2 * HTML backend for Halibut
8 * - I'm never entirely convinced that having a fragment link to
9 * come in at the start of the real text in the file is
10 * sensible. Perhaps for the topmost section in the file, no
11 * fragment should be used? (Though it should probably still be
12 * _there_ even if unused.)
21 #define is_heading_type(type) ( (type) == para_Title || \
22 (type) == para_Chapter || \
23 (type) == para_Appendix || \
24 (type) == para_UnnumberedChapter || \
25 (type) == para_Heading || \
26 (type) == para_Subsect)
28 #define heading_depth(p) ( (p)->type == para_Subsect ? (p)->aux + 1 : \
29 (p)->type == para_Heading ? 1 : \
30 (p)->type == para_Title ? -1 : 0 )
34 wchar_t *number_suffix
;
39 sectlevel achapter
, *asect
;
40 int *contents_depths
; /* 0=main, 1=chapter, 2=sect etc */
42 int address_section
, visible_version_id
;
43 int leaf_contains_contents
, leaf_smallest_contents
;
44 char *contents_filename
;
46 char *template_filename
;
47 char *single_filename
;
48 char *template_fragment
;
49 char *head_end
, *body_start
, *body_end
, *addr_start
, *addr_end
;
50 char *body_tag
, *nav_attr
;
51 wchar_t *author
, *description
;
52 wchar_t *index_text
, *contents_text
, *preamble_text
, *title_separator
;
53 wchar_t *nav_prev_text
, *nav_next_text
, *nav_separator
;
54 wchar_t *index_main_sep
, *index_multi_sep
;
55 wchar_t *pre_versionid
, *post_versionid
;
56 int restrict_charset
, output_charset
;
58 HTML_3_2
, HTML_4
, ISO_HTML
,
59 XHTML_1_0_TRANSITIONAL
, XHTML_1_0_STRICT
61 wchar_t *lquote
, *rquote
;
65 #define contents_depth(conf, level) \
66 ( (conf).ncdepths > (level) ? (conf).contents_depths[level] : (level)+2 )
68 #define is_xhtml(ver) ((ver) >= XHTML_1_0_TRANSITIONAL)
70 typedef struct htmlfile htmlfile
;
71 typedef struct htmlsect htmlsect
;
76 int last_fragment_number
;
77 int min_heading_depth
;
78 htmlsect
*first
, *last
; /* first/last highest-level sections */
82 htmlsect
*next
, *parent
;
84 paragraph
*title
, *text
;
85 enum { NORMAL
, TOP
, INDEX
} type
;
91 htmlfile
*head
, *tail
;
92 htmlfile
*single
, *index
;
97 htmlsect
*head
, *tail
;
113 int generated
, referenced
;
118 * This level deals with charset conversion, starting and
119 * ending tags, and writing to the file. It's the lexical
123 int charset
, restrict_charset
;
124 charset_state cstate
;
127 HO_NEUTRAL
, HO_IN_TAG
, HO_IN_EMPTY_TAG
, HO_IN_TEXT
130 * Stuff beyond here deals with the higher syntactic level: it
131 * tracks how many levels of <ul> are currently open when
132 * producing a contents list, for example.
137 static int html_fragment_compare(void *av
, void *bv
)
139 htmlfragment
*a
= (htmlfragment
*)av
;
140 htmlfragment
*b
= (htmlfragment
*)bv
;
143 if ((cmp
= strcmp(a
->file
->filename
, b
->file
->filename
)) != 0)
146 return strcmp(a
->fragment
, b
->fragment
);
149 static void html_file_section(htmlconfig
*cfg
, htmlfilelist
*files
,
150 htmlsect
*sect
, int depth
);
152 static htmlfile
*html_new_file(htmlfilelist
*list
, char *filename
);
153 static htmlsect
*html_new_sect(htmlsectlist
*list
, paragraph
*title
);
155 /* Flags for html_words() flags parameter */
159 #define INDEXENTS 0x04
161 static void html_words(htmloutput
*ho
, word
*words
, int flags
,
162 htmlfile
*file
, keywordlist
*keywords
, htmlconfig
*cfg
);
163 static void html_codepara(htmloutput
*ho
, word
*words
);
165 static void element_open(htmloutput
*ho
, char const *name
);
166 static void element_close(htmloutput
*ho
, char const *name
);
167 static void element_empty(htmloutput
*ho
, char const *name
);
168 static void element_attr(htmloutput
*ho
, char const *name
, char const *value
);
169 static void element_attr_w(htmloutput
*ho
, char const *name
,
170 wchar_t const *value
);
171 static void html_text(htmloutput
*ho
, wchar_t const *str
);
172 static void html_text_nbsp(htmloutput
*ho
, wchar_t const *str
);
173 static void html_text_limit(htmloutput
*ho
, wchar_t const *str
, int maxlen
);
174 static void html_text_limit_internal(htmloutput
*ho
, wchar_t const *text
,
175 int maxlen
, int quote_quotes
, int nbsp
);
176 static void html_nl(htmloutput
*ho
);
177 static void html_raw(htmloutput
*ho
, char *text
);
178 static void html_raw_as_attr(htmloutput
*ho
, char *text
);
179 static void cleanup(htmloutput
*ho
);
181 static void html_href(htmloutput
*ho
, htmlfile
*thisfile
,
182 htmlfile
*targetfile
, char *targetfrag
);
183 static void html_fragment(htmloutput
*ho
, char const *fragment
);
185 static char *html_format(paragraph
*p
, char *template_string
);
186 static char *html_sanitise_fragment(htmlfilelist
*files
, htmlfile
*file
,
189 static void html_contents_entry(htmloutput
*ho
, int depth
, htmlsect
*s
,
190 htmlfile
*thisfile
, keywordlist
*keywords
,
192 static void html_section_title(htmloutput
*ho
, htmlsect
*s
,
193 htmlfile
*thisfile
, keywordlist
*keywords
,
194 htmlconfig
*cfg
, int real
);
196 static htmlconfig
html_configure(paragraph
*source
) {
204 ret
.achapter
.just_numbers
= FALSE
;
205 ret
.achapter
.number_suffix
= L
": ";
207 ret
.asect
= snewn(ret
.nasect
, sectlevel
);
208 ret
.asect
[0].just_numbers
= TRUE
;
209 ret
.asect
[0].number_suffix
= L
" ";
211 ret
.contents_depths
= 0;
212 ret
.visible_version_id
= TRUE
;
213 ret
.address_section
= TRUE
;
214 ret
.leaf_contains_contents
= FALSE
;
215 ret
.leaf_smallest_contents
= 4;
216 ret
.single_filename
= dupstr("Manual.html");
217 ret
.contents_filename
= dupstr("Contents.html");
218 ret
.index_filename
= dupstr("IndexPage.html");
219 ret
.template_filename
= dupstr("%n.html");
220 ret
.template_fragment
= dupstr("%b");
221 ret
.head_end
= ret
.body_tag
= ret
.body_start
= ret
.body_end
=
222 ret
.addr_start
= ret
.addr_end
= ret
.nav_attr
= NULL
;
223 ret
.author
= ret
.description
= NULL
;
224 ret
.restrict_charset
= CS_UTF8
;
225 ret
.output_charset
= CS_ASCII
;
226 ret
.htmlver
= HTML_4
;
227 ret
.index_text
= L
"Index";
228 ret
.contents_text
= L
"Contents";
229 ret
.preamble_text
= L
"Preamble";
230 ret
.title_separator
= L
" - ";
231 ret
.nav_prev_text
= L
"Previous";
232 ret
.nav_next_text
= L
"Next";
233 ret
.nav_separator
= L
" | ";
234 ret
.index_main_sep
= L
": ";
235 ret
.index_multi_sep
= L
", ";
236 ret
.pre_versionid
= L
"[";
237 ret
.post_versionid
= L
"]";
239 * Default quote characters are Unicode matched single quotes,
240 * falling back to ordinary ASCII ".
242 ret
.lquote
= L
"\x2018\0\x2019\0\"\0\"\0\0";
243 ret
.rquote
= uadv(ret
.lquote
);
246 * Two-pass configuration so that we can pick up global config
247 * (e.g. `quotes') before having it overridden by specific
248 * config (`html-quotes'), irrespective of the order in which
251 for (p
= source
; p
; p
= p
->next
) {
252 if (p
->type
== para_Config
) {
253 if (!ustricmp(p
->keyword
, L
"quotes")) {
254 if (*uadv(p
->keyword
) && *uadv(uadv(p
->keyword
))) {
255 ret
.lquote
= uadv(p
->keyword
);
256 ret
.rquote
= uadv(ret
.lquote
);
262 for (p
= source
; p
; p
= p
->next
) {
263 if (p
->type
== para_Config
) {
264 wchar_t *k
= p
->keyword
;
266 if (!ustrnicmp(k
, L
"xhtml-", 6))
267 k
++; /* treat `xhtml-' and `html-' the same */
269 if (!ustricmp(k
, L
"html-restrict-charset")) {
270 ret
.restrict_charset
= charset_from_ustr(&p
->fpos
, uadv(k
));
271 } else if (!ustricmp(k
, L
"html-output-charset")) {
272 ret
.output_charset
= charset_from_ustr(&p
->fpos
, uadv(k
));
273 } else if (!ustricmp(k
, L
"html-version")) {
274 wchar_t *vername
= uadv(k
);
275 static const struct {
279 {L
"html3.2", HTML_3_2
},
281 {L
"iso-html", ISO_HTML
},
282 {L
"xhtml1.0transitional", XHTML_1_0_TRANSITIONAL
},
283 {L
"xhtml1.0strict", XHTML_1_0_STRICT
}
287 for (i
= 0; i
< (int)lenof(versions
); i
++)
288 if (!ustricmp(versions
[i
].name
, vername
))
291 if (i
== lenof(versions
))
292 error(err_htmlver
, &p
->fpos
, vername
);
294 ret
.htmlver
= versions
[i
].ver
;
295 } else if (!ustricmp(k
, L
"html-single-filename")) {
296 sfree(ret
.single_filename
);
297 ret
.single_filename
= dupstr(adv(p
->origkeyword
));
298 } else if (!ustricmp(k
, L
"html-contents-filename")) {
299 sfree(ret
.contents_filename
);
300 ret
.contents_filename
= dupstr(adv(p
->origkeyword
));
301 } else if (!ustricmp(k
, L
"html-index-filename")) {
302 sfree(ret
.index_filename
);
303 ret
.index_filename
= dupstr(adv(p
->origkeyword
));
304 } else if (!ustricmp(k
, L
"html-template-filename")) {
305 sfree(ret
.template_filename
);
306 ret
.template_filename
= dupstr(adv(p
->origkeyword
));
307 } else if (!ustricmp(k
, L
"html-template-fragment")) {
308 sfree(ret
.template_fragment
);
309 ret
.template_fragment
= dupstr(adv(p
->origkeyword
));
310 } else if (!ustricmp(k
, L
"html-chapter-numeric")) {
311 ret
.achapter
.just_numbers
= utob(uadv(k
));
312 } else if (!ustricmp(k
, L
"html-chapter-suffix")) {
313 ret
.achapter
.number_suffix
= uadv(k
);
314 } else if (!ustricmp(k
, L
"html-leaf-level")) {
315 ret
.leaf_level
= utoi(uadv(k
));
316 } else if (!ustricmp(k
, L
"html-section-numeric")) {
317 wchar_t *q
= uadv(k
);
323 if (n
>= ret
.nasect
) {
325 ret
.asect
= sresize(ret
.asect
, n
+1, sectlevel
);
326 for (i
= ret
.nasect
; i
<= n
; i
++)
327 ret
.asect
[i
] = ret
.asect
[ret
.nasect
-1];
330 ret
.asect
[n
].just_numbers
= utob(q
);
331 } else if (!ustricmp(k
, L
"html-section-suffix")) {
332 wchar_t *q
= uadv(k
);
338 if (n
>= ret
.nasect
) {
340 ret
.asect
= sresize(ret
.asect
, n
+1, sectlevel
);
341 for (i
= ret
.nasect
; i
<= n
; i
++) {
342 ret
.asect
[i
] = ret
.asect
[ret
.nasect
-1];
346 ret
.asect
[n
].number_suffix
= q
;
347 } else if (!ustricmp(k
, L
"html-contents-depth") ||
348 !ustrnicmp(k
, L
"html-contents-depth-", 20)) {
350 * Relic of old implementation: this directive used
351 * to be written as \cfg{html-contents-depth-3}{2}
352 * rather than the usual Halibut convention of
353 * \cfg{html-contents-depth}{3}{2}. We therefore
356 wchar_t *q
= k
[19] ? k
+20 : uadv(k
);
362 if (n
>= ret
.ncdepths
) {
364 ret
.contents_depths
=
365 sresize(ret
.contents_depths
, n
+1, int);
366 for (i
= ret
.ncdepths
; i
<= n
; i
++) {
367 ret
.contents_depths
[i
] = i
+2;
371 ret
.contents_depths
[n
] = utoi(q
);
372 } else if (!ustricmp(k
, L
"html-head-end")) {
373 ret
.head_end
= adv(p
->origkeyword
);
374 } else if (!ustricmp(k
, L
"html-body-tag")) {
375 ret
.body_tag
= adv(p
->origkeyword
);
376 } else if (!ustricmp(k
, L
"html-body-start")) {
377 ret
.body_start
= adv(p
->origkeyword
);
378 } else if (!ustricmp(k
, L
"html-body-end")) {
379 ret
.body_end
= adv(p
->origkeyword
);
380 } else if (!ustricmp(k
, L
"html-address-start")) {
381 ret
.addr_start
= adv(p
->origkeyword
);
382 } else if (!ustricmp(k
, L
"html-address-end")) {
383 ret
.addr_end
= adv(p
->origkeyword
);
384 } else if (!ustricmp(k
, L
"html-navigation-attributes")) {
385 ret
.nav_attr
= adv(p
->origkeyword
);
386 } else if (!ustricmp(k
, L
"html-author")) {
387 ret
.author
= uadv(k
);
388 } else if (!ustricmp(k
, L
"html-description")) {
389 ret
.description
= uadv(k
);
390 } else if (!ustricmp(k
, L
"html-suppress-address")) {
391 ret
.address_section
= !utob(uadv(k
));
392 } else if (!ustricmp(k
, L
"html-versionid")) {
393 ret
.visible_version_id
= utob(uadv(k
));
394 } else if (!ustricmp(k
, L
"html-quotes")) {
395 if (*uadv(k
) && *uadv(uadv(k
))) {
396 ret
.lquote
= uadv(k
);
397 ret
.rquote
= uadv(ret
.lquote
);
399 } else if (!ustricmp(k
, L
"html-leaf-contains-contents")) {
400 ret
.leaf_contains_contents
= utob(uadv(k
));
401 } else if (!ustricmp(k
, L
"html-leaf-smallest-contents")) {
402 ret
.leaf_smallest_contents
= utoi(uadv(k
));
403 } else if (!ustricmp(k
, L
"html-index-text")) {
404 ret
.index_text
= uadv(k
);
405 } else if (!ustricmp(k
, L
"html-contents-text")) {
406 ret
.contents_text
= uadv(k
);
407 } else if (!ustricmp(k
, L
"html-preamble-text")) {
408 ret
.preamble_text
= uadv(k
);
409 } else if (!ustricmp(k
, L
"html-title-separator")) {
410 ret
.title_separator
= uadv(k
);
411 } else if (!ustricmp(k
, L
"html-nav-prev-text")) {
412 ret
.nav_prev_text
= uadv(k
);
413 } else if (!ustricmp(k
, L
"html-nav-next-text")) {
414 ret
.nav_next_text
= uadv(k
);
415 } else if (!ustricmp(k
, L
"html-nav-separator")) {
416 ret
.nav_separator
= uadv(k
);
417 } else if (!ustricmp(k
, L
"html-index-main-separator")) {
418 ret
.index_main_sep
= uadv(k
);
419 } else if (!ustricmp(k
, L
"html-index-multiple-separator")) {
420 ret
.index_multi_sep
= uadv(k
);
421 } else if (!ustricmp(k
, L
"html-pre-versionid")) {
422 ret
.pre_versionid
= uadv(k
);
423 } else if (!ustricmp(k
, L
"html-post-versionid")) {
424 ret
.post_versionid
= uadv(k
);
430 * Now process fallbacks on quote characters.
432 while (*uadv(ret
.rquote
) && *uadv(uadv(ret
.rquote
)) &&
433 (!cvt_ok(ret
.restrict_charset
, ret
.lquote
) ||
434 !cvt_ok(ret
.restrict_charset
, ret
.rquote
))) {
435 ret
.lquote
= uadv(ret
.rquote
);
436 ret
.rquote
= uadv(ret
.lquote
);
442 paragraph
*html_config_filename(char *filename
)
445 * If the user passes in a single filename as a parameter to
446 * the `--html' command-line option, then we should assume it
447 * to imply _two_ config directives:
448 * \cfg{html-single-filename}{whatever} and
449 * \cfg{html-leaf-level}{0}; the rationale being that the user
450 * wants their output _in that file_.
454 p
= cmdline_cfg_simple("html-single-filename", filename
, NULL
);
455 q
= cmdline_cfg_simple("html-leaf-level", "0", NULL
);
460 void html_backend(paragraph
*sourceform
, keywordlist
*keywords
,
461 indexdata
*idx
, void *unused
)
465 htmlfilelist files
= { NULL
, NULL
, NULL
, NULL
, NULL
};
466 htmlsectlist sects
= { NULL
, NULL
}, nonsects
= { NULL
, NULL
};
470 conf
= html_configure(sourceform
);
473 * We're going to make heavy use of paragraphs' private data
474 * fields in the forthcoming code. Clear them first, so we can
475 * reliably tell whether we have auxiliary data for a
476 * particular paragraph.
478 for (p
= sourceform
; p
; p
= p
->next
)
479 p
->private_data
= NULL
;
481 files
.frags
= newtree234(html_fragment_compare
);
484 * Start by figuring out into which file each piece of the
485 * document should be put. We'll do this by inventing an
486 * `htmlsect' structure and stashing it in the private_data
487 * field of each section paragraph; we also need one additional
488 * htmlsect for the document index, which won't show up in the
489 * source form but needs to be consistently mentioned in
492 * While we're here, we'll also invent the HTML fragment name
496 htmlsect
*topsect
, *sect
;
499 topsect
= html_new_sect(§s
, NULL
);
501 topsect
->title
= NULL
;
502 topsect
->text
= sourceform
;
503 topsect
->contents_depth
= contents_depth(conf
, 0);
504 html_file_section(&conf
, &files
, topsect
, -1);
505 topsect
->fragment
= NULL
;
507 for (p
= sourceform
; p
; p
= p
->next
)
508 if (is_heading_type(p
->type
)) {
509 d
= heading_depth(p
);
511 if (p
->type
== para_Title
) {
516 sect
= html_new_sect(§s
, p
);
517 sect
->text
= p
->next
;
519 sect
->contents_depth
= contents_depth(conf
, d
+1) - (d
+1);
522 sect
->parent
= (htmlsect
*)p
->parent
->private_data
;
523 assert(sect
->parent
!= NULL
);
525 sect
->parent
= topsect
;
526 p
->private_data
= sect
;
528 html_file_section(&conf
, &files
, sect
, d
);
530 sect
->fragment
= html_format(p
, conf
.template_fragment
);
531 sect
->fragment
= html_sanitise_fragment(&files
, sect
->file
,
536 sect
= html_new_sect(§s
, NULL
);
539 sect
->parent
= topsect
;
540 html_file_section(&conf
, &files
, sect
, 0); /* peer of chapters */
541 sect
->fragment
= utoa_dup(conf
.index_text
, CS_ASCII
);
542 sect
->fragment
= html_sanitise_fragment(&files
, sect
->file
,
544 files
.index
= sect
->file
;
548 * Go through the keyword list and sort out fragment IDs for
549 * all the potentially referenced paragraphs which _aren't_
557 for (i
= 0; (kw
= index234(keywords
->keys
, i
)) != NULL
; i
++) {
558 paragraph
*q
, *p
= kw
->para
;
560 if (!is_heading_type(p
->type
)) {
564 * Find the paragraph's parent htmlsect, to
565 * determine which file it will end up in.
570 * Preamble paragraphs have no parent. So if we
571 * have a non-heading with no parent, it must
572 * be preamble, and therefore its parent
573 * htmlsect must be the preamble one.
576 sects
.head
->type
== TOP
);
579 parent
= (htmlsect
*)q
->private_data
;
582 * Now we can construct an htmlsect for this
583 * paragraph itself, taking care to put it in the
584 * list of non-sections rather than the list of
585 * sections (so that traverses of the `sects' list
586 * won't attempt to add it to the contents or
587 * anything weird like that).
589 sect
= html_new_sect(&nonsects
, p
);
590 sect
->file
= parent
->file
;
591 sect
->parent
= parent
;
592 p
->private_data
= sect
;
595 * Fragment IDs for these paragraphs will simply be
596 * `p' followed by an integer.
598 sect
->fragment
= snewn(40, char);
599 sprintf(sect
->fragment
, "p%d",
600 sect
->file
->last_fragment_number
++);
601 sect
->fragment
= html_sanitise_fragment(&files
, sect
->file
,
608 * Reset the fragment numbers in each file. I've just used them
609 * to generate `p' fragment IDs for non-section paragraphs
610 * (numbered list elements, bibliocited), and now I want to use
611 * them for `i' fragment IDs for index entries.
615 for (file
= files
.head
; file
; file
= file
->next
)
616 file
->last_fragment_number
= 0;
620 * Now sort out the index. This involves:
622 * - For each index term, we set up an htmlindex structure to
623 * store all the references to that term.
625 * - Then we make a pass over the actual document, finding
626 * every word_IndexRef; for each one, we actually figure out
627 * the HTML filename/fragment pair we will use to reference
628 * it, store that information in the private data field of
629 * the word_IndexRef itself (so we can recreate it when the
630 * time comes to output our HTML), and add a reference to it
631 * to the index term in question.
640 * Set up the htmlindex structures.
643 for (i
= 0; (entry
= index234(idx
->entries
, i
)) != NULL
; i
++) {
644 htmlindex
*hi
= snew(htmlindex
);
646 hi
->nrefs
= hi
->refsize
= 0;
649 entry
->backend_data
= hi
;
653 * Run over the document inventing fragments. Each fragment
654 * is of the form `i' followed by an integer.
656 lastsect
= sects
.head
; /* this is always the top section */
657 for (p
= sourceform
; p
; p
= p
->next
) {
658 if (is_heading_type(p
->type
) && p
->type
!= para_Title
)
659 lastsect
= (htmlsect
*)p
->private_data
;
661 for (w
= p
->words
; w
; w
= w
->next
)
662 if (w
->type
== word_IndexRef
) {
663 htmlindexref
*hr
= snew(htmlindexref
);
667 hr
->referenced
= hr
->generated
= FALSE
;
668 hr
->section
= lastsect
;
672 lastsect
->file
->last_fragment_number
++);
673 hr
->fragment
= dupstr(buf
);
675 html_sanitise_fragment(&files
, hr
->section
->file
,
678 w
->private_data
= hr
;
680 tag
= index_findtag(idx
, w
->text
);
684 for (i
= 0; i
< tag
->nrefs
; i
++) {
685 indexentry
*entry
= tag
->refs
[i
];
686 htmlindex
*hi
= (htmlindex
*)entry
->backend_data
;
688 if (hi
->nrefs
>= hi
->refsize
) {
690 hi
->refs
= sresize(hi
->refs
, hi
->refsize
, word
*);
693 hi
->refs
[hi
->nrefs
++] = w
;
700 * Now we're ready to write out the actual HTML files.
704 * - we open that file and write its header
705 * - we run down the list of sections
706 * - for each section directly contained within that file, we
707 * output the section text
708 * - for each section which is not in the file but which has a
709 * parent that is, we output a contents entry for the
710 * section if appropriate
711 * - finally, we output the file trailer and close the file.
720 for (f
= files
.head
; f
; f
= f
->next
) {
723 enum LISTTYPE
{ NOLIST
, UL
, OL
, DL
};
724 enum ITEMTYPE
{ NOITEM
, LI
, DT
, DD
};
725 struct stackelement
{
726 struct stackelement
*next
;
727 enum LISTTYPE listtype
;
728 enum ITEMTYPE itemtype
;
731 #define listname(lt) ( (lt)==UL ? "ul" : (lt)==OL ? "ol" : "dl" )
732 #define itemname(lt) ( (lt)==LI ? "li" : (lt)==DT ? "dt" : "dd" )
734 ho
.fp
= fopen(f
->filename
, "w");
735 ho
.charset
= conf
.output_charset
;
736 ho
.restrict_charset
= conf
.restrict_charset
;
737 ho
.cstate
= charset_init_state
;
738 ho
.ver
= conf
.htmlver
;
739 ho
.state
= HO_NEUTRAL
;
740 ho
.contents_level
= 0;
743 switch (conf
.htmlver
) {
745 fprintf(ho
.fp
, "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD "
746 "HTML 3.2 Final//EN\">\n");
749 fprintf(ho
.fp
, "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML"
750 " 4.01//EN\"\n\"http://www.w3.org/TR/html4/"
754 fprintf(ho
.fp
, "<!DOCTYPE HTML PUBLIC \"ISO/IEC "
755 "15445:2000//DTD HTML//EN\">\n");
757 case XHTML_1_0_TRANSITIONAL
:
758 fprintf(ho
.fp
, "<?xml version=\"1.0\" encoding=\"%s\"?>\n",
759 charset_to_mimeenc(conf
.output_charset
));
760 fprintf(ho
.fp
, "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML"
761 " 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/"
762 "xhtml1/DTD/xhtml1-transitional.dtd\">\n");
764 case XHTML_1_0_STRICT
:
765 fprintf(ho
.fp
, "<?xml version=\"1.0\" encoding=\"%s\"?>\n",
766 charset_to_mimeenc(conf
.output_charset
));
767 fprintf(ho
.fp
, "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML"
768 " 1.0 Strict//EN\"\n\"http://www.w3.org/TR/xhtml1/"
769 "DTD/xhtml1-strict.dtd\">\n");
773 element_open(&ho
, "html");
774 if (is_xhtml(conf
.htmlver
)) {
775 element_attr(&ho
, "xmlns", "http://www.w3.org/1999/xhtml");
779 element_open(&ho
, "head");
782 element_empty(&ho
, "meta");
783 element_attr(&ho
, "http-equiv", "content-type");
786 sprintf(buf
, "text/html; charset=%.150s",
787 charset_to_mimeenc(conf
.output_charset
));
788 element_attr(&ho
, "content", buf
);
793 element_empty(&ho
, "meta");
794 element_attr(&ho
, "name", "author");
795 element_attr_w(&ho
, "content", conf
.author
);
799 if (conf
.description
) {
800 element_empty(&ho
, "meta");
801 element_attr(&ho
, "name", "description");
802 element_attr_w(&ho
, "content", conf
.description
);
806 element_open(&ho
, "title");
807 if (f
->first
&& f
->first
->title
) {
808 html_words(&ho
, f
->first
->title
->words
, NOTHING
,
812 if (f
->last
!= f
->first
&& f
->last
->title
) {
813 html_text(&ho
, conf
.title_separator
);
814 html_words(&ho
, f
->last
->title
->words
, NOTHING
,
818 element_close(&ho
, "title");
822 html_raw(&ho
, conf
.head_end
);
824 element_close(&ho
, "head");
828 html_raw(&ho
, conf
.body_tag
);
830 element_open(&ho
, "body");
834 html_raw(&ho
, conf
.body_start
);
837 * Write out a nav bar. Special case: we don't do this
838 * if there is only one file.
840 if (files
.head
!= files
.tail
) {
841 element_open(&ho
, "p");
843 html_raw_as_attr(&ho
, conf
.nav_attr
);
846 element_open(&ho
, "a");
847 element_attr(&ho
, "href", prevf
->filename
);
849 html_text(&ho
, conf
.nav_prev_text
);
851 element_close(&ho
, "a");
853 html_text(&ho
, conf
.nav_separator
);
855 if (f
!= files
.head
) {
856 element_open(&ho
, "a");
857 element_attr(&ho
, "href", files
.head
->filename
);
859 html_text(&ho
, conf
.contents_text
);
861 element_close(&ho
, "a");
863 html_text(&ho
, conf
.nav_separator
);
865 if (f
!= files
.index
) {
866 element_open(&ho
, "a");
867 element_attr(&ho
, "href", files
.index
->filename
);
869 html_text(&ho
, conf
.index_text
);
870 if (f
!= files
.index
)
871 element_close(&ho
, "a");
873 html_text(&ho
, conf
.nav_separator
);
876 element_open(&ho
, "a");
877 element_attr(&ho
, "href", f
->next
->filename
);
879 html_text(&ho
, conf
.nav_next_text
);
881 element_close(&ho
, "a");
883 element_close(&ho
, "p");
889 * Write out a prefix TOC for the file.
891 * We start by going through the section list and
892 * collecting the sections which need to be added to
893 * the contents. On the way, we also test to see if
894 * this file is a leaf file (defined as one which
895 * contains all descendants of any section it
896 * contains), because this will play a part in our
897 * decision on whether or not to _output_ the TOC.
899 * Special case: we absolutely do not do this if we're
900 * in single-file mode.
902 if (files
.head
!= files
.tail
) {
903 int ntoc
= 0, tocsize
= 0;
904 htmlsect
**toc
= NULL
;
907 for (s
= sects
.head
; s
; s
= s
->next
) {
912 * Search up from this section until we find
913 * the highest-level one which belongs in this
918 for (ac
= s
; ac
; ac
= ac
->parent
) {
926 if (s
->file
!= f
&& a
!= NULL
)
930 if (adepth
<= a
->contents_depth
) {
931 if (ntoc
>= tocsize
) {
933 toc
= sresize(toc
, tocsize
, htmlsect
*);
940 if (leaf
&& conf
.leaf_contains_contents
&&
941 ntoc
>= conf
.leaf_smallest_contents
) {
944 for (i
= 0; i
< ntoc
; i
++) {
945 htmlsect
*s
= toc
[i
];
946 int hlevel
= (s
->type
== TOP ?
-1 :
947 s
->type
== INDEX ?
0 :
948 heading_depth(s
->title
))
949 - f
->min_heading_depth
+ 1;
952 html_contents_entry(&ho
, hlevel
, s
,
955 html_contents_entry(&ho
, 0, NULL
, f
, keywords
, &conf
);
960 * Now go through the document and output some real
964 for (s
= sects
.head
; s
; s
= s
->next
) {
967 * This section belongs in this file.
978 * Search up from this section until we find
979 * the highest-level one which belongs in this
984 for (ac
= s
; ac
; ac
= ac
->parent
) {
994 * This section does not belong in this
995 * file, but an ancestor of it does. Write
996 * out a contents table entry, if the depth
997 * doesn't exceed the maximum contents
998 * depth for the ancestor section.
1000 if (adepth
<= a
->contents_depth
) {
1001 html_contents_entry(&ho
, adepth
, s
,
1002 f
, keywords
, &conf
);
1011 html_contents_entry(&ho
, 0, NULL
, f
, keywords
, &conf
);
1014 * Display the section heading.
1017 hlevel
= (s
->type
== TOP ?
-1 :
1018 s
->type
== INDEX ?
0 :
1019 heading_depth(s
->title
))
1020 - f
->min_heading_depth
+ 1;
1021 assert(hlevel
>= 1);
1022 /* HTML headings only go up to <h6> */
1026 htag
[1] = '0' + hlevel
;
1028 element_open(&ho
, htag
);
1031 * Provide anchor for cross-links to target.
1033 * (Also we'll have to do this separately in
1034 * other paragraph types - NumberedList and
1038 html_fragment(&ho
, s
->fragment
);
1040 html_section_title(&ho
, s
, f
, keywords
, &conf
, TRUE
);
1042 element_close(&ho
, htag
);
1045 * Now display the section text.
1048 stackhead
= snew(struct stackelement
);
1049 stackhead
->next
= NULL
;
1050 stackhead
->listtype
= NOLIST
;
1051 stackhead
->itemtype
= NOITEM
;
1053 for (p
= s
->text
;; p
= p
->next
) {
1054 enum LISTTYPE listtype
;
1055 struct stackelement
*se
;
1058 * Preliminary switch to figure out what
1059 * sort of list we expect to be inside at
1062 * Since p may still be NULL at this point,
1063 * I invent a harmless paragraph type for
1066 switch (p ? p
->type
: para_Normal
) {
1069 case para_Copyright
:
1070 case para_BiblioCited
:
1072 case para_QuotePush
:
1076 case para_UnnumberedChapter
:
1087 case para_NumberedList
:
1091 case para_DescribedThing
:
1092 case para_Description
:
1096 case para_LcontPush
:
1097 se
= snew(struct stackelement
);
1098 se
->next
= stackhead
;
1099 se
->listtype
= NOLIST
;
1100 se
->itemtype
= NOITEM
;
1104 default: /* some totally non-printing para */
1111 * Terminate the most recent list item, if
1112 * any. (We left this until after
1113 * processing LcontPush, since in that case
1114 * the list item won't want to be
1115 * terminated until after the corresponding
1118 if (stackhead
->itemtype
!= NOITEM
) {
1119 element_close(&ho
, itemname(stackhead
->itemtype
));
1122 stackhead
->itemtype
= NOITEM
;
1125 * Terminate the current list, if it's not
1126 * the one we want to be in.
1128 if (listtype
!= stackhead
->listtype
&&
1129 stackhead
->listtype
!= NOLIST
) {
1130 element_close(&ho
, listname(stackhead
->listtype
));
1135 * Leave the loop if our time has come.
1137 if (!p
|| (is_heading_type(p
->type
) &&
1138 p
->type
!= para_Title
))
1139 break; /* end of section text */
1142 * Start a fresh list if necessary.
1144 if (listtype
!= stackhead
->listtype
&&
1146 element_open(&ho
, listname(listtype
));
1148 stackhead
->listtype
= listtype
;
1152 element_empty(&ho
, "hr");
1155 html_codepara(&ho
, p
->words
);
1158 case para_Copyright
:
1159 element_open(&ho
, "p");
1161 html_words(&ho
, p
->words
, ALL
,
1162 f
, keywords
, &conf
);
1164 element_close(&ho
, "p");
1166 case para_BiblioCited
:
1167 element_open(&ho
, "p");
1168 if (p
->private_data
) {
1169 htmlsect
*s
= (htmlsect
*)p
->private_data
;
1170 html_fragment(&ho
, s
->fragment
);
1173 html_words(&ho
, p
->kwtext
, ALL
,
1174 f
, keywords
, &conf
);
1175 html_text(&ho
, L
" ");
1176 html_words(&ho
, p
->words
, ALL
,
1177 f
, keywords
, &conf
);
1179 element_close(&ho
, "p");
1182 case para_NumberedList
:
1183 element_open(&ho
, "li");
1184 if (p
->private_data
) {
1185 htmlsect
*s
= (htmlsect
*)p
->private_data
;
1186 html_fragment(&ho
, s
->fragment
);
1189 stackhead
->itemtype
= LI
;
1190 html_words(&ho
, p
->words
, ALL
,
1191 f
, keywords
, &conf
);
1193 case para_DescribedThing
:
1194 element_open(&ho
, "dt");
1196 stackhead
->itemtype
= DT
;
1197 html_words(&ho
, p
->words
, ALL
,
1198 f
, keywords
, &conf
);
1200 case para_Description
:
1201 element_open(&ho
, "dd");
1203 stackhead
->itemtype
= DD
;
1204 html_words(&ho
, p
->words
, ALL
,
1205 f
, keywords
, &conf
);
1208 case para_QuotePush
:
1209 element_open(&ho
, "blockquote");
1212 element_close(&ho
, "blockquote");
1217 stackhead
= stackhead
->next
;
1224 assert(stackhead
&& !stackhead
->next
);
1228 if (s
->type
== INDEX
) {
1233 * This section is the index. I'll just
1234 * render it as a single paragraph, with a
1235 * colon between the index term and the
1236 * references, and <br> in between each
1239 element_open(&ho
, "p");
1241 for (i
= 0; (entry
=
1242 index234(idx
->entries
, i
)) != NULL
; i
++) {
1243 htmlindex
*hi
= (htmlindex
*)entry
->backend_data
;
1247 element_empty(&ho
, "br");
1250 html_words(&ho
, entry
->text
, MARKUP
|LINKS
,
1251 f
, keywords
, &conf
);
1253 html_text(&ho
, conf
.index_main_sep
);
1255 for (j
= 0; j
< hi
->nrefs
; j
++) {
1257 (htmlindexref
*)hi
->refs
[j
]->private_data
;
1258 paragraph
*p
= hr
->section
->title
;
1261 html_text(&ho
, conf
.index_multi_sep
);
1263 html_href(&ho
, f
, hr
->section
->file
,
1265 hr
->referenced
= TRUE
;
1267 html_words(&ho
, p
->kwtext
, MARKUP
|LINKS
,
1268 f
, keywords
, &conf
);
1269 else if (p
&& p
->words
)
1270 html_words(&ho
, p
->words
, MARKUP
|LINKS
,
1271 f
, keywords
, &conf
);
1274 * If there is no title at all,
1275 * this must be because our
1276 * target section is the
1277 * preamble section and there
1278 * is no title. So we use the
1281 html_text(&ho
, conf
.preamble_text
);
1283 element_close(&ho
, "a");
1286 element_close(&ho
, "p");
1291 html_contents_entry(&ho
, 0, NULL
, f
, keywords
, &conf
);
1298 int done_version_ids
= FALSE
;
1300 element_empty(&ho
, "hr");
1303 html_raw(&ho
, conf
.body_end
);
1305 if (conf
.address_section
) {
1306 int started
= FALSE
;
1307 if (conf
.htmlver
== ISO_HTML
) {
1309 * The ISO-HTML validator complains if
1310 * there isn't a <div> tag surrounding the
1311 * <address> tag. I'm uncertain of why this
1312 * should be - there appears to be no
1313 * mention of this in the ISO-HTML spec,
1314 * suggesting that it doesn't represent a
1315 * change from HTML 4, but nonetheless the
1316 * HTML 4 validator doesn't seem to mind.
1318 element_open(&ho
, "div");
1320 element_open(&ho
, "address");
1321 if (conf
.addr_start
) {
1322 html_raw(&ho
, conf
.addr_start
);
1326 if (conf
.visible_version_id
) {
1327 for (p
= sourceform
; p
; p
= p
->next
)
1328 if (p
->type
== para_VersionID
) {
1330 element_empty(&ho
, "br");
1332 html_text(&ho
, conf
.pre_versionid
);
1333 html_words(&ho
, p
->words
, NOTHING
,
1334 f
, keywords
, &conf
);
1335 html_text(&ho
, conf
.post_versionid
);
1338 done_version_ids
= TRUE
;
1340 if (conf
.addr_end
) {
1342 element_empty(&ho
, "br");
1343 html_raw(&ho
, conf
.addr_end
);
1345 element_close(&ho
, "address");
1346 if (conf
.htmlver
== ISO_HTML
)
1347 element_close(&ho
, "div");
1350 if (!done_version_ids
) {
1352 * If the user didn't want the version IDs
1353 * visible, I think we still have a duty to put
1354 * them in an HTML comment.
1356 int started
= FALSE
;
1357 for (p
= sourceform
; p
; p
= p
->next
)
1358 if (p
->type
== para_VersionID
) {
1360 html_raw(&ho
, "<!-- version IDs:\n");
1363 html_words(&ho
, p
->words
, NOTHING
,
1364 f
, keywords
, &conf
);
1368 html_raw(&ho
, "-->\n");
1372 element_close(&ho
, "body");
1374 element_close(&ho
, "html");
1381 * Go through and check that no index fragments were referenced
1382 * without being generated, or indeed vice versa.
1384 * (When I actually get round to freeing everything, this can
1385 * probably be the freeing loop as well.)
1387 for (p
= sourceform
; p
; p
= p
->next
) {
1389 for (w
= p
->words
; w
; w
= w
->next
)
1390 if (w
->type
== word_IndexRef
) {
1391 htmlindexref
*hr
= (htmlindexref
*)w
->private_data
;
1393 assert(!hr
->referenced
== !hr
->generated
);
1398 * Free all the working data.
1401 sfree(conf
.single_filename
);
1402 sfree(conf
.contents_filename
);
1403 sfree(conf
.index_filename
);
1404 sfree(conf
.template_filename
);
1405 sfree(conf
.template_fragment
);
1408 while ( (frag
= (htmlfragment
*)delpos234(files
.frags
, 0)) != NULL
) {
1410 * frag->fragment is dynamically allocated, but will be
1411 * freed when we process the htmlsect structure which
1412 * it is attached to.
1416 freetree234(files
.frags
);
1419 htmlsect
*sect
, *tmp
;
1423 sfree(sect
->fragment
);
1427 sect
= nonsects
.head
;
1430 sfree(sect
->fragment
);
1436 htmlfile
*file
, *tmp
;
1440 sfree(file
->filename
);
1448 for (i
= 0; (entry
= index234(idx
->entries
, i
)) != NULL
; i
++) {
1449 htmlindex
*hi
= (htmlindex
*)entry
->backend_data
;
1456 for (p
= sourceform
; p
; p
= p
->next
)
1457 for (w
= p
->words
; w
; w
= w
->next
)
1458 if (w
->type
== word_IndexRef
) {
1459 htmlindexref
*hr
= (htmlindexref
*)w
->private_data
;
1461 sfree(hr
->fragment
);
1467 static void html_file_section(htmlconfig
*cfg
, htmlfilelist
*files
,
1468 htmlsect
*sect
, int depth
)
1474 * `depth' is derived from the heading_depth() macro at the top
1475 * of this file, which counts title as -1, chapter as 0,
1476 * heading as 1 and subsection as 2. However, the semantics of
1477 * cfg->leaf_level are defined to count chapter as 1, heading
1478 * as 2 etc. So first I increment depth :-(
1482 if (cfg
->leaf_level
== 0) {
1484 * leaf_level==0 is a special case, in which everything is
1485 * put into a single file.
1488 files
->single
= html_new_file(files
, cfg
->single_filename
);
1490 file
= files
->single
;
1493 * If the depth of this section is at or above leaf_level,
1494 * we invent a fresh file and put this section at its head.
1495 * Otherwise, we put it in the same file as its parent
1498 if (ldepth
> cfg
->leaf_level
) {
1500 * We know that sect->parent cannot be NULL. The only
1501 * circumstance in which it can be is if sect is at
1502 * chapter or appendix level, i.e. ldepth==1; and if
1503 * that's the case, then we cannot have entered this
1504 * branch unless cfg->leaf_level==0, in which case we
1505 * would be in the single-file case above and not here
1508 assert(sect
->parent
);
1510 file
= sect
->parent
->file
;
1512 if (sect
->type
== TOP
) {
1513 file
= html_new_file(files
, cfg
->contents_filename
);
1514 } else if (sect
->type
== INDEX
) {
1515 file
= html_new_file(files
, cfg
->index_filename
);
1519 assert(ldepth
> 0 && sect
->title
);
1520 title
= html_format(sect
->title
, cfg
->template_filename
);
1521 file
= html_new_file(files
, title
);
1529 if (file
->min_heading_depth
> depth
) {
1531 * This heading is at a higher level than any heading we
1532 * have so far placed in this file; so we set the `first'
1535 file
->min_heading_depth
= depth
;
1539 if (file
->min_heading_depth
== depth
)
1543 static htmlfile
*html_new_file(htmlfilelist
*list
, char *filename
)
1545 htmlfile
*ret
= snew(htmlfile
);
1549 list
->tail
->next
= ret
;
1554 ret
->filename
= dupstr(filename
);
1555 ret
->last_fragment_number
= 0;
1556 ret
->min_heading_depth
= INT_MAX
;
1557 ret
->first
= ret
->last
= NULL
;
1562 static htmlsect
*html_new_sect(htmlsectlist
*list
, paragraph
*title
)
1564 htmlsect
*ret
= snew(htmlsect
);
1568 list
->tail
->next
= ret
;
1581 static void html_words(htmloutput
*ho
, word
*words
, int flags
,
1582 htmlfile
*file
, keywordlist
*keywords
, htmlconfig
*cfg
)
1588 for (w
= words
; w
; w
= w
->next
) switch (w
->type
) {
1589 case word_HyperLink
:
1590 if (flags
& LINKS
) {
1591 element_open(ho
, "a");
1592 c
= utoa_dup(w
->text
, CS_ASCII
);
1593 element_attr(ho
, "href", c
);
1597 case word_UpperXref
:
1598 case word_LowerXref
:
1599 if (flags
& LINKS
) {
1600 keyword
*kwl
= kw_lookup(keywords
, w
->text
);
1601 paragraph
*p
= kwl
->para
;
1602 htmlsect
*s
= (htmlsect
*)p
->private_data
;
1606 html_href(ho
, file
, s
->file
, s
->fragment
);
1612 element_close(ho
, "a");
1615 if (flags
& INDEXENTS
) {
1616 htmlindexref
*hr
= (htmlindexref
*)w
->private_data
;
1617 html_fragment(ho
, hr
->fragment
);
1618 hr
->generated
= TRUE
;
1625 case word_WhiteSpace
:
1626 case word_EmphSpace
:
1627 case word_CodeSpace
:
1628 case word_WkCodeSpace
:
1630 case word_EmphQuote
:
1631 case word_CodeQuote
:
1632 case word_WkCodeQuote
:
1633 style
= towordstyle(w
->type
);
1634 type
= removeattr(w
->type
);
1635 if (style
== word_Emph
&&
1636 (attraux(w
->aux
) == attr_First
||
1637 attraux(w
->aux
) == attr_Only
) &&
1639 element_open(ho
, "em");
1640 else if ((style
== word_Code
|| style
== word_WeakCode
) &&
1641 (attraux(w
->aux
) == attr_First
||
1642 attraux(w
->aux
) == attr_Only
) &&
1644 element_open(ho
, "code");
1646 if (type
== word_WhiteSpace
)
1647 html_text(ho
, L
" ");
1648 else if (type
== word_Quote
) {
1649 if (quoteaux(w
->aux
) == quote_Open
)
1650 html_text(ho
, cfg
->lquote
);
1652 html_text(ho
, cfg
->rquote
);
1654 if (!w
->alt
|| cvt_ok(ho
->restrict_charset
, w
->text
))
1655 html_text_nbsp(ho
, w
->text
);
1657 html_words(ho
, w
->alt
, flags
, file
, keywords
, cfg
);
1660 if (style
== word_Emph
&&
1661 (attraux(w
->aux
) == attr_Last
||
1662 attraux(w
->aux
) == attr_Only
) &&
1664 element_close(ho
, "em");
1665 else if ((style
== word_Code
|| style
== word_WeakCode
) &&
1666 (attraux(w
->aux
) == attr_Last
||
1667 attraux(w
->aux
) == attr_Only
) &&
1669 element_close(ho
, "code");
1675 static void html_codepara(htmloutput
*ho
, word
*words
)
1677 element_open(ho
, "pre");
1678 element_open(ho
, "code");
1679 for (; words
; words
= words
->next
) if (words
->type
== word_WeakCode
) {
1684 if (words
->next
&& words
->next
->type
== word_Emph
) {
1685 e
= words
->next
->text
;
1686 words
= words
->next
;
1690 while (e
&& *e
&& *t
) {
1694 for (n
= 0; t
[n
] && e
[n
] && e
[n
] == ec
; n
++);
1702 element_open(ho
, open_tag
);
1704 html_text_limit(ho
, t
, n
);
1707 element_close(ho
, open_tag
);
1715 element_close(ho
, "code");
1716 element_close(ho
, "pre");
1719 static void html_charset_cleanup(htmloutput
*ho
)
1724 bytes
= charset_from_unicode(NULL
, NULL
, outbuf
, lenof(outbuf
),
1725 ho
->charset
, &ho
->cstate
, NULL
);
1727 fwrite(outbuf
, 1, bytes
, ho
->fp
);
1730 static void return_mostly_to_neutral(htmloutput
*ho
)
1732 if (ho
->state
== HO_IN_EMPTY_TAG
&& is_xhtml(ho
->ver
)) {
1733 fprintf(ho
->fp
, " />");
1734 } else if (ho
->state
== HO_IN_EMPTY_TAG
|| ho
->state
== HO_IN_TAG
) {
1735 fprintf(ho
->fp
, ">");
1738 ho
->state
= HO_NEUTRAL
;
1741 static void return_to_neutral(htmloutput
*ho
)
1743 if (ho
->state
== HO_IN_TEXT
) {
1744 html_charset_cleanup(ho
);
1747 return_mostly_to_neutral(ho
);
1750 static void element_open(htmloutput
*ho
, char const *name
)
1752 return_to_neutral(ho
);
1753 fprintf(ho
->fp
, "<%s", name
);
1754 ho
->state
= HO_IN_TAG
;
1757 static void element_close(htmloutput
*ho
, char const *name
)
1759 return_to_neutral(ho
);
1760 fprintf(ho
->fp
, "</%s>", name
);
1761 ho
->state
= HO_NEUTRAL
;
1764 static void element_empty(htmloutput
*ho
, char const *name
)
1766 return_to_neutral(ho
);
1767 fprintf(ho
->fp
, "<%s", name
);
1768 ho
->state
= HO_IN_EMPTY_TAG
;
1771 static void html_nl(htmloutput
*ho
)
1773 return_to_neutral(ho
);
1774 fputc('\n', ho
->fp
);
1777 static void html_raw(htmloutput
*ho
, char *text
)
1779 return_to_neutral(ho
);
1780 fputs(text
, ho
->fp
);
1783 static void html_raw_as_attr(htmloutput
*ho
, char *text
)
1785 assert(ho
->state
== HO_IN_TAG
|| ho
->state
== HO_IN_EMPTY_TAG
);
1787 fputs(text
, ho
->fp
);
1790 static void element_attr(htmloutput
*ho
, char const *name
, char const *value
)
1792 html_charset_cleanup(ho
);
1793 assert(ho
->state
== HO_IN_TAG
|| ho
->state
== HO_IN_EMPTY_TAG
);
1794 fprintf(ho
->fp
, " %s=\"%s\"", name
, value
);
1797 static void element_attr_w(htmloutput
*ho
, char const *name
,
1798 wchar_t const *value
)
1800 html_charset_cleanup(ho
);
1801 fprintf(ho
->fp
, " %s=\"", name
);
1802 html_text_limit_internal(ho
, value
, 0, TRUE
, FALSE
);
1803 html_charset_cleanup(ho
);
1807 static void html_text(htmloutput
*ho
, wchar_t const *text
)
1809 return_mostly_to_neutral(ho
);
1810 html_text_limit_internal(ho
, text
, 0, FALSE
, FALSE
);
1813 static void html_text_nbsp(htmloutput
*ho
, wchar_t const *text
)
1815 return_mostly_to_neutral(ho
);
1816 html_text_limit_internal(ho
, text
, 0, FALSE
, TRUE
);
1819 static void html_text_limit(htmloutput
*ho
, wchar_t const *text
, int maxlen
)
1821 return_mostly_to_neutral(ho
);
1822 html_text_limit_internal(ho
, text
, maxlen
, FALSE
, FALSE
);
1825 static void html_text_limit_internal(htmloutput
*ho
, wchar_t const *text
,
1826 int maxlen
, int quote_quotes
, int nbsp
)
1828 int textlen
= ustrlen(text
);
1832 if (maxlen
> 0 && textlen
> maxlen
)
1835 while (textlen
> 0) {
1836 /* Scan ahead for characters we really can't display in HTML. */
1837 int lenbefore
, lenafter
;
1838 for (lenbefore
= 0; lenbefore
< textlen
; lenbefore
++)
1839 if (text
[lenbefore
] == L
'<' ||
1840 text
[lenbefore
] == L
'>' ||
1841 text
[lenbefore
] == L
'&' ||
1842 (text
[lenbefore
] == L
'"' && quote_quotes
) ||
1843 (text
[lenbefore
] == L
' ' && nbsp
))
1845 lenafter
= lenbefore
;
1846 bytes
= charset_from_unicode(&text
, &lenafter
, outbuf
, lenof(outbuf
),
1847 ho
->charset
, &ho
->cstate
, &err
);
1848 textlen
-= (lenbefore
- lenafter
);
1850 fwrite(outbuf
, 1, bytes
, ho
->fp
);
1853 * We have encountered a character that cannot be
1854 * displayed in the selected output charset. Therefore,
1855 * we use an HTML numeric entity reference.
1857 assert(textlen
> 0);
1858 fprintf(ho
->fp
, "&#%ld;", (long int)*text
);
1860 } else if (lenafter
== 0 && textlen
> 0) {
1862 * We have encountered a character which is special to
1866 fprintf(ho
->fp
, "<");
1867 else if (*text
== L
'>')
1868 fprintf(ho
->fp
, ">");
1869 else if (*text
== L
'&')
1870 fprintf(ho
->fp
, "&");
1871 else if (*text
== L
'"')
1872 fprintf(ho
->fp
, """);
1873 else if (*text
== L
' ') {
1875 fprintf(ho
->fp
, " ");
1877 assert(!"Can't happen");
1883 static void cleanup(htmloutput
*ho
)
1885 return_to_neutral(ho
);
1889 static void html_href(htmloutput
*ho
, htmlfile
*thisfile
,
1890 htmlfile
*targetfile
, char *targetfrag
)
1892 rdstringc rs
= { 0, 0, NULL
};
1895 if (targetfile
!= thisfile
)
1896 rdaddsc(&rs
, targetfile
->filename
);
1899 rdaddsc(&rs
, targetfrag
);
1903 element_open(ho
, "a");
1904 element_attr(ho
, "href", url
);
1908 static void html_fragment(htmloutput
*ho
, char const *fragment
)
1910 element_open(ho
, "a");
1911 element_attr(ho
, "name", fragment
);
1912 if (is_xhtml(ho
->ver
))
1913 element_attr(ho
, "id", fragment
);
1914 element_close(ho
, "a");
1917 static char *html_format(paragraph
*p
, char *template_string
)
1921 wchar_t *ws
, wsbuf
[2];
1922 rdstringc rs
= { 0, 0, NULL
};
1924 t
= template_string
;
1926 if (*t
== '%' && t
[1]) {
1940 if (p
->kwtext
&& fmt
== 'n')
1942 else if (p
->kwtext2
&& fmt
== 'b') {
1944 * HTML fragment names must start with a letter, so
1945 * simply `1.2.3' is not adequate. In this case I'm
1946 * going to cheat slightly by prepending the first
1947 * character of the first word of kwtext, so that
1948 * we get `C1' for chapter 1, `S2.3' for section
1951 if (p
->kwtext
&& p
->kwtext
->text
[0]) {
1954 wsbuf
[0] = p
->kwtext
->text
[0];
1957 } else if (p
->keyword
&& *p
->keyword
&& fmt
== 'k')
1963 c
= utoa_dup(ws
, CS_ASCII
);
1969 if (removeattr(w
->type
) == word_Normal
) {
1970 c
= utoa_dup(w
->text
, CS_ASCII
);
1981 return rdtrimc(&rs
);
1984 static char *html_sanitise_fragment(htmlfilelist
*files
, htmlfile
*file
,
1988 * The HTML 4 spec's strictest definition of fragment names (<a
1989 * name> and "id" attributes) says that they `must begin with a
1990 * letter and may be followed by any number of letters, digits,
1991 * hyphens, underscores, colons, and periods'.
1993 * So here we unceremoniously rip out any characters not
1994 * conforming to this limitation.
1996 char *p
= text
, *q
= text
;
1998 while (*p
&& !((*p
>='A' && *p
<='Z') || (*p
>='a' && *p
<='z')))
2000 if ((*q
++ = *p
++) != '\0') {
2002 if ((*p
>='A' && *p
<='Z') ||
2003 (*p
>='a' && *p
<='z') ||
2004 (*p
>='0' && *p
<='9') ||
2005 *p
=='-' || *p
=='_' || *p
==':' || *p
=='.')
2014 * Now we check for clashes with other fragment names, and
2015 * adjust this one if necessary by appending a hyphen followed
2019 htmlfragment
*frag
= snew(htmlfragment
);
2020 int len
= 0; /* >0 indicates we have resized */
2024 frag
->fragment
= text
;
2026 while (add234(files
->frags
, frag
) != frag
) {
2029 frag
->fragment
= text
= sresize(text
, len
+20, char);
2032 sprintf(text
+ len
, "-%d", ++suffix
);
2039 static void html_contents_entry(htmloutput
*ho
, int depth
, htmlsect
*s
,
2040 htmlfile
*thisfile
, keywordlist
*keywords
,
2043 while (ho
->contents_level
> depth
) {
2044 element_close(ho
, "ul");
2045 ho
->contents_level
--;
2048 while (ho
->contents_level
< depth
) {
2049 element_open(ho
, "ul");
2050 ho
->contents_level
++;
2056 element_open(ho
, "li");
2057 html_href(ho
, thisfile
, s
->file
, s
->fragment
);
2058 html_section_title(ho
, s
, thisfile
, keywords
, cfg
, FALSE
);
2059 element_close(ho
, "a");
2060 element_close(ho
, "li");
2063 static void html_section_title(htmloutput
*ho
, htmlsect
*s
, htmlfile
*thisfile
,
2064 keywordlist
*keywords
, htmlconfig
*cfg
,
2070 int depth
= heading_depth(s
->title
);
2074 else if (depth
== 0)
2075 sl
= &cfg
->achapter
;
2076 else if (depth
<= cfg
->nasect
)
2077 sl
= &cfg
->asect
[depth
-1];
2079 sl
= &cfg
->asect
[cfg
->nasect
-1];
2083 else if (sl
->just_numbers
)
2084 number
= s
->title
->kwtext2
;
2086 number
= s
->title
->kwtext
;
2089 html_words(ho
, number
, MARKUP
,
2090 thisfile
, keywords
, cfg
);
2091 html_text(ho
, sl
->number_suffix
);
2094 html_words(ho
, s
->title
->words
, real ? ALL
: MARKUP
,
2095 thisfile
, keywords
, cfg
);
2097 assert(s
->type
!= NORMAL
);
2099 * If we're printing the full document title for _real_ and
2100 * there isn't one, we don't want to print `Preamble' at
2101 * the top of what ought to just be some text. If we need
2102 * it in any other context such as TOCs, we need to print
2105 if (s
->type
== TOP
&& !real
)
2106 html_text(ho
, cfg
->preamble_text
);
2107 else if (s
->type
== INDEX
)
2108 html_text(ho
, cfg
->index_text
);