[project @ 2000-02-25 14:55:31 by panne]
[ghc-hetmet.git] / ghc / compiler / hsSyn / HsSyn.lhs
index 2702f8a..42731cc 100644 (file)
@@ -1,5 +1,5 @@
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 \section{Haskell abstract syntax definition}
 
@@ -8,64 +8,51 @@ which is declared in the various \tr{Hs*} modules.  This module,
 therefore, is almost nothing but re-exporting.
 
 \begin{code}
-#include "HsVersions.h"
-
 module HsSyn (
 
        -- NB: don't reexport HsCore or HsPragmas;
        -- this module tells about "real Haskell"
 
-       EXP_MODULE(HsSyn) ,
-       EXP_MODULE(HsBinds) ,
-       EXP_MODULE(HsDecls) ,
-       EXP_MODULE(HsExpr) ,
-       EXP_MODULE(HsImpExp) ,
-       EXP_MODULE(HsBasic) ,
-       EXP_MODULE(HsMatches) ,
-       EXP_MODULE(HsPat) ,
-       EXP_MODULE(HsTypes)
+       module HsSyn,
+       module HsBinds,
+       module HsDecls,
+       module HsExpr,
+       module HsImpExp,
+       module HsBasic,
+       module HsMatches,
+       module HsPat,
+       module HsTypes,
+       Fixity, NewOrData, 
+
+       collectTopBinders, collectMonoBinders
      ) where
 
-IMP_Ubiq()
+#include "HsVersions.h"
 
 -- friends:
+import HsDecls         
 import HsBinds
-import HsDecls         ( HsDecl(..), TyDecl(..), InstDecl(..), ClassDecl(..), 
-                         DefaultDecl(..), 
-                         FixityDecl(..), 
-                         ConDecl(..), BangType(..),
-                         IfaceSig(..), HsIdInfo,  SpecDataSig(..), SpecInstSig(..),
-                         hsDeclName
-                       )
 import HsExpr
 import HsImpExp
 import HsBasic
 import HsMatches
 import HsPat
 import HsTypes
-import HsPragmas       ( ClassPragmas, ClassOpPragmas,
-                         DataPragmas, GenPragmas, InstancePragmas )
 import HsCore
+import BasicTypes      ( Fixity, Version, NewOrData )
 
 -- others:
-import FiniteMap       ( FiniteMap )
-import Outputable      ( ifPprShowAll, ifnotPprForUser, interpp'SP, Outputable(..) )
-import Pretty
+import Outputable
 import SrcLoc          ( SrcLoc )
-\end{code}
-
-@Fake@ is a placeholder type; for when tyvars and uvars aren't used.
-\begin{code}
-data Fake = Fake
-instance Eq Fake
-instance Outputable Fake
+import Bag
+import Module          ( ModuleName, pprModuleName )
 \end{code}
 
 All we actually declare here is the top-level structure for a module.
 \begin{code}
-data HsModule tyvar uvar name pat
+data HsModule name pat
   = HsModule
-       Module                  -- module name
+       ModuleName              -- module name
        (Maybe Version)         -- source interface version number
        (Maybe [IE name])       -- export list; Nothing => export everything
                                -- Just [] => export *nothing* (???)
@@ -74,36 +61,76 @@ data HsModule tyvar uvar name pat
                                -- imported interfaces early on, adding that
                                -- info to TyDecls/etc; so this list is
                                -- often empty, downstream.
-       [FixityDecl name]
-       [HsDecl tyvar uvar name pat]    -- Type, class, value, and interface signature decls
+       [HsDecl name pat]       -- Type, class, value, and interface signature decls
+       (Maybe DeprecTxt)       -- reason/explanation for deprecation of this module
        SrcLoc
 \end{code}
 
 \begin{code}
-instance (NamedThing name, Outputable name, Outputable pat,
-         Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
-       => Outputable (HsModule tyvar uvar name pat) where
-
-    ppr sty (HsModule name iface_version exports imports fixities
-                     decls src_loc)
-      = ppAboves [
-           ifPprShowAll sty (ppr sty src_loc),
-           ifnotPprForUser sty (pp_iface_version iface_version),
+instance (Outputable name, Outputable pat)
+       => Outputable (HsModule name pat) where
+
+    ppr (HsModule name iface_version exports imports
+                     decls deprec src_loc)
+      = vcat [
            case exports of
-             Nothing -> ppCat [ppPStr SLIT("module"), ppPStr name, ppPStr SLIT("where")]
-             Just es -> ppAboves [
-                           ppCat [ppPStr SLIT("module"), ppPStr name, ppLparen],
-                           ppNest 8 (interpp'SP sty es),
-                           ppNest 4 (ppPStr SLIT(") where"))
+             Nothing -> pp_header (ptext SLIT("where"))
+             Just es -> vcat [
+                           pp_header lparen,
+                           nest 8 (fsep (punctuate comma (map ppr es))),
+                           nest 4 (ptext SLIT(") where"))
                          ],
            pp_nonnull imports,
-           pp_nonnull fixities,
            pp_nonnull decls
        ]
       where
-       pp_nonnull [] = ppNil
-       pp_nonnull xs = ppAboves (map (ppr sty) xs)
+       pp_header rest = case deprec of
+           Nothing -> pp_modname <+> rest
+           Just d -> vcat [ pp_modname, ppr d, rest ]
+
+       pp_modname = ptext SLIT("module") <+> pprModuleName name
+
+       pp_nonnull [] = empty
+       pp_nonnull xs = vcat (map ppr xs)
 
-       pp_iface_version Nothing  = ppNil
-       pp_iface_version (Just n) = ppCat [ppStr "{-# INTERFACE", ppInt n, ppStr "#-}"]
+       pp_iface_version Nothing  = empty
+       pp_iface_version (Just n) = hsep [text "{-# INTERFACE", int n, text "#-}"]
 \end{code}
+
+
+%************************************************************************
+%*                                                                     *
+\subsection{Collecting binders from @HsBinds@}
+%*                                                                     *
+%************************************************************************
+
+Get all the binders in some @MonoBinds@, IN THE ORDER OF APPEARANCE.
+
+These functions are here, rather than in HsBinds, to avoid a loop between HsPat and HsBinds.
+
+\begin{verbatim}
+...
+where
+  (x, y) = ...
+  f i j  = ...
+  [a, b] = ...
+\end{verbatim}
+it should return @[x, y, f, a, b]@ (remember, order important).
+
+\begin{code}
+collectTopBinders :: HsBinds name (InPat name) -> Bag (name,SrcLoc)
+collectTopBinders EmptyBinds     = emptyBag
+collectTopBinders (MonoBind b _ _) = collectMonoBinders b
+collectTopBinders (ThenBinds b1 b2)
+ = collectTopBinders b1 `unionBags` collectTopBinders b2
+
+collectMonoBinders :: MonoBinds name (InPat name) -> Bag (name,SrcLoc)
+collectMonoBinders EmptyMonoBinds               = emptyBag
+collectMonoBinders (PatMonoBind pat _ loc)      = listToBag (map (\v->(v,loc)) (collectPatBinders pat))
+collectMonoBinders (FunMonoBind f _ matches loc) = unitBag (f,loc)
+collectMonoBinders (VarMonoBind v expr)         = error "collectMonoBinders"
+collectMonoBinders (CoreMonoBind v expr)        = error "collectMonoBinders"
+collectMonoBinders (AndMonoBinds bs1 bs2)       = collectMonoBinders bs1 `unionBags`
+                                                  collectMonoBinders bs2
+\end{code}
+