[project @ 2005-10-27 14:35:20 by simonpj]
[ghc-hetmet.git] / ghc / compiler / hsSyn / HsBinds.lhs
index 494ac60..f20bcb4 100644 (file)
@@ -11,21 +11,19 @@ module HsBinds where
 #include "HsVersions.h"
 
 import {-# SOURCE #-} HsExpr ( HsExpr, pprExpr, LHsExpr,
-                              LMatch, pprFunBind,
+                              MatchGroup, pprFunBind,
                               GRHSs, pprPatBind )
+import {-# SOURCE #-} HsPat  ( LPat )
 
--- friends:
-import HsPat           ( LPat )
-import HsTypes         ( LHsType )
-
---others:
+import HsTypes         ( LHsType, PostTcType )
 import Name            ( Name )
-import NameSet         ( NameSet, elemNameSet, nameSetToList )
-import BasicTypes      ( IPName, RecFlag(..), Activation(..), Fixity )
+import NameSet         ( NameSet, elemNameSet )
+import BasicTypes      ( IPName, RecFlag(..), InlineSpec(..), Fixity )
 import Outputable      
-import SrcLoc          ( Located(..), unLoc )
-import Var             ( TyVar )
-import Bag             ( Bag, bagToList )
+import SrcLoc          ( Located(..), SrcSpan, unLoc )
+import Util            ( sortLe )
+import Var             ( TyVar, DictId, Id )
+import Bag             ( Bag, emptyBag, isEmptyBag, bagToList, unionBags, unionManyBags )
 \end{code}
 
 %************************************************************************
@@ -37,52 +35,24 @@ import Bag          ( Bag, bagToList )
 Global bindings (where clauses)
 
 \begin{code}
-data HsBindGroup id
-  = HsBindGroup                        -- A mutually recursive group
-       (LHsBinds id)
-       [LSig id]               -- Empty on typechecker output, Type Signatures
-       RecFlag
-
-  | HsIPBinds
-       [LIPBind id]            -- Not allowed at top level
-
-instance OutputableBndr id => Outputable (HsBindGroup id) where
-  ppr (HsBindGroup binds sigs is_rec)
-     = vcat [ppr_isrec,
-            vcat (map ppr sigs),
-            vcat (map ppr (bagToList binds))
-       ]
-     where
-       ppr_isrec = getPprStyle $ \ sty -> 
-                  if userStyle sty then empty else
-                  case is_rec of
-                       Recursive    -> ptext SLIT("{- rec -}")
-                       NonRecursive -> ptext SLIT("{- nonrec -}")
-
-  ppr (HsIPBinds ipbinds)
-     = vcat (map ppr ipbinds)
-
-mkHsBindGroup :: RecFlag -> Bag (LHsBind id) -> HsBindGroup id
-mkHsBindGroup is_rec mbinds = HsBindGroup mbinds [] is_rec
-
--- -----------------------------------------------------------------------------
--- Implicit parameter bindings
-
-type LIPBind id = Located (IPBind id)
-
--- | Implicit parameter bindings.
-data IPBind id
-  = IPBind
-       (IPName id)
-       (LHsExpr id)
+data HsLocalBinds id   -- Bindings in a 'let' expression
+                       -- or a 'where' clause
+  = HsValBinds (HsValBinds id)
+  | HsIPBinds  (HsIPBinds id)
+  | EmptyLocalBinds
 
-instance (OutputableBndr id) => Outputable (IPBind id) where
-    ppr (IPBind id rhs) = pprBndr LetBind id <+> equals <+> pprExpr (unLoc rhs)
+data HsValBinds id     -- Value bindings (not implicit parameters)
+  = ValBindsIn                         -- Before typechecking
+       (LHsBinds id) [LSig id]         -- Not dependency analysed
+                                       -- Recursive by default
 
--- -----------------------------------------------------------------------------
+  | ValBindsOut                                -- After renaming
+       [(RecFlag, LHsBinds id)]        -- Dependency analysed
+       [LSig Name]
 
-type LHsBinds id = Bag (LHsBind id)
-type LHsBind  id = Located (HsBind id)
+type LHsBinds id  = Bag (LHsBind id)
+type DictBinds id = LHsBinds id                -- Used for dictionary or method bindings
+type LHsBind  id  = Located (HsBind id)
 
 data HsBind id
   = FunBind     (Located id)
@@ -95,28 +65,118 @@ data HsBind id
                        -- FunBinds, so if you change this, you'll need to
                        -- change e.g. rnMethodBinds
                Bool    -- True => infix declaration
-               [LMatch id]
+               (MatchGroup id)
+               NameSet         -- After the renamer, this contains a superset of the 
+                               -- Names of the other binders in this binding group that 
+                               -- are free in the RHS of the defn
+                               -- Before renaming, and after typechecking, 
+                               -- the field is unused; it's just an error thunk
 
   | PatBind     (LPat id)      -- The pattern is never a simple variable;
                                -- That case is done by FunBind
                (GRHSs id)
-
-  | VarBind id (Located (HsExpr id))   -- Dictionary binding and suchlike;
-                                       -- located only for consistency
-
-  | AbsBinds                           -- Binds abstraction; TRANSLATION
-               [TyVar]                 -- Type variables
-               [id]                    -- Dicts
-               [([TyVar], id, id)]     -- (type variables, polymorphic, momonmorphic) triples
-               NameSet                 -- Set of *polymorphic* variables that have an INLINE pragma
-               (LHsBinds id)           -- The "business end"
-
-       -- Creates bindings for *new* (polymorphic, overloaded) locals
-       -- in terms of *old* (monomorphic, non-overloaded) ones.
+               PostTcType      -- Type of the GRHSs
+               NameSet         -- Same as for FunBind
+
+  | VarBind id (Located (HsExpr id))   -- Dictionary binding and suchlike 
+                                       -- All VarBinds are introduced by the type checker
+                                       -- Located only for consistency
+
+  | AbsBinds                                   -- Binds abstraction; TRANSLATION
+               [TyVar]                         -- Type variables
+               [DictId]                        -- Dicts
+               [([TyVar], id, id, [Prag])]     -- (tvs, poly_id, mono_id, prags)
+               (LHsBinds id)                   -- The dictionary bindings and typechecked user bindings
+                                               -- mixed up together; you can tell the dict bindings because
+                                               -- they are all VarBinds
+
+       -- Consider (AbsBinds tvs ds [(ftvs, poly_f, mono_f) binds]
+       -- 
+       -- Creates bindings for (polymorphic, overloaded) poly_f
+       -- in terms of monomorphic, non-overloaded mono_f
+       --
+       -- Invariants: 
+       --      1. 'binds' binds mono_f
+       --      2. ftvs is a subset of tvs
+       --      3. ftvs includes all tyvars free in ds
        --
        -- See section 9 of static semantics paper for more details.
        -- (You can get a PhD for explaining the True Meaning
        --  of this last construct.)
+
+placeHolderNames :: NameSet
+-- Used for the NameSet in FunBind and PatBind prior to the renamer
+placeHolderNames = panic "placeHolderNames"
+
+------------
+instance OutputableBndr id => Outputable (HsLocalBinds id) where
+  ppr (HsValBinds bs) = ppr bs
+  ppr (HsIPBinds bs)  = ppr bs
+  ppr EmptyLocalBinds = empty
+
+instance OutputableBndr id => Outputable (HsValBinds id) where
+  ppr (ValBindsIn binds sigs)
+   = pprValBindsForUser binds sigs
+
+  ppr (ValBindsOut sccs sigs) 
+    = getPprStyle $ \ sty ->
+      if debugStyle sty then   -- Print with sccs showing
+       vcat (map ppr sigs) $$ vcat (map ppr_scc sccs)
+     else
+       pprValBindsForUser (unionManyBags (map snd sccs)) sigs
+   where
+     ppr_scc (rec_flag, binds) = pp_rec rec_flag <+> pprLHsBinds binds
+     pp_rec Recursive    = ptext SLIT("rec")
+     pp_rec NonRecursive = ptext SLIT("nonrec")
+
+--  *not* pprLHsBinds because we don't want braces; 'let' and
+-- 'where' include a list of HsBindGroups and we don't want
+-- several groups of bindings each with braces around.
+-- Sort by location before printing
+pprValBindsForUser binds sigs
+  = vcat (map snd (sort_by_loc decls))
+  where
+
+    decls :: [(SrcSpan, SDoc)]
+    decls = [(loc, ppr sig)  | L loc sig <- sigs] ++
+           [(loc, ppr bind) | L loc bind <- bagToList binds]
+
+    sort_by_loc decls = sortLe (\(l1,_) (l2,_) -> l1 <= l2) decls
+
+pprLHsBinds :: OutputableBndr id => LHsBinds id -> SDoc
+pprLHsBinds binds 
+  | isEmptyLHsBinds binds = empty
+  | otherwise = lbrace <+> vcat (map ppr (bagToList binds)) <+> rbrace
+
+------------
+emptyLocalBinds :: HsLocalBinds a
+emptyLocalBinds = EmptyLocalBinds
+
+isEmptyLocalBinds :: HsLocalBinds a -> Bool
+isEmptyLocalBinds (HsValBinds ds) = isEmptyValBinds ds
+isEmptyLocalBinds (HsIPBinds ds)  = isEmptyIPBinds ds
+isEmptyLocalBinds EmptyLocalBinds = True
+
+isEmptyValBinds :: HsValBinds a -> Bool
+isEmptyValBinds (ValBindsIn ds sigs)  = isEmptyLHsBinds ds && null sigs
+isEmptyValBinds (ValBindsOut ds sigs) = null ds && null sigs
+
+emptyValBindsIn, emptyValBindsOut :: HsValBinds a
+emptyValBindsIn  = ValBindsIn emptyBag []
+emptyValBindsOut = ValBindsOut []      []
+
+emptyLHsBinds :: LHsBinds id
+emptyLHsBinds = emptyBag
+
+isEmptyLHsBinds :: LHsBinds id -> Bool
+isEmptyLHsBinds = isEmptyBag
+
+------------
+plusHsValBinds :: HsValBinds a -> HsValBinds a -> HsValBinds a
+plusHsValBinds (ValBindsIn ds1 sigs1) (ValBindsIn ds2 sigs2)
+  = ValBindsIn (ds1 `unionBags` ds2) (sigs1 ++ sigs2)
+plusHsValBinds (ValBindsOut ds1 sigs1) (ValBindsOut ds2 sigs2)
+  = ValBindsOut (ds1 ++ ds2) (sigs1 ++ sigs2)
 \end{code}
 
 What AbsBinds means
@@ -149,24 +209,59 @@ instance OutputableBndr id => Outputable (HsBind id) where
 
 ppr_monobind :: OutputableBndr id => HsBind id -> SDoc
 
-ppr_monobind (PatBind pat grhss)       = pprPatBind pat grhss
-ppr_monobind (VarBind var rhs)         = ppr var <+> equals <+> pprExpr (unLoc rhs)
-ppr_monobind (FunBind fun inf matches) = pprFunBind (unLoc fun) matches
+ppr_monobind (PatBind pat grhss _ _)     = pprPatBind pat grhss
+ppr_monobind (VarBind var rhs)           = ppr var <+> equals <+> pprExpr (unLoc rhs)
+ppr_monobind (FunBind fun inf matches _) = pprFunBind (unLoc fun) matches
       -- ToDo: print infix if appropriate
 
-ppr_monobind (AbsBinds tyvars dictvars exports inlines val_binds)
+ppr_monobind (AbsBinds tyvars dictvars exports val_binds)
      = sep [ptext SLIT("AbsBinds"),
            brackets (interpp'SP tyvars),
            brackets (interpp'SP dictvars),
-           brackets (sep (punctuate comma (map ppr exports))),
-           brackets (interpp'SP (nameSetToList inlines))]
+           brackets (sep (punctuate comma (map ppr_exp exports)))]
        $$
-       nest 4 ( vcat [pprBndr LetBind x | (_,x,_) <- exports]
+       nest 2 ( vcat [pprBndr LetBind x | (_,x,_,_) <- exports]
                        -- Print type signatures
-               $$
-               ppr val_binds )
+               $$ pprLHsBinds val_binds )
+  where
+    ppr_exp (tvs, gbl, lcl, prags)
+       = vcat [ppr gbl <+> ptext SLIT("<=") <+> ppr tvs <+> ppr lcl,
+               nest 2 (vcat (map (pprPrag gbl) prags))]
+\end{code}
+
+%************************************************************************
+%*                                                                     *
+               Implicit parameter bindings
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+data HsIPBinds id
+  = IPBinds 
+       [LIPBind id] 
+       (DictBinds id)  -- Only in typechecker output; binds 
+                       -- uses of the implicit parameters
+
+isEmptyIPBinds :: HsIPBinds id -> Bool
+isEmptyIPBinds (IPBinds is ds) = null is && isEmptyBag ds
+
+type LIPBind id = Located (IPBind id)
+
+-- | Implicit parameter bindings.
+data IPBind id
+  = IPBind
+       (IPName id)
+       (LHsExpr id)
+
+instance (OutputableBndr id) => Outputable (HsIPBinds id) where
+  ppr (IPBinds bs ds) = vcat (map ppr bs) 
+                       $$ pprLHsBinds ds
+
+instance (OutputableBndr id) => Outputable (IPBind id) where
+  ppr (IPBind id rhs) = pprBndr LetBind id <+> equals <+> pprExpr (unLoc rhs)
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
 \subsection{@Sig@: type signatures and value-modifying user pragmas}
@@ -182,15 +277,15 @@ serves for both.
 type LSig name = Located (Sig name)
 
 data Sig name
-  = Sig                (Located name)  -- a bog-std type signature
+  = TypeSig    (Located name)  -- A bog-std type signature
                (LHsType name)
 
-  | SpecSig    (Located name)  -- specialise a function or datatype ...
+  | SpecSig    (Located name)  -- Specialise a function or datatype ...
                (LHsType name)  -- ... to these types
+               InlineSpec
 
-  | InlineSig  Bool            -- True <=> INLINE f, False <=> NOINLINE f
-               (Located name)  -- Function name
-               Activation      -- When inlining is *active*
+  | InlineSig  (Located name)  -- Function name
+               InlineSpec
 
   | SpecInstSig (LHsType name) -- (Class tys); should be a specialisation of the 
                                -- current instance decl
@@ -199,12 +294,34 @@ data Sig name
 
 type LFixitySig name = Located (FixitySig name)
 data FixitySig name = FixitySig (Located name) Fixity 
+
+-- A Prag conveys pragmas from the type checker to the desugarer
+data Prag 
+  = InlinePrag 
+       InlineSpec
+
+  | SpecPrag   
+       (HsExpr Id)     -- An expression, of the given specialised type, which
+       PostTcType      -- specialises the polymorphic function
+       [Id]            -- Dicts mentioned free in the expression
+       InlineSpec      -- Inlining spec for the specialised function
+
+isInlinePrag (InlinePrag _) = True
+isInlinePrag prag          = False
+
+isSpecPrag (SpecPrag _ _ _ _) = True
+isSpecPrag prag                      = False
 \end{code}
 
 \begin{code}
 okBindSig :: NameSet -> LSig Name -> Bool
 okBindSig ns sig = sigForThisGroup ns sig
 
+okHsBootSig :: LSig Name -> Bool
+okHsBootSig (L _ (TypeSig  _ _)) = True
+okHsBootSig (L _ (FixSig _))    = True
+okHsBootSig sig                         = False
+
 okClsDclSig :: LSig Name -> Bool
 okClsDclSig (L _ (SpecInstSig _)) = False
 okClsDclSig sig                  = True        -- All others OK
@@ -212,7 +329,7 @@ okClsDclSig sig               = True        -- All others OK
 okInstDclSig :: NameSet -> LSig Name -> Bool
 okInstDclSig ns lsig@(L _ sig) = ok ns sig
   where
-    ok ns (Sig _ _)      = False
+    ok ns (TypeSig _ _)          = False
     ok ns (FixSig _)     = False
     ok ns (SpecInstSig _) = True
     ok ns sig            = sigForThisGroup ns lsig
@@ -226,27 +343,36 @@ sigForThisGroup ns sig
 sigName :: LSig name -> Maybe name
 sigName (L _ sig) = f sig
  where
-    f (Sig         n _)        = Just (unLoc n)
-    f (SpecSig     n _)        = Just (unLoc n)
-    f (InlineSig _ n _)        = Just (unLoc n)
+    f (TypeSig   n _)          = Just (unLoc n)
+    f (SpecSig   n _ _)        = Just (unLoc n)
+    f (InlineSig n _)          = Just (unLoc n)
     f (FixSig (FixitySig n _)) = Just (unLoc n)
     f other                    = Nothing
 
-isFixitySig :: Sig name -> Bool
-isFixitySig (FixSig _) = True
-isFixitySig _         = False
+isFixityLSig :: LSig name -> Bool
+isFixityLSig (L _ (FixSig _)) = True
+isFixityLSig _               = False
+
+isVanillaLSig :: LSig name -> Bool
+isVanillaLSig (L _(TypeSig name _)) = True
+isVanillaLSig sig                  = False
+
+isSpecLSig :: LSig name -> Bool
+isSpecLSig (L _(SpecSig name _ _)) = True
+isSpecLSig sig                    = False
 
-isPragSig :: Sig name -> Bool
+isSpecInstLSig (L _ (SpecInstSig _)) = True
+isSpecInstLSig sig                  = False
+
+isPragLSig :: LSig name -> Bool
        -- Identifies pragmas 
-isPragSig (SpecSig _ _)     = True
-isPragSig (InlineSig _ _ _) = True
-isPragSig (SpecInstSig _)   = True
-isPragSig other                    = False
-
-hsSigDoc (Sig        _ _)        = ptext SLIT("type signature")
-hsSigDoc (SpecSig    _ _)        = ptext SLIT("SPECIALISE pragma")
-hsSigDoc (InlineSig True  _ _)    = ptext SLIT("INLINE pragma")
-hsSigDoc (InlineSig False _ _)    = ptext SLIT("NOINLINE pragma")
+isPragLSig (L _ (SpecSig _ _ _)) = True
+isPragLSig (L _ (InlineSig _ _)) = True
+isPragLSig other                = False
+
+hsSigDoc (TypeSig    _ _)        = ptext SLIT("type signature")
+hsSigDoc (SpecSig    _ _ _)      = ptext SLIT("SPECIALISE pragma")
+hsSigDoc (InlineSig _ spec)      = ppr spec <+> ptext SLIT("pragma")
 hsSigDoc (SpecInstSig _)         = ptext SLIT("SPECIALISE instance pragma")
 hsSigDoc (FixSig (FixitySig _ _)) = ptext SLIT("fixity declaration")
 \end{code}
@@ -254,10 +380,10 @@ hsSigDoc (FixSig (FixitySig _ _)) = ptext SLIT("fixity declaration")
 Signature equality is used when checking for duplicate signatures
 
 \begin{code}
-eqHsSig :: Sig Name -> Sig Name -> Bool
-eqHsSig (FixSig (FixitySig n1 _)) (FixSig (FixitySig n2 _)) = unLoc n1 == unLoc n2
-eqHsSig (Sig n1 _)                 (Sig n2 _)              = unLoc n1 == unLoc n2
-eqHsSig (InlineSig b1 n1 _)        (InlineSig b2 n2 _)     = b1 == b2 && unLoc n1 == unLoc n2
+eqHsSig :: LSig Name -> LSig Name -> Bool
+eqHsSig (L _ (FixSig (FixitySig n1 _))) (L _ (FixSig (FixitySig n2 _))) = unLoc n1 == unLoc n2
+eqHsSig (L _ (TypeSig n1 _))           (L _ (TypeSig n2 _))            = unLoc n1 == unLoc n2
+eqHsSig (L _ (InlineSig n1 s1))        (L _ (InlineSig n2 s2))                 = s1 == s2 && unLoc n1 == unLoc n2
        -- For specialisations, we don't have equality over
        -- HsType, so it's not convenient to spot duplicate 
        -- specialisations here.  Check for this later, when we're in Type land
@@ -265,29 +391,29 @@ eqHsSig _other1 _other2 = False
 \end{code}
 
 \begin{code}
-instance (Outputable name) => Outputable (Sig name) where
+instance (OutputableBndr name) => Outputable (Sig name) where
     ppr sig = ppr_sig sig
 
-ppr_sig :: Outputable name => Sig name -> SDoc
-ppr_sig (Sig var ty)
-      = sep [ppr var <+> dcolon, nest 4 (ppr ty)]
+ppr_sig :: OutputableBndr name => Sig name -> SDoc
+ppr_sig (TypeSig var ty)         = pprVarSig (unLoc var) ty
+ppr_sig (FixSig fix_sig)         = ppr fix_sig
+ppr_sig (SpecSig var ty inl)     = pragBrackets (pprSpec var ty inl)
+ppr_sig (InlineSig var inl)       = pragBrackets (ppr inl <+> ppr var)
+ppr_sig (SpecInstSig ty)         = pragBrackets (ptext SLIT("SPECIALIZE instance") <+> ppr ty)
 
-ppr_sig (SpecSig var ty)
-      = sep [ hsep [text "{-# SPECIALIZE", ppr var, dcolon],
-             nest 4 (ppr ty <+> text "#-}")
-       ]
-
-ppr_sig (InlineSig True var phase)
-      = hsep [text "{-# INLINE", ppr phase, ppr var, text "#-}"]
+instance Outputable name => Outputable (FixitySig name) where
+  ppr (FixitySig name fixity) = sep [ppr fixity, ppr name]
 
-ppr_sig (InlineSig False var phase)
-      = hsep [text "{-# NOINLINE", ppr phase, ppr var, text "#-}"]
+pragBrackets :: SDoc -> SDoc
+pragBrackets doc = ptext SLIT("{-#") <+> doc <+> ptext SLIT("#-}") 
 
-ppr_sig (SpecInstSig ty)
-      = hsep [text "{-# SPECIALIZE instance", ppr ty, text "#-}"]
+pprVarSig :: (Outputable id, Outputable ty) => id -> ty -> SDoc
+pprVarSig var ty = sep [ppr var <+> dcolon, nest 2 (ppr ty)]
 
-ppr_sig (FixSig fix_sig) = ppr fix_sig
+pprSpec :: (Outputable id, Outputable ty) => id -> ty -> InlineSpec -> SDoc
+pprSpec var ty inl = sep [ptext SLIT("SPECIALIZE") <+> ppr inl <+> pprVarSig var ty]
 
-instance Outputable name => Outputable (FixitySig name) where
-  ppr (FixitySig name fixity) = sep [ppr fixity, ppr name]
+pprPrag :: Outputable id => id -> Prag -> SDoc
+pprPrag var (InlinePrag inl)         = ppr inl <+> ppr var
+pprPrag var (SpecPrag expr ty _ inl) = pprSpec var ty inl
 \end{code}