ghc/compiler/hsSyn/HsTypes.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
   3 %
   4 \section[HsTypes]{Abstract syntax: user-defined types}
   5
   6 If compiled without \tr{#define COMPILING_GHC}, you get
   7 (part of) a Haskell-abstract-syntax library.  With it,
   8 you get part of GHC.
   9
  10 \begin{code}
  11 #include "HsVersions.h"
  12
  13 module HsTypes (
  14         PolyType(..), MonoType(..),
  15         SYN_IE(Context), SYN_IE(ClassAssertion)
  16
  17 #ifdef COMPILING_GHC
  18         , pprParendPolyType
  19         , pprParendMonoType, pprContext
  20         , extractMonoTyNames, extractCtxtTyNames
  21         , cmpPolyType, cmpMonoType, cmpContext
  22 #endif
  23     ) where
  24
  25 #ifdef COMPILING_GHC
  26 IMP_Ubiq()
  27
  28 import Outputable       ( interppSP, ifnotPprForUser )
  29 import Pretty
  30 import Util             ( thenCmp, cmpList, isIn, panic# )
  31
  32 #endif {- COMPILING_GHC -}
  33 \end{code}
  34
  35 This is the syntax for types as seen in type signatures.
  36
  37 \begin{code}
  38 data PolyType name
  39   = HsPreForAllTy       (Context name)
  40                         (MonoType name)
  41
  42         -- The renamer turns HsPreForAllTys into HsForAllTys when they
  43         -- occur in signatures, to make the binding of variables
  44         -- explicit.  This distinction is made visible for
  45         -- non-COMPILING_GHC code, because you probably want to do the
  46         -- same thing.
  47
  48   | HsForAllTy          [name]
  49                         (Context name)
  50                         (MonoType name)
  51
  52 type Context name = [ClassAssertion name]
  53
  54 type ClassAssertion name = (name, name)
  55
  56 data MonoType name
  57   = MonoTyVar           name            -- Type variable
  58
  59   | MonoTyApp           name            -- Type constructor or variable
  60                         [MonoType name]
  61
  62     -- We *could* have a "MonoTyCon name" equiv to "MonoTyApp name []"
  63     -- (for efficiency, what?)  WDP 96/02/18
  64
  65   | MonoFunTy           (MonoType name) -- function type
  66                         (MonoType name)
  67
  68   | MonoListTy          (MonoType name) -- list type
  69   | MonoTupleTy         [MonoType name] -- tuple type (length gives arity)
  70
  71 #ifdef COMPILING_GHC
  72   -- these next two are only used in unfoldings in interfaces
  73   | MonoDictTy          name    -- Class
  74                         (MonoType name)
  75
  76   | MonoForAllTy        [(name, Kind)]
  77                         (MonoType name)
  78         -- *** NOTA BENE *** A "monotype" in a pragma can have
  79         -- for-alls in it, (mostly to do with dictionaries).  These
  80         -- must be explicitly Kinded.
  81
  82 #endif {- COMPILING_GHC -}
  83 \end{code}
  84
  85 This is used in various places:
  86 \begin{code}
  87 #ifdef COMPILING_GHC
  88 pprContext :: (Outputable name) => PprStyle -> (Context name) -> Pretty
  89
  90 pprContext sty []           = ppNil
  91 pprContext sty [(clas, ty)] = ppCat [ppr sty clas, ppr sty ty, ppStr "=>"]
  92 pprContext sty context
  93   = ppBesides [ppLparen,
  94            ppInterleave ppComma (map pp_assert context),
  95            ppRparen, ppStr " =>"]
  96   where
  97     pp_assert (clas, ty)
  98       = ppCat [ppr sty clas, ppr sty ty]
  99 \end{code}
 100
 101 \begin{code}
 102 instance (Outputable name) => Outputable (PolyType name) where
 103     ppr sty (HsPreForAllTy ctxt ty)
 104       = print_it sty ppNil ctxt ty
 105     ppr sty (HsForAllTy [] ctxt ty)
 106       = print_it sty ppNil ctxt ty
 107     ppr sty (HsForAllTy tvs ctxt ty)
 108       = print_it sty
 109             (ppBesides [ppStr "_forall_ ", interppSP sty tvs, ppStr " => "])
 110             ctxt ty
 111
 112 print_it sty pp_forall ctxt ty
 113   = ppCat [ifnotPprForUser sty pp_forall, -- print foralls unless PprForUser
 114            pprContext sty ctxt, ppr sty ty]
 115
 116 pprParendPolyType :: Outputable name => PprStyle -> PolyType name -> Pretty
 117 pprParendPolyType sty ty = ppr sty ty -- ToDo: more later
 118
 119 instance (Outputable name) => Outputable (MonoType name) where
 120     ppr = pprMonoType
 121
 122 pREC_TOP = (0 :: Int)
 123 pREC_FUN = (1 :: Int)
 124 pREC_CON = (2 :: Int)
 125
 126 -- printing works more-or-less as for Types
 127
 128 pprMonoType, pprParendMonoType :: (Outputable name) => PprStyle -> MonoType name -> Pretty
 129
 130 pprMonoType sty ty       = ppr_mono_ty sty pREC_TOP ty
 131 pprParendMonoType sty ty = ppr_mono_ty sty pREC_CON ty
 132
 133 ppr_mono_ty sty ctxt_prec (MonoTyVar name) = ppr sty name
 134
 135 ppr_mono_ty sty ctxt_prec (MonoFunTy ty1 ty2)
 136   = let p1 = ppr_mono_ty sty pREC_FUN ty1
 137         p2 = ppr_mono_ty sty pREC_TOP ty2
 138     in
 139     if ctxt_prec < pREC_FUN then -- no parens needed
 140         ppSep [p1, ppBeside (ppStr "-> ") p2]
 141     else
 142         ppSep [ppBeside ppLparen p1, ppBesides [ppStr "-> ", p2, ppRparen]]
 143
 144 ppr_mono_ty sty ctxt_prec (MonoTupleTy tys)
 145  = ppBesides [ppLparen, ppInterleave ppComma (map (ppr sty) tys), ppRparen]
 146
 147 ppr_mono_ty sty ctxt_prec (MonoListTy ty)
 148  = ppBesides [ppLbrack, ppr_mono_ty sty pREC_TOP ty, ppRbrack]
 149
 150 ppr_mono_ty sty ctxt_prec (MonoTyApp tycon tys)
 151   = let pp_tycon = ppr sty tycon in
 152     if null tys then
 153         pp_tycon
 154     else if ctxt_prec < pREC_CON then -- no parens needed
 155         ppCat [pp_tycon, ppInterleave ppNil (map (ppr_mono_ty sty pREC_CON) tys)]
 156     else
 157         ppBesides [ ppLparen, pp_tycon, ppSP,
 158                ppInterleave ppNil (map (ppr_mono_ty sty pREC_CON) tys), ppRparen ]
 159
 160 -- unfoldings only
 161 ppr_mono_ty sty ctxt_prec (MonoDictTy clas ty)
 162   = ppBesides [ppStr "{{", ppr sty clas, ppSP, ppr_mono_ty sty ctxt_prec ty, ppStr "}}"]
 163
 164 #endif {- COMPILING_GHC -}
 165 \end{code}
 166
 167 \begin{code}
 168 #ifdef COMPILING_GHC
 169
 170 extractCtxtTyNames :: Eq name => Context  name -> [name]
 171 extractMonoTyNames :: Eq name => (name -> Bool) -> MonoType name -> [name]
 172
 173 extractCtxtTyNames ctxt
 174   = foldr get [] ctxt
 175   where
 176     get (clas, tv) acc
 177       | tv `is_elem` acc = acc
 178       | otherwise        = tv : acc
 179
 180     is_elem = isIn "extractCtxtTyNames"
 181
 182 extractMonoTyNames is_tyvar_name ty
 183   = get ty []
 184   where
 185     get (MonoTyApp con tys) acc = let
 186                                      rest = foldr get acc tys
 187                                   in
 188                                   if is_tyvar_name con && not (con `is_elem` rest)
 189                                   then con : rest
 190                                   else rest
 191     get (MonoListTy ty)     acc = get ty acc
 192     get (MonoFunTy ty1 ty2) acc = get ty1 (get ty2 acc)
 193     get (MonoDictTy _ ty)   acc = get ty acc
 194     get (MonoTupleTy tys)   acc = foldr get acc tys
 195     get (MonoTyVar tv)      acc
 196       | tv `is_elem` acc        = acc
 197       | otherwise               = tv : acc
 198
 199     is_elem = isIn "extractMonoTyNames"
 200
 201 #endif {- COMPILING_GHC -}
 202 \end{code}
 203
 204 We do define a specialised equality for these \tr{*Type} types; used
 205 in checking interfaces.  Most any other use is likely to be {\em
 206 wrong}, so be careful!
 207 \begin{code}
 208 #ifdef COMPILING_GHC
 209
 210 cmpPolyType :: (a -> a -> TAG_) -> PolyType a -> PolyType a -> TAG_
 211 cmpMonoType :: (a -> a -> TAG_) -> MonoType a -> MonoType a -> TAG_
 212 cmpContext  :: (a -> a -> TAG_) -> Context  a -> Context  a -> TAG_
 213
 214 -- We assume that HsPreForAllTys have been smashed by now.
 215 # ifdef DEBUG
 216 cmpPolyType _ (HsPreForAllTy _ _) _ = panic# "cmpPolyType:HsPreForAllTy:1st arg"
 217 cmpPolyType _ _ (HsPreForAllTy _ _) = panic# "cmpPolyType:HsPreForAllTy:2nd arg"
 218 # endif
 219
 220 cmpPolyType cmp (HsForAllTy tvs1 c1 t1) (HsForAllTy tvs2 c2 t2)
 221   = cmpList cmp tvs1 tvs2   `thenCmp`
 222     cmpContext cmp c1 c2    `thenCmp`
 223     cmpMonoType cmp t1 t2
 224
 225 -----------
 226 cmpMonoType cmp (MonoTyVar n1) (MonoTyVar n2)
 227   = cmp n1 n2
 228
 229 cmpMonoType cmp (MonoTupleTy tys1) (MonoTupleTy tys2)
 230   = cmpList (cmpMonoType cmp) tys1 tys2
 231 cmpMonoType cmp (MonoListTy ty1) (MonoListTy ty2)
 232   = cmpMonoType cmp ty1 ty2
 233
 234 cmpMonoType cmp (MonoTyApp tc1 tys1) (MonoTyApp tc2 tys2)
 235   = cmp tc1 tc2 `thenCmp`
 236     cmpList (cmpMonoType cmp) tys1 tys2
 237
 238 cmpMonoType cmp (MonoFunTy a1 b1) (MonoFunTy a2 b2)
 239   = cmpMonoType cmp a1 a2 `thenCmp` cmpMonoType cmp b1 b2
 240
 241 cmpMonoType cmp (MonoDictTy c1 ty1)   (MonoDictTy c2 ty2)
 242   = cmp c1 c2 `thenCmp` cmpMonoType cmp ty1 ty2
 243
 244 cmpMonoType cmp ty1 ty2 -- tags must be different
 245   = let tag1 = tag ty1
 246         tag2 = tag ty2
 247     in
 248     if tag1 _LT_ tag2 then LT_ else GT_
 249   where
 250     tag (MonoTyVar n1)          = (ILIT(1) :: FAST_INT)
 251     tag (MonoTupleTy tys1)      = ILIT(2)
 252     tag (MonoListTy ty1)        = ILIT(3)
 253     tag (MonoTyApp tc1 tys1)    = ILIT(4)
 254     tag (MonoFunTy a1 b1)       = ILIT(5)
 255     tag (MonoDictTy c1 ty1)     = ILIT(7)
 256
 257 -------------------
 258 cmpContext cmp a b
 259   = cmpList cmp_ctxt a b
 260   where
 261     cmp_ctxt (c1, tv1) (c2, tv2)
 262       = cmp c1 c2 `thenCmp` cmp tv1 tv2
 263
 264 #endif {- COMPILING_GHC -}
 265 \end{code}