barbies-th: Create strippable HKD via TH

[ bsd3, data, data-structures, generics, library ] [ Propose Tags ]

Please see Data.Barbie.TH


[Skip to Readme]
Versions [RSS] [faq] 0, 0.1, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.7, 0.1.8, 0.1.9
Change log CHANGELOG.md
Dependencies barbies (>=2.0.1 && <2.1), base (>=4.12 && <4.17), split (==0.2.*), template-haskell (>=2.14 && <2.19) [details]
License BSD-3-Clause
Copyright Copyright (c) 2021 Fumiaki Kinoshita
Author Fumiaki Kinoshita
Maintainer fumiexcel@gmail.com
Revised Revision 1 made by FumiakiKinoshita at 2021-11-09T14:13:56Z
Category Data, Generics, Data Structures
Home page https://github.com/fumieval/barbies-th
Bug tracker https://github.com/fumieval/barbies-th/issues
Source repo head: git clone https://github.com/fumieval/barbies-th.git
Uploaded by FumiakiKinoshita at 2021-10-21T06:42:17Z
Distributions NixOS:0.1.8
Downloads 1962 total (220 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-10-21 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for barbies-th-0.1.9

[back to package description]

barbies-th

Hackage Haskell CI

A wrapper library for barbies to generate strippable HKDs. It transforms the following declaration

declareBareB [d|
  data Foo = Foo
    { foo :: Int
    , bar :: String
    }  |]

into:

data Foo sw h = Foo
    { foo :: Wear sw h Int,
    , bar :: Wear sw h String
    }
instance BareB Foo
instance FieldNamesB (Foo Covered) where
  bfieldNames = Foo (Const "foo") (Const "bar")
instance ProductB (Foo Covered) where
  bprod (Foo xfoo xbar) (Foo yfoo ybar)
    = Foo (Pair xfoo yfoo) (Pair xbar ybar)
instance FunctorB (Foo Covered) where ...
instance TraversableB (Foo Covered) where ...
instance ConstraintsB (Foo Covered)
instance ProductBC (Foo Covered)

passthroughBareB generates a type synonym for the bare type, preserving the semantics of the original definition.

data FooB sw h = Foo
    { foo :: Wear sw h Int,
    , bar :: Wear sw h String
    }
type Foo = Foo Bare Identity
type FooH = Foo Covered

Typically you need the following extensions to make declareBareB work:

{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TypeFamilies #-}

GHC sometimes takes very long time to compile code with generically derived instances, and it often fails to inline functions properly too. This package generates most instance methods by TH, reducing large amount of compilation time of the declarations and use sites.

Unlike higgledy which relies on in-memory representation using GHC.Generic, you don't have to worry about the performance, and you can benefit from various language features (e.g. -Wmissing-fields, RecordWildCards etc) even in higher-kinded form.

Deriving pass-through

stock deriving does not work on HKDs. Instead, it transforms deriving clauses into standalone ones via the Barbie wrapper, as well as ones for the Bare counterpart. For example,

data Foo = ... deriving (Show, Eq)

generates

deriving instance Show (Foo Bare Identity)
deriving instance Eq (Foo Bare Identity)
deriving via Barbie (Foo Covered) h instance Show (Barbie (Foo Covered) h) => Show (Foo Covered h)
deriving via Barbie (Foo Covered) h instance Eq (Barbie (Foo Covered) h) => Eq (Foo Covered h)

Note that Barbies module must be imported manually in order to make use of coercions.

Matryoshka barbies

Barbies can contain other barbies if they're declared in the same splice, it pretty much works as you'd expect.

declareBareB [d|
  data Inner = Inner
    { inner :: Int
    }
  data Outer = Outer
    { outer :: Inner
    , other :: Bool
    }
|]

into:

data Inner sw h = Inner
    { inner :: Wear sw h Int
    }
data Outer sw h = Outer
    { outer :: Inner sw h
    , other :: Wear sw h Bool
    }
-- And all the instances as above