=================================================================== RCS file: /cvs/mandoc/mdoc_validate.c,v retrieving revision 1.134 retrieving revision 1.209 diff -u -p -r1.134 -r1.209 --- mandoc/mdoc_validate.c 2010/12/01 13:05:13 1.134 +++ mandoc/mdoc_validate.c 2014/04/15 00:41:09 1.209 @@ -1,6 +1,8 @@ -/* $Id: mdoc_validate.c,v 1.134 2010/12/01 13:05:13 kristaps Exp $ */ +/* $Id: mdoc_validate.c,v 1.209 2014/04/15 00:41:09 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons + * 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 @@ -18,7 +20,7 @@ #include "config.h" #endif -#ifndef OSNAME +#ifndef OSNAME #include #endif @@ -32,7 +34,9 @@ #include #include +#include "mdoc.h" #include "mandoc.h" +#include "mandoc_aux.h" #include "libmdoc.h" #include "libmandoc.h" @@ -42,7 +46,6 @@ #define POST_ARGS struct mdoc *mdoc #define NUMSIZ 32 -#define DATESIZ 32 enum check_ineq { CHECK_LT, @@ -53,7 +56,6 @@ enum check_ineq { enum check_lvl { CHECK_WARN, CHECK_ERROR, - CHECK_FATAL }; typedef int (*v_pre)(PRE_ARGS); @@ -71,23 +73,19 @@ static void check_text(struct mdoc *, int, int, char static void check_argv(struct mdoc *, struct mdoc_node *, struct mdoc_argv *); static void check_args(struct mdoc *, struct mdoc_node *); +static enum mdoc_sec a2sec(const char *); +static size_t macro2len(enum mdoct); -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); -static int eerr_eq0(POST_ARGS); -static int eerr_eq1(POST_ARGS); -static int eerr_ge1(POST_ARGS); -static int eerr_le1(POST_ARGS); static int ewarn_eq0(POST_ARGS); +static int ewarn_eq1(POST_ARGS); static int ewarn_ge1(POST_ARGS); -static int herr_eq0(POST_ARGS); -static int herr_ge1(POST_ARGS); +static int ewarn_le1(POST_ARGS); static int hwarn_eq0(POST_ARGS); static int hwarn_eq1(POST_ARGS); +static int hwarn_ge1(POST_ARGS); static int hwarn_le1(POST_ARGS); static int post_an(POST_ARGS); @@ -98,15 +96,20 @@ 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_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_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_par(POST_ARGS); static int post_prol(POST_ARGS); static int post_root(POST_ARGS); static int post_rs(POST_ARGS); @@ -136,30 +139,34 @@ static v_post posts_bd[] = { post_literal, hwarn_eq0, static v_post posts_bf[] = { hwarn_le1, post_bf, NULL }; static v_post posts_bk[] = { hwarn_eq0, bwarn_ge1, NULL }; static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL }; -static v_post posts_bool[] = { eerr_eq1, ebool, NULL }; +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_dd[] = { ewarn_ge1, post_dd, post_prol, NULL }; -static v_post posts_dl[] = { post_literal, bwarn_ge1, herr_eq0, 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_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[] = { eerr_eq1, post_lb, NULL }; -static v_post posts_nd[] = { berr_ge1, NULL }; +static v_post posts_lb[] = { post_lb, 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_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_pp[] = { post_par, ewarn_eq0, NULL }; +static v_post posts_rs[] = { post_rs, 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[] = { eerr_ge1, NULL }; -static v_post posts_text1[] = { eerr_eq1, 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, herr_eq0, NULL }; -static v_post posts_wtext[] = { ewarn_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 }; @@ -167,109 +174,107 @@ 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, NULL }; +static v_pre pres_it[] = { pre_it, pre_par, 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 }; static v_pre pres_ss[] = { pre_ss, NULL }; static v_pre pres_std[] = { pre_std, NULL }; -const struct valids mdoc_valids[MDOC_MAX] = { +static const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ap */ { 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_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 */ { NULL, NULL }, /* El */ { pres_it, posts_it }, /* It */ - { NULL, posts_text }, /* Ad */ + { NULL, NULL }, /* Ad */ { pres_an, posts_an }, /* An */ { NULL, posts_defaults }, /* Ar */ - { NULL, posts_text }, /* Cd */ + { NULL, NULL }, /* Cd */ { NULL, NULL }, /* Cm */ { NULL, NULL }, /* Dv */ - { pres_er, posts_text }, /* Er */ + { NULL, NULL }, /* Er */ { NULL, NULL }, /* Ev */ { pres_std, posts_std }, /* Ex */ { NULL, NULL }, /* Fa */ - { pres_fd, posts_wtext }, /* Fd */ + { NULL, posts_text }, /* Fd */ { NULL, NULL }, /* Fl */ - { NULL, posts_text }, /* Fn */ - { NULL, posts_wtext }, /* Ft */ - { NULL, posts_text }, /* Ic */ + { 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, posts_wline }, /* Op */ + { NULL, NULL }, /* Op */ { NULL, NULL }, /* Ot */ { NULL, posts_defaults }, /* Pa */ { pres_std, posts_std }, /* Rv */ { NULL, posts_st }, /* St */ { NULL, NULL }, /* Va */ { NULL, posts_vt }, /* Vt */ - { NULL, posts_wtext }, /* Xr */ + { NULL, posts_text }, /* Xr */ { NULL, posts_text }, /* %A */ - { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */ - { NULL, posts_text }, /* %D */ /* FIXME: check date with mandoc_a2time(). */ + { 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, posts_wline }, /* Aq */ + { NULL, NULL }, /* Aq */ { NULL, posts_at }, /* At */ { NULL, NULL }, /* Bc */ { NULL, posts_bf }, /* Bf */ { NULL, NULL }, /* Bo */ - { NULL, posts_wline }, /* Bq */ + { NULL, NULL }, /* Bq */ { NULL, NULL }, /* Bsx */ - { NULL, NULL }, /* Bx */ + { NULL, posts_bx }, /* Bx */ { NULL, posts_bool }, /* Db */ { NULL, NULL }, /* Dc */ { NULL, NULL }, /* Do */ - { NULL, posts_wline }, /* Dq */ + { NULL, NULL }, /* Dq */ { NULL, NULL }, /* Ec */ { NULL, NULL }, /* Ef */ { NULL, NULL }, /* Em */ { NULL, NULL }, /* Eo */ { NULL, NULL }, /* Fx */ - { NULL, posts_text }, /* Ms */ + { NULL, NULL }, /* Ms */ { NULL, posts_notext }, /* No */ - { NULL, posts_notext }, /* Ns */ + { NULL, posts_ns }, /* Ns */ { NULL, NULL }, /* Nx */ { NULL, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ { NULL, posts_text1 }, /* Pf */ { NULL, NULL }, /* Po */ - { NULL, posts_wline }, /* Pq */ + { NULL, NULL }, /* Pq */ { NULL, NULL }, /* Qc */ - { NULL, posts_wline }, /* Ql */ + { NULL, NULL }, /* Ql */ { NULL, NULL }, /* Qo */ - { NULL, posts_wline }, /* Qq */ + { NULL, NULL }, /* Qq */ { NULL, NULL }, /* Re */ { NULL, posts_rs }, /* Rs */ { NULL, NULL }, /* Sc */ { NULL, NULL }, /* So */ - { NULL, posts_wline }, /* Sq */ + { NULL, NULL }, /* Sq */ { NULL, posts_bool }, /* Sm */ - { NULL, posts_text }, /* Sx */ - { NULL, posts_text }, /* Sy */ - { NULL, posts_text }, /* Tn */ + { NULL, posts_hyph }, /* Sx */ + { NULL, NULL }, /* Sy */ + { NULL, NULL }, /* Tn */ { NULL, NULL }, /* Ux */ { NULL, NULL }, /* Xc */ { NULL, NULL }, /* Xo */ @@ -284,10 +289,10 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Fr */ { NULL, posts_eoln }, /* Ud */ { NULL, posts_lb }, /* Lb */ - { NULL, posts_notext }, /* Lp */ - { NULL, posts_text }, /* Lk */ + { pres_pp, posts_pp }, /* Lp */ + { NULL, NULL }, /* Lk */ { NULL, posts_defaults }, /* Mt */ - { NULL, posts_wline }, /* Brq */ + { NULL, NULL }, /* Brq */ { NULL, NULL }, /* Bro */ { NULL, NULL }, /* Brc */ { NULL, posts_text }, /* %C */ @@ -295,10 +300,11 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* 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. */ @@ -312,14 +318,39 @@ 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] = { + NULL, + "NAME", + "LIBRARY", + "SYNOPSIS", + "DESCRIPTION", + "CONTEXT", + "IMPLEMENTATION NOTES", + "RETURN VALUES", + "ENVIRONMENT", + "FILES", + "EXIT STATUS", + "EXAMPLES", + "DIAGNOSTICS", + "COMPATIBILITY", + "ERRORS", + "SEE ALSO", + "STANDARDS", + "HISTORY", + "AUTHORS", + "CAVEATS", + "BUGS", + "SECURITY CONSIDERATIONS", + NULL +}; int mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) @@ -328,12 +359,21 @@ mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) int line, pos; char *tp; - if (MDOC_TEXT == n->type) { + switch (n->type) { + case (MDOC_TEXT): tp = n->string; line = n->line; pos = n->pos; check_text(mdoc, line, pos, tp); + /* FALLTHROUGH */ + case (MDOC_TBL): + /* FALLTHROUGH */ + case (MDOC_EQN): + /* FALLTHROUGH */ + case (MDOC_ROOT): return(1); + default: + break; } check_args(mdoc, n); @@ -356,10 +396,18 @@ mdoc_valid_post(struct mdoc *mdoc) return(1); mdoc->last->flags |= MDOC_VALID; - if (MDOC_TEXT == mdoc->last->type) + switch (mdoc->last->type) { + case (MDOC_TEXT): + /* FALLTHROUGH */ + case (MDOC_EQN): + /* FALLTHROUGH */ + case (MDOC_TBL): return(1); - if (MDOC_ROOT == mdoc->last->type) + case (MDOC_ROOT): return(post_root(mdoc)); + default: + break; + } if (NULL == mdoc_valids[mdoc->last->tok].post) return(1); @@ -371,28 +419,29 @@ mdoc_valid_post(struct mdoc *mdoc) } 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): p = "less than "; - if (m->last->nchild < val) + if (mdoc->last->nchild < val) return(1); break; case (CHECK_GT): - p = "greater than "; - if (m->last->nchild > val) + p = "more than "; + if (mdoc->last->nchild > val) return(1); break; case (CHECK_EQ): p = ""; - if (val == m->last->nchild) + if (val == mdoc->last->nchild) return(1); break; default: @@ -400,26 +449,18 @@ check_count(struct mdoc *m, enum mdoc_type type, /* NOTREACHED */ } - if (CHECK_WARN == lvl) { - return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT, - m->last->line, m->last->pos, - "want %s%d children (have %d)", - 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)", - p, val, m->last->nchild)); + t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT; + mandoc_vmsg(t, mdoc->parse, mdoc->last->line, mdoc->last->pos, + "want %s%d children (have %d)", + p, val, mdoc->last->nchild); + return(1); } static int berr_ge1(POST_ARGS) { - return(check_count(mdoc, MDOC_BODY, CHECK_FATAL, CHECK_GT, 0)); + return(check_count(mdoc, MDOC_BODY, CHECK_ERROR, CHECK_GT, 0)); } static int @@ -429,54 +470,30 @@ bwarn_ge1(POST_ARGS) } static int -eerr_eq0(POST_ARGS) +ewarn_eq0(POST_ARGS) { - return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_EQ, 0)); + return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0)); } static int -eerr_eq1(POST_ARGS) +ewarn_eq1(POST_ARGS) { - return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_EQ, 1)); + return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1)); } static int -eerr_ge1(POST_ARGS) -{ - return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_GT, 0)); -} - -static int -eerr_le1(POST_ARGS) -{ - return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_LT, 2)); -} - -static int -ewarn_eq0(POST_ARGS) -{ - return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0)); -} - -static int ewarn_ge1(POST_ARGS) { return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0)); } static int -herr_eq0(POST_ARGS) +ewarn_le1(POST_ARGS) { - return(check_count(mdoc, MDOC_HEAD, CHECK_FATAL, CHECK_EQ, 0)); + return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2)); } static int -herr_ge1(POST_ARGS) -{ - return(check_count(mdoc, MDOC_HEAD, CHECK_FATAL, CHECK_GT, 0)); -} - -static int hwarn_eq0(POST_ARGS) { return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0)); @@ -489,13 +506,19 @@ hwarn_eq1(POST_ARGS) } static int +hwarn_ge1(POST_ARGS) +{ + return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_GT, 0)); +} + +static int hwarn_le1(POST_ARGS) { return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_LT, 2)); } static void -check_args(struct mdoc *m, struct mdoc_node *n) +check_args(struct mdoc *mdoc, struct mdoc_node *n) { int i; @@ -504,53 +527,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 @@ -562,10 +566,9 @@ check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type (t == n->parent->type)) return(1); - mdoc_vmsg(mdoc, MANDOCERR_SYNTCHILD, - 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); } @@ -575,22 +578,18 @@ pre_display(PRE_ARGS) { struct mdoc_node *node; - /* Display elements (`Bd', `D1'...) cannot be nested. */ - if (MDOC_BLOCK != n->type) return(1); - /* LINTED */ for (node = mdoc->last->parent; node; node = node->parent) if (MDOC_BLOCK == node->type) if (MDOC_Bd == node->tok) break; - if (NULL == node) - return(1); + if (node) + mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP); - mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP); - return(0); + return(1); } @@ -612,8 +611,6 @@ pre_bl(PRE_ARGS) assert(np); assert(MDOC_BLOCK == np->type); assert(MDOC_Bl == np->tok); - assert(np->data.Bl); - n->data.Bl = np->data.Bl; return(1); } @@ -623,9 +620,6 @@ pre_bl(PRE_ARGS) * ones. If we find no list type, we default to LIST_item. */ - assert(NULL == n->data.Bl); - n->data.Bl = mandoc_calloc(1, sizeof(struct mdoc_bl)); - /* LINTED */ for (i = 0; n->args && i < (int)n->args->argc; i++) { lt = LIST__NONE; @@ -668,18 +662,23 @@ pre_bl(PRE_ARGS) break; /* Set list arguments. */ case (MDOC_Compact): - dup = n->data.Bl->comp; + dup = n->norm->Bl.comp; comp = 1; break; case (MDOC_Width): - dup = (NULL != n->data.Bl->width); - width = n->args->argv[i].value[0]; + /* 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): /* NB: this can be empty! */ if (n->args->argv[i].sz) { offs = n->args->argv[i].value[0]; - dup = (NULL != n->data.Bl->offs); + dup = (NULL != n->norm->Bl.offs); break; } mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); @@ -694,36 +693,36 @@ pre_bl(PRE_ARGS) mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP); if (comp && ! dup) - n->data.Bl->comp = comp; + n->norm->Bl.comp = comp; if (offs && ! dup) - n->data.Bl->offs = offs; + n->norm->Bl.offs = offs; if (width && ! dup) - n->data.Bl->width = width; + n->norm->Bl.width = width; /* Check: multiple list types. */ - if (LIST__NONE != lt && n->data.Bl->type != LIST__NONE) + if (LIST__NONE != lt && n->norm->Bl.type != LIST__NONE) mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP); /* Assign list type. */ - if (LIST__NONE != lt && n->data.Bl->type == LIST__NONE) { - n->data.Bl->type = lt; + if (LIST__NONE != lt && n->norm->Bl.type == LIST__NONE) { + n->norm->Bl.type = lt; /* Set column information, too. */ if (LIST_column == lt) { - n->data.Bl->ncols = + n->norm->Bl.ncols = n->args->argv[i].sz; - n->data.Bl->cols = (const char **) + n->norm->Bl.cols = (void *) n->args->argv[i].value; } } /* The list type should come first. */ - if (n->data.Bl->type == LIST__NONE) - if (n->data.Bl->width || - n->data.Bl->offs || - n->data.Bl->comp) + if (n->norm->Bl.type == LIST__NONE) + if (n->norm->Bl.width || + n->norm->Bl.offs || + n->norm->Bl.comp) mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST); continue; @@ -731,22 +730,22 @@ pre_bl(PRE_ARGS) /* Allow lists to default to LIST_item. */ - if (LIST__NONE == n->data.Bl->type) { + if (LIST__NONE == n->norm->Bl.type) { mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE); - n->data.Bl->type = LIST_item; + 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->data.Bl->type) { + switch (n->norm->Bl.type) { case (LIST_tag): - if (n->data.Bl->width) - break; - mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); + if (NULL == n->norm->Bl.width) + mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); break; case (LIST_column): /* FALLTHROUGH */ @@ -757,10 +756,21 @@ pre_bl(PRE_ARGS) case (LIST_inset): /* FALLTHROUGH */ case (LIST_item): - if (NULL == n->data.Bl->width) - break; - mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG); + 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; } @@ -787,14 +797,9 @@ pre_bd(PRE_ARGS) assert(np); assert(MDOC_BLOCK == np->type); assert(MDOC_Bd == np->tok); - assert(np->data.Bd); - n->data.Bd = np->data.Bd; return(1); } - assert(NULL == n->data.Bd); - n->data.Bd = mandoc_calloc(1, sizeof(struct mdoc_bd)); - /* LINTED */ for (i = 0; n->args && i < (int)n->args->argc; i++) { dt = DISP__NONE; @@ -824,14 +829,14 @@ pre_bd(PRE_ARGS) /* NB: this can be empty! */ if (n->args->argv[i].sz) { offs = n->args->argv[i].value[0]; - dup = (NULL != n->data.Bd->offs); + dup = (NULL != n->norm->Bd.offs); break; } mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV); break; case (MDOC_Compact): comp = 1; - dup = n->data.Bd->comp; + dup = n->norm->Bd.comp; break; default: abort(); @@ -846,24 +851,24 @@ pre_bd(PRE_ARGS) /* Make our auxiliary assignments. */ if (offs && ! dup) - n->data.Bd->offs = offs; + n->norm->Bd.offs = offs; if (comp && ! dup) - n->data.Bd->comp = comp; + n->norm->Bd.comp = comp; /* Check whether a type has already been assigned. */ - if (DISP__NONE != dt && n->data.Bd->type != DISP__NONE) + if (DISP__NONE != dt && n->norm->Bd.type != DISP__NONE) mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP); /* Make our type assignment. */ - if (DISP__NONE != dt && n->data.Bd->type == DISP__NONE) - n->data.Bd->type = dt; + if (DISP__NONE != dt && n->norm->Bd.type == DISP__NONE) + n->norm->Bd.type = dt; } - if (DISP__NONE == n->data.Bd->type) { + if (DISP__NONE == n->norm->Bd.type) { mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE); - n->data.Bd->type = DISP_ragged; + n->norm->Bd.type = DISP_ragged; } return(1); @@ -886,8 +891,6 @@ 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)); } @@ -899,10 +902,6 @@ 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? - */ return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); } @@ -920,9 +919,9 @@ pre_an(PRE_ARGS) n->args->argv[i].pos, MANDOCERR_IGNARGV); if (MDOC_Split == n->args->argv[0].arg) - n->data.An.auth = AUTH_split; + n->norm->An.auth = AUTH_split; else if (MDOC_Nosplit == n->args->argv[0].arg) - n->data.An.auth = AUTH_nosplit; + n->norm->An.auth = AUTH_nosplit; else abort(); @@ -945,7 +944,7 @@ static int pre_dt(PRE_ARGS) { - if (0 == mdoc->meta.date || mdoc->meta.os) + if (NULL == mdoc->meta.date || mdoc->meta.os) mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); if (mdoc->meta.title) @@ -958,7 +957,7 @@ static int pre_os(PRE_ARGS) { - if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) + if (NULL == mdoc->meta.title || NULL == mdoc->meta.date) mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO); if (mdoc->meta.os) @@ -1004,15 +1003,12 @@ post_bf(POST_ARGS) assert(np); assert(MDOC_HEAD == np->type); assert(MDOC_Bf == np->tok); - assert(np->data.Bf); - mdoc->last->data.Bf = np->data.Bf; return(1); } np = mdoc->last; assert(MDOC_BLOCK == np->parent->type); assert(MDOC_Bf == np->parent->tok); - np->data.Bf = mandoc_calloc(1, sizeof(struct mdoc_bf)); /* * Cannot have both argument and parameter. @@ -1032,11 +1028,11 @@ post_bf(POST_ARGS) if (np->parent->args) { arg = np->parent->args->argv[0].arg; if (MDOC_Emphasis == arg) - np->data.Bf->font = FONT_Em; + np->norm->Bf.font = FONT_Em; else if (MDOC_Literal == arg) - np->data.Bf->font = FONT_Li; + np->norm->Bf.font = FONT_Li; else if (MDOC_Symbolic == arg) - np->data.Bf->font = FONT_Sy; + np->norm->Bf.font = FONT_Sy; else abort(); return(1); @@ -1045,11 +1041,11 @@ post_bf(POST_ARGS) /* Extract parameter into data. */ if (0 == strcmp(np->child->string, "Em")) - np->data.Bf->font = FONT_Em; + np->norm->Bf.font = FONT_Em; else if (0 == strcmp(np->child->string, "Li")) - np->data.Bf->font = FONT_Li; + np->norm->Bf.font = FONT_Li; else if (0 == strcmp(np->child->string, "Sy")) - np->data.Bf->font = FONT_Sy; + np->norm->Bf.font = FONT_Sy; else mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE); @@ -1063,6 +1059,8 @@ post_lb(POST_ARGS) char *buf; size_t sz; + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1); + assert(mdoc->last->child); assert(MDOC_TEXT == mdoc->last->child->type); @@ -1106,12 +1104,11 @@ post_vt(POST_ARGS) /* * The Vt macro comes in both ELEM and BLOCK form, both of which * have different syntaxes (yet more context-sensitive - * behaviour). ELEM types must have a child; BLOCK types, + * behaviour). ELEM types must have a child, which is already + * guaranteed by the in_line parsing routine; BLOCK types, * specifically the BODY, should only have TEXT children. */ - if (MDOC_ELEM == mdoc->last->type) - return(eerr_ge1(mdoc)); if (MDOC_BODY != mdoc->last->type) return(1); @@ -1126,23 +1123,16 @@ post_vt(POST_ARGS) 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); } @@ -1255,17 +1245,12 @@ post_an(POST_ARGS) struct mdoc_node *np; np = mdoc->last; - if (AUTH__NONE != np->data.An.auth && np->child) - return(eerr_eq0(mdoc)); + if (AUTH__NONE == np->norm->An.auth) { + if (0 == np->child) + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0); + } else if (np->child) + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0); - /* - * 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); - - mdoc_nmsg(mdoc, np, MANDOCERR_NOARGS); return(1); } @@ -1273,7 +1258,7 @@ post_an(POST_ARGS) static int post_it(POST_ARGS) { - int i, cols, rc; + int i, cols; enum mdoc_list lt; struct mdoc_node *n, *c; enum mandocerr er; @@ -1282,8 +1267,7 @@ post_it(POST_ARGS) return(1); n = mdoc->last->parent->parent; - assert(n->data.Bl); - lt = n->data.Bl->type; + lt = n->norm->Bl.type; if (LIST__NONE == lt) { mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE); @@ -1322,7 +1306,7 @@ post_it(POST_ARGS) mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST); break; case (LIST_column): - cols = (int)n->data.Bl->ncols; + cols = (int)n->norm->Bl.ncols; assert(NULL == mdoc->last->head->child); @@ -1340,10 +1324,10 @@ post_it(POST_ARGS) else er = MANDOCERR_SYNTARGCOUNT; - rc = mdoc_vmsg(mdoc, er, - mdoc->last->line, mdoc->last->pos, + mandoc_vmsg(er, mdoc->parse, mdoc->last->line, + mdoc->last->pos, "columns == %d (have %d)", cols, i); - return(rc); + return(MANDOCERR_ARGCOUNT == er); default: break; } @@ -1354,7 +1338,7 @@ post_it(POST_ARGS) static int 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 @@ -1366,17 +1350,46 @@ post_bl_block(POST_ARGS) n = mdoc->last; - if (LIST_tag == n->data.Bl->type && - NULL == n->data.Bl->width) { + if (LIST_tag == n->norm->Bl.type && + NULL == n->norm->Bl.width) { if ( ! post_bl_block_tag(mdoc)) return(0); - } else if (NULL != n->data.Bl->width) { + 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->data.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) { + mdoc_nmsg(mdoc, nc, MANDOCERR_MOVEPAR); + if ( ! mdoc_node_relink(mdoc, nc)) + return(0); + } else if (0 == n->norm->Bl.comp && + LIST_column != n->norm->Bl.type) { + mdoc_nmsg(mdoc, nc, MANDOCERR_IGNPAR); + mdoc_node_delete(mdoc, nc); + } else + break; + nc = ni->body->last; + } + } return(1); } @@ -1400,11 +1413,11 @@ post_bl_block_width(POST_ARGS) * the macro's width as set in share/tmac/mdoc/doc-common. */ - if (0 == strcmp(n->data.Bl->width, "Ds")) + if (0 == strcmp(n->norm->Bl.width, "Ds")) width = 6; - else if (MDOC_MAX == (tok = mdoc_hash_find(n->data.Bl->width))) + else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width))) return(1); - else if (0 == (width = mdoc_macro2len(tok))) { + else if (0 == (width = macro2len(tok))) { mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH); return(1); } @@ -1419,12 +1432,12 @@ post_bl_block_width(POST_ARGS) assert(i < (int)n->args->argc); - snprintf(buf, NUMSIZ, "%zun", width); + snprintf(buf, NUMSIZ, "%un", (unsigned int)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]; + n->norm->Bl.width = n->args->argv[i].value[0]; return(1); } @@ -1453,28 +1466,23 @@ post_bl_block_tag(POST_ARGS) 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); + if (nn == NULL) break; - } if (MDOC_TEXT == nn->type) { sz = strlen(nn->string) + 1; break; } - if (0 != (ssz = mdoc_macro2len(nn->tok))) + if (0 != (ssz = macro2len(nn->tok))) sz = ssz; - else - mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG); break; } /* Defaults to ten ens. */ - snprintf(buf, NUMSIZ, "%zun", sz); + snprintf(buf, NUMSIZ, "%un", (unsigned int)sz); /* * We have to dynamically add this to the macro's argument list. @@ -1495,7 +1503,7 @@ post_bl_block_tag(POST_ARGS) n->args->argv[i].value[0] = mandoc_strdup(buf); /* Set our width! */ - n->data.Bl->width = n->args->argv[i].value[0]; + n->norm->Bl.width = n->args->argv[i].value[0]; return(1); } @@ -1506,7 +1514,7 @@ post_bl_head(POST_ARGS) struct mdoc_node *np, *nn, *nnp; int i, j; - if (LIST_column != mdoc->last->data.Bl->type) + if (LIST_column != mdoc->last->norm->Bl.type) /* FIXME: this should be ERROR class... */ return(hwarn_eq0(mdoc)); @@ -1523,7 +1531,7 @@ post_bl_head(POST_ARGS) * lists, but I'll leave that for another day. */ - if (mdoc->last->data.Bl->ncols && mdoc->last->nchild) { + if (mdoc->last->norm->Bl.ncols && mdoc->last->nchild) { mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS); return(0); } else if (NULL == mdoc->last->child) @@ -1540,7 +1548,7 @@ 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. */ @@ -1549,8 +1557,8 @@ post_bl_head(POST_ARGS) 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; + mdoc->last->norm->Bl.ncols = np->args->argv[j].sz; + 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; @@ -1569,31 +1577,71 @@ 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); - if (NULL == mdoc->last->child) - return(1); + } - /* - * We only allow certain children of `Bl'. This is usually on - * `It', but apparently `Sm' occurs here and there, so we let - * that one through, too. - */ - - /* LINTED */ - for (n = mdoc->last->child; n; n = n->next) { - if (MDOC_BLOCK == n->type && MDOC_It == n->tok) + nchild = nbody->child; + while (NULL != nchild) { + if (MDOC_It == nchild->tok || MDOC_Sm == nchild->tok) { + nchild = nchild->next; continue; - if (MDOC_Sm == n->tok) - continue; - mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD); - return(0); + } + + mdoc_nmsg(mdoc, nchild, MANDOCERR_CHILD); + + /* + * 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); @@ -1603,15 +1651,25 @@ static int ebool(struct mdoc *mdoc) { - if (NULL == mdoc->last->child) + if (NULL == mdoc->last->child) { + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY); + mdoc_node_delete(mdoc, mdoc->last); return(1); + } + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1); 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); @@ -1653,18 +1711,23 @@ post_root(POST_ARGS) static int post_st(POST_ARGS) { - const char *p; + struct mdoc_node *ch; + const char *p; - assert(MDOC_TEXT == mdoc->last->child->type); + if (NULL == (ch = mdoc->last->child)) { + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY); + mdoc_node_delete(mdoc, mdoc->last); + return(1); + } - p = mdoc_a2st(mdoc->last->child->string); + assert(MDOC_TEXT == ch->type); - if (p == NULL) { + if (NULL == (p = mdoc_a2st(ch->string))) { mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD); mdoc_node_delete(mdoc, mdoc->last); } else { - free(mdoc->last->child->string); - mdoc->last->child->string = mandoc_strdup(p); + free(ch->string); + ch->string = mandoc_strdup(p); } return(1); @@ -1676,8 +1739,18 @@ post_rs(POST_ARGS) struct mdoc_node *nn, *next, *prev; int i, j; - if (MDOC_BODY != mdoc->last->type) + switch (mdoc->last->type) { + case (MDOC_HEAD): + check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0); return(1); + case (MDOC_BODY): + if (mdoc->last->child) + break; + check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0); + return(1); + default: + return(1); + } /* * Make sure only certain types of nodes are allowed within the @@ -1692,6 +1765,8 @@ post_rs(POST_ARGS) break; if (i < RSORD_MAX) { + if (MDOC__J == rsord[i] || MDOC__B == rsord[i]) + mdoc->last->norm->Rs.quote_T++; next = nn->next; continue; } @@ -1702,6 +1777,14 @@ post_rs(POST_ARGS) } /* + * 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. @@ -1766,7 +1849,57 @@ 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); + return(1); +} + +static int post_sh(POST_ARGS) { @@ -1816,7 +1949,8 @@ post_sh_body(POST_ARGS) static int post_sh_head(POST_ARGS) { - char buf[BUFSIZ]; + struct mdoc_node *n; + char *secname; enum mdoc_sec sec; /* @@ -1826,11 +1960,11 @@ 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 = mdoc_str2sec(buf); - /* The NAME should be first. */ if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed) @@ -1838,19 +1972,38 @@ post_sh_head(POST_ARGS) /* 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 @@ -1872,45 +2025,79 @@ post_sh_head(POST_ARGS) assert(mdoc->meta.msec); switch (sec) { - case (SEC_RETURN_VALUES): - /* FALLTHROUGH */ case (SEC_ERRORS): + if (*mdoc->meta.msec == '4') + break; /* FALLTHROUGH */ + case (SEC_RETURN_VALUES): + /* FALLTHROUGH */ case (SEC_LIBRARY): if (*mdoc->meta.msec == '2') break; if (*mdoc->meta.msec == '3') break; + /* FALLTHROUGH */ + case (SEC_CONTEXT): if (*mdoc->meta.msec == '9') break; - mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC); + mandoc_msg(MANDOCERR_SECMSEC, mdoc->parse, + mdoc->last->line, mdoc->last->pos, secname); break; default: break; } + free(secname); return(1); } static int +post_ignpar(POST_ARGS) +{ + struct mdoc_node *np; + + if (MDOC_BODY != mdoc->last->type) + return(1); + + if (NULL != (np = mdoc->last->child)) + if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) { + mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR); + 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); + mdoc_node_delete(mdoc, np); + } + + return(1); +} + +static int pre_par(PRE_ARGS) { if (NULL == mdoc->last) return(1); + 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->data.Bl->comp) + if (MDOC_Bl == n->tok && n->norm->Bl.comp) return(1); - if (MDOC_Bd == n->tok && n->data.Bd->comp) + if (MDOC_Bd == n->tok && n->norm->Bd.comp) return(1); + if (MDOC_It == n->tok && n->parent->norm->Bl.comp) + return(1); mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR); mdoc_node_delete(mdoc, mdoc->last); @@ -1918,6 +2105,32 @@ pre_par(PRE_ARGS) } static int +post_par(POST_ARGS) +{ + + if (MDOC_ELEM != mdoc->last->type && + MDOC_BLOCK != mdoc->last->type) + return(1); + + if (NULL == mdoc->last->prev) { + if (MDOC_Sh != mdoc->last->parent->tok && + MDOC_Ss != mdoc->last->parent->tok) + return(1); + } else { + if (MDOC_Pp != mdoc->last->prev->tok && + MDOC_Lp != mdoc->last->prev->tok && + (MDOC_br != mdoc->last->tok || + (MDOC_sp != mdoc->last->prev->tok && + MDOC_br != mdoc->last->prev->tok))) + return(1); + } + + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR); + mdoc_node_delete(mdoc, mdoc->last); + return(1); +} + +static int pre_literal(PRE_ARGS) { @@ -1934,10 +2147,9 @@ pre_literal(PRE_ARGS) mdoc->flags |= MDOC_LITERAL; break; case (MDOC_Bd): - assert(n->data.Bd); - if (DISP_literal == n->data.Bd->type) + if (DISP_literal == n->norm->Bd.type) mdoc->flags |= MDOC_LITERAL; - if (DISP_unfilled == n->data.Bd->type) + if (DISP_unfilled == n->norm->Bd.type) mdoc->flags |= MDOC_LITERAL; break; default: @@ -1951,27 +2163,28 @@ pre_literal(PRE_ARGS) static int post_dd(POST_ARGS) { - char buf[DATESIZ]; struct mdoc_node *n; + char *datestr; - n = mdoc->last; + if (mdoc->meta.date) + free(mdoc->meta.date); - if (NULL == n->child) { - mdoc->meta.date = time(NULL); + n = mdoc->last; + if (NULL == n->child || '\0' == n->child->string[0]) { + mdoc->meta.date = mdoc->quick ? mandoc_strdup("") : + mandoc_normdate(mdoc->parse, NULL, n->line, n->pos); 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); + 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); } @@ -1997,7 +2210,7 @@ post_dt(POST_ARGS) if (NULL != (nn = n->child)) for (p = nn->string; *p; p++) { - if (toupper((u_char)*p) == *p) + if (toupper((unsigned char)*p) == *p) continue; /* @@ -2043,7 +2256,7 @@ post_dt(POST_ARGS) * 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); @@ -2068,9 +2281,9 @@ 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) { + mdoc_nmsg(mdoc, nn, MANDOCERR_BADVOLARCH); free(mdoc->meta.vol); mdoc->meta.vol = mandoc_strdup(nn->string); } else @@ -2100,59 +2313,68 @@ post_prol(POST_ARGS) } static int +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. + */ + + n = mdoc->last->child; + if (n && NULL != (n = n->next)) + *n->string = (char)toupper + ((unsigned char)*n->string); + + return(1); +} + +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 (-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*/ + if (NULL == defbuf) { + if (-1 == uname(&utsname)) { + mdoc_nmsg(mdoc, n, MANDOCERR_UNAME); + 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); } @@ -2185,36 +2407,107 @@ post_std(POST_ARGS) return(1); } -static int -concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz) +static enum mdoc_sec +a2sec(const char *p) { + int i; - p[0] = '\0'; + for (i = 0; i < (int)SEC__MAX; i++) + if (secnames[i] && 0 == strcmp(p, secnames[i])) + return((enum mdoc_sec)i); - /* - * 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. - */ + return(SEC_CUSTOM); +} - for ( ; n; n = n->next) { - assert(MDOC_TEXT == n->type); +static size_t +macro2len(enum mdoct macro) +{ - 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); + switch (macro) { + case(MDOC_Ad): + return(12); + case(MDOC_Ao): + return(12); + case(MDOC_An): + return(12); + case(MDOC_Aq): + return(12); + case(MDOC_Ar): + return(12); + case(MDOC_Bo): + return(12); + case(MDOC_Bq): + return(12); + case(MDOC_Cd): + return(12); + case(MDOC_Cm): + return(10); + case(MDOC_Do): + return(10); + case(MDOC_Dq): + return(12); + case(MDOC_Dv): + return(12); + case(MDOC_Eo): + return(12); + case(MDOC_Em): + return(10); + case(MDOC_Er): + return(17); + case(MDOC_Ev): + return(15); + case(MDOC_Fa): + return(12); + case(MDOC_Fl): + return(10); + case(MDOC_Fo): + return(16); + case(MDOC_Fn): + return(16); + case(MDOC_Ic): + return(10); + case(MDOC_Li): + return(16); + case(MDOC_Ms): + return(6); + case(MDOC_Nm): + return(10); + case(MDOC_No): + return(12); + case(MDOC_Oo): + return(10); + case(MDOC_Op): + return(14); + case(MDOC_Pa): + return(32); + case(MDOC_Pf): + return(12); + case(MDOC_Po): + return(12); + case(MDOC_Pq): + return(12); + case(MDOC_Ql): + return(16); + case(MDOC_Qo): + return(12); + case(MDOC_So): + return(12); + case(MDOC_Sq): + return(12); + case(MDOC_Sy): + return(6); + case(MDOC_Sx): + return(16); + case(MDOC_Tn): + return(10); + case(MDOC_Va): + return(12); + case(MDOC_Vt): + return(12); + case(MDOC_Xr): + return(10); + default: + break; + }; + return(0); } -