Add nice header/footer for autodoc
[hcoop/domtool2.git] / src / autodoc.sml
1 (* HCoop Domtool (http://hcoop.sourceforge.net/)
2 * Copyright (c) 2006, Adam Chlipala
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 *)
18
19 (* Generating HTML documentation automatically *)
20
21 structure Autodoc :> AUTODOC = struct
22
23 open Ast HTML HtmlPrint
24 open PD
25
26 fun uppercase s =
27 case s of
28 "" => s
29 | _ => str (Char.toUpper (String.sub (s, 0)))
30 ^ String.extract (s, 1, NONE)
31
32 fun check' G fname =
33 let
34 val prog = Parse.parse fname
35 in
36 if !ErrorMsg.anyErrors then
37 G
38 else
39 Tycheck.checkFile G (Defaults.tInit ()) prog
40 end
41
42 fun autodoc {outdir, infiles} =
43 let
44 val (prov, infiles) = Order.order infiles
45 val _ = HtmlPrint.setProviders prov
46
47 val G = foldl (fn (fname, G) => check' G fname) Env.empty infiles
48
49 fun annotate_decl d =
50 case d of
51 DVal (name, NONE, e) =>
52 (case Env.lookupVal G name of
53 NONE => d
54 | SOME t => DVal (name, SOME t, e))
55 | _ => d
56
57 fun modify file =
58 let
59 val file' = #file (OS.Path.splitDirFile file)
60 val file' = #base (OS.Path.splitBaseExt file')
61 in
62 file'
63 end
64
65 fun doFile file =
66 let
67 val (desc, decls, _) = Parse.parse file
68
69 val file' = modify file
70
71 val title = "Domtool Module " ^ uppercase file'
72
73 val outf = TextIO.openOut (outdir ^ "/" ^ file' ^ ".html")
74
75 (*fun doDecl (d, desc, _) =
76 Option.app (fn desc => (TextIO.output (outf, "<p>");
77 TextIO.output (outf, desc);
78 TextIO.output (outf, "</p>\n"))) desc*)
79
80 val body = case desc of
81 NONE => BlockList []
82 | SOME desc => P {align = NONE,
83 content = PCDATA desc}
84
85 val body = BlockList [body,
86 TextBlock (BR {clear = SOME TextFlowCtl.all})]
87
88
89 val summaries = foldr (fn ((d, desc, _), summaries) =>
90 HtmlPrint.output (p_decl_fref (annotate_decl d))
91 :: BR {clear = NONE}
92 :: summaries)
93 [] decls
94
95 val entries = map (fn (d, desc, _) =>
96 let
97 val cblock = HtmlPrint.output (p_decl (annotate_decl d))
98
99 val dblock = case desc of
100 NONE => TextBlock (PCDATA "")
101 | SOME desc => BLOCKQUOTE (TextBlock (PCDATA desc))
102 in
103 BlockList [P {align = NONE,
104 content = TT cblock},
105 dblock]
106 end) decls
107
108 val body = BlockList (body
109 :: HR {align = NONE,
110 noshade = false,
111 size = NONE,
112 width = NONE}
113 :: TextBlock (TT (TextList summaries))
114 :: HR {align = NONE,
115 noshade = false,
116 size = NONE,
117 width = NONE}
118 :: entries)
119
120 val html = HTML {version = NONE,
121 head = [Head_TITLE title,
122 Head_LINK {id = NONE,
123 href = SOME Config.Autodoc.stylesheet,
124 rel = SOME "stylesheet",
125 rev = NONE,
126 title = NONE}],
127 body = BODY {background = NONE,
128 bgcolor = NONE,
129 text = NONE,
130 link = NONE,
131 vlink = NONE,
132 alink = NONE,
133 content = BlockList[TextBlock (PCDATA (Config.Autodoc.htmlHeader title)),
134 body,
135 TextBlock (PCDATA Config.Autodoc.htmlFooter)]}}
136 in
137 PrHTML.prHTML {putc = (fn ch => TextIO.output1 (outf, ch)),
138 puts = (fn s => TextIO.output (outf, s))} html;
139 TextIO.closeOut outf
140 end
141
142 val title = "Domtool Module Index"
143
144 val items = map (fn file =>
145 let
146 val file' = modify file
147 in
148 LI {ty = NONE,
149 value = NONE,
150 content = TextBlock (A {name = NONE,
151 href = SOME (file' ^ ".html"),
152 rel = NONE,
153 rev = NONE,
154 title = NONE,
155 content = PCDATA (uppercase file')})}
156 end) infiles
157
158 val index = HTML {version = NONE,
159 head = [Head_TITLE title,
160 Head_LINK {id = NONE,
161 href = SOME Config.Autodoc.stylesheet,
162 rel = SOME "stylesheet",
163 rev = NONE,
164 title = NONE}],
165 body = BODY {background = NONE,
166 bgcolor = NONE,
167 text = NONE,
168 link = NONE,
169 vlink = NONE,
170 alink = NONE,
171 content = BlockList[TextBlock (PCDATA (Config.Autodoc.htmlHeader title)),
172 TextBlock (BR {clear = SOME TextFlowCtl.all}),
173 UL {ty = NONE,
174 compact = false,
175 content = items},
176 TextBlock (PCDATA Config.Autodoc.htmlFooter)]}}
177
178 val outf = TextIO.openOut (outdir ^ "/index.html")
179 in
180 PrHTML.prHTML {putc = (fn ch => TextIO.output1 (outf, ch)),
181 puts = (fn s => TextIO.output (outf, s))} index;
182 TextIO.closeOut outf;
183
184 app doFile infiles
185 end
186
187 end