2 * man page backend for Halibut
10 static void man_text(FILE *, word
*, int newline
, int quote_props
);
11 static void man_codepara(FILE *, word
*);
12 static int man_convert(wchar_t *s
, int maxlen
,
13 char **result
, int quote_props
);
21 static manconfig
man_configure(paragraph
*source
) {
28 ret
.headnumbers
= FALSE
;
31 for (; source
; source
= source
->next
) {
32 if (source
->type
== para_Config
) {
33 if (!ustricmp(source
->keyword
, L
"man-identity")) {
36 wp
= uadv(source
->keyword
);
40 ret
.th
= mknewa(wchar_t, ep
- wp
+ 1);
41 memcpy(ret
.th
, wp
, (ep
- wp
+ 1) * sizeof(wchar_t));
42 } else if (!ustricmp(source
->keyword
, L
"man-headnumbers")) {
43 ret
.headnumbers
= utob(uadv(source
->keyword
));
44 } else if (!ustricmp(source
->keyword
, L
"man-mindepth")) {
45 ret
.mindepth
= utoi(uadv(source
->keyword
));
53 static void man_conf_cleanup(manconfig cf
)
58 #define QUOTE_INITCTRL 1 /* quote initial . and ' on a line */
59 #define QUOTE_QUOTES 2 /* quote double quotes by doubling them */
61 void man_backend(paragraph
*sourceform
, keywordlist
*keywords
,
68 IGNORE(keywords
); /* we don't happen to need this */
69 IGNORE(idx
); /* or this */
71 conf
= man_configure(sourceform
);
74 * Determine the output file name, and open the output file
76 * FIXME: want configurable output file names here. For the
77 * moment, we'll just call it `output.1'.
79 fp
= fopen("output.1", "w");
81 error(err_cantopenw
, "output.1");
85 /* Do the version ID */
86 for (p
= sourceform
; p
; p
= p
->next
)
87 if (p
->type
== para_VersionID
) {
88 fprintf(fp
, ".\\\" ");
89 man_text(fp
, p
->words
, TRUE
, 0);
92 /* .TH name-of-program manual-section */
94 if (conf
.th
&& *conf
.th
) {
98 for (wp
= conf
.th
; *wp
; wp
= uadv(wp
)) {
100 man_convert(wp
, 0, &c
, QUOTE_QUOTES
);
108 fprintf(fp
, ".UC\n");
110 /* Do the preamble and copyright */
112 for (p
= sourceform
; p
; p
= p
->next
)
113 if (p
->type
== para_Preamble
) {
114 fprintf(fp
, "%s", sep
);
115 man_text(fp
, p
->words
, TRUE
, 0);
118 for (p
= sourceform
; p
; p
= p
->next
)
119 if (p
->type
== para_Copyright
) {
120 fprintf(fp
, "%s", sep
);
121 man_text(fp
, p
->words
, TRUE
, 0);
125 for (p
= sourceform
; p
; p
= p
->next
) switch (p
->type
) {
127 * Things we ignore because we've already processed them or
128 * aren't going to touch them in this pass.
132 case para_Biblio
: /* only touch BiblioCited */
145 case para_UnnumberedChapter
:
150 if (p
->type
== para_Subsect
)
152 else if (p
->type
== para_Heading
)
156 if (depth
>= conf
.mindepth
) {
157 fprintf(fp
, ".SH \"");
158 if (conf
.headnumbers
&& p
->kwtext
) {
159 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
);
162 man_text(fp
, p
->words
, FALSE
, QUOTE_QUOTES
);
172 fprintf(fp
, ".PP\n");
173 man_codepara(fp
, p
->words
);
180 fprintf(fp
, ".PP\n");
181 man_text(fp
, p
->words
, TRUE
, 0);
187 case para_Description
:
188 case para_BiblioCited
:
190 case para_NumberedList
:
191 if (p
->type
== para_Bullet
) {
192 fprintf(fp
, ".IP \"\\fBo\\fP\"\n"); /* FIXME: configurable? */
193 } else if (p
->type
== para_NumberedList
) {
194 fprintf(fp
, ".IP \"");
195 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
);
197 } else if (p
->type
== para_Description
) {
199 * Do nothing; the .xP for this paragraph is the .IP
200 * which has come before it in the DescribedThing.
202 } else if (p
->type
== para_BiblioCited
) {
203 fprintf(fp
, ".IP \"");
204 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
);
207 man_text(fp
, p
->words
, TRUE
, 0);
210 case para_DescribedThing
:
211 fprintf(fp
, ".IP \"");
212 man_text(fp
, p
->words
, FALSE
, QUOTE_QUOTES
);
218 * This isn't terribly good. Anyone who wants to do better
221 fprintf(fp
, ".PP\n----------------------------------------\n");
226 fprintf(fp
, ".RS\n");
230 fprintf(fp
, ".RE\n");
238 man_conf_cleanup(conf
);
242 * Convert a wide string into a string of chars. If `result' is
243 * non-NULL, mallocs the resulting string and stores a pointer to
244 * it in `*result'. If `result' is NULL, merely checks whether all
245 * characters in the string are feasible for the output character
248 * Return is nonzero if all characters are OK. If not all
249 * characters are OK but `result' is non-NULL, a result _will_
250 * still be generated!
252 * FIXME: Here is probably also a good place to do escaping sorts
253 * of things. I know I at least need to escape backslash, and full
254 * stops at the starts of words are probably trouble as well.
256 static int man_convert(wchar_t *s
, int maxlen
,
257 char **result
, int quote_props
) {
259 * FIXME. Currently this is ISO8859-1 only.
261 int doing
= (result
!= 0);
264 int plen
= 0, psize
= 0;
269 for (; *s
&& maxlen
!= 0; s
++, maxlen
--) {
273 if ((c
>= 32 && c
<= 126) ||
274 (c
>= 160 && c
<= 255)) {
278 /* Char is not OK. */
280 outc
= 0xBF; /* approximate the good old DEC `uh?' */
283 if (plen
+3 >= psize
) {
285 p
= resize(p
, psize
);
287 if (plen
== 0 && (outc
== '.' || outc
== '\'') &&
288 (quote_props
& QUOTE_INITCTRL
)) {
290 * Control character (. or ') at the start of a
291 * line. Quote it by putting \& (troff zero-width
296 } else if (outc
== '\\') {
298 * Quote backslashes by doubling them, always.
301 } else if (outc
== '"' && (quote_props
& QUOTE_QUOTES
)) {
303 * Double quote within double quotes. Quote it by
312 p
= resize(p
, plen
+1);
319 static void man_rdaddwc(rdstringc
*rs
, word
*text
, word
*end
,
323 for (; text
&& text
!= end
; text
= text
->next
) switch (text
->type
) {
336 case word_WhiteSpace
:
339 case word_WkCodeSpace
:
343 case word_WkCodeQuote
:
344 assert(text
->type
!= word_CodeQuote
&&
345 text
->type
!= word_WkCodeQuote
);
346 if (towordstyle(text
->type
) == word_Emph
&&
347 (attraux(text
->aux
) == attr_First
||
348 attraux(text
->aux
) == attr_Only
))
350 else if ((towordstyle(text
->type
) == word_Code
||
351 towordstyle(text
->type
) == word_WeakCode
) &&
352 (attraux(text
->aux
) == attr_First
||
353 attraux(text
->aux
) == attr_Only
))
355 if (removeattr(text
->type
) == word_Normal
) {
357 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
358 if (man_convert(text
->text
, 0, &c
, quote_props
))
361 man_rdaddwc(rs
, text
->alt
, NULL
, quote_props
);
363 } else if (removeattr(text
->type
) == word_WhiteSpace
) {
365 } else if (removeattr(text
->type
) == word_Quote
) {
367 if (quote_props
& QUOTE_QUOTES
)
370 if (towordstyle(text
->type
) == word_Emph
&&
371 (attraux(text
->aux
) == attr_Last
||
372 attraux(text
->aux
) == attr_Only
))
374 else if ((towordstyle(text
->type
) == word_Code
||
375 towordstyle(text
->type
) == word_WeakCode
) &&
376 (attraux(text
->aux
) == attr_Last
||
377 attraux(text
->aux
) == attr_Only
))
383 static void man_text(FILE *fp
, word
*text
, int newline
, int quote_props
) {
384 rdstringc t
= { 0, 0, NULL
};
386 man_rdaddwc(&t
, text
, NULL
, quote_props
| QUOTE_INITCTRL
);
387 fprintf(fp
, "%s", t
.text
);
393 static void man_codepara(FILE *fp
, word
*text
) {
394 fprintf(fp
, ".nf\n");
395 for (; text
; text
= text
->next
) if (text
->type
== word_WeakCode
) {
398 int quote_props
= QUOTE_INITCTRL
;
401 if (text
->next
&& text
->next
->type
== word_Emph
) {
402 e
= text
->next
->text
;
407 while (e
&& *e
&& *t
) {
411 for (n
= 0; t
[n
] && e
[n
] && e
[n
] == ec
; n
++);
416 man_convert(t
, n
, &c
, quote_props
);
417 quote_props
&= ~QUOTE_INITCTRL
;
418 fprintf(fp
, "%s", c
);
420 if (ec
== 'i' || ec
== 'b')
425 man_convert(t
, 0, &c
, quote_props
);
426 fprintf(fp
, "%s\n", c
);
429 fprintf(fp
, ".fi\n");