=================================================================== RCS file: /cvs/mandoc/mdoc_validate.c,v retrieving revision 1.13 retrieving revision 1.266 diff -u -p -r1.13 -r1.266 --- mandoc/mdoc_validate.c 2009/06/17 11:02:06 1.13 +++ mandoc/mdoc_validate.c 2015/02/03 00:48:47 1.266 @@ -1,6 +1,8 @@ -/* $Id: mdoc_validate.c,v 1.13 2009/06/17 11:02:06 kristaps Exp $ */ +/* $Id: mdoc_validate.c,v 1.266 2015/02/03 00:48:47 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2015 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 @@ -14,1437 +16,2487 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include "config.h" + #include +#ifndef OSNAME +#include +#endif #include #include -#include +#include +#include #include #include +#include +#include "mdoc.h" +#include "mandoc.h" +#include "mandoc_aux.h" #include "libmdoc.h" +#include "libmandoc.h" /* FIXME: .Bl -diag can't have non-text children in HEAD. */ -/* TODO: ignoring Pp (it's superfluous in some invocations). */ -#define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n -#define POST_ARGS struct mdoc *mdoc +#define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n +#define POST_ARGS struct mdoc *mdoc -enum merr { - ETOOLONG, - EESCAPE, - EPRINT, - ENODATA, - ENOPROLOGUE, - ELINE, - EATT, - ENAME, - ELISTTYPE, - EDISPTYPE, - EMULTIDISP, - ESECNAME, - EMULTILIST, - EARGREP, - EBOOL, - ENESTDISP +enum check_ineq { + CHECK_LT, + CHECK_GT, + CHECK_EQ }; -enum mwarn { - WPRINT, - WNOWIDTH, - WMISSWIDTH, - WESCAPE, - WDEPESC, - WDEPCOL, - WWRONGMSEC, - WSECOOO, - WSECREP, - WBADSTAND, - WNAMESECINC, - WNOMULTILINE, - WMULTILINE, - WLINE, - WNOLINE, - WPROLOOO, - WPROLREP, - WARGVAL, - WBADSEC, - WBADMSEC +enum check_lvl { + CHECK_WARN, + CHECK_ERROR, }; -typedef int (*v_pre)(PRE_ARGS); -typedef int (*v_post)(POST_ARGS); +typedef void (*v_pre)(PRE_ARGS); +typedef void (*v_post)(POST_ARGS); struct valids { - v_pre *pre; - v_post *post; + v_pre pre; + v_post post; }; -static int pwarn(struct mdoc *, int, int, enum mwarn); -static int perr(struct mdoc *, int, int, enum merr); -static int check_parent(PRE_ARGS, int, enum mdoc_type); -static int check_msec(PRE_ARGS, ...); -static int check_sec(PRE_ARGS, ...); -static int check_stdarg(PRE_ARGS); -static int check_text(struct mdoc *, int, int, const char *); -static int check_argv(struct mdoc *, - const struct mdoc_node *, - const struct mdoc_argv *); -static int check_args(struct mdoc *, - const struct mdoc_node *); -static int err_child_lt(struct mdoc *, const char *, int); -static int warn_child_lt(struct mdoc *, const char *, int); -static int err_child_gt(struct mdoc *, const char *, int); -static int warn_child_gt(struct mdoc *, const char *, int); -static int err_child_eq(struct mdoc *, const char *, int); -static int warn_child_eq(struct mdoc *, const char *, int); -static int count_child(struct mdoc *); -static int warn_print(struct mdoc *, int, int); -static int warn_count(struct mdoc *, const char *, - int, const char *, int); -static int err_count(struct mdoc *, const char *, - int, const char *, int); -static int pre_an(PRE_ARGS); -static int pre_bd(PRE_ARGS); -static int pre_bl(PRE_ARGS); -static int pre_cd(PRE_ARGS); -static int pre_dd(PRE_ARGS); -static int pre_display(PRE_ARGS); -static int pre_dt(PRE_ARGS); -static int pre_er(PRE_ARGS); -static int pre_ex(PRE_ARGS); -static int pre_fd(PRE_ARGS); -static int pre_it(PRE_ARGS); -static int pre_lb(PRE_ARGS); -static int pre_os(PRE_ARGS); -static int pre_rv(PRE_ARGS); -static int pre_sh(PRE_ARGS); -static int pre_ss(PRE_ARGS); -static int herr_ge1(POST_ARGS); -static int hwarn_le1(POST_ARGS); -static int herr_eq0(POST_ARGS); -static int eerr_eq0(POST_ARGS); -static int eerr_le2(POST_ARGS); -static int eerr_eq1(POST_ARGS); -static int eerr_ge1(POST_ARGS); -static int ewarn_eq0(POST_ARGS); -static int ewarn_eq1(POST_ARGS); -static int bwarn_ge1(POST_ARGS); -static int hwarn_eq1(POST_ARGS); -static int ewarn_ge1(POST_ARGS); -static int ebool(POST_ARGS); -static int post_an(POST_ARGS); -static int post_args(POST_ARGS); -static int post_at(POST_ARGS); -static int post_bf(POST_ARGS); -static int post_bl(POST_ARGS); -static int post_it(POST_ARGS); -static int post_nm(POST_ARGS); -static int post_root(POST_ARGS); -static int post_sh(POST_ARGS); -static int post_sh_body(POST_ARGS); -static int post_sh_head(POST_ARGS); -static int post_st(POST_ARGS); +static void check_count(struct mdoc *, enum mdoc_type, + enum check_lvl, enum check_ineq, int); +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 int child_an(const struct mdoc_node *); +static enum mdoc_sec a2sec(const char *); +static size_t macro2len(enum mdoct); +static void rewrite_macro2len(char **); -#define vwarn(m, t) nwarn((m), (m)->last, (t)) -#define verr(m, t) nerr((m), (m)->last, (t)) -#define nwarn(m, n, t) pwarn((m), (n)->line, (n)->pos, (t)) -#define nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t)) +static void bwarn_ge1(POST_ARGS); +static void ewarn_eq1(POST_ARGS); +static void ewarn_ge1(POST_ARGS); +static void hwarn_eq0(POST_ARGS); -static v_pre pres_an[] = { pre_an, NULL }; -static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; -static v_pre pres_bl[] = { pre_bl, NULL }; -static v_pre pres_cd[] = { pre_cd, NULL }; -static v_pre pres_dd[] = { pre_dd, NULL }; -static v_pre pres_d1[] = { pre_display, NULL }; -static v_pre pres_dt[] = { pre_dt, NULL }; -static v_pre pres_er[] = { pre_er, NULL }; -static v_pre pres_ex[] = { pre_ex, NULL }; -static v_pre pres_fd[] = { pre_fd, NULL }; -static v_pre pres_it[] = { pre_it, NULL }; -static v_pre pres_lb[] = { pre_lb, NULL }; -static v_pre pres_os[] = { pre_os, NULL }; -static v_pre pres_rv[] = { pre_rv, NULL }; -static v_pre pres_sh[] = { pre_sh, NULL }; -static v_pre pres_ss[] = { pre_ss, NULL }; -static v_post posts_bool[] = { eerr_eq1, ebool, NULL }; -static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL }; -static v_post posts_text[] = { eerr_ge1, NULL }; -static v_post posts_wtext[] = { ewarn_ge1, NULL }; -static v_post posts_notext[] = { eerr_eq0, NULL }; -static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL }; -static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; -static v_post posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL }; -static v_post posts_it[] = { post_it, NULL }; -static v_post posts_in[] = { ewarn_eq1, NULL }; -static v_post posts_ss[] = { herr_ge1, NULL }; -static v_post posts_pf[] = { eerr_eq1, NULL }; -static v_post posts_lb[] = { eerr_eq1, NULL }; -static v_post posts_st[] = { eerr_eq1, post_st, NULL }; -static v_post posts_pp[] = { ewarn_eq0, NULL }; -static v_post posts_ex[] = { eerr_eq0, post_args, NULL }; -static v_post posts_rv[] = { eerr_eq0, post_args, NULL }; -static v_post posts_an[] = { post_an, NULL }; -static v_post posts_at[] = { post_at, NULL }; -static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL }; -static v_post posts_nm[] = { post_nm, NULL }; -static v_post posts_bf[] = { hwarn_le1, post_bf, NULL }; -static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL }; +static void post_an(POST_ARGS); +static void post_at(POST_ARGS); +static void post_bf(POST_ARGS); +static void post_bk(POST_ARGS); +static void post_bl(POST_ARGS); +static void post_bl_block(POST_ARGS); +static void post_bl_block_tag(POST_ARGS); +static void post_bl_head(POST_ARGS); +static void post_bx(POST_ARGS); +static void post_d1(POST_ARGS); +static void post_defaults(POST_ARGS); +static void post_dd(POST_ARGS); +static void post_dt(POST_ARGS); +static void post_en(POST_ARGS); +static void post_es(POST_ARGS); +static void post_eoln(POST_ARGS); +static void post_ex(POST_ARGS); +static void post_fa(POST_ARGS); +static void post_fn(POST_ARGS); +static void post_fname(POST_ARGS); +static void post_fo(POST_ARGS); +static void post_hyph(POST_ARGS); +static void post_hyphtext(POST_ARGS); +static void post_ignpar(POST_ARGS); +static void post_it(POST_ARGS); +static void post_lb(POST_ARGS); +static void post_literal(POST_ARGS); +static void post_nd(POST_ARGS); +static void post_nm(POST_ARGS); +static void post_ns(POST_ARGS); +static void post_os(POST_ARGS); +static void post_par(POST_ARGS); +static void post_root(POST_ARGS); +static void post_rs(POST_ARGS); +static void post_sh(POST_ARGS); +static void post_sh_head(POST_ARGS); +static void post_sh_name(POST_ARGS); +static void post_sh_see_also(POST_ARGS); +static void post_sh_authors(POST_ARGS); +static void post_sm(POST_ARGS); +static void post_st(POST_ARGS); +static void post_vt(POST_ARGS); -const struct valids mdoc_valids[MDOC_MAX] = { +static void pre_an(PRE_ARGS); +static void pre_bd(PRE_ARGS); +static void pre_bl(PRE_ARGS); +static void pre_dd(PRE_ARGS); +static void pre_display(PRE_ARGS); +static void pre_dt(PRE_ARGS); +static void pre_literal(PRE_ARGS); +static void pre_obsolete(PRE_ARGS); +static void pre_os(PRE_ARGS); +static void pre_par(PRE_ARGS); +static void pre_std(PRE_ARGS); + +static const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ap */ - { pres_dd, posts_text }, /* Dd */ - { pres_dt, NULL }, /* Dt */ - { pres_os, NULL }, /* Os */ - { pres_sh, posts_sh }, /* Sh */ - { pres_ss, posts_ss }, /* Ss */ - { NULL, posts_pp }, /* Pp */ - { pres_d1, posts_wline }, /* D1 */ - { pres_d1, posts_wline }, /* Dl */ - { pres_bd, posts_bd }, /* Bd */ + { pre_dd, post_dd }, /* Dd */ + { pre_dt, post_dt }, /* Dt */ + { pre_os, post_os }, /* Os */ + { NULL, post_sh }, /* Sh */ + { NULL, post_ignpar }, /* Ss */ + { pre_par, post_par }, /* Pp */ + { pre_display, post_d1 }, /* D1 */ + { pre_literal, post_literal }, /* Dl */ + { pre_bd, post_literal }, /* Bd */ { NULL, NULL }, /* Ed */ - { pres_bl, posts_bl }, /* Bl */ + { pre_bl, post_bl }, /* Bl */ { NULL, NULL }, /* El */ - { pres_it, posts_it }, /* It */ - { NULL, posts_text }, /* Ad */ - { pres_an, posts_an }, /* An */ - { NULL, NULL }, /* Ar */ - { pres_cd, posts_text }, /* Cd */ + { pre_par, post_it }, /* It */ + { NULL, NULL }, /* Ad */ + { pre_an, post_an }, /* An */ + { NULL, post_defaults }, /* Ar */ + { NULL, NULL }, /* Cd */ { NULL, NULL }, /* Cm */ - { NULL, NULL }, /* Dv */ - { pres_er, posts_text }, /* Er */ - { NULL, NULL }, /* Ev */ - { pres_ex, posts_ex }, /* Ex */ - { NULL, NULL }, /* Fa */ - { pres_fd, posts_wtext }, /* Fd */ + { NULL, NULL }, /* Dv */ + { NULL, NULL }, /* Er */ + { NULL, NULL }, /* Ev */ + { pre_std, post_ex }, /* Ex */ + { NULL, post_fa }, /* Fa */ + { NULL, ewarn_ge1 }, /* Fd */ { NULL, NULL }, /* Fl */ - { NULL, posts_text }, /* Fn */ - { NULL, posts_wtext }, /* Ft */ - { NULL, posts_text }, /* Ic */ - { NULL, posts_in }, /* In */ - { NULL, NULL }, /* Li */ - { NULL, posts_wtext }, /* Nd */ - { NULL, posts_nm }, /* Nm */ - { NULL, posts_wline }, /* Op */ - { NULL, NULL }, /* Ot */ - { NULL, NULL }, /* Pa */ - { pres_rv, posts_rv }, /* Rv */ - { NULL, posts_st }, /* St */ + { NULL, post_fn }, /* Fn */ + { NULL, NULL }, /* Ft */ + { NULL, NULL }, /* Ic */ + { NULL, ewarn_eq1 }, /* In */ + { NULL, post_defaults }, /* Li */ + { NULL, post_nd }, /* Nd */ + { NULL, post_nm }, /* Nm */ + { NULL, NULL }, /* Op */ + { pre_obsolete, NULL }, /* Ot */ + { NULL, post_defaults }, /* Pa */ + { pre_std, NULL }, /* Rv */ + { NULL, post_st }, /* St */ { NULL, NULL }, /* Va */ - { NULL, posts_text }, /* Vt */ - { NULL, posts_xr }, /* Xr */ - { NULL, posts_text }, /* %A */ - { NULL, posts_text }, /* %B */ - { NULL, posts_text }, /* %D */ - { NULL, posts_text }, /* %I */ - { NULL, posts_text }, /* %J */ - { NULL, posts_text }, /* %N */ - { NULL, posts_text }, /* %O */ - { NULL, posts_text }, /* %P */ - { NULL, posts_text }, /* %R */ - { NULL, posts_text }, /* %T */ - { NULL, posts_text }, /* %V */ + { NULL, post_vt }, /* Vt */ + { NULL, ewarn_ge1 }, /* Xr */ + { NULL, ewarn_ge1 }, /* %A */ + { NULL, post_hyphtext }, /* %B */ /* FIXME: can be used outside Rs/Re. */ + { NULL, ewarn_ge1 }, /* %D */ + { NULL, ewarn_ge1 }, /* %I */ + { NULL, ewarn_ge1 }, /* %J */ + { NULL, post_hyphtext }, /* %N */ + { NULL, post_hyphtext }, /* %O */ + { NULL, ewarn_ge1 }, /* %P */ + { NULL, post_hyphtext }, /* %R */ + { NULL, post_hyphtext }, /* %T */ /* FIXME: can be used outside Rs/Re. */ + { NULL, ewarn_ge1 }, /* %V */ { NULL, NULL }, /* Ac */ { NULL, NULL }, /* Ao */ - { NULL, posts_wline }, /* Aq */ - { NULL, posts_at }, /* At */ + { NULL, NULL }, /* Aq */ + { NULL, post_at }, /* At */ { NULL, NULL }, /* Bc */ - { NULL, posts_bf }, /* Bf */ + { NULL, post_bf }, /* Bf */ { NULL, NULL }, /* Bo */ - { NULL, posts_wline }, /* Bq */ + { NULL, NULL }, /* Bq */ { NULL, NULL }, /* Bsx */ - { NULL, NULL }, /* Bx */ - { NULL, posts_bool }, /* Db */ + { NULL, post_bx }, /* Bx */ + { pre_obsolete, NULL }, /* 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 }, /* Ef */ + { NULL, NULL }, /* Em */ { NULL, NULL }, /* Eo */ { NULL, NULL }, /* Fx */ - { NULL, posts_text }, /* Ms */ - { NULL, posts_notext }, /* No */ - { NULL, posts_notext }, /* Ns */ + { NULL, NULL }, /* Ms */ + { NULL, NULL }, /* No */ + { NULL, post_ns }, /* Ns */ { NULL, NULL }, /* Nx */ { NULL, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ - { NULL, posts_pf }, /* Pf */ + { NULL, NULL }, /* 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_wline }, /* Rs */ + { NULL, post_rs }, /* Rs */ { NULL, NULL }, /* Sc */ { NULL, NULL }, /* So */ - { NULL, posts_wline }, /* Sq */ - { NULL, posts_bool }, /* Sm */ - { NULL, posts_text }, /* Sx */ - { NULL, posts_text }, /* Sy */ - { NULL, posts_text }, /* Tn */ + { NULL, NULL }, /* Sq */ + { NULL, post_sm }, /* Sm */ + { NULL, post_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, post_fo }, /* Fo */ + { NULL, NULL }, /* Fc */ { NULL, NULL }, /* Oo */ { NULL, NULL }, /* Oc */ - { NULL, posts_wline }, /* Bk */ + { NULL, post_bk }, /* Bk */ { NULL, NULL }, /* Ek */ - { NULL, posts_notext }, /* Bt */ + { NULL, post_eoln }, /* Bt */ { NULL, NULL }, /* Hf */ - { NULL, NULL }, /* Fr */ - { NULL, posts_notext }, /* Ud */ - { pres_lb, posts_lb }, /* Lb */ - { NULL, posts_pp }, /* Lp */ - { NULL, NULL }, /* Lk */ - { NULL, posts_text }, /* Mt */ - { NULL, posts_wline }, /* Brq */ - { NULL, NULL }, /* Bro */ - { NULL, NULL }, /* Brc */ - { NULL, posts_text }, /* %C */ - { NULL, NULL }, /* Es */ - { NULL, NULL }, /* En */ + { pre_obsolete, NULL }, /* Fr */ + { NULL, post_eoln }, /* Ud */ + { NULL, post_lb }, /* Lb */ + { pre_par, post_par }, /* Lp */ + { NULL, NULL }, /* Lk */ + { NULL, post_defaults }, /* Mt */ + { NULL, NULL }, /* Brq */ + { NULL, NULL }, /* Bro */ + { NULL, NULL }, /* Brc */ + { NULL, ewarn_ge1 }, /* %C */ + { pre_obsolete, post_es }, /* Es */ + { pre_obsolete, post_en }, /* En */ { NULL, NULL }, /* Dx */ - { NULL, posts_text }, /* %Q */ + { NULL, ewarn_ge1 }, /* %Q */ + { NULL, post_par }, /* br */ + { NULL, post_par }, /* sp */ + { NULL, ewarn_eq1 }, /* %U */ + { NULL, NULL }, /* Ta */ + { NULL, NULL }, /* ll */ }; +#define RSORD_MAX 14 /* Number of `Rs' blocks. */ -#ifdef __linux__ -extern size_t strlcat(char *, const char *, size_t); -#endif +static const enum mdoct rsord[RSORD_MAX] = { + MDOC__A, + MDOC__T, + MDOC__B, + MDOC__I, + MDOC__J, + MDOC__R, + MDOC__N, + MDOC__V, + MDOC__U, + MDOC__P, + MDOC__Q, + MDOC__C, + 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, - const struct mdoc_node *n) + +void +mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) { - v_pre *p; - int line, pos; - const char *tp; + v_pre p; - if (MDOC_TEXT == n->type) { - tp = n->string; - line = n->line; - pos = n->pos; - return(check_text(mdoc, line, pos, tp)); + switch (n->type) { + case MDOC_TEXT: + check_text(mdoc, n->line, n->pos, n->string); + /* FALLTHROUGH */ + case MDOC_TBL: + /* FALLTHROUGH */ + case MDOC_EQN: + /* FALLTHROUGH */ + case MDOC_ROOT: + return; + default: + break; } - if ( ! check_args(mdoc, n)) - return(0); - if (NULL == mdoc_valids[n->tok].pre) - return(1); - for (p = mdoc_valids[n->tok].pre; *p; p++) - if ( ! (*p)(mdoc, n)) - return(0); - return(1); + check_args(mdoc, n); + p = mdoc_valids[n->tok].pre; + if (*p) + (*p)(mdoc, n); } - -int +void mdoc_valid_post(struct mdoc *mdoc) { - v_post *p; + struct mdoc_node *n; + v_post p; - /* - * This check occurs after the macro's children have been filled - * in: postfix validation. Since this happens when we're - * rewinding the scope tree, it's possible to have multiple - * invocations (as by design, for now), we set bit MDOC_VALID to - * indicate that we've validated. - */ + n = mdoc->last; + if (n->flags & MDOC_VALID) + return; + n->flags |= MDOC_VALID; - if (MDOC_VALID & mdoc->last->flags) - return(1); - mdoc->last->flags |= MDOC_VALID; + switch (n->type) { + case MDOC_TEXT: + /* FALLTHROUGH */ + case MDOC_EQN: + /* FALLTHROUGH */ + case MDOC_TBL: + break; + case MDOC_ROOT: + post_root(mdoc); + break; + default: - if (MDOC_TEXT == mdoc->last->type) - return(1); - if (MDOC_ROOT == mdoc->last->type) - return(post_root(mdoc)); + /* + * Closing delimiters are not special at the + * beginning of a block, opening delimiters + * are not special at the end. + */ - if (NULL == mdoc_valids[mdoc->last->tok].post) - return(1); - for (p = mdoc_valids[mdoc->last->tok].post; *p; p++) - if ( ! (*p)(mdoc)) - return(0); + if (n->child != NULL) + n->child->flags &= ~MDOC_DELIMC; + if (n->last != NULL) + n->last->flags &= ~MDOC_DELIMO; - return(1); -} + /* Call the macro's postprocessor. */ - -static int -perr(struct mdoc *m, int line, int pos, enum merr type) -{ - char *p; - - p = NULL; - switch (type) { - case (ETOOLONG): - p = "text argument too long"; + p = mdoc_valids[n->tok].post; + if (*p) + (*p)(mdoc); break; - case (EESCAPE): - p = "invalid escape sequence"; - break; - case (EPRINT): - p = "invalid character"; - break; - case (ENESTDISP): - p = "displays may not be nested"; - break; - case (EBOOL): - p = "expected boolean value"; - break; - case (EARGREP): - p = "argument repeated"; - break; - case (EMULTIDISP): - p = "multiple display types specified"; - break; - case (EMULTILIST): - p = "multiple list types specified"; - break; - case (ELISTTYPE): - p = "missing list type"; - break; - case (EDISPTYPE): - p = "missing display type"; - break; - case (ESECNAME): - p = "the NAME section must come first"; - break; - case (ELINE): - p = "expected line arguments"; - break; - case (ENOPROLOGUE): - p = "document has no prologue"; - break; - case (ENODATA): - p = "document has no data"; - break; - case (EATT): - p = "expected valid AT&T symbol"; - break; - case (ENAME): - p = "default name not yet set"; - break; } - assert(p); - return(mdoc_perr(m, line, pos, p)); } - -static int -pwarn(struct mdoc *m, int line, int pos, enum mwarn type) +static void +check_count(struct mdoc *mdoc, enum mdoc_type type, + enum check_lvl lvl, enum check_ineq ineq, int val) { - char *p; - enum mdoc_warn c; + const char *p; + enum mandocerr t; - c = WARN_SYNTAX; - p = NULL; - switch (type) { - case (WBADMSEC): - p = "inappropriate manual section"; - c = WARN_COMPAT; + if (mdoc->last->type != type) + return; + + switch (ineq) { + case CHECK_LT: + p = "less than "; + if (mdoc->last->nchild < val) + return; break; - case (WBADSEC): - p = "inappropriate document section"; - c = WARN_COMPAT; + case CHECK_GT: + p = "more than "; + if (mdoc->last->nchild > val) + return; break; - case (WARGVAL): - p = "argument value suggested"; - c = WARN_COMPAT; + case CHECK_EQ: + p = ""; + if (val == mdoc->last->nchild) + return; break; - case (WPROLREP): - p = "prologue macros repeated"; - c = WARN_COMPAT; - break; - case (WPROLOOO): - p = "prologue macros out-of-order"; - c = WARN_COMPAT; - break; - case (WDEPCOL): - p = "deprecated column argument syntax"; - c = WARN_COMPAT; - break; - case (WNOWIDTH): - p = "superfluous width argument"; - break; - case (WMISSWIDTH): - p = "missing width argument"; - break; - case (WPRINT): - p = "invalid character"; - break; - case (WESCAPE): - p = "invalid escape sequence"; - break; - case (WDEPESC): - p = "deprecated special-character escape"; - break; - case (WNOLINE): - p = "suggested no line arguments"; - break; - case (WLINE): - p = "suggested line arguments"; - break; - case (WMULTILINE): - p = "suggested multi-line arguments"; - break; - case (WNOMULTILINE): - p = "suggested no multi-line arguments"; - break; - case (WWRONGMSEC): - p = "document section in wrong manual section"; - c = WARN_COMPAT; - break; - case (WSECOOO): - p = "document section out of conventional order"; - break; - case (WSECREP): - p = "document section repeated"; - break; - case (WBADSTAND): - p = "unknown standard"; - break; - case (WNAMESECINC): - p = "NAME section contents incomplete/badly-ordered"; - break; + default: + abort(); + /* NOTREACHED */ } - assert(p); - return(mdoc_pwarn(m, line, pos, c, p)); + + 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); } +static void +bwarn_ge1(POST_ARGS) +{ + check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0); +} -static int -warn_print(struct mdoc *m, int ln, int pos) +static void +ewarn_eq1(POST_ARGS) { - if (MDOC_IGN_CHARS & m->pflags) - return(pwarn(m, ln, pos, WPRINT)); - return(perr(m, ln, pos, EPRINT)); + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1); } +static void +ewarn_ge1(POST_ARGS) +{ + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0); +} -static inline int -warn_count(struct mdoc *m, const char *k, - int want, const char *v, int has) +static void +hwarn_eq0(POST_ARGS) { + check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0); +} - return(mdoc_warn(m, WARN_SYNTAX, - "suggests %s %s %d (has %d)", v, k, want, has)); +static void +check_args(struct mdoc *mdoc, struct mdoc_node *n) +{ + int i; + + if (NULL == n->args) + return; + + assert(n->args->argc); + for (i = 0; i < (int)n->args->argc; i++) + check_argv(mdoc, n, &n->args->argv[i]); } +static void +check_argv(struct mdoc *mdoc, struct mdoc_node *n, struct mdoc_argv *v) +{ + int i; -static inline int -err_count(struct mdoc *m, const char *k, - int want, const char *v, int has) + for (i = 0; i < (int)v->sz; i++) + check_text(mdoc, v->line, v->pos, v->value[i]); +} + +static void +check_text(struct mdoc *mdoc, int ln, int pos, char *p) { + char *cp; - return(mdoc_err(m, - "requires %s %s %d (has %d)", v, k, want, has)); + if (MDOC_LITERAL & mdoc->flags) + return; + + for (cp = p; NULL != (p = strchr(p, '\t')); p++) + mandoc_msg(MANDOCERR_FI_TAB, mdoc->parse, + ln, pos + (int)(p - cp), NULL); } +static void +pre_display(PRE_ARGS) +{ + struct mdoc_node *node; -static inline int -count_child(struct mdoc *mdoc) + if (MDOC_BLOCK != n->type) + return; + + for (node = mdoc->last->parent; node; node = node->parent) + if (MDOC_BLOCK == node->type) + if (MDOC_Bd == node->tok) + break; + + if (node) + mandoc_vmsg(MANDOCERR_BD_NEST, + mdoc->parse, n->line, n->pos, + "%s in Bd", mdoc_macronames[n->tok]); +} + +static void +pre_bl(PRE_ARGS) { + struct mdoc_node *np; + struct mdoc_argv *argv, *wa; int i; - struct mdoc_node *n; + enum mdocargt mdoclt; + enum mdoc_list lt; - for (i = 0, n = mdoc->last->child; n; n = n->next, i++) - /* Do nothing */ ; + if (MDOC_BLOCK != n->type) { + if (ENDBODY_NOT != n->end) { + assert(n->pending); + np = n->pending->parent; + } else + np = n->parent; - return(i); -} + assert(np); + assert(MDOC_BLOCK == np->type); + assert(MDOC_Bl == np->tok); + return; + } + /* + * 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. + */ -/* - * Build these up with macros because they're basically the same check - * for different inequalities. Yes, this could be done with functions, - * but this is reasonable for now. - */ + wa = (n->args == NULL) ? NULL : n->args->argv; + mdoclt = MDOC_ARG_MAX; + for (i = 0; n->args && i < (int)n->args->argc; i++) { + argv = n->args->argv + i; + lt = LIST__NONE; + switch (argv->arg) { + /* Set list types. */ + case MDOC_Bullet: + lt = LIST_bullet; + break; + case MDOC_Dash: + lt = LIST_dash; + break; + case MDOC_Enum: + lt = LIST_enum; + break; + case MDOC_Hyphen: + lt = LIST_hyphen; + break; + case MDOC_Item: + lt = LIST_item; + break; + case MDOC_Tag: + lt = LIST_tag; + break; + case MDOC_Diag: + lt = LIST_diag; + break; + case MDOC_Hang: + lt = LIST_hang; + break; + case MDOC_Ohang: + lt = LIST_ohang; + break; + case MDOC_Inset: + lt = LIST_inset; + break; + case MDOC_Column: + lt = LIST_column; + break; + /* Set list arguments. */ + case MDOC_Compact: + if (n->norm->Bl.comp) + mandoc_msg(MANDOCERR_ARG_REP, + mdoc->parse, argv->line, + argv->pos, "Bl -compact"); + n->norm->Bl.comp = 1; + break; + case MDOC_Width: + wa = argv; + if (0 == argv->sz) { + mandoc_msg(MANDOCERR_ARG_EMPTY, + mdoc->parse, argv->line, + argv->pos, "Bl -width"); + n->norm->Bl.width = "0n"; + break; + } + if (NULL != n->norm->Bl.width) + mandoc_vmsg(MANDOCERR_ARG_REP, + mdoc->parse, argv->line, + argv->pos, "Bl -width %s", + argv->value[0]); + rewrite_macro2len(argv->value); + n->norm->Bl.width = argv->value[0]; + break; + case MDOC_Offset: + if (0 == argv->sz) { + mandoc_msg(MANDOCERR_ARG_EMPTY, + mdoc->parse, argv->line, + argv->pos, "Bl -offset"); + break; + } + if (NULL != n->norm->Bl.offs) + mandoc_vmsg(MANDOCERR_ARG_REP, + mdoc->parse, argv->line, + argv->pos, "Bl -offset %s", + argv->value[0]); + rewrite_macro2len(argv->value); + n->norm->Bl.offs = argv->value[0]; + break; + default: + continue; + } + if (LIST__NONE == lt) + continue; + mdoclt = argv->arg; -#define CHECK_CHILD_DEFN(lvl, name, ineq) \ -static int \ -lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \ -{ \ - int i; \ - if ((i = count_child(mdoc)) ineq sz) \ - return(1); \ - return(lvl##_count(mdoc, #ineq, sz, p, i)); \ -} + /* Check: multiple list types. */ -#define CHECK_BODY_DEFN(name, lvl, func, num) \ -static int \ -b##lvl##_##name(POST_ARGS) \ -{ \ - if (MDOC_BODY != mdoc->last->type) \ - return(1); \ - return(func(mdoc, "multi-line arguments", (num))); \ -} + if (LIST__NONE != n->norm->Bl.type) { + mandoc_vmsg(MANDOCERR_BL_REP, + mdoc->parse, n->line, n->pos, + "Bl -%s", mdoc_argnames[argv->arg]); + continue; + } -#define CHECK_ELEM_DEFN(name, lvl, func, num) \ -static int \ -e##lvl##_##name(POST_ARGS) \ -{ \ - assert(MDOC_ELEM == mdoc->last->type); \ - return(func(mdoc, "line arguments", (num))); \ -} + /* The list type should come first. */ -#define CHECK_HEAD_DEFN(name, lvl, func, num) \ -static int \ -h##lvl##_##name(POST_ARGS) \ -{ \ - if (MDOC_HEAD != mdoc->last->type) \ - return(1); \ - return(func(mdoc, "line arguments", (num))); \ -} + if (n->norm->Bl.width || + n->norm->Bl.offs || + n->norm->Bl.comp) + mandoc_vmsg(MANDOCERR_BL_LATETYPE, + mdoc->parse, n->line, n->pos, "Bl -%s", + mdoc_argnames[n->args->argv[0].arg]); + n->norm->Bl.type = lt; + if (LIST_column == lt) { + n->norm->Bl.ncols = argv->sz; + n->norm->Bl.cols = (void *)argv->value; + } + } -CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */ -CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */ -CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */ -CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */ -CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */ -CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */ -CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */ -CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */ -CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */ -CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */ -CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */ -CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */ -CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */ -CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */ -CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */ -CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */ -CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */ -CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */ + /* Allow lists to default to LIST_item. */ + if (LIST__NONE == n->norm->Bl.type) { + mandoc_msg(MANDOCERR_BL_NOTYPE, mdoc->parse, + n->line, n->pos, "Bl"); + n->norm->Bl.type = LIST_item; + } -static int -check_stdarg(PRE_ARGS) -{ + /* + * 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. Yet others have a default and need + * no warning. + */ - if (n->args && 1 == n->args->argc) - if (MDOC_Std == n->args->argv[0].arg) - return(1); - return(nwarn(mdoc, n, WARGVAL)); + switch (n->norm->Bl.type) { + case LIST_tag: + if (NULL == n->norm->Bl.width) + mandoc_msg(MANDOCERR_BL_NOWIDTH, mdoc->parse, + n->line, n->pos, "Bl -tag"); + break; + case LIST_column: + /* FALLTHROUGH */ + case LIST_diag: + /* FALLTHROUGH */ + case LIST_ohang: + /* FALLTHROUGH */ + case LIST_inset: + /* FALLTHROUGH */ + case LIST_item: + if (n->norm->Bl.width) + mandoc_vmsg(MANDOCERR_BL_SKIPW, mdoc->parse, + wa->line, wa->pos, "Bl -%s", + mdoc_argnames[mdoclt]); + 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; + } + pre_par(mdoc, n); } - -static int -check_sec(PRE_ARGS, ...) +static void +pre_bd(PRE_ARGS) { - enum mdoc_sec sec; - va_list ap; + struct mdoc_node *np; + struct mdoc_argv *argv; + int i; + enum mdoc_disp dt; - va_start(ap, n); + pre_literal(mdoc, n); - for (;;) { - /* LINTED */ - sec = (enum mdoc_sec)va_arg(ap, int); - if (SEC_CUSTOM == sec) + if (MDOC_BLOCK != n->type) { + if (ENDBODY_NOT != n->end) { + assert(n->pending); + np = n->pending->parent; + } else + np = n->parent; + + assert(np); + assert(MDOC_BLOCK == np->type); + assert(MDOC_Bd == np->tok); + return; + } + + for (i = 0; n->args && i < (int)n->args->argc; i++) { + argv = n->args->argv + i; + dt = DISP__NONE; + + switch (argv->arg) { + case MDOC_Centred: + dt = DISP_centered; break; - if (sec != mdoc->lastsec) + case MDOC_Ragged: + dt = DISP_ragged; + break; + case MDOC_Unfilled: + dt = DISP_unfilled; + break; + case MDOC_Filled: + dt = DISP_filled; + break; + case MDOC_Literal: + dt = DISP_literal; + break; + case MDOC_File: + mandoc_msg(MANDOCERR_BD_FILE, mdoc->parse, + n->line, n->pos, NULL); + break; + case MDOC_Offset: + if (0 == argv->sz) { + mandoc_msg(MANDOCERR_ARG_EMPTY, + mdoc->parse, argv->line, + argv->pos, "Bd -offset"); + break; + } + if (NULL != n->norm->Bd.offs) + mandoc_vmsg(MANDOCERR_ARG_REP, + mdoc->parse, argv->line, + argv->pos, "Bd -offset %s", + argv->value[0]); + rewrite_macro2len(argv->value); + n->norm->Bd.offs = argv->value[0]; + break; + case MDOC_Compact: + if (n->norm->Bd.comp) + mandoc_msg(MANDOCERR_ARG_REP, + mdoc->parse, argv->line, + argv->pos, "Bd -compact"); + n->norm->Bd.comp = 1; + break; + default: + abort(); + /* NOTREACHED */ + } + if (DISP__NONE == dt) continue; - va_end(ap); - return(1); + + if (DISP__NONE == n->norm->Bd.type) + n->norm->Bd.type = dt; + else + mandoc_vmsg(MANDOCERR_BD_REP, + mdoc->parse, n->line, n->pos, + "Bd -%s", mdoc_argnames[argv->arg]); } - va_end(ap); - return(nwarn(mdoc, n, WBADSEC)); + if (DISP__NONE == n->norm->Bd.type) { + mandoc_msg(MANDOCERR_BD_NOTYPE, mdoc->parse, + n->line, n->pos, "Bd"); + n->norm->Bd.type = DISP_ragged; + } + pre_par(mdoc, n); } - -static int -check_msec(PRE_ARGS, ...) +static void +pre_an(PRE_ARGS) { - va_list ap; - int msec; + struct mdoc_argv *argv; + size_t i; - va_start(ap, n); - for (;;) { - /* LINTED */ - if (0 == (msec = va_arg(ap, int))) - break; - if (msec != mdoc->meta.msec) - continue; - va_end(ap); - return(1); + if (n->args == NULL) + return; + + for (i = 1; i < n->args->argc; i++) { + argv = n->args->argv + i; + mandoc_vmsg(MANDOCERR_AN_REP, + mdoc->parse, argv->line, argv->pos, + "An -%s", mdoc_argnames[argv->arg]); } - va_end(ap); - return(nwarn(mdoc, n, WBADMSEC)); + argv = n->args->argv; + if (argv->arg == MDOC_Split) + n->norm->An.auth = AUTH_split; + else if (argv->arg == MDOC_Nosplit) + n->norm->An.auth = AUTH_nosplit; + else + abort(); } - -static int -check_args(struct mdoc *m, const struct mdoc_node *n) +static void +pre_std(PRE_ARGS) { - int i; - if (NULL == n->args) - return(1); + if (n->args && 1 == n->args->argc) + if (MDOC_Std == n->args->argv[0].arg) + return; - assert(n->args->argc); - for (i = 0; i < (int)n->args->argc; i++) - if ( ! check_argv(m, n, &n->args->argv[i])) - return(0); - - return(1); + mandoc_msg(MANDOCERR_ARG_STD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); } +static void +pre_obsolete(PRE_ARGS) +{ -static int -check_argv(struct mdoc *m, const struct mdoc_node *n, - const struct mdoc_argv *v) + if (MDOC_ELEM == n->type || MDOC_BLOCK == n->type) + mandoc_msg(MANDOCERR_MACRO_OBS, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); +} + +static void +pre_dt(PRE_ARGS) { - int i; - for (i = 0; i < (int)v->sz; i++) - if ( ! check_text(m, v->line, v->pos, v->value[i])) - return(0); + if (mdoc->meta.title != NULL) + mandoc_msg(MANDOCERR_PROLOG_REP, mdoc->parse, + n->line, n->pos, "Dt"); + else if (mdoc->meta.os != NULL) + mandoc_msg(MANDOCERR_PROLOG_ORDER, mdoc->parse, + n->line, n->pos, "Dt after Os"); +} - if (MDOC_Std == v->arg) { - /* `Nm' name must be set. */ - if (v->sz || m->meta.name) - return(1); - return(nerr(m, n, ENAME)); - } +static void +pre_os(PRE_ARGS) +{ - return(1); + if (mdoc->meta.os != NULL) + mandoc_msg(MANDOCERR_PROLOG_REP, mdoc->parse, + n->line, n->pos, "Os"); + else if (mdoc->flags & MDOC_PBODY) + mandoc_msg(MANDOCERR_PROLOG_LATE, mdoc->parse, + n->line, n->pos, "Os"); } +static void +pre_dd(PRE_ARGS) +{ -static int -check_text(struct mdoc *mdoc, int line, int pos, const char *p) + if (mdoc->meta.date != NULL) + mandoc_msg(MANDOCERR_PROLOG_REP, mdoc->parse, + n->line, n->pos, "Dd"); + else if (mdoc->flags & MDOC_PBODY) + mandoc_msg(MANDOCERR_PROLOG_LATE, mdoc->parse, + n->line, n->pos, "Dd"); + else if (mdoc->meta.title != NULL) + mandoc_msg(MANDOCERR_PROLOG_ORDER, mdoc->parse, + n->line, n->pos, "Dd after Dt"); + else if (mdoc->meta.os != NULL) + mandoc_msg(MANDOCERR_PROLOG_ORDER, mdoc->parse, + n->line, n->pos, "Dd after Os"); +} + +static void +post_bf(POST_ARGS) { - size_t c; + struct mdoc_node *np, *nch; + enum mdocargt arg; - for ( ; *p; p++) { - if ('\t' == *p) { - if ( ! (MDOC_LITERAL & mdoc->flags)) - if ( ! warn_print(mdoc, line, pos)) - return(0); - } else if ( ! isprint((u_char)*p)) - if ( ! warn_print(mdoc, line, pos)) - return(0); + /* + * Unlike other data pointers, these are "housed" by the HEAD + * element, which contains the goods. + */ - if ('\\' != *p) - continue; + if (MDOC_HEAD != mdoc->last->type) { + if (ENDBODY_NOT != mdoc->last->end) { + assert(mdoc->last->pending); + np = mdoc->last->pending->parent->head; + } else if (MDOC_BLOCK != mdoc->last->type) { + np = mdoc->last->parent->head; + } else + np = mdoc->last->head; - c = mdoc_isescape(p); - if (c) { - /* See if form is deprecated. */ - if ('*' == p[1]) - if ( ! pwarn(mdoc, line, pos, WDEPESC)) - return(0); - p += (int)c - 1; - continue; + assert(np); + assert(MDOC_HEAD == np->type); + assert(MDOC_Bf == np->tok); + return; + } + + np = mdoc->last; + assert(MDOC_BLOCK == np->parent->type); + assert(MDOC_Bf == np->parent->tok); + + /* Check the number of arguments. */ + + nch = np->child; + if (NULL == np->parent->args) { + if (NULL == nch) { + mandoc_msg(MANDOCERR_BF_NOFONT, mdoc->parse, + np->line, np->pos, "Bf"); + return; } - if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags)) - return(perr(mdoc, line, pos, EESCAPE)); - if ( ! pwarn(mdoc, line, pos, WESCAPE)) - return(0); + nch = nch->next; } + if (NULL != nch) + mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse, + nch->line, nch->pos, "Bf ... %s", nch->string); - return(1); + /* Extract argument into data. */ + + if (np->parent->args) { + arg = np->parent->args->argv[0].arg; + if (MDOC_Emphasis == arg) + np->norm->Bf.font = FONT_Em; + else if (MDOC_Literal == arg) + np->norm->Bf.font = FONT_Li; + else if (MDOC_Symbolic == arg) + np->norm->Bf.font = FONT_Sy; + else + abort(); + return; + } + + /* Extract parameter into data. */ + + if (0 == strcmp(np->child->string, "Em")) + np->norm->Bf.font = FONT_Em; + else if (0 == strcmp(np->child->string, "Li")) + np->norm->Bf.font = FONT_Li; + else if (0 == strcmp(np->child->string, "Sy")) + np->norm->Bf.font = FONT_Sy; + else + mandoc_vmsg(MANDOCERR_BF_BADFONT, mdoc->parse, + np->child->line, np->child->pos, + "Bf %s", np->child->string); } +static void +post_lb(POST_ARGS) +{ + struct mdoc_node *n; + const char *stdlibname; + char *libname; + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1); + n = mdoc->last->child; + assert(MDOC_TEXT == n->type); + if (NULL == (stdlibname = mdoc_a2lib(n->string))) + mandoc_asprintf(&libname, + "library \\(lq%s\\(rq", n->string); + else + libname = mandoc_strdup(stdlibname); -static int -check_parent(PRE_ARGS, int tok, enum mdoc_type t) + free(n->string); + n->string = libname; +} + +static void +post_eoln(POST_ARGS) { + const struct mdoc_node *n; - assert(n->parent); - if ((MDOC_ROOT == t || tok == n->parent->tok) && - (t == n->parent->type)) - return(1); + n = mdoc->last; + if (n->child) + mandoc_vmsg(MANDOCERR_ARG_SKIP, + mdoc->parse, n->line, n->pos, + "%s %s", mdoc_macronames[n->tok], + n->child->string); +} - return(mdoc_nerr(mdoc, n, "require parent %s", - MDOC_ROOT == t ? "" : mdoc_macronames[tok])); +static void +post_fname(POST_ARGS) +{ + const struct mdoc_node *n; + const char *cp; + size_t pos; + + n = mdoc->last->child; + pos = strcspn(n->string, "()"); + cp = n->string + pos; + if ( ! (cp[0] == '\0' || (cp[0] == '(' && cp[1] == '*'))) + mandoc_msg(MANDOCERR_FN_PAREN, mdoc->parse, + n->line, n->pos + pos, n->string); } +static void +post_fn(POST_ARGS) +{ + post_fname(mdoc); + post_fa(mdoc); +} -static int -pre_display(PRE_ARGS) +static void +post_fo(POST_ARGS) { - struct mdoc_node *node; - /* Display elements (`Bd', `D1'...) cannot be nested. */ + check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 1); + bwarn_ge1(mdoc); + if (mdoc->last->type == MDOC_HEAD && mdoc->last->nchild) + post_fname(mdoc); +} - if (MDOC_BLOCK != n->type) - return(1); +static void +post_fa(POST_ARGS) +{ + const struct mdoc_node *n; + const char *cp; - /* LINTED */ - for (node = mdoc->last->parent; node; node = node->parent) - if (MDOC_BLOCK == node->type) - if (MDOC_Bd == node->tok) + for (n = mdoc->last->child; n != NULL; n = n->next) { + for (cp = n->string; *cp != '\0'; cp++) { + /* Ignore callbacks and alterations. */ + if (*cp == '(' || *cp == '{') break; - if (NULL == node) - return(1); + if (*cp != ',') + continue; + mandoc_msg(MANDOCERR_FA_COMMA, mdoc->parse, + n->line, n->pos + (cp - n->string), + n->string); + break; + } + } +} - return(nerr(mdoc, n, ENESTDISP)); +static void +post_vt(POST_ARGS) +{ + const struct mdoc_node *n; + + /* + * 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, which is already + * guaranteed by the in_line parsing routine; BLOCK types, + * specifically the BODY, should only have TEXT children. + */ + + if (MDOC_BODY != mdoc->last->type) + return; + + for (n = mdoc->last->child; n; n = n->next) + if (MDOC_TEXT != n->type) + mandoc_msg(MANDOCERR_VT_CHILD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); } +static void +post_nm(POST_ARGS) +{ + struct mdoc_node *n; -static int -pre_bl(PRE_ARGS) + n = mdoc->last; + + if (n->last != NULL && + (n->last->tok == MDOC_Pp || + n->last->tok == MDOC_Lp)) + mdoc_node_relink(mdoc, n->last); + + if (NULL != mdoc->meta.name) + return; + + mdoc_deroff(&mdoc->meta.name, n); + + if (NULL == mdoc->meta.name) + mandoc_msg(MANDOCERR_NM_NONAME, mdoc->parse, + n->line, n->pos, "Nm"); +} + +static void +post_nd(POST_ARGS) { - int pos, col, type, width, offset; - if (MDOC_BLOCK != n->type) - return(1); - if (NULL == n->args) - return(nerr(mdoc, n, ELISTTYPE)); + check_count(mdoc, MDOC_BODY, CHECK_ERROR, CHECK_GT, 0); + post_hyph(mdoc); +} - /* Make sure that only one type of list is specified. */ +static void +post_d1(POST_ARGS) +{ - type = offset = width = col = -1; + bwarn_ge1(mdoc); + post_hyph(mdoc); +} - /* LINTED */ - for (pos = 0; pos < (int)n->args->argc; pos++) - switch (n->args->argv[pos].arg) { - case (MDOC_Bullet): - /* FALLTHROUGH */ - case (MDOC_Dash): - /* FALLTHROUGH */ - case (MDOC_Enum): - /* FALLTHROUGH */ - case (MDOC_Hyphen): - /* FALLTHROUGH */ - case (MDOC_Item): - /* FALLTHROUGH */ - case (MDOC_Tag): - /* FALLTHROUGH */ - case (MDOC_Diag): - /* FALLTHROUGH */ - case (MDOC_Hang): - /* FALLTHROUGH */ - case (MDOC_Ohang): - /* FALLTHROUGH */ - case (MDOC_Inset): - /* FALLTHROUGH */ - case (MDOC_Column): - if (-1 != type) - return(nerr(mdoc, n, EMULTILIST)); - type = n->args->argv[pos].arg; - col = pos; - break; - case (MDOC_Width): - if (-1 != width) - return(nerr(mdoc, n, EARGREP)); - width = n->args->argv[pos].arg; - break; - case (MDOC_Offset): - if (-1 != offset) - return(nerr(mdoc, n, EARGREP)); - offset = n->args->argv[pos].arg; - break; - default: - break; - } +static void +post_literal(POST_ARGS) +{ - if (-1 == type) - return(nerr(mdoc, n, ELISTTYPE)); + if (mdoc->last->tok == MDOC_Bd) + hwarn_eq0(mdoc); + bwarn_ge1(mdoc); - /* - * 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. + /* + * The `Dl' (note "el" not "one") and `Bd' macros unset the + * MDOC_LITERAL flag as they leave. Note that `Bd' only sets + * this in literal mode, but it doesn't hurt to just switch it + * off in general since displays can't be nested. */ - switch (type) { - case (MDOC_Tag): - if (-1 == width && ! nwarn(mdoc, n, WMISSWIDTH)) - return(0); - break; - case (MDOC_Column): - /* FALLTHROUGH */ - case (MDOC_Diag): - /* FALLTHROUGH */ - case (MDOC_Inset): - /* FALLTHROUGH */ - case (MDOC_Item): - if (-1 != width && ! nwarn(mdoc, n, WNOWIDTH)) - return(0); - break; - default: - break; - } + if (MDOC_BODY == mdoc->last->type) + mdoc->flags &= ~MDOC_LITERAL; +} +static void +post_defaults(POST_ARGS) +{ + struct mdoc_node *nn; + /* - * General validation of fields. + * The `Ar' defaults to "file ..." if no value is provided as an + * argument; the `Mt' and `Pa' macros use "~"; the `Li' just + * gets an empty string. */ - switch (type) { - case (MDOC_Column): - assert(col >= 0); - if (0 == n->args->argv[col].sz) - break; - if ( ! nwarn(mdoc, n, WDEPCOL)) - return(0); + if (mdoc->last->child) + return; + + nn = mdoc->last; + mdoc->next = MDOC_NEXT_CHILD; + + switch (nn->tok) { + case MDOC_Ar: + mdoc_word_alloc(mdoc, nn->line, nn->pos, "file"); + mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."); break; - default: + case MDOC_Pa: + /* FALLTHROUGH */ + case MDOC_Mt: + mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"); break; + default: + abort(); + /* NOTREACHED */ } - - return(1); + mdoc->last = nn; } - -static int -pre_bd(PRE_ARGS) +static void +post_at(POST_ARGS) { - int i, type, err; + struct mdoc_node *n; + const char *std_att; + char *att; - if (MDOC_BLOCK != n->type) - return(1); - if (NULL == n->args) - return(nerr(mdoc, n, EDISPTYPE)); + n = mdoc->last; + if (n->child == NULL) { + mdoc->next = MDOC_NEXT_CHILD; + mdoc_word_alloc(mdoc, n->line, n->pos, "AT&T UNIX"); + mdoc->last = n; + return; + } - /* Make sure that only one type of display is specified. */ + /* + * 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. + */ - /* LINTED */ - for (i = 0, err = type = 0; ! err && - i < (int)n->args->argc; i++) - switch (n->args->argv[i].arg) { - case (MDOC_Ragged): - /* FALLTHROUGH */ - case (MDOC_Unfilled): - /* FALLTHROUGH */ - case (MDOC_Filled): - /* FALLTHROUGH */ - case (MDOC_Literal): - /* FALLTHROUGH */ - case (MDOC_File): - if (0 == type++) - break; - return(nerr(mdoc, n, EMULTIDISP)); - default: - break; - } + n = n->child; + assert(MDOC_TEXT == n->type); + if (NULL == (std_att = mdoc_a2att(n->string))) { + mandoc_vmsg(MANDOCERR_AT_BAD, mdoc->parse, + n->line, n->pos, "At %s", n->string); + mandoc_asprintf(&att, "AT&T UNIX %s", n->string); + } else + att = mandoc_strdup(std_att); - if (type) - return(1); - return(nerr(mdoc, n, EDISPTYPE)); + free(n->string); + n->string = att; } - -static int -pre_ss(PRE_ARGS) +static void +post_an(POST_ARGS) { + struct mdoc_node *np; - if (MDOC_BLOCK != n->type) - return(1); - return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY)); + np = mdoc->last; + 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); } - -static int -pre_sh(PRE_ARGS) +static void +post_en(POST_ARGS) { - if (MDOC_BLOCK != n->type) - return(1); - return(check_parent(mdoc, n, -1, MDOC_ROOT)); + if (MDOC_BLOCK == mdoc->last->type) + mdoc->last->norm->Es = mdoc->last_es; } - -static int -pre_it(PRE_ARGS) +static void +post_es(POST_ARGS) { - if (MDOC_BLOCK != n->type) - return(1); - return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); + mdoc->last_es = mdoc->last; } - -static int -pre_an(PRE_ARGS) +static void +post_it(POST_ARGS) { + int i, cols; + enum mdoc_list lt; + struct mdoc_node *nbl, *nit, *nch; - if (NULL == n->args || 1 == n->args->argc) - return(1); - return(mdoc_nerr(mdoc, n, "only one argument allowed")); -} + nit = mdoc->last; + if (nit->type != MDOC_BLOCK) + return; + nbl = nit->parent->parent; + lt = nbl->norm->Bl.type; -static int -pre_lb(PRE_ARGS) -{ + switch (lt) { + case LIST_tag: + /* FALLTHROUGH */ + case LIST_hang: + /* FALLTHROUGH */ + case LIST_ohang: + /* FALLTHROUGH */ + case LIST_inset: + /* FALLTHROUGH */ + case LIST_diag: + if (nit->head->child == NULL) + mandoc_vmsg(MANDOCERR_IT_NOHEAD, + mdoc->parse, nit->line, nit->pos, + "Bl -%s It", + mdoc_argnames[nbl->args->argv[0].arg]); + break; + case LIST_bullet: + /* FALLTHROUGH */ + case LIST_dash: + /* FALLTHROUGH */ + case LIST_enum: + /* FALLTHROUGH */ + case LIST_hyphen: + if (nit->body == NULL || nit->body->child == NULL) + mandoc_vmsg(MANDOCERR_IT_NOBODY, + mdoc->parse, nit->line, nit->pos, + "Bl -%s It", + mdoc_argnames[nbl->args->argv[0].arg]); + /* FALLTHROUGH */ + case LIST_item: + if (nit->head->child != NULL) + mandoc_vmsg(MANDOCERR_ARG_SKIP, + mdoc->parse, nit->line, nit->pos, + "It %s", nit->head->child->string); + break; + case LIST_column: + cols = (int)nbl->norm->Bl.ncols; - return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM)); -} + assert(nit->head->child == NULL); + for (i = 0, nch = nit->child; nch; nch = nch->next) + if (nch->type == MDOC_BODY) + i++; -static int -pre_rv(PRE_ARGS) + if (i < cols || i > cols + 1) + mandoc_vmsg(MANDOCERR_ARGCOUNT, + mdoc->parse, nit->line, nit->pos, + "columns == %d (have %d)", cols, i); + break; + default: + abort(); + } +} + +static void +post_bl_block(POST_ARGS) { + struct mdoc_node *n, *ni, *nc; - if ( ! check_msec(mdoc, n, 2, 3, 0)) - return(0); - return(check_stdarg(mdoc, n)); -} + /* + * These are fairly complicated, so we've broken them into two + * functions. post_bl_block_tag() is called when a -tag is + * specified, but no -width (it must be guessed). The second + * when a -width is specified (macro indicators must be + * rewritten into real lengths). + */ + n = mdoc->last; -static int -pre_ex(PRE_ARGS) -{ + if (LIST_tag == n->norm->Bl.type && + NULL == n->norm->Bl.width) { + post_bl_block_tag(mdoc); + assert(n->norm->Bl.width); + } - if ( ! check_msec(mdoc, n, 1, 6, 8, 0)) - return(0); - return(check_stdarg(mdoc, n)); + 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]); + mdoc_node_relink(mdoc, nc); + } 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; + } + } } - -static int -pre_er(PRE_ARGS) +/* + * If the argument of -offset or -width is a macro, + * replace it with the associated default width. + */ +void +rewrite_macro2len(char **arg) { + size_t width; + enum mdoct tok; - return(check_msec(mdoc, n, 2, 3, 9, 0)); + if (*arg == NULL) + return; + else if ( ! strcmp(*arg, "Ds")) + width = 6; + else if ((tok = mdoc_hash_find(*arg)) == MDOC_MAX) + return; + else + width = macro2len(tok); + + free(*arg); + mandoc_asprintf(arg, "%zun", width); } - -static int -pre_cd(PRE_ARGS) +static void +post_bl_block_tag(POST_ARGS) { + struct mdoc_node *n, *nn; + size_t sz, ssz; + int i; + char buf[24]; - return(check_msec(mdoc, n, 4, 0)); -} + /* + * Calculate the -width for a `Bl -tag' list if it hasn't been + * provided. Uses the first head macro. NOTE AGAIN: this is + * ONLY if the -width argument has NOT been provided. See + * rewrite_macro2len() for converting the -width string. + */ + sz = 10; + n = mdoc->last; -static int -pre_dt(PRE_ARGS) -{ + for (nn = n->body->child; nn; nn = nn->next) { + if (MDOC_It != nn->tok) + continue; - if (0 == mdoc->meta.date || mdoc->meta.os) - if ( ! nwarn(mdoc, n, WPROLOOO)) - return(0); - if (mdoc->meta.title) - if ( ! nwarn(mdoc, n, WPROLREP)) - return(0); - return(1); -} + assert(MDOC_BLOCK == nn->type); + nn = nn->head->child; + if (nn == NULL) + break; -static int -pre_os(PRE_ARGS) -{ + if (MDOC_TEXT == nn->type) { + sz = strlen(nn->string) + 1; + break; + } - if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) - if ( ! nwarn(mdoc, n, WPROLOOO)) - return(0); - if (mdoc->meta.os) - if ( ! nwarn(mdoc, n, WPROLREP)) - return(0); - return(1); -} + if (0 != (ssz = macro2len(nn->tok))) + sz = ssz; + break; + } -static int -pre_dd(PRE_ARGS) -{ + /* Defaults to ten ens. */ - if (mdoc->meta.title || mdoc->meta.os) - if ( ! nwarn(mdoc, n, WPROLOOO)) - return(0); - if (mdoc->meta.date) - if ( ! nwarn(mdoc, n, WPROLREP)) - return(0); - return(1); -} + (void)snprintf(buf, sizeof(buf), "%un", (unsigned int)sz); + /* + * We have to dynamically add this to the macro's argument list. + * We're guaranteed that a MDOC_Width doesn't already exist. + */ -static int -post_bf(POST_ARGS) + assert(n->args); + i = (int)(n->args->argc)++; + + 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; + n->args->argv[i].pos = n->pos; + n->args->argv[i].sz = 1; + n->args->argv[i].value = mandoc_malloc(sizeof(char *)); + n->args->argv[i].value[0] = mandoc_strdup(buf); + + /* Set our width! */ + n->norm->Bl.width = n->args->argv[i].value[0]; +} + +static void +post_bl_head(POST_ARGS) { - char *p; - struct mdoc_node *head; + struct mdoc_node *np, *nn, *nnp; + struct mdoc_argv *argv; + int i, j; - if (MDOC_BLOCK != mdoc->last->type) - return(1); + if (LIST_column != mdoc->last->norm->Bl.type) { + /* FIXME: this should be ERROR class... */ + hwarn_eq0(mdoc); + return; + } - head = mdoc->last->head; + /* + * Append old-style lists, where the column width specifiers + * trail as macro parameters, to the new-style ("normal-form") + * lists where they're argument values following -column. + */ - if (mdoc->last->args && head->child) - return(mdoc_err(mdoc, "one argument expected")); - else if (mdoc->last->args) - return(1); + if (mdoc->last->child == NULL) + return; - if (NULL == head->child || MDOC_TEXT != head->child->type) - return(mdoc_err(mdoc, "text argument expected")); + np = mdoc->last->parent; + assert(np->args); - p = head->child->string; + for (j = 0; j < (int)np->args->argc; j++) + if (MDOC_Column == np->args->argv[j].arg) + break; - if (0 == strcmp(p, "Em")) - return(1); - else if (0 == strcmp(p, "Li")) - return(1); - else if (0 == strcmp(p, "Sm")) - return(1); + assert(j < (int)np->args->argc); - return(mdoc_nerr(mdoc, head->child, "invalid font mode")); -} + /* + * 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. + */ + argv = np->args->argv + j; + i = argv->sz; + argv->sz += mdoc->last->nchild; + argv->value = mandoc_reallocarray(argv->value, + argv->sz, sizeof(char *)); -static int -post_nm(POST_ARGS) -{ + mdoc->last->norm->Bl.ncols = argv->sz; + mdoc->last->norm->Bl.cols = (void *)argv->value; - if (mdoc->last->child) - return(1); - if (mdoc->meta.name) - return(1); - return(verr(mdoc, ENAME)); + for (nn = mdoc->last->child; nn; i++) { + argv->value[i] = nn->string; + nn->string = NULL; + nnp = nn; + nn = nn->next; + mdoc_node_delete(NULL, nnp); + } + + mdoc->last->nchild = 0; + mdoc->last->child = NULL; } - -static int -post_at(POST_ARGS) +static void +post_bl(POST_ARGS) { + 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 (NULL == mdoc->last->child) - return(1); - if (MDOC_TEXT != mdoc->last->child->type) - return(verr(mdoc, EATT)); - if (mdoc_a2att(mdoc->last->child->string)) - return(1); - return(verr(mdoc, EATT)); + nbody = mdoc->last; + switch (nbody->type) { + case MDOC_BLOCK: + post_bl_block(mdoc); + return; + case MDOC_HEAD: + post_bl_head(mdoc); + return; + case MDOC_BODY: + break; + default: + return; + } + + bwarn_ge1(mdoc); + + nchild = nbody->child; + while (NULL != nchild) { + if (nchild->tok == MDOC_It || + (nchild->tok == MDOC_Sm && + nchild->next != NULL && + nchild->next->tok == MDOC_It)) { + nchild = nchild->next; + continue; + } + + 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; + } } +static void +post_bk(POST_ARGS) +{ -static int -post_an(POST_ARGS) + hwarn_eq0(mdoc); + bwarn_ge1(mdoc); +} + +static void +post_sm(struct mdoc *mdoc) { + struct mdoc_node *nch; - if (mdoc->last->args) { - if (NULL == mdoc->last->child) - return(1); - return(verr(mdoc, ELINE)); + nch = mdoc->last->child; + + if (nch == NULL) { + mdoc->flags ^= MDOC_SMOFF; + return; } - if (mdoc->last->child) - return(1); - return(verr(mdoc, ELINE)); -} + assert(nch->type == MDOC_TEXT); + if ( ! strcmp(nch->string, "on")) { + mdoc->flags &= ~MDOC_SMOFF; + return; + } + if ( ! strcmp(nch->string, "off")) { + mdoc->flags |= MDOC_SMOFF; + return; + } -static int -post_args(POST_ARGS) + mandoc_vmsg(MANDOCERR_SM_BAD, + mdoc->parse, nch->line, nch->pos, + "%s %s", mdoc_macronames[mdoc->last->tok], nch->string); + mdoc_node_relink(mdoc, nch); + return; +} + +static void +post_root(POST_ARGS) { + struct mdoc_node *n; - if (mdoc->last->args) - return(1); - return(verr(mdoc, ELINE)); -} + /* Add missing prologue data. */ + if (mdoc->meta.date == NULL) + mdoc->meta.date = mdoc->quick ? + mandoc_strdup("") : + mandoc_normdate(mdoc->parse, NULL, 0, 0); -static int -post_it(POST_ARGS) + if (mdoc->meta.title == NULL) { + mandoc_msg(MANDOCERR_DT_NOTITLE, + mdoc->parse, 0, 0, "EOF"); + mdoc->meta.title = mandoc_strdup("UNTITLED"); + } + + if (mdoc->meta.vol == NULL) + mdoc->meta.vol = mandoc_strdup("LOCAL"); + + if (mdoc->meta.os == NULL) { + mandoc_msg(MANDOCERR_OS_MISSING, + mdoc->parse, 0, 0, NULL); + mdoc->meta.os = mandoc_strdup(""); + } + + /* Check that we begin with a proper `Sh'. */ + + n = mdoc->first->child; + while (n != NULL && mdoc_macros[n->tok].flags & MDOC_PROLOGUE) + n = n->next; + + if (n == NULL) + mandoc_msg(MANDOCERR_DOC_EMPTY, mdoc->parse, 0, 0, NULL); + else if (n->tok != MDOC_Sh) + mandoc_msg(MANDOCERR_SEC_BEFORE, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); +} + +static void +post_st(POST_ARGS) { - int type, i, cols; - struct mdoc_node *n, *c; + struct mdoc_node *n, *nch; + const char *p; - if (MDOC_BLOCK != mdoc->last->type) - return(1); + n = mdoc->last; + nch = n->child; - n = mdoc->last->parent->parent; - if (NULL == n->args) - return(verr(mdoc, ELISTTYPE)); + if (NULL == nch) { + mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); + mdoc_node_delete(mdoc, n); + return; + } - /* Some types require block-head, some not. */ + assert(MDOC_TEXT == nch->type); - /* LINTED */ - for (cols = type = -1, i = 0; -1 == type && - i < (int)n->args->argc; i++) - switch (n->args->argv[i].arg) { - case (MDOC_Tag): - /* FALLTHROUGH */ - case (MDOC_Diag): - /* FALLTHROUGH */ - case (MDOC_Hang): - /* FALLTHROUGH */ - case (MDOC_Ohang): - /* FALLTHROUGH */ - case (MDOC_Inset): - /* FALLTHROUGH */ - case (MDOC_Bullet): - /* FALLTHROUGH */ - case (MDOC_Dash): - /* FALLTHROUGH */ - case (MDOC_Enum): - /* FALLTHROUGH */ - case (MDOC_Hyphen): - /* FALLTHROUGH */ - case (MDOC_Item): - type = n->args->argv[i].arg; - break; - case (MDOC_Column): - type = n->args->argv[i].arg; - cols = (int)n->args->argv[i].sz; - break; - default: - break; - } + if (NULL == (p = mdoc_a2st(nch->string))) { + mandoc_vmsg(MANDOCERR_ST_BAD, mdoc->parse, + nch->line, nch->pos, "St %s", nch->string); + mdoc_node_delete(mdoc, n); + } else { + free(nch->string); + nch->string = mandoc_strdup(p); + } +} - if (-1 == type) - return(verr(mdoc, ELISTTYPE)); +static void +post_rs(POST_ARGS) +{ + struct mdoc_node *nn, *next, *prev; + int i, j; - switch (type) { - case (MDOC_Tag): - if (NULL == mdoc->last->head->child) - if ( ! vwarn(mdoc, WLINE)) - return(0); - break; - case (MDOC_Hang): - /* FALLTHROUGH */ - case (MDOC_Ohang): - /* FALLTHROUGH */ - case (MDOC_Inset): - /* FALLTHROUGH */ - case (MDOC_Diag): - if (NULL == mdoc->last->head->child) - if ( ! vwarn(mdoc, WLINE)) - return(0); - if (NULL == mdoc->last->body->child) - if ( ! vwarn(mdoc, WMULTILINE)) - return(0); - break; - case (MDOC_Bullet): - /* FALLTHROUGH */ - case (MDOC_Dash): - /* FALLTHROUGH */ - case (MDOC_Enum): - /* FALLTHROUGH */ - case (MDOC_Hyphen): - /* FALLTHROUGH */ - case (MDOC_Item): - if (mdoc->last->head->child) - if ( ! vwarn(mdoc, WNOLINE)) - return(0); - if (NULL == mdoc->last->body->child) - if ( ! vwarn(mdoc, WMULTILINE)) - return(0); - break; - case (MDOC_Column): - if (NULL == mdoc->last->head->child) - if ( ! vwarn(mdoc, WLINE)) - return(0); - if (mdoc->last->body->child) - if ( ! vwarn(mdoc, WNOMULTILINE)) - return(0); - c = mdoc->last->child; - for (i = 0; c && MDOC_HEAD == c->type; c = c->next) - i++; - if (i == cols) + switch (mdoc->last->type) { + case MDOC_HEAD: + check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0); + return; + case MDOC_BODY: + if (mdoc->last->child) break; - return(mdoc_err(mdoc, "column mismatch (have " - "%d, want %d)", i, cols)); + check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0); + return; default: - break; + return; } - 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 an insertion sort. + */ + next = NULL; + for (nn = mdoc->last->child->next; nn; nn = next) { + /* Determine order of `nn'. */ + for (i = 0; i < RSORD_MAX; i++) + if (rsord[i] == nn->tok) + break; -static int -post_bl(POST_ARGS) -{ - struct mdoc_node *n; + if (i == RSORD_MAX) { + mandoc_msg(MANDOCERR_RS_BAD, + mdoc->parse, nn->line, nn->pos, + mdoc_macronames[nn->tok]); + i = -1; + } else if (MDOC__J == nn->tok || MDOC__B == nn->tok) + mdoc->last->norm->Rs.quote_T++; - if (MDOC_BODY != mdoc->last->type) - return(1); - if (NULL == mdoc->last->child) - return(1); + /* + * 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. + */ - /* LINTED */ - for (n = mdoc->last->child; n; n = n->next) { - if (MDOC_BLOCK == n->type) - if (MDOC_It == n->tok) - continue; - return(mdoc_nerr(mdoc, n, "bad child of parent %s", - mdoc_macronames[mdoc->last->tok])); - } + if (NULL != (next = nn->next)) + next->prev = nn->prev; - return(1); -} + if (NULL != (prev = nn->prev)) + prev->next = nn->next; + nn->prev = nn->next = NULL; -static int -ebool(struct mdoc *mdoc) + /* + * Scan back until we reach a node that's + * ordered before `nn'. + */ + + for ( ; prev ; prev = prev->prev) { + /* Determine order of `prev'. */ + for (j = 0; j < RSORD_MAX; j++) + if (rsord[j] == prev->tok) + break; + if (j == RSORD_MAX) + j = -1; + + if (j <= i) + break; + } + + /* + * Set `nn' back into its correct place in front + * of the `prev' node. + */ + + nn->prev = prev; + + if (prev) { + if (prev->next) + prev->next->prev = nn; + nn->next = prev->next; + prev->next = nn; + } else { + mdoc->last->child->prev = nn; + nn->next = mdoc->last->child; + mdoc->last->child = nn; + } + } +} + +/* + * For some arguments of some macros, + * convert all breakable hyphens into ASCII_HYPH. + */ +static void +post_hyph(POST_ARGS) { - struct mdoc_node *n; + struct mdoc_node *n, *nch; + char *cp; - /* LINTED */ - for (n = mdoc->last->child; n; n = n->next) { - if (MDOC_TEXT != n->type) + n = mdoc->last; + switch (n->type) { + case MDOC_HEAD: + if (MDOC_Sh == n->tok || MDOC_Ss == n->tok) break; - if (0 == strcmp(n->string, "on")) - continue; - if (0 == strcmp(n->string, "off")) - continue; + return; + case MDOC_BODY: + if (MDOC_D1 == n->tok || MDOC_Nd == n->tok) + break; + return; + case MDOC_ELEM: break; + default: + return; } - if (NULL == n) - return(1); - return(nerr(mdoc, n, EBOOL)); + 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; + } } - -static int -post_root(POST_ARGS) +static void +post_hyphtext(POST_ARGS) { - if (NULL == mdoc->first->child) - return(verr(mdoc, ENODATA)); - if ( ! (MDOC_PBODY & mdoc->flags)) - return(verr(mdoc, ENOPROLOGUE)); - - if (MDOC_BLOCK != mdoc->first->child->type) - return(verr(mdoc, ENODATA)); - if (MDOC_Sh != mdoc->first->child->tok) - return(verr(mdoc, ENODATA)); - - return(1); + ewarn_ge1(mdoc); + post_hyph(mdoc); } - -static int -post_st(POST_ARGS) +static void +post_ns(POST_ARGS) { - if (mdoc_a2st(mdoc->last->child->string)) - return(1); - return(vwarn(mdoc, WBADSTAND)); + if (MDOC_LINE & mdoc->last->flags) + mandoc_msg(MANDOCERR_NS_SKIP, mdoc->parse, + mdoc->last->line, mdoc->last->pos, NULL); } - -static int +static void post_sh(POST_ARGS) { - if (MDOC_HEAD == mdoc->last->type) - return(post_sh_head(mdoc)); - if (MDOC_BODY == mdoc->last->type) - return(post_sh_body(mdoc)); + post_ignpar(mdoc); - return(1); + switch (mdoc->last->type) { + case MDOC_HEAD: + post_sh_head(mdoc); + break; + case MDOC_BODY: + switch (mdoc->lastsec) { + case SEC_NAME: + post_sh_name(mdoc); + break; + case SEC_SEE_ALSO: + post_sh_see_also(mdoc); + break; + case SEC_AUTHORS: + post_sh_authors(mdoc); + break; + default: + break; + } + break; + default: + break; + } } - -static int -post_sh_body(POST_ARGS) +static void +post_sh_name(POST_ARGS) { struct mdoc_node *n; - if (SEC_NAME != mdoc->lastnamed) - return(1); - /* * Warn if the NAME section doesn't contain the `Nm' and `Nd' * macros (can have multiple `Nm' and one `Nd'). Note that the * children of the BODY declaration can also be "text". */ - if (NULL == (n = mdoc->last->child)) - return(vwarn(mdoc, WNAMESECINC)); + if (NULL == (n = mdoc->last->child)) { + mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse, + mdoc->last->line, mdoc->last->pos, "empty"); + return; + } for ( ; n && n->next; n = n->next) { if (MDOC_ELEM == n->type && MDOC_Nm == n->tok) continue; if (MDOC_TEXT == n->type) continue; - if ( ! vwarn(mdoc, WNAMESECINC)) - return(0); + mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); } - if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) - return(1); - return(vwarn(mdoc, WNAMESECINC)); + assert(n); + if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok) + return; + + mandoc_msg(MANDOCERR_NAMESEC_BAD, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); } +static void +post_sh_see_also(POST_ARGS) +{ + const struct mdoc_node *n; + const char *name, *sec; + const char *lastname, *lastsec, *lastpunct; + int cmp; + n = mdoc->last->child; + lastname = lastsec = lastpunct = NULL; + while (n != NULL) { + if (n->tok != MDOC_Xr || n->nchild < 2) + break; + + /* Process one .Xr node. */ + + name = n->child->string; + sec = n->child->next->string; + if (lastsec != NULL) { + if (lastpunct[0] != ',' || lastpunct[1] != '\0') + mandoc_vmsg(MANDOCERR_XR_PUNCT, + mdoc->parse, n->line, n->pos, + "%s before %s(%s)", lastpunct, + name, sec); + cmp = strcmp(lastsec, sec); + if (cmp > 0) + mandoc_vmsg(MANDOCERR_XR_ORDER, + mdoc->parse, n->line, n->pos, + "%s(%s) after %s(%s)", name, + sec, lastname, lastsec); + else if (cmp == 0 && + strcasecmp(lastname, name) > 0) + mandoc_vmsg(MANDOCERR_XR_ORDER, + mdoc->parse, n->line, n->pos, + "%s after %s", name, lastname); + } + lastname = name; + lastsec = sec; + + /* Process the following node. */ + + n = n->next; + if (n == NULL) + break; + if (n->tok == MDOC_Xr) { + lastpunct = "none"; + continue; + } + if (n->type != MDOC_TEXT) + break; + for (name = n->string; *name != '\0'; name++) + if (isalpha((const unsigned char)*name)) + return; + lastpunct = n->string; + if (n->next == NULL) + mandoc_vmsg(MANDOCERR_XR_PUNCT, mdoc->parse, + n->line, n->pos, "%s after %s(%s)", + lastpunct, lastname, lastsec); + n = n->next; + } +} + static int +child_an(const struct mdoc_node *n) +{ + + for (n = n->child; n != NULL; n = n->next) + if ((n->tok == MDOC_An && n->nchild) || child_an(n)) + return(1); + return(0); +} + +static void +post_sh_authors(POST_ARGS) +{ + + if ( ! child_an(mdoc->last)) + mandoc_msg(MANDOCERR_AN_MISSING, mdoc->parse, + mdoc->last->line, mdoc->last->pos, NULL); +} + +static void post_sh_head(POST_ARGS) { - char buf[64]; - enum mdoc_sec sec; - const struct mdoc_node *n; + struct mdoc_node *n; + const char *goodsec; + char *secname; + enum mdoc_sec sec; /* * Process a new section. Sections are either "named" or - * "custom"; custom sections are user-defined, while named ones - * usually follow a conventional order and may only appear in - * certain manual sections. + * "custom". Custom sections are user-defined, while named ones + * follow a conventional order and may only appear in certain + * manual sections. */ - buf[0] = 0; + secname = NULL; + sec = SEC_CUSTOM; + mdoc_deroff(&secname, mdoc->last); + sec = NULL == secname ? SEC_CUSTOM : a2sec(secname); - for (n = mdoc->last->child; n; n = n->next) { - /* XXX - copied from compact(). */ - assert(MDOC_TEXT == n->type); + /* The NAME should be first. */ - if (strlcat(buf, n->string, 64) >= 64) - return(nerr(mdoc, n, ETOOLONG)); - if (NULL == n->next) - continue; - if (strlcat(buf, " ", 64) >= 64) - return(nerr(mdoc, n, ETOOLONG)); + if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed) + mandoc_vmsg(MANDOCERR_NAMESEC_FIRST, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "Sh %s", secname); + + /* The SYNOPSIS gets special attention in other areas. */ + + if (SEC_SYNOPSIS == sec) { + roff_setreg(mdoc->roff, "nS", 1, '='); + mdoc->flags |= MDOC_SYNOPSIS; + } else { + roff_setreg(mdoc->roff, "nS", 0, '='); + mdoc->flags &= ~MDOC_SYNOPSIS; } - sec = mdoc_atosec(buf); + /* Mark our last section. */ - /* - * Check: NAME should always be first, CUSTOM has no roles, - * non-CUSTOM has a conventional order to be followed. + 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. */ - if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed) - return(verr(mdoc, ESECNAME)); - if (SEC_CUSTOM == sec) - return(1); + 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) { + free(secname); + return; + } + + /* + * Check whether our non-custom section is being repeated or is + * out of order. + */ + if (sec == mdoc->lastnamed) - return(vwarn(mdoc, WSECREP)); + mandoc_vmsg(MANDOCERR_SEC_REP, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "Sh %s", secname); + if (sec < mdoc->lastnamed) - return(vwarn(mdoc, WSECOOO)); + mandoc_vmsg(MANDOCERR_SEC_ORDER, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "Sh %s", secname); - /* - * Check particular section/manual conventions. LIBRARY can - * only occur in msec 2, 3 (TODO: are there more of these?). - */ + /* Mark the last named section. */ + mdoc->lastnamed = sec; + + /* Check particular section/manual conventions. */ + + if (mdoc->meta.msec == NULL) { + free(secname); + return; + } + + goodsec = NULL; switch (sec) { - case (SEC_LIBRARY): - switch (mdoc->meta.msec) { - case (2): - /* FALLTHROUGH */ - case (3): + case SEC_ERRORS: + if (*mdoc->meta.msec == '4') break; - default: - return(vwarn(mdoc, WWRONGMSEC)); - } + goodsec = "2, 3, 4, 9"; + /* FALLTHROUGH */ + case SEC_RETURN_VALUES: + /* FALLTHROUGH */ + 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; + if (NULL == goodsec) + goodsec = "9"; + mandoc_vmsg(MANDOCERR_SEC_MSEC, mdoc->parse, + mdoc->last->line, mdoc->last->pos, + "Sh %s for %s only", secname, goodsec); break; default: break; } + free(secname); +} - return(1); +static void +post_ignpar(POST_ARGS) +{ + struct mdoc_node *np; + + check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_GT, 0); + post_hyph(mdoc); + + if (MDOC_BODY != mdoc->last->type) + return; + + if (NULL != (np = mdoc->last->child)) + if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) { + 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) { + 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); + } } +static void +pre_par(PRE_ARGS) +{ -static int -pre_fd(PRE_ARGS) + if (NULL == mdoc->last) + return; + if (MDOC_ELEM != n->type && MDOC_BLOCK != n->type) + return; + + /* + * 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 && + MDOC_br != mdoc->last->tok) + return; + if (MDOC_Bl == n->tok && n->norm->Bl.comp) + return; + if (MDOC_Bd == n->tok && n->norm->Bd.comp) + return; + if (MDOC_It == n->tok && n->parent->norm->Bl.comp) + return; + + 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); +} + +static void +post_par(POST_ARGS) { + struct mdoc_node *np; - return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM)); + if (mdoc->last->tok == MDOC_sp) + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2); + else + check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0); + + if (MDOC_ELEM != mdoc->last->type && + MDOC_BLOCK != mdoc->last->type) + return; + + if (NULL == (np = mdoc->last->prev)) { + np = mdoc->last->parent; + if (MDOC_Sh != np->tok && MDOC_Ss != np->tok) + return; + } else if (MDOC_Pp != np->tok && MDOC_Lp != np->tok && + (MDOC_br != mdoc->last->tok || + (MDOC_sp != np->tok && MDOC_br != np->tok))) + return; + + 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); +} + +static void +pre_literal(PRE_ARGS) +{ + + pre_display(mdoc, n); + + if (MDOC_BODY != n->type) + return; + + /* + * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd + * -unfilled' macros set MDOC_LITERAL on entrance to the body. + */ + + switch (n->tok) { + case MDOC_Dl: + mdoc->flags |= MDOC_LITERAL; + break; + case MDOC_Bd: + if (DISP_literal == n->norm->Bd.type) + mdoc->flags |= MDOC_LITERAL; + if (DISP_unfilled == n->norm->Bd.type) + mdoc->flags |= MDOC_LITERAL; + break; + default: + abort(); + /* NOTREACHED */ + } +} + +static void +post_dd(POST_ARGS) +{ + 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 = mdoc->quick ? mandoc_strdup("") : + mandoc_normdate(mdoc->parse, NULL, n->line, n->pos); + goto out; + } + + 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); + } +out: + mdoc_node_delete(mdoc, n); +} + +static void +post_dt(POST_ARGS) +{ + struct mdoc_node *nn, *n; + const char *cp; + char *p; + + n = mdoc->last; + + free(mdoc->meta.title); + free(mdoc->meta.msec); + free(mdoc->meta.vol); + free(mdoc->meta.arch); + + mdoc->meta.title = NULL; + mdoc->meta.msec = NULL; + mdoc->meta.vol = NULL; + mdoc->meta.arch = NULL; + + /* First check that all characters are uppercase. */ + + if (NULL != (nn = n->child)) + for (p = nn->string; *p; p++) { + if (toupper((unsigned char)*p) == *p) + continue; + mandoc_vmsg(MANDOCERR_TITLE_CASE, + mdoc->parse, nn->line, + nn->pos + (p - nn->string), + "Dt %s", nn->string); + break; + } + + /* No argument: msec and arch remain NULL. */ + + if (NULL == (nn = n->child)) { + mandoc_msg(MANDOCERR_DT_NOTITLE, + mdoc->parse, n->line, n->pos, "Dt"); + mdoc->meta.title = mandoc_strdup("UNTITLED"); + mdoc->meta.vol = mandoc_strdup("LOCAL"); + goto out; + } + + /* One argument: msec and arch remain NULL. */ + + mdoc->meta.title = mandoc_strdup( + '\0' == nn->string[0] ? "UNTITLED" : nn->string); + + if (NULL == (nn = nn->next)) { + mandoc_vmsg(MANDOCERR_MSEC_MISSING, + mdoc->parse, n->line, n->pos, + "Dt %s", mdoc->meta.title); + mdoc->meta.vol = mandoc_strdup("LOCAL"); + goto out; + } + + /* Handles: `.Dt TITLE SEC' + * title = TITLE, + * volume = SEC is msec ? format(msec) : SEC, + * msec = SEC is msec ? atoi(msec) : 0, + * arch = NULL + */ + + cp = mandoc_a2msec(nn->string); + if (cp) { + mdoc->meta.vol = mandoc_strdup(cp); + mdoc->meta.msec = mandoc_strdup(nn->string); + } else { + mandoc_vmsg(MANDOCERR_MSEC_BAD, mdoc->parse, + nn->line, nn->pos, "Dt ... %s", nn->string); + mdoc->meta.vol = mandoc_strdup(nn->string); + mdoc->meta.msec = mandoc_strdup(nn->string); + } + + /* Handle an optional architecture */ + + if ((nn = nn->next) != NULL) { + for (p = nn->string; *p; p++) + *p = tolower((unsigned char)*p); + mdoc->meta.arch = mandoc_strdup(nn->string); + } + + /* Ignore any subsequent parameters... */ + /* FIXME: warn about subsequent parameters. */ +out: + mdoc_node_delete(mdoc, n); +} + +static void +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); +} + +static void +post_os(POST_ARGS) +{ +#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. + * 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) + goto out; + + if (mdoc->defos) { + mdoc->meta.os = mandoc_strdup(mdoc->defos); + goto out; + } + +#ifdef OSNAME + mdoc->meta.os = mandoc_strdup(OSNAME); +#else /*!OSNAME */ + if (NULL == defbuf) { + if (-1 == uname(&utsname)) { + mandoc_msg(MANDOCERR_OS_UNAME, mdoc->parse, + n->line, n->pos, "Os"); + defbuf = mandoc_strdup("UNKNOWN"); + } else + mandoc_asprintf(&defbuf, "%s %s", + utsname.sysname, utsname.release); + } + mdoc->meta.os = mandoc_strdup(defbuf); +#endif /*!OSNAME*/ + +out: + mdoc_node_delete(mdoc, n); +} + +/* + * If no argument is provided, + * fill in the name of the current manual page. + */ +static void +post_ex(POST_ARGS) +{ + struct mdoc_node *n; + + n = mdoc->last; + + if (n->child) + return; + + if (mdoc->meta.name == NULL) { + mandoc_msg(MANDOCERR_EX_NONAME, mdoc->parse, + n->line, n->pos, "Ex"); + return; + } + + mdoc->next = MDOC_NEXT_CHILD; + mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name); + mdoc->last = n; +} + +static enum mdoc_sec +a2sec(const char *p) +{ + int i; + + for (i = 0; i < (int)SEC__MAX; i++) + if (secnames[i] && 0 == strcmp(p, secnames[i])) + return((enum mdoc_sec)i); + + return(SEC_CUSTOM); +} + +static size_t +macro2len(enum mdoct macro) +{ + + 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); }