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,
   9
  10         mkClass, classTyVars,
  11         classKey, classSelIds, classTyCon,
  12         classBigSig, classExtraBigSig, classInstEnv, classTvsFds
  13     ) where
  14
  15 #include "HsVersions.h"
  16
  17 import {-# SOURCE #-} TyCon     ( TyCon )
  18 import {-# SOURCE #-} TypeRep   ( Type )
  19 import {-# SOURCE #-} InstEnv   ( InstEnv )
  20
  21 import Var              ( Id, TyVar )
  22 import Name             ( NamedThing(..), Name )
  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 :: [([TyVar], [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         classInstEnv :: InstEnv,        -- All the instances of this class
  53
  54         classTyCon :: TyCon             -- The data type constructor for dictionaries
  55   }                                     -- of this class
  56
  57 type ClassOpItem = (Id,         --   Selector function; contains unfolding
  58                     Id,         --   Default methods
  59                     Bool)       --   True <=> an explicit default method was
  60                                 --            supplied in the class decl
  61 \end{code}
  62
  63 The @mkClass@ function fills in the indirect superclasses.
  64
  65 \begin{code}
  66 mkClass :: Name -> [TyVar]
  67         -> [([TyVar], [TyVar])]
  68         -> [(Class,[Type])] -> [Id]
  69         -> [(Id, Id, Bool)]
  70         -> TyCon
  71         -> InstEnv
  72         -> Class
  73
  74 mkClass name tyvars fds super_classes superdict_sels
  75         op_stuff tycon class_insts
  76   = Class {     classKey = getUnique name,
  77                 className = name,
  78                 classTyVars = tyvars,
  79                 classFunDeps = fds,
  80                 classSCTheta = super_classes,
  81                 classSCSels = superdict_sels,
  82                 classOpStuff = op_stuff,
  83                 classInstEnv = class_insts,
  84                 classTyCon = tycon }
  85 \end{code}
  86
  87 %************************************************************************
  88 %*                                                                      *
  89 \subsection[Class-selectors]{@Class@: simple selectors}
  90 %*                                                                      *
  91 %************************************************************************
  92
  93 The rest of these functions are just simple selectors.
  94
  95 \begin{code}
  96 classSelIds (Class {classSCSels = sc_sels, classOpStuff = op_stuff})
  97   = sc_sels ++ [op_sel | (op_sel, _, _) <- op_stuff]
  98
  99 classTvsFds c
 100   = (classTyVars c, classFunDeps c)
 101
 102 classBigSig (Class {classTyVars = tyvars, classSCTheta = sc_theta,
 103                     classSCSels = sc_sels, classOpStuff = op_stuff})
 104   = (tyvars, sc_theta, sc_sels, op_stuff)
 105 classExtraBigSig (Class {classTyVars = tyvars, classFunDeps = fundeps,
 106                          classSCTheta = sc_theta, classSCSels = sc_sels,
 107                          classOpStuff = op_stuff})
 108   = (tyvars, fundeps, sc_theta, sc_sels, op_stuff)
 109 \end{code}
 110
 111
 112 %************************************************************************
 113 %*                                                                      *
 114 \subsection[Class-instances]{Instance declarations for @Class@}
 115 %*                                                                      *
 116 %************************************************************************
 117
 118 We compare @Classes@ by their keys (which include @Uniques@).
 119
 120 \begin{code}
 121 instance Eq Class where
 122     c1 == c2 = classKey c1 == classKey c2
 123     c1 /= c2 = classKey c1 /= classKey c2
 124
 125 instance Ord Class where
 126     c1 <= c2 = classKey c1 <= classKey c2
 127     c1 <  c2 = classKey c1 <  classKey c2
 128     c1 >= c2 = classKey c1 >= classKey c2
 129     c1 >  c2 = classKey c1 >  classKey c2
 130     compare c1 c2 = classKey c1 `compare` classKey c2
 131 \end{code}
 132
 133 \begin{code}
 134 instance Uniquable Class where
 135     getUnique c = classKey c
 136
 137 instance NamedThing Class where
 138     getName clas = className clas
 139
 140 instance Outputable Class where
 141     ppr c = ppr (getName c)
 142
 143 instance Show Class where
 144     showsPrec p c = showsPrecSDoc p (ppr c)
 145 \end{code}
 146
 147