compiler/types/Class.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5
   6 The @Class@ datatype
   7
   8 \begin{code}
   9 module Class (
  10         Class, ClassOpItem,
  11         DefMeth (..),
  12
  13         FunDep, pprFundeps,
  14
  15         mkClass, classTyVars, classArity,
  16         classKey, className, classATs, classSelIds, classTyCon, classMethods,
  17         classBigSig, classExtraBigSig, classTvsFds, classSCTheta
  18     ) where
  19
  20 #include "HsVersions.h"
  21
  22 import {-# SOURCE #-} TyCon     ( TyCon )
  23 import {-# SOURCE #-} TypeRep   ( PredType )
  24
  25 import Var
  26 import Name
  27 import BasicTypes
  28 import Unique
  29 import Outputable
  30 \end{code}
  31
  32 %************************************************************************
  33 %*                                                                      *
  34 \subsection[Class-basic]{@Class@: basic definition}
  35 %*                                                                      *
  36 %************************************************************************
  37
  38 A @Class@ corresponds to a Greek kappa in the static semantics:
  39
  40 \begin{code}
  41 data Class
  42   = Class {
  43         classKey  :: Unique,            -- Key for fast comparison
  44         className :: Name,
  45
  46         classTyVars  :: [TyVar],        -- The class type variables
  47         classFunDeps :: [FunDep TyVar], -- The functional dependencies
  48
  49         classSCTheta :: [PredType],     -- Immediate superclasses, and the
  50         classSCSels  :: [Id],           -- corresponding selector functions
  51                                         -- to extract them from a dictionary
  52                                         -- of this class
  53
  54         classATs     :: [TyCon],        -- Associated type families
  55
  56         classOpStuff :: [ClassOpItem],  -- Ordered by tag
  57
  58         classTyCon :: TyCon             -- The data type constructor for
  59                                         -- dictionaries of this class
  60      }
  61
  62 type FunDep a = ([a],[a])  --  e.g. class C a b c | a b -> c, a c -> b where...
  63                            --  Here fun-deps are [([a,b],[c]), ([a,c],[b])]
  64
  65 type ClassOpItem = (Id, DefMeth)
  66         -- Selector function; contains unfolding
  67         -- Default-method info
  68
  69 data DefMeth = NoDefMeth                -- No default method
  70              | DefMeth                  -- A polymorphic default method
  71              | GenDefMeth               -- A generic default method
  72              deriving Eq
  73 \end{code}
  74
  75 The @mkClass@ function fills in the indirect superclasses.
  76
  77 \begin{code}
  78 mkClass :: Name -> [TyVar]
  79         -> [([TyVar], [TyVar])]
  80         -> [PredType] -> [Id]
  81         -> [TyCon]
  82         -> [ClassOpItem]
  83         -> TyCon
  84         -> Class
  85
  86 mkClass name tyvars fds super_classes superdict_sels ats
  87         op_stuff tycon
  88   = Class {     classKey = getUnique name,
  89                 className = name,
  90                 classTyVars = tyvars,
  91                 classFunDeps = fds,
  92                 classSCTheta = super_classes,
  93                 classSCSels = superdict_sels,
  94                 classATs = ats,
  95                 classOpStuff = op_stuff,
  96                 classTyCon = tycon }
  97 \end{code}
  98
  99 %************************************************************************
 100 %*                                                                      *
 101 \subsection[Class-selectors]{@Class@: simple selectors}
 102 %*                                                                      *
 103 %************************************************************************
 104
 105 The rest of these functions are just simple selectors.
 106
 107 \begin{code}
 108 classArity :: Class -> Arity
 109 classArity clas = length (classTyVars clas)
 110         -- Could memoise this
 111
 112 classSelIds :: Class -> [Id]
 113 classSelIds c@(Class {classSCSels = sc_sels})
 114   = sc_sels ++ classMethods c
 115
 116 classMethods :: Class -> [Id]
 117 classMethods (Class {classOpStuff = op_stuff})
 118   = [op_sel | (op_sel, _) <- op_stuff]
 119
 120 classTvsFds c
 121   = (classTyVars c, classFunDeps c)
 122
 123 classBigSig (Class {classTyVars = tyvars, classSCTheta = sc_theta,
 124                     classSCSels = sc_sels, classOpStuff = op_stuff})
 125   = (tyvars, sc_theta, sc_sels, op_stuff)
 126 classExtraBigSig (Class {classTyVars = tyvars, classFunDeps = fundeps,
 127                          classSCTheta = sc_theta, classSCSels = sc_sels,
 128                          classATs = ats, classOpStuff = op_stuff})
 129   = (tyvars, fundeps, sc_theta, sc_sels, ats, op_stuff)
 130 \end{code}
 131
 132
 133 %************************************************************************
 134 %*                                                                      *
 135 \subsection[Class-instances]{Instance declarations for @Class@}
 136 %*                                                                      *
 137 %************************************************************************
 138
 139 We compare @Classes@ by their keys (which include @Uniques@).
 140
 141 \begin{code}
 142 instance Eq Class where
 143     c1 == c2 = classKey c1 == classKey c2
 144     c1 /= c2 = classKey c1 /= classKey c2
 145
 146 instance Ord Class where
 147     c1 <= c2 = classKey c1 <= classKey c2
 148     c1 <  c2 = classKey c1 <  classKey c2
 149     c1 >= c2 = classKey c1 >= classKey c2
 150     c1 >  c2 = classKey c1 >  classKey c2
 151     compare c1 c2 = classKey c1 `compare` classKey c2
 152 \end{code}
 153
 154 \begin{code}
 155 instance Uniquable Class where
 156     getUnique c = classKey c
 157
 158 instance NamedThing Class where
 159     getName clas = className clas
 160
 161 instance Outputable Class where
 162     ppr c = ppr (getName c)
 163
 164 instance Show Class where
 165     showsPrec p c = showsPrecSDoc p (ppr c)
 166
 167 instance Outputable DefMeth where
 168     ppr DefMeth     =  text "{- has default method -}"
 169     ppr GenDefMeth  =  text "{- has generic method -}"
 170     ppr NoDefMeth   =  empty   -- No default method
 171
 172 pprFundeps :: Outputable a => [FunDep a] -> SDoc
 173 pprFundeps []  = empty
 174 pprFundeps fds = hsep (ptext SLIT("|") : punctuate comma (map ppr_fd fds))
 175                where
 176                  ppr_fd (us, vs) = hsep [interppSP us, ptext SLIT("->"),
 177                                          interppSP vs]
 178 \end{code}
 179