2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[Class]{The @Class@ datatype}
13 mkClass, classTyVars, classArity,
14 classKey, className, classSelIds, classTyCon, classMethods,
15 classBigSig, classExtraBigSig, classTvsFds, classSCTheta
18 #include "HsVersions.h"
20 import {-# SOURCE #-} TyCon ( TyCon )
21 import {-# SOURCE #-} TypeRep ( PredType )
23 import Var ( Id, TyVar )
24 import Name ( NamedThing(..), Name )
25 import BasicTypes ( Arity )
26 import Unique ( Unique, Uniquable(..) )
30 %************************************************************************
32 \subsection[Class-basic]{@Class@: basic definition}
34 %************************************************************************
36 A @Class@ corresponds to a Greek kappa in the static semantics:
41 classKey :: Unique, -- Key for fast comparison
44 classTyVars :: [TyVar], -- The class type variables
45 classFunDeps :: [FunDep TyVar], -- The functional dependencies
47 classSCTheta :: [PredType], -- Immediate superclasses, and the
48 classSCSels :: [Id], -- corresponding selector functions to
49 -- extract them from a dictionary of this
52 classOpStuff :: [ClassOpItem], -- Ordered by tag
54 classTyCon :: TyCon -- The data type constructor for dictionaries
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])]
60 type ClassOpItem = (Id, DefMeth)
61 -- Selector function; contains unfolding
62 -- Default-method info
64 data DefMeth = NoDefMeth -- No default method
65 | DefMeth -- A polymorphic default method
66 | GenDefMeth -- A generic default method
70 The @mkClass@ function fills in the indirect superclasses.
73 mkClass :: Name -> [TyVar]
74 -> [([TyVar], [TyVar])]
80 mkClass name tyvars fds super_classes superdict_sels
82 = Class { classKey = getUnique name,
86 classSCTheta = super_classes,
87 classSCSels = superdict_sels,
88 classOpStuff = op_stuff,
92 %************************************************************************
94 \subsection[Class-selectors]{@Class@: simple selectors}
96 %************************************************************************
98 The rest of these functions are just simple selectors.
101 classArity :: Class -> Arity
102 classArity clas = length (classTyVars clas)
103 -- Could memoise this
105 classSelIds :: Class -> [Id]
106 classSelIds c@(Class {classSCSels = sc_sels})
107 = sc_sels ++ classMethods c
109 classMethods :: Class -> [Id]
110 classMethods (Class {classOpStuff = op_stuff})
111 = [op_sel | (op_sel, _) <- op_stuff]
114 = (classTyVars c, classFunDeps c)
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)
126 %************************************************************************
128 \subsection[Class-instances]{Instance declarations for @Class@}
130 %************************************************************************
132 We compare @Classes@ by their keys (which include @Uniques@).
135 instance Eq Class where
136 c1 == c2 = classKey c1 == classKey c2
137 c1 /= c2 = classKey c1 /= classKey c2
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
148 instance Uniquable Class where
149 getUnique c = classKey c
151 instance NamedThing Class where
152 getName clas = className clas
154 instance Outputable Class where
155 ppr c = ppr (getName c)
157 instance Show Class where
158 showsPrec p c = showsPrecSDoc p (ppr c)
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
165 pprFundeps :: Outputable a => [FunDep a] -> SDoc
166 pprFundeps [] = empty
167 pprFundeps fds = hsep (ptext SLIT("|") : punctuate comma (map ppr_fd fds))
169 ppr_fd (us, vs) = hsep [interppSP us, ptext SLIT("->"),