ghc/compiler/types/Class.lhs

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