Add {-# OPTIONS_GHC -w #-} and some blurb to all compiler modules
[ghc-hetmet.git] / compiler / hsSyn / HsImpExp.lhs
index 220afb7..ebd18ea 100644 (file)
@@ -1,14 +1,25 @@
 %
+% (c) The University of Glasgow 2006
 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
-\section[HsImpExp]{Abstract syntax: imports, exports, interfaces}
+
+HsImpExp: Abstract syntax: imports, exports, interfaces
 
 \begin{code}
+{-# OPTIONS_GHC -w #-}
+-- The above warning supression flag is a temporary kludge.
+-- While working on this module you are encouraged to remove it and fix
+-- any warnings in the module. See
+--     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
+-- for details
+
 module HsImpExp where
 
 #include "HsVersions.h"
 
-import Module          ( Module )
+import Module          ( ModuleName )
+import HsDoc           ( HsDoc )
+
 import Outputable
 import FastString
 import SrcLoc          ( Located(..) )
@@ -26,10 +37,10 @@ One per \tr{import} declaration in a module.
 type LImportDecl name = Located (ImportDecl name)
 
 data ImportDecl name
-  = ImportDecl   (Located Module)              -- module name
+  = ImportDecl   (Located ModuleName)          -- module name
                  Bool                          -- True <=> {-# SOURCE #-} import
                  Bool                          -- True => qualified
-                 (Maybe Module)                -- as Module
+                 (Maybe ModuleName)            -- as Module
                  (Maybe (Bool, [LIE name]))    -- (True => hiding, names)
 \end{code}
 
@@ -68,11 +79,14 @@ ideclName (ImportDecl mod_nm _ _ _ _) = mod_nm
 type LIE name = Located (IE name)
 
 data IE name
-  = IEVar              name
-  | IEThingAbs          name           -- Class/Type (can't tell)
-  | IEThingAll          name           -- Class/Type plus all methods/constructors
-  | IEThingWith                name [name]     -- Class/Type plus some methods/constructors
-  | IEModuleContents    Module         -- (Export Only)
+  = IEVar               name
+  | IEThingAbs          name            -- Class/Type (can't tell)
+  | IEThingAll          name            -- Class/Type plus all methods/constructors
+  | IEThingWith         name [name]     -- Class/Type plus some methods/constructors
+  | IEModuleContents    ModuleName      -- (Export Only)
+  | IEGroup             Int (HsDoc name) -- Doc section heading
+  | IEDoc               (HsDoc name)     -- Some documentation
+  | IEDocNamed          String           -- Reference to named doc
 \end{code}
 
 \begin{code}
@@ -88,6 +102,9 @@ ieNames (IEThingAbs       n   ) = [n]
 ieNames (IEThingAll       n   ) = [n]
 ieNames (IEThingWith      n ns) = n:ns
 ieNames (IEModuleContents _   ) = []
+ieNames (IEGroup          _ _ ) = []
+ieNames (IEDoc            _   ) = []
+ieNames (IEDocNamed       _   ) = []        
 \end{code}
 
 \begin{code}
@@ -99,6 +116,9 @@ instance (Outputable name) => Outputable (IE name) where
        = ppr thing <> parens (fsep (punctuate comma (map pprHsVar withs)))
     ppr (IEModuleContents mod)
        = ptext SLIT("module") <+> ppr mod
+    ppr (IEGroup n doc)         = text ("<IEGroup: " ++ (show n) ++ ">") 
+    ppr (IEDoc doc)             = ppr doc
+    ppr (IEDocNamed string)     = text ("<IEDocNamed: " ++ string ++ ">")
 \end{code}
 
 \begin{code}