=================================================================== RCS file: /cvs/mandoc/Attic/mdoc_action.c,v retrieving revision 1.1 retrieving revision 1.87 diff -u -p -r1.1 -r1.87 --- mandoc/Attic/mdoc_action.c 2009/03/25 15:36:05 1.1 +++ mandoc/Attic/mdoc_action.c 2010/11/30 12:35:10 1.87 @@ -1,90 +1,78 @@ -/* $Id: mdoc_action.c,v 1.1 2009/03/25 15:36:05 kristaps Exp $ */ +/* $Id: mdoc_action.c,v 1.87 2010/11/30 12:35:10 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any - * purpose with or without fee is hereby granted, provided that the - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#ifndef OSNAME #include +#endif #include -#include -#include #include #include #include +#include +#include "mandoc.h" #include "libmdoc.h" +#include "libmandoc.h" -/* - * 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). +#define DATESIZ 32 +/* + * FIXME: this file is deprecated. All future "actions" should be + * pushed into mdoc_validate.c. */ -enum mwarn { - WBADSEC, - WNOWIDTH, - WBADDATE -}; +#define POST_ARGS struct mdoc *m, struct mdoc_node *n +#define PRE_ARGS struct mdoc *m, struct mdoc_node *n -#define PRE_ARGS struct mdoc *m, const struct mdoc_node *n -#define POST_ARGS struct mdoc *m - struct actions { int (*pre)(PRE_ARGS); int (*post)(POST_ARGS); }; -static int pwarn(struct mdoc *, int, int, enum mwarn); +static int concat(struct mdoc *, char *, + const struct mdoc_node *, size_t); -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_dd(POST_ARGS); -static int post_display(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_bd(PRE_ARGS); -static int pre_dl(PRE_ARGS); - -#define mwarn(m, t) pwarn((m), (m)->last->line, (m)->last->pos, (t)) - -const struct actions mdoc_actions[MDOC_MAX] = { - { NULL, NULL }, /* \" */ +static const struct actions mdoc_actions[MDOC_MAX] = { + { NULL, NULL }, /* Ap */ { NULL, post_dd }, /* Dd */ { NULL, post_dt }, /* Dt */ { NULL, post_os }, /* Os */ - { NULL, post_sh }, /* Sh */ + { NULL, NULL }, /* Sh */ { NULL, NULL }, /* Ss */ { NULL, NULL }, /* Pp */ { NULL, NULL }, /* D1 */ - { pre_dl, post_display }, /* Dl */ - { pre_bd, post_display }, /* Bd */ + { NULL, NULL }, /* Dl */ + { NULL, NULL }, /* Bd */ { NULL, NULL }, /* Ed */ - { NULL, post_bl }, /* Bl */ + { NULL, NULL }, /* Bl */ { NULL, NULL }, /* El */ { NULL, NULL }, /* It */ { NULL, NULL }, /* Ad */ { NULL, NULL }, /* An */ - { NULL, post_ar }, /* Ar */ + { NULL, NULL }, /* Ar */ { NULL, NULL }, /* Cd */ { NULL, NULL }, /* Cm */ { NULL, NULL }, /* Dv */ @@ -100,7 +88,7 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* In */ { NULL, NULL }, /* Li */ { NULL, NULL }, /* Nd */ - { NULL, post_nm }, /* Nm */ + { NULL, NULL }, /* Nm */ { NULL, NULL }, /* Op */ { NULL, NULL }, /* Ot */ { NULL, NULL }, /* Pa */ @@ -175,7 +163,6 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* Fr */ { NULL, NULL }, /* Ud */ { NULL, NULL }, /* Lb */ - { NULL, NULL }, /* Ap */ { NULL, NULL }, /* Lp */ { NULL, NULL }, /* Lk */ { NULL, NULL }, /* Mt */ @@ -187,24 +174,29 @@ const struct actions mdoc_actions[MDOC_MAX] = { { NULL, NULL }, /* En */ { NULL, NULL }, /* Dx */ { NULL, NULL }, /* %Q */ + { NULL, NULL }, /* br */ + { NULL, NULL }, /* sp */ + { NULL, NULL }, /* %U */ + { NULL, NULL }, /* Ta */ }; int -mdoc_action_pre(struct mdoc *m, const struct mdoc_node *n) +mdoc_action_pre(struct mdoc *m, struct mdoc_node *n) { switch (n->type) { case (MDOC_ROOT): - break; + /* FALLTHROUGH */ case (MDOC_TEXT): - break; + return(1); default: - if (NULL == mdoc_actions[m->last->tok].pre) - break; - return((*mdoc_actions[m->last->tok].pre)(m, n)); + break; } - return(1); + + if (NULL == mdoc_actions[n->tok].pre) + return(1); + return((*mdoc_actions[n->tok].pre)(m, n)); } @@ -218,134 +210,85 @@ mdoc_action_post(struct mdoc *m) switch (m->last->type) { case (MDOC_TEXT): - break; + /* FALLTHROUGH */ case (MDOC_ROOT): - break; + return(1); default: - if (NULL == mdoc_actions[m->last->tok].post) - break; - return((*mdoc_actions[m->last->tok].post)(m)); - } - return(1); -} - - -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) + if (NULL == mdoc_actions[m->last->tok].post) return(1); - if (m->last->args->argv[0].sz) - return(1); - - assert(m->meta.name); - - m->last->args->argv[0].value = calloc(1, sizeof(char *)); - if (NULL == m->last->args->argv[0].value) - err(1, "calloc"); - - m->last->args->argv[0].sz = 1; - m->last->args->argv[0].value[0] = xstrdup(m->meta.name); - return(1); + return((*mdoc_actions[m->last->tok].post)(m, m->last)); } +/* + * Concatenate sibling nodes together. All siblings must be of type + * MDOC_TEXT or an assertion is raised. Concatenation is separated by a + * single whitespace. + */ static int -post_nm(POST_ARGS) +concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz) { - char buf[64]; - if (m->meta.name) - return(1); + assert(sz); + p[0] = '\0'; + for ( ; n; n = n->next) { + assert(MDOC_TEXT == n->type); + /* + * XXX: yes, these can technically be resized, but it's + * highly unlikely that we're going to get here, so let + * it slip for now. + */ + if (strlcat(p, n->string, sz) >= sz) { + mdoc_nmsg(m, n, MANDOCERR_MEM); + return(0); + } + if (NULL == n->next) + continue; + if (strlcat(p, " ", sz) >= sz) { + mdoc_nmsg(m, n, MANDOCERR_MEM); + return(0); + } + } - (void)xstrlcpys(buf, m->last->child, sizeof(buf)); - m->meta.name = xstrdup(buf); - return(1); } +/* + * Macros accepting `-std' as an argument have the name of the current + * document (`Nm') filled in as the argument if it's not provided. + */ static int -post_sh(POST_ARGS) +post_std(POST_ARGS) { - enum mdoc_sec sec; - char buf[64]; + struct mdoc_node *nn; - /* - * 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) + if (n->child) return(1); + if (NULL == m->meta.name) + return(1); + + nn = n; + m->next = MDOC_NEXT_CHILD; - (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): - /* FALLTHROUGH */ - case (3): - /* FALLTHROUGH */ - case (9): - break; - default: - return(mwarn(m, WBADSEC)); - } - break; - default: - break; - } + if ( ! mdoc_word_alloc(m, n->line, n->pos, m->meta.name)) + return(0); + m->last = nn; return(1); } - +/* + * Parse out the contents of `Dt'. See in-line documentation for how we + * handle the various fields of this macro. + */ static int post_dt(POST_ARGS) { - struct mdoc_node *n; + struct mdoc_node *nn; const char *cp; - char *ep; - long lval; if (m->meta.title) free(m->meta.title); @@ -355,27 +298,32 @@ post_dt(POST_ARGS) free(m->meta.arch); m->meta.title = m->meta.vol = m->meta.arch = NULL; - m->meta.msec = 0; - /* Handles: `.Dt' * --> title = unknown, volume = local, msec = 0, arch = NULL */ - if (NULL == (n = m->last->child)) { - m->meta.title = xstrdup("unknown"); - m->meta.vol = xstrdup("local"); - return(post_prol(m)); + if (NULL == (nn = n->child)) { + /* XXX: make these macro values. */ + /* FIXME: warn about missing values. */ + m->meta.title = mandoc_strdup("UNKNOWN"); + m->meta.vol = mandoc_strdup("LOCAL"); + m->meta.msec = mandoc_strdup("1"); + return(post_prol(m, n)); } /* Handles: `.Dt TITLE' * --> title = TITLE, volume = local, msec = 0, arch = NULL */ - m->meta.title = xstrdup(n->string); + m->meta.title = mandoc_strdup + ('\0' == nn->string[0] ? "UNKNOWN" : nn->string); - if (NULL == (n = n->next)) { - m->meta.vol = xstrdup("local"); - return(post_prol(m)); + if (NULL == (nn = nn->next)) { + /* FIXME: warn about missing msec. */ + /* XXX: make this a macro value. */ + m->meta.vol = mandoc_strdup("LOCAL"); + m->meta.msec = mandoc_strdup("1"); + return(post_prol(m, n)); } /* Handles: `.Dt TITLE SEC' @@ -385,18 +333,18 @@ post_dt(POST_ARGS) * arch = NULL */ - cp = mdoc_a2msec(n->string); + cp = mdoc_a2msec(nn->string); if (cp) { - 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); + m->meta.vol = mandoc_strdup(cp); + m->meta.msec = mandoc_strdup(nn->string); + } else if (mdoc_nmsg(m, n, MANDOCERR_BADMSEC)) { + m->meta.vol = mandoc_strdup(nn->string); + m->meta.msec = mandoc_strdup(nn->string); + } else + return(0); - if (NULL == (n = n->next)) - return(post_prol(m)); + if (NULL == (nn = nn->next)) + return(post_prol(m, n)); /* Handles: `.Dt TITLE SEC VOL' * --> title = TITLE, volume = VOL is vol ? @@ -405,309 +353,120 @@ post_dt(POST_ARGS) * VOL */ - cp = mdoc_a2vol(n->string); + cp = mdoc_a2vol(nn->string); if (cp) { free(m->meta.vol); - m->meta.vol = xstrdup(cp); - n = n->next; + m->meta.vol = mandoc_strdup(cp); } else { - cp = mdoc_a2arch(n->string); + /* FIXME: warn about bad arch. */ + cp = mdoc_a2arch(nn->string); if (NULL == cp) { free(m->meta.vol); - m->meta.vol = xstrdup(n->string); - } else - m->meta.arch = xstrdup(cp); + m->meta.vol = mandoc_strdup(nn->string); + } else + m->meta.arch = mandoc_strdup(cp); } /* Ignore any subsequent parameters... */ + /* FIXME: warn about subsequent parameters. */ - return(post_prol(m)); + return(post_prol(m, n)); } +/* + * Set the operating system by way of the `Os' macro. Note that if an + * argument isn't provided and -DOSNAME="\"foo\"" is provided during + * compilation, this value will be used instead of filling in "sysname + * release" from uname(). + */ static int post_os(POST_ARGS) { - char buf[64]; + char buf[BUFSIZ]; +#ifndef OSNAME struct utsname utsname; +#endif if (m->meta.os) free(m->meta.os); - (void)xstrlcpys(buf, m->last->child, sizeof(buf)); + if ( ! concat(m, buf, n->child, BUFSIZ)) + return(0); - if (0 == buf[0]) { + /* XXX: yes, these can all be dynamically-adjusted buffers, but + * it's really not worth the extra hackery. + */ + + if ('\0' == buf[0]) { +#ifdef OSNAME + if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(m, n, MANDOCERR_MEM); + return(0); + } +#else /*!OSNAME */ 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)); + return(mdoc_nmsg(m, n, MANDOCERR_UTSNAME)); + + if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(m, n, MANDOCERR_MEM); + return(0); + } + if (strlcat(buf, " ", 64) >= BUFSIZ) { + mdoc_nmsg(m, n, MANDOCERR_MEM); + return(0); + } + if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(m, n, MANDOCERR_MEM); + return(0); + } +#endif /*!OSNAME*/ } - m->meta.os = xstrdup(buf); - m->lastnamed = m->lastsec = SEC_BODY; - - return(post_prol(m)); + m->meta.os = mandoc_strdup(buf); + return(post_prol(m, n)); } - /* - * Calculate the -width for a `Bl -tag' list if it hasn't been provided. - * Uses the first head macro. + * Parse the date field in `Dd'. */ static int -post_bl_tagwidth(struct mdoc *m) +post_dd(POST_ARGS) { - struct mdoc_node *n; - int sz; - char buf[32]; + char buf[DATESIZ]; - /* - * Use the text width, if a text node, or the default macro - * width if a macro. - */ - - if ((n = m->last->body->child)) { - assert(MDOC_BLOCK == n->type); - assert(MDOC_It == n->tok); - n = n->head->child; + if (NULL == n->child) { + m->meta.date = time(NULL); + return(post_prol(m, n)); } - sz = 10; /* Default size. */ - - if (n) { - if (MDOC_TEXT != n->type) { - if (0 == (sz = (int)mdoc_macro2len(n->tok))) - if ( ! mwarn(m, WNOWIDTH)) - return(0); - } else - sz = (int)strlen(n->string) + 1; - } - - (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. - */ - - n = m->last; - assert(n->args); - - sz = (int)(n->args->argc)++; - n->args->argv = xrealloc(n->args->argv, - n->args->argc * sizeof(struct mdoc_argv)); - - n->args->argv[sz].arg = MDOC_Width; - n->args->argv[sz].line = m->last->line; - n->args->argv[sz].pos = m->last->pos; - n->args->argv[sz].sz = 1; - n->args->argv[sz].value = calloc(1, sizeof(char *)); - if (NULL == n->args->argv[sz].value) - err(1, "calloc"); - n->args->argv[sz].value[0] = xstrdup(buf); - - return(1); -} - - -static int -post_bl_width(struct mdoc *m) -{ - size_t width; - int i, tok; - char buf[32]; - char *p; - - if (NULL == m->last->args) - return(1); - - for (i = 0; i < (int)m->last->args->argc; i++) - if (MDOC_Width == m->last->args->argv[i].arg) - break; - - if (i == (int)m->last->args->argc) - return(1); - - 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")) - 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)); - - /* 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); - - /* - * 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")) + if ( ! concat(m, buf, n->child, DATESIZ)) 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); -} + m->meta.date = mandoc_a2time + (MTIME_MDOCDATE | MTIME_CANONICAL, buf); - -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)) + if (0 == m->meta.date) { + if ( ! mdoc_nmsg(m, n, MANDOCERR_BADDATE)) return(0); m->meta.date = time(NULL); } - return(post_prol(m)); + return(post_prol(m, n)); } +/* + * Remove prologue macros from the document after they're processed. + * The final document uses mdoc_meta for these values and discards the + * originals. + */ 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); + mdoc_node_delete(m, n); + if (m->meta.title && m->meta.date && m->meta.os) + m->flags |= MDOC_PBODY; return(1); } - - -static int -pre_dl(PRE_ARGS) -{ - - if (MDOC_BODY != n->type) - return(1); - m->flags |= MDOC_LITERAL; - return(1); -} - - -static int -pre_bd(PRE_ARGS) -{ - int i; - - if (MDOC_BODY != n->type) - return(1); - - /* - * 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); -} - -