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, classInstEnv
  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
  44         classSCTheta :: [(Class,[Type])],       -- Immediate superclasses, and the
  45         classSCSels  :: [Id],                   -- corresponding selector functions to
  46                                                 -- extract them from a dictionary of this
  47                                                 -- class
  48
  49         classOpStuff :: [ClassOpItem],          -- Ordered by tag
  50
  51         classInstEnv :: InstEnv,        -- All the instances of this class
  52
  53         classTyCon :: TyCon             -- The data type constructor for dictionaries
  54   }                                     -- of this class
  55
  56 type ClassOpItem = (Id,         --   Selector function; contains unfolding
  57                     Id,         --   Default methods
  58                     Bool)       --   True <=> an explicit default method was
  59                                 --            supplied in the class decl
  60 \end{code}
  61
  62 The @mkClass@ function fills in the indirect superclasses.
  63
  64 \begin{code}
  65 mkClass :: Name -> [TyVar]
  66         -> [(Class,[Type])] -> [Id]
  67         -> [(Id, Id, Bool)]
  68         -> TyCon
  69         -> InstEnv
  70         -> Class
  71
  72 mkClass name tyvars super_classes superdict_sels
  73         op_stuff tycon class_insts
  74   = Class {     classKey = getUnique name,
  75                 className = name,
  76                 classTyVars = tyvars,
  77                 classSCTheta = super_classes,
  78                 classSCSels = superdict_sels,
  79                 classOpStuff = op_stuff,
  80                 classInstEnv = class_insts,
  81                 classTyCon = tycon }
  82 \end{code}
  83
  84 %************************************************************************
  85 %*                                                                      *
  86 \subsection[Class-selectors]{@Class@: simple selectors}
  87 %*                                                                      *
  88 %************************************************************************
  89
  90 The rest of these functions are just simple selectors.
  91
  92 \begin{code}
  93 classSelIds (Class {classSCSels = sc_sels, classOpStuff = op_stuff})
  94   = sc_sels ++ [op_sel | (op_sel, _, _) <- op_stuff]
  95
  96 classBigSig (Class {classTyVars = tyvars, classSCTheta = sc_theta,
  97                     classSCSels = sc_sels, classOpStuff = op_stuff})
  98   = (tyvars, sc_theta, sc_sels, op_stuff)
  99 \end{code}
 100
 101
 102 %************************************************************************
 103 %*                                                                      *
 104 \subsection[Class-instances]{Instance declarations for @Class@}
 105 %*                                                                      *
 106 %************************************************************************
 107
 108 We compare @Classes@ by their keys (which include @Uniques@).
 109
 110 \begin{code}
 111 instance Eq Class where
 112     c1 == c2 = classKey c1 == classKey c2
 113     c1 /= c2 = classKey c1 /= classKey c2
 114
 115 instance Ord Class where
 116     c1 <= c2 = classKey c1 <= classKey c2
 117     c1 <  c2 = classKey c1 <  classKey c2
 118     c1 >= c2 = classKey c1 >= classKey c2
 119     c1 >  c2 = classKey c1 >  classKey c2
 120     compare c1 c2 = classKey c1 `compare` classKey c2
 121 \end{code}
 122
 123 \begin{code}
 124 instance Uniquable Class where
 125     getUnique c = classKey c
 126
 127 instance NamedThing Class where
 128     getName clas = className clas
 129
 130 instance Outputable Class where
 131     ppr c = ppr (getName c)
 132
 133 instance Show Class where
 134     showsPrec p c = showsPrecSDoc p (ppr c)
 135 \end{code}
 136
 137