ghc/compiler/types/Class.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
   3 %
   4 \section[Class]{The @Class@ datatype}
   5
   6 \begin{code}
   7 #include "HsVersions.h"
   8
   9 module Class (
  10         GenClass(..), SYN_IE(Class),
  11
  12         mkClass,
  13         classKey, classOps, classGlobalIds,
  14         classSuperDictSelId, classOpId, classDefaultMethodId,
  15         classSig, classBigSig, classInstEnv,
  16         isSuperClassOf,
  17         classOpTagByOccName, classOpTagByOccName_maybe,
  18
  19         GenClassOp(..), SYN_IE(ClassOp),
  20         mkClassOp,
  21         classOpTag, classOpString,
  22         classOpLocalType,
  23
  24         SYN_IE(ClassInstEnv)
  25     ) where
  26
  27 CHK_Ubiq() -- debugging consistency check
  28
  29 IMPORT_DELOOPER(TyLoop)
  30
  31 #if __GLASGOW_HASKELL__ >= 202
  32 import Name
  33 #endif
  34
  35 import TyCon            ( TyCon )
  36 import TyVar            ( SYN_IE(TyVar), GenTyVar )
  37 import Usage            ( GenUsage, SYN_IE(Usage), SYN_IE(UVar) )
  38
  39 import MatchEnv         ( MatchEnv )
  40 import Maybes           ( assocMaybe )
  41 import Name             ( changeUnique, Name, OccName, occNameString )
  42 import Outputable
  43 import Unique           -- Keys for built-in classes
  44 import UniqFM           ( SYN_IE(Uniquable))
  45 import Pretty           ( Doc, hsep, ptext )
  46 import SrcLoc           ( SrcLoc )
  47 import Util
  48 \end{code}
  49
  50 %************************************************************************
  51 %*                                                                      *
  52 \subsection[Class-basic]{@Class@: basic definition}
  53 %*                                                                      *
  54 %************************************************************************
  55
  56 A @Class@ corresponds to a Greek kappa in the static semantics:
  57
  58 The parameterisation wrt tyvar and uvar is only necessary to
  59 get appropriately general instances of Ord3 for GenType.
  60
  61 \begin{code}
  62 data GenClassOp ty
  63   = ClassOp     OccName -- The operation name
  64
  65                 Int     -- Unique within a class; starts at 1
  66
  67                 ty      -- Type; the class tyvar is free (you can find
  68                         -- it from the class). This means that a
  69                         -- ClassOp doesn't make much sense outside the
  70                         -- context of its parent class.
  71
  72 data GenClass tyvar uvar
  73   = Class
  74         Unique          -- Key for fast comparison
  75         Name
  76
  77         tyvar           -- The class type variable
  78
  79         [GenClass tyvar uvar]   -- Immediate superclasses, and the
  80         [Id]                    -- corresponding selector functions to
  81                                 -- extract them from a dictionary of this
  82                                 -- class
  83
  84         [GenClassOp (GenType tyvar uvar)] -- The * class operations
  85         [Id]                              --     * selector functions
  86         [Id]                              --     * default methods
  87                           -- They are all ordered by tag.  The
  88                           -- selector ids are less innocent than they
  89                           -- look, because their IdInfos contains
  90                           -- suitable specialisation information.  In
  91                           -- particular, constant methods are
  92                           -- instances of selectors at suitably simple
  93                           -- types.
  94
  95         ClassInstEnv      -- Gives details of all the instances of this class
  96
  97         [(GenClass tyvar uvar, [GenClass tyvar uvar])]
  98                           -- Indirect superclasses;
  99                           --   (k,[k1,...,kn]) means that
 100                           --   k is an immediate superclass of k1
 101                           --   k1 is an immediate superclass of k2
 102                           --   ... and kn is an immediate superclass
 103                           -- of this class.  (This is all redundant
 104                           -- information, since it can be derived from
 105                           -- the superclass information above.)
 106
 107 type Class        = GenClass TyVar UVar
 108 type ClassOp      = GenClassOp Type
 109
 110 type ClassInstEnv = MatchEnv Type Id            -- The Ids are dfuns
 111 \end{code}
 112
 113 The @mkClass@ function fills in the indirect superclasses.
 114
 115 \begin{code}
 116 mkClass :: Unique -> Name -> TyVar
 117         -> [Class] -> [Id]
 118         -> [ClassOp] -> [Id] -> [Id]
 119         -> ClassInstEnv
 120         -> Class
 121
 122 mkClass uniq full_name tyvar super_classes superdict_sels
 123         class_ops dict_sels defms class_insts
 124   = Class uniq (changeUnique full_name uniq) tyvar
 125                 super_classes superdict_sels
 126                 class_ops dict_sels defms
 127                 class_insts
 128                 trans_clos
 129   where
 130     trans_clos :: [(Class,[Class])]
 131     trans_clos = transitiveClosure succ (==) [ (clas, []) | clas <- super_classes ]
 132
 133     succ (clas@(Class _ _ _ super_classes _ _ _ _ _ _), links)
 134       = [(super, (clas:links)) | super <- super_classes]
 135 \end{code}
 136
 137 %************************************************************************
 138 %*                                                                      *
 139 \subsection[Class-selectors]{@Class@: simple selectors}
 140 %*                                                                      *
 141 %************************************************************************
 142
 143 The rest of these functions are just simple selectors.
 144
 145 \begin{code}
 146 classKey (Class key _ _ _ _ _ _ _ _ _) = key
 147 classOps (Class _ _ _ _ _ ops _ _ _ _) = ops
 148 classGlobalIds (Class _ _ _ _ _ _ sels defm_ids _ _) = sels ++ defm_ids
 149
 150 classOpId (Class _ _ _ _ _ ops op_ids _ _ _) op
 151   = op_ids !! (classOpTag op - 1)
 152
 153 classDefaultMethodId (Class _ _ _ _ _ ops _ defm_ids _ _) idx
 154   = defm_ids !! idx
 155
 156 classSuperDictSelId (Class _ _ _ scs scsel_ids _ _ _ _ _) super_clas
 157   = assoc "classSuperDictSelId" (scs `zip` scsel_ids) super_clas
 158
 159 classSig :: GenClass t u -> (t, [GenClass t u], [GenClassOp (GenType t u)])
 160 classSig (Class _ _ tyvar super_classes _ ops _ _ _ _)
 161   = (tyvar, super_classes, ops)
 162
 163 classBigSig (Class _ _ tyvar super_classes sdsels ops sels defms _ _)
 164   = (tyvar, super_classes, sdsels, ops, sels, defms)
 165
 166 classInstEnv (Class _ _ _ _ _ _ _ _ inst_env _) = inst_env
 167 \end{code}
 168
 169 @a `isSuperClassOf` b@ returns @Nothing@ if @a@ is not a superclass of
 170 @b@, but if it is, it returns $@Just@~[k_1,\ldots,k_n]$, where the
 171 $k_1,\ldots,k_n$ are exactly as described in the definition of the
 172 @GenClass@ constructor above.
 173
 174 \begin{code}
 175 isSuperClassOf :: Class -> Class -> Maybe [Class]
 176 clas `isSuperClassOf` (Class _ _ _ _ _ _ _ _ _ links) = assocMaybe links clas
 177 \end{code}
 178
 179 %************************************************************************
 180 %*                                                                      *
 181 \subsection[Class-instances]{Instance declarations for @Class@}
 182 %*                                                                      *
 183 %************************************************************************
 184
 185 We compare @Classes@ by their keys (which include @Uniques@).
 186
 187 \begin{code}
 188 instance Ord3 (GenClass tyvar uvar) where
 189   cmp (Class k1 _ _ _ _ _ _ _ _ _) (Class k2 _ _ _ _ _ _ _ _ _)  = cmp k1 k2
 190
 191 instance Eq (GenClass tyvar uvar) where
 192     (Class k1 _ _ _ _ _ _ _ _ _) == (Class k2 _ _ _ _ _ _ _ _ _) = k1 == k2
 193     (Class k1 _ _ _ _ _ _ _ _ _) /= (Class k2 _ _ _ _ _ _ _ _ _) = k1 /= k2
 194
 195 instance Ord (GenClass tyvar uvar) where
 196     (Class k1 _ _ _ _ _ _ _ _ _) <= (Class k2 _ _ _ _ _ _ _ _ _) = k1 <= k2
 197     (Class k1 _ _ _ _ _ _ _ _ _) <  (Class k2 _ _ _ _ _ _ _ _ _) = k1 <  k2
 198     (Class k1 _ _ _ _ _ _ _ _ _) >= (Class k2 _ _ _ _ _ _ _ _ _) = k1 >= k2
 199     (Class k1 _ _ _ _ _ _ _ _ _) >  (Class k2 _ _ _ _ _ _ _ _ _) = k1 >  k2
 200     _tagCmp a b = case cmp a b of { LT_ -> _LT; EQ_ -> _EQ; GT__ -> _GT }
 201 \end{code}
 202
 203 \begin{code}
 204 instance Uniquable (GenClass tyvar uvar) where
 205     uniqueOf (Class u _ _ _ _ _ _ _ _ _) = u
 206
 207 instance NamedThing (GenClass tyvar uvar) where
 208     getName (Class _ n _ _ _ _ _ _ _ _) = n
 209
 210 instance NamedThing (GenClassOp ty) where
 211     getOccName (ClassOp occ _ _) = occ
 212 \end{code}
 213
 214
 215 %************************************************************************
 216 %*                                                                      *
 217 \subsection[ClassOp-basic]{@ClassOp@: type and basic functions}
 218 %*                                                                      *
 219 %************************************************************************
 220
 221 A @ClassOp@ represents a a class operation.  From it and its parent
 222 class we can construct the dictionary-selector @Id@ for the
 223 operation/superclass dictionary, and the @Id@ for its default method.
 224 It appears in a list inside the @Class@ object.
 225
 226 The type of a method in a @ClassOp@ object is its local type; that is,
 227 without the overloading of the class itself.  For example, in the
 228 declaration
 229 \begin{pseudocode}
 230         class Foo a where
 231                 op :: Ord b => a -> b -> a
 232 \end{pseudocode}
 233 the type recorded for @op@ in the @ClassOp@ list of the @Class@ object is
 234 just
 235         $\forall \beta.~
 236                 @Ord@~\beta \Rightarrow
 237                 \alpha \rightarrow \beta \rightarrow alpha$
 238
 239 (where $\alpha$ is the class type variable recorded in the @Class@
 240 object).  Of course, the type of @op@ recorded in the GVE will be its
 241 ``full'' type
 242
 243         $\forall \alpha \forall \beta.~
 244                 @Foo@~\alpha \Rightarrow
 245                 ~@Ord@~\beta \Rightarrow \alpha
 246                 \rightarrow \beta \rightarrow alpha$
 247
 248 ******************************************************************
 249 **** That is, the type variables of a class op selector
 250 ***  are all at the outer level.
 251 ******************************************************************
 252
 253 \begin{code}
 254 mkClassOp :: OccName -> Int -> ty -> GenClassOp ty
 255 mkClassOp name tag ty = ClassOp name tag ty
 256
 257 classOpTag :: GenClassOp ty -> Int
 258 classOpTag    (ClassOp _ tag _) = tag
 259
 260 classOpString :: GenClassOp ty -> FAST_STRING
 261 classOpString (ClassOp occ _ _) = occNameString occ
 262
 263 classOpLocalType :: GenClassOp ty -> ty {-SigmaType-}
 264 classOpLocalType (ClassOp _ _ ty) = ty
 265 \end{code}
 266
 267 Rather unsavoury ways of getting ClassOp tags:
 268 \begin{code}
 269 classOpTagByOccName_maybe :: Class -> OccName -> Maybe Int
 270 classOpTagByOccName       :: Class -> OccName -> Int
 271
 272 classOpTagByOccName clas op
 273   = case (classOpTagByOccName_maybe clas op) of
 274       Just tag -> tag
 275 #ifdef DEBUG
 276       Nothing  -> pprPanic "classOpTagByOccName:" (hsep (ppr PprDebug op : map (ptext . classOpString) (classOps clas)))
 277 #endif
 278
 279 classOpTagByOccName_maybe clas op
 280   = go (classOps clas) 1
 281   where
 282     go []                     _   = Nothing
 283     go (ClassOp occ _ _ : ns) tag = if occ == op
 284                                     then Just tag
 285                                     else go ns (tag+1)
 286 \end{code}
 287
 288 %************************************************************************
 289 %*                                                                      *
 290 \subsection[ClassOp-instances]{Instance declarations for @ClassOp@}
 291 %*                                                                      *
 292 %************************************************************************
 293
 294 @ClassOps@ are compared by their tags.
 295
 296 \begin{code}
 297 instance Eq (GenClassOp ty) where
 298     (ClassOp _ i1 _) == (ClassOp _ i2 _) = i1 == i2
 299     (ClassOp _ i1 _) /= (ClassOp _ i2 _) = i1 == i2
 300
 301 instance Ord (GenClassOp ty) where
 302     (ClassOp _ i1 _) <= (ClassOp _ i2 _) = i1 <= i2
 303     (ClassOp _ i1 _) <  (ClassOp _ i2 _) = i1 <  i2
 304     (ClassOp _ i1 _) >= (ClassOp _ i2 _) = i1 >= i2
 305     (ClassOp _ i1 _) >  (ClassOp _ i2 _) = i1 >  i2
 306     -- ToDo: something for _tagCmp? (WDP 94/10)
 307 \end{code}