split HaskLiteralsAndTyCons into two files
[coq-hetmet.git] / src / Extraction-prefix.hs
1 {-# OPTIONS_GHC -fno-warn-unused-matches -fno-warn-unused-binds -fno-warn-unused-imports #-}
2 module CoqPass ( coqPassCoreToString, coqPassCoreToCore )
3 where
4 import qualified Unique
5 import qualified UniqSupply
6 import qualified MkCore
7 import qualified TysWiredIn
8 import qualified TysPrim
9 import qualified Outputable
10 import qualified PrelNames
11 import qualified OccName
12 import qualified Name
13 import qualified Literal
14 import qualified Type
15 import qualified TypeRep
16 import qualified DataCon
17 import qualified TyCon
18 import qualified Coercion
19 import qualified Var
20 import qualified Id
21 import qualified FastString
22 import qualified BasicTypes
23 import qualified DataCon
24 import qualified CoreSyn
25 import qualified CoreUtils
26 import qualified Class
27 import qualified Data.Char 
28 import qualified Data.List
29 import qualified Data.Ord
30 import qualified Data.Typeable
31 import Data.Bits ((.&.), shiftL, (.|.))
32 import Prelude ( (++), (+), (==), Show, show, (.), ($) )
33 import qualified Prelude
34 import qualified GHC.Base
35 import qualified System.IO.Unsafe
36
37 getTyConTyVars :: TyCon.TyCon -> [Var.TyVar]
38 getTyConTyVars tc =
39   if TyCon.isFunTyCon tc
40   then []
41   else if TyCon.isPrimTyCon tc
42        then []
43        else TyCon.tyConTyVars tc
44
45 cmpAlts :: (CoreSyn.AltCon,[Var.Var],CoreSyn.Expr Var.Var) -> (CoreSyn.AltCon,[Var.Var],CoreSyn.Expr Var.Var) -> Data.Ord.Ordering
46 cmpAlts (CoreSyn.DEFAULT,_,_) _   = Data.Ord.LT
47 cmpAlts _ (CoreSyn.DEFAULT,_,_)   = Data.Ord.GT
48 cmpAlts (a1,_,_) (a2,_,_)         = Data.Ord.compare a2 a1
49
50 sortAlts :: [(CoreSyn.AltCon,[Var.Var],CoreSyn.Expr Var.Var)] -> [(CoreSyn.AltCon,[Var.Var],CoreSyn.Expr Var.Var)]
51 sortAlts x = Data.List.sortBy (\a b -> if a `CoreSyn.ltAlt` b then Data.Ord.LT else Data.Ord.GT) x
52
53 coreVarToWeakVar :: Var.Var -> WeakVar
54 coreVarToWeakVar v | Id.isId     v = WExprVar (WeakExprVar v (errOrFail (coreTypeToWeakType (Var.varType v))))
55 coreVarToWeakVar v | Var.isTyVar v = WTypeVar (WeakTypeVar v (coreKindToKind (Var.varType v)))
56 coreVarToWeakVar v | Var.isCoVar v = WCoerVar (WeakCoerVar v (Prelude.error "FIXME") 
57                                                              (Prelude.error "FIXME") (Prelude.error "FIXME"))
58 coreVarToWeakVar _                 =
59    Prelude.error "Var.Var that is neither an expression variable, type variable, nor coercion variable!"
60
61 errOrFail :: OrError t -> t
62 errOrFail (OK x)    = x
63 errOrFail (Error s) = Prelude.error s
64
65 tyConOrTyFun :: TyCon.TyCon -> Prelude.Either TyCon.TyCon TyCon.TyCon
66 tyConOrTyFun n =
67    if n == TysPrim.statePrimTyCon     -- special-purpose hack treat State# as a type family since it has kind *->* but no tyvars
68    then Prelude.Right n
69    else if TyCon.isFamInstTyCon n
70         then Prelude.Right n
71         else Prelude.Left n
72
73 nat2int :: Nat -> Prelude.Int
74 nat2int O     = 0
75 nat2int (S x) = 1 + (nat2int x)
76
77 natToString :: Nat -> Prelude.String
78 natToString n = show (nat2int n)
79
80 sanitizeForLatex :: Prelude.String -> Prelude.String
81 sanitizeForLatex []      = []
82 sanitizeForLatex ('_':x) = "\\_"++(sanitizeForLatex x)
83 sanitizeForLatex ('$':x) = "\\$"++(sanitizeForLatex x)
84 sanitizeForLatex ('#':x) = "\\#"++(sanitizeForLatex x)
85 sanitizeForLatex (c:x)   = c:(sanitizeForLatex x)
86
87 kindToCoreKind :: Kind -> TypeRep.Kind
88 kindToCoreKind KindStar          = TypeRep.liftedTypeKind
89 kindToCoreKind (KindArrow k1 k2) = Coercion.mkArrowKind (kindToCoreKind k1) (kindToCoreKind k2)
90 kindToCoreKind _                 = Prelude.error "kindToCoreKind does not know how to handle that"
91
92 coreKindToKind :: TypeRep.Kind -> Kind
93 coreKindToKind k =
94   case Coercion.splitKindFunTy_maybe k of
95       Prelude.Just (k1,k2) -> KindArrow (coreKindToKind k1) (coreKindToKind k2)
96       Prelude.Nothing -> 
97                       if (Coercion.isLiftedTypeKind k)   then KindStar
98                  else if (Coercion.isUnliftedTypeKind k) then KindStar
99                  else if (Coercion.isArgTypeKind k)      then KindStar
100                  else if (Coercion.isUbxTupleKind k)     then KindStar
101                  else if (Coercion.isOpenTypeKind k)     then KindStar
102 --
103 -- The "subkinding" in GHC is not dealt with in System FC, and dealing
104 -- with it is not actually as simple as you'd think.
105 --
106 --                 else if (Coercion.isUnliftedTypeKind k) then KindUnliftedType
107 --                 else if (Coercion.isOpenTypeKind k)     then KindOpenType
108 --                 else if (Coercion.isArgTypeKind k)      then KindArgType
109 --                 else if (Coercion.isUbxTupleKind k)     then KindUnboxedTuple
110 --
111                  else if (Coercion.isTySuperKind k)      then Prelude.error "coreKindToKind got the kind-of-the-kind-of-types"
112                  else if (Coercion.isCoSuperKind k)      then Prelude.error "coreKindToKind got the kind-of-the-kind-of-coercions"
113                  else                                         Prelude.error ((Prelude.++) "coreKindToKind got an unknown kind: "
114                                                                                (Outputable.showSDoc (Outputable.ppr k)))
115 outputableToString :: Outputable.Outputable a => a -> Prelude.String
116 outputableToString = (\x -> Outputable.showSDocDebug (Outputable.ppr x))
117
118 coreViewDeep :: Type.Type -> Type.Type
119 coreViewDeep t =
120     case t of
121       TypeRep.TyVarTy tv       -> TypeRep.TyVarTy tv
122       TypeRep.FunTy arg res    -> TypeRep.FunTy (coreViewDeep arg) (coreViewDeep res)
123       TypeRep.AppTy fun arg    -> TypeRep.AppTy (coreViewDeep fun) (coreViewDeep arg)
124       TypeRep.ForAllTy fun arg -> TypeRep.ForAllTy fun (coreViewDeep arg)
125       TypeRep.TyConApp tc tys  -> let t' = TypeRep.TyConApp tc (Prelude.map coreViewDeep tys)
126                         in case Type.coreView t' of
127                                Prelude.Nothing     -> t'
128                                Prelude.Just    t'' -> t''
129       TypeRep.PredTy p         -> case Type.coreView t of
130                                Prelude.Nothing     -> TypeRep.PredTy p
131                                Prelude.Just    t'  -> t'
132
133 coreCoercionToWeakCoercion :: Type.Type -> WeakCoercion
134 coreCoercionToWeakCoercion c =
135  WCoUnsafe (errOrFail (coreTypeToWeakType t1)) (errOrFail (coreTypeToWeakType t2))
136    where
137     (t1,t2) = Coercion.coercionKind c
138 {-
139 -- REMEMBER: cotycon applications may be oversaturated
140  case c of
141   TypeRep.TyVarTy  v     -> WCoVar (WeakCoerVar v (Prelude.error "FIXME") (Prelude.error "FIXME") (Prelude.error "FIXME"))
142   TypeRep.AppTy    t1 t2 -> WCoApp   (coreCoercionToWeakCoercion t1) (coreCoercionToWeakCoercion t2)
143   TypeRep.TyConApp tc t  ->
144       case TyCon.isCoercionTyCon_maybe tc of
145         Prelude.Nothing -> Prelude.error ((Prelude.++) "coreCoercionToWeakCoercion got isCoercionTyCon_maybe " (outputableToString c))
146         Prelude.Just (_, ctcd) ->
147             case (ctcd,t) of
148               (TyCon.CoTrans , [x,y]     ) -> WCoComp   (coreCoercionToWeakCoercion x) (coreCoercionToWeakCoercion y)
149               (TyCon.CoSym   , [x]       ) -> WCoSym    (coreCoercionToWeakCoercion x)
150               (TyCon.CoLeft  , [x]       ) -> WCoLeft   (coreCoercionToWeakCoercion x)
151               (TyCon.CoRight , [x]       ) -> WCoLeft   (coreCoercionToWeakCoercion x)
152 --            (TyCon.CoUnsafe, [t1, t2 ] ) -> WCoUnsafe (coreTypeToWeakType t1) (coreTypeToWeakType t2)
153               (TyCon.CoTrans , []        ) -> Prelude.error "CoTrans is not in post-publication-appendix SystemFC1"
154               (TyCon.CoCsel1 , []        ) -> Prelude.error "CoCsel1 is not in post-publication-appendix SystemFC1"
155               (TyCon.CoCsel2 , []        ) -> Prelude.error "CoCsel2 is not in post-publication-appendix SystemFC1"
156               (TyCon.CoCselR , []        ) -> Prelude.error "CoCselR is not in post-publication-appendix SystemFC1"
157               (TyCon.CoInst  , []        ) -> Prelude.error "CoInst  is not in post-publication-appendix SystemFC1"
158               (TyCon.CoAxiom _ _ _ , _   ) -> Prelude.error "CoAxiom is not yet implemented (FIXME)"
159               ( _, [ t1 , t2 ]) -> WCoUnsafe (errOrFail (coreTypeToWeakType t1)) (errOrFail (coreTypeToWeakType t2))
160               _ -> Prelude.error ((Prelude.++) "coreCoercionToWeakCoercion got " (outputableToString c))
161   _ -> Prelude.error ((Prelude.++) "coreCoercionToWeakCoercion got " (outputableToString c))
162 -}
163 --  TypeRep.ForAllTy v t   -> WCoAll  (Prelude.error "FIXME") (coreTypeToWeakType t)
164 -- FIXME   x y                                  -> WCoAppT    (coreCoercionToWeakCoercion x) (coreCoercionToWeakType y)
165 --  CoreSyn.Type t                            -> WCoType   (coreTypeToWeakType t)
166
167 {-
168 weakCoercionToCoreCoercion :: CoreCoercion -> Type.Type
169 | WCoVar     (weakCoerVar _ _ t1 t2) => (t1,t2)
170 | WCoType    t                       => Prelude_error "FIXME WCoType"
171 | WCoApp     c1 c2                   => Prelude_error "FIXME WCoApp"
172 | WCoAppT    c t                     => Prelude_error "FIXME WCoAppT"
173 | WCoAll     k f                     => Prelude_error "FIXME WCoAll"
174 | WCoSym     c                       => let (t2,t1) := weakCoercionTypes c in (t1,t2)
175 | WCoComp    c1 c2                   => Prelude_error "FIXME WCoComp"
176 | WCoLeft    c                       => Prelude_error "FIXME WCoLeft"
177 | WCoRight   c                       => Prelude_error "FIXME WCoRight"
178 | WCoUnsafe  t1 t2                   => (t1,t2)
179 -}
180
181 {-# NOINLINE trace #-}
182 trace :: Prelude.String -> a -> a
183 trace msg x = x
184
185 --trace = Debug.Trace.trace
186 --trace msg x = x
187 --trace msg x = System.IO.Unsafe.unsafePerformIO $ Prelude.return x
188 --trace s x = x
189 --trace msg x = System.IO.Unsafe.unsafePerformIO $
190 --                (Prelude.>>=) (System.IO.hPutStrLn System.IO.stdout msg) (\_ -> Prelude.return x)
191 --trace msg x = System.IO.Unsafe.unsafePerformIO $
192 --                (Prelude.>>=) (System.IO.hPutStr System.IO.stdout " ") (\_ -> Prelude.return x)
193
194
195 {-  -- used for extracting strings WITHOUT the patch for Coq
196 bin2ascii =
197   (\ b0 b1 b2 b3 b4 b5 b6 b7 ->
198      let f b i = if b then 1 `shiftL` i else 0
199      in Data.Char.chr (f b0 0 .|. f b1 1 .|. f b2 2 .|. f b3 3 .|. f b4 4 .|. f b5 5 .|. f b6 6 .|. f b7 7))
200 -}
201
202 -- I'm leaving this here (commented out) in case I ever need it again)
203 --checkTypeEquality :: Type.Type -> Type.Type -> Prelude.Bool
204 --checkTypeEquality t1 t2 = Type.tcEqType (Type.expandTypeSynonyms t1) (Type.expandTypeSynonyms t2)