=================================================================== RCS file: /cvs/mandoc/mdoc_validate.c,v retrieving revision 1.166 retrieving revision 1.221 diff -u -p -r1.166 -r1.221 --- mandoc/mdoc_validate.c 2011/04/03 09:53:50 1.166 +++ mandoc/mdoc_validate.c 2014/07/02 13:10:45 1.221 @@ -1,7 +1,8 @@ -/* $Id: mdoc_validate.c,v 1.166 2011/04/03 09:53:50 kristaps Exp $ */ +/* $Id: mdoc_validate.c,v 1.221 2014/07/02 13:10:45 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons - * Copyright (c) 2010, 2011 Ingo Schwarze + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2014 Ingo Schwarze + * Copyright (c) 2010 Joerg Sonnenberger * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -19,7 +20,7 @@ #include "config.h" #endif -#ifndef OSNAME +#ifndef OSNAME #include #endif @@ -35,6 +36,7 @@ #include "mdoc.h" #include "mandoc.h" +#include "mandoc_aux.h" #include "libmdoc.h" #include "libmandoc.h" @@ -43,9 +45,6 @@ #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n #define POST_ARGS struct mdoc *mdoc -#define NUMSIZ 32 -#define DATESIZE 32 - enum check_ineq { CHECK_LT, CHECK_GT, @@ -65,16 +64,13 @@ struct valids { v_post *post; }; -static int check_count(struct mdoc *, enum mdoc_type, +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 void check_text(struct mdoc *, int, int, char *); -static void check_argv(struct mdoc *, +static void check_argv(struct mdoc *, struct mdoc_node *, struct mdoc_argv *); static void check_args(struct mdoc *, struct mdoc_node *); - -static int concat(struct mdoc *, char *, - const struct mdoc_node *, size_t); static enum mdoc_sec a2sec(const char *); static size_t macro2len(enum mdoct); @@ -99,17 +95,21 @@ 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_bx(POST_ARGS); +static int post_defaults(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_en(POST_ARGS); +static int post_es(POST_ARGS); static int post_eoln(POST_ARGS); +static int post_hyph(POST_ARGS); +static int post_ignpar(POST_ARGS); static int post_it(POST_ARGS); static int post_lb(POST_ARGS); +static int post_literal(POST_ARGS); static int post_nm(POST_ARGS); static int post_ns(POST_ARGS); static int post_os(POST_ARGS); -static int post_ignpar(POST_ARGS); +static int post_par(POST_ARGS); static int post_prol(POST_ARGS); static int post_root(POST_ARGS); static int post_rs(POST_ARGS); @@ -127,6 +127,7 @@ static int pre_display(PRE_ARGS); static int pre_dt(PRE_ARGS); static int pre_it(PRE_ARGS); static int pre_literal(PRE_ARGS); +static int pre_obsolete(PRE_ARGS); static int pre_os(PRE_ARGS); static int pre_par(PRE_ARGS); static int pre_sh(PRE_ARGS); @@ -143,27 +144,32 @@ static v_post posts_bx[] = { post_bx, NULL }; static v_post posts_bool[] = { ebool, NULL }; static v_post posts_eoln[] = { post_eoln, NULL }; static v_post posts_defaults[] = { post_defaults, NULL }; +static v_post posts_d1[] = { bwarn_ge1, post_hyph, NULL }; static v_post posts_dd[] = { post_dd, post_prol, NULL }; static v_post posts_dl[] = { post_literal, bwarn_ge1, NULL }; static v_post posts_dt[] = { post_dt, post_prol, NULL }; +static v_post posts_en[] = { post_en, NULL }; +static v_post posts_es[] = { post_es, NULL }; static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL }; +static v_post posts_hyph[] = { post_hyph, NULL }; +static v_post posts_hyphtext[] = { ewarn_ge1, post_hyph, NULL }; static v_post posts_it[] = { post_it, NULL }; static v_post posts_lb[] = { post_lb, NULL }; -static v_post posts_nd[] = { berr_ge1, NULL }; +static v_post posts_nd[] = { berr_ge1, post_hyph, NULL }; static v_post posts_nm[] = { post_nm, NULL }; static v_post posts_notext[] = { ewarn_eq0, NULL }; static v_post posts_ns[] = { post_ns, NULL }; static v_post posts_os[] = { post_os, post_prol, NULL }; +static v_post posts_pp[] = { post_par, ewarn_eq0, NULL }; static v_post posts_rs[] = { post_rs, NULL }; -static v_post posts_sh[] = { post_ignpar, hwarn_ge1, bwarn_ge1, post_sh, NULL }; -static v_post posts_sp[] = { ewarn_le1, NULL }; -static v_post posts_ss[] = { post_ignpar, hwarn_ge1, bwarn_ge1, NULL }; +static v_post posts_sh[] = { post_ignpar,hwarn_ge1,post_sh,post_hyph,NULL }; +static v_post posts_sp[] = { post_par, ewarn_le1, NULL }; +static v_post posts_ss[] = { post_ignpar, hwarn_ge1, post_hyph, NULL }; static v_post posts_st[] = { post_st, NULL }; static v_post posts_std[] = { post_std, NULL }; static v_post posts_text[] = { ewarn_ge1, NULL }; static v_post posts_text1[] = { ewarn_eq1, NULL }; static v_post posts_vt[] = { post_vt, NULL }; -static v_post posts_wline[] = { bwarn_ge1, NULL }; static v_pre pres_an[] = { pre_an, NULL }; static v_pre pres_bd[] = { pre_display, pre_bd, pre_literal, pre_par, NULL }; static v_pre pres_bl[] = { pre_bl, pre_par, NULL }; @@ -171,9 +177,8 @@ static v_pre pres_d1[] = { pre_display, NULL }; static v_pre pres_dl[] = { pre_literal, pre_display, NULL }; 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_fd[] = { NULL, NULL }; static v_pre pres_it[] = { pre_it, pre_par, NULL }; +static v_pre pres_obsolete[] = { pre_obsolete, NULL }; static v_pre pres_os[] = { pre_os, NULL }; static v_pre pres_pp[] = { pre_par, NULL }; static v_pre pres_sh[] = { pre_sh, NULL }; @@ -185,58 +190,58 @@ static const struct valids mdoc_valids[MDOC_MAX] = { { pres_dd, posts_dd }, /* Dd */ { pres_dt, posts_dt }, /* Dt */ { pres_os, posts_os }, /* Os */ - { pres_sh, posts_sh }, /* Sh */ - { pres_ss, posts_ss }, /* Ss */ - { pres_pp, posts_notext }, /* Pp */ - { pres_d1, posts_wline }, /* D1 */ + { pres_sh, posts_sh }, /* Sh */ + { pres_ss, posts_ss }, /* Ss */ + { pres_pp, posts_pp }, /* Pp */ + { pres_d1, posts_d1 }, /* D1 */ { pres_dl, posts_dl }, /* Dl */ { pres_bd, posts_bd }, /* Bd */ { NULL, NULL }, /* Ed */ - { pres_bl, posts_bl }, /* Bl */ + { pres_bl, posts_bl }, /* Bl */ { NULL, NULL }, /* El */ { pres_it, posts_it }, /* It */ - { NULL, NULL }, /* Ad */ - { pres_an, posts_an }, /* An */ + { NULL, NULL }, /* Ad */ + { pres_an, posts_an }, /* An */ { NULL, posts_defaults }, /* Ar */ - { NULL, NULL }, /* Cd */ + { NULL, NULL }, /* Cd */ { NULL, NULL }, /* Cm */ - { NULL, NULL }, /* Dv */ - { pres_er, NULL }, /* Er */ - { NULL, NULL }, /* Ev */ - { pres_std, posts_std }, /* Ex */ - { NULL, NULL }, /* Fa */ - { pres_fd, posts_text }, /* Fd */ + { NULL, NULL }, /* Dv */ + { NULL, NULL }, /* Er */ + { NULL, NULL }, /* Ev */ + { pres_std, posts_std }, /* Ex */ + { NULL, NULL }, /* Fa */ + { NULL, posts_text }, /* Fd */ { NULL, NULL }, /* Fl */ - { NULL, NULL }, /* Fn */ - { NULL, NULL }, /* Ft */ - { NULL, NULL }, /* Ic */ - { NULL, posts_text1 }, /* In */ + { NULL, NULL }, /* Fn */ + { NULL, NULL }, /* Ft */ + { NULL, NULL }, /* Ic */ + { NULL, posts_text1 }, /* In */ { NULL, posts_defaults }, /* Li */ { NULL, posts_nd }, /* Nd */ { NULL, posts_nm }, /* Nm */ { NULL, NULL }, /* Op */ - { NULL, NULL }, /* Ot */ + { pres_obsolete, NULL }, /* Ot */ { NULL, posts_defaults }, /* Pa */ { pres_std, posts_std }, /* Rv */ - { NULL, posts_st }, /* St */ + { NULL, posts_st }, /* St */ { NULL, NULL }, /* Va */ - { NULL, posts_vt }, /* Vt */ - { NULL, posts_text }, /* Xr */ + { NULL, posts_vt }, /* Vt */ + { NULL, posts_text }, /* Xr */ { NULL, posts_text }, /* %A */ - { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */ + { NULL, posts_hyphtext }, /* %B */ /* FIXME: can be used outside Rs/Re. */ { NULL, posts_text }, /* %D */ { NULL, posts_text }, /* %I */ { NULL, posts_text }, /* %J */ - { NULL, posts_text }, /* %N */ - { NULL, posts_text }, /* %O */ + { NULL, posts_hyphtext }, /* %N */ + { NULL, posts_hyphtext }, /* %O */ { NULL, posts_text }, /* %P */ - { NULL, posts_text }, /* %R */ - { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */ + { NULL, posts_hyphtext }, /* %R */ + { NULL, posts_hyphtext }, /* %T */ /* FIXME: can be used outside Rs/Re. */ { NULL, posts_text }, /* %V */ { NULL, NULL }, /* Ac */ { NULL, NULL }, /* Ao */ { NULL, NULL }, /* Aq */ - { NULL, posts_at }, /* At */ + { NULL, posts_at }, /* At */ { NULL, NULL }, /* Bc */ { NULL, posts_bf }, /* Bf */ { NULL, NULL }, /* Bo */ @@ -248,11 +253,11 @@ static const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Do */ { NULL, NULL }, /* Dq */ { NULL, NULL }, /* Ec */ - { NULL, NULL }, /* Ef */ - { NULL, NULL }, /* Em */ + { NULL, NULL }, /* Ef */ + { NULL, NULL }, /* Em */ { NULL, NULL }, /* Eo */ { NULL, NULL }, /* Fx */ - { NULL, NULL }, /* Ms */ + { NULL, NULL }, /* Ms */ { NULL, posts_notext }, /* No */ { NULL, posts_ns }, /* Ns */ { NULL, NULL }, /* Nx */ @@ -270,39 +275,40 @@ static const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Sc */ { NULL, NULL }, /* So */ { NULL, NULL }, /* Sq */ - { NULL, posts_bool }, /* Sm */ - { NULL, NULL }, /* Sx */ + { NULL, posts_bool }, /* Sm */ + { NULL, posts_hyph }, /* Sx */ { NULL, NULL }, /* Sy */ { NULL, NULL }, /* Tn */ { NULL, NULL }, /* Ux */ { NULL, NULL }, /* Xc */ { NULL, NULL }, /* Xo */ - { NULL, posts_fo }, /* Fo */ - { NULL, NULL }, /* Fc */ + { NULL, posts_fo }, /* Fo */ + { NULL, NULL }, /* Fc */ { NULL, NULL }, /* Oo */ { NULL, NULL }, /* Oc */ { NULL, posts_bk }, /* Bk */ { NULL, NULL }, /* Ek */ { NULL, posts_eoln }, /* Bt */ { NULL, NULL }, /* Hf */ - { NULL, NULL }, /* Fr */ + { pres_obsolete, NULL }, /* Fr */ { NULL, posts_eoln }, /* Ud */ { NULL, posts_lb }, /* Lb */ - { NULL, posts_notext }, /* Lp */ - { NULL, NULL }, /* Lk */ - { NULL, posts_defaults }, /* Mt */ - { NULL, NULL }, /* Brq */ - { NULL, NULL }, /* Bro */ - { NULL, NULL }, /* Brc */ + { pres_pp, posts_pp }, /* Lp */ + { NULL, NULL }, /* Lk */ + { NULL, posts_defaults }, /* Mt */ + { NULL, NULL }, /* Brq */ + { NULL, NULL }, /* Bro */ + { NULL, NULL }, /* Brc */ { NULL, posts_text }, /* %C */ - { NULL, NULL }, /* Es */ - { NULL, NULL }, /* En */ + { pres_obsolete, posts_es }, /* Es */ + { pres_obsolete, posts_en }, /* En */ { NULL, NULL }, /* Dx */ { NULL, posts_text }, /* %Q */ - { NULL, posts_notext }, /* br */ - { pres_pp, posts_sp }, /* sp */ + { NULL, posts_pp }, /* br */ + { NULL, posts_sp }, /* sp */ { NULL, posts_text1 }, /* %U */ { NULL, NULL }, /* Ta */ + { NULL, NULL }, /* ll */ }; #define RSORD_MAX 14 /* Number of `Rs' blocks. */ @@ -316,12 +322,12 @@ static const enum mdoct rsord[RSORD_MAX] = { MDOC__R, MDOC__N, MDOC__V, + MDOC__U, MDOC__P, MDOC__Q, - MDOC__D, - MDOC__O, MDOC__C, - MDOC__U + MDOC__D, + MDOC__O }; static const char * const secnames[SEC__MAX] = { @@ -330,6 +336,7 @@ static const char * const secnames[SEC__MAX] = { "LIBRARY", "SYNOPSIS", "DESCRIPTION", + "CONTEXT", "IMPLEMENTATION NOTES", "RETURN VALUES", "ENVIRONMENT", @@ -349,6 +356,7 @@ static const char * const secnames[SEC__MAX] = { NULL }; + int mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) { @@ -357,17 +365,17 @@ mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) char *tp; switch (n->type) { - case (MDOC_TEXT): + case MDOC_TEXT: tp = n->string; line = n->line; pos = n->pos; check_text(mdoc, line, pos, tp); /* FALLTHROUGH */ - case (MDOC_TBL): + case MDOC_TBL: /* FALLTHROUGH */ - case (MDOC_EQN): + case MDOC_EQN: /* FALLTHROUGH */ - case (MDOC_ROOT): + case MDOC_ROOT: return(1); default: break; @@ -378,12 +386,11 @@ mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) if (NULL == mdoc_valids[n->tok].pre) return(1); for (p = mdoc_valids[n->tok].pre; *p; p++) - if ( ! (*p)(mdoc, n)) + if ( ! (*p)(mdoc, n)) return(0); return(1); } - int mdoc_valid_post(struct mdoc *mdoc) { @@ -394,13 +401,13 @@ mdoc_valid_post(struct mdoc *mdoc) mdoc->last->flags |= MDOC_VALID; switch (mdoc->last->type) { - case (MDOC_TEXT): + case MDOC_TEXT: /* FALLTHROUGH */ - case (MDOC_EQN): + case MDOC_EQN: /* FALLTHROUGH */ - case (MDOC_TBL): + case MDOC_TBL: return(1); - case (MDOC_ROOT): + case MDOC_ROOT: return(post_root(mdoc)); default: break; @@ -409,36 +416,36 @@ mdoc_valid_post(struct mdoc *mdoc) if (NULL == mdoc_valids[mdoc->last->tok].post) return(1); for (p = mdoc_valids[mdoc->last->tok].post; *p; p++) - if ( ! (*p)(mdoc)) + if ( ! (*p)(mdoc)) return(0); return(1); } static int -check_count(struct mdoc *m, enum mdoc_type type, +check_count(struct mdoc *mdoc, enum mdoc_type type, enum check_lvl lvl, enum check_ineq ineq, int val) { const char *p; enum mandocerr t; - if (m->last->type != type) + if (mdoc->last->type != type) return(1); - + switch (ineq) { - case (CHECK_LT): + case CHECK_LT: p = "less than "; - if (m->last->nchild < val) + if (mdoc->last->nchild < val) return(1); break; - case (CHECK_GT): + case CHECK_GT: p = "more than "; - if (m->last->nchild > val) + if (mdoc->last->nchild > val) return(1); break; - case (CHECK_EQ): + case CHECK_EQ: p = ""; - if (val == m->last->nchild) + if (val == mdoc->last->nchild) return(1); break; default: @@ -447,9 +454,9 @@ check_count(struct mdoc *m, enum mdoc_type type, } t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT; - mandoc_vmsg(t, m->parse, m->last->line, m->last->pos, - "want %s%d children (have %d)", - p, val, m->last->nchild); + mandoc_vmsg(t, mdoc->parse, mdoc->last->line, + mdoc->last->pos, "want %s%d children (have %d)", + p, val, mdoc->last->nchild); return(1); } @@ -515,7 +522,7 @@ hwarn_le1(POST_ARGS) } static void -check_args(struct mdoc *m, struct mdoc_node *n) +check_args(struct mdoc *mdoc, struct mdoc_node *n) { int i; @@ -524,53 +531,34 @@ check_args(struct mdoc *m, struct mdoc_node *n) assert(n->args->argc); for (i = 0; i < (int)n->args->argc; i++) - check_argv(m, n, &n->args->argv[i]); + check_argv(mdoc, n, &n->args->argv[i]); } static void -check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v) +check_argv(struct mdoc *mdoc, struct mdoc_node *n, struct mdoc_argv *v) { int i; for (i = 0; i < (int)v->sz; i++) - check_text(m, v->line, v->pos, v->value[i]); + check_text(mdoc, v->line, v->pos, v->value[i]); /* FIXME: move to post_std(). */ if (MDOC_Std == v->arg) - if ( ! (v->sz || m->meta.name)) - mdoc_nmsg(m, n, MANDOCERR_NONAME); + if ( ! (v->sz || mdoc->meta.name)) + mdoc_nmsg(mdoc, n, MANDOCERR_NONAME); } static void -check_text(struct mdoc *m, int ln, int pos, char *p) +check_text(struct mdoc *mdoc, int ln, int pos, char *p) { - int c; - size_t sz; + char *cp; - for ( ; *p; p++, pos++) { - sz = strcspn(p, "\t\\"); - p += (int)sz; + if (MDOC_LITERAL & mdoc->flags) + return; - if ('\0' == *p) - break; - - pos += (int)sz; - - if ('\t' == *p) { - if ( ! (MDOC_LITERAL & m->flags)) - mdoc_pmsg(m, ln, pos, MANDOCERR_BADTAB); - continue; - } - - if (0 == (c = mandoc_special(p))) { - mdoc_pmsg(m, ln, pos, MANDOCERR_BADESCAPE); - continue; - } - - p += c - 1; - pos += c - 1; - } + for (cp = p; NULL != (p = strchr(p, '\t')); p++) + mdoc_pmsg(mdoc, ln, pos + (int)(p - cp), MANDOCERR_BADTAB); } static int @@ -582,9 +570,9 @@ check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type (t == n->parent->type)) return(1); - mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse, n->line, - n->pos, "want parent %s", MDOC_ROOT == t ? - "" : mdoc_macronames[tok]); + mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse, + n->line, n->pos, "want parent %s", + MDOC_ROOT == t ? "" : mdoc_macronames[tok]); return(0); } @@ -597,18 +585,19 @@ pre_display(PRE_ARGS) if (MDOC_BLOCK != n->type) return(1); - for (node = mdoc->last->parent; node; node = node->parent) + for (node = mdoc->last->parent; node; node = node->parent) if (MDOC_BLOCK == node->type) if (MDOC_Bd == node->tok) break; if (node) - mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP); + mandoc_vmsg(MANDOCERR_BD_NEST, + mdoc->parse, n->line, n->pos, + "%s in Bd", mdoc_macronames[n->tok]); return(1); } - static int pre_bl(PRE_ARGS) { @@ -630,62 +619,66 @@ pre_bl(PRE_ARGS) return(1); } - /* + /* * First figure out which kind of list to use: bind ourselves to * the first mentioned list type and warn about any remaining * ones. If we find no list type, we default to LIST_item. */ - /* LINTED */ for (i = 0; n->args && i < (int)n->args->argc; i++) { lt = LIST__NONE; dup = comp = 0; width = offs = NULL; switch (n->args->argv[i].arg) { /* Set list types. */ - case (MDOC_Bullet): + case MDOC_Bullet: lt = LIST_bullet; break; - case (MDOC_Dash): + case MDOC_Dash: lt = LIST_dash; break; - case (MDOC_Enum): + case MDOC_Enum: lt = LIST_enum; break; - case (MDOC_Hyphen): + case MDOC_Hyphen: lt = LIST_hyphen; break; - case (MDOC_Item): + case MDOC_Item: lt = LIST_item; break; - case (MDOC_Tag): + case MDOC_Tag: lt = LIST_tag; break; - case (MDOC_Diag): + case MDOC_Diag: lt = LIST_diag; break; - case (MDOC_Hang): + case MDOC_Hang: lt = LIST_hang; break; - case (MDOC_Ohang): + case MDOC_Ohang: lt = LIST_ohang; break; - case (MDOC_Inset): + case MDOC_Inset: lt = LIST_inset; break; - case (MDOC_Column): + case MDOC_Column: lt = LIST_column; break; /* Set list arguments. */ - case (MDOC_Compact): + case MDOC_Compact: dup = n->norm->Bl.comp; comp = 1; break; - case (MDOC_Width): - dup = (NULL != n->norm->Bl.width); - width = n->args->argv[i].value[0]; + case MDOC_Width: + /* NB: this can be empty! */ + if (n->args->argv[i].sz) { + width = n->args->argv[i].value[0]; + dup = (NULL != n->norm->Bl.width); + break; + } + mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); break; - case (MDOC_Offset): + case MDOC_Offset: /* NB: this can be empty! */ if (n->args->argv[i].sz) { offs = n->args->argv[i].value[0]; @@ -721,19 +714,19 @@ pre_bl(PRE_ARGS) n->norm->Bl.type = lt; /* Set column information, too. */ if (LIST_column == lt) { - n->norm->Bl.ncols = - n->args->argv[i].sz; - n->norm->Bl.cols = (const char **) - n->args->argv[i].value; + n->norm->Bl.ncols = + n->args->argv[i].sz; + n->norm->Bl.cols = (void *) + n->args->argv[i].value; } } /* The list type should come first. */ if (n->norm->Bl.type == LIST__NONE) - if (n->norm->Bl.width || - n->norm->Bl.offs || - n->norm->Bl.comp) + if (n->norm->Bl.width || + n->norm->Bl.offs || + n->norm->Bl.comp) mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST); continue; @@ -746,30 +739,42 @@ pre_bl(PRE_ARGS) n->norm->Bl.type = LIST_item; } - /* + /* * Validate the width field. Some list types don't need width * types and should be warned about them. Others should have it - * and must also be warned. + * and must also be warned. Yet others have a default and need + * no warning. */ switch (n->norm->Bl.type) { - case (LIST_tag): - if (n->norm->Bl.width) - break; - mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); + case LIST_tag: + if (NULL == n->norm->Bl.width) + mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); break; - case (LIST_column): + case LIST_column: /* FALLTHROUGH */ - case (LIST_diag): + case LIST_diag: /* FALLTHROUGH */ - case (LIST_ohang): + case LIST_ohang: /* FALLTHROUGH */ - case (LIST_inset): + case LIST_inset: /* FALLTHROUGH */ - case (LIST_item): + case LIST_item: if (n->norm->Bl.width) mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); break; + case LIST_bullet: + /* FALLTHROUGH */ + case LIST_dash: + /* FALLTHROUGH */ + case LIST_hyphen: + if (NULL == n->norm->Bl.width) + n->norm->Bl.width = "2n"; + break; + case LIST_enum: + if (NULL == n->norm->Bl.width) + n->norm->Bl.width = "3n"; + break; default: break; } @@ -777,12 +782,11 @@ pre_bl(PRE_ARGS) return(1); } - static int pre_bd(PRE_ARGS) { int i, dup, comp; - enum mdoc_disp dt; + enum mdoc_disp dt; const char *offs; struct mdoc_node *np; @@ -799,32 +803,31 @@ pre_bd(PRE_ARGS) return(1); } - /* LINTED */ for (i = 0; n->args && i < (int)n->args->argc; i++) { dt = DISP__NONE; dup = comp = 0; offs = NULL; switch (n->args->argv[i].arg) { - case (MDOC_Centred): + case MDOC_Centred: dt = DISP_centred; break; - case (MDOC_Ragged): + case MDOC_Ragged: dt = DISP_ragged; break; - case (MDOC_Unfilled): + case MDOC_Unfilled: dt = DISP_unfilled; break; - case (MDOC_Filled): + case MDOC_Filled: dt = DISP_filled; break; - case (MDOC_Literal): + case MDOC_Literal: dt = DISP_literal; break; - case (MDOC_File): + case MDOC_File: mdoc_nmsg(mdoc, n, MANDOCERR_BADDISP); return(0); - case (MDOC_Offset): + case MDOC_Offset: /* NB: this can be empty! */ if (n->args->argv[i].sz) { offs = n->args->argv[i].value[0]; @@ -833,7 +836,7 @@ pre_bd(PRE_ARGS) } mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); break; - case (MDOC_Compact): + case MDOC_Compact: comp = 1; dup = n->norm->Bd.comp; break; @@ -873,7 +876,6 @@ pre_bd(PRE_ARGS) return(1); } - static int pre_ss(PRE_ARGS) { @@ -883,19 +885,15 @@ pre_ss(PRE_ARGS) return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY)); } - static int pre_sh(PRE_ARGS) { if (MDOC_BLOCK != n->type) return(1); - - mdoc->regs->regs[(int)REG_nS].set = 0; return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT)); } - static int pre_it(PRE_ARGS) { @@ -906,7 +904,6 @@ pre_it(PRE_ARGS) return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); } - static int pre_an(PRE_ARGS) { @@ -914,10 +911,10 @@ pre_an(PRE_ARGS) if (NULL == n->args) return(1); - + for (i = 1; i < (int)n->args->argc; i++) - mdoc_pmsg(mdoc, n->args->argv[i].line, - n->args->argv[i].pos, MANDOCERR_IGNARGV); + mdoc_pmsg(mdoc, n->args->argv[i].line, + n->args->argv[i].pos, MANDOCERR_IGNARGV); if (MDOC_Split == n->args->argv[0].arg) n->norm->An.auth = AUTH_split; @@ -942,14 +939,26 @@ pre_std(PRE_ARGS) } static int +pre_obsolete(PRE_ARGS) +{ + + if (MDOC_ELEM == n->type || MDOC_BLOCK == n->type) + mandoc_msg(MANDOCERR_MACRO_OBS, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); + return(1); +} + +static int pre_dt(PRE_ARGS) { if (NULL == mdoc->meta.date || mdoc->meta.os) - mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); + mandoc_msg(MANDOCERR_PROLOG_ORDER, mdoc->parse, + n->line, n->pos, "Dt"); if (mdoc->meta.title) - mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP); + mandoc_msg(MANDOCERR_PROLOG_REP, mdoc->parse, + n->line, n->pos, "Dt"); return(1); } @@ -959,10 +968,12 @@ pre_os(PRE_ARGS) { if (NULL == mdoc->meta.title || NULL == mdoc->meta.date) - mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); + mandoc_msg(MANDOCERR_PROLOG_ORDER, mdoc->parse, + n->line, n->pos, "Os"); if (mdoc->meta.os) - mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP); + mandoc_msg(MANDOCERR_PROLOG_REP, mdoc->parse, + n->line, n->pos, "Os"); return(1); } @@ -972,15 +983,16 @@ pre_dd(PRE_ARGS) { if (mdoc->meta.title || mdoc->meta.os) - mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); + mandoc_msg(MANDOCERR_PROLOG_ORDER, mdoc->parse, + n->line, n->pos, "Dd"); if (mdoc->meta.date) - mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP); + mandoc_msg(MANDOCERR_PROLOG_REP, mdoc->parse, + n->line, n->pos, "Dd"); return(1); } - static int post_bf(POST_ARGS) { @@ -998,7 +1010,7 @@ post_bf(POST_ARGS) np = mdoc->last->pending->parent->head; } else if (MDOC_BLOCK != mdoc->last->type) { np = mdoc->last->parent->head; - } else + } else np = mdoc->last->head; assert(np); @@ -1011,9 +1023,9 @@ post_bf(POST_ARGS) assert(MDOC_BLOCK == np->parent->type); assert(MDOC_Bf == np->parent->tok); - /* + /* * Cannot have both argument and parameter. - * If neither is specified, let it through with a warning. + * If neither is specified, let it through with a warning. */ if (np->parent->args && np->child) { @@ -1025,7 +1037,7 @@ post_bf(POST_ARGS) } /* Extract argument into data. */ - + if (np->parent->args) { arg = np->parent->args->argv[0].arg; if (MDOC_Emphasis == arg) @@ -1047,7 +1059,7 @@ post_bf(POST_ARGS) np->norm->Bf.font = FONT_Li; else if (0 == strcmp(np->child->string, "Sy")) np->norm->Bf.font = FONT_Sy; - else + else mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE); return(1); @@ -1056,34 +1068,25 @@ post_bf(POST_ARGS) static int post_lb(POST_ARGS) { - const char *p; - char *buf; - size_t sz; + struct mdoc_node *n; + const char *stdlibname; + char *libname; check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1); - assert(mdoc->last->child); - assert(MDOC_TEXT == mdoc->last->child->type); + n = mdoc->last->child; - p = mdoc_a2lib(mdoc->last->child->string); + assert(n); + assert(MDOC_TEXT == n->type); - /* If lookup ok, replace with table value. */ + if (NULL == (stdlibname = mdoc_a2lib(n->string))) + mandoc_asprintf(&libname, + "library \\(lq%s\\(rq", n->string); + else + libname = mandoc_strdup(stdlibname); - if (p) { - free(mdoc->last->child->string); - mdoc->last->child->string = mandoc_strdup(p); - return(1); - } - - /* If not, use "library ``xxxx''. */ - - sz = strlen(mdoc->last->child->string) + - 2 + strlen("\\(lqlibrary\\(rq"); - buf = mandoc_malloc(sz); - snprintf(buf, sz, "library \\(lq%s\\(rq", - mdoc->last->child->string); - free(mdoc->last->child->string); - mdoc->last->child->string = buf; + free(n->string); + n->string = libname; return(1); } @@ -1096,7 +1099,6 @@ post_eoln(POST_ARGS) return(1); } - static int post_vt(POST_ARGS) { @@ -1112,42 +1114,35 @@ post_vt(POST_ARGS) if (MDOC_BODY != mdoc->last->type) return(1); - + for (n = mdoc->last->child; n; n = n->next) - if (MDOC_TEXT != n->type) - mdoc_nmsg(mdoc, n, MANDOCERR_CHILD); + if (MDOC_TEXT != n->type) + mandoc_msg(MANDOCERR_VT_CHILD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); return(1); } - static int post_nm(POST_ARGS) { - char buf[BUFSIZ]; - /* If no child specified, make sure we have the meta name. */ - - if (NULL == mdoc->last->child && NULL == mdoc->meta.name) { - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME); + if (NULL != mdoc->meta.name) return(1); - } else if (mdoc->meta.name) - return(1); - /* If no meta name, set it from the child. */ + mdoc_deroff(&mdoc->meta.name, mdoc->last); - if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ)) - return(0); - - mdoc->meta.name = mandoc_strdup(buf); - + if (NULL == mdoc->meta.name) { + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME); + mdoc->meta.name = mandoc_strdup("UNKNOWN"); + } return(1); } static int post_literal(POST_ARGS) { - + /* * The `Dl' (note "el" not "one") and `Bd' macros unset the * MDOC_LITERAL flag as they leave. Note that `Bd' only sets @@ -1174,37 +1169,37 @@ post_defaults(POST_ARGS) if (mdoc->last->child) return(1); - + nn = mdoc->last; mdoc->next = MDOC_NEXT_CHILD; switch (nn->tok) { - case (MDOC_Ar): + case MDOC_Ar: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "file")) return(0); if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "...")) return(0); break; - case (MDOC_At): + case MDOC_At: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "AT&T")) return(0); if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "UNIX")) return(0); break; - case (MDOC_Li): + case MDOC_Li: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "")) return(0); break; - case (MDOC_Pa): + case MDOC_Pa: /* FALLTHROUGH */ - case (MDOC_Mt): + case MDOC_Mt: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~")) return(0); break; default: abort(); /* NOTREACHED */ - } + } mdoc->last = nn; return(1); @@ -1213,37 +1208,28 @@ post_defaults(POST_ARGS) static int post_at(POST_ARGS) { - const char *p, *q; - char *buf; - size_t sz; + struct mdoc_node *n; + const char *std_att; + char *att; /* * If we have a child, look it up in the standard keys. If a * key exist, use that instead of the child; if it doesn't, * prefix "AT&T UNIX " to the existing data. */ - - if (NULL == mdoc->last->child) + + if (NULL == (n = mdoc->last->child)) return(1); - assert(MDOC_TEXT == mdoc->last->child->type); - p = mdoc_a2att(mdoc->last->child->string); - - if (p) { - free(mdoc->last->child->string); - mdoc->last->child->string = mandoc_strdup(p); - } else { + assert(MDOC_TEXT == n->type); + if (NULL == (std_att = mdoc_a2att(n->string))) { mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT); - p = "AT&T UNIX "; - q = mdoc->last->child->string; - sz = strlen(p) + strlen(q) + 1; - buf = mandoc_malloc(sz); - strlcpy(buf, p, sz); - strlcat(buf, q, sz); - free(mdoc->last->child->string); - mdoc->last->child->string = buf; - } + mandoc_asprintf(&att, "AT&T UNIX %s", n->string); + } else + att = mandoc_strdup(std_att); + free(n->string); + n->string = att; return(1); } @@ -1262,8 +1248,24 @@ post_an(POST_ARGS) return(1); } +static int +post_en(POST_ARGS) +{ + if (MDOC_BLOCK == mdoc->last->type) + mdoc->last->norm->Es = mdoc->last_es; + return(1); +} + static int +post_es(POST_ARGS) +{ + + mdoc->last_es = mdoc->last; + return(1); +} + +static int post_it(POST_ARGS) { int i, cols; @@ -1283,37 +1285,37 @@ post_it(POST_ARGS) } switch (lt) { - case (LIST_tag): + case LIST_tag: if (mdoc->last->head->child) break; /* FIXME: give this a dummy value. */ mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS); break; - case (LIST_hang): + case LIST_hang: /* FALLTHROUGH */ - case (LIST_ohang): + case LIST_ohang: /* FALLTHROUGH */ - case (LIST_inset): + case LIST_inset: /* FALLTHROUGH */ - case (LIST_diag): + case LIST_diag: if (NULL == mdoc->last->head->child) mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS); break; - case (LIST_bullet): + case LIST_bullet: /* FALLTHROUGH */ - case (LIST_dash): + case LIST_dash: /* FALLTHROUGH */ - case (LIST_enum): + case LIST_enum: /* FALLTHROUGH */ - case (LIST_hyphen): + case LIST_hyphen: if (NULL == mdoc->last->body->child) mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY); /* FALLTHROUGH */ - case (LIST_item): + case LIST_item: if (mdoc->last->head->child) mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST); break; - case (LIST_column): + case LIST_column: cols = (int)n->norm->Bl.ncols; assert(NULL == mdoc->last->head->child); @@ -1332,9 +1334,9 @@ post_it(POST_ARGS) else er = MANDOCERR_SYNTARGCOUNT; - mandoc_vmsg(er, mdoc->parse, mdoc->last->line, - mdoc->last->pos, - "columns == %d (have %d)", cols, i); + mandoc_vmsg(er, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "columns == %d (have %d)", cols, i); return(MANDOCERR_ARGCOUNT == er); default: break; @@ -1344,9 +1346,9 @@ post_it(POST_ARGS) } static int -post_bl_block(POST_ARGS) +post_bl_block(POST_ARGS) { - struct mdoc_node *n; + struct mdoc_node *n, *ni, *nc; /* * These are fairly complicated, so we've broken them into two @@ -1358,17 +1360,51 @@ post_bl_block(POST_ARGS) n = mdoc->last; - if (LIST_tag == n->norm->Bl.type && - NULL == n->norm->Bl.width) { + if (LIST_tag == n->norm->Bl.type && + NULL == n->norm->Bl.width) { if ( ! post_bl_block_tag(mdoc)) return(0); + assert(n->norm->Bl.width); } else if (NULL != n->norm->Bl.width) { if ( ! post_bl_block_width(mdoc)) return(0); - } else - return(1); + assert(n->norm->Bl.width); + } - assert(n->norm->Bl.width); + for (ni = n->body->child; ni; ni = ni->next) { + if (NULL == ni->body) + continue; + nc = ni->body->last; + while (NULL != nc) { + switch (nc->tok) { + case MDOC_Pp: + /* FALLTHROUGH */ + case MDOC_Lp: + /* FALLTHROUGH */ + case MDOC_br: + break; + default: + nc = NULL; + continue; + } + if (NULL == ni->next) { + mandoc_msg(MANDOCERR_PAR_MOVE, + mdoc->parse, nc->line, nc->pos, + mdoc_macronames[nc->tok]); + if ( ! mdoc_node_relink(mdoc, nc)) + return(0); + } else if (0 == n->norm->Bl.comp && + LIST_column != n->norm->Bl.type) { + mandoc_vmsg(MANDOCERR_PAR_SKIP, + mdoc->parse, nc->line, nc->pos, + "%s before It", + mdoc_macronames[nc->tok]); + mdoc_node_delete(mdoc, nc); + } else + break; + nc = ni->body->last; + } + } return(1); } @@ -1379,7 +1415,7 @@ post_bl_block_width(POST_ARGS) int i; enum mdoct tok; struct mdoc_node *n; - char buf[NUMSIZ]; + char buf[24]; n = mdoc->last; @@ -1405,13 +1441,13 @@ post_bl_block_width(POST_ARGS) assert(n->args); - for (i = 0; i < (int)n->args->argc; i++) + 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); + (void)snprintf(buf, sizeof(buf), "%un", (unsigned int)width); free(n->args->argv[i].value[0]); n->args->argv[i].value[0] = mandoc_strdup(buf); @@ -1426,7 +1462,7 @@ post_bl_block_tag(POST_ARGS) struct mdoc_node *n, *nn; size_t sz, ssz; int i; - char buf[NUMSIZ]; + char buf[24]; /* * Calculate the -width for a `Bl -tag' list if it hasn't been @@ -1457,11 +1493,11 @@ post_bl_block_tag(POST_ARGS) sz = ssz; break; - } + } /* Defaults to ten ens. */ - snprintf(buf, NUMSIZ, "%zun", sz); + (void)snprintf(buf, sizeof(buf), "%un", (unsigned int)sz); /* * We have to dynamically add this to the macro's argument list. @@ -1471,8 +1507,8 @@ post_bl_block_tag(POST_ARGS) 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 = mandoc_reallocarray(n->args->argv, + n->args->argc, sizeof(struct mdoc_argv)); n->args->argv[i].arg = MDOC_Width; n->args->argv[i].line = n->line; @@ -1486,9 +1522,8 @@ post_bl_block_tag(POST_ARGS) return(1); } - static int -post_bl_head(POST_ARGS) +post_bl_head(POST_ARGS) { struct mdoc_node *np, *nn, *nnp; int i, j; @@ -1505,7 +1540,7 @@ post_bl_head(POST_ARGS) /* 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. */ @@ -1519,7 +1554,7 @@ post_bl_head(POST_ARGS) np = mdoc->last->parent; assert(np->args); - for (j = 0; j < (int)np->args->argc; j++) + for (j = 0; j < (int)np->args->argc; j++) if (MDOC_Column == np->args->argv[j].arg) break; @@ -1527,17 +1562,17 @@ post_bl_head(POST_ARGS) assert(0 == np->args->argv[j].sz); /* - * Accomodate for new-style groff column syntax. Shuffle the + * Accommodate 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 *)); + np->args->argv[j].value = mandoc_reallocarray(NULL, + (size_t)mdoc->last->nchild, sizeof(char *)); mdoc->last->norm->Bl.ncols = np->args->argv[j].sz; - mdoc->last->norm->Bl.cols = (const char **)np->args->argv[j].value; + mdoc->last->norm->Bl.cols = (void *)np->args->argv[j].value; for (i = 0, nn = mdoc->last->child; nn; i++) { np->args->argv[j].value[i] = nn->string; @@ -1556,32 +1591,73 @@ post_bl_head(POST_ARGS) static int post_bl(POST_ARGS) { - struct mdoc_node *n; + struct mdoc_node *nparent, *nprev; /* of the Bl block */ + struct mdoc_node *nblock, *nbody; /* of the Bl */ + struct mdoc_node *nchild, *nnext; /* of the Bl body */ - if (MDOC_HEAD == mdoc->last->type) - return(post_bl_head(mdoc)); - if (MDOC_BLOCK == mdoc->last->type) + nbody = mdoc->last; + switch (nbody->type) { + case MDOC_BLOCK: return(post_bl_block(mdoc)); - if (MDOC_BODY != mdoc->last->type) + case MDOC_HEAD: + return(post_bl_head(mdoc)); + case MDOC_BODY: + break; + default: return(1); + } - for (n = mdoc->last->child; n; n = n->next) { - switch (n->tok) { - case (MDOC_Lp): - /* FALLTHROUGH */ - case (MDOC_Pp): - mdoc_nmsg(mdoc, n, MANDOCERR_CHILD); - /* FALLTHROUGH */ - case (MDOC_It): - /* FALLTHROUGH */ - case (MDOC_Sm): + nchild = nbody->child; + while (NULL != nchild) { + if (MDOC_It == nchild->tok || MDOC_Sm == nchild->tok) { + nchild = nchild->next; continue; - default: - break; } - mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD); - return(0); + mandoc_msg(MANDOCERR_BL_MOVE, mdoc->parse, + nchild->line, nchild->pos, + mdoc_macronames[nchild->tok]); + + /* + * Move the node out of the Bl block. + * First, collect all required node pointers. + */ + + nblock = nbody->parent; + nprev = nblock->prev; + nparent = nblock->parent; + nnext = nchild->next; + + /* + * Unlink this child. + */ + + assert(NULL == nchild->prev); + if (0 == --nbody->nchild) { + nbody->child = NULL; + nbody->last = NULL; + assert(NULL == nnext); + } else { + nbody->child = nnext; + nnext->prev = NULL; + } + + /* + * Relink this child. + */ + + nchild->parent = nparent; + nchild->prev = nprev; + nchild->next = nblock; + + nblock->prev = nchild; + nparent->nchild++; + if (NULL == nprev) + nparent->child = nchild; + else + nprev->next = nchild; + + nchild = nnext; } return(1); @@ -1600,10 +1676,16 @@ ebool(struct mdoc *mdoc) assert(MDOC_TEXT == mdoc->last->child->type); - if (0 == strcmp(mdoc->last->child->string, "on")) + if (0 == strcmp(mdoc->last->child->string, "on")) { + if (MDOC_Sm == mdoc->last->tok) + mdoc->flags &= ~MDOC_SMOFF; return(1); - if (0 == strcmp(mdoc->last->child->string, "off")) + } + if (0 == strcmp(mdoc->last->child->string, "off")) { + if (MDOC_Sm == mdoc->last->tok) + mdoc->flags |= MDOC_SMOFF; return(1); + } mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL); return(1); @@ -1612,34 +1694,31 @@ ebool(struct mdoc *mdoc) static int post_root(POST_ARGS) { - int erc; + int ret; struct mdoc_node *n; - erc = 0; + ret = 1; /* Check that we have a finished prologue. */ if ( ! (MDOC_PBODY & mdoc->flags)) { - erc++; + ret = 0; mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG); } 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); - } + if (NULL == n->child) + mdoc_nmsg(mdoc, n, MANDOCERR_DOC_EMPTY); + else if (MDOC_Sh != n->child->tok) + mandoc_msg(MANDOCERR_SEC_BEFORE, mdoc->parse, + n->child->line, n->child->pos, + mdoc_macronames[n->child->tok]); - return(erc ? 0 : 1); + return(ret); } static int @@ -1674,10 +1753,10 @@ post_rs(POST_ARGS) int i, j; switch (mdoc->last->type) { - case (MDOC_HEAD): + case MDOC_HEAD: check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0); return(1); - case (MDOC_BODY): + case MDOC_BODY: if (mdoc->last->child) break; check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0); @@ -1706,11 +1785,20 @@ post_rs(POST_ARGS) } next = nn->next; - mdoc_nmsg(mdoc, nn, MANDOCERR_CHILD); + mandoc_msg(MANDOCERR_RS_SKIP, mdoc->parse, + nn->line, nn->pos, mdoc_macronames[nn->tok]); mdoc_node_delete(mdoc, nn); } /* + * Nothing to sort if only invalid nodes were found + * inside the `Rs' body. + */ + + if (NULL == mdoc->last->child) + return(1); + + /* * The full `Rs' block needs special handling to order the * sub-elements according to `rsord'. Pick through each element * and correctly order it. This is a insertion sort. @@ -1723,13 +1811,13 @@ post_rs(POST_ARGS) if (rsord[i] == nn->tok) break; - /* + /* * Remove `nn' from the chain. This somewhat * repeats mdoc_node_unlink(), but since we're * just re-ordering, there's no need for the * full unlink process. */ - + if (NULL != (next = nn->next)) next->prev = nn->prev; @@ -1738,7 +1826,7 @@ post_rs(POST_ARGS) nn->prev = nn->next = NULL; - /* + /* * Scan back until we reach a node that's * ordered before `nn'. */ @@ -1775,12 +1863,53 @@ post_rs(POST_ARGS) return(1); } +/* + * For some arguments of some macros, + * convert all breakable hyphens into ASCII_HYPH. + */ static int +post_hyph(POST_ARGS) +{ + struct mdoc_node *n, *nch; + char *cp; + + n = mdoc->last; + switch (n->type) { + case MDOC_HEAD: + if (MDOC_Sh == n->tok || MDOC_Ss == n->tok) + break; + return(1); + case MDOC_BODY: + if (MDOC_D1 == n->tok || MDOC_Nd == n->tok) + break; + return(1); + case MDOC_ELEM: + break; + default: + return(1); + } + + for (nch = n->child; nch; nch = nch->next) { + if (MDOC_TEXT != nch->type) + continue; + cp = nch->string; + if ('\0' == *cp) + continue; + while ('\0' != *(++cp)) + if ('-' == *cp && + isalpha((unsigned char)cp[-1]) && + isalpha((unsigned char)cp[1])) + *cp = ASCII_HYPH; + } + return(1); +} + +static int post_ns(POST_ARGS) { if (MDOC_LINE & mdoc->last->flags) - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNNS); + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NS_SKIP); return(1); } @@ -1811,7 +1940,8 @@ post_sh_body(POST_ARGS) */ if (NULL == (n = mdoc->last->child)) { - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC); + mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse, + mdoc->last->line, mdoc->last->pos, "empty"); return(1); } @@ -1820,21 +1950,25 @@ post_sh_body(POST_ARGS) continue; if (MDOC_TEXT == n->type) continue; - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC); + mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); } assert(n); if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok) return(1); - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC); + mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); return(1); } static int post_sh_head(POST_ARGS) { - char buf[BUFSIZ]; + struct mdoc_node *n; + const char *goodsec; + char *secname; enum mdoc_sec sec; /* @@ -1844,31 +1978,51 @@ post_sh_head(POST_ARGS) * manual sections. */ - if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ)) - return(0); + secname = NULL; + sec = SEC_CUSTOM; + mdoc_deroff(&secname, mdoc->last); + sec = NULL == secname ? SEC_CUSTOM : a2sec(secname); - sec = a2sec(buf); - /* The NAME should be first. */ if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed) - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST); + mandoc_msg(MANDOCERR_NAMESEC_FIRST, mdoc->parse, + mdoc->last->line, mdoc->last->pos, secname); /* The SYNOPSIS gets special attention in other areas. */ - if (SEC_SYNOPSIS == sec) + if (SEC_SYNOPSIS == sec) { + roff_setreg(mdoc->roff, "nS", 1, '='); mdoc->flags |= MDOC_SYNOPSIS; - else + } else { + roff_setreg(mdoc->roff, "nS", 0, '='); mdoc->flags &= ~MDOC_SYNOPSIS; + } /* Mark our last section. */ mdoc->lastsec = sec; + /* + * Set the section attribute for the current HEAD, for its + * parent BLOCK, and for the HEAD children; the latter can + * only be TEXT nodes, so no recursion is needed. + * For other blocks and elements, including .Sh BODY, this is + * done when allocating the node data structures, but for .Sh + * BLOCK and HEAD, the section is still unknown at that time. + */ + + mdoc->last->parent->sec = sec; + mdoc->last->sec = sec; + for (n = mdoc->last->child; n; n = n->next) + n->sec = sec; + /* We don't care about custom sections after this. */ - if (SEC_CUSTOM == sec) + if (SEC_CUSTOM == sec) { + free(secname); return(1); + } /* * Check whether our non-custom section is being repeated or is @@ -1876,10 +2030,12 @@ post_sh_head(POST_ARGS) */ if (sec == mdoc->lastnamed) - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP); + mandoc_msg(MANDOCERR_SEC_REP, mdoc->parse, + mdoc->last->line, mdoc->last->pos, secname); if (sec < mdoc->lastnamed) - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO); + mandoc_msg(MANDOCERR_SEC_ORDER, mdoc->parse, + mdoc->last->line, mdoc->last->pos, secname); /* Mark the last named section. */ @@ -1889,24 +2045,37 @@ post_sh_head(POST_ARGS) assert(mdoc->meta.msec); + goodsec = NULL; switch (sec) { - case (SEC_RETURN_VALUES): + case SEC_ERRORS: + if (*mdoc->meta.msec == '4') + break; + goodsec = "2, 3, 4, 9"; /* FALLTHROUGH */ - case (SEC_ERRORS): + case SEC_RETURN_VALUES: /* FALLTHROUGH */ - case (SEC_LIBRARY): + case SEC_LIBRARY: if (*mdoc->meta.msec == '2') break; if (*mdoc->meta.msec == '3') break; + if (NULL == goodsec) + goodsec = "2, 3, 9"; + /* FALLTHROUGH */ + case SEC_CONTEXT: if (*mdoc->meta.msec == '9') break; - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC); + if (NULL == goodsec) + goodsec = "9"; + mandoc_vmsg(MANDOCERR_SEC_MSEC, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "%s for %s only", secname, goodsec); break; default: break; } + free(secname); return(1); } @@ -1920,13 +2089,19 @@ post_ignpar(POST_ARGS) if (NULL != (np = mdoc->last->child)) if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) { - mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR); + mandoc_vmsg(MANDOCERR_PAR_SKIP, + mdoc->parse, np->line, np->pos, + "%s after %s", mdoc_macronames[np->tok], + mdoc_macronames[mdoc->last->tok]); mdoc_node_delete(mdoc, np); } if (NULL != (np = mdoc->last->last)) if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) { - mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR); + mandoc_vmsg(MANDOCERR_PAR_SKIP, mdoc->parse, + np->line, np->pos, "%s at the end of %s", + mdoc_macronames[np->tok], + mdoc_macronames[mdoc->last->tok]); mdoc_node_delete(mdoc, np); } @@ -1942,12 +2117,14 @@ pre_par(PRE_ARGS) if (MDOC_ELEM != n->type && MDOC_BLOCK != n->type) return(1); - /* + /* * Don't allow prior `Lp' or `Pp' prior to a paragraph-type * block: `Lp', `Pp', or non-compact `Bd' or `Bl'. */ - if (MDOC_Pp != mdoc->last->tok && MDOC_Lp != mdoc->last->tok) + if (MDOC_Pp != mdoc->last->tok && + MDOC_Lp != mdoc->last->tok && + MDOC_br != mdoc->last->tok) return(1); if (MDOC_Bl == n->tok && n->norm->Bl.comp) return(1); @@ -1956,12 +2133,43 @@ pre_par(PRE_ARGS) if (MDOC_It == n->tok && n->parent->norm->Bl.comp) return(1); - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR); + mandoc_vmsg(MANDOCERR_PAR_SKIP, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "%s before %s", mdoc_macronames[mdoc->last->tok], + mdoc_macronames[n->tok]); mdoc_node_delete(mdoc, mdoc->last); return(1); } static int +post_par(POST_ARGS) +{ + struct mdoc_node *np; + + if (MDOC_ELEM != mdoc->last->type && + MDOC_BLOCK != mdoc->last->type) + return(1); + + if (NULL == (np = mdoc->last->prev)) { + np = mdoc->last->parent; + if (MDOC_Sh != np->tok && MDOC_Ss != np->tok) + return(1); + } else { + if (MDOC_Pp != np->tok && MDOC_Lp != np->tok && + (MDOC_br != mdoc->last->tok || + (MDOC_sp != np->tok && MDOC_br != np->tok))) + return(1); + } + + mandoc_vmsg(MANDOCERR_PAR_SKIP, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "%s after %s", mdoc_macronames[mdoc->last->tok], + mdoc_macronames[np->tok]); + mdoc_node_delete(mdoc, mdoc->last); + return(1); +} + +static int pre_literal(PRE_ARGS) { @@ -1974,10 +2182,10 @@ pre_literal(PRE_ARGS) */ switch (n->tok) { - case (MDOC_Dl): + case MDOC_Dl: mdoc->flags |= MDOC_LITERAL; break; - case (MDOC_Bd): + case MDOC_Bd: if (DISP_literal == n->norm->Bd.type) mdoc->flags |= MDOC_LITERAL; if (DISP_unfilled == n->norm->Bd.type) @@ -1987,32 +2195,35 @@ pre_literal(PRE_ARGS) abort(); /* NOTREACHED */ } - + return(1); } static int post_dd(POST_ARGS) { - char buf[DATESIZE]; struct mdoc_node *n; + char *datestr; if (mdoc->meta.date) free(mdoc->meta.date); n = mdoc->last; if (NULL == n->child || '\0' == n->child->string[0]) { - mdoc->meta.date = mandoc_normdate - (mdoc->parse, NULL, n->line, n->pos); + mdoc->meta.date = mdoc->quick ? mandoc_strdup("") : + mandoc_normdate(mdoc->parse, NULL, n->line, n->pos); return(1); } - if ( ! concat(mdoc, buf, n->child, DATESIZE)) - return(0); - - mdoc->meta.date = mandoc_normdate - (mdoc->parse, buf, n->line, n->pos); - + datestr = NULL; + mdoc_deroff(&datestr, n); + if (mdoc->quick) + mdoc->meta.date = datestr; + else { + mdoc->meta.date = mandoc_normdate(mdoc->parse, + datestr, n->line, n->pos); + free(datestr); + } return(1); } @@ -2034,23 +2245,21 @@ post_dt(POST_ARGS) mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL; - /* First make all characters uppercase. */ + /* First check that all characters are uppercase. */ if (NULL != (nn = n->child)) for (p = nn->string; *p; p++) { - if (toupper((u_char)*p) == *p) + if (toupper((unsigned 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); + mandoc_msg(MANDOCERR_TITLE_CASE, + mdoc->parse, nn->line, + nn->pos + (p - nn->string), + nn->string); break; } - /* Handles: `.Dt' - * --> title = unknown, volume = local, msec = 0, arch = NULL + /* Handles: `.Dt' + * title = unknown, volume = local, msec = 0, arch = NULL */ if (NULL == (nn = n->child)) { @@ -2062,12 +2271,12 @@ post_dt(POST_ARGS) return(1); } - /* Handles: `.Dt TITLE' - * --> title = TITLE, volume = local, msec = 0, arch = NULL + /* Handles: `.Dt TITLE' + * title = TITLE, volume = local, msec = 0, arch = NULL */ - mdoc->meta.title = mandoc_strdup - ('\0' == nn->string[0] ? "UNKNOWN" : nn->string); + mdoc->meta.title = mandoc_strdup( + '\0' == nn->string[0] ? "UNKNOWN" : nn->string); if (NULL == (nn = nn->next)) { /* FIXME: warn about missing msec. */ @@ -2078,30 +2287,31 @@ post_dt(POST_ARGS) } /* Handles: `.Dt TITLE SEC' - * --> title = TITLE, volume = SEC is msec ? - * format(msec) : SEC, - * msec = SEC is msec ? atoi(msec) : 0, - * arch = NULL + * title = TITLE, + * volume = SEC is msec ? format(msec) : SEC, + * msec = SEC is msec ? atoi(msec) : 0, + * arch = NULL */ - cp = mdoc_a2msec(nn->string); + cp = mandoc_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); + mandoc_msg(MANDOCERR_MSEC_BAD, mdoc->parse, + nn->line, nn->pos, nn->string); 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 + * title = TITLE, + * volume = VOL is vol ? format(VOL) : + * VOL is arch ? format(arch) : + * VOL */ cp = mdoc_a2vol(nn->string); @@ -2109,14 +2319,15 @@ post_dt(POST_ARGS) free(mdoc->meta.vol); mdoc->meta.vol = mandoc_strdup(cp); } else { - /* FIXME: warn about bad arch. */ cp = mdoc_a2arch(nn->string); if (NULL == cp) { + mandoc_msg(MANDOCERR_ARCH_BAD, mdoc->parse, + nn->line, nn->pos, nn->string); free(mdoc->meta.vol); mdoc->meta.vol = mandoc_strdup(nn->string); - } else + } else mdoc->meta.arch = mandoc_strdup(cp); - } + } /* Ignore any subsequent parameters... */ /* FIXME: warn about subsequent parameters. */ @@ -2145,7 +2356,7 @@ post_bx(POST_ARGS) { struct mdoc_node *n; - /* + /* * Make `Bx's second argument always start with an uppercase * letter. Groff checks if it's an "accepted" term, but we just * uppercase blindly. @@ -2153,8 +2364,7 @@ post_bx(POST_ARGS) n = mdoc->last->child; if (n && NULL != (n = n->next)) - *n->string = (char)toupper - ((unsigned char)*n->string); + *n->string = (char)toupper((unsigned char)*n->string); return(1); } @@ -2162,60 +2372,47 @@ post_bx(POST_ARGS) static int post_os(POST_ARGS) { - struct mdoc_node *n; - char buf[BUFSIZ]; #ifndef OSNAME struct utsname utsname; + static char *defbuf; #endif + struct mdoc_node *n; 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(). - */ + * Set the operating system by way of the `Os' macro. + * The order of precedence is: + * 1. the argument of the `Os' macro, unless empty + * 2. the -Ios=foo command line argument, if provided + * 3. -DOSNAME="\"foo\"", if provided during compilation + * 4. "sysname release" from uname(3) + */ + free(mdoc->meta.os); + mdoc->meta.os = NULL; + mdoc_deroff(&mdoc->meta.os, n); if (mdoc->meta.os) - free(mdoc->meta.os); + return(1); - if ( ! concat(mdoc, buf, n->child, BUFSIZ)) - return(0); + if (mdoc->defos) { + mdoc->meta.os = mandoc_strdup(mdoc->defos); + return(1); + } - /* 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); - } + mdoc->meta.os = mandoc_strdup(OSNAME); #else /*!OSNAME */ + if (NULL == defbuf) { if (-1 == uname(&utsname)) { mdoc_nmsg(mdoc, n, MANDOCERR_UNAME); - mdoc->meta.os = mandoc_strdup("UNKNOWN"); - return(post_prol(mdoc)); - } - - if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) { - mdoc_nmsg(mdoc, n, MANDOCERR_MEM); - return(0); - } - if (strlcat(buf, " ", BUFSIZ) >= 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*/ + defbuf = mandoc_strdup("UNKNOWN"); + } else + mandoc_asprintf(&defbuf, "%s %s", + utsname.sysname, utsname.release); } - - mdoc->meta.os = mandoc_strdup(buf); + mdoc->meta.os = mandoc_strdup(defbuf); +#endif /*!OSNAME*/ return(1); } @@ -2237,7 +2434,7 @@ post_std(POST_ARGS) if (NULL == mdoc->meta.name) return(1); - + nn = n; mdoc->next = MDOC_NEXT_CHILD; @@ -2248,45 +2445,12 @@ post_std(POST_ARGS) 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); -} - -static enum mdoc_sec +static enum mdoc_sec a2sec(const char *p) { int i; - for (i = 0; i < (int)SEC__MAX; i++) + for (i = 0; i < (int)SEC__MAX; i++) if (secnames[i] && 0 == strcmp(p, secnames[i])) return((enum mdoc_sec)i); @@ -2298,87 +2462,87 @@ macro2len(enum mdoct macro) { switch (macro) { - case(MDOC_Ad): + case MDOC_Ad: return(12); - case(MDOC_Ao): + case MDOC_Ao: return(12); - case(MDOC_An): + case MDOC_An: return(12); - case(MDOC_Aq): + case MDOC_Aq: return(12); - case(MDOC_Ar): + case MDOC_Ar: return(12); - case(MDOC_Bo): + case MDOC_Bo: return(12); - case(MDOC_Bq): + case MDOC_Bq: return(12); - case(MDOC_Cd): + case MDOC_Cd: return(12); - case(MDOC_Cm): + case MDOC_Cm: return(10); - case(MDOC_Do): + case MDOC_Do: return(10); - case(MDOC_Dq): + case MDOC_Dq: return(12); - case(MDOC_Dv): + case MDOC_Dv: return(12); - case(MDOC_Eo): + case MDOC_Eo: return(12); - case(MDOC_Em): + case MDOC_Em: return(10); - case(MDOC_Er): + case MDOC_Er: return(17); - case(MDOC_Ev): + case MDOC_Ev: return(15); - case(MDOC_Fa): + case MDOC_Fa: return(12); - case(MDOC_Fl): + case MDOC_Fl: return(10); - case(MDOC_Fo): + case MDOC_Fo: return(16); - case(MDOC_Fn): + case MDOC_Fn: return(16); - case(MDOC_Ic): + case MDOC_Ic: return(10); - case(MDOC_Li): + case MDOC_Li: return(16); - case(MDOC_Ms): + case MDOC_Ms: return(6); - case(MDOC_Nm): + case MDOC_Nm: return(10); - case(MDOC_No): + case MDOC_No: return(12); - case(MDOC_Oo): + case MDOC_Oo: return(10); - case(MDOC_Op): + case MDOC_Op: return(14); - case(MDOC_Pa): + case MDOC_Pa: return(32); - case(MDOC_Pf): + case MDOC_Pf: return(12); - case(MDOC_Po): + case MDOC_Po: return(12); - case(MDOC_Pq): + case MDOC_Pq: return(12); - case(MDOC_Ql): + case MDOC_Ql: return(16); - case(MDOC_Qo): + case MDOC_Qo: return(12); - case(MDOC_So): + case MDOC_So: return(12); - case(MDOC_Sq): + case MDOC_Sq: return(12); - case(MDOC_Sy): + case MDOC_Sy: return(6); - case(MDOC_Sx): + case MDOC_Sx: return(16); - case(MDOC_Tn): + case MDOC_Tn: return(10); - case(MDOC_Va): + case MDOC_Va: return(12); - case(MDOC_Vt): + case MDOC_Vt: return(12); - case(MDOC_Xr): + case MDOC_Xr: return(10); default: break;