Make dumpIfSet_dyn_or use dumpSDoc
[ghc-hetmet.git] / compiler / hsSyn / HsImpExp.lhs
index 029ec28..5015999 100644 (file)
@@ -6,24 +6,18 @@
 HsImpExp: Abstract syntax: imports, exports, interfaces
 
 \begin{code}
-{-# OPTIONS -fno-warn-incomplete-patterns #-}
--- 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/Commentary/CodingStyle#Warnings
--- for details
+{-# LANGUAGE DeriveDataTypeable #-}
 
 module HsImpExp where
 
-#include "HsVersions.h"
-
 import Module          ( ModuleName )
-import HsDoc           ( HsDoc )
+import HsDoc           ( HsDocString )
 
 import Outputable
 import FastString
 import SrcLoc          ( Located(..) )
-import Char            ( isAlpha )
+
+import Data.Data
 \end{code}
 
 %************************************************************************
@@ -36,38 +30,43 @@ One per \tr{import} declaration in a module.
 \begin{code}
 type LImportDecl name = Located (ImportDecl name)
 
+-- | A single Haskell @import@ declaration.
 data ImportDecl name
-  = ImportDecl   (Located ModuleName)          -- module name
-                 Bool                          -- True <=> {-# SOURCE #-} import
-                 Bool                          -- True => qualified
-                 (Maybe ModuleName)            -- as Module
-                 (Maybe (Bool, [LIE name]))    -- (True => hiding, names)
+  = ImportDecl {
+      ideclName      :: Located ModuleName, -- ^ Module name.
+      ideclPkgQual   :: Maybe FastString,   -- ^ Package qualifier.
+      ideclSource    :: Bool,               -- ^ True <=> {-# SOURCE #-} import
+      ideclQualified :: Bool,               -- ^ True => qualified
+      ideclAs        :: Maybe ModuleName,   -- ^ as Module
+      ideclHiding    :: Maybe (Bool, [LIE name]) -- ^ (True => hiding, names)
+    } deriving (Data, Typeable)
 \end{code}
 
 \begin{code}
 instance (Outputable name) => Outputable (ImportDecl name) where
-    ppr (ImportDecl mod from qual as spec)
-      = hang (hsep [ptext SLIT("import"), ppr_imp from, 
-                    pp_qual qual, ppr mod, pp_as as])
+    ppr (ImportDecl mod pkg from qual as spec)
+      = hang (hsep [ptext (sLit "import"), ppr_imp from, 
+                    pp_qual qual, pp_pkg pkg, ppr mod, pp_as as])
             4 (pp_spec spec)
       where
+        pp_pkg Nothing  = empty
+        pp_pkg (Just p) = doubleQuotes (ftext p)
+
        pp_qual False   = empty
-       pp_qual True    = ptext SLIT("qualified")
+       pp_qual True    = ptext (sLit "qualified")
 
        pp_as Nothing   = empty
-       pp_as (Just a)  = ptext SLIT("as ") <+> ppr a
+       pp_as (Just a)  = ptext (sLit "as") <+> ppr a
 
-       ppr_imp True  = ptext SLIT("{-# SOURCE #-}")
+       ppr_imp True  = ptext (sLit "{-# SOURCE #-}")
        ppr_imp False = empty
 
-       pp_spec Nothing = empty
-       pp_spec (Just (False, spec))
-                       = parens (interpp'SP spec)
-       pp_spec (Just (True, spec))
-                       = ptext SLIT("hiding") <+> parens (interpp'SP spec)
+       pp_spec Nothing             = empty
+       pp_spec (Just (False, ies)) = ppr_ies ies
+       pp_spec (Just (True,  ies)) = ptext (sLit "hiding") <+> ppr_ies ies
 
-ideclName :: ImportDecl name -> Located ModuleName
-ideclName (ImportDecl mod_nm _ _ _ _) = mod_nm
+       ppr_ies []  = ptext (sLit "()")
+       ppr_ies ies = char '(' <+> interpp'SP ies <+> char ')'
 \end{code}
 
 %************************************************************************
@@ -79,15 +78,17 @@ ideclName (ImportDecl mod_nm _ _ _ _) = mod_nm
 \begin{code}
 type LIE name = Located (IE name)
 
+-- | Imported or exported entity.
 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    ModuleName      -- (Export Only)
-  | IEGroup             Int (HsDoc name) -- Doc section heading
-  | IEDoc               (HsDoc name)     -- Some documentation
-  | IEDocNamed          String           -- Reference to named doc
+  | 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 HsDocString  -- ^ Doc section heading
+  | IEDoc               HsDocString      -- ^ Some documentation
+  | IEDocNamed          String           -- ^ Reference to named doc
+  deriving (Data, Typeable)
 \end{code}
 
 \begin{code}
@@ -96,6 +97,7 @@ ieName (IEVar n)       = n
 ieName (IEThingAbs  n)   = n
 ieName (IEThingWith n _) = n
 ieName (IEThingAll  n)   = n
+ieName _ = panic "ieName failed pattern match!"
 
 ieNames :: IE a -> [a]
 ieNames (IEVar            n   ) = [n]
@@ -115,32 +117,11 @@ instance (Outputable name) => Outputable (IE name) where
     ppr (IEThingAll    thing)  = hcat [ppr thing, text "(..)"]
     ppr (IEThingWith thing withs)
        = ppr thing <> parens (fsep (punctuate comma (map pprHsVar withs)))
-    ppr (IEModuleContents mod)
-       = ptext SLIT("module") <+> ppr mod
+    ppr (IEModuleContents mod')
+       = ptext (sLit "module") <+> ppr mod'
     ppr (IEGroup n _)           = text ("<IEGroup: " ++ (show n) ++ ">")
     ppr (IEDoc doc)             = ppr doc
     ppr (IEDocNamed string)     = text ("<IEDocNamed: " ++ string ++ ">")
 \end{code}
 
-\begin{code}
-pprHsVar :: Outputable name => name -> SDoc
-pprHsVar v | isOperator ppr_v = parens ppr_v
-          | otherwise        = ppr_v
-          where
-            ppr_v = ppr v
-
-isOperator :: SDoc -> Bool
-isOperator ppr_v 
-  = case showSDocUnqual ppr_v of
-        ('(':_)   -> False              -- (), (,) etc
-        ('[':_)   -> False              -- []
-        ('$':c:_) -> not (isAlpha c)    -- Don't treat $d as an operator
-        (':':c:_) -> not (isAlpha c)    -- Don't treat :T as an operator
-        ('_':_)   -> False              -- Not an operator
-        (c:_)     -> not (isAlpha c)    -- Starts with non-alpha
-        _         -> False
-    -- We use (showSDoc (ppr v)), rather than isSymOcc (getOccName v) simply so
-    -- that we don't need NamedThing in the context of all these functions.
-    -- Gruesome, but simple.
-\end{code}