1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
--
-- Haddock - A Haskell Documentation Tool
--
-- (c) Simon Marlow 2003
--
module HaddockTypes (
-- * Module interfaces
NameEnv, Interface(..), ExportItem(..), ModuleMap,
-- * Misc types
DocOption(..), InstHead,
) where
import HsSyn
import Map
-- ---------------------------------------------------------------------------
-- Describing a module interface
type NameEnv = Map HsName HsQName
data Interface
= Interface {
iface_filename :: FilePath,
-- ^ the filename that contains the source code for this module
iface_module :: Module,
iface_package :: Maybe String,
iface_env :: NameEnv,
-- ^ environment mapping exported names to *original* names
iface_reexported :: [HsName],
-- ^ For names exported by this module, but not
-- actually documented in this module's documentation
-- (perhaps because they are reexported via 'module M'
-- in the export list), this mapping gives the
-- location of documentation for the name in another
-- module.
iface_sub :: Map HsName [HsName],
-- ^ maps names to "subordinate" names
-- (eg. tycon to constrs & fields, class to methods)
iface_exports :: [ExportItem],
-- ^ the exports used to construct the documentation
iface_orig_exports :: [ExportItem],
-- ^ the exports used to construct the documentation
-- (with orig names, not import names)
iface_decls :: Map HsName HsDecl,
-- ^ decls from this module (only)
-- restricted to only those bits exported.
-- the map key is the "main name" of the decl.
iface_insts :: [HsDecl],
-- ^ instances from this module
iface_info :: ModuleInfo,
-- ^ information from the module header
iface_doc :: Maybe Doc,
-- ^ documentation from the module header
iface_options :: [DocOption]
-- ^ module-wide doc options
}
data DocOption
= OptHide -- this module should not appear in the docs
| OptPrune
| OptIgnoreExports -- pretend everything is exported
| OptNotHome -- not the best place to get docs for things
-- exported by this module.
deriving (Eq)
data ExportItem
= ExportDecl
HsQName -- the original name
HsDecl -- a declaration (with doc annotations)
[InstHead] -- instances relevant to this declaration
| ExportNoDecl -- an exported entity for which we have no documentation
-- (perhaps becuase it resides in another package)
HsQName -- the original name
HsQName -- where to link to
[HsQName] -- subordinate names
| ExportGroup -- a section heading
Int -- section level (1, 2, 3, ... )
String -- section "id" (for hyperlinks)
Doc -- section heading text
| ExportDoc -- some documentation
Doc
| ExportModule -- a cross-reference to another module
Module
type ModuleMap = Map Module Interface
type InstHead = (HsContext,HsAsst)
|
