X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2FhsSyn%2FHsSyn.lhs;h=ce748ebfab65cc788d317c240e6f87b9f336433e;hp=6277f5cc3cc8f677122b4ddf6ed90488f539812f;hb=b2bd63f99d643f6b3eb30bb72bb9ae26d4183252;hpb=cae75f82226638691cfa1e85fc168f4b65ddce4d

diff --git a/compiler/hsSyn/HsSyn.lhs b/compiler/hsSyn/HsSyn.lhs
index 6277f5c..ce748eb 100644
--- a/compiler/hsSyn/HsSyn.lhs
+++ b/compiler/hsSyn/HsSyn.lhs
@@ -9,6 +9,8 @@ which is declared in the various \tr{Hs*} modules.  This module,
 therefore, is almost nothing but re-exporting.
 
 \begin{code}
+{-# LANGUAGE DeriveDataTypeable #-}
+
 module HsSyn (
 	module HsBinds,
 	module HsDecls,
@@ -22,9 +24,6 @@ module HsSyn (
 	Fixity,
 
 	HsModule(..), HsExtCore(..),
-
-	HaddockModInfo(..),
-	emptyHaddockModInfo,
 ) where
 
 -- friends:
@@ -42,43 +41,41 @@ import HsDoc
 -- others:
 import IfaceSyn		( IfaceBinding )
 import Outputable
-import SrcLoc		( Located(..) )
+import SrcLoc
 import Module		( Module, ModuleName )
 import FastString
+
+-- libraries:
+import Data.Data hiding ( Fixity )
 \end{code}
 
-All we actually declare here is the top-level structure for a module.
 \begin{code}
+-- | All we actually declare here is the top-level structure for a module.
 data HsModule name
-  = HsModule
-	(Maybe (Located ModuleName))-- Nothing => "module X where" is omitted
-				--	(in which case the next field is Nothing too)
-	(Maybe [LIE name])	-- Export list; Nothing => export list omitted, so export everything
-				-- Just [] => export *nothing*
-				-- Just [...] => as you would expect...
-	[LImportDecl name]	-- We snaffle interesting stuff out of the
-				-- imported interfaces early on, adding that
-				-- info to TyDecls/etc; so this list is
-				-- often empty, downstream.
-	[LHsDecl name]		-- Type, class, value, and interface signature decls
-	(Maybe WarningTxt)	-- reason/explanation for warning/deprecation of this module
-	(HaddockModInfo name)   -- Haddock module info
-	(Maybe (HsDoc name))    -- Haddock module description
-
-data HaddockModInfo name = HaddockModInfo { 
-	hmi_description :: Maybe (HsDoc name),
-	hmi_portability :: Maybe String,
-	hmi_stability   :: Maybe String,
-	hmi_maintainer  :: Maybe String
-}
-
-emptyHaddockModInfo :: HaddockModInfo a                                                  
-emptyHaddockModInfo = HaddockModInfo {                                                  
-	hmi_description = Nothing,
-	hmi_portability = Nothing,
-	hmi_stability   = Nothing,
-	hmi_maintainer  = Nothing
-}       
+  = HsModule {
+      hsmodName :: Maybe (Located ModuleName),
+        -- ^ @Nothing@: \"module X where\" is omitted (in which case the next
+        --     field is Nothing too)
+      hsmodExports :: Maybe [LIE name],
+        -- ^ Export list
+        --
+        --  - @Nothing@: export list omitted, so export everything
+        --
+        --  - @Just []@: export /nothing/
+        --
+        --  - @Just [...]@: as you would expect...
+        --
+      hsmodImports :: [LImportDecl name],
+        -- ^ We snaffle interesting stuff out of the imported interfaces early
+        -- on, adding that info to TyDecls/etc; so this list is often empty,
+        -- downstream.
+      hsmodDecls :: [LHsDecl name],
+        -- ^ Type, class, value, and interface signature decls
+      hsmodDeprecMessage :: Maybe WarningTxt,
+        -- ^ reason\/explanation for warning/deprecation of this module
+      hsmodHaddockModHeader :: Maybe LHsDocString
+        -- ^ Haddock module info and description, unparsed
+   } deriving (Data, Typeable)
 
 data HsExtCore name	-- Read from Foo.hcr
   = HsExtCore
@@ -96,10 +93,10 @@ instance Outputable Char where
 instance (OutputableBndr name)
 	=> Outputable (HsModule name) where
 
-    ppr (HsModule Nothing _ imports decls _ _ mbDoc)
+    ppr (HsModule Nothing _ imports decls _ mbDoc)
       = pp_mb mbDoc $$ pp_nonnull imports $$ pp_nonnull decls
 
-    ppr (HsModule (Just name) exports imports decls deprec _ mbDoc)
+    ppr (HsModule (Just name) exports imports decls deprec mbDoc)
       = vcat [
 	    pp_mb mbDoc,
 	    case exports of