{-# LANGUAGE TemplateHaskell, CPP #-}
module Test.LeanCheck.Derive
( deriveListable
, deriveListableIfNeeded
, deriveListableCascading
, deriveTiers
, deriveList
)
where
#ifdef __GLASGOW_HASKELL__
import Language.Haskell.TH
import Test.LeanCheck.Basic
import Control.Monad (unless, liftM, filterM)
import Data.List (delete)
#if __GLASGOW_HASKELL__ < 706
reportWarning :: String -> Q ()
reportWarning = report False
#endif
deriveListable :: Name -> DecsQ
deriveListable :: Name -> DecsQ
deriveListable = Bool -> Bool -> Name -> DecsQ
deriveListableX Bool
True Bool
False
deriveListableIfNeeded :: Name -> DecsQ
deriveListableIfNeeded :: Name -> DecsQ
deriveListableIfNeeded = Bool -> Bool -> Name -> DecsQ
deriveListableX Bool
False Bool
False
deriveListableCascading :: Name -> DecsQ
deriveListableCascading :: Name -> DecsQ
deriveListableCascading = Bool -> Bool -> Name -> DecsQ
deriveListableX Bool
True Bool
True
deriveListableX :: Bool -> Bool -> Name -> DecsQ
deriveListableX :: Bool -> Bool -> Name -> DecsQ
deriveListableX Bool
warnExisting Bool
cascade Name
t = do
Bool
is <- Name
t Name -> Name -> Q Bool
`isInstanceOf` ''Listable
if Bool
is
then do
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (Bool -> Bool
not Bool
warnExisting)
(String -> Q ()
reportWarning forall a b. (a -> b) -> a -> b
$ String
"Instance Listable " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show Name
t
forall a. [a] -> [a] -> [a]
++ String
" already exists, skipping derivation")
forall (m :: * -> *) a. Monad m => a -> m a
return []
else if Bool
cascade
then Name -> DecsQ
reallyDeriveListableCascading Name
t
else Name -> DecsQ
reallyDeriveListable Name
t
reallyDeriveListable :: Name -> DecsQ
reallyDeriveListable :: Name -> DecsQ
reallyDeriveListable Name
t = do
(Type
nt,[Type]
vs) <- Name -> Q (Type, [Type])
normalizeType Name
t
#if __GLASGOW_HASKELL__ >= 710
[Type]
cxt <- forall (t :: * -> *) (m :: * -> *) a.
(Traversable t, Monad m) =>
t (m a) -> m (t a)
sequence [[t| Listable $(return v) |] | Type
v <- [Type]
vs]
#else
cxt <- sequence [classP ''Listable [return v] | v <- vs]
#endif
#if __GLASGOW_HASKELL__ >= 708
[Type]
cxt [Type] -> DecsQ -> DecsQ
|=>| [d| instance Listable $(return nt)
where tiers = $(deriveTiers t) |]
#else
tiersE <- deriveTiers t
return [ InstanceD
cxt
(AppT (ConT ''Listable) nt)
[ValD (VarP 'tiers) (NormalB tiersE) []]
]
#endif
deriveTiers :: Name -> ExpQ
deriveTiers :: Name -> ExpQ
deriveTiers Name
t = forall {a}. [(Name, [a])] -> ExpQ
conse forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< Name -> Q [(Name, [Type])]
typeConstructors Name
t
where
cone :: Name -> t a -> ExpQ
cone Name
n t a
as = do
(Just Name
consN) <- String -> Q (Maybe Name)
lookupValueName forall a b. (a -> b) -> a -> b
$ String
"cons" forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show (forall (t :: * -> *) a. Foldable t => t a -> Int
length t a
as)
[| $(varE consN) $(conE n) |]
conse :: [(Name, [a])] -> ExpQ
conse = forall (t :: * -> *) a. Foldable t => (a -> a -> a) -> t a -> a
foldr1 (\ExpQ
e1 ExpQ
e2 -> [| $e1 \/ $e2 |]) forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map (forall a b c. (a -> b -> c) -> (a, b) -> c
uncurry forall {t :: * -> *} {a}. Foldable t => Name -> t a -> ExpQ
cone)
deriveList :: Name -> ExpQ
deriveList :: Name -> ExpQ
deriveList Name
t = [| concat $(deriveTiers t) |]
reallyDeriveListableCascading :: Name -> DecsQ
reallyDeriveListableCascading :: Name -> DecsQ
reallyDeriveListableCascading Name
t =
forall (m :: * -> *) a. Monad m => a -> m a
return forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM Name -> DecsQ
reallyDeriveListable
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall (m :: * -> *) a.
Applicative m =>
(a -> m Bool) -> [a] -> m [a]
filterM (forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. Name -> Q Bool
isTypeSynonym)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< forall (m :: * -> *) a. Monad m => a -> m a
return forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Name
tforall a. a -> [a] -> [a]
:) forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. Eq a => a -> [a] -> [a]
delete Name
t
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< Name
t Name -> (Name -> Q Bool) -> Q [Name]
`typeConCascadingArgsThat` (Name -> Name -> Q Bool
`isntInstanceOf` ''Listable)
typeConArgs :: Name -> Q [Name]
typeConArgs :: Name -> Q [Name]
typeConArgs Name
t = do
Bool
is <- Name -> Q Bool
isTypeSynonym Name
t
if Bool
is
then forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM Type -> [Name]
typeConTs forall a b. (a -> b) -> a -> b
$ Name -> Q Type
typeSynonymType Name
t
else forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM (forall a. Ord a => [[a]] -> [a]
nubMerges forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map Type -> [Name]
typeConTs forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd) forall a b. (a -> b) -> a -> b
$ Name -> Q [(Name, [Type])]
typeConstructors Name
t
where
typeConTs :: Type -> [Name]
typeConTs :: Type -> [Name]
typeConTs (AppT Type
t1 Type
t2) = Type -> [Name]
typeConTs Type
t1 forall a. Ord a => [a] -> [a] -> [a]
`nubMerge` Type -> [Name]
typeConTs Type
t2
typeConTs (SigT Type
t Type
_) = Type -> [Name]
typeConTs Type
t
typeConTs (VarT Name
_) = []
typeConTs (ConT Name
n) = [Name
n]
#if __GLASGOW_HASKELL__ >= 800
typeConTs (InfixT Type
t1 Name
n Type
t2) = Type -> [Name]
typeConTs Type
t1 forall a. Ord a => [a] -> [a] -> [a]
`nubMerge` Type -> [Name]
typeConTs Type
t2
typeConTs (UInfixT Type
t1 Name
n Type
t2) = Type -> [Name]
typeConTs Type
t1 forall a. Ord a => [a] -> [a] -> [a]
`nubMerge` Type -> [Name]
typeConTs Type
t2
typeConTs (ParensT Type
t) = Type -> [Name]
typeConTs Type
t
#endif
typeConTs Type
_ = []
typeConArgsThat :: Name -> (Name -> Q Bool) -> Q [Name]
typeConArgsThat :: Name -> (Name -> Q Bool) -> Q [Name]
typeConArgsThat Name
t Name -> Q Bool
p = do
[Name]
targs <- Name -> Q [Name]
typeConArgs Name
t
[(Name, Bool)]
tbs <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (\Name
t' -> do Bool
is <- Name -> Q Bool
p Name
t'; forall (m :: * -> *) a. Monad m => a -> m a
return (Name
t',Bool
is)) [Name]
targs
forall (m :: * -> *) a. Monad m => a -> m a
return [Name
t' | (Name
t',Bool
p) <- [(Name, Bool)]
tbs, Bool
p]
typeConCascadingArgsThat :: Name -> (Name -> Q Bool) -> Q [Name]
Name
t typeConCascadingArgsThat :: Name -> (Name -> Q Bool) -> Q [Name]
`typeConCascadingArgsThat` Name -> Q Bool
p = do
[Name]
ts <- Name
t Name -> (Name -> Q Bool) -> Q [Name]
`typeConArgsThat` Name -> Q Bool
p
let p' :: Name -> Q Bool
p' Name
t' = do Bool
is <- Name -> Q Bool
p Name
t'; forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ Name
t' forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`notElem` (Name
tforall a. a -> [a] -> [a]
:[Name]
ts) Bool -> Bool -> Bool
&& Bool
is
[[Name]]
tss <- forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (Name -> (Name -> Q Bool) -> Q [Name]
`typeConCascadingArgsThat` Name -> Q Bool
p') [Name]
ts
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a. Ord a => [[a]] -> [a]
nubMerges ([Name]
tsforall a. a -> [a] -> [a]
:[[Name]]
tss)
normalizeType :: Name -> Q (Type, [Type])
normalizeType :: Name -> Q (Type, [Type])
normalizeType Name
t = do
Int
ar <- Name -> Q Int
typeArity Name
t
[Type]
vs <- Int -> Q [Type]
newVarTs Int
ar
forall (m :: * -> *) a. Monad m => a -> m a
return (forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
foldl Type -> Type -> Type
AppT (Name -> Type
ConT Name
t) [Type]
vs, [Type]
vs)
where
newNames :: [String] -> Q [Name]
newNames :: [String] -> Q [Name]
newNames = forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM forall (m :: * -> *). Quote m => String -> m Name
newName
newVarTs :: Int -> Q [Type]
newVarTs :: Int -> Q [Type]
newVarTs Int
n = forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM (forall a b. (a -> b) -> [a] -> [b]
map Name -> Type
VarT)
forall a b. (a -> b) -> a -> b
$ [String] -> Q [Name]
newNames (forall a. Int -> [a] -> [a]
take Int
n forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map (forall a. a -> [a] -> [a]
:[]) forall a b. (a -> b) -> a -> b
$ forall a. [a] -> [a]
cycle [Char
'a'..Char
'z'])
normalizeTypeUnits :: Name -> Q Type
normalizeTypeUnits :: Name -> Q Type
normalizeTypeUnits Name
t = do
Int
ar <- Name -> Q Int
typeArity Name
t
forall (m :: * -> *) a. Monad m => a -> m a
return (forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
foldl Type -> Type -> Type
AppT (Name -> Type
ConT Name
t) (forall a. Int -> a -> [a]
replicate Int
ar (Int -> Type
TupleT Int
0)))
isInstanceOf :: Name -> Name -> Q Bool
isInstanceOf :: Name -> Name -> Q Bool
isInstanceOf Name
tn Name
cl = do
Type
ty <- Name -> Q Type
normalizeTypeUnits Name
tn
Name -> [Type] -> Q Bool
isInstance Name
cl [Type
ty]
isntInstanceOf :: Name -> Name -> Q Bool
isntInstanceOf :: Name -> Name -> Q Bool
isntInstanceOf Name
tn Name
cl = forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM Bool -> Bool
not (Name -> Name -> Q Bool
isInstanceOf Name
tn Name
cl)
typeArity :: Name -> Q Int
typeArity :: Name -> Q Int
typeArity Name
t = do
Info
ti <- Name -> Q Info
reify Name
t
forall (m :: * -> *) a. Monad m => a -> m a
return forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) a. Foldable t => t a -> Int
length forall a b. (a -> b) -> a -> b
$ case Info
ti of
#if __GLASGOW_HASKELL__ < 800
TyConI (DataD _ _ ks _ _) -> ks
TyConI (NewtypeD _ _ ks _ _) -> ks
#else
TyConI (DataD [Type]
_ Name
_ [TyVarBndr ()]
ks Maybe Type
_ [Con]
_ [DerivClause]
_) -> [TyVarBndr ()]
ks
TyConI (NewtypeD [Type]
_ Name
_ [TyVarBndr ()]
ks Maybe Type
_ Con
_ [DerivClause]
_) -> [TyVarBndr ()]
ks
#endif
TyConI (TySynD Name
_ [TyVarBndr ()]
ks Type
_) -> [TyVarBndr ()]
ks
Info
_ -> forall a. HasCallStack => String -> a
error forall a b. (a -> b) -> a -> b
$ String
"error (typeArity): symbol " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show Name
t
forall a. [a] -> [a] -> [a]
++ String
" is not a newtype, data or type synonym"
typeConstructors :: Name -> Q [(Name,[Type])]
typeConstructors :: Name -> Q [(Name, [Type])]
typeConstructors Name
t = do
Info
ti <- Name -> Q Info
reify Name
t
forall (m :: * -> *) a. Monad m => a -> m a
return forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a -> b) -> [a] -> [b]
map Con -> (Name, [Type])
simplify forall a b. (a -> b) -> a -> b
$ case Info
ti of
#if __GLASGOW_HASKELL__ < 800
TyConI (DataD _ _ _ cs _) -> cs
TyConI (NewtypeD _ _ _ c _) -> [c]
#else
TyConI (DataD [Type]
_ Name
_ [TyVarBndr ()]
_ Maybe Type
_ [Con]
cs [DerivClause]
_) -> [Con]
cs
TyConI (NewtypeD [Type]
_ Name
_ [TyVarBndr ()]
_ Maybe Type
_ Con
c [DerivClause]
_) -> [Con
c]
#endif
Info
_ -> forall a. HasCallStack => String -> a
error forall a b. (a -> b) -> a -> b
$ String
"error (typeConstructors): symbol " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show Name
t
forall a. [a] -> [a] -> [a]
++ String
" is neither newtype nor data"
where
simplify :: Con -> (Name, [Type])
simplify (NormalC Name
n [BangType]
ts) = (Name
n,forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd [BangType]
ts)
simplify (RecC Name
n [VarBangType]
ts) = (Name
n,forall a b. (a -> b) -> [a] -> [b]
map forall {a} {b} {c}. (a, b, c) -> c
trd [VarBangType]
ts)
simplify (InfixC BangType
t1 Name
n BangType
t2) = (Name
n,[forall a b. (a, b) -> b
snd BangType
t1,forall a b. (a, b) -> b
snd BangType
t2])
simplify Con
_ = forall a. HasCallStack => String -> a
error String
"typeConstructors: unexpected unhandled case"
trd :: (a, b, c) -> c
trd (a
x,b
y,c
z) = c
z
isTypeSynonym :: Name -> Q Bool
isTypeSynonym :: Name -> Q Bool
isTypeSynonym Name
t = do
Info
ti <- Name -> Q Info
reify Name
t
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ case Info
ti of
TyConI (TySynD Name
_ [TyVarBndr ()]
_ Type
_) -> Bool
True
Info
_ -> Bool
False
typeSynonymType :: Name -> Q Type
typeSynonymType :: Name -> Q Type
typeSynonymType Name
t = do
Info
ti <- Name -> Q Info
reify Name
t
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ case Info
ti of
TyConI (TySynD Name
_ [TyVarBndr ()]
_ Type
t') -> Type
t'
Info
_ -> forall a. HasCallStack => String -> a
error forall a b. (a -> b) -> a -> b
$ String
"error (typeSynonymType): symbol " forall a. [a] -> [a] -> [a]
++ forall a. Show a => a -> String
show Name
t
forall a. [a] -> [a] -> [a]
++ String
" is not a type synonym"
(|=>|) :: Cxt -> DecsQ -> DecsQ
[Type]
c |=>| :: [Type] -> DecsQ -> DecsQ
|=>| DecsQ
qds = do [Dec]
ds <- DecsQ
qds
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map (Dec -> [Type] -> Dec
`ac` [Type]
c) [Dec]
ds
#if __GLASGOW_HASKELL__ < 800
where ac (InstanceD c ts ds) c' = InstanceD (c++c') ts ds
ac d _ = d
#else
where ac :: Dec -> [Type] -> Dec
ac (InstanceD Maybe Overlap
o [Type]
c Type
ts [Dec]
ds) [Type]
c' = Maybe Overlap -> [Type] -> Type -> [Dec] -> Dec
InstanceD Maybe Overlap
o ([Type]
cforall a. [a] -> [a] -> [a]
++[Type]
c') Type
ts [Dec]
ds
ac Dec
d [Type]
_ = Dec
d
#endif
nubMerge :: Ord a => [a] -> [a] -> [a]
nubMerge :: forall a. Ord a => [a] -> [a] -> [a]
nubMerge [] [a]
ys = [a]
ys
nubMerge [a]
xs [] = [a]
xs
nubMerge (a
x:[a]
xs) (a
y:[a]
ys) | a
x forall a. Ord a => a -> a -> Bool
< a
y = a
x forall a. a -> [a] -> [a]
: [a]
xs forall a. Ord a => [a] -> [a] -> [a]
`nubMerge` (a
yforall a. a -> [a] -> [a]
:[a]
ys)
| a
x forall a. Ord a => a -> a -> Bool
> a
y = a
y forall a. a -> [a] -> [a]
: (a
xforall a. a -> [a] -> [a]
:[a]
xs) forall a. Ord a => [a] -> [a] -> [a]
`nubMerge` [a]
ys
| Bool
otherwise = a
x forall a. a -> [a] -> [a]
: [a]
xs forall a. Ord a => [a] -> [a] -> [a]
`nubMerge` [a]
ys
nubMerges :: Ord a => [[a]] -> [a]
nubMerges :: forall a. Ord a => [[a]] -> [a]
nubMerges = forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr forall a. Ord a => [a] -> [a] -> [a]
nubMerge []
#else
errorNotGHC :: a
errorNotGHC = error "Only defined when using GHC"
deriveListable :: a
deriveListable = errorNotGHC
deriveListableIfNeeded :: a
deriveListableIfNeeded = errorNotGHC
deriveListableCascading :: a
deriveListableCascading = errorNotGHC
deriveTiers :: a
deriveTiers = errorNotGHC
deriveList :: a
deriveList = errorNotGHC
#endif