mdoc_man.c revision 95c635efb7c3b86efc493e0447eaec7aecca3f0f
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore/* $Id: mdoc_man.c,v 1.9 2011/10/24 21:47:59 schwarze Exp $ */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Permission to use, copy, modify, and distribute this software for any
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * purpose with or without fee is hereby granted, provided that the above
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * copyright notice and this permission notice appear in all copies.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore#define DECL_ARGS const struct mdoc_meta *m, \
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const struct mdoc_node *n, \
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore int need_space; /* next word needs prior ws */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore int (*cond)(DECL_ARGS); /* DON'T run actions */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore int (*pre)(DECL_ARGS); /* pre-node action */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore void (*post)(DECL_ARGS); /* post-node action */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const char *prefix; /* pre-node string constant */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const char *suffix; /* post-node string constant */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amorestatic void print_word(struct mman *, const char *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amorestatic const struct manact manacts[MDOC_MAX + 1] = {
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ap, NULL, NULL, NULL }, /* Ap */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_sect, post_sect, ".SH", NULL }, /* Sh */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_sect, post_sect, ".SS", NULL }, /* Ss */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_pp, NULL, NULL, NULL }, /* Pp */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_dl, post_dl, NULL, NULL }, /* D1 */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_dl, post_dl, NULL, NULL }, /* Dl */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_bd, post_bd, NULL, NULL }, /* Bd */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_it, NULL, NULL, NULL }, /* _It */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Ad */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Ar */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Cd */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Cm */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Dv */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Er */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Ev */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore "\\fP\nutility exits 0 on success, and >0 if an error occurs."
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fB-", "\\fP" }, /* Fl */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Ic */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Li */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Pa */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore "\\fP\nfunction returns the value 0 if successful;\n"
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore "otherwise the value -1 is returned and the global\n"
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore "variable \\fIerrno\\fP is set to indicate the error."
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_xr, NULL, NULL, NULL }, /* Xr */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, NULL, post_percent, NULL, NULL }, /* _%A */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, NULL, post_percent, NULL, NULL }, /* _%D */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_percent, "\\fI", "\\fP" }, /* %J */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_percent, "\"", "\"" }, /* %T */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "<", ">" }, /* Ao */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "<", ">" }, /* Aq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "[", "]" }, /* Bo */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "[", "]" }, /* Bq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "BSD/OS", NULL }, /* Bsx */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_bx, NULL, NULL, NULL }, /* Bx */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "``", "''" }, /* Do */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "``", "''" }, /* Dq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Em */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "FreeBSD", NULL }, /* Fx */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Ms */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ns, NULL, NULL, NULL }, /* Ns */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "NetBSD", NULL }, /* Nx */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "OpenBSD", NULL }, /* Ox */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, NULL, post_pf, NULL, NULL }, /* Pf */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "(", ")" }, /* Po */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "(", ")" }, /* Pq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "`", "'" }, /* Ql */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qo */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "\"", "\"" }, /* Qq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_pp, NULL, NULL, NULL }, /* Rs */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "`", "'" }, /* So */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "`", "'" }, /* Sq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fI", "\\fP" }, /* Sx */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fB", "\\fP" }, /* Sy */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_enc, post_enc, "\\fR", "\\fP" }, /* Tn */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "UNIX", NULL }, /* Ux */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "[", "]" }, /* Oo */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "is currently in beta test.", NULL }, /* Bt */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "currently under development.", NULL }, /* Ud */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "{", "}" }, /* Brq */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { cond_body, pre_enc, post_enc, "{", "}" }, /* Bro */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_ux, NULL, "DragonFly", NULL }, /* Dx */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_br, NULL, NULL, NULL }, /* br */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, pre_sp, post_sp, NULL, NULL }, /* sp */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore { NULL, NULL, NULL, NULL, NULL }, /* ROOT */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * If we need a newline, print it now and start afresh.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * If we need a space, only print it before
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * (1) a nonzero length word;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * (2) a word that is non-punctuation; and
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * (3) if punctuation, non-terminating puncutation.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore if (NULL == strchr(".,:;)]?!", s[0]) || '\0' != s[1])
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Reassign needing space if we're not following opening
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * punctuation.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore ('(' != s[0] && '[' != s[0]) || '\0' != s[1];
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore for ( ; *s; s++) {
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore switch (*s) {
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore putchar((unsigned char)*s);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Dump the keep buffer.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * We're guaranteed by now that this exists (is non-NULL).
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Flush stdout afterward, just in case.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore fputs(mparse_getkeep(man_mparse(man)), stdout);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const struct mdoc_meta *m;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore const struct mdoc_node *n;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"",
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Break the line if we were parsed subsequent the current node.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * This makes the page structure be more consistent.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Make sure that we don't happen to start with a
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * control character at the start of a line.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Conditionally run the pre-node action handler for a
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore cond = NULL == act->cond || (*act->cond)(m, n, mm);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Conditionally run all child nodes.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Note that this iterates over children instead of using
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * recursion. This prevents unnecessary depth in the stack.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Lastly, conditionally run the post-node handler.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Output a font encoding before a node, e.g., \fR.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * This obviously has no trailing space.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Output a font encoding subsequent a node, e.g., \fP.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Used in listings (percent = %A, e.g.).
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * FIXME: this is incomplete.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * It doesn't print a nice ", and" for lists.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Print before a section header.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Print subsequent a section header.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore if (MDOC_ELEM != n->type && MDOC_HEAD != n->type)
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore if (MDOC_ELEM != n->type && MDOC_HEAD != n->type)