[project @ 2004-02-12 02:04:59 by mthomas]
[ghc-hetmet.git] / ghc / compiler / hsSyn / HsBinds.lhs
index 375fe31..0db816c 100644 (file)
 %
 \section[HsBinds]{Abstract syntax: top-level bindings and signatures}
 
-Datatype for: @HsBinds@, @Bind@, @Sig@, @MonoBinds@.
+Datatype for: @BindGroup@, @Bind@, @Sig@, @Bind@.
 
 \begin{code}
 module HsBinds where
 
 #include "HsVersions.h"
 
-import {-# SOURCE #-} HsExpr    ( pprExpr, HsExpr )
-import {-# SOURCE #-} HsMatches ( pprMatches, Match, pprGRHSs, GRHSs )
+import {-# SOURCE #-} HsExpr ( HsExpr, pprExpr, LHsExpr,
+                              LMatch, pprFunBind,
+                              GRHSs, pprPatBind )
 
 -- friends:
-import HsTypes         ( HsType )
-import CoreSyn         ( CoreExpr )
-import PprCore         ()         -- Instances for Outputable
+import HsPat           ( LPat )
+import HsTypes         ( LHsType )
 
 --others:
-import Id              ( Id )
-import NameSet         ( NameSet, nameSetToList )
-import BasicTypes      ( RecFlag(..), Fixity )
+import Name            ( Name )
+import NameSet         ( NameSet, elemNameSet, nameSetToList )
+import BasicTypes      ( IPName, RecFlag(..), Activation(..), Fixity )
 import Outputable      
-import Bag
-import SrcLoc          ( SrcLoc )
+import SrcLoc          ( Located(..), unLoc )
 import Var             ( TyVar )
+import Bag             ( Bag, bagToList )
 \end{code}
 
 %************************************************************************
 %*                                                                     *
-\subsection{Bindings: @HsBinds@}
+\subsection{Bindings: @BindGroup@}
 %*                                                                     *
 %************************************************************************
 
-The following syntax may produce new syntax which is not part of the input,
-and which is instead a translation of the input to the typechecker.
-Syntax translations are marked TRANSLATION in comments. New empty
-productions are useful in development but may not appear in the final
-grammar.
-
-Collections of bindings, created by dependency analysis and translation:
-
-\begin{code}
-data HsBinds id pat            -- binders and bindees
-  = EmptyBinds
-
-  | ThenBinds  (HsBinds id pat)
-               (HsBinds id pat)
-
-  | MonoBind   (MonoBinds id pat)
-               [Sig id]                -- Empty on typechecker output
-               RecFlag
-\end{code}
-
-\begin{code}
-nullBinds :: HsBinds id pat -> Bool
-
-nullBinds EmptyBinds           = True
-nullBinds (ThenBinds b1 b2)    = nullBinds b1 && nullBinds b2
-nullBinds (MonoBind b _ _)     = nullMonoBinds b
-\end{code}
+Global bindings (where clauses)
 
 \begin{code}
-instance (Outputable pat, Outputable id) =>
-               Outputable (HsBinds id pat) where
-    ppr binds = ppr_binds binds
-
-ppr_binds EmptyBinds = empty
-ppr_binds (ThenBinds binds1 binds2)
-     = ($$) (ppr_binds binds1) (ppr_binds binds2)
-ppr_binds (MonoBind bind sigs is_rec)
-     = vcat [ifNotPprForUser (ptext rec_str),
+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),
-            ppr bind
+            vcat (map ppr (bagToList binds))
        ]
      where
-       rec_str = case is_rec of
-                  Recursive    -> SLIT("{- rec -}")
-                  NonRecursive -> SLIT("{- nonrec -}")
-\end{code}
-
-%************************************************************************
-%*                                                                     *
-\subsection{Bindings: @MonoBinds@}
-%*                                                                     *
-%************************************************************************
-
-Global bindings (where clauses)
-
-\begin{code}
-data MonoBinds id pat
-  = EmptyMonoBinds
-
-  | AndMonoBinds    (MonoBinds id pat)
-                   (MonoBinds id pat)
-
-  | PatMonoBind     pat
-                   (GRHSs id pat)
-                   SrcLoc
-
-  | FunMonoBind     id
-                   Bool                -- True => infix declaration
-                   [Match id pat]
-                   SrcLoc
-
-  | VarMonoBind            id                  -- TRANSLATION
-                   (HsExpr id pat)
-
-  | CoreMonoBind    id                 -- TRANSLATION
-                   CoreExpr            -- No zonking; this is a final CoreExpr with Ids and Types!
+       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)
+
+-- -----------------------------------------------------------------------------
+-- Implicit parameter bindings
+
+type LIPBind id = Located (IPBind id)
+
+-- | Implicit parameter bindings.
+data IPBind id
+  = IPBind
+       (IPName id)
+       (LHsExpr id)
+
+instance (OutputableBndr id) => Outputable (IPBind id) where
+    ppr (IPBind id rhs) = pprBndr LetBind id <+> equals <+> pprExpr (unLoc rhs)
+
+-- -----------------------------------------------------------------------------
+
+type LHsBinds id = Bag (LHsBind id)
+type LHsBind  id = Located (HsBind id)
+
+data HsBind id
+  = FunBind     (Located id)
+                       -- Used for both functions      f x = e
+                       -- and variables                f = \x -> e
+                       -- Reason: the Match stuff lets us have an optional
+                       --         result type sig      f :: a->a = ...mentions a...
+                       --
+                       -- This also means that instance decls can only have
+                       -- FunBinds, so if you change this, you'll need to
+                       -- change e.g. rnMethodBinds
+               Bool    -- True => infix declaration
+               [LMatch id]
+
+  | 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
-               (MonoBinds id pat)      -- The "business end"
+               (LHsBinds id)           -- The "business end"
 
        -- Creates bindings for *new* (polymorphic, overloaded) locals
        -- in terms of *old* (monomorphic, non-overloaded) ones.
@@ -147,49 +137,20 @@ So the desugarer tries to do a better job:
                                        (fm,gm) -> fm
        ..ditto for gp..
 
-       p = /\ [a,b] -> \ [d1,d2] -> letrec DBINDS and BIND 
-                                     in (fm,gm)
-
-\begin{code}
-nullMonoBinds :: MonoBinds id pat -> Bool
-
-nullMonoBinds EmptyMonoBinds        = True
-nullMonoBinds (AndMonoBinds bs1 bs2) = nullMonoBinds bs1 && nullMonoBinds bs2
-nullMonoBinds other_monobind        = False
-
-andMonoBinds :: MonoBinds id pat -> MonoBinds id pat -> MonoBinds id pat
-andMonoBinds EmptyMonoBinds mb = mb
-andMonoBinds mb EmptyMonoBinds = mb
-andMonoBinds mb1 mb2 = AndMonoBinds mb1 mb2
-
-andMonoBindList :: [MonoBinds id pat] -> MonoBinds id pat
-andMonoBindList binds = foldr AndMonoBinds EmptyMonoBinds binds
-\end{code}
+       tp = /\ [a,b] -> \ [d1,d2] -> letrec DBINDS and BIND 
+                                      in (fm,gm)
 
 \begin{code}
-instance (Outputable id, Outputable pat) =>
-               Outputable (MonoBinds id pat) where
+instance OutputableBndr id => Outputable (HsBind id) where
     ppr mbind = ppr_monobind mbind
 
+ppr_monobind :: OutputableBndr id => HsBind id -> SDoc
 
-ppr_monobind :: (Outputable id, Outputable pat) => MonoBinds id pat -> SDoc
-ppr_monobind EmptyMonoBinds = empty
-ppr_monobind (AndMonoBinds binds1 binds2)
-      = ppr_monobind binds1 $$ ppr_monobind binds2
-
-ppr_monobind (PatMonoBind pat grhss locn)
-      = sep [ppr pat, nest 4 (pprGRHSs False grhss)]
-
-ppr_monobind (FunMonoBind fun inf matches locn)
-      = pprMatches (False, ppr 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 (VarMonoBind name expr)
-      = sep [ppr name <+> equals, nest 4 (pprExpr expr)]
-
-ppr_monobind (CoreMonoBind name expr)
-      = sep [ppr name <+> equals, nest 4 (ppr expr)]
-
 ppr_monobind (AbsBinds tyvars dictvars exports inlines val_binds)
      = sep [ptext SLIT("AbsBinds"),
            brackets (interpp'SP tyvars),
@@ -197,7 +158,10 @@ ppr_monobind (AbsBinds tyvars dictvars exports inlines val_binds)
            brackets (sep (punctuate comma (map ppr exports))),
            brackets (interpp'SP (nameSetToList inlines))]
        $$
-       nest 4 (ppr val_binds)
+       nest 4 ( vcat [pprBndr LetBind x | (_,x,_) <- exports]
+                       -- Print type signatures
+               $$
+               ppr val_binds )
 \end{code}
 
 %************************************************************************
@@ -212,86 +176,115 @@ signatures.  Then all the machinery to move them into place, etc.,
 serves for both.
 
 \begin{code}
-data Sig name
-  = Sig                name            -- a bog-std type signature
-               (HsType name)
-               SrcLoc
-
-  | ClassOpSig name            -- Selector name
-               (Maybe name)    -- Default-method name (if any)
-               (HsType name)
-               SrcLoc
+type LSig name = Located (Sig name)
 
-  | SpecSig    name            -- specialise a function or datatype ...
-               (HsType name)   -- ... to these types
-               SrcLoc
+data Sig name
+  = Sig                (Located name)  -- a bog-std type signature
+               (LHsType name)
 
-  | InlineSig  name            -- INLINE f
-               SrcLoc
+  | SpecSig    (Located name)  -- specialise a function or datatype ...
+               (LHsType name)  -- ... to these types
 
-  | NoInlineSig        name            -- NOINLINE f
-               SrcLoc
+  | InlineSig  Bool            -- True <=> INLINE f, False <=> NOINLINE f
+               (Located name)  -- Function name
+               Activation      -- When inlining is *active*
 
-  | SpecInstSig (HsType name)  -- (Class tys); should be a specialisation of the 
+  | SpecInstSig (LHsType name) -- (Class tys); should be a specialisation of the 
                                -- current instance decl
-               SrcLoc
-
-  | FixSig     (FixitySig name)                -- Fixity declaration
 
+  | FixSig     (FixitySig name)        -- Fixity declaration
 
-data FixitySig name  = FixitySig name Fixity SrcLoc
+type LFixitySig name = Located (FixitySig name)
+data FixitySig name = FixitySig (Located name) Fixity 
 \end{code}
 
 \begin{code}
-sigsForMe :: (name -> Bool) -> [Sig name] -> [Sig name]
-sigsForMe f sigs
-  = filter sig_for_me sigs
+okBindSig :: NameSet -> LSig Name -> Bool
+okBindSig ns sig = sigForThisGroup ns sig
+
+okClsDclSig :: LSig Name -> Bool
+okClsDclSig (L _ (SpecInstSig _)) = False
+okClsDclSig sig                  = True        -- All others OK
+
+okInstDclSig :: NameSet -> LSig Name -> Bool
+okInstDclSig ns lsig@(L _ sig) = ok ns sig
   where
-    sig_for_me (Sig         n _ _)       = f n
-    sig_for_me (ClassOpSig  n _ _ _)     = f n
-    sig_for_me (SpecSig     n _ _)       = f n
-    sig_for_me (InlineSig   n     _)     = f n  
-    sig_for_me (NoInlineSig n     _)     = f n  
-    sig_for_me (SpecInstSig _ _)         = False
-    sig_for_me (FixSig (FixitySig n _ _)) = f n
+    ok ns (Sig _ _)      = False
+    ok ns (FixSig _)     = False
+    ok ns (SpecInstSig _) = True
+    ok ns sig            = sigForThisGroup ns lsig
+
+sigForThisGroup :: NameSet -> LSig Name -> Bool
+sigForThisGroup ns sig
+  = case sigName sig of
+       Nothing -> False
+       Just n  -> n `elemNameSet` ns
+
+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 (FixSig (FixitySig n _)) = Just (unLoc n)
+    f other                    = Nothing
 
 isFixitySig :: Sig name -> Bool
 isFixitySig (FixSig _) = True
 isFixitySig _         = False
 
-isClassOpSig :: Sig name -> Bool
-isClassOpSig (ClassOpSig _ _ _ _) = True
-isClassOpSig _                   = False
+isPragSig :: Sig 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")
+hsSigDoc (SpecInstSig _)         = ptext SLIT("SPECIALISE instance pragma")
+hsSigDoc (FixSig (FixitySig _ _)) = ptext SLIT("fixity declaration")
 \end{code}
 
-\begin{code}
-instance (Outputable name) => Outputable (Sig name) where
-    ppr sig = ppr_sig sig
-
-instance Outputable name => Outputable (FixitySig name) where
-  ppr (FixitySig name fixity loc) = sep [ppr fixity, ppr name]
+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
+       -- 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
+eqHsSig _other1 _other2 = False
+\end{code}
 
-ppr_sig (Sig var ty _)
-      = sep [ppr var <+> dcolon, nest 4 (ppr ty)]
+\begin{code}
+instance (OutputableBndr name) => Outputable (Sig name) where
+    ppr sig = ppr_sig sig
 
-ppr_sig (ClassOpSig var _ ty _)
+ppr_sig :: OutputableBndr name => Sig name -> SDoc
+ppr_sig (Sig var ty)
       = sep [ppr var <+> dcolon, nest 4 (ppr ty)]
 
-ppr_sig (SpecSig var ty _)
+ppr_sig (SpecSig var ty)
       = sep [ hsep [text "{-# SPECIALIZE", ppr var, dcolon],
              nest 4 (ppr ty <+> text "#-}")
        ]
 
-ppr_sig (InlineSig var _)
-        = hsep [text "{-# INLINE", ppr var, text "#-}"]
+ppr_sig (InlineSig True var phase)
+      = hsep [text "{-# INLINE", ppr phase, ppr var, text "#-}"]
 
-ppr_sig (NoInlineSig var _)
-        = hsep [text "{-# NOINLINE", ppr var, text "#-}"]
+ppr_sig (InlineSig False var phase)
+      = hsep [text "{-# NOINLINE", ppr phase, ppr var, text "#-}"]
 
-ppr_sig (SpecInstSig ty _)
+ppr_sig (SpecInstSig ty)
       = hsep [text "{-# SPECIALIZE instance", ppr ty, text "#-}"]
 
 ppr_sig (FixSig fix_sig) = ppr fix_sig
-\end{code}
 
+instance Outputable name => Outputable (FixitySig name) where
+  ppr (FixitySig name fixity) = sep [ppr fixity, ppr name]
+\end{code}