2 * man page backend for Halibut
16 wchar_t *bullet
, *lquote
, *rquote
;
19 static void man_text(FILE *, word
*,
20 int newline
, int quote_props
, manconfig
*conf
);
21 static void man_codepara(FILE *, word
*, int charset
);
22 static int man_convert(wchar_t const *s
, int maxlen
,
23 char **result
, int quote_props
,
24 int charset
, charset_state
*state
);
27 * My TROFF reference is "NROFF/TROFF User's Manual", Joseph
28 * F. Ossana, October 11 1976.
37 * \(sl slash (matching bakslash)
38 * \(br box vertical rule
39 * \(br Bell System logo
41 * all characters for constructing large brackets
47 } const man_charmap
[] = {
48 {0x00A2, "\\(ct"}, {0x00A7, "\\(sc"}, {0x00A9, "\\(co"}, {0x00AC, "\\(no"},
49 {0x00AE, "\\(rg"}, {0x00B0, "\\(de"}, {0x00B1, "\\(+-"}, {0x00B4, "\\(aa"},
50 {0x00BC, "\\(14"}, {0x00BD, "\\(12"}, {0x00BE, "\\(34"}, {0x00D7, "\\(mu"},
53 {0x0391, "\\(*A"}, {0x0392, "\\(*B"}, {0x0393, "\\(*G"}, {0x0394, "\\(*D"},
54 {0x0395, "\\(*E"}, {0x0396, "\\(*Z"}, {0x0397, "\\(*Y"}, {0x0398, "\\(*H"},
55 {0x0399, "\\(*I"}, {0x039A, "\\(*K"}, {0x039B, "\\(*L"}, {0x039C, "\\(*M"},
56 {0x039D, "\\(*N"}, {0x039E, "\\(*C"}, {0x039F, "\\(*O"}, {0x03A0, "\\(*P"},
57 {0x03A1, "\\(*R"}, {0x03A3, "\\(*S"}, {0x03A4, "\\(*T"}, {0x03A5, "\\(*U"},
58 {0x03A6, "\\(*F"}, {0x03A7, "\\(*X"}, {0x03A8, "\\(*Q"}, {0x03A9, "\\(*W"},
59 {0x03B1, "\\(*a"}, {0x03B2, "\\(*b"}, {0x03B3, "\\(*g"}, {0x03B4, "\\(*d"},
60 {0x03B5, "\\(*e"}, {0x03B6, "\\(*z"}, {0x03B7, "\\(*y"}, {0x03B8, "\\(*h"},
61 {0x03B9, "\\(*i"}, {0x03BA, "\\(*k"}, {0x03BB, "\\(*l"}, {0x03BC, "\\(*m"},
62 {0x03BD, "\\(*n"}, {0x03BE, "\\(*c"}, {0x03BF, "\\(*o"}, {0x03C0, "\\(*p"},
63 {0x03C1, "\\(*r"}, {0x03C2, "\\(ts"}, {0x03C3, "\\(*s"}, {0x03C4, "\\(*t"},
64 {0x03C5, "\\(*u"}, {0x03C6, "\\(*f"}, {0x03C7, "\\(*x"}, {0x03C8, "\\(*q"},
67 {0x2014, "\\(em"}, {0x2018, "`"}, {0x2019, "'"}, {0x2020, "\\(dg"},
68 {0x2021, "\\(dd"}, {0x2022, "\\(bu"}, {0x2032, "\\(fm"},
70 {0x2190, "\\(<-"}, {0x2191, "\\(ua"}, {0x2192, "\\(->"}, {0x2193, "\\(da"},
72 {0x2202, "\\(pd"}, {0x2205, "\\(es"}, {0x2207, "\\(gr"}, {0x2208, "\\(mo"},
73 {0x2212, "\\-"}, {0x2217, "\\(**"}, {0x221A, "\\(sr"}, {0x221D, "\\(pt"},
74 {0x221E, "\\(if"}, {0x2229, "\\(ca"}, {0x222A, "\\(cu"}, {0x222B, "\\(is"},
75 {0x223C, "\\(ap"}, {0x2245, "\\(~="}, {0x2260, "\\(!="}, {0x2261, "\\(=="},
76 {0x2264, "\\(<="}, {0x2265, "\\(>="}, {0x2282, "\\(sb"}, {0x2283, "\\(sp"},
77 {0x2286, "\\(ib"}, {0x2287, "\\(ip"},
79 {0x25A1, "\\(sq"}, {0x25CB, "\\(ci"},
81 {0x261C, "\\(lh"}, {0x261E, "\\(rh"},
84 static char const *troffchar(int unichar
) {
88 j
= lenof(man_charmap
);
91 if (man_charmap
[k
].uni
== unichar
)
92 return man_charmap
[k
].troff
;
93 else if (man_charmap
[k
].uni
> unichar
)
102 * Return TRUE if we can represent the whole of the given string either
103 * in the output charset or as named characters; FALSE otherwise.
105 static int troff_ok(int charset
, wchar_t *string
) {
110 if (!cvt_ok(charset
, test
) && !troffchar(*string
))
117 static manconfig
man_configure(paragraph
*source
) {
125 ret
.headnumbers
= FALSE
;
127 ret
.filename
= dupstr("output.1");
128 ret
.charset
= CS_ASCII
;
129 ret
.bullet
= L
"\x2022\0o\0\0";
130 ret
.lquote
= L
"\x2018\0\x2019\0\"\0\"\0\0";
131 ret
.rquote
= uadv(ret
.lquote
);
134 * Two-pass configuration so that we can pick up global config
135 * (e.g. `quotes') before having it overridden by specific
136 * config (`man-quotes'), irrespective of the order in which
139 for (p
= source
; p
; p
= p
->next
) {
140 if (p
->type
== para_Config
) {
141 if (!ustricmp(p
->keyword
, L
"quotes")) {
142 if (*uadv(p
->keyword
) && *uadv(uadv(p
->keyword
))) {
143 ret
.lquote
= uadv(p
->keyword
);
144 ret
.rquote
= uadv(ret
.lquote
);
150 for (p
= source
; p
; p
= p
->next
) {
151 if (p
->type
== para_Config
) {
152 if (!ustricmp(p
->keyword
, L
"man-identity")) {
155 wp
= uadv(p
->keyword
);
160 ret
.th
= snewn(ep
- wp
+ 1, wchar_t);
161 memcpy(ret
.th
, wp
, (ep
- wp
+ 1) * sizeof(wchar_t));
162 } else if (!ustricmp(p
->keyword
, L
"man-charset")) {
163 ret
.charset
= charset_from_ustr(&p
->fpos
, uadv(p
->keyword
));
164 } else if (!ustricmp(p
->keyword
, L
"man-headnumbers")) {
165 ret
.headnumbers
= utob(uadv(p
->keyword
));
166 } else if (!ustricmp(p
->keyword
, L
"man-mindepth")) {
167 ret
.mindepth
= utoi(uadv(p
->keyword
));
168 } else if (!ustricmp(p
->keyword
, L
"man-filename")) {
170 ret
.filename
= dupstr(adv(p
->origkeyword
));
171 } else if (!ustricmp(p
->keyword
, L
"man-bullet")) {
172 ret
.bullet
= uadv(p
->keyword
);
173 } else if (!ustricmp(p
->keyword
, L
"man-quotes")) {
174 if (*uadv(p
->keyword
) && *uadv(uadv(p
->keyword
))) {
175 ret
.lquote
= uadv(p
->keyword
);
176 ret
.rquote
= uadv(ret
.lquote
);
183 * Now process fallbacks on quote characters and bullets.
185 while (*uadv(ret
.rquote
) && *uadv(uadv(ret
.rquote
)) &&
186 (!troff_ok(ret
.charset
, ret
.lquote
) ||
187 !troff_ok(ret
.charset
, ret
.rquote
))) {
188 ret
.lquote
= uadv(ret
.rquote
);
189 ret
.rquote
= uadv(ret
.lquote
);
192 while (*ret
.bullet
&& *uadv(ret
.bullet
) &&
193 !troff_ok(ret
.charset
, ret
.bullet
))
194 ret
.bullet
= uadv(ret
.bullet
);
199 static void man_conf_cleanup(manconfig cf
)
205 paragraph
*man_config_filename(char *filename
)
207 return cmdline_cfg_simple("man-filename", filename
, NULL
);
210 #define QUOTE_INITCTRL 1 /* quote initial . and ' on a line */
211 #define QUOTE_QUOTES 2 /* quote double quotes by doubling them */
213 void man_backend(paragraph
*sourceform
, keywordlist
*keywords
,
214 indexdata
*idx
, void *unused
) {
218 int had_described_thing
;
224 conf
= man_configure(sourceform
);
227 * Open the output file.
229 fp
= fopen(conf
.filename
, "w");
231 error(err_cantopenw
, conf
.filename
);
235 /* Do the version ID */
236 for (p
= sourceform
; p
; p
= p
->next
)
237 if (p
->type
== para_VersionID
) {
238 fprintf(fp
, ".\\\" ");
239 man_text(fp
, p
->words
, TRUE
, 0, &conf
);
242 /* .TH name-of-program manual-section */
244 if (conf
.th
&& *conf
.th
) {
248 for (wp
= conf
.th
; *wp
; wp
= uadv(wp
)) {
250 man_convert(wp
, 0, &c
, QUOTE_QUOTES
, conf
.charset
, NULL
);
258 had_described_thing
= FALSE
;
259 #define cleanup_described_thing do { \
260 if (had_described_thing) \
262 had_described_thing = FALSE; \
265 for (p
= sourceform
; p
; p
= p
->next
) switch (p
->type
) {
267 * Things we ignore because we've already processed them or
268 * aren't going to touch them in this pass.
272 case para_Biblio
: /* only touch BiblioCited */
283 case para_UnnumberedChapter
:
287 cleanup_described_thing
;
290 if (p
->type
== para_Subsect
)
292 else if (p
->type
== para_Heading
)
296 if (depth
>= conf
.mindepth
) {
297 if (depth
> conf
.mindepth
)
298 fprintf(fp
, ".SS \"");
300 fprintf(fp
, ".SH \"");
301 if (conf
.headnumbers
&& p
->kwtext
) {
302 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
, &conf
);
305 man_text(fp
, p
->words
, FALSE
, QUOTE_QUOTES
, &conf
);
315 cleanup_described_thing
;
316 fprintf(fp
, ".PP\n");
317 man_codepara(fp
, p
->words
, conf
.charset
);
325 cleanup_described_thing
;
326 fprintf(fp
, ".PP\n");
327 man_text(fp
, p
->words
, TRUE
, 0, &conf
);
333 case para_Description
:
334 case para_BiblioCited
:
336 case para_NumberedList
:
337 if (p
->type
!= para_Description
)
338 cleanup_described_thing
;
340 if (p
->type
== para_Bullet
) {
342 man_convert(conf
.bullet
, -1, &bullettext
, QUOTE_QUOTES
,
344 fprintf(fp
, ".IP \"\\fB%s\\fP\"\n", bullettext
);
346 } else if (p
->type
== para_NumberedList
) {
347 fprintf(fp
, ".IP \"");
348 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
, &conf
);
350 } else if (p
->type
== para_Description
) {
351 if (had_described_thing
) {
353 * Do nothing; the .xP for this paragraph is the
354 * .IP which has come before it in the
359 * A \dd without a preceding \dt is given a blank
362 fprintf(fp
, ".IP \"\"\n");
364 } else if (p
->type
== para_BiblioCited
) {
365 fprintf(fp
, ".IP \"");
366 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
, &conf
);
369 man_text(fp
, p
->words
, TRUE
, 0, &conf
);
370 had_described_thing
= FALSE
;
373 case para_DescribedThing
:
374 cleanup_described_thing
;
375 fprintf(fp
, ".IP \"");
376 man_text(fp
, p
->words
, FALSE
, QUOTE_QUOTES
, &conf
);
378 had_described_thing
= TRUE
;
383 * New paragraph containing a horizontal line 1/2em above the
384 * baseline whose length is the line length minus the current
387 cleanup_described_thing
;
388 fprintf(fp
, ".PP\n\\u\\l'\\n(.lu-\\n(.iu'\\d\n");
393 cleanup_described_thing
;
394 fprintf(fp
, ".RS\n");
398 cleanup_described_thing
;
399 fprintf(fp
, ".RE\n");
402 cleanup_described_thing
;
408 man_conf_cleanup(conf
);
412 * Convert a wide string into a string of chars; mallocs the
413 * resulting string and stores a pointer to it in `*result'.
415 * If `state' is non-NULL, updates the charset state pointed to. If
416 * `state' is NULL, this function uses its own state, initialises
417 * it from scratch, and cleans it up when finished. If `state' is
418 * non-NULL but _s_ is NULL, cleans up a provided state.
420 * Return is nonzero if all characters are OK. If not all
421 * characters are OK but `result' is non-NULL, a result _will_
422 * still be generated!
424 * This function also does escaping of groff special characters.
426 static int man_convert(wchar_t const *s
, int maxlen
,
427 char **result
, int quote_props
,
428 int charset
, charset_state
*state
) {
429 charset_state internal_state
= CHARSET_INIT_STATE
;
432 int plen
= 0, psize
= 0;
433 rdstringc out
= {0, 0, NULL
};
437 state
= &internal_state
;
439 slen
= (s ?
ustrlen(s
) : 0);
441 if (slen
> maxlen
&& maxlen
> 0)
446 p
= snewn(psize
, char);
450 int ret
= charset_from_unicode(&s
, &slen
, p
, psize
,
451 charset
, state
, &err
);
454 for (q
= p
; q
< p
+plen
; q
++) {
455 if (q
== p
&& (*q
== '.' || *q
== '\'') &&
456 (quote_props
& QUOTE_INITCTRL
)) {
458 * Control character (. or ') at the start of a
459 * line. Quote it by putting \& (troff zero-width
464 } else if (*q
== '\\' || *q
== '`') {
466 * Quote backslashes and backticks always.
469 } else if (*q
== '"' && (quote_props
& QUOTE_QUOTES
)) {
471 * Double quote within double quotes. Quote it by
479 char const *tr
= troffchar(*s
);
486 /* Past start of string -- no more quoting needed */
487 quote_props
&= ~QUOTE_INITCTRL
;
490 if (state
== &internal_state
|| s
== NULL
) {
491 int ret
= charset_from_unicode(NULL
, 0, p
+plen
, psize
-plen
,
492 charset
, state
, NULL
);
500 *result
= rdtrimc(&out
);
502 *result
= dupstr("");
507 static int man_rdaddwc(rdstringc
*rs
, word
*text
, word
*end
,
508 int quote_props
, manconfig
*conf
,
509 charset_state
*state
) {
512 for (; text
&& text
!= end
; text
= text
->next
) switch (text
->type
) {
525 case word_WhiteSpace
:
528 case word_WkCodeSpace
:
532 case word_WkCodeQuote
:
533 assert(text
->type
!= word_CodeQuote
&&
534 text
->type
!= word_WkCodeQuote
);
536 if (towordstyle(text
->type
) == word_Emph
&&
537 (attraux(text
->aux
) == attr_First
||
538 attraux(text
->aux
) == attr_Only
)) {
539 man_convert(NULL
, 0, &c
, quote_props
, conf
->charset
, state
);
542 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
544 *state
= charset_init_state
;
546 } else if ((towordstyle(text
->type
) == word_Code
||
547 towordstyle(text
->type
) == word_WeakCode
) &&
548 (attraux(text
->aux
) == attr_First
||
549 attraux(text
->aux
) == attr_Only
)) {
550 man_convert(NULL
, 0, &c
, quote_props
, conf
->charset
, state
);
553 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
555 *state
= charset_init_state
;
559 if (removeattr(text
->type
) == word_Normal
) {
560 charset_state s2
= *state
;
562 if (man_convert(text
->text
, 0, &c
, quote_props
, conf
->charset
, &s2
) ||
566 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
569 quote_props
= man_rdaddwc(rs
, text
->alt
, NULL
,
570 quote_props
, conf
, state
);
573 } else if (removeattr(text
->type
) == word_WhiteSpace
) {
574 man_convert(L
" ", 1, &c
, quote_props
, conf
->charset
, state
);
577 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
579 } else if (removeattr(text
->type
) == word_Quote
) {
580 man_convert(quoteaux(text
->aux
) == quote_Open ?
581 conf
->lquote
: conf
->rquote
, 0,
582 &c
, quote_props
, conf
->charset
, state
);
585 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
588 if (towordstyle(text
->type
) != word_Normal
&&
589 (attraux(text
->aux
) == attr_Last
||
590 attraux(text
->aux
) == attr_Only
)) {
591 man_convert(NULL
, 0, &c
, quote_props
, conf
->charset
, state
);
594 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
596 *state
= charset_init_state
;
601 man_convert(NULL
, 0, &c
, quote_props
, conf
->charset
, state
);
604 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
610 static void man_text(FILE *fp
, word
*text
, int newline
,
611 int quote_props
, manconfig
*conf
) {
612 rdstringc t
= { 0, 0, NULL
};
613 charset_state state
= CHARSET_INIT_STATE
;
615 man_rdaddwc(&t
, text
, NULL
, quote_props
| QUOTE_INITCTRL
, conf
, &state
);
616 fprintf(fp
, "%s", t
.text
);
622 static void man_codepara(FILE *fp
, word
*text
, int charset
) {
623 fprintf(fp
, ".nf\n");
624 for (; text
; text
= text
->next
) if (text
->type
== word_WeakCode
) {
627 int quote_props
= QUOTE_INITCTRL
;
630 if (text
->next
&& text
->next
->type
== word_Emph
) {
631 e
= text
->next
->text
;
636 while (e
&& *e
&& *t
) {
640 for (n
= 0; t
[n
] && e
[n
] && e
[n
] == ec
; n
++);
645 man_convert(t
, n
, &c
, quote_props
, charset
, NULL
);
646 quote_props
&= ~QUOTE_INITCTRL
;
647 fprintf(fp
, "%s", c
);
649 if (ec
== 'i' || ec
== 'b')
654 man_convert(t
, 0, &c
, quote_props
, charset
, NULL
);
655 fprintf(fp
, "%s\n", c
);
658 fprintf(fp
, ".fi\n");