=================================================================== RCS file: /cvs/mandoc/Attic/action.c,v retrieving revision 1.9 retrieving revision 1.44 diff -u -p -r1.9 -r1.44 --- mandoc/Attic/action.c 2009/01/16 12:23:25 1.9 +++ mandoc/Attic/action.c 2009/03/20 15:14:01 1.44 @@ -1,6 +1,6 @@ -/* $Id: action.c,v 1.9 2009/01/16 12:23:25 kristaps Exp $ */ +/* $Id: action.c,v 1.44 2009/03/20 15:14:01 kristaps Exp $ */ /* - * Copyright (c) 2008 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the @@ -16,28 +16,61 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ +#include + #include +#include +#include #include -#include +#include #include "private.h" -typedef int (*a_pre)(struct mdoc *, struct mdoc_node *); -typedef int (*a_post)(struct mdoc *); +/* + * Actions are executed on macros after they've been post-validated: in + * other words, a macro will not be "acted upon" until all of its + * children have been filled in (post-fix order). + */ +enum merr { + ENOWIDTH +}; +enum mwarn { + WBADSEC, + WNOWIDTH, + WBADDATE +}; + +#define PRE_ARGS struct mdoc *m, const struct mdoc_node *n +#define POST_ARGS struct mdoc *m + struct actions { - a_pre pre; - a_post post; + int (*pre)(PRE_ARGS); + int (*post)(POST_ARGS); }; +static int pwarn(struct mdoc *, int, int, enum mwarn); +static int perr(struct mdoc *, int, int, enum merr); -static int post_sh(struct mdoc *); -static int post_os(struct mdoc *); -static int post_dt(struct mdoc *); -static int post_dd(struct mdoc *); +static int post_ar(POST_ARGS); +static int post_bl(POST_ARGS); +static int post_bl_width(POST_ARGS); +static int post_bl_tagwidth(POST_ARGS); +static int post_display(POST_ARGS); +static int post_dd(POST_ARGS); +static int post_dt(POST_ARGS); +static int post_nm(POST_ARGS); +static int post_os(POST_ARGS); +static int post_prol(POST_ARGS); +static int post_sh(POST_ARGS); +static int post_std(POST_ARGS); +static int pre_display(PRE_ARGS); +#define merr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t)) +#define mwarn(m, t) pwarn((m), (m)->last->line, (m)->last->pos, (t)) + const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* \" */ { NULL, post_dd }, /* Dd */ @@ -47,21 +80,21 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* Ss */ { NULL, NULL }, /* Pp */ { NULL, NULL }, /* D1 */ - { NULL, NULL }, /* Dl */ - { NULL, NULL }, /* Bd */ + { pre_display, post_display }, /* Dl */ + { pre_display, post_display }, /* Bd */ { NULL, NULL }, /* Ed */ - { NULL, NULL }, /* Bl */ + { NULL, post_bl }, /* Bl */ { NULL, NULL }, /* El */ { NULL, NULL }, /* It */ { NULL, NULL }, /* Ad */ { NULL, NULL }, /* An */ - { NULL, NULL }, /* Ar */ + { NULL, post_ar }, /* Ar */ { NULL, NULL }, /* Cd */ { NULL, NULL }, /* Cm */ { NULL, NULL }, /* Dv */ { NULL, NULL }, /* Er */ { NULL, NULL }, /* Ev */ - { NULL, NULL }, /* Ex */ + { NULL, post_std }, /* Ex */ { NULL, NULL }, /* Fa */ { NULL, NULL }, /* Fd */ { NULL, NULL }, /* Fl */ @@ -71,11 +104,11 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* In */ { NULL, NULL }, /* Li */ { NULL, NULL }, /* Nd */ - { NULL, NULL }, /* Nm */ + { NULL, post_nm }, /* Nm */ { NULL, NULL }, /* Op */ { NULL, NULL }, /* Ot */ { NULL, NULL }, /* Pa */ - { NULL, NULL }, /* Rv */ + { NULL, post_std }, /* Rv */ { NULL, NULL }, /* St */ { NULL, NULL }, /* Va */ { NULL, NULL }, /* Vt */ @@ -145,193 +178,547 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ { NULL, NULL }, /* Ud */ + { NULL, NULL }, /* Lb */ + { NULL, NULL }, /* Ap */ + { NULL, NULL }, /* Lp */ + { NULL, NULL }, /* Lk */ + { NULL, NULL }, /* Mt */ + { NULL, NULL }, /* Brq */ + { NULL, NULL }, /* Bro */ + { NULL, NULL }, /* Brc */ + { NULL, NULL }, /* %C */ + { NULL, NULL }, /* Es */ + { NULL, NULL }, /* En */ + { NULL, NULL }, /* Dx */ }; -static int -post_sh(struct mdoc *mdoc) +int +mdoc_action_pre(struct mdoc *m, const struct mdoc_node *n) { - enum mdoc_sec sec; - int i; - struct mdoc_node *n; - char *args[MDOC_LINEARG_MAX]; - if (MDOC_HEAD != mdoc->last->type) + switch (n->type) { + case (MDOC_ROOT): + break; + case (MDOC_TEXT): + break; + default: + if (NULL == mdoc_actions[m->last->tok].pre) + break; + return((*mdoc_actions[m->last->tok].pre)(m, n)); + } + return(1); +} + + +int +mdoc_action_post(struct mdoc *m) +{ + + if (MDOC_ACTED & m->last->flags) return(1); - - assert(MDOC_Sh == mdoc->last->tok); + m->last->flags |= MDOC_ACTED; - n = mdoc->last->child; - assert(n); + switch (m->last->type) { + case (MDOC_TEXT): + break; + case (MDOC_ROOT): + break; + default: + if (NULL == mdoc_actions[m->last->tok].post) + break; + return((*mdoc_actions[m->last->tok].post)(m)); + } + return(1); +} - for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) { - assert(MDOC_TEXT == n->type); - assert(NULL == n->child); - assert(n->data.text.string); - args[i] = n->data.text.string; + +static int +perr(struct mdoc *m, int line, int pos, enum merr type) +{ + char *p; + + p = NULL; + + switch (type) { + case (ENOWIDTH): + p = "missing width argument"; + break; } - sec = mdoc_atosec((size_t)i, (const char **)args); - if (SEC_CUSTOM != sec) - mdoc->sec_lastn = sec; - mdoc->sec_last = sec; + assert(p); + return(mdoc_perr(m, line, pos, p)); +} + +static int +pwarn(struct mdoc *m, int line, int pos, enum mwarn type) +{ + char *p; + int c; + + p = NULL; + c = WARN_SYNTAX; + + switch (type) { + case (WBADSEC): + p = "inappropriate document section in manual section"; + c = WARN_COMPAT; + break; + case (WNOWIDTH): + p = "cannot determine default width"; + break; + case (WBADDATE): + p = "malformed date syntax"; + break; + } + + assert(p); + return(mdoc_pwarn(m, line, pos, c, p)); +} + + +static int +post_std(POST_ARGS) +{ + + /* + * If '-std' is invoked without an argument, fill it in with our + * name (if it's been set). + */ + + if (NULL == m->last->args) + return(1); + if (m->last->args->argv[0].sz) + return(1); + + assert(m->meta.name); + + m->last->args->argv[0].value = xcalloc(1, sizeof(char *)); + m->last->args->argv[0].sz = 1; + m->last->args->argv[0].value[0] = xstrdup(m->meta.name); return(1); } static int -post_dt(struct mdoc *mdoc) +post_nm(POST_ARGS) { - int i; - char *p; - size_t sz; - struct mdoc_node *n; + char buf[64]; - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Dt == mdoc->last->tok); - assert(0 == mdoc->meta.title[0]); + if (m->meta.name) + return(1); - sz = META_TITLE_SZ; - (void)xstrlcpy(mdoc->meta.title, "UNTITLED", sz); + (void)xstrlcpys(buf, m->last->child, sizeof(buf)); + m->meta.name = xstrdup(buf); - for (i = 0, n = mdoc->last->child; n; n = n->next, i++) { - assert(MDOC_TEXT == n->type); - p = n->data.text.string; + return(1); +} - switch (i) { - case (0): - if (xstrlcpy(mdoc->meta.title, p, sz)) - break; - return(mdoc_nerr(mdoc, n, "badly-formed manual title parameter")); - case (1): - mdoc->meta.msec = mdoc_atomsec(p); - if (MSEC_DEFAULT != mdoc->meta.msec) - break; - return(mdoc_nerr(mdoc, n, "badly-formed manual section parameter")); + +static int +post_sh(POST_ARGS) +{ + enum mdoc_sec sec; + char buf[64]; + + /* + * We keep track of the current section /and/ the "named" + * section, which is one of the conventional ones, in order to + * check ordering. + */ + + if (MDOC_HEAD != m->last->type) + return(1); + + (void)xstrlcpys(buf, m->last->child, sizeof(buf)); + if (SEC_CUSTOM != (sec = mdoc_atosec(buf))) + m->lastnamed = sec; + + switch ((m->lastsec = sec)) { + case (SEC_RETURN_VALUES): + /* FALLTHROUGH */ + case (SEC_ERRORS): + switch (m->meta.msec) { case (2): - mdoc->meta.vol = mdoc_atovol(p); - if (VOL_DEFAULT != mdoc->meta.vol) - break; - mdoc->meta.arch = mdoc_atoarch(p); - if (ARCH_DEFAULT != mdoc->meta.arch) - break; - return(mdoc_nerr(mdoc, n, "badly-formed manual volume parameter")); + /* FALLTHROUGH */ + case (3): + /* FALLTHROUGH */ + case (9): + break; default: - return(mdoc_nerr(mdoc, n, "too many parameters")); + return(mwarn(m, WBADSEC)); } + break; + default: + break; } - - mdoc_msg(mdoc, "parsed title: %s", mdoc->meta.title); - /* TODO: print vol2a functions. */ return(1); } static int -post_os(struct mdoc *mdoc) +post_dt(POST_ARGS) { - char *p; - size_t sz; struct mdoc_node *n; + const char *cp; + char *ep; + long lval; - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Os == mdoc->last->tok); - assert(0 == mdoc->meta.os[0]); + if (m->meta.title) + free(m->meta.title); + if (m->meta.vol) + free(m->meta.vol); + if (m->meta.arch) + free(m->meta.arch); - sz = META_OS_SZ; + m->meta.title = m->meta.vol = m->meta.arch = NULL; + m->meta.msec = 0; - for (n = mdoc->last->child; n; n = n->next) { - assert(MDOC_TEXT == n->type); - p = n->data.text.string; + /* Handles: `.Dt' + * --> title = unknown, volume = local, msec = 0, arch = NULL + */ - if ( ! xstrlcat(mdoc->meta.os, p, sz)) - return(mdoc_nerr(mdoc, n, "badly-formed manual system parameter")); - if ( ! xstrlcat(mdoc->meta.os, " ", sz)) - return(mdoc_nerr(mdoc, n, "badly-formed manual system parameter")); + if (NULL == (n = m->last->child)) { + m->meta.title = xstrdup("unknown"); + m->meta.vol = xstrdup("local"); + return(post_prol(m)); } - if (0 == mdoc->meta.os[0]) - (void)xstrlcpy(mdoc->meta.os, "LOCAL", sz); + /* Handles: `.Dt TITLE' + * --> title = TITLE, volume = local, msec = 0, arch = NULL + */ - mdoc_msg(mdoc, "parsed operating system: %s", mdoc->meta.os); - mdoc->sec_lastn = mdoc->sec_last = SEC_BODY; + m->meta.title = xstrdup(n->string); + + if (NULL == (n = n->next)) { + m->meta.vol = xstrdup("local"); + return(post_prol(m)); + } + + /* Handles: `.Dt TITLE SEC' + * --> title = TITLE, volume = SEC is msec ? + * format(msec) : SEC, + * msec = SEC is msec ? atoi(msec) : 0, + * arch = NULL + */ + + if ((cp = mdoc_a2msec(n->string))) { + m->meta.vol = xstrdup(cp); + errno = 0; + lval = strtol(n->string, &ep, 10); + if (n->string[0] != '\0' && *ep == '\0') + m->meta.msec = (int)lval; + } else + m->meta.vol = xstrdup(n->string); + + if (NULL == (n = n->next)) + return(post_prol(m)); + + /* Handles: `.Dt TITLE SEC VOL' + * --> title = TITLE, volume = VOL is vol ? + * format(VOL) : + * VOL is arch ? format(arch) : + * VOL + */ + + if ((cp = mdoc_a2vol(n->string))) { + free(m->meta.vol); + m->meta.vol = xstrdup(cp); + n = n->next; + } else { + cp = mdoc_a2arch(n->string); + if (NULL == cp) { + free(m->meta.vol); + m->meta.vol = xstrdup(n->string); + } else + m->meta.arch = xstrdup(cp); + } + + /* Ignore any subsequent parameters... */ + + return(post_prol(m)); +} + + +static int +post_os(POST_ARGS) +{ + char buf[64]; + struct utsname utsname; + + if (m->meta.os) + free(m->meta.os); + + (void)xstrlcpys(buf, m->last->child, sizeof(buf)); + + if (0 == buf[0]) { + if (-1 == uname(&utsname)) + return(mdoc_err(m, "utsname")); + (void)xstrlcpy(buf, utsname.sysname, sizeof(buf)); + (void)xstrlcat(buf, " ", sizeof(buf)); + (void)xstrlcat(buf, utsname.release, sizeof(buf)); + } + + m->meta.os = xstrdup(buf); + m->lastnamed = m->lastsec = SEC_BODY; + + return(post_prol(m)); +} + + +static int +post_bl_tagwidth(struct mdoc *m) +{ + struct mdoc_node *n; + int sz; + char buf[32]; + + /* + * If -tag has been specified and -width has not been, then try + * to intuit our width from the first body element. + */ + + if (NULL == (n = m->last->body->child)) + return(1); + + /* + * Use the text width, if a text node, or the default macro + * width if a macro. + */ + + if ((n = n->head->child)) { + if (MDOC_TEXT != n->type) { + if (0 == (sz = (int)mdoc_macro2len(n->tok))) + sz = -1; + } else + sz = (int)strlen(n->string) + 1; + } else + sz = -1; + + if (-1 == sz) { + if ( ! mwarn(m, WNOWIDTH)) + return(0); + sz = 10; + } + + (void)snprintf(buf, sizeof(buf), "%dn", sz); + + /* + * We have to dynamically add this to the macro's argument list. + * We're guaranteed that a MDOC_Width doesn't already exist. + */ + + if (NULL == m->last->args) { + m->last->args = xcalloc + (1, sizeof(struct mdoc_arg)); + m->last->args->refcnt = 1; + } + + n = m->last; + sz = (int)n->args->argc; + + (n->args->argc)++; + + n->args->argv = xrealloc(n->args->argv, + n->args->argc * sizeof(struct mdoc_arg)); + + n->args->argv[sz - 1].arg = MDOC_Width; + n->args->argv[sz - 1].line = m->last->line; + n->args->argv[sz - 1].pos = m->last->pos; + n->args->argv[sz - 1].sz = 1; + n->args->argv[sz - 1].value = xcalloc(1, sizeof(char *)); + n->args->argv[sz - 1].value[0] = xstrdup(buf); + return(1); } static int -post_dd(struct mdoc *mdoc) +post_bl_width(struct mdoc *m) { - char date[64]; - size_t sz; + size_t width; + int i, tok; + char buf[32]; char *p; - struct mdoc_node *n; - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Dd == mdoc->last->tok); + if (NULL == m->last->args) + return(merr(m, ENOWIDTH)); - n = mdoc->last->child; - assert(0 == mdoc->meta.date); - date[0] = 0; + for (i = 0; i < (int)m->last->args->argc; i++) + if (MDOC_Width == m->last->args->argv[i].arg) + break; - sz = 64; + if (i == (int)m->last->args->argc) + return(merr(m, ENOWIDTH)); - for ( ; 0 == mdoc->meta.date && n; n = n->next) { - assert(MDOC_TEXT == n->type); - p = n->data.text.string; + p = m->last->args->argv[i].value[0]; - if (xstrcmp(p, "$Mdocdate: January 16 2009 $")) { - mdoc->meta.date = time(NULL); - continue; - } else if (xstrcmp(p, "$")) { - mdoc->meta.date = mdoc_atotime(date); - continue; - } else if (xstrcmp(p, "$Mdocdate:")) - continue; + /* + * If the value to -width is a macro, then we re-write it to be + * the macro's width as set in share/tmac/mdoc/doc-common. + */ - if ( ! xstrlcat(date, n->data.text.string, sz)) - return(mdoc_nerr(mdoc, n, "badly-formed manual date parameter")); - if (n->next && ! xstrlcat(date, " ", sz)) - return(mdoc_nerr(mdoc, n, "badly-formed manual date parameter")); - } + if (xstrcmp(p, "Ds")) + width = 8; + else if (MDOC_MAX == (tok = mdoc_tokhash_find(m->htab, p))) + return(1); + else if (0 == (width = mdoc_macro2len(tok))) + return(mwarn(m, WNOWIDTH)); - if (mdoc->meta.date && NULL == n) { - mdoc_msg(mdoc, "parsed time: %u since epoch", - mdoc->meta.date); + /* The value already exists: free and reallocate it. */ + + (void)snprintf(buf, sizeof(buf), "%zun", width); + + free(m->last->args->argv[i].value[0]); + m->last->args->argv[i].value[0] = xstrdup(buf); + + return(1); +} + + +static int +post_bl(POST_ARGS) +{ + int i, r, len; + + if (MDOC_BLOCK != m->last->type) return(1); - } else if (n) - return(mdoc_err(mdoc, "badly-formed manual date")); - if ((mdoc->meta.date = mdoc_atotime(date))) { - mdoc_msg(mdoc, "parsed time: %u since epoch", - mdoc->meta.date); + /* + * These are fairly complicated, so we've broken them into two + * functions. post_bl_tagwidth() is called when a -tag is + * specified, but no -width (it must be guessed). The second + * when a -width is specified (macro indicators must be + * rewritten into real lengths). + */ + + len = (int)(m->last->args ? m->last->args->argc : 0); + + for (r = i = 0; i < len; i++) { + if (MDOC_Tag == m->last->args->argv[i].arg) + r |= 1 << 0; + if (MDOC_Width == m->last->args->argv[i].arg) + r |= 1 << 1; + } + + if (r & (1 << 0) && ! (r & (1 << 1))) { + if ( ! post_bl_tagwidth(m)) + return(0); + } else if (r & (1 << 1)) + if ( ! post_bl_width(m)) + return(0); + + return(1); +} + + +static int +post_ar(POST_ARGS) +{ + struct mdoc_node *n; + + if (m->last->child) return(1); + + n = m->last; + m->next = MDOC_NEXT_CHILD; + if ( ! mdoc_word_alloc(m, m->last->line, + m->last->pos, "file")) + return(0); + m->next = MDOC_NEXT_SIBLING; + if ( ! mdoc_word_alloc(m, m->last->line, + m->last->pos, "...")) + return(0); + + m->last = n; + m->next = MDOC_NEXT_SIBLING; + return(1); +} + + +static int +post_dd(POST_ARGS) +{ + char buf[64]; + + (void)xstrlcpys(buf, m->last->child, sizeof(buf)); + + if (0 == (m->meta.date = mdoc_atotime(buf))) { + if ( ! mwarn(m, WBADDATE)) + return(0); + m->meta.date = time(NULL); } - return(mdoc_err(mdoc, "badly-formed manual date")); + return(post_prol(m)); } -int -mdoc_action_pre(struct mdoc *mdoc, struct mdoc_node *node) +static int +post_prol(POST_ARGS) { + struct mdoc_node *n; + /* + * The end document shouldn't have the prologue macros as part + * of the syntax tree (they encompass only meta-data). + */ + + if (m->last->parent->child == m->last) + m->last->parent->child = m->last->prev; + if (m->last->prev) + m->last->prev->next = NULL; + + n = m->last; + assert(NULL == m->last->next); + + if (m->last->prev) { + m->last = m->last->prev; + m->next = MDOC_NEXT_SIBLING; + } else { + m->last = m->last->parent; + m->next = MDOC_NEXT_CHILD; + } + + mdoc_node_freelist(n); return(1); } -int -mdoc_action_post(struct mdoc *mdoc) +static int +pre_display(PRE_ARGS) { + int i; - if (MDOC_TEXT == mdoc->last->type) + if (MDOC_BODY != n->type) return(1); - if (MDOC_ROOT == mdoc->last->type) - return(1); - if (NULL == mdoc_actions[mdoc->last->tok].post) - return(1); - /* TODO: MDOC_Nm... ? */ - return((*mdoc_actions[mdoc->last->tok].post)(mdoc)); + /* + * We ONLY enter a literal context if `Bd -literal' or `Bd + * -unfilled'. + */ + + n = n->parent; + for (i = 0; i < (int)n->args->argc; i++) + if (MDOC_Literal == n->args->argv[i].arg) + break; + else if (MDOC_Unfilled == n->args->argv[i].arg) + break; + + if (i < (int)n->args->argc) + m->flags |= MDOC_LITERAL; + + return(1); } + + +static int +post_display(POST_ARGS) +{ + + if (MDOC_BODY == m->last->type) + m->flags &= ~MDOC_LITERAL; + return(1); +} + +