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
,
67 IGNORE(keywords
); /* we don't happen to need this */
68 IGNORE(idx
); /* or this */
70 conf
= man_configure(sourceform
);
73 * Determine the output file name, and open the output file
75 * FIXME: want configurable output file names here. For the
76 * moment, we'll just call it `output.1'.
78 fp
= fopen("output.1", "w");
80 error(err_cantopenw
, "output.1");
84 /* Do the version ID */
85 for (p
= sourceform
; p
; p
= p
->next
)
86 if (p
->type
== para_VersionID
) {
87 fprintf(fp
, ".\\\" ");
88 man_text(fp
, p
->words
, TRUE
, 0);
91 /* .TH name-of-program manual-section */
93 if (conf
.th
&& *conf
.th
) {
97 for (wp
= conf
.th
; *wp
; wp
= uadv(wp
)) {
99 man_convert(wp
, 0, &c
, QUOTE_QUOTES
);
107 fprintf(fp
, ".UC\n");
109 for (p
= sourceform
; p
; p
= p
->next
) switch (p
->type
) {
111 * Things we ignore because we've already processed them or
112 * aren't going to touch them in this pass.
116 case para_Biblio
: /* only touch BiblioCited */
127 case para_UnnumberedChapter
:
133 if (p
->type
== para_Subsect
)
135 else if (p
->type
== para_Heading
)
139 if (depth
>= conf
.mindepth
) {
140 fprintf(fp
, ".SH \"");
141 if (conf
.headnumbers
&& p
->kwtext
) {
142 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
);
145 man_text(fp
, p
->words
, FALSE
, QUOTE_QUOTES
);
155 fprintf(fp
, ".PP\n");
156 man_codepara(fp
, p
->words
);
164 fprintf(fp
, ".PP\n");
165 man_text(fp
, p
->words
, TRUE
, 0);
171 case para_Description
:
172 case para_BiblioCited
:
174 case para_NumberedList
:
175 if (p
->type
== para_Bullet
) {
176 fprintf(fp
, ".IP \"\\fBo\\fP\"\n"); /* FIXME: configurable? */
177 } else if (p
->type
== para_NumberedList
) {
178 fprintf(fp
, ".IP \"");
179 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
);
181 } else if (p
->type
== para_Description
) {
183 * Do nothing; the .xP for this paragraph is the .IP
184 * which has come before it in the DescribedThing.
186 } else if (p
->type
== para_BiblioCited
) {
187 fprintf(fp
, ".IP \"");
188 man_text(fp
, p
->kwtext
, FALSE
, QUOTE_QUOTES
);
191 man_text(fp
, p
->words
, TRUE
, 0);
194 case para_DescribedThing
:
195 fprintf(fp
, ".IP \"");
196 man_text(fp
, p
->words
, FALSE
, QUOTE_QUOTES
);
202 * This isn't terribly good. Anyone who wants to do better
205 fprintf(fp
, ".PP\n----------------------------------------\n");
210 fprintf(fp
, ".RS\n");
214 fprintf(fp
, ".RE\n");
222 man_conf_cleanup(conf
);
226 * Convert a wide string into a string of chars. If `result' is
227 * non-NULL, mallocs the resulting string and stores a pointer to
228 * it in `*result'. If `result' is NULL, merely checks whether all
229 * characters in the string are feasible for the output character
232 * Return is nonzero if all characters are OK. If not all
233 * characters are OK but `result' is non-NULL, a result _will_
234 * still be generated!
236 * FIXME: Here is probably also a good place to do escaping sorts
237 * of things. I know I at least need to escape backslash, and full
238 * stops at the starts of words are probably trouble as well.
240 static int man_convert(wchar_t *s
, int maxlen
,
241 char **result
, int quote_props
) {
243 * FIXME. Currently this is ISO8859-1 only.
245 int doing
= (result
!= 0);
248 int plen
= 0, psize
= 0;
253 for (; *s
&& maxlen
!= 0; s
++, maxlen
--) {
257 if ((c
>= 32 && c
<= 126) ||
258 (c
>= 160 && c
<= 255)) {
262 /* Char is not OK. */
264 outc
= 0xBF; /* approximate the good old DEC `uh?' */
267 if (plen
+3 >= psize
) {
269 p
= resize(p
, psize
);
271 if (plen
== 0 && (outc
== '.' || outc
== '\'') &&
272 (quote_props
& QUOTE_INITCTRL
)) {
274 * Control character (. or ') at the start of a
275 * line. Quote it by putting \& (troff zero-width
280 } else if (outc
== '\\') {
282 * Quote backslashes by doubling them, always.
285 } else if (outc
== '"' && (quote_props
& QUOTE_QUOTES
)) {
287 * Double quote within double quotes. Quote it by
296 p
= resize(p
, plen
+1);
303 static void man_rdaddwc(rdstringc
*rs
, word
*text
, word
*end
,
307 for (; text
&& text
!= end
; text
= text
->next
) switch (text
->type
) {
320 case word_WhiteSpace
:
323 case word_WkCodeSpace
:
327 case word_WkCodeQuote
:
328 assert(text
->type
!= word_CodeQuote
&&
329 text
->type
!= word_WkCodeQuote
);
330 if (towordstyle(text
->type
) == word_Emph
&&
331 (attraux(text
->aux
) == attr_First
||
332 attraux(text
->aux
) == attr_Only
))
334 else if ((towordstyle(text
->type
) == word_Code
||
335 towordstyle(text
->type
) == word_WeakCode
) &&
336 (attraux(text
->aux
) == attr_First
||
337 attraux(text
->aux
) == attr_Only
))
339 if (removeattr(text
->type
) == word_Normal
) {
341 quote_props
&= ~QUOTE_INITCTRL
; /* not at start any more */
342 if (man_convert(text
->text
, 0, &c
, quote_props
))
345 man_rdaddwc(rs
, text
->alt
, NULL
, quote_props
);
347 } else if (removeattr(text
->type
) == word_WhiteSpace
) {
349 } else if (removeattr(text
->type
) == word_Quote
) {
351 if (quote_props
& QUOTE_QUOTES
)
354 if (towordstyle(text
->type
) == word_Emph
&&
355 (attraux(text
->aux
) == attr_Last
||
356 attraux(text
->aux
) == attr_Only
))
358 else if ((towordstyle(text
->type
) == word_Code
||
359 towordstyle(text
->type
) == word_WeakCode
) &&
360 (attraux(text
->aux
) == attr_Last
||
361 attraux(text
->aux
) == attr_Only
))
367 static void man_text(FILE *fp
, word
*text
, int newline
, int quote_props
) {
368 rdstringc t
= { 0, 0, NULL
};
370 man_rdaddwc(&t
, text
, NULL
, quote_props
| QUOTE_INITCTRL
);
371 fprintf(fp
, "%s", t
.text
);
377 static void man_codepara(FILE *fp
, word
*text
) {
378 fprintf(fp
, ".nf\n");
379 for (; text
; text
= text
->next
) if (text
->type
== word_WeakCode
) {
382 int quote_props
= QUOTE_INITCTRL
;
385 if (text
->next
&& text
->next
->type
== word_Emph
) {
386 e
= text
->next
->text
;
391 while (e
&& *e
&& *t
) {
395 for (n
= 0; t
[n
] && e
[n
] && e
[n
] == ec
; n
++);
400 man_convert(t
, n
, &c
, quote_props
);
401 quote_props
&= ~QUOTE_INITCTRL
;
402 fprintf(fp
, "%s", c
);
404 if (ec
== 'i' || ec
== 'b')
409 man_convert(t
, 0, &c
, quote_props
);
410 fprintf(fp
, "%s\n", c
);
413 fprintf(fp
, ".fi\n");