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, FunDep,
   9         DefMeth (..),
  10
  11         mkClass, classTyVars, classArity,
  12         classKey, className, classSelIds, classTyCon,
  13         classBigSig, classExtraBigSig, classTvsFds, classSCTheta,
  14         classHasFDs
  15     ) where
  16
  17 #include "HsVersions.h"
  18
  19 import {-# SOURCE #-} TyCon     ( TyCon )
  20 import {-# SOURCE #-} TypeRep   ( PredType )
  21
  22 import Var              ( Id, TyVar )
  23 import Name             ( NamedThing(..), Name )
  24 import BasicTypes       ( Arity )
  25 import Unique           ( Unique, Uniquable(..) )
  26 import Outputable
  27 import Util             ( notNull )
  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 Name)
  61         -- Selector function; contains unfolding
  62         -- Default-method info
  63
  64 data DefMeth id = NoDefMeth             -- No default method
  65                 | DefMeth id            -- A polymorphic default method (named id)
  66                                         --      (Only instantiated to RdrName and Name, never Id)
  67                 | GenDefMeth            -- A generic default method
  68                 deriving Eq
  69 \end{code}
  70
  71 The @mkClass@ function fills in the indirect superclasses.
  72
  73 \begin{code}
  74 mkClass :: Name -> [TyVar]
  75         -> [([TyVar], [TyVar])]
  76         -> [PredType] -> [Id]
  77         -> [ClassOpItem]
  78         -> TyCon
  79         -> Class
  80
  81 mkClass name tyvars fds super_classes superdict_sels
  82         op_stuff tycon
  83   = Class {     classKey = getUnique name,
  84                 className = name,
  85                 classTyVars = tyvars,
  86                 classFunDeps = fds,
  87                 classSCTheta = super_classes,
  88                 classSCSels = superdict_sels,
  89                 classOpStuff = op_stuff,
  90                 classTyCon = tycon }
  91 \end{code}
  92
  93 %************************************************************************
  94 %*                                                                      *
  95 \subsection[Class-selectors]{@Class@: simple selectors}
  96 %*                                                                      *
  97 %************************************************************************
  98
  99 The rest of these functions are just simple selectors.
 100
 101 \begin{code}
 102 classArity :: Class -> Arity
 103 classArity clas = length (classTyVars clas)
 104         -- Could memoise this
 105
 106 classSelIds (Class {classSCSels = sc_sels, classOpStuff = op_stuff})
 107   = sc_sels ++ [op_sel | (op_sel, _) <- op_stuff]
 108
 109 classTvsFds c
 110   = (classTyVars c, classFunDeps c)
 111
 112 classBigSig (Class {classTyVars = tyvars, classSCTheta = sc_theta,
 113                     classSCSels = sc_sels, classOpStuff = op_stuff})
 114   = (tyvars, sc_theta, sc_sels, op_stuff)
 115 classExtraBigSig (Class {classTyVars = tyvars, classFunDeps = fundeps,
 116                          classSCTheta = sc_theta, classSCSels = sc_sels,
 117                          classOpStuff = op_stuff})
 118   = (tyvars, fundeps, sc_theta, sc_sels, op_stuff)
 119
 120 classHasFDs :: Class -> Bool
 121 classHasFDs (Class {classFunDeps = fundeps}) = notNull fundeps
 122 \end{code}
 123
 124
 125 %************************************************************************
 126 %*                                                                      *
 127 \subsection[Class-instances]{Instance declarations for @Class@}
 128 %*                                                                      *
 129 %************************************************************************
 130
 131 We compare @Classes@ by their keys (which include @Uniques@).
 132
 133 \begin{code}
 134 instance Eq Class where
 135     c1 == c2 = classKey c1 == classKey c2
 136     c1 /= c2 = classKey c1 /= classKey c2
 137
 138 instance Ord Class where
 139     c1 <= c2 = classKey c1 <= classKey c2
 140     c1 <  c2 = classKey c1 <  classKey c2
 141     c1 >= c2 = classKey c1 >= classKey c2
 142     c1 >  c2 = classKey c1 >  classKey c2
 143     compare c1 c2 = classKey c1 `compare` classKey c2
 144 \end{code}
 145
 146 \begin{code}
 147 instance Uniquable Class where
 148     getUnique c = classKey c
 149
 150 instance NamedThing Class where
 151     getName clas = className clas
 152
 153 instance Outputable Class where
 154     ppr c = ppr (getName c)
 155
 156 instance Show Class where
 157     showsPrec p c = showsPrecSDoc p (ppr c)
 158 \end{code}
 159
 160