[project @ 2002-11-06 13:10:46 by simonpj]
[ghc-hetmet.git] / ghc / compiler / hsSyn / HsBinds.lhs
index 8a559f3..a3d127d 100644 (file)
@@ -10,22 +10,25 @@ module HsBinds where
 
 #include "HsVersions.h"
 
-import {-# SOURCE #-} HsExpr    ( pprExpr, HsExpr )
-import {-# SOURCE #-} HsMatches ( pprMatches, Match, pprGRHSs, GRHSs )
+import {-# SOURCE #-} HsExpr ( HsExpr, pprExpr,
+                              Match,  pprFunBind,
+                              GRHSs,  pprPatBind )
 
 -- friends:
+import HsImpExp                ( pprHsVar )
+import HsPat           ( Pat )
 import HsTypes         ( HsType )
-import CoreSyn         ( CoreExpr )
-import PprCore         ()         -- Instances for Outputable
+import PprCore         ( {- instance Outputable (Expr a) -} )
 
 --others:
-import Id              ( Id )
-import NameSet         ( NameSet, nameSetToList )
-import BasicTypes      ( RecFlag(..), Fixity )
+import Name            ( Name )
+import PrelNames       ( isUnboundName )
+import NameSet         ( NameSet, elemNameSet, nameSetToList )
+import BasicTypes      ( RecFlag(..), FixitySig(..), Activation(..), IPName )
 import Outputable      
-import Bag
 import SrcLoc          ( SrcLoc )
 import Var             ( TyVar )
+import Class            ( DefMeth (..) )
 \end{code}
 
 %************************************************************************
@@ -43,42 +46,59 @@ grammar.
 Collections of bindings, created by dependency analysis and translation:
 
 \begin{code}
-data HsBinds id pat            -- binders and bindees
+data HsBinds id                -- binders and bindees
   = EmptyBinds
-
-  | ThenBinds  (HsBinds id pat)
-               (HsBinds id pat)
-
-  | MonoBind   (MonoBinds id pat)
-               [Sig id]                -- Empty on typechecker output
-               RecFlag
+  | ThenBinds  (HsBinds id) (HsBinds id)
+
+  | MonoBind                   -- A mutually recursive group
+       (MonoBinds id)
+       [Sig id]                -- Empty on typechecker output, Type Signatures
+       RecFlag
+
+  | IPBinds                    -- Implcit parameters
+                               -- Not allowed at top level
+       [(IPName id, HsExpr id)]
+       Bool            -- True <=> this was a 'with' binding
+                       --  (tmp, until 'with' is removed)
 \end{code}
 
 \begin{code}
-nullBinds :: HsBinds id pat -> Bool
+nullBinds :: HsBinds id -> Bool
 
 nullBinds EmptyBinds           = True
 nullBinds (ThenBinds b1 b2)    = nullBinds b1 && nullBinds b2
 nullBinds (MonoBind b _ _)     = nullMonoBinds b
+nullBinds (IPBinds b _)        = null b
+
+mkMonoBind :: RecFlag -> MonoBinds id -> HsBinds id
+mkMonoBind _      EmptyMonoBinds  = EmptyBinds
+mkMonoBind is_rec mbinds         = MonoBind mbinds [] is_rec
 \end{code}
 
 \begin{code}
-instance (Outputable pat, Outputable id) =>
-               Outputable (HsBinds id pat) where
+instance (OutputableBndr id) => Outputable (HsBinds id) where
     ppr binds = ppr_binds binds
 
 ppr_binds EmptyBinds = empty
 ppr_binds (ThenBinds binds1 binds2)
-     = ($$) (ppr_binds binds1) (ppr_binds binds2)
+    = ppr_binds binds1 $$ ppr_binds binds2
+
+ppr_binds (IPBinds binds is_with)
+  = sep (punctuate semi (map pp_item binds))
+  where
+    pp_item (id,rhs) = pprBndr LetBind id <+> equals <+> pprExpr rhs
+
 ppr_binds (MonoBind bind sigs is_rec)
-     = vcat [ifNotPprForUser (ptext rec_str),
+     = vcat [ppr_isrec,
             vcat (map ppr sigs),
             ppr bind
        ]
      where
-       rec_str = case is_rec of
-                  Recursive    -> SLIT("{- rec -}")
-                  NonRecursive -> SLIT("{- nonrec -}")
+       ppr_isrec = getPprStyle $ \ sty -> 
+                  if userStyle sty then empty else
+                  case is_rec of
+                       Recursive    -> ptext SLIT("{- rec -}")
+                       NonRecursive -> ptext SLIT("{- nonrec -}")
 \end{code}
 
 %************************************************************************
@@ -90,33 +110,38 @@ ppr_binds (MonoBind bind sigs is_rec)
 Global bindings (where clauses)
 
 \begin{code}
-data MonoBinds id pat
+data MonoBinds id
   = EmptyMonoBinds
 
-  | AndMonoBinds    (MonoBinds id pat)
-                   (MonoBinds id pat)
-
-  | PatMonoBind     pat
-                   (GRHSs id pat)
+  | AndMonoBinds    (MonoBinds id)
+                   (MonoBinds id)
+
+  | FunMonoBind     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
+                               -- FunMonoBinds, so if you change this, you'll need to
+                               -- change e.g. rnMethodBinds
+                   Bool                -- True => infix declaration
+                   [Match id]
                    SrcLoc
 
-  | FunMonoBind     id
-                   Bool                -- True => infix declaration
-                   [Match id pat]
+  | PatMonoBind     (Pat id)   -- The pattern is never a simple variable;
+                               -- That case is done by FunMonoBind
+                   (GRHSs id)
                    SrcLoc
 
   | VarMonoBind            id                  -- TRANSLATION
-                   (HsExpr id pat)
-
-  | CoreMonoBind    id                 -- TRANSLATION
-                   CoreExpr            -- No zonking; this is a final CoreExpr with Ids and Types!
+                   (HsExpr id)
 
   | 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"
+               (MonoBinds id)      -- The "business end"
 
        -- Creates bindings for *new* (polymorphic, overloaded) locals
        -- in terms of *old* (monomorphic, non-overloaded) ones.
@@ -147,57 +172,65 @@ 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)
+       tp = /\ [a,b] -> \ [d1,d2] -> letrec DBINDS and BIND 
+                                      in (fm,gm)
 
 \begin{code}
-nullMonoBinds :: MonoBinds id pat -> Bool
+-- We keep the invariant that a MonoBinds is only empty 
+-- if it is exactly EmptyMonoBinds
 
+nullMonoBinds :: MonoBinds id -> 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 :: MonoBinds id -> MonoBinds id -> MonoBinds id
 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
+andMonoBindList :: [MonoBinds id] -> MonoBinds id
+andMonoBindList binds
+  = loop1 binds
+  where
+    loop1 [] = EmptyMonoBinds
+    loop1 (EmptyMonoBinds : binds) = loop1 binds
+    loop1 (b:bs) = loop2 b bs
+
+       -- acc is non-empty
+    loop2 acc [] = acc
+    loop2 acc (EmptyMonoBinds : bs) = loop2 acc bs
+    loop2 acc (b:bs) = loop2 (acc `AndMonoBinds` b) bs
 \end{code}
 
+
 \begin{code}
-instance (Outputable id, Outputable pat) =>
-               Outputable (MonoBinds id pat) where
+instance OutputableBndr id => Outputable (MonoBinds id) where
     ppr mbind = ppr_monobind mbind
 
 
-ppr_monobind :: (Outputable id, Outputable pat) => MonoBinds id pat -> SDoc
+ppr_monobind :: OutputableBndr id => MonoBinds id -> 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 (PatMonoBind pat grhss locn)      = pprPatBind pat grhss
+ppr_monobind (FunMonoBind fun inf matches locn) = pprFunBind 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)]
+      = sep [pprBndr LetBind name <+> equals, nest 4 (pprExpr expr)]
 
 ppr_monobind (AbsBinds tyvars dictvars exports inlines val_binds)
      = sep [ptext SLIT("AbsBinds"),
            brackets (interpp'SP tyvars),
            brackets (interpp'SP dictvars),
-           brackets (interpp'SP exports),
+           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}
 
 %************************************************************************
@@ -218,7 +251,8 @@ data Sig name
                SrcLoc
 
   | ClassOpSig name            -- Selector name
-               (Maybe name)    -- Default-method name (if any)
+                (DefMeth name) -- Default-method info
+                               -- See "THE NAMING STORY" in HsDecls
                (HsType name)
                SrcLoc
 
@@ -226,34 +260,46 @@ data Sig name
                (HsType name)   -- ... to these types
                SrcLoc
 
-  | InlineSig  name            -- INLINE f
-               SrcLoc
-
-  | NoInlineSig        name            -- NOINLINE f
+  | InlineSig  Bool            -- True <=> INLINE f, False <=> NOINLINE f
+               name            -- Function name
+               Activation      -- When inlining is *active*
                SrcLoc
 
   | SpecInstSig (HsType name)  -- (Class tys); should be a specialisation of the 
                                -- current instance decl
                SrcLoc
 
-  | FixSig     (FixitySig name)                -- Fixity declaration
-
-
-data FixitySig name  = FixitySig name Fixity SrcLoc
+  | FixSig     (FixitySig name)        -- Fixity declaration
 \end{code}
 
 \begin{code}
-sigsForMe :: (name -> Bool) -> [Sig name] -> [Sig name]
-sigsForMe f sigs
-  = filter sig_for_me sigs
-  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
+okBindSig :: NameSet -> Sig Name -> Bool
+okBindSig ns (ClassOpSig _ _ _ _) = False
+okBindSig ns sig                 = sigForThisGroup ns sig
+
+okClsDclSig :: NameSet -> Sig Name -> Bool
+okClsDclSig ns (Sig _ _ _) = False
+okClsDclSig ns sig        = sigForThisGroup ns sig
+
+okInstDclSig :: NameSet -> Sig Name -> Bool
+okInstDclSig ns (Sig _ _ _)      = False
+okInstDclSig ns (FixSig _)       = False
+okInstDclSig ns (SpecInstSig _ _) = True
+okInstDclSig ns sig              = sigForThisGroup ns sig
+
+sigForThisGroup ns sig 
+  = case sigName sig of
+       Nothing                  -> False
+       Just n | isUnboundName n -> True        -- Don't complain about an unbound name again
+              | otherwise       -> n `elemNameSet` ns
+
+sigName :: Sig name -> Maybe name
+sigName (Sig         n _ _)        = Just n
+sigName (ClassOpSig  n _ _ _)      = Just n
+sigName (SpecSig     n _ _)        = Just n
+sigName (InlineSig _ n _ _)        = Just n
+sigName (FixSig (FixitySig n _ _)) = Just n
+sigName other                     = Nothing
 
 isFixitySig :: Sig name -> Bool
 isFixitySig (FixSig _) = True
@@ -262,32 +308,57 @@ 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
+\end{code}
+
+\begin{code}
+hsSigDoc (Sig        _ _ loc)        = (ptext SLIT("type signature"),loc)
+hsSigDoc (ClassOpSig _ _ _ loc)       = (ptext SLIT("class-method type signature"), loc)
+hsSigDoc (SpecSig    _ _ loc)        = (ptext SLIT("SPECIALISE pragma"),loc)
+hsSigDoc (InlineSig True  _ _ loc)    = (ptext SLIT("INLINE pragma"),loc)
+hsSigDoc (InlineSig False _ _ loc)    = (ptext SLIT("NOINLINE pragma"),loc)
+hsSigDoc (SpecInstSig _ loc)         = (ptext SLIT("SPECIALISE instance pragma"),loc)
+hsSigDoc (FixSig (FixitySig _ _ loc)) = (ptext SLIT("fixity declaration"), loc)
 \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]
-
-
+ppr_sig :: Outputable name => Sig name -> SDoc
 ppr_sig (Sig var ty _)
       = sep [ppr var <+> dcolon, nest 4 (ppr ty)]
 
-ppr_sig (ClassOpSig var _ ty _)
-      = sep [ppr var <+> dcolon, nest 4 (ppr ty)]
+ppr_sig (ClassOpSig var dm ty _)
+      = sep [ pprHsVar var <+> dcolon, 
+             nest 4 (ppr ty),
+             nest 4 (pp_dm_comment) ]
+      where
+       pp_dm = case dm of 
+                 DefMeth _  -> equals  -- Default method indicator
+                 GenDefMeth -> semi    -- Generic method indicator
+                 NoDefMeth  -> empty   -- No Method at all
+       pp_dm_comment = case dm of 
+                 DefMeth _  -> text "{- has default method -}"
+                 GenDefMeth -> text "{- has generic method -}"
+                 NoDefMeth  -> empty   -- No Method at all
 
 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 _)
       = hsep [text "{-# SPECIALIZE instance", ppr ty, text "#-}"]
@@ -295,3 +366,19 @@ ppr_sig (SpecInstSig ty _)
 ppr_sig (FixSig fix_sig) = ppr fix_sig
 \end{code}
 
+Checking for distinct signatures; oh, so boring
+
+
+\begin{code}
+eqHsSig :: Sig Name -> Sig Name -> Bool
+eqHsSig (Sig n1 _ _)         (Sig n2 _ _)          = n1 == n2
+eqHsSig (InlineSig b1 n1 _ _)(InlineSig b2 n2 _ _) = b1 == b2 && n1 == n2
+
+eqHsSig (SpecInstSig ty1 _)  (SpecInstSig ty2 _)  = ty1 == ty2
+eqHsSig (SpecSig n1 ty1 _)   (SpecSig n2 ty2 _)   =
+    -- may have many specialisations for one value;
+    -- but not ones that are exactly the same...
+    (n1 == n2) && (ty1 == ty2)
+
+eqHsSig _other1 _other2 = False
+\end{code}