=================================================================== RCS file: /cvs/mandoc/mdoc_validate.c,v retrieving revision 1.129 retrieving revision 1.134 diff -u -p -r1.129 -r1.134 --- mandoc/mdoc_validate.c 2010/11/29 16:06:46 1.129 +++ mandoc/mdoc_validate.c 2010/12/01 13:05:13 1.134 @@ -1,4 +1,4 @@ -/* $Id: mdoc_validate.c,v 1.129 2010/11/29 16:06:46 kristaps Exp $ */ +/* $Id: mdoc_validate.c,v 1.134 2010/12/01 13:05:13 kristaps Exp $ */ /* * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons * @@ -18,6 +18,10 @@ #include "config.h" #endif +#ifndef OSNAME +#include +#endif + #include #include @@ -26,6 +30,7 @@ #include #include #include +#include #include "mandoc.h" #include "libmdoc.h" @@ -36,6 +41,9 @@ #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n #define POST_ARGS struct mdoc *mdoc +#define NUMSIZ 32 +#define DATESIZ 32 + enum check_ineq { CHECK_LT, CHECK_GT, @@ -59,12 +67,14 @@ struct valids { static int check_count(struct mdoc *, enum mdoc_type, enum check_lvl, enum check_ineq, int); static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type); -static int check_stdarg(PRE_ARGS); -static int check_text(struct mdoc *, int, int, char *); -static int check_argv(struct mdoc *, +static void check_text(struct mdoc *, int, int, char *); +static void check_argv(struct mdoc *, struct mdoc_node *, struct mdoc_argv *); -static int check_args(struct mdoc *, struct mdoc_node *); +static void check_args(struct mdoc *, struct mdoc_node *); +static int concat(struct mdoc *, char *, + const struct mdoc_node *, size_t); + static int ebool(POST_ARGS); static int berr_ge1(POST_ARGS); static int bwarn_ge1(POST_ARGS); @@ -84,20 +94,27 @@ static int post_an(POST_ARGS); static int post_at(POST_ARGS); static int post_bf(POST_ARGS); static int post_bl(POST_ARGS); +static int post_bl_block(POST_ARGS); +static int post_bl_block_width(POST_ARGS); +static int post_bl_block_tag(POST_ARGS); static int post_bl_head(POST_ARGS); +static int post_dd(POST_ARGS); +static int post_dt(POST_ARGS); static int post_defaults(POST_ARGS); static int post_literal(POST_ARGS); static int post_eoln(POST_ARGS); -static int post_dt(POST_ARGS); static int post_it(POST_ARGS); static int post_lb(POST_ARGS); static int post_nm(POST_ARGS); +static int post_os(POST_ARGS); +static int post_prol(POST_ARGS); static int post_root(POST_ARGS); static int post_rs(POST_ARGS); static int post_sh(POST_ARGS); static int post_sh_body(POST_ARGS); static int post_sh_head(POST_ARGS); static int post_st(POST_ARGS); +static int post_std(POST_ARGS); static int post_vt(POST_ARGS); static int pre_an(PRE_ARGS); static int pre_bd(PRE_ARGS); @@ -109,9 +126,9 @@ static int pre_it(PRE_ARGS); static int pre_literal(PRE_ARGS); static int pre_os(PRE_ARGS); static int pre_par(PRE_ARGS); -static int pre_rv(PRE_ARGS); static int pre_sh(PRE_ARGS); static int pre_ss(PRE_ARGS); +static int pre_std(PRE_ARGS); static v_post posts_an[] = { post_an, NULL }; static v_post posts_at[] = { post_at, post_defaults, NULL }; @@ -122,19 +139,22 @@ static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL static v_post posts_bool[] = { eerr_eq1, ebool, NULL }; static v_post posts_eoln[] = { post_eoln, NULL }; static v_post posts_defaults[] = { post_defaults, NULL }; +static v_post posts_dd[] = { ewarn_ge1, post_dd, post_prol, NULL }; static v_post posts_dl[] = { post_literal, bwarn_ge1, herr_eq0, NULL }; -static v_post posts_dt[] = { post_dt, NULL }; +static v_post posts_dt[] = { post_dt, post_prol, NULL }; static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL }; static v_post posts_it[] = { post_it, NULL }; static v_post posts_lb[] = { eerr_eq1, post_lb, NULL }; static v_post posts_nd[] = { berr_ge1, NULL }; static v_post posts_nm[] = { post_nm, NULL }; static v_post posts_notext[] = { ewarn_eq0, NULL }; +static v_post posts_os[] = { post_os, post_prol, NULL }; static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL }; static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; static v_post posts_sp[] = { eerr_le1, NULL }; static v_post posts_ss[] = { herr_ge1, NULL }; static v_post posts_st[] = { eerr_eq1, post_st, NULL }; +static v_post posts_std[] = { post_std, NULL }; static v_post posts_text[] = { eerr_ge1, NULL }; static v_post posts_text1[] = { eerr_eq1, NULL }; static v_post posts_vt[] = { post_vt, NULL }; @@ -148,20 +168,19 @@ static v_pre pres_dl[] = { pre_literal, pre_display, static v_pre pres_dd[] = { pre_dd, NULL }; static v_pre pres_dt[] = { pre_dt, NULL }; static v_pre pres_er[] = { NULL, NULL }; -static v_pre pres_ex[] = { NULL, NULL }; static v_pre pres_fd[] = { NULL, NULL }; static v_pre pres_it[] = { pre_it, NULL }; static v_pre pres_os[] = { pre_os, NULL }; static v_pre pres_pp[] = { pre_par, NULL }; -static v_pre pres_rv[] = { pre_rv, NULL }; static v_pre pres_sh[] = { pre_sh, NULL }; static v_pre pres_ss[] = { pre_ss, NULL }; +static v_pre pres_std[] = { pre_std, NULL }; const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ap */ - { pres_dd, posts_wtext }, /* Dd */ + { pres_dd, posts_dd }, /* Dd */ { pres_dt, posts_dt }, /* Dt */ - { pres_os, NULL }, /* Os */ + { pres_os, posts_os }, /* Os */ { pres_sh, posts_sh }, /* Sh */ { pres_ss, posts_ss }, /* Ss */ { pres_pp, posts_notext }, /* Pp */ @@ -180,7 +199,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Dv */ { pres_er, posts_text }, /* Er */ { NULL, NULL }, /* Ev */ - { pres_ex, NULL }, /* Ex */ + { pres_std, posts_std }, /* Ex */ { NULL, NULL }, /* Fa */ { pres_fd, posts_wtext }, /* Fd */ { NULL, NULL }, /* Fl */ @@ -194,7 +213,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, posts_wline }, /* Op */ { NULL, NULL }, /* Ot */ { NULL, posts_defaults }, /* Pa */ - { pres_rv, NULL }, /* Rv */ + { pres_std, posts_std }, /* Rv */ { NULL, posts_st }, /* St */ { NULL, NULL }, /* Va */ { NULL, posts_vt }, /* Vt */ @@ -313,11 +332,12 @@ mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) tp = n->string; line = n->line; pos = n->pos; - return(check_text(mdoc, line, pos, tp)); + check_text(mdoc, line, pos, tp); + return(1); } - if ( ! check_args(mdoc, n)) - return(0); + check_args(mdoc, n); + if (NULL == mdoc_valids[n->tok].pre) return(1); for (p = mdoc_valids[n->tok].pre; *p; p++) @@ -375,6 +395,9 @@ check_count(struct mdoc *m, enum mdoc_type type, if (val == m->last->nchild) return(1); break; + default: + abort(); + /* NOTREACHED */ } if (CHECK_WARN == lvl) { @@ -384,6 +407,8 @@ check_count(struct mdoc *m, enum mdoc_type type, p, val, m->last->nchild)); } + /* FIXME: THIS IS THE SAME AS THE ABOVE. */ + return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT, m->last->line, m->last->pos, "require %s%d children (have %d)", @@ -469,56 +494,35 @@ hwarn_le1(POST_ARGS) return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_LT, 2)); } - -static int -check_stdarg(PRE_ARGS) -{ - - if (n->args && 1 == n->args->argc) - if (MDOC_Std == n->args->argv[0].arg) - return(1); - return(mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV)); -} - - -static int +static void check_args(struct mdoc *m, struct mdoc_node *n) { int i; if (NULL == n->args) - return(1); + return; assert(n->args->argc); for (i = 0; i < (int)n->args->argc; i++) - if ( ! check_argv(m, n, &n->args->argv[i])) - return(0); - - return(1); + check_argv(m, n, &n->args->argv[i]); } - -static int +static void check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v) { int i; for (i = 0; i < (int)v->sz; i++) - if ( ! check_text(m, v->line, v->pos, v->value[i])) - return(0); + check_text(m, v->line, v->pos, v->value[i]); - if (MDOC_Std == v->arg) { - if (v->sz || m->meta.name) - return(1); - if ( ! mdoc_nmsg(m, n, MANDOCERR_NONAME)) - return(0); - } + /* FIXME: move to post_std(). */ - return(1); + if (MDOC_Std == v->arg) + if ( ! (v->sz || m->meta.name)) + mdoc_nmsg(m, n, MANDOCERR_NONAME); } - -static int +static void check_text(struct mdoc *m, int ln, int pos, char *p) { int c; @@ -534,27 +538,21 @@ check_text(struct mdoc *m, int ln, int pos, char *p) pos += (int)sz; if ('\t' == *p) { - if (MDOC_LITERAL & m->flags) - continue; - if (mdoc_pmsg(m, ln, pos, MANDOCERR_BADTAB)) - continue; - return(0); + if ( ! (MDOC_LITERAL & m->flags)) + mdoc_pmsg(m, ln, pos, MANDOCERR_BADTAB); + continue; } - /* Check the special character. */ - - c = mandoc_special(p); - if (c) { - p += c - 1; - pos += c - 1; - } else + if (0 == (c = mandoc_special(p))) { mdoc_pmsg(m, ln, pos, MANDOCERR_BADESCAPE); - } + continue; + } - return(1); + p += c - 1; + pos += c - 1; + } } - static int check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t) { @@ -684,8 +682,7 @@ pre_bl(PRE_ARGS) dup = (NULL != n->data.Bl->offs); break; } - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); break; default: continue; @@ -693,8 +690,8 @@ pre_bl(PRE_ARGS) /* Check: duplicate auxiliary arguments. */ - if (dup && ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP)) - return(0); + if (dup) + mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP); if (comp && ! dup) n->data.Bl->comp = comp; @@ -706,8 +703,7 @@ pre_bl(PRE_ARGS) /* Check: multiple list types. */ if (LIST__NONE != lt && n->data.Bl->type != LIST__NONE) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP); /* Assign list type. */ @@ -728,8 +724,7 @@ pre_bl(PRE_ARGS) if (n->data.Bl->width || n->data.Bl->offs || n->data.Bl->comp) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST); continue; } @@ -737,8 +732,7 @@ pre_bl(PRE_ARGS) /* Allow lists to default to LIST_item. */ if (LIST__NONE == n->data.Bl->type) { - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE); n->data.Bl->type = LIST_item; } @@ -752,9 +746,8 @@ pre_bl(PRE_ARGS) case (LIST_tag): if (n->data.Bl->width) break; - if (mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG)) - break; - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); + break; case (LIST_column): /* FALLTHROUGH */ case (LIST_diag): @@ -766,9 +759,8 @@ pre_bl(PRE_ARGS) case (LIST_item): if (NULL == n->data.Bl->width) break; - if (mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG)) - break; - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG); + break; default: break; } @@ -835,8 +827,7 @@ pre_bd(PRE_ARGS) dup = (NULL != n->data.Bd->offs); break; } - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); break; case (MDOC_Compact): comp = 1; @@ -849,8 +840,8 @@ pre_bd(PRE_ARGS) /* Check whether we have duplicates. */ - if (dup && ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP)) - return(0); + if (dup) + mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP); /* Make our auxiliary assignments. */ @@ -862,8 +853,7 @@ pre_bd(PRE_ARGS) /* Check whether a type has already been assigned. */ if (DISP__NONE != dt && n->data.Bd->type != DISP__NONE) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP); /* Make our type assignment. */ @@ -872,8 +862,7 @@ pre_bd(PRE_ARGS) } if (DISP__NONE == n->data.Bd->type) { - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE); n->data.Bd->type = DISP_ragged; } @@ -909,6 +898,7 @@ pre_it(PRE_ARGS) if (MDOC_BLOCK != n->type) return(1); + /* * FIXME: this can probably be lifted if we make the It into * something else on-the-fly? @@ -926,9 +916,8 @@ pre_an(PRE_ARGS) return(1); for (i = 1; i < (int)n->args->argc; i++) - if ( ! mdoc_pmsg(mdoc, n->args->argv[i].line, - n->args->argv[i].pos, MANDOCERR_IGNARGV)) - return(0); + mdoc_pmsg(mdoc, n->args->argv[i].line, + n->args->argv[i].pos, MANDOCERR_IGNARGV); if (MDOC_Split == n->args->argv[0].arg) n->data.An.auth = AUTH_split; @@ -940,72 +929,54 @@ pre_an(PRE_ARGS) return(1); } - static int -pre_rv(PRE_ARGS) +pre_std(PRE_ARGS) { - return(check_stdarg(mdoc, n)); -} + if (n->args && 1 == n->args->argc) + if (MDOC_Std == n->args->argv[0].arg) + return(1); - -static int -post_dt(POST_ARGS) -{ - const struct mdoc_node *nn; - const char *p; - - if (NULL != (nn = mdoc->last->child)) - for (p = nn->string; *p; p++) { - if (toupper((u_char)*p) == *p) - continue; - if ( ! mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE)) - return(0); - break; - } - + mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV); return(1); } - static int pre_dt(PRE_ARGS) { if (0 == mdoc->meta.date || mdoc->meta.os) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); + if (mdoc->meta.title) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP); + return(1); } - static int pre_os(PRE_ARGS) { if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); + if (mdoc->meta.os) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP); + return(1); } - static int pre_dd(PRE_ARGS) { if (mdoc->meta.title || mdoc->meta.os) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); + if (mdoc->meta.date) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP); + return(1); } @@ -1051,8 +1022,10 @@ post_bf(POST_ARGS) if (np->parent->args && np->child) { mdoc_nmsg(mdoc, np, MANDOCERR_SYNTARGVCOUNT); return(0); - } else if (NULL == np->parent->args && NULL == np->child) - return(mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE)); + } else if (NULL == np->parent->args && NULL == np->child) { + mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE); + return(1); + } /* Extract argument into data. */ @@ -1077,8 +1050,8 @@ post_bf(POST_ARGS) np->data.Bf->font = FONT_Li; else if (0 == strcmp(np->child->string, "Sy")) np->data.Bf->font = FONT_Sy; - else if ( ! mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE)) - return(0); + else + mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE); return(1); } @@ -1119,9 +1092,9 @@ static int post_eoln(POST_ARGS) { - if (NULL == mdoc->last->child) - return(1); - return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST)); + if (mdoc->last->child) + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST); + return(1); } @@ -1144,8 +1117,7 @@ post_vt(POST_ARGS) for (n = mdoc->last->child; n; n = n->next) if (MDOC_TEXT != n->type) - if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_CHILD)) - return(0); + mdoc_nmsg(mdoc, n, MANDOCERR_CHILD); return(1); } @@ -1154,8 +1126,7 @@ post_vt(POST_ARGS) static int post_nm(POST_ARGS) { - struct mdoc_node *nn; - char buf[BUFSIZ]; + char buf[BUFSIZ]; /* If no child specified, make sure we have the meta name. */ @@ -1167,27 +1138,11 @@ post_nm(POST_ARGS) /* If no meta name, set it from the child. */ - buf[0] = '\0'; + if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ)) + return(0); - for (nn = mdoc->last->child; nn; nn = nn->next) { - /* XXX - copied from concat(). */ - assert(MDOC_TEXT == nn->type); - - if (strlcat(buf, nn->string, BUFSIZ) >= BUFSIZ) { - mdoc_nmsg(mdoc, nn, MANDOCERR_MEM); - return(0); - } - - if (NULL == nn->next) - continue; - - if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) { - mdoc_nmsg(mdoc, nn, MANDOCERR_MEM); - return(0); - } - } - mdoc->meta.name = mandoc_strdup(buf); + return(1); } @@ -1203,7 +1158,7 @@ post_literal(POST_ARGS) */ if (MDOC_BODY == mdoc->last->type) - mdoc->last->flags &= ~MDOC_LITERAL; + mdoc->flags &= ~MDOC_LITERAL; return(1); } @@ -1302,13 +1257,16 @@ post_an(POST_ARGS) np = mdoc->last; if (AUTH__NONE != np->data.An.auth && np->child) return(eerr_eq0(mdoc)); + /* * FIXME: make this ewarn and make sure that the front-ends * don't print the arguments. */ if (AUTH__NONE != np->data.An.auth || np->child) return(1); - return(mdoc_nmsg(mdoc, np, MANDOCERR_NOARGS)); + + mdoc_nmsg(mdoc, np, MANDOCERR_NOARGS); + return(1); } @@ -1329,7 +1287,7 @@ post_it(POST_ARGS) if (LIST__NONE == lt) { mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE); - return(0); + return(1); } switch (lt) { @@ -1337,8 +1295,7 @@ post_it(POST_ARGS) if (mdoc->last->head->child) break; /* FIXME: give this a dummy value. */ - if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS)) - return(0); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS); break; case (LIST_hang): /* FALLTHROUGH */ @@ -1348,8 +1305,7 @@ post_it(POST_ARGS) /* FALLTHROUGH */ case (LIST_diag): if (NULL == mdoc->last->head->child) - if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS)) - return(0); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS); break; case (LIST_bullet): /* FALLTHROUGH */ @@ -1359,13 +1315,11 @@ post_it(POST_ARGS) /* FALLTHROUGH */ case (LIST_hyphen): if (NULL == mdoc->last->body->child) - if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY)) - return(0); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY); /* FALLTHROUGH */ case (LIST_item): if (mdoc->last->head->child) - if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST)) - return(0); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST); break; case (LIST_column): cols = (int)n->data.Bl->ncols; @@ -1373,8 +1327,7 @@ post_it(POST_ARGS) assert(NULL == mdoc->last->head->child); if (NULL == mdoc->last->body->child) - if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY)) - return(0); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY); for (i = 0, c = mdoc->last->child; c; c = c->next) if (MDOC_BODY == c->type) @@ -1398,35 +1351,230 @@ post_it(POST_ARGS) return(1); } - static int -post_bl_head(POST_ARGS) +post_bl_block(POST_ARGS) { struct mdoc_node *n; - assert(mdoc->last->parent); - n = mdoc->last->parent; + /* + * These are fairly complicated, so we've broken them into two + * functions. post_bl_block_tag() 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). + */ - if (LIST_column == n->data.Bl->type) { - if (n->data.Bl->ncols && mdoc->last->nchild) { - mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS); + n = mdoc->last; + + if (LIST_tag == n->data.Bl->type && + NULL == n->data.Bl->width) { + if ( ! post_bl_block_tag(mdoc)) return(0); - } + } else if (NULL != n->data.Bl->width) { + if ( ! post_bl_block_width(mdoc)) + return(0); + } else return(1); + + assert(n->data.Bl->width); + return(1); +} + +static int +post_bl_block_width(POST_ARGS) +{ + size_t width; + int i; + enum mdoct tok; + struct mdoc_node *n; + char buf[NUMSIZ]; + + n = mdoc->last; + + /* + * Calculate the real width of a list from the -width string, + * which may contain a macro (with a known default width), a + * literal string, or a scaling width. + * + * 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 (0 == strcmp(n->data.Bl->width, "Ds")) + width = 6; + else if (MDOC_MAX == (tok = mdoc_hash_find(n->data.Bl->width))) + return(1); + else if (0 == (width = mdoc_macro2len(tok))) { + mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH); + return(1); } - /* FIXME: should be ERROR class. */ - return(hwarn_eq0(mdoc)); + /* The value already exists: free and reallocate it. */ + + assert(n->args); + + for (i = 0; i < (int)n->args->argc; i++) + if (MDOC_Width == n->args->argv[i].arg) + break; + + assert(i < (int)n->args->argc); + + snprintf(buf, NUMSIZ, "%zun", width); + free(n->args->argv[i].value[0]); + n->args->argv[i].value[0] = mandoc_strdup(buf); + + /* Set our width! */ + n->data.Bl->width = n->args->argv[i].value[0]; + return(1); } +static int +post_bl_block_tag(POST_ARGS) +{ + struct mdoc_node *n, *nn; + size_t sz, ssz; + int i; + char buf[NUMSIZ]; + /* + * Calculate the -width for a `Bl -tag' list if it hasn't been + * provided. Uses the first head macro. NOTE AGAIN: this is + * ONLY if the -width argument has NOT been provided. See + * post_bl_block_width() for converting the -width string. + */ + + sz = 10; + n = mdoc->last; + + for (nn = n->body->child; nn; nn = nn->next) { + if (MDOC_It != nn->tok) + continue; + + assert(MDOC_BLOCK == nn->type); + nn = nn->head->child; + + if (nn == NULL) { + /* No -width for .Bl and first .It is emtpy */ + mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); + break; + } + + if (MDOC_TEXT == nn->type) { + sz = strlen(nn->string) + 1; + break; + } + + if (0 != (ssz = mdoc_macro2len(nn->tok))) + sz = ssz; + else + mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); + + break; + } + + /* Defaults to ten ens. */ + + snprintf(buf, NUMSIZ, "%zun", sz); + + /* + * We have to dynamically add this to the macro's argument list. + * We're guaranteed that a MDOC_Width doesn't already exist. + */ + + assert(n->args); + i = (int)(n->args->argc)++; + + n->args->argv = mandoc_realloc(n->args->argv, + n->args->argc * sizeof(struct mdoc_argv)); + + n->args->argv[i].arg = MDOC_Width; + n->args->argv[i].line = n->line; + n->args->argv[i].pos = n->pos; + n->args->argv[i].sz = 1; + n->args->argv[i].value = mandoc_malloc(sizeof(char *)); + n->args->argv[i].value[0] = mandoc_strdup(buf); + + /* Set our width! */ + n->data.Bl->width = n->args->argv[i].value[0]; + return(1); +} + + static int +post_bl_head(POST_ARGS) +{ + struct mdoc_node *np, *nn, *nnp; + int i, j; + + if (LIST_column != mdoc->last->data.Bl->type) + /* FIXME: this should be ERROR class... */ + return(hwarn_eq0(mdoc)); + + /* + * Convert old-style lists, where the column width specifiers + * trail as macro parameters, to the new-style ("normal-form") + * lists where they're argument values following -column. + */ + + /* First, disallow both types and allow normal-form. */ + + /* + * TODO: technically, we can accept both and just merge the two + * lists, but I'll leave that for another day. + */ + + if (mdoc->last->data.Bl->ncols && mdoc->last->nchild) { + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS); + return(0); + } else if (NULL == mdoc->last->child) + return(1); + + np = mdoc->last->parent; + assert(np->args); + + for (j = 0; j < (int)np->args->argc; j++) + if (MDOC_Column == np->args->argv[j].arg) + break; + + assert(j < (int)np->args->argc); + assert(0 == np->args->argv[j].sz); + + /* + * Accomodate for new-style groff column syntax. Shuffle the + * child nodes, all of which must be TEXT, as arguments for the + * column field. Then, delete the head children. + */ + + np->args->argv[j].sz = (size_t)mdoc->last->nchild; + np->args->argv[j].value = mandoc_malloc + ((size_t)mdoc->last->nchild * sizeof(char *)); + + mdoc->last->data.Bl->ncols = np->args->argv[j].sz; + mdoc->last->data.Bl->cols = (const char **)np->args->argv[j].value; + + for (i = 0, nn = mdoc->last->child; nn; i++) { + np->args->argv[j].value[i] = nn->string; + nn->string = NULL; + nnp = nn; + nn = nn->next; + mdoc_node_delete(NULL, nnp); + } + + mdoc->last->nchild = 0; + mdoc->last->child = NULL; + + return(1); +} + +static int post_bl(POST_ARGS) { struct mdoc_node *n; if (MDOC_HEAD == mdoc->last->type) return(post_bl_head(mdoc)); + if (MDOC_BLOCK == mdoc->last->type) + return(post_bl_block(mdoc)); if (MDOC_BODY != mdoc->last->type) return(1); if (NULL == mdoc->last->child) @@ -1451,45 +1599,55 @@ post_bl(POST_ARGS) return(1); } - static int ebool(struct mdoc *mdoc) { - struct mdoc_node *n; - /* LINTED */ - for (n = mdoc->last->child; n; n = n->next) { - if (MDOC_TEXT != n->type) - break; - if (0 == strcmp(n->string, "on")) - continue; - if (0 == strcmp(n->string, "off")) - continue; - break; - } + if (NULL == mdoc->last->child) + return(1); - if (NULL == n) + assert(MDOC_TEXT == mdoc->last->child->type); + + if (0 == strcmp(mdoc->last->child->string, "on")) return(1); - return(mdoc_nmsg(mdoc, n, MANDOCERR_BADBOOL)); + if (0 == strcmp(mdoc->last->child->string, "off")) + return(1); + + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL); + return(1); } - static int post_root(POST_ARGS) { + int erc; + struct mdoc_node *n; - if (NULL == mdoc->first->child) - mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY); - else if ( ! (MDOC_PBODY & mdoc->flags)) + erc = 0; + + /* Check that we have a finished prologue. */ + + if ( ! (MDOC_PBODY & mdoc->flags)) { + erc++; mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG); - else if (MDOC_BLOCK != mdoc->first->child->type) - mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY); - else if (MDOC_Sh != mdoc->first->child->tok) - mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY); - else - return(1); + } - return(0); + n = mdoc->first; + assert(n); + + /* Check that we begin with a proper `Sh'. */ + + if (NULL == n->child) { + erc++; + mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY); + } else if (MDOC_BLOCK != n->child->type || + MDOC_Sh != n->child->tok) { + erc++; + /* Can this be lifted? See rxdebug.1 for example. */ + mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY); + } + + return(erc ? 0 : 1); } static int @@ -1608,7 +1766,6 @@ post_rs(POST_ARGS) return(1); } - static int post_sh(POST_ARGS) { @@ -1621,7 +1778,6 @@ post_sh(POST_ARGS) return(1); } - static int post_sh_body(POST_ARGS) { @@ -1636,31 +1792,32 @@ post_sh_body(POST_ARGS) * children of the BODY declaration can also be "text". */ - if (NULL == (n = mdoc->last->child)) - return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC)); + if (NULL == (n = mdoc->last->child)) { + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC); + return(1); + } for ( ; n && n->next; n = n->next) { if (MDOC_ELEM == n->type && MDOC_Nm == n->tok) continue; if (MDOC_TEXT == n->type) continue; - if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC)) - return(0); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC); } assert(n); if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok) return(1); - return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC)); + + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC); + return(1); } - static int post_sh_head(POST_ARGS) { - char buf[BUFSIZ]; - enum mdoc_sec sec; - struct mdoc_node *n; + char buf[BUFSIZ]; + enum mdoc_sec sec; /* * Process a new section. Sections are either "named" or @@ -1669,28 +1826,9 @@ post_sh_head(POST_ARGS) * manual sections. */ - buf[0] = '\0'; + if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ)) + return(0); - /* FIXME: use dynamic buffer... */ - - for (n = mdoc->last->child; n; n = n->next) { - /* XXX - copied from concat(). */ - assert(MDOC_TEXT == n->type); - - if (strlcat(buf, n->string, BUFSIZ) >= BUFSIZ) { - mdoc_nmsg(mdoc, n, MANDOCERR_MEM); - return(0); - } - - if (NULL == n->next) - continue; - - if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) { - mdoc_nmsg(mdoc, n, MANDOCERR_MEM); - return(0); - } - } - sec = mdoc_str2sec(buf); /* The NAME should be first. */ @@ -1809,3 +1947,274 @@ pre_literal(PRE_ARGS) return(1); } + +static int +post_dd(POST_ARGS) +{ + char buf[DATESIZ]; + struct mdoc_node *n; + + n = mdoc->last; + + if (NULL == n->child) { + mdoc->meta.date = time(NULL); + return(1); + } + + if ( ! concat(mdoc, buf, n->child, DATESIZ)) + return(0); + + mdoc->meta.date = mandoc_a2time + (MTIME_MDOCDATE | MTIME_CANONICAL, buf); + + if (0 == mdoc->meta.date) { + mdoc_nmsg(mdoc, n, MANDOCERR_BADDATE); + mdoc->meta.date = time(NULL); + } + + return(1); +} + +static int +post_dt(POST_ARGS) +{ + struct mdoc_node *nn, *n; + const char *cp; + char *p; + + n = mdoc->last; + + 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; + + /* First make all characters uppercase. */ + + if (NULL != (nn = n->child)) + for (p = nn->string; *p; p++) { + if (toupper((u_char)*p) == *p) + continue; + + /* + * FIXME: don't be lazy: have this make all + * characters be uppercase and just warn once. + */ + mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE); + break; + } + + /* Handles: `.Dt' + * --> title = unknown, volume = local, msec = 0, arch = NULL + */ + + if (NULL == (nn = n->child)) { + /* XXX: make these macro values. */ + /* FIXME: warn about missing values. */ + mdoc->meta.title = mandoc_strdup("UNKNOWN"); + mdoc->meta.vol = mandoc_strdup("LOCAL"); + mdoc->meta.msec = mandoc_strdup("1"); + return(1); + } + + /* Handles: `.Dt TITLE' + * --> title = TITLE, volume = local, msec = 0, arch = NULL + */ + + mdoc->meta.title = mandoc_strdup + ('\0' == nn->string[0] ? "UNKNOWN" : nn->string); + + if (NULL == (nn = nn->next)) { + /* FIXME: warn about missing msec. */ + /* XXX: make this a macro value. */ + mdoc->meta.vol = mandoc_strdup("LOCAL"); + mdoc->meta.msec = mandoc_strdup("1"); + return(1); + } + + /* Handles: `.Dt TITLE SEC' + * --> title = TITLE, volume = SEC is msec ? + * format(msec) : SEC, + * msec = SEC is msec ? atoi(msec) : 0, + * arch = NULL + */ + + cp = mdoc_a2msec(nn->string); + if (cp) { + mdoc->meta.vol = mandoc_strdup(cp); + mdoc->meta.msec = mandoc_strdup(nn->string); + } else { + mdoc_nmsg(mdoc, n, MANDOCERR_BADMSEC); + mdoc->meta.vol = mandoc_strdup(nn->string); + mdoc->meta.msec = mandoc_strdup(nn->string); + } + + if (NULL == (nn = nn->next)) + return(1); + + /* Handles: `.Dt TITLE SEC VOL' + * --> title = TITLE, volume = VOL is vol ? + * format(VOL) : + * VOL is arch ? format(arch) : + * VOL + */ + + cp = mdoc_a2vol(nn->string); + if (cp) { + free(mdoc->meta.vol); + mdoc->meta.vol = mandoc_strdup(cp); + } else { + /* FIXME: warn about bad arch. */ + cp = mdoc_a2arch(nn->string); + if (NULL == cp) { + free(mdoc->meta.vol); + mdoc->meta.vol = mandoc_strdup(nn->string); + } else + mdoc->meta.arch = mandoc_strdup(cp); + } + + /* Ignore any subsequent parameters... */ + /* FIXME: warn about subsequent parameters. */ + + return(1); +} + +static int +post_prol(POST_ARGS) +{ + /* + * Remove prologue macros from the document after they're + * processed. The final document uses mdoc_meta for these + * values and discards the originals. + */ + + mdoc_node_delete(mdoc, mdoc->last); + if (mdoc->meta.title && mdoc->meta.date && mdoc->meta.os) + mdoc->flags |= MDOC_PBODY; + + return(1); +} + +static int +post_os(POST_ARGS) +{ + struct mdoc_node *n; + char buf[BUFSIZ]; +#ifndef OSNAME + struct utsname utsname; +#endif + + n = mdoc->last; + + /* + * 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(). + */ + + if (mdoc->meta.os) + free(mdoc->meta.os); + + if ( ! concat(mdoc, buf, n->child, BUFSIZ)) + return(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(mdoc, n, MANDOCERR_MEM); + return(0); + } +#else /*!OSNAME */ + if (-1 == uname(&utsname)) + return(mdoc_nmsg(mdoc, n, MANDOCERR_UTSNAME)); + + if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(mdoc, n, MANDOCERR_MEM); + return(0); + } + if (strlcat(buf, " ", 64) >= BUFSIZ) { + mdoc_nmsg(mdoc, n, MANDOCERR_MEM); + return(0); + } + if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(mdoc, n, MANDOCERR_MEM); + return(0); + } +#endif /*!OSNAME*/ + } + + mdoc->meta.os = mandoc_strdup(buf); + return(1); +} + +static int +post_std(POST_ARGS) +{ + struct mdoc_node *nn, *n; + + n = mdoc->last; + + /* + * Macros accepting `-std' as an argument have the name of the + * current document (`Nm') filled in as the argument if it's not + * provided. + */ + + if (n->child) + return(1); + + if (NULL == mdoc->meta.name) + return(1); + + nn = n; + mdoc->next = MDOC_NEXT_CHILD; + + if ( ! mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name)) + return(0); + + mdoc->last = nn; + return(1); +} + +static int +concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz) +{ + + p[0] = '\0'; + + /* + * Concatenate sibling nodes together. All siblings must be of + * type MDOC_TEXT or an assertion is raised. Concatenation is + * separated by a single whitespace. Returns 0 on fatal (string + * overrun) error. + */ + + for ( ; n; n = n->next) { + assert(MDOC_TEXT == n->type); + + 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); + } + } + + return(1); +} +