2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[HsBinds]{Abstract syntax: top-level bindings and signatures}
6 Datatype for: @BindGroup@, @Bind@, @Sig@, @Bind@.
11 #include "HsVersions.h"
13 import {-# SOURCE #-} HsExpr ( HsExpr, pprExpr, LHsExpr,
14 MatchGroup, pprFunBind,
16 import {-# SOURCE #-} HsPat ( LPat )
18 import HsTypes ( LHsType, PostTcType )
21 import NameSet ( NameSet, elemNameSet )
22 import BasicTypes ( IPName, RecFlag(..), InlineSpec(..), Fixity )
24 import SrcLoc ( Located(..), SrcSpan, unLoc )
25 import Util ( sortLe )
26 import Var ( TyVar, DictId, Id )
27 import Bag ( Bag, emptyBag, isEmptyBag, bagToList, unionBags, unionManyBags )
30 %************************************************************************
32 \subsection{Bindings: @BindGroup@}
34 %************************************************************************
36 Global bindings (where clauses)
39 data HsLocalBinds id -- Bindings in a 'let' expression
40 -- or a 'where' clause
41 = HsValBinds (HsValBinds id)
42 | HsIPBinds (HsIPBinds id)
46 data HsValBinds id -- Value bindings (not implicit parameters)
47 = ValBindsIn -- Before typechecking
48 (LHsBinds id) [LSig id] -- Not dependency analysed
49 -- Recursive by default
51 | ValBindsOut -- After renaming
52 [(RecFlag, LHsBinds id)] -- Dependency analysed
55 type LHsBinds id = Bag (LHsBind id)
56 type DictBinds id = LHsBinds id -- Used for dictionary or method bindings
57 type LHsBind id = Located (HsBind id)
60 = FunBind { -- FunBind is used for both functions f x = e
61 -- and variables f = \x -> e
62 -- Reason 1: Special case for type inference: see TcBinds.tcMonoBinds
64 -- Reason 2: instance decls can only have FunBinds, which is convenient
65 -- If you change this, you'll need tochange e.g. rnMethodBinds
67 -- But note that the form f :: a->a = ...
68 -- parses as a pattern binding, just like
69 -- (f :: a -> a) = ...
73 fun_infix :: Bool, -- True => infix declaration
75 fun_matches :: MatchGroup id, -- The payload
77 fun_co_fn :: ExprCoFn, -- Coercion from the type of the MatchGroup to the type of
79 -- f :: Int -> forall a. a -> a
81 -- Then the MatchGroup will have type (Int -> a' -> a')
82 -- (with a free type variable a'). The coercion will take
83 -- a CoreExpr of this type and convert it to a CoreExpr of
84 -- type Int -> forall a'. a' -> a'
85 -- Notice that the coercion captures the free a'. That's
86 -- why coercions are (CoreExpr -> CoreExpr), rather than
87 -- just CoreExpr (with a functional type)
89 bind_fvs :: NameSet -- After the renamer, this contains a superset of the
90 -- Names of the other binders in this binding group that
91 -- are free in the RHS of the defn
92 -- Before renaming, and after typechecking,
93 -- the field is unused; it's just an error thunk
96 | PatBind { -- The pattern is never a simple variable;
97 -- That case is done by FunBind
100 pat_rhs_ty :: PostTcType, -- Type of the GRHSs
101 bind_fvs :: NameSet -- Same as for FunBind
104 | VarBind { -- Dictionary binding and suchlike
105 var_id :: id, -- All VarBinds are introduced by the type checker
106 var_rhs :: LHsExpr id -- Located only for consistency
109 | AbsBinds { -- Binds abstraction; TRANSLATION
111 abs_dicts :: [DictId],
112 abs_exports :: [([TyVar], id, id, [Prag])], -- (tvs, poly_id, mono_id, prags)
113 abs_binds :: LHsBinds id -- The dictionary bindings and typechecked user bindings
114 -- mixed up together; you can tell the dict bindings because
115 -- they are all VarBinds
117 -- Consider (AbsBinds tvs ds [(ftvs, poly_f, mono_f) binds]
119 -- Creates bindings for (polymorphic, overloaded) poly_f
120 -- in terms of monomorphic, non-overloaded mono_f
123 -- 1. 'binds' binds mono_f
124 -- 2. ftvs is a subset of tvs
125 -- 3. ftvs includes all tyvars free in ds
127 -- See section 9 of static semantics paper for more details.
128 -- (You can get a PhD for explaining the True Meaning
129 -- of this last construct.)
131 placeHolderNames :: NameSet
132 -- Used for the NameSet in FunBind and PatBind prior to the renamer
133 placeHolderNames = panic "placeHolderNames"
136 instance OutputableBndr id => Outputable (HsLocalBinds id) where
137 ppr (HsValBinds bs) = ppr bs
138 ppr (HsIPBinds bs) = ppr bs
139 ppr EmptyLocalBinds = empty
141 instance OutputableBndr id => Outputable (HsValBinds id) where
142 ppr (ValBindsIn binds sigs)
143 = pprValBindsForUser binds sigs
145 ppr (ValBindsOut sccs sigs)
146 = getPprStyle $ \ sty ->
147 if debugStyle sty then -- Print with sccs showing
148 vcat (map ppr sigs) $$ vcat (map ppr_scc sccs)
150 pprValBindsForUser (unionManyBags (map snd sccs)) sigs
152 ppr_scc (rec_flag, binds) = pp_rec rec_flag <+> pprLHsBinds binds
153 pp_rec Recursive = ptext SLIT("rec")
154 pp_rec NonRecursive = ptext SLIT("nonrec")
156 -- *not* pprLHsBinds because we don't want braces; 'let' and
157 -- 'where' include a list of HsBindGroups and we don't want
158 -- several groups of bindings each with braces around.
159 -- Sort by location before printing
160 pprValBindsForUser :: (OutputableBndr id1, OutputableBndr id2)
161 => LHsBinds id1 -> [LSig id2] -> SDoc
162 pprValBindsForUser binds sigs
163 = vcat (map snd (sort_by_loc decls))
166 decls :: [(SrcSpan, SDoc)]
167 decls = [(loc, ppr sig) | L loc sig <- sigs] ++
168 [(loc, ppr bind) | L loc bind <- bagToList binds]
170 sort_by_loc decls = sortLe (\(l1,_) (l2,_) -> l1 <= l2) decls
172 pprLHsBinds :: OutputableBndr id => LHsBinds id -> SDoc
174 | isEmptyLHsBinds binds = empty
175 | otherwise = lbrace <+> vcat (map ppr (bagToList binds)) <+> rbrace
178 emptyLocalBinds :: HsLocalBinds a
179 emptyLocalBinds = EmptyLocalBinds
181 isEmptyLocalBinds :: HsLocalBinds a -> Bool
182 isEmptyLocalBinds (HsValBinds ds) = isEmptyValBinds ds
183 isEmptyLocalBinds (HsIPBinds ds) = isEmptyIPBinds ds
184 isEmptyLocalBinds EmptyLocalBinds = True
186 isEmptyValBinds :: HsValBinds a -> Bool
187 isEmptyValBinds (ValBindsIn ds sigs) = isEmptyLHsBinds ds && null sigs
188 isEmptyValBinds (ValBindsOut ds sigs) = null ds && null sigs
190 emptyValBindsIn, emptyValBindsOut :: HsValBinds a
191 emptyValBindsIn = ValBindsIn emptyBag []
192 emptyValBindsOut = ValBindsOut [] []
194 emptyLHsBinds :: LHsBinds id
195 emptyLHsBinds = emptyBag
197 isEmptyLHsBinds :: LHsBinds id -> Bool
198 isEmptyLHsBinds = isEmptyBag
201 plusHsValBinds :: HsValBinds a -> HsValBinds a -> HsValBinds a
202 plusHsValBinds (ValBindsIn ds1 sigs1) (ValBindsIn ds2 sigs2)
203 = ValBindsIn (ds1 `unionBags` ds2) (sigs1 ++ sigs2)
204 plusHsValBinds (ValBindsOut ds1 sigs1) (ValBindsOut ds2 sigs2)
205 = ValBindsOut (ds1 ++ ds2) (sigs1 ++ sigs2)
217 f1p = /\ tvs -> \ [d1,d2] -> letrec DBINDS and BIND
220 gp = ...same again, with gm instead of fm
222 This is a pretty bad translation, because it duplicates all the bindings.
223 So the desugarer tries to do a better job:
225 fp = /\ [a,b] -> \ [d1,d2] -> case tp [a,b] [d1,d2] of
229 tp = /\ [a,b] -> \ [d1,d2] -> letrec DBINDS and BIND
233 instance OutputableBndr id => Outputable (HsBind id) where
234 ppr mbind = ppr_monobind mbind
236 ppr_monobind :: OutputableBndr id => HsBind id -> SDoc
238 ppr_monobind (PatBind { pat_lhs = pat, pat_rhs = grhss }) = pprPatBind pat grhss
239 ppr_monobind (VarBind { var_id = var, var_rhs = rhs }) = ppr var <+> equals <+> pprExpr (unLoc rhs)
240 ppr_monobind (FunBind { fun_id = fun, fun_matches = matches }) = pprFunBind (unLoc fun) matches
241 -- ToDo: print infix if appropriate
243 ppr_monobind (AbsBinds { abs_tvs = tyvars, abs_dicts = dictvars,
244 abs_exports = exports, abs_binds = val_binds })
245 = sep [ptext SLIT("AbsBinds"),
246 brackets (interpp'SP tyvars),
247 brackets (interpp'SP dictvars),
248 brackets (sep (punctuate comma (map ppr_exp exports)))]
250 nest 2 ( vcat [pprBndr LetBind x | (_,x,_,_) <- exports]
251 -- Print type signatures
252 $$ pprLHsBinds val_binds )
254 ppr_exp (tvs, gbl, lcl, prags)
255 = vcat [ppr gbl <+> ptext SLIT("<=") <+> ppr tvs <+> ppr lcl,
256 nest 2 (vcat (map (pprPrag gbl) prags))]
259 %************************************************************************
261 Implicit parameter bindings
263 %************************************************************************
269 (DictBinds id) -- Only in typechecker output; binds
270 -- uses of the implicit parameters
272 isEmptyIPBinds :: HsIPBinds id -> Bool
273 isEmptyIPBinds (IPBinds is ds) = null is && isEmptyBag ds
275 type LIPBind id = Located (IPBind id)
277 -- | Implicit parameter bindings.
283 instance (OutputableBndr id) => Outputable (HsIPBinds id) where
284 ppr (IPBinds bs ds) = vcat (map ppr bs)
287 instance (OutputableBndr id) => Outputable (IPBind id) where
288 ppr (IPBind id rhs) = pprBndr LetBind id <+> equals <+> pprExpr (unLoc rhs)
292 %************************************************************************
294 \subsection{Coercion functions}
296 %************************************************************************
299 -- A Coercion is an expression with a hole in it
300 -- We need coercions to have concrete form so that we can zonk them
303 = CoHole -- The identity coercion
304 | CoCompose ExprCoFn ExprCoFn
305 | CoApps ExprCoFn [Id] -- Non-empty list
306 | CoTyApps ExprCoFn [Type] -- in all of these
307 | CoLams [Id] ExprCoFn -- so that the identity coercion
308 | CoTyLams [TyVar] ExprCoFn -- is just Hole
309 | CoLet (LHsBinds Id) ExprCoFn -- Would be nicer to be core bindings
311 (<.>) :: ExprCoFn -> ExprCoFn -> ExprCoFn
314 idCoercion :: ExprCoFn
317 isIdCoercion :: ExprCoFn -> Bool
318 isIdCoercion CoHole = True
319 isIdCoercion other = False
323 %************************************************************************
325 \subsection{@Sig@: type signatures and value-modifying user pragmas}
327 %************************************************************************
329 It is convenient to lump ``value-modifying'' user-pragmas (e.g.,
330 ``specialise this function to these four types...'') in with type
331 signatures. Then all the machinery to move them into place, etc.,
335 type LSig name = Located (Sig name)
338 = TypeSig (Located name) -- A bog-std type signature
341 | SpecSig (Located name) -- Specialise a function or datatype ...
342 (LHsType name) -- ... to these types
345 | InlineSig (Located name) -- Function name
348 | SpecInstSig (LHsType name) -- (Class tys); should be a specialisation of the
349 -- current instance decl
351 | FixSig (FixitySig name) -- Fixity declaration
353 type LFixitySig name = Located (FixitySig name)
354 data FixitySig name = FixitySig (Located name) Fixity
356 -- A Prag conveys pragmas from the type checker to the desugarer
362 (HsExpr Id) -- An expression, of the given specialised type, which
363 PostTcType -- specialises the polymorphic function
364 [Id] -- Dicts mentioned free in the expression
365 InlineSpec -- Inlining spec for the specialised function
367 isInlinePrag (InlinePrag _) = True
368 isInlinePrag prag = False
370 isSpecPrag (SpecPrag _ _ _ _) = True
371 isSpecPrag prag = False
375 okBindSig :: NameSet -> LSig Name -> Bool
376 okBindSig ns sig = sigForThisGroup ns sig
378 okHsBootSig :: LSig Name -> Bool
379 okHsBootSig (L _ (TypeSig _ _)) = True
380 okHsBootSig (L _ (FixSig _)) = True
381 okHsBootSig sig = False
383 okClsDclSig :: LSig Name -> Bool
384 okClsDclSig (L _ (SpecInstSig _)) = False
385 okClsDclSig sig = True -- All others OK
387 okInstDclSig :: NameSet -> LSig Name -> Bool
388 okInstDclSig ns lsig@(L _ sig) = ok ns sig
390 ok ns (TypeSig _ _) = False
391 ok ns (FixSig _) = False
392 ok ns (SpecInstSig _) = True
393 ok ns sig = sigForThisGroup ns lsig
395 sigForThisGroup :: NameSet -> LSig Name -> Bool
396 sigForThisGroup ns sig
397 = case sigName sig of
399 Just n -> n `elemNameSet` ns
401 sigName :: LSig name -> Maybe name
402 sigName (L _ sig) = f sig
404 f (TypeSig n _) = Just (unLoc n)
405 f (SpecSig n _ _) = Just (unLoc n)
406 f (InlineSig n _) = Just (unLoc n)
407 f (FixSig (FixitySig n _)) = Just (unLoc n)
410 isFixityLSig :: LSig name -> Bool
411 isFixityLSig (L _ (FixSig {})) = True
412 isFixityLSig _ = False
414 isVanillaLSig :: LSig name -> Bool
415 isVanillaLSig (L _(TypeSig {})) = True
416 isVanillaLSig sig = False
418 isSpecLSig :: LSig name -> Bool
419 isSpecLSig (L _(SpecSig {})) = True
420 isSpecLSig sig = False
422 isSpecInstLSig (L _ (SpecInstSig {})) = True
423 isSpecInstLSig sig = False
425 isPragLSig :: LSig name -> Bool
426 -- Identifies pragmas
427 isPragLSig (L _ (SpecSig {})) = True
428 isPragLSig (L _ (InlineSig {})) = True
429 isPragLSig other = False
431 isInlineLSig :: LSig name -> Bool
432 -- Identifies inline pragmas
433 isInlineLSig (L _ (InlineSig {})) = True
434 isInlineLSig other = False
436 hsSigDoc (TypeSig {}) = ptext SLIT("type signature")
437 hsSigDoc (SpecSig {}) = ptext SLIT("SPECIALISE pragma")
438 hsSigDoc (InlineSig _ spec) = ppr spec <+> ptext SLIT("pragma")
439 hsSigDoc (SpecInstSig {}) = ptext SLIT("SPECIALISE instance pragma")
440 hsSigDoc (FixSig {}) = ptext SLIT("fixity declaration")
443 Signature equality is used when checking for duplicate signatures
446 eqHsSig :: LSig Name -> LSig Name -> Bool
447 eqHsSig (L _ (FixSig (FixitySig n1 _))) (L _ (FixSig (FixitySig n2 _))) = unLoc n1 == unLoc n2
448 eqHsSig (L _ (TypeSig n1 _)) (L _ (TypeSig n2 _)) = unLoc n1 == unLoc n2
449 eqHsSig (L _ (InlineSig n1 s1)) (L _ (InlineSig n2 s2)) = s1 == s2 && unLoc n1 == unLoc n2
450 -- For specialisations, we don't have equality over
451 -- HsType, so it's not convenient to spot duplicate
452 -- specialisations here. Check for this later, when we're in Type land
453 eqHsSig _other1 _other2 = False
457 instance (OutputableBndr name) => Outputable (Sig name) where
458 ppr sig = ppr_sig sig
460 ppr_sig :: OutputableBndr name => Sig name -> SDoc
461 ppr_sig (TypeSig var ty) = pprVarSig (unLoc var) ty
462 ppr_sig (FixSig fix_sig) = ppr fix_sig
463 ppr_sig (SpecSig var ty inl) = pragBrackets (pprSpec var ty inl)
464 ppr_sig (InlineSig var inl) = pragBrackets (ppr inl <+> ppr var)
465 ppr_sig (SpecInstSig ty) = pragBrackets (ptext SLIT("SPECIALIZE instance") <+> ppr ty)
467 instance Outputable name => Outputable (FixitySig name) where
468 ppr (FixitySig name fixity) = sep [ppr fixity, ppr name]
470 pragBrackets :: SDoc -> SDoc
471 pragBrackets doc = ptext SLIT("{-#") <+> doc <+> ptext SLIT("#-}")
473 pprVarSig :: (Outputable id, Outputable ty) => id -> ty -> SDoc
474 pprVarSig var ty = sep [ppr var <+> dcolon, nest 2 (ppr ty)]
476 pprSpec :: (Outputable id, Outputable ty) => id -> ty -> InlineSpec -> SDoc
477 pprSpec var ty inl = sep [ptext SLIT("SPECIALIZE") <+> ppr inl <+> pprVarSig var ty]
479 pprPrag :: Outputable id => id -> Prag -> SDoc
480 pprPrag var (InlinePrag inl) = ppr inl <+> ppr var
481 pprPrag var (SpecPrag expr ty _ inl) = pprSpec var ty inl