{-# LANGUAGE FlexibleInstances   #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TemplateHaskell     #-}
--------------------------------------------------------------------------------
-- |
-- Module      :  Data.Comp.Multi.Derive.Ordering
-- Copyright   :  (c) 2011 Patrick Bahr, Tom Hvitved
-- License     :  BSD3
-- Maintainer  :  Tom Hvitved <hvitved@diku.dk>
-- Stability   :  experimental
-- Portability :  non-portable (GHC Extensions)
--
-- Automatically derive instances of @OrdHF@.
--
--------------------------------------------------------------------------------
module Data.Comp.Multi.Derive.Ordering
    (
     OrdHF(..),
     makeOrdHF
    ) where

import Data.Comp.Derive.Utils
import Data.Comp.Multi.Ordering
import Data.List
import Data.Maybe
import Language.Haskell.TH hiding (Cxt)

compList :: [Ordering] -> Ordering
compList :: [Ordering] -> Ordering
compList = Ordering -> Maybe Ordering -> Ordering
forall a. a -> Maybe a -> a
fromMaybe Ordering
EQ (Maybe Ordering -> Ordering)
-> ([Ordering] -> Maybe Ordering) -> [Ordering] -> Ordering
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Ordering -> Bool) -> [Ordering] -> Maybe Ordering
forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Maybe a
find (Ordering -> Ordering -> Bool
forall a. Eq a => a -> a -> Bool
/= Ordering
EQ)

{-| Derive an instance of 'OrdHF' for a type constructor of any parametric
  kind taking at least three arguments. -}
makeOrdHF :: Name -> Q [Dec]
makeOrdHF :: Name -> Q [Dec]
makeOrdHF Name
fname = do
  Just (DataInfo Cxt
_ Name
name [TyVarBndr BndrVis]
args [Con]
constrs [DerivClause]
_) <- Q Info -> Q (Maybe DataInfo)
abstractNewtypeQ (Q Info -> Q (Maybe DataInfo)) -> Q Info -> Q (Maybe DataInfo)
forall a b. (a -> b) -> a -> b
$ Name -> Q Info
reify Name
fname
  let args' :: [TyVarBndr BndrVis]
args' = [TyVarBndr BndrVis] -> [TyVarBndr BndrVis]
forall a. HasCallStack => [a] -> [a]
init [TyVarBndr BndrVis]
args
  -- covariant argument
  let Type
coArg :: Type = Name -> Type
VarT (Name -> Type) -> Name -> Type
forall a b. (a -> b) -> a -> b
$ TyVarBndr BndrVis -> Name
tyVarBndrName (TyVarBndr BndrVis -> Name) -> TyVarBndr BndrVis -> Name
forall a b. (a -> b) -> a -> b
$ [TyVarBndr BndrVis] -> TyVarBndr BndrVis
forall a. HasCallStack => [a] -> a
last [TyVarBndr BndrVis]
args'
  let argNames :: Cxt
argNames = (TyVarBndr BndrVis -> Type) -> [TyVarBndr BndrVis] -> Cxt
forall a b. (a -> b) -> [a] -> [b]
map (Name -> Type
VarT (Name -> Type)
-> (TyVarBndr BndrVis -> Name) -> TyVarBndr BndrVis -> Type
forall b c a. (b -> c) -> (a -> b) -> a -> c
. TyVarBndr BndrVis -> Name
tyVarBndrName) ([TyVarBndr BndrVis] -> [TyVarBndr BndrVis]
forall a. HasCallStack => [a] -> [a]
init [TyVarBndr BndrVis]
args')
  let complType :: Type
complType = (Type -> Type -> Type) -> Type -> Cxt -> Type
forall b a. (b -> a -> b) -> b -> [a] -> b
forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
foldl Type -> Type -> Type
AppT (Name -> Type
ConT Name
name) Cxt
argNames
  let classType :: Type
classType = Type -> Type -> Type
AppT (Name -> Type
ConT ''OrdHF) Type
complType
  [(Name, Cxt, Maybe Type)]
constrs' :: [(Name,[Type],Maybe Type)] <- (Con -> Q (Name, Cxt, Maybe Type))
-> [Con] -> Q [(Name, Cxt, Maybe Type)]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
forall (m :: * -> *) a b. Monad m => (a -> m b) -> [a] -> m [b]
mapM Con -> Q (Name, Cxt, Maybe Type)
normalConExp [Con]
constrs
  Dec
compareHFDecl <- Name -> [Q Clause] -> Q Dec
forall (m :: * -> *). Quote m => Name -> [m Clause] -> m Dec
funD 'compareHF (Type -> [(Name, Cxt, Maybe Type)] -> [Q Clause]
compareHFClauses Type
coArg [(Name, Cxt, Maybe Type)]
constrs')
  [Dec] -> Q [Dec]
forall a. a -> Q a
forall (m :: * -> *) a. Monad m => a -> m a
return [Cxt -> Type -> [Dec] -> Dec
mkInstanceD [] Type
classType [Dec
compareHFDecl]]
      where compareHFClauses :: Type -> [(Name,[Type],Maybe Type)] -> [ClauseQ]
            compareHFClauses :: Type -> [(Name, Cxt, Maybe Type)] -> [Q Clause]
compareHFClauses Type
_ [] = []
            compareHFClauses Type
coArg [(Name, Cxt, Maybe Type)]
constrs =
                let constrs' :: [((Name, Cxt, Maybe Type), Integer)]
constrs' = [(Name, Cxt, Maybe Type)]
constrs [(Name, Cxt, Maybe Type)]
-> [Integer] -> [((Name, Cxt, Maybe Type), Integer)]
forall a b. [a] -> [b] -> [(a, b)]
`zip` [Integer
1..]
                    constPairs :: [(((Name, Cxt, Maybe Type), Integer),
  ((Name, Cxt, Maybe Type), Integer))]
constPairs = [(((Name, Cxt, Maybe Type), Integer)
x,((Name, Cxt, Maybe Type), Integer)
y)| ((Name, Cxt, Maybe Type), Integer)
x<-[((Name, Cxt, Maybe Type), Integer)]
constrs', ((Name, Cxt, Maybe Type), Integer)
y <- [((Name, Cxt, Maybe Type), Integer)]
constrs']
                in ((((Name, Cxt, Maybe Type), Integer),
  ((Name, Cxt, Maybe Type), Integer))
 -> Q Clause)
-> [(((Name, Cxt, Maybe Type), Integer),
     ((Name, Cxt, Maybe Type), Integer))]
-> [Q Clause]
forall a b. (a -> b) -> [a] -> [b]
map (Type
-> (((Name, Cxt, Maybe Type), Integer),
    ((Name, Cxt, Maybe Type), Integer))
-> Q Clause
forall {a} {b} {c}.
Ord a =>
Type
-> (((Name, Cxt, Maybe Type), a), ((Name, b, c), a)) -> Q Clause
genClause Type
coArg) [(((Name, Cxt, Maybe Type), Integer),
  ((Name, Cxt, Maybe Type), Integer))]
constPairs
            genClause :: Type
-> (((Name, Cxt, Maybe Type), a), ((Name, b, c), a)) -> Q Clause
genClause Type
coArg (((Name, Cxt, Maybe Type)
c,a
n),((Name, b, c)
d,a
m))
                | a
n a -> a -> Bool
forall a. Eq a => a -> a -> Bool
== a
m = Type -> (Name, Cxt, Maybe Type) -> Q Clause
genEqClause Type
coArg (Name, Cxt, Maybe Type)
c
                | a
n a -> a -> Bool
forall a. Ord a => a -> a -> Bool
< a
m = (Name, Cxt, Maybe Type) -> (Name, b, c) -> Q Clause
forall {m :: * -> *} {b} {c} {b} {c}.
Quote m =>
(Name, b, c) -> (Name, b, c) -> m Clause
genLtClause (Name, Cxt, Maybe Type)
c (Name, b, c)
d
                | Bool
otherwise = (Name, Cxt, Maybe Type) -> (Name, b, c) -> Q Clause
forall {m :: * -> *} {b} {c} {b} {c}.
Quote m =>
(Name, b, c) -> (Name, b, c) -> m Clause
genGtClause (Name, Cxt, Maybe Type)
c (Name, b, c)
d
            genEqClause :: Type -> (Name,[Type],Maybe Type) -> ClauseQ
            genEqClause :: Type -> (Name, Cxt, Maybe Type) -> Q Clause
genEqClause Type
coArg (Name
constr, Cxt
args,Maybe Type
gadtTy) = do
              [Name]
varXs <- Int -> String -> Q [Name]
newNames (Cxt -> Int
forall a. [a] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length Cxt
args) String
"x"
              [Name]
varYs <- Int -> String -> Q [Name]
newNames (Cxt -> Int
forall a. [a] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length Cxt
args) String
"y"
              let patX :: Pat
patX = Name -> Cxt -> [Pat] -> Pat
ConP Name
constr [] ([Pat] -> Pat) -> [Pat] -> Pat
forall a b. (a -> b) -> a -> b
$ (Name -> Pat) -> [Name] -> [Pat]
forall a b. (a -> b) -> [a] -> [b]
map Name -> Pat
VarP [Name]
varXs
              let patY :: Pat
patY = Name -> Cxt -> [Pat] -> Pat
ConP Name
constr [] ([Pat] -> Pat) -> [Pat] -> Pat
forall a b. (a -> b) -> a -> b
$ (Name -> Pat) -> [Name] -> [Pat]
forall a b. (a -> b) -> [a] -> [b]
map Name -> Pat
VarP [Name]
varYs
              Exp
body <- Type -> [(Name, Name, Type)] -> ExpQ
eqDBody (Type -> Maybe Type -> Type
getBinaryFArg Type
coArg Maybe Type
gadtTy) ([Name] -> [Name] -> Cxt -> [(Name, Name, Type)]
forall a b c. [a] -> [b] -> [c] -> [(a, b, c)]
zip3 [Name]
varXs [Name]
varYs Cxt
args)
              Clause -> Q Clause
forall a. a -> Q a
forall (m :: * -> *) a. Monad m => a -> m a
return (Clause -> Q Clause) -> Clause -> Q Clause
forall a b. (a -> b) -> a -> b
$ [Pat] -> Body -> [Dec] -> Clause
Clause [Pat
patX, Pat
patY] (Exp -> Body
NormalB Exp
body) []
            eqDBody :: Type -> [(Name, Name, Type)] -> ExpQ
            eqDBody :: Type -> [(Name, Name, Type)] -> ExpQ
eqDBody Type
coArg [(Name, Name, Type)]
x =
                [|compList $([ExpQ] -> ExpQ
forall (m :: * -> *). Quote m => [m Exp] -> m Exp
listE ([ExpQ] -> ExpQ) -> [ExpQ] -> ExpQ
forall a b. (a -> b) -> a -> b
$ ((Name, Name, Type) -> ExpQ) -> [(Name, Name, Type)] -> [ExpQ]
forall a b. (a -> b) -> [a] -> [b]
map (Type -> (Name, Name, Type) -> ExpQ
eqDB Type
coArg) [(Name, Name, Type)]
x)|]
            eqDB :: Type -> (Name, Name, Type) -> ExpQ
            eqDB :: Type -> (Name, Name, Type) -> ExpQ
eqDB Type
coArg (Name
x, Name
y, Type
tp)
                | Bool -> Bool
not (Type -> Type -> Bool
containsType Type
tp Type
coArg) =
                    [| compare $(Name -> ExpQ
forall (m :: * -> *). Quote m => Name -> m Exp
varE Name
x) $(Name -> ExpQ
forall (m :: * -> *). Quote m => Name -> m Exp
varE Name
y) |]
                | Bool
otherwise =
                    [| kcompare $(Name -> ExpQ
forall (m :: * -> *). Quote m => Name -> m Exp
varE Name
x) $(Name -> ExpQ
forall (m :: * -> *). Quote m => Name -> m Exp
varE Name
y) |]
            genLtClause :: (Name, b, c) -> (Name, b, c) -> m Clause
genLtClause (Name
c, b
_, c
_) (Name
d, b
_, c
_) =
                [m Pat] -> m Body -> [m Dec] -> m Clause
forall (m :: * -> *).
Quote m =>
[m Pat] -> m Body -> [m Dec] -> m Clause
clause [Name -> [m FieldPat] -> m Pat
forall (m :: * -> *). Quote m => Name -> [m FieldPat] -> m Pat
recP Name
c [], Name -> [m FieldPat] -> m Pat
forall (m :: * -> *). Quote m => Name -> [m FieldPat] -> m Pat
recP Name
d []] (m Exp -> m Body
forall (m :: * -> *). Quote m => m Exp -> m Body
normalB [| LT |]) []
            genGtClause :: (Name, b, c) -> (Name, b, c) -> m Clause
genGtClause (Name
c, b
_, c
_) (Name
d, b
_, c
_) =
                [m Pat] -> m Body -> [m Dec] -> m Clause
forall (m :: * -> *).
Quote m =>
[m Pat] -> m Body -> [m Dec] -> m Clause
clause [Name -> [m FieldPat] -> m Pat
forall (m :: * -> *). Quote m => Name -> [m FieldPat] -> m Pat
recP Name
c [], Name -> [m FieldPat] -> m Pat
forall (m :: * -> *). Quote m => Name -> [m FieldPat] -> m Pat
recP Name
d []] (m Exp -> m Body
forall (m :: * -> *). Quote m => m Exp -> m Body
normalB [| GT |]) []