2 * xhtml backend for Halibut
3 * (initial implementation by James Aylett)
7 * +++ doesn't handle non-breaking hyphens. Not sure how to yet.
8 * +++ entity names (from a file -- ideally supply normal SGML files)
9 * +++ configuration directive to file split where the current layout
10 * code wouldn't. Needs changes to _ponder_layout() and _do_paras(),
15 * +++ biblio/index references target the nearest section marker, rather
16 * than having a dedicated target themselves. In large bibliographies
17 * this will cause problems. (The solution is to fake up a response
18 * from xhtml_find_section(), probably linking it into the sections
19 * chain just in case we need it again, and to make freeing it up
20 * easier.) docsrc.pl used to work as we do, however, and SGT agrees that
21 * this is acceptable for now.
22 * +++ can't cope with leaf-level == 0. It's all to do with the
23 * top-level file not being normal, probably not even having a valid
24 * section level, and stuff like that. I question whether this is an
25 * issue, frankly; small manuals that fit on one page should probably
26 * not be written in halibut at all.
36 * FILENAME_TEMPLATE (overridable in config of course) allows you
37 * to choose the general form for your HTML file names. It is
38 * slightly printf-styled (% followed by a single character is a
39 * formatting directive, %% is a literal %). Formatting directives
42 * - %n is the section type-plus-number, minus whitespace (`Chapter1.2').
43 * - %b is the section number on its own (`1.2').
44 * - %k is the section's _internal_ keyword.
45 * - %N is the section's visible title in the output, again minus
48 * %n, %b and %k will all default to %N if the section is
49 * unnumbered (`Bibliography' is often a good example).
51 * FRAGMENT_TEMPLATE is the same, but defines the <a name="foo">
52 * markers used to cross-reference to particular subsections of a
56 #define FILENAME_SINGLE "Manual.html"
57 #define FILENAME_CONTENTS "Contents.html"
58 #define FILENAME_INDEX "IndexPage.html"
59 #define FILENAME_TEMPLATE "%n.html"
60 #define FRAGMENT_TEMPLATE "%b"
62 struct xhtmlsection_Struct
{
63 struct xhtmlsection_Struct
*next
; /* next sibling (NULL if split across files) */
64 struct xhtmlsection_Struct
*child
; /* NULL if split across files */
65 struct xhtmlsection_Struct
*parent
; /* NULL if split across files */
66 struct xhtmlsection_Struct
*chain
; /* single structure independent of weird trees */
68 struct xhtmlfile_Struct
*file
; /* which file is this a part of? */
69 char *fragment
; /* fragment id within the file */
73 struct xhtmlfile_Struct
{
74 struct xhtmlfile_Struct
*next
;
75 struct xhtmlfile_Struct
*child
;
76 struct xhtmlfile_Struct
*parent
;
78 struct xhtmlsection_Struct
*sections
; /* sections within this file (only one for non-leaf) */
79 int is_leaf
; /* is this file a leaf file, ie does it not have any children? */
82 typedef struct xhtmlsection_Struct xhtmlsection
;
83 typedef struct xhtmlfile_Struct xhtmlfile
;
84 typedef struct xhtmlindex_Struct xhtmlindex
;
86 struct xhtmlindex_Struct
{
89 xhtmlsection
**sections
;
94 wchar_t *number_suffix
;
98 int contents_depth
[6];
99 int leaf_contains_contents
;
101 int leaf_smallest_contents
;
102 int include_version_id
;
103 wchar_t *author
, *description
;
104 wchar_t *head_end
, *body
, *body_start
, *body_end
, *address_start
, *address_end
, *nav_attrs
;
105 int suppress_address
;
106 xhtmlheadfmt fchapter
, *fsect
;
108 char *contents_filename
, *index_filename
;
109 char *single_filename
, *template_filename
, *template_fragment
;
112 /*static void xhtml_level(paragraph *, int);
113 static void xhtml_level_0(paragraph *);
114 static void xhtml_docontents(FILE *, paragraph *, int);
115 static void xhtml_dosections(FILE *, paragraph *, int);
116 static void xhtml_dobody(FILE *, paragraph *, int);*/
118 static void xhtml_doheader(FILE *, word
*);
119 static void xhtml_dofooter(FILE *);
120 static void xhtml_versionid(FILE *, word
*, int);
122 static void xhtml_utostr(wchar_t *, char **);
123 static int xhtml_para_level(paragraph
*);
124 static int xhtml_reservedchar(int);
126 static int xhtml_convert(wchar_t *, int, char **, int);
127 static void xhtml_rdaddwc(rdstringc
*, word
*, word
*, int);
128 static void xhtml_para(FILE *, word
*, int);
129 static void xhtml_codepara(FILE *, word
*);
130 static void xhtml_heading(FILE *, paragraph
*, int);
132 /* File-global variables are much easier than passing these things
133 * all over the place. Evil, but easier. We can replace this with a single
134 * structure at some point.
136 static xhtmlconfig conf
;
137 static keywordlist
*keywords
;
138 static indexdata
*idx
;
139 static xhtmlfile
*topfile
;
140 static xhtmlsection
*topsection
;
141 static paragraph
*sourceparas
;
142 static xhtmlfile
*lastfile
;
143 static xhtmlfile
*xhtml_last_file
= NULL
;
144 static int last_level
=-1, start_level
;
145 static xhtmlsection
*currentsection
;
147 static xhtmlconfig
xhtml_configure(paragraph
*source
)
154 ret
.contents_depth
[0] = 2;
155 ret
.contents_depth
[1] = 3;
156 ret
.contents_depth
[2] = 4;
157 ret
.contents_depth
[3] = 5;
158 ret
.contents_depth
[4] = 6;
159 ret
.contents_depth
[5] = 7;
161 ret
.leaf_smallest_contents
= 4;
162 ret
.leaf_contains_contents
= FALSE
;
163 ret
.include_version_id
= TRUE
;
165 ret
.description
= NULL
;
168 ret
.body_start
= NULL
;
170 ret
.address_start
= NULL
;
171 ret
.address_end
= NULL
;
172 ret
.nav_attrs
= NULL
;
173 ret
.suppress_address
= FALSE
;
175 ret
.fchapter
.just_numbers
= FALSE
;
176 ret
.fchapter
.number_suffix
= L
": ";
178 ret
.fsect
= mknewa(xhtmlheadfmt
, ret
.nfsect
);
179 ret
.fsect
[0].just_numbers
= FALSE
;
180 ret
.fsect
[0].number_suffix
= L
": ";
181 ret
.fsect
[1].just_numbers
= TRUE
;
182 ret
.fsect
[1].number_suffix
= L
" ";
183 ret
.contents_filename
= strdup(FILENAME_CONTENTS
);
184 ret
.single_filename
= strdup(FILENAME_SINGLE
);
185 ret
.index_filename
= strdup(FILENAME_INDEX
);
186 ret
.template_filename
= strdup(FILENAME_TEMPLATE
);
187 ret
.template_fragment
= strdup(FRAGMENT_TEMPLATE
);
189 for (; source
; source
= source
->next
)
191 if (source
->type
== para_Config
)
193 if (!ustricmp(source
->keyword
, L
"xhtml-contents-filename")) {
194 sfree(ret
.contents_filename
);
195 ret
.contents_filename
= dupstr(adv(source
->origkeyword
));
196 } else if (!ustricmp(source
->keyword
, L
"xhtml-single-filename")) {
197 sfree(ret
.single_filename
);
198 ret
.single_filename
= dupstr(adv(source
->origkeyword
));
199 } else if (!ustricmp(source
->keyword
, L
"xhtml-index-filename")) {
200 sfree(ret
.index_filename
);
201 ret
.index_filename
= dupstr(adv(source
->origkeyword
));
202 } else if (!ustricmp(source
->keyword
, L
"xhtml-template-filename")) {
203 sfree(ret
.template_filename
);
204 ret
.template_filename
= dupstr(adv(source
->origkeyword
));
205 } else if (!ustricmp(source
->keyword
, L
"xhtml-template-fragment")) {
206 sfree(ret
.template_fragment
);
207 ret
.template_fragment
= utoa_dup(uadv(source
->keyword
), CS_ASCII
);
208 } else if (!ustricmp(source
->keyword
, L
"xhtml-contents-depth-0")) {
209 ret
.contents_depth
[0] = utoi(uadv(source
->keyword
));
210 } else if (!ustricmp(source
->keyword
, L
"xhtml-contents-depth-1")) {
211 ret
.contents_depth
[1] = utoi(uadv(source
->keyword
));
212 } else if (!ustricmp(source
->keyword
, L
"xhtml-contents-depth-2")) {
213 ret
.contents_depth
[2] = utoi(uadv(source
->keyword
));
214 } else if (!ustricmp(source
->keyword
, L
"xhtml-contents-depth-3")) {
215 ret
.contents_depth
[3] = utoi(uadv(source
->keyword
));
216 } else if (!ustricmp(source
->keyword
, L
"xhtml-contents-depth-4")) {
217 ret
.contents_depth
[4] = utoi(uadv(source
->keyword
));
218 } else if (!ustricmp(source
->keyword
, L
"xhtml-contents-depth-5")) {
219 ret
.contents_depth
[5] = utoi(uadv(source
->keyword
));
220 } else if (!ustricmp(source
->keyword
, L
"xhtml-leaf-level")) {
221 ret
.leaf_level
= utoi(uadv(source
->keyword
));
222 } else if (!ustricmp(source
->keyword
, L
"xhtml-leaf-smallest-contents")) {
223 ret
.leaf_smallest_contents
= utoi(uadv(source
->keyword
));
224 } else if (!ustricmp(source
->keyword
, L
"xhtml-versionid")) {
225 ret
.include_version_id
= utob(uadv(source
->keyword
));
226 } else if (!ustricmp(source
->keyword
, L
"xhtml-leaf-contains-contents")) {
227 ret
.leaf_contains_contents
= utob(uadv(source
->keyword
));
228 } else if (!ustricmp(source
->keyword
, L
"xhtml-suppress-address")) {
229 ret
.suppress_address
= utob(uadv(source
->keyword
));
230 } else if (!ustricmp(source
->keyword
, L
"xhtml-author")) {
231 ret
.author
= uadv(source
->keyword
);
232 } else if (!ustricmp(source
->keyword
, L
"xhtml-description")) {
233 ret
.description
= uadv(source
->keyword
);
234 } else if (!ustricmp(source
->keyword
, L
"xhtml-head-end")) {
235 ret
.head_end
= uadv(source
->keyword
);
236 } else if (!ustricmp(source
->keyword
, L
"xhtml-body-start")) {
237 ret
.body_start
= uadv(source
->keyword
);
238 } else if (!ustricmp(source
->keyword
, L
"xhtml-body-tag")) {
239 ret
.body
= uadv(source
->keyword
);
240 } else if (!ustricmp(source
->keyword
, L
"xhtml-body-end")) {
241 ret
.body_end
= uadv(source
->keyword
);
242 } else if (!ustricmp(source
->keyword
, L
"xhtml-address-start")) {
243 ret
.address_start
= uadv(source
->keyword
);
244 } else if (!ustricmp(source
->keyword
, L
"xhtml-address-end")) {
245 ret
.address_end
= uadv(source
->keyword
);
246 } else if (!ustricmp(source
->keyword
, L
"xhtml-navigation-attributes")) {
247 ret
.nav_attrs
= uadv(source
->keyword
);
248 } else if (!ustricmp(source
->keyword
, L
"xhtml-chapter-numeric")) {
249 ret
.fchapter
.just_numbers
= utob(uadv(source
->keyword
));
250 } else if (!ustricmp(source
->keyword
, L
"xhtml-chapter-suffix")) {
251 ret
.fchapter
.number_suffix
= uadv(source
->keyword
);
252 } else if (!ustricmp(source
->keyword
, L
"xhtml-section-numeric")) {
253 wchar_t *p
= uadv(source
->keyword
);
259 if (n
>= ret
.nfsect
) {
261 ret
.fsect
= resize(ret
.fsect
, n
+1);
262 for (i
= ret
.nfsect
; i
<= n
; i
++)
263 ret
.fsect
[i
] = ret
.fsect
[ret
.nfsect
-1];
266 ret
.fsect
[n
].just_numbers
= utob(p
);
267 } else if (!ustricmp(source
->keyword
, L
"xhtml-section-suffix")) {
268 wchar_t *p
= uadv(source
->keyword
);
274 if (n
>= ret
.nfsect
) {
276 ret
.fsect
= resize(ret
.fsect
, n
+1);
277 for (i
= ret
.nfsect
; i
<= n
; i
++)
278 ret
.fsect
[i
] = ret
.fsect
[ret
.nfsect
-1];
281 ret
.fsect
[n
].number_suffix
= p
;
286 /* printf(" !!! leaf_level = %i\n", ret.leaf_level);
287 printf(" !!! contentdepth-0 = %i\n", ret.contents_depth[0]);
288 printf(" !!! contentdepth-1 = %i\n", ret.contents_depth[1]);
289 printf(" !!! contentdepth-2 = %i\n", ret.contents_depth[2]);
290 printf(" !!! contentdepth-3 = %i\n", ret.contents_depth[3]);
291 printf(" !!! contentdepth-4 = %i\n", ret.contents_depth[4]);
292 printf(" !!! contentdepth-5 = %i\n", ret.contents_depth[5]);
293 printf(" !!! leaf_contains_contents = %i\n", ret.leaf_contains_contents);*/
297 paragraph
*xhtml_config_filename(char *filename
)
300 * If the user passes in a single filename as a parameter to
301 * the `--html' command-line option, then we should assume it
302 * to imply _two_ config directives:
303 * \cfg{xhtml-single-filename}{whatever} and
304 * \cfg{xhtml-leaf-level}{0}; the rationale being that the user
305 * wants their output _in that file_.
309 p
= cmdline_cfg_simple("xhtml-single-filename", filename
, NULL
);
310 q
= cmdline_cfg_simple("xhtml-leaf-level", "0", NULL
);
315 static xhtmlsection
*xhtml_new_section(xhtmlsection
*last
)
317 xhtmlsection
*ret
= mknew(xhtmlsection
);
325 ret
->level
=-1; /* marker: end of chain */
329 /* Returns NULL or the section that marks that paragraph */
330 static xhtmlsection
*xhtml_find_section(paragraph
*p
)
332 xhtmlsection
*ret
= topsection
;
333 if (xhtml_para_level(p
)==-1) { /* first, we back-track to a section paragraph */
334 paragraph
*p2
= sourceparas
;
335 paragraph
*p3
= NULL
;
336 while (p2
&& p2
!=p
) {
337 if (xhtml_para_level(p2
)!=-1) {
342 if (p3
==NULL
) { /* for some reason, we couldn't find a section before this paragraph ... ? */
343 /* Note that this can happen, if you have a cross-reference to before the first chapter starts.
344 * So don't do that, then.
350 while (ret
&& ret
->para
!= p
) {
351 /* printf(" xhtml_find_section(): checking %s for para @ %p\n", ret->fragment, p);*/
357 static void xhtml_format(paragraph
*p
, char *template_string
, rdstringc
*r
)
365 if (*t
== '%' && t
[1]) {
379 if (p
->kwtext
&& fmt
== 'n')
381 else if (p
->kwtext2
&& fmt
== 'b')
383 else if (p
->keyword
&& *p
->keyword
&& fmt
== 'k')
389 switch (removeattr(w
->type
))
394 case word_WeakCode:*/
395 xhtml_utostr(w
->text
, &c
);
403 xhtml_utostr(ws
, &c
);
413 static xhtmlfile
*xhtml_new_file(xhtmlsection
*sect
)
415 xhtmlfile
*ret
= mknew(xhtmlfile
);
422 ret
->is_leaf
=(sect
!=NULL
&& sect
->level
==conf
.leaf_level
);
424 if (conf
.leaf_level
==0) { /* currently unused */
425 ret
->filename
= smalloc(strlen(conf
.single_filename
)+1);
426 sprintf(ret
->filename
, conf
.single_filename
);
428 ret
->filename
= smalloc(strlen(conf
.contents_filename
)+1);
429 sprintf(ret
->filename
, conf
.contents_filename
);
432 paragraph
*p
= sect
->para
;
433 rdstringc fname_c
= { 0, 0, NULL
};
434 xhtml_format(p
, conf
.template_filename
, &fname_c
);
435 ret
->filename
= rdtrimc(&fname_c
);
437 /* printf(" ! new file '%s', is_leaf == %s\n", ret->filename, (ret->is_leaf)?("true"):("false"));*/
442 * Walk the tree fixing up files which are actually leaf (ie
443 * have no children) but aren't at leaf level, so they have the
446 void xhtml_fixup_layout(xhtmlfile
* file
)
448 if (file
->child
==NULL
) {
449 file
->is_leaf
= TRUE
;
451 xhtml_fixup_layout(file
->child
);
454 xhtml_fixup_layout(file
->next
);
458 * Create the tree structure so we know where everything goes.
461 * Ignoring file splitting, we have three choices with each new section:
463 * +-----------------+-----------------+
471 * Y is the last section we added (currentsect).
472 * If sect is the section we want to add, then:
474 * (1) if sect->level < currentsect->level
475 * (2) if sect->level == currentsect->level
476 * (3) if sect->level > currentsect->level
478 * This requires the constraint that you never skip section numbers
479 * (so you can't have a.b.c.d without all of a, a.b and a.b.c existing).
481 * Note that you _can_ have 1.1.1.1 followed by 1.2 - you can change
482 * more than one level at a time. Lots of asserts, and probably part of
483 * the algorithm here, rely on this being true. (It currently isn't
484 * enforced by halibut, however.)
486 * File splitting makes this harder. For instance, say we added at (3)
487 * above and now need to add another section. We are splitting at level
488 * 2, ie the level of Y. Z is the last section we added:
490 * +-----------------+-----------------+
500 * The (1) case is now split; we need to search upwards to find where
501 * to actually link in. The other two cases remain the same (and will
502 * always be like this).
504 * File splitting makes this harder, however. The decision of whether
505 * to split to a new file is always on the same condition, however (is
506 * the level of this section higher than the leaf_level configuration
509 * Treating the cases backwards:
511 * (3) same file if sect->level > conf.leaf_level, otherwise new file
513 * if in the same file, currentsect->child points to sect
514 * otherwise the linking is done through the file tree (which works
515 * in more or less the same way, ie currentfile->child points to
518 * (2) same file if sect->level > conf.leaf_level, otherwise new file
520 * if in the same file, currentsect->next points to sect
521 * otherwise file linking and currentfile->next points to the new
522 * file (we know that Z must have caused a new file to be created)
524 * (1) same file if sect->level > conf.leaf_level, otherwise new file
526 * this is actually effectively the same case as (2) here,
527 * except that we first have to travel up the sections to figure
528 * out which section this new one will be a sibling of. In doing
529 * so, we may disappear off the top of a file and have to go up
530 * to its parent in the file tree.
533 static void xhtml_ponder_layout(paragraph
*p
)
535 xhtmlsection
*lastsection
;
536 xhtmlsection
*currentsect
;
537 xhtmlfile
*currentfile
;
540 topsection
= xhtml_new_section(NULL
);
541 topfile
= xhtml_new_file(NULL
);
542 lastsection
= topsection
;
543 currentfile
= topfile
;
544 currentsect
= topsection
;
546 if (conf
.leaf_level
== 0) {
547 topfile
->is_leaf
= 1;
548 topfile
->sections
= topsection
;
549 topsection
->file
= topfile
;
554 int level
= xhtml_para_level(p
);
555 if (level
>0) /* actually a section */
558 rdstringc frag_c
= { 0, 0, NULL
};
560 sect
= xhtml_new_section(lastsection
);
564 xhtml_format(p
, conf
.template_fragment
, &frag_c
);
565 sect
->fragment
= rdtrimc(&frag_c
);
567 /* printf(" ! adding para @ %p as sect %s, level %i\n", sect->para, sect->fragment, level);*/
569 if (level
>currentsect
->level
) { /* case (3) */
570 if (level
>conf
.leaf_level
) { /* same file */
571 assert(currentfile
->is_leaf
);
572 currentsect
->child
= sect
;
573 sect
->parent
=currentsect
;
574 sect
->file
=currentfile
;
575 /* printf("connected '%s' to existing file '%s' [I]\n", sect->fragment, currentfile->filename);*/
577 } else { /* new file */
578 xhtmlfile
*file
= xhtml_new_file(sect
);
579 assert(!currentfile
->is_leaf
);
580 currentfile
->child
=file
;
582 file
->parent
=currentfile
;
583 /* printf("connected '%s' to new file '%s' [I]\n", sect->fragment, file->filename);*/
587 } else if (level
>= currentsect
->file
->sections
->level
) {
588 /* Case (1) or (2) *AND* still under the section that starts
591 * I'm not convinced that this couldn't be rolled in with the
592 * final else {} leg further down. It seems a lot of effort
595 if (level
>conf
.leaf_level
) { /* stick within the same file */
596 assert(currentfile
->is_leaf
);
597 sect
->file
= currentfile
;
598 while (currentsect
&& currentsect
->level
> level
&&
599 currentsect
->file
==currentsect
->parent
->file
) {
600 currentsect
= currentsect
->parent
;
603 currentsect
->next
= sect
;
604 assert(currentsect
->level
== sect
->level
);
605 sect
->parent
= currentsect
->parent
;
607 /* printf("connected '%s' to existing file '%s' [II]\n", sect->fragment, currentfile->filename);*/
608 } else { /* new file */
609 xhtmlfile
*file
= xhtml_new_file(sect
);
611 currentfile
->next
=file
;
612 file
->parent
=currentfile
->parent
;
613 file
->is_leaf
=(level
==conf
.leaf_level
);
615 /* printf("connected '%s' to new file '%s' [II]\n", sect->fragment, file->filename);*/
619 } else { /* Case (1) or (2) and we must move up the file tree first */
620 /* this loop is now probably irrelevant - we know we can't connect
621 * to anything in the current file */
622 while (currentsect
&& level
<currentsect
->level
) {
623 currentsect
=currentsect
->parent
;
625 /* printf(" * up one level to '%s'\n", currentsect->fragment);*/
627 /* printf(" * up one level (off top of current file)\n");*/
631 /* I'm pretty sure this can now never fire */
632 assert(currentfile
->is_leaf
);
633 /* printf("connected '%s' to existing file '%s' [III]\n", sect->fragment, currentfile->filename);*/
634 sect
->file
= currentfile
;
635 currentsect
->next
=sect
;
637 } else { /* find a file we can attach to */
638 while (currentfile
&& currentfile
->sections
&& level
<currentfile
->sections
->level
) {
639 currentfile
=currentfile
->parent
;
641 /* printf(" * up one file level to '%s'\n", currentfile->filename);*/
643 /* printf(" * up one file level (off top of tree)\n");*/
646 if (currentfile
) { /* new file (we had to skip up a file to
647 get here, so we must be dealing with a
648 level no lower than the configured
650 xhtmlfile
*file
= xhtml_new_file(sect
);
651 currentfile
->next
=file
;
653 file
->parent
=currentfile
->parent
;
654 file
->is_leaf
=(level
==conf
.leaf_level
);
656 /* printf("connected '%s' to new file '%s' [III]\n", sect->fragment, file->filename);*/
660 fatal(err_whatever
, "Ran off the top trying to connect sibling: strange document.");
666 topsection
= lastsection
; /* get correct end of the chain */
667 xhtml_fixup_layout(topfile
); /* leaf files not at leaf level marked as such */
670 static void xhtml_do_index();
671 static void xhtml_do_file(xhtmlfile
*file
);
672 static void xhtml_do_top_file(xhtmlfile
*file
, paragraph
*sourceform
);
673 static void xhtml_do_paras(FILE *fp
, paragraph
*p
, paragraph
*end
, int indexable
);
674 static int xhtml_do_contents_limit(FILE *fp
, xhtmlfile
*file
, int limit
);
675 static int xhtml_do_contents_section_limit(FILE *fp
, xhtmlsection
*section
, int limit
);
676 static int xhtml_add_contents_entry(FILE *fp
, xhtmlsection
*section
, int limit
);
677 static int xhtml_do_contents(FILE *fp
, xhtmlfile
*file
);
678 static int xhtml_do_naked_contents(FILE *fp
, xhtmlfile
*file
);
679 static void xhtml_do_sections(FILE *fp
, xhtmlsection
*sections
);
682 * Do all the files in this structure.
684 static void xhtml_do_files(xhtmlfile
*file
)
688 xhtml_do_files(file
->child
);
690 xhtml_do_files(file
->next
);
694 * Free up all memory used by the file tree from 'xfile' downwards
696 static void xhtml_free_file(xhtmlfile
* xfile
)
702 if (xfile
->filename
) {
703 sfree(xfile
->filename
);
705 xhtml_free_file(xfile
->child
);
706 xhtml_free_file(xfile
->next
);
713 void xhtml_backend(paragraph
*sourceform
, keywordlist
*in_keywords
,
714 indexdata
*in_idx
, void *unused
)
723 sourceparas
= sourceform
;
724 conf
= xhtml_configure(sourceform
);
725 keywords
= in_keywords
;
728 /* Clear up the index entries backend data pointers */
729 for (ti
=0; (ientry
= (indexentry
*)index234(idx
->entries
, ti
))!=NULL
; ti
++) {
730 ientry
->backend_data
=NULL
;
733 xhtml_ponder_layout(sourceform
);
735 /* old system ... (writes to *.alt, but gets some stuff wrong and is ugly) */
736 /* xhtml_level_0(sourceform);
737 for (i=1; i<=conf.leaf_level; i++)
739 xhtml_level(sourceform, i);
742 /* new system ... (writes to *.html, but isn't fully trusted) */
743 xhtml_do_top_file(topfile
, sourceform
);
744 assert(!topfile
->next
); /* shouldn't have a sibling at all */
745 if (topfile
->child
) {
746 xhtml_do_files(topfile
->child
);
750 /* release file, section, index data structures */
753 xhtmlsection
*tmp
= xsect
->chain
;
754 if (xsect
->fragment
) {
755 sfree(xsect
->fragment
);
760 xhtml_free_file(topfile
);
761 for (ti
= 0; (ientry
=(indexentry
*)index234(idx
->entries
, ti
))!=NULL
; ti
++) {
762 if (ientry
->backend_data
!=NULL
) {
763 xhtmlindex
*xi
= (xhtmlindex
*) ientry
->backend_data
;
764 if (xi
->sections
!=NULL
) {
769 ientry
->backend_data
= NULL
;
774 static int xhtml_para_level(paragraph
*p
)
781 case para_UnnumberedChapter
:
786 /* case para_BiblioCited:
799 /* Output the nav links for the current file.
800 * file == NULL means we're doing the index
802 static void xhtml_donavlinks(FILE *fp
, xhtmlfile
*file
)
804 xhtmlfile
*xhtml_next_file
= NULL
;
806 if (conf
.nav_attrs
!=NULL
) {
807 fprintf(fp
, " %ls>", conf
.nav_attrs
);
811 if (xhtml_last_file
==NULL
) {
812 fprintf(fp
, "Previous | ");
814 fprintf(fp
, "<a href=\"%s\">Previous</a> | ", xhtml_last_file
->filename
);
816 fprintf(fp
, "<a href=\"%s\">Contents</a> | ", conf
.contents_filename
);
818 fprintf(fp
, "Index | ");
820 fprintf(fp
, "<a href=\"%s\">Index</a> | ", conf
.index_filename
);
822 if (file
!= NULL
) { /* otherwise we're doing nav links for the index */
823 if (xhtml_next_file
==NULL
)
824 xhtml_next_file
= file
->child
;
825 if (xhtml_next_file
==NULL
)
826 xhtml_next_file
= file
->next
;
827 if (xhtml_next_file
==NULL
)
828 xhtml_next_file
= file
->parent
->next
;
830 if (xhtml_next_file
==NULL
) {
831 if (file
==NULL
) { /* index, so no next file */
832 fprintf(fp
, "Next ");
834 fprintf(fp
, "<a href=\"%s\">Next</a>", conf
.index_filename
);
837 fprintf(fp
, "<a href=\"%s\">Next</a>", xhtml_next_file
->filename
);
839 fprintf(fp
, "</p>\n");
842 /* Write out the index file */
843 static void xhtml_do_index_body(FILE *fp
)
848 if (count234(idx
->entries
) == 0)
849 return; /* don't write anything at all */
851 fprintf(fp
, "<dl>\n");
852 /* iterate over idx->entries using the tree functions and display everything */
853 for (ti
= 0; (y
= (indexentry
*)index234(idx
->entries
, ti
)) != NULL
; ti
++) {
854 if (y
->backend_data
) {
859 xhtml_para(fp
, y
->text
, FALSE
);
860 fprintf(fp
, "</dt>\n<dd>");
862 xi
= (xhtmlindex
*) y
->backend_data
;
863 for (i
=0; i
<xi
->nsection
; i
++) {
864 xhtmlsection
*sect
= xi
->sections
[i
];
866 fprintf(fp
, "<a href=\"%s#%s\">", sect
->file
->filename
, sect
->fragment
);
867 if (sect
->para
->kwtext
) {
868 xhtml_para(fp
, sect
->para
->kwtext
, FALSE
);
869 } else if (sect
->para
->words
) {
870 xhtml_para(fp
, sect
->para
->words
, FALSE
);
873 if (i
+1<xi
->nsection
) {
878 fprintf(fp
, "</dd>\n");
881 fprintf(fp
, "</dl>\n");
883 static void xhtml_do_index()
885 word temp_word
= { NULL
, NULL
, word_Normal
, 0, 0, L
"Index",
886 { NULL
, 0, 0}, NULL
};
887 FILE *fp
= fopen(conf
.index_filename
, "w");
890 fatal(err_cantopenw
, conf
.index_filename
);
891 xhtml_doheader(fp
, &temp_word
);
892 xhtml_donavlinks(fp
, NULL
);
894 xhtml_do_index_body(fp
);
896 xhtml_donavlinks(fp
, NULL
);
901 /* Output the given file. This includes whatever contents at beginning and end, etc. etc. */
902 static void xhtml_do_file(xhtmlfile
*file
)
904 FILE *fp
= fopen(file
->filename
, "w");
906 fatal(err_cantopenw
, file
->filename
);
908 if (file
->sections
->para
->words
) {
909 xhtml_doheader(fp
, file
->sections
->para
->words
);
910 } else if (file
->sections
->para
->kwtext
) {
911 xhtml_doheader(fp
, file
->sections
->para
->kwtext
);
913 xhtml_doheader(fp
, NULL
);
916 xhtml_donavlinks(fp
, file
);
918 if (file
->is_leaf
&& conf
.leaf_contains_contents
&&
919 xhtml_do_contents(NULL
, file
)>=conf
.leaf_smallest_contents
)
920 xhtml_do_contents(fp
, file
);
921 xhtml_do_sections(fp
, file
->sections
);
923 xhtml_do_naked_contents(fp
, file
);
925 xhtml_donavlinks(fp
, file
);
930 xhtml_last_file
= file
;
933 /* Output the top-level file. */
934 static void xhtml_do_top_file(xhtmlfile
*file
, paragraph
*sourceform
)
938 FILE *fp
= fopen(file
->filename
, "w");
940 fatal(err_cantopenw
, file
->filename
);
942 /* Do the title -- only one allowed */
943 for (p
= sourceform
; p
&& !done
; p
= p
->next
)
945 if (p
->type
== para_Title
)
947 xhtml_doheader(fp
, p
->words
);
952 xhtml_doheader(fp
, NULL
/* Eek! */);
957 for (p
= sourceform
; p
; p
= p
->next
)
959 if (p
->type
== para_Title
) {
960 xhtml_heading(fp
, p
, FALSE
);
965 /* Do the preamble */
966 for (p
= sourceform
; p
; p
= p
->next
)
968 if (p
->type
== para_Chapter
|| p
->type
== para_Heading
||
969 p
->type
== para_Subsect
|| p
->type
== para_Appendix
||
970 p
->type
== para_UnnumberedChapter
) {
972 * We've found the end of the preamble. Do every normal
973 * paragraph up to there.
975 xhtml_do_paras(fp
, sourceform
, p
, FALSE
);
980 xhtml_do_contents(fp
, file
);
981 xhtml_do_sections(fp
, file
->sections
);
984 * Put the index in the top file if we're in single-file mode
987 if (conf
.leaf_level
== 0 && count234(idx
->entries
) > 0) {
988 fprintf(fp
, "<a name=\"index\"></a><h1>Index</h1>\n");
989 xhtml_do_index_body(fp
);
996 /* Convert a Unicode string to an ASCII one. '?' is
997 * used for unmappable characters.
999 static void xhtml_utostr(wchar_t *in
, char **out
)
1001 int l
= ustrlen(in
);
1003 *out
= smalloc(l
+1);
1006 if (in
[i
]>=32 && in
[i
]<=126)
1007 (*out
)[i
]=(char)in
[i
];
1015 * Write contents for the given file, and subfiles, down to
1016 * the appropriate contents depth. Returns the number of
1019 static int xhtml_do_contents(FILE *fp
, xhtmlfile
*file
)
1021 int level
, limit
, count
= 0;
1025 level
= (file
->sections
)?
(file
->sections
->level
):(0);
1026 limit
= conf
.contents_depth
[(level
>5)?
(5):(level
)];
1027 start_level
= (file
->is_leaf
) ?
(level
-1) : (level
);
1028 last_level
= start_level
;
1030 count
+= xhtml_do_contents_section_limit(fp
, file
->sections
, limit
);
1031 count
+= xhtml_do_contents_limit(fp
, file
->child
, limit
);
1033 while (last_level
> start_level
) {
1035 fprintf(fp
, "</li></ul>\n");
1041 /* As above, but doesn't do anything in the current file */
1042 static int xhtml_do_naked_contents(FILE *fp
, xhtmlfile
*file
)
1044 int level
, limit
, start_level
, count
= 0;
1048 level
= (file
->sections
)?
(file
->sections
->level
):(0);
1049 limit
= conf
.contents_depth
[(level
>5)?
(5):(level
)];
1050 start_level
= (file
->is_leaf
) ?
(level
-1) : (level
);
1051 last_level
= start_level
;
1053 count
= xhtml_do_contents_limit(fp
, file
->child
, limit
);
1055 while (last_level
> start_level
) {
1057 fprintf(fp
, "</li></ul>\n");
1064 * Write contents for the given file, children, and siblings, down to
1065 * given limit contents depth.
1067 static int xhtml_do_contents_limit(FILE *fp
, xhtmlfile
*file
, int limit
)
1071 count
+= xhtml_do_contents_section_limit(fp
, file
->sections
, limit
);
1072 count
+= xhtml_do_contents_limit(fp
, file
->child
, limit
);
1079 * Write contents entries for the given section tree, down to the
1080 * limit contents depth.
1082 static int xhtml_do_contents_section_deep_limit(FILE *fp
, xhtmlsection
*section
, int limit
)
1086 if (!xhtml_add_contents_entry(fp
, section
, limit
))
1090 count
+= xhtml_do_contents_section_deep_limit(fp
, section
->child
, limit
);
1091 section
= section
->next
;
1097 * Write contents entries for the given section tree, down to the
1098 * limit contents depth.
1100 static int xhtml_do_contents_section_limit(FILE *fp
, xhtmlsection
*section
, int limit
)
1105 xhtml_add_contents_entry(fp
, section
, limit
);
1107 count
+= xhtml_do_contents_section_deep_limit(fp
, section
->child
, limit
);
1108 /* section=section->child;
1109 while (section && xhtml_add_contents_entry(fp, section, limit)) {
1110 section = section->next;
1116 * Add a section entry, unless we're exceeding the limit, in which
1117 * case return FALSE (otherwise return TRUE).
1119 static int xhtml_add_contents_entry(FILE *fp
, xhtmlsection
*section
, int limit
)
1121 if (!section
|| section
->level
> limit
)
1123 if (fp
==NULL
|| section
->level
< 0)
1125 if (last_level
> section
->level
) {
1126 while (last_level
> section
->level
) {
1128 fprintf(fp
, "</li></ul>\n");
1130 fprintf(fp
, "</li>\n");
1131 } else if (last_level
< section
->level
) {
1132 assert(last_level
== section
->level
- 1);
1134 fprintf(fp
, "<ul>\n");
1136 fprintf(fp
, "</li>\n");
1138 fprintf(fp
, "<li><a href=\"%s#%s\">", section
->file
->filename
, section
->fragment
);
1139 if (section
->para
->kwtext
) {
1140 xhtml_para(fp
, section
->para
->kwtext
, FALSE
);
1141 if (section
->para
->words
) {
1145 if (section
->para
->words
) {
1146 xhtml_para(fp
, section
->para
->words
, FALSE
);
1148 fprintf(fp
, "</a>\n");
1153 * Write all the sections in this file. Do all paragraphs in this section, then all
1154 * children (recursively), then go on to the next one (tail recursively).
1156 static void xhtml_do_sections(FILE *fp
, xhtmlsection
*sections
)
1159 currentsection
= sections
;
1160 xhtml_do_paras(fp
, sections
->para
, NULL
, TRUE
);
1161 xhtml_do_sections(fp
, sections
->child
);
1162 sections
= sections
->next
;
1166 /* Write this list of paragraphs. Close off all lists at the end. */
1167 static void xhtml_do_paras(FILE *fp
, paragraph
*p
, paragraph
*end
,
1170 int last_type
= -1, ptype
, first
=TRUE
;
1171 stack lcont_stack
= stk_new();
1175 /* for (; p && (xhtml_para_level(p)>limit || xhtml_para_level(p)==-1 || first); p=p->next) {*/
1176 for (; p
&& p
!= end
&& (xhtml_para_level(p
)==-1 || first
); p
=p
->next
) {
1178 switch (ptype
= p
->type
)
1181 * Things we ignore because we've already processed them or
1182 * aren't going to touch them in this pass.
1186 case para_Biblio
: /* only touch BiblioCited */
1187 case para_VersionID
:
1197 case para_UnnumberedChapter
:
1198 xhtml_heading(fp
, p
, indexable
);
1203 xhtml_heading(fp
, p
, indexable
);
1207 fprintf(fp
, "\n<hr />\n");
1211 case para_Copyright
:
1212 fprintf(fp
, "\n<p>");
1213 xhtml_para(fp
, p
->words
, indexable
);
1214 fprintf(fp
, "</p>\n");
1217 case para_LcontPush
:
1222 stk_push(lcont_stack
, p
);
1223 last_type
= para_Normal
;
1228 int *p
= stk_pop(lcont_stack
);
1230 ptype
= last_type
= *p
;
1232 goto closeofflist
; /* ick */
1235 case para_QuotePush
:
1236 fprintf(fp
, "<blockquote>\n");
1239 fprintf(fp
, "</blockquote>\n");
1243 case para_NumberedList
:
1244 case para_Description
:
1245 case para_DescribedThing
:
1246 case para_BiblioCited
:
1247 if (last_type
!=p
->type
&&
1248 !(last_type
==para_DescribedThing
&& p
->type
==para_Description
) &&
1249 !(last_type
==para_Description
&& p
->type
==para_DescribedThing
)) {
1250 /* start up list if necessary */
1251 if (p
->type
== para_Bullet
) {
1252 fprintf(fp
, "<ul>\n");
1253 } else if (p
->type
== para_NumberedList
) {
1254 fprintf(fp
, "<ol>\n");
1255 } else if (p
->type
== para_BiblioCited
||
1256 p
->type
== para_DescribedThing
||
1257 p
->type
== para_Description
) {
1258 fprintf(fp
, "<dl>\n");
1261 if (p
->type
== para_Bullet
|| p
->type
== para_NumberedList
) {
1262 fprintf(fp
, "<li>");
1263 } else if (p
->type
== para_DescribedThing
) {
1264 fprintf(fp
, "<dt>");
1265 } else if (p
->type
== para_Description
) {
1266 fprintf(fp
, "<dd>");
1267 } else if (p
->type
== para_BiblioCited
) {
1268 fprintf(fp
, "<dt>");
1269 xhtml_para(fp
, p
->kwtext
, indexable
);
1270 fprintf(fp
, "</dt>\n<dd>");
1272 xhtml_para(fp
, p
->words
, indexable
);
1274 paragraph
*p2
= p
->next
;
1275 if (p2
&& xhtml_para_level(p2
)==-1 && p2
->type
== para_LcontPush
)
1280 if (ptype
== para_BiblioCited
) {
1281 fprintf(fp
, "</dd>\n");
1282 } else if (ptype
== para_DescribedThing
) {
1283 fprintf(fp
, "</dt>");
1284 } else if (ptype
== para_Description
) {
1285 fprintf(fp
, "</dd>");
1286 } else if (ptype
== para_Bullet
|| ptype
== para_NumberedList
) {
1287 fprintf(fp
, "</li>");
1289 if (ptype
== para_Bullet
|| ptype
== para_NumberedList
||
1290 ptype
== para_BiblioCited
|| ptype
== para_Description
||
1291 ptype
== para_DescribedThing
)
1292 /* close off list if necessary */
1294 paragraph
*p2
= p
->next
;
1295 int close_off
=FALSE
;
1296 /* if (p2 && (xhtml_para_level(p2)>limit || xhtml_para_level(p2)==-1)) {*/
1297 if (p2
&& xhtml_para_level(p2
)==-1) {
1298 if (p2
->type
!= ptype
&&
1299 !(p2
->type
==para_DescribedThing
&& ptype
==para_Description
) &&
1300 !(p2
->type
==para_Description
&& ptype
==para_DescribedThing
) &&
1301 p2
->type
!= para_LcontPush
)
1307 if (ptype
== para_Bullet
) {
1308 fprintf(fp
, "</ul>\n");
1309 } else if (ptype
== para_NumberedList
) {
1310 fprintf(fp
, "</ol>\n");
1311 } else if (ptype
== para_BiblioCited
||
1312 ptype
== para_Description
||
1313 ptype
== para_DescribedThing
) {
1314 fprintf(fp
, "</dl>\n");
1321 xhtml_codepara(fp
, p
->words
);
1327 stk_free(lcont_stack
);
1331 * Output a header for this XHTML file.
1333 static void xhtml_doheader(FILE *fp
, word
*title
)
1335 fprintf(fp
, "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n");
1336 fprintf(fp
, "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n");
1337 fprintf(fp
, "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n\n<head>\n<title>");
1339 fprintf(fp
, "The thing with no name!");
1341 xhtml_para(fp
, title
, FALSE
);
1342 fprintf(fp
, "</title>\n");
1343 fprintf(fp
, "<meta name=\"generator\" content=\"Halibut %s xhtml-backend\" />\n", version
);
1345 fprintf(fp
, "<meta name=\"author\" content=\"%ls\" />\n", conf
.author
);
1346 if (conf
.description
)
1347 fprintf(fp
, "<meta name=\"description\" content=\"%ls\" />\n", conf
.description
);
1349 fprintf(fp
, "%ls\n", conf
.head_end
);
1350 fprintf(fp
, "</head>\n\n");
1352 fprintf(fp
, "%ls\n", conf
.body
);
1354 fprintf(fp
, "<body>\n");
1355 if (conf
.body_start
)
1356 fprintf(fp
, "%ls\n", conf
.body_start
);
1360 * Output a footer for this XHTML file.
1362 static void xhtml_dofooter(FILE *fp
)
1364 fprintf(fp
, "\n<hr />\n\n");
1366 fprintf(fp
, "%ls\n", conf
.body_end
);
1367 if (!conf
.suppress_address
) {
1368 fprintf(fp
,"<address>\n");
1369 if (conf
.address_start
)
1370 fprintf(fp
, "%ls\n", conf
.address_start
);
1371 /* Do the version ID */
1372 if (conf
.include_version_id
) {
1375 for (p
= sourceparas
; p
; p
= p
->next
)
1376 if (p
->type
== para_VersionID
) {
1377 xhtml_versionid(fp
, p
->words
, started
);
1381 if (conf
.address_end
)
1382 fprintf(fp
, "%ls\n", conf
.address_end
);
1383 fprintf(fp
, "</address>\n");
1385 fprintf(fp
, "</body>\n\n</html>\n");
1389 * Output the versionid paragraph. Typically this is a version control
1390 * ID string (such as $Id...$ in RCS).
1392 static void xhtml_versionid(FILE *fp
, word
*text
, int started
)
1394 rdstringc t
= { 0, 0, NULL
};
1396 rdaddc(&t
, '['); /* FIXME: configurability */
1397 xhtml_rdaddwc(&t
, text
, NULL
, FALSE
);
1398 rdaddc(&t
, ']'); /* FIXME: configurability */
1401 fprintf(fp
, "<br />\n");
1402 fprintf(fp
, "%s\n", t
.text
);
1406 /* Is this an XHTML reserved character? */
1407 static int xhtml_reservedchar(int c
)
1409 if (c
=='&' || c
=='<' || c
=='>' || c
=='"')
1416 * Convert a wide string into valid XHTML: Anything outside ASCII will
1417 * be fixed up as an entity. Currently we don't worry about constraining the
1418 * encoded character set, which we should probably do at some point (we can
1419 * still fix up and return FALSE - see the last comment here). We also don't
1422 * Because this is only used for words, spaces are HARD spaces (any other
1423 * spaces will be word_Whitespace not word_Normal). So they become
1424 * Unless hard_spaces is FALSE, of course (code paragraphs break the above
1427 * If `result' is non-NULL, mallocs the resulting string and stores a pointer to
1428 * it in `*result'. If `result' is NULL, merely checks whether all
1429 * characters in the string are feasible.
1431 * Return is nonzero if all characters are OK. If not all
1432 * characters are OK but `result' is non-NULL, a result _will_
1433 * still be generated!
1435 static int xhtml_convert(wchar_t *s
, int maxlen
, char **result
,
1437 int doing
= (result
!= 0);
1440 int plen
= 0, psize
= 0;
1445 for (; *s
&& maxlen
!= 0; s
++, maxlen
--) {
1448 #define ensure_size(i) if (i>=psize) { psize = i+256; p = resize(p, psize); }
1450 if (((c
== 32 && !hard_spaces
) || (c
> 32 && c
<= 126 && !xhtml_reservedchar(c
)))) {
1455 p
[plen
++] = (char)c
;
1458 /* Char needs fixing up. */
1459 /* ok = FALSE; -- currently we never return FALSE; we
1460 * might want to when considering a character set for the
1465 if (c
==32) { /* a space in a word is a hard space */
1466 ensure_size(plen
+6); /* includes space for the NUL, which is subsequently stomped on */
1467 sprintf(p
+plen
, " ");
1470 /* FIXME: entity names! */
1471 ensure_size(plen
+8); /* includes space for the NUL, which is subsequently stomped on */
1472 plen
+=sprintf(p
+plen
, "&#%04i;", (int)c
);
1478 p
= resize(p
, plen
+1);
1486 * This formats the given words as XHTML.
1488 * `indexable', if FALSE, prohibits adding any index references.
1489 * You might use this, for example, if an index reference occurred
1490 * in a section title, to prevent phony index references when the
1491 * section title is processed in strange places such as contents
1494 static void xhtml_rdaddwc(rdstringc
*rs
, word
*text
, word
*end
, int indexable
) {
1501 for (; text
&& text
!= end
; text
= text
->next
) {
1502 switch (text
->type
) {
1503 case word_HyperLink
:
1504 xhtml_utostr(text
->text
, &c
);
1505 rdaddsc(rs
, "<a href=\"");
1511 case word_UpperXref
:
1512 case word_LowerXref
:
1513 kwl
= kw_lookup(keywords
, text
->text
);
1515 sect
=xhtml_find_section(kwl
->para
);
1517 rdaddsc(rs
, "<a href=\"");
1518 rdaddsc(rs
, sect
->file
->filename
);
1520 rdaddsc(rs
, sect
->fragment
);
1523 rdaddsc(rs
, "<a href=\"Apologies.html\"><!-- probably a bibliography cross reference -->");
1524 error(err_whatever
, "Couldn't locate cross-reference! (Probably a bibliography entry.)");
1527 rdaddsc(rs
, "<a href=\"Apologies.html\"><!-- unknown cross-reference -->");
1528 error(err_whatever
, "Couldn't locate cross-reference! (Wasn't in source file.)");
1532 case word_IndexRef
: /* in theory we could make an index target here */
1533 /* rdaddsc(rs, "<a name=\"idx-");
1534 xhtml_utostr(text->text, &c);
1537 rdaddsc(rs, "\"></a>");*/
1538 /* what we _do_ need to do is to fix up the backend data
1539 * for any indexentry this points to.
1544 for (ti
=0; (itag
= (indextag
*)index234(idx
->tags
, ti
))!=NULL
; ti
++) {
1545 /* FIXME: really ustricmp() and not ustrcmp()? */
1546 if (ustricmp(itag
->name
, text
->text
)==0) {
1551 if (itag
->refs
!=NULL
) {
1553 for (i
=0; i
<itag
->nrefs
; i
++) {
1554 xhtmlindex
*idx_ref
;
1557 ientry
= itag
->refs
[i
];
1558 if (ientry
->backend_data
==NULL
) {
1559 idx_ref
= (xhtmlindex
*) smalloc(sizeof(xhtmlindex
));
1561 fatal(err_nomemory
);
1562 idx_ref
->nsection
= 0;
1564 idx_ref
->sections
= (xhtmlsection
**) smalloc(idx_ref
->size
* sizeof(xhtmlsection
*));
1565 if (idx_ref
->sections
==NULL
)
1566 fatal(err_nomemory
);
1567 ientry
->backend_data
= idx_ref
;
1569 idx_ref
= ientry
->backend_data
;
1570 if (idx_ref
->nsection
+1 > idx_ref
->size
) {
1571 int new_size
= idx_ref
->size
* 2;
1572 idx_ref
->sections
= srealloc(idx_ref
->sections
, new_size
* sizeof(xhtmlsection
));
1573 if (idx_ref
->sections
==NULL
) {
1574 fatal(err_nomemory
);
1576 idx_ref
->size
= new_size
;
1579 idx_ref
->sections
[idx_ref
->nsection
++] = currentsection
;
1584 fatal(err_whatever
, "Index tag had no entries!");
1587 fprintf(stderr
, "Looking for index entry '%ls'\n", text
->text
);
1588 fatal(err_whatever
, "Couldn't locate index entry! (Wasn't in index.)");
1594 rdaddsc(rs
, "</a>");
1601 case word_WhiteSpace
:
1602 case word_EmphSpace
:
1603 case word_CodeSpace
:
1604 case word_WkCodeSpace
:
1606 case word_EmphQuote
:
1607 case word_CodeQuote
:
1608 case word_WkCodeQuote
:
1609 assert(text
->type
!= word_CodeQuote
&&
1610 text
->type
!= word_WkCodeQuote
);
1611 if (towordstyle(text
->type
) == word_Emph
&&
1612 (attraux(text
->aux
) == attr_First
||
1613 attraux(text
->aux
) == attr_Only
))
1614 rdaddsc(rs
, "<em>");
1615 else if ((towordstyle(text
->type
) == word_Code
|| towordstyle(text
->type
) == word_WeakCode
) &&
1616 (attraux(text
->aux
) == attr_First
||
1617 attraux(text
->aux
) == attr_Only
))
1618 rdaddsc(rs
, "<code>");
1620 if (removeattr(text
->type
) == word_Normal
) {
1621 if (xhtml_convert(text
->text
, 0, &c
, TRUE
) || !text
->alt
)
1622 /* spaces in the word are hard */
1625 xhtml_rdaddwc(rs
, text
->alt
, NULL
, indexable
);
1627 } else if (removeattr(text
->type
) == word_WhiteSpace
) {
1629 } else if (removeattr(text
->type
) == word_Quote
) {
1630 rdaddsc(rs
, """);
1633 if (towordstyle(text
->type
) == word_Emph
&&
1634 (attraux(text
->aux
) == attr_Last
||
1635 attraux(text
->aux
) == attr_Only
))
1636 rdaddsc(rs
, "</em>");
1637 else if ((towordstyle(text
->type
) == word_Code
|| towordstyle(text
->type
) == word_WeakCode
) &&
1638 (attraux(text
->aux
) == attr_Last
||
1639 attraux(text
->aux
) == attr_Only
))
1640 rdaddsc(rs
, "</code>");
1646 /* Output a heading, formatted as XHTML.
1648 static void xhtml_heading(FILE *fp
, paragraph
*p
, int indexable
)
1650 rdstringc t
= { 0, 0, NULL
};
1651 word
*tprefix
= p
->kwtext
;
1652 word
*nprefix
= p
->kwtext2
;
1653 word
*text
= p
->words
;
1654 int level
= xhtml_para_level(p
);
1655 xhtmlsection
*sect
= xhtml_find_section(p
);
1659 fragment
= sect
->fragment
;
1661 if (p
->type
== para_Title
)
1664 fragment
= ""; /* FIXME: what else can we do? */
1665 error(err_whatever
, "Couldn't locate heading cross-reference!");
1669 if (p
->type
== para_Title
)
1671 else if (level
== 1)
1672 fmt
= &conf
.fchapter
;
1673 else if (level
-1 < conf
.nfsect
)
1674 fmt
= &conf
.fsect
[level
-1];
1676 fmt
= &conf
.fsect
[conf
.nfsect
-1];
1678 if (fmt
&& fmt
->just_numbers
&& nprefix
) {
1679 xhtml_rdaddwc(&t
, nprefix
, NULL
, indexable
);
1682 if (xhtml_convert(fmt
->number_suffix
, 0, &c
, FALSE
)) {
1687 } else if (fmt
&& !fmt
->just_numbers
&& tprefix
) {
1688 xhtml_rdaddwc(&t
, tprefix
, NULL
, indexable
);
1691 if (xhtml_convert(fmt
->number_suffix
, 0, &c
, FALSE
)) {
1697 xhtml_rdaddwc(&t
, text
, NULL
, indexable
);
1699 * If we're outputting in single-file mode, we need to lower
1700 * the level of each heading by one, because the overall
1701 * document title will be sitting right at the top as an <h1>
1702 * and so chapters and sections should start at <h2>.
1704 * Even if not, the document title will come back from
1705 * xhtml_para_level() as level zero, so we must increment that
1706 * no matter what leaf_level is set to.
1708 if (conf
.leaf_level
== 0 || level
== 0)
1710 fprintf(fp
, "<a name=\"%s\"></a><h%i>%s</h%i>\n", fragment
, level
, t
.text
, level
);
1714 /* Output a paragraph. Styles are handled by xhtml_rdaddwc().
1715 * This looks pretty simple; I may have missed something ...
1717 static void xhtml_para(FILE *fp
, word
*text
, int indexable
)
1719 rdstringc out
= { 0, 0, NULL
};
1720 xhtml_rdaddwc(&out
, text
, NULL
, indexable
);
1721 fprintf(fp
, "%s", out
.text
);
1725 /* Output a code paragraph. I'm treating this as preformatted, which
1726 * may not be entirely correct. See xhtml_para() for my worries about
1727 * this being overly-simple; however I think that most of the complexity
1728 * of the text backend came entirely out of word wrapping anyway.
1730 static void xhtml_codepara(FILE *fp
, word
*text
)
1732 fprintf(fp
, "<pre>");
1733 for (; text
; text
= text
->next
) if (text
->type
== word_WeakCode
) {
1738 * See if this WeakCode is followed by an Emph to indicate
1742 if (text
->next
&& text
->next
->type
== word_Emph
) {
1743 next
= text
= text
->next
;
1757 for (n
= 0; t
[n
] && e
[n
] && e
[n
] == ec
; n
++);
1758 xhtml_convert(t
, n
, &c
, FALSE
);
1759 fprintf(fp
, "%s%s%s",
1760 (ec
== 'i' ?
"<em>" : ec
== 'b' ?
"<b>" : ""),
1762 (ec
== 'i' ?
"</em>" : ec
== 'b' ?
"</b>" : ""));
1769 xhtml_convert(t
, 0, &c
, FALSE
);
1770 fprintf(fp
, "%s\n", c
);
1773 xhtml_convert(here
->text
, 0, &c
, FALSE
);
1774 fprintf(fp
, "%s\n", c
);
1778 fprintf(fp
, "</pre>\n");