Add Data and Typeable instances to HsSyn
[ghc-hetmet.git] / compiler / hsSyn / HsImpExp.lhs
index 4e58dd7..dd24aed 100644 (file)
@@ -12,15 +12,18 @@ HsImpExp: Abstract syntax: imports, exports, interfaces
 -- any warnings in the module. See
 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
 -- for details
+{-# LANGUAGE DeriveDataTypeable #-}
 
 module HsImpExp where
 
 import Module          ( ModuleName )
-import HsDoc           ( HsDoc )
+import HsDoc           ( HsDocString )
 
 import Outputable
 import FastString
 import SrcLoc          ( Located(..) )
+
+import Data.Data
 \end{code}
 
 %************************************************************************
@@ -33,38 +36,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)
+    ppr (ImportDecl mod pkg from qual as spec)
       = hang (hsep [ptext (sLit "import"), ppr_imp from, 
-                    pp_qual qual, ppr mod, pp_as as])
+                    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_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 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}
 
 %************************************************************************
@@ -76,15 +84,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}