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