emptyHaddockModInfo,
) where
-#include "HsVersions.h"
-
-- friends:
import HsDecls
import HsBinds
import HsLit
import HsPat
import HsTypes
-import BasicTypes ( Fixity, DeprecTxt )
+import BasicTypes ( Fixity, WarningTxt )
import HsUtils
import HsDoc
import Outputable
import SrcLoc ( Located(..) )
import Module ( Module, ModuleName )
+import FastString
\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 DeprecTxt) -- reason/explanation for deprecation of this module
- (HaddockModInfo name) -- Haddock module info
- (Maybe (HsDoc name)) -- Haddock module description
+ = 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
+ hsmodHaddockModInfo :: HaddockModInfo name,
+ -- ^ Haddock module info
+ hsmodHaddockModDescr :: Maybe (HsDoc name)
+ -- ^ Haddock module description
+ }
data HaddockModInfo name = HaddockModInfo {
hmi_description :: Maybe (HsDoc name),
= vcat [
pp_mb mbDoc,
case exports of
- Nothing -> pp_header (ptext 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"))
+ nest 4 (ptext (sLit ") where"))
],
pp_nonnull imports,
pp_nonnull decls
Nothing -> pp_modname <+> rest
Just d -> vcat [ pp_modname, ppr d, rest ]
- pp_modname = ptext SLIT("module") <+> ppr name
+ pp_modname = ptext (sLit "module") <+> ppr name
pp_mb :: Outputable t => Maybe t -> SDoc
pp_mb (Just x) = ppr x