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