=================================================================== RCS file: /cvs/mandoc/Attic/action.c,v retrieving revision 1.25 retrieving revision 1.34 diff -u -p -r1.25 -r1.34 --- mandoc/Attic/action.c 2009/02/28 14:43:35 1.25 +++ mandoc/Attic/action.c 2009/03/08 12:40:27 1.34 @@ -1,4 +1,4 @@ -/* $Id: action.c,v 1.25 2009/02/28 14:43:35 kristaps Exp $ */ +/* $Id: action.c,v 1.34 2009/03/08 12:40:27 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -16,7 +16,10 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ +#include + #include +#include #include #include #include @@ -30,25 +33,36 @@ * children have been filled in (post-fix order). */ +enum merr { + ENOWIDTH +}; + +enum mwarn { + WBADSEC, + WNOWIDTH, + WBADDATE +}; + struct actions { int (*post)(struct mdoc *); }; -/* Per-macro action routines. */ - +static int nwarn(struct mdoc *, + const struct mdoc_node *, enum mwarn); +static int nerr(struct mdoc *, + const struct mdoc_node *, enum merr); +static int post_ar(struct mdoc *); static int post_bl(struct mdoc *); static int post_bl_width(struct mdoc *); static int post_bl_tagwidth(struct mdoc *); -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_dt(struct mdoc *); static int post_nm(struct mdoc *); - +static int post_os(struct mdoc *); +static int post_sh(struct mdoc *); +static int post_ex(struct mdoc *); static int post_prologue(struct mdoc *); -/* Array of macro action routines. */ - const struct actions mdoc_actions[MDOC_MAX] = { { NULL }, /* \" */ { post_dd }, /* Dd */ @@ -66,13 +80,13 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL }, /* It */ { NULL }, /* Ad */ { NULL }, /* An */ - { NULL }, /* Ar */ + { post_ar }, /* Ar */ { NULL }, /* Cd */ { NULL }, /* Cm */ { NULL }, /* Dv */ { NULL }, /* Er */ { NULL }, /* Ev */ - { NULL }, /* Ex */ + { post_ex }, /* Ex */ { NULL }, /* Fa */ { NULL }, /* Fd */ { NULL }, /* Fl */ @@ -156,32 +170,99 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL }, /* Hf */ { NULL }, /* Fr */ { NULL }, /* Ud */ + { NULL }, /* Lb */ }; +#define merr(m, t) nerr((m), (m)->last, (t)) static int -post_nm(struct mdoc *mdoc) +nerr(struct mdoc *m, const struct mdoc_node *n, enum merr type) { - char buf[64]; + char *p; - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Nm == mdoc->last->tok); + p = NULL; + switch (type) { + case (ENOWIDTH): + p = "missing width argument"; + break; + } + + assert(p); + return(mdoc_nerr(m, n, p)); +} + + +#define mwarn(m, t) nwarn((m), (m)->last, (t)) +static int +nwarn(struct mdoc *m, const struct mdoc_node *n, 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_nwarn(m, n, c, p)); +} + + +static int +post_ex(struct mdoc *mdoc) +{ + /* - * The `Nm' macro sets the document's name when used the first - * time with an argument. Subsequent calls without a value will - * result in the name value being used. + * If `.Ex -std' is invoked without an argument, fill it in with + * our name (if it's been set). */ - if (mdoc->meta.name) + if (NULL == mdoc->last->args) return(1); + if (mdoc->last->args->argv[0].sz) + return(1); - if (xstrlcats(buf, mdoc->last->child, 64)) { - mdoc->meta.name = xstrdup(buf); + assert(mdoc->meta.name); + + mdoc_msg(mdoc, "writing %s argument: %s", + mdoc_argnames[MDOC_Std], + mdoc->meta.name); + + assert(1 == mdoc->last->args->argv[0].sz); + + mdoc->last->args->argv[0].sz = 1; + mdoc->last->args->argv[0].value = xcalloc(1, sizeof(char *)); + mdoc->last->args->argv[0].value[0] = xstrdup(mdoc->meta.name); + return(1); +} + + +static int +post_nm(struct mdoc *mdoc) +{ + char buf[64]; + + if (mdoc->meta.name) return(1); - } - return(mdoc_err(mdoc, "macro parameters too long")); + (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf)); + mdoc->meta.name = xstrdup(buf); + mdoc_msg(mdoc, "name: %s", mdoc->meta.name); + + return(1); } @@ -199,28 +280,26 @@ post_sh(struct mdoc *mdoc) if (MDOC_HEAD != mdoc->last->type) return(1); - if (xstrlcats(buf, mdoc->last->child, 64)) { - if (SEC_CUSTOM != (sec = mdoc_atosec(buf))) - mdoc->lastnamed = sec; - mdoc->lastsec = sec; - } else - return(mdoc_err(mdoc, "parameters too long")); + (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf)); + if (SEC_CUSTOM != (sec = mdoc_atosec(buf))) + mdoc->lastnamed = sec; + + mdoc->lastsec = sec; + switch (mdoc->lastsec) { case (SEC_RETURN_VALUES): /* FALLTHROUGH */ case (SEC_ERRORS): switch (mdoc->meta.msec) { - case (MSEC_2): + case (2): /* FALLTHROUGH */ - case (MSEC_3): + case (3): /* FALLTHROUGH */ - case (MSEC_9): + case (9): break; default: - return(mdoc_warn(mdoc, WARN_COMPAT, - "inappropriate section for " - "manual section")); + return(mwarn(mdoc, WBADSEC)); } break; default: @@ -233,51 +312,100 @@ post_sh(struct mdoc *mdoc) static int post_dt(struct mdoc *mdoc) { - int i; - char *p; struct mdoc_node *n; + const char *cp; + char *ep; + long lval; - /* - * Prologue title must be parsed into document meta-data. + if (mdoc->meta.title) + free(mdoc->meta.title); + if (mdoc->meta.vol) + free(mdoc->meta.vol); + if (mdoc->meta.arch) + free(mdoc->meta.arch); + + mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL; + mdoc->meta.msec = 0; + + /* Handles: `.Dt' + * --> title = unknown, volume = local, msec = 0, arch = NULL */ - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Dt == mdoc->last->tok); + if (NULL == (n = mdoc->last->child)) { + mdoc->meta.title = xstrdup("unknown"); + mdoc->meta.vol = xstrdup("local"); + mdoc_msg(mdoc, "title: %s", mdoc->meta.title); + mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol); + mdoc_msg(mdoc, "arch: "); + mdoc_msg(mdoc, "msec: "); + return(post_prologue(mdoc)); + } - assert(NULL == mdoc->meta.title); + /* Handles: `.Dt TITLE' + * --> title = TITLE, volume = local, msec = 0, arch = NULL + */ - /* LINTED */ - for (i = 0, n = mdoc->last->child; n; n = n->next, i++) { - assert(MDOC_TEXT == n->type); - p = n->data.text.string; + mdoc->meta.title = xstrdup(n->string); + mdoc_msg(mdoc, "title: %s", mdoc->meta.title); - switch (i) { - case (0): - mdoc->meta.title = xstrdup(p); - break; - case (1): - mdoc->meta.msec = mdoc_atomsec(p); - if (MSEC_DEFAULT != mdoc->meta.msec) - break; - return(mdoc_nerr(mdoc, n, "invalid parameter syntax")); - 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, "invalid parameter syntax")); - default: - return(mdoc_nerr(mdoc, n, "too many parameters")); - } + if (NULL == (n = n->next)) { + mdoc->meta.vol = xstrdup("local"); + mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol); + mdoc_msg(mdoc, "arch: "); + mdoc_msg(mdoc, "msec: %d", mdoc->meta.msec); + return(post_prologue(mdoc)); } - if (NULL == mdoc->meta.title) - mdoc->meta.title = xstrdup("UNTITLED"); + /* Handles: `.Dt TITLE SEC' + * --> title = TITLE, volume = SEC is msec ? + * format(msec) : SEC, + * msec = SEC is msec ? atoi(msec) : 0, + * arch = NULL + */ - mdoc_msg(mdoc, "title: %s", mdoc->meta.title); + if ((cp = mdoc_a2msec(n->string))) { + mdoc->meta.vol = xstrdup(cp); + errno = 0; + lval = strtol(n->string, &ep, 10); + if (n->string[0] != '\0' && *ep == '\0') + mdoc->meta.msec = (int)lval; + } else + mdoc->meta.vol = xstrdup(n->string); + if (NULL == (n = n->next)) { + mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol); + mdoc_msg(mdoc, "arch: "); + mdoc_msg(mdoc, "msec: %d", mdoc->meta.msec); + return(post_prologue(mdoc)); + } + + /* 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(mdoc->meta.vol); + mdoc->meta.vol = xstrdup(cp); + n = n->next; + } else { + cp = mdoc_a2arch(n->string); + if (NULL == cp) { + free(mdoc->meta.vol); + mdoc->meta.vol = xstrdup(n->string); + } else + mdoc->meta.arch = xstrdup(cp); + } + + mdoc_msg(mdoc, "volume: %s", mdoc->meta.vol); + mdoc_msg(mdoc, "arch: %s", mdoc->meta.arch ? + mdoc->meta.arch : ""); + mdoc_msg(mdoc, "msec: %d", mdoc->meta.msec); + + /* Ignore any subsequent parameters... */ + return(post_prologue(mdoc)); } @@ -286,22 +414,26 @@ static int post_os(struct mdoc *mdoc) { char buf[64]; + struct utsname utsname; - /* - * Prologue operating system must be parsed into document - * meta-data. - */ + if (mdoc->meta.os) + free(mdoc->meta.os); - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Os == mdoc->last->tok); - assert(NULL == mdoc->meta.os); + (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf)); - if ( ! xstrlcats(buf, mdoc->last->child, 64)) - return(mdoc_err(mdoc, "macro parameters too long")); + if (0 == buf[0]) { + if (-1 == uname(&utsname)) + return(mdoc_err(mdoc, "utsname")); + (void)xstrlcpy(buf, utsname.sysname, sizeof(buf)); + (void)xstrlcat(buf, " ", sizeof(buf)); + (void)xstrlcat(buf, utsname.release, sizeof(buf)); + } - mdoc->meta.os = xstrdup(buf[0] ? buf : "LOCAL"); - mdoc->lastnamed = SEC_BODY; + mdoc->meta.os = xstrdup(buf); + mdoc_msg(mdoc, "system: %s", mdoc->meta.os); + mdoc->lastnamed = mdoc->lastsec = SEC_BODY; + return(post_prologue(mdoc)); } @@ -310,7 +442,6 @@ static int post_bl_tagwidth(struct mdoc *mdoc) { struct mdoc_node *n; - struct mdoc_block *b; int sz; char buf[32]; @@ -319,30 +450,25 @@ post_bl_tagwidth(struct mdoc *mdoc) * to intuit our width from the first body element. */ - b = &mdoc->last->data.block; - - if (NULL == (n = b->body->child)) + if (NULL == (n = mdoc->last->body->child)) return(1); - assert(MDOC_It == n->tok); /* * Use the text width, if a text node, or the default macro * width if a macro. */ - if ((n = n->data.block.head->child)) { + if ((n = n->head->child)) { if (MDOC_TEXT != n->type) { - if (0 == (sz = mdoc_macro2len(n->tok))) + if (0 == (sz = (int)mdoc_macro2len(n->tok))) sz = -1; } else - sz = (int)strlen(n->data.text.string) + 1; + sz = (int)strlen(n->string) + 1; } else sz = -1; if (-1 == sz) { - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "cannot determine default %s", - mdoc_argnames[MDOC_Width])) + if ( ! mwarn(mdoc, WNOWIDTH)) return(0); sz = 10; } @@ -354,66 +480,75 @@ post_bl_tagwidth(struct mdoc *mdoc) * We're guaranteed that a MDOC_Width doesn't already exist. */ - (b->argc)++; - b->argv = xrealloc(b->argv, b->argc * sizeof(struct mdoc_arg)); + if (NULL == mdoc->last->args) { + mdoc->last->args = xcalloc + (1, sizeof(struct mdoc_arg)); + mdoc->last->args->refcnt = 1; + } - b->argv[b->argc - 1].arg = MDOC_Width; - b->argv[b->argc - 1].line = mdoc->last->line; - b->argv[b->argc - 1].pos = mdoc->last->pos; - b->argv[b->argc - 1].sz = 1; - b->argv[b->argc - 1].value = xcalloc(1, sizeof(char *)); - b->argv[b->argc - 1].value[0] = xstrdup(buf); + n = mdoc->last; + sz = (int)n->args->argc; + + (n->args->argc)++; - mdoc_msg(mdoc, "adding %s argument: %dn", - mdoc_argnames[MDOC_Width], sz); + 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 = mdoc->last->line; + n->args->argv[sz - 1].pos = mdoc->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); + + mdoc_msg(mdoc, "adding %s argument: %s", + mdoc_argnames[MDOC_Width], buf); + return(1); } static int -post_bl_width(struct mdoc *mdoc) +post_bl_width(struct mdoc *m) { size_t width; int i, tok; char buf[32]; - char **p; + char *p; - for (i = 0; i < (int)mdoc->last->data.block.argc; i++) - if (MDOC_Width == mdoc->last->data.block.argv[i].arg) + if (NULL == m->last->args) + return(merr(m, ENOWIDTH)); + + for (i = 0; i < (int)m->last->args->argc; i++) + if (MDOC_Width == m->last->args->argv[i].arg) break; - assert(i < (int)mdoc->last->data.block.argc); - assert(1 == mdoc->last->data.block.argv[i].sz); - p = &mdoc->last->data.block.argv[i].value[0]; + if (i == (int)m->last->args->argc) + return(merr(m, ENOWIDTH)); + p = m->last->args->argv[i].value[0]; + /* * 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 (xstrcmp(*p, "Ds")) { - if ( ! mdoc_warn(mdoc, WARN_COMPAT, - "%s argument deprecated", - mdoc_argnames[MDOC_Width])) - return(0); - width = 6; - } else if (MDOC_MAX == (tok = mdoc_find(mdoc, *p))) + 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(mdoc_warn(mdoc, WARN_SYNTAX, - "%s macro has no length", - mdoc_argnames[MDOC_Width])); + return(mwarn(m, WNOWIDTH)); - mdoc_msg(mdoc, "re-writing %s argument: %s -> %zun", - mdoc_argnames[MDOC_Width], *p, width); + mdoc_msg(m, "re-writing %s argument: %s -> %zun", + mdoc_argnames[MDOC_Width], p, width); /* The value already exists: free and reallocate it. */ (void)snprintf(buf, sizeof(buf), "%zun", width); - free(*p); - *p = strdup(buf); + free(m->last->args->argv[i].value[0]); + m->last->args->argv[i].value[0] = xstrdup(buf); return(1); } @@ -422,7 +557,7 @@ post_bl_width(struct mdoc *mdoc) static int post_bl(struct mdoc *mdoc) { - int i, r; + int i, r, len; if (MDOC_BLOCK != mdoc->last->type) return(1); @@ -435,10 +570,12 @@ post_bl(struct mdoc *mdoc) * rewritten into real lengths). */ - for (r = i = 0; i < (int)mdoc->last->data.block.argc; i++) { - if (MDOC_Tag == mdoc->last->data.block.argv[i].arg) + len = (int)(mdoc->last->args ? mdoc->last->args->argc : 0); + + for (r = i = 0; i < len; i++) { + if (MDOC_Tag == mdoc->last->args->argv[i].arg) r |= 1 << 0; - if (MDOC_Width == mdoc->last->data.block.argv[i].arg) + if (MDOC_Width == mdoc->last->args->argv[i].arg) r |= 1 << 1; } @@ -454,28 +591,44 @@ post_bl(struct mdoc *mdoc) static int -post_dd(struct mdoc *mdoc) +post_ar(struct mdoc *mdoc) { - char buf[64]; + struct mdoc_node *n; - /* - * Prologue date must be parsed into document meta-data. We - * accept multiple kinds of dates, described mostly in - * mdoc_atotime(). - */ + if (mdoc->last->child) + return(1); + + n = mdoc->last; - assert(MDOC_ELEM == mdoc->last->type); - assert(MDOC_Dd == mdoc->last->tok); + mdoc->next = MDOC_NEXT_CHILD; + if ( ! mdoc_word_alloc(mdoc, mdoc->last->line, + mdoc->last->pos, "file")) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + if ( ! mdoc_word_alloc(mdoc, mdoc->last->line, + mdoc->last->pos, "...")) + return(0); - assert(0 == mdoc->meta.date); + mdoc->last = n; + mdoc->next = MDOC_NEXT_SIBLING; + return(1); +} - if ( ! xstrlcats(buf, mdoc->last->child, 64)) - return(mdoc_err(mdoc, "macro parameters too long")); - if (0 == (mdoc->meta.date = mdoc_atotime(buf))) - return(mdoc_err(mdoc, "invalid parameter syntax")); - mdoc_msg(mdoc, "date: %u", mdoc->meta.date); +static int +post_dd(struct mdoc *mdoc) +{ + char buf[64]; + (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf)); + + if (0 == (mdoc->meta.date = mdoc_atotime(buf))) { + if ( ! mwarn(mdoc, WBADDATE)) + return(0); + mdoc->meta.date = time(NULL); + } + + mdoc_msg(mdoc, "date: %u", mdoc->meta.date); return(post_prologue(mdoc)); }