=================================================================== RCS file: /cvs/mandoc/mdoc_macro.c,v retrieving revision 1.3 retrieving revision 1.27 diff -u -p -r1.3 -r1.27 --- mandoc/mdoc_macro.c 2009/03/27 13:44:24 1.3 +++ mandoc/mdoc_macro.c 2009/07/25 16:03:03 1.27 @@ -1,20 +1,18 @@ -/* $Id: mdoc_macro.c,v 1.3 2009/03/27 13:44:24 kristaps Exp $ */ +/* $Id: mdoc_macro.c,v 1.27 2009/07/25 16:03:03 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any - * purpose with or without fee is hereby granted, provided that the - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include #include @@ -24,27 +22,6 @@ #include "libmdoc.h" -/* - * This has scanning/parsing routines, each of which extract a macro and - * its arguments and parameters, then know how to progress to the next - * macro. - */ - -/* FIXME: .Fl, .Ar, .Cd handling of `|'. */ - -enum mwarn { - WIMPBRK, - WMACPARM, - WOBS -}; - -enum merr { - EOPEN, - EQUOT, - ENOCTX, - ENOPARMS -}; - #define REWIND_REWIND (1 << 0) #define REWIND_NOHALT (1 << 1) #define REWIND_HALT (1 << 2) @@ -71,23 +48,19 @@ static int rew_subblock(enum mdoc_type, static int rew_last(struct mdoc *, struct mdoc_node *); static int append_delims(struct mdoc *, int, int *, char *); static int lookup(struct mdoc *, int, int, int, const char *); -static int pwarn(struct mdoc *, int, int, enum mwarn); -static int perr(struct mdoc *, int, int, enum merr); static int swarn(struct mdoc *, enum mdoc_type, int, int, const struct mdoc_node *); -#define nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t)) - /* Central table of library: who gets parsed how. */ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { - { NULL, 0 }, /* \" */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ { in_line_eoln, MDOC_PROLOGUE }, /* Dd */ { in_line_eoln, MDOC_PROLOGUE }, /* Dt */ { in_line_eoln, MDOC_PROLOGUE }, /* Os */ { blk_full, 0 }, /* Sh */ { blk_full, 0 }, /* Ss */ - { in_line, 0 }, /* Pp */ + { in_line_eoln, 0 }, /* Pp */ { blk_part_imp, MDOC_PARSED }, /* D1 */ { blk_part_imp, MDOC_PARSED }, /* Dl */ { blk_full, MDOC_EXPLICIT }, /* Bd */ @@ -96,9 +69,9 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { blk_exp_close, MDOC_EXPLICIT }, /* El */ { blk_full, MDOC_PARSED }, /* It */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ - { in_line, MDOC_PARSED }, /* An */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ - { in_line_eoln, MDOC_CALLABLE }, /* Cd */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ @@ -108,11 +81,11 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { in_line_eoln, 0 }, /* Fd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ - { in_line, MDOC_PARSED }, /* Ft */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ - { in_line_eoln, 0 }, /* In */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ - { in_line_eoln, 0 }, /* Nd */ + { blk_full, 0 }, /* Nd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */ { obsolete, 0 }, /* Ot */ @@ -152,7 +125,7 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */ - { in_line, MDOC_PARSED }, /* Ms */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */ @@ -188,10 +161,9 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { obsolete, 0 }, /* Fr */ { in_line_eoln, 0 }, /* Ud */ { in_line_eoln, 0 }, /* Lb */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ - { in_line, 0 }, /* Lp */ - { in_line, MDOC_PARSED }, /* Lk */ - { in_line, MDOC_PARSED }, /* Mt */ + { in_line_eoln, 0 }, /* Lp */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */ { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */ { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */ @@ -200,59 +172,14 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { obsolete, 0 }, /* En */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */ { in_line_eoln, 0 }, /* %Q */ + { in_line_eoln, 0 }, /* br */ + { in_line_eoln, 0 }, /* sp */ }; const struct mdoc_macro * const mdoc_macros = __mdoc_macros; static int -perr(struct mdoc *mdoc, int line, int pos, enum merr type) -{ - char *p; - - p = NULL; - switch (type) { - case (EOPEN): - p = "explicit scope still open on exit"; - break; - case (EQUOT): - p = "unterminated quotation"; - break; - case (ENOCTX): - p = "closure has no prior context"; - break; - case (ENOPARMS): - p = "unexpect line arguments"; - break; - } - assert(p); - return(mdoc_perr(mdoc, line, pos, p)); -} - - -static int -pwarn(struct mdoc *mdoc, int line, int pos, enum mwarn type) -{ - char *p; - - p = NULL; - switch (type) { - case (WIMPBRK): - p = "crufty end-of-line scope violation"; - break; - case (WMACPARM): - p = "macro-like parameter"; - break; - case (WOBS): - p = "macro marked obsolete"; - break; - } - assert(p); - return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, p)); -} - - -static int swarn(struct mdoc *mdoc, enum mdoc_type type, int line, int pos, const struct mdoc_node *p) { @@ -290,10 +217,10 @@ swarn(struct mdoc *mdoc, enum mdoc_type type, } if ( ! (MDOC_IGN_SCOPE & mdoc->pflags)) - return(mdoc_perr(mdoc, line, pos, + return(mdoc_verr(mdoc, line, pos, "%s scope breaks %s scope of %s", tt, t, n)); - return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + return(mdoc_vwarn(mdoc, line, pos, "%s scope breaks %s scope of %s", tt, t, n)); } @@ -319,7 +246,7 @@ mdoc_macroend(struct mdoc *mdoc) continue; if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) continue; - return(nerr(mdoc, n, EOPEN)); + return(mdoc_nerr(mdoc, n, EOPEN)); } return(rew_last(mdoc, mdoc->first)); @@ -330,12 +257,12 @@ lookup(struct mdoc *mdoc, int line, int pos, int from, { int res; - res = mdoc_tokhash_find(mdoc->htab, p); + res = mdoc_hash_find(mdoc->htab, p); if (MDOC_PARSED & mdoc_macros[from].flags) return(res); if (MDOC_MAX == res) return(res); - if ( ! pwarn(mdoc, line, pos, WMACPARM)) + if ( ! mdoc_pwarn(mdoc, line, pos, EMACPARM)) return(-1); return(MDOC_MAX); } @@ -461,6 +388,8 @@ rew_dohalt(int tok, enum mdoc_type type, const struct if (type == p->type && tok == p->tok) return(REWIND_REWIND); break; + case (MDOC_Nd): + /* FALLTHROUGH */ case (MDOC_Ss): assert(MDOC_TAIL != type); if (type == p->type && tok == p->tok) @@ -566,9 +495,13 @@ rew_dobreak(int tok, const struct mdoc_node *p) switch (tok) { case (MDOC_It): return(MDOC_It == p->tok); + case (MDOC_Nd): + return(MDOC_Nd == p->tok); case (MDOC_Ss): return(MDOC_Ss == p->tok); case (MDOC_Sh): + if (MDOC_Nd == p->tok) + return(1); if (MDOC_Ss == p->tok) return(1); return(MDOC_Sh == p->tok); @@ -644,7 +577,7 @@ rew_expblock(struct mdoc *mdoc, int tok, int line, int for (n = mdoc->last; n; n = n->parent) { c = rew_dohalt(tok, MDOC_BLOCK, n); if (REWIND_HALT == c) - return(perr(mdoc, line, ppos, ENOCTX)); + return(mdoc_perr(mdoc, line, ppos, ENOCTX)); if (REWIND_REWIND == c) break; else if (rew_dobreak(tok, n)) @@ -729,13 +662,13 @@ blk_exp_close(MACRO_PROT_ARGS) } if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - if (0 == buf[*pos]) { - if ( ! rew_subblock(MDOC_BODY, mdoc, - tok, line, ppos)) + if (buf[*pos]) + if ( ! mdoc_pwarn(mdoc, line, ppos, ENOLINE)) return(0); - return(rew_expblock(mdoc, tok, line, ppos)); - } - return(perr(mdoc, line, ppos, ENOPARMS)); + + if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + return(rew_expblock(mdoc, tok, line, ppos)); } if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) @@ -748,7 +681,7 @@ blk_exp_close(MACRO_PROT_ARGS) mdoc->next = MDOC_NEXT_CHILD; } - for (lastarg = ppos, flushed = j = 0; ; j++) { + for (flushed = j = 0; ; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { @@ -800,11 +733,34 @@ blk_exp_close(MACRO_PROT_ARGS) static int in_line(MACRO_PROT_ARGS) { - int la, lastpunct, c, w, cnt, d, call; + int la, lastpunct, c, w, cnt, d, nc; struct mdoc_arg *arg; char *p; - for (la = ppos, arg = NULL;; ) { + /* + * Whether we allow ignored elements (those without content, + * usually because of reserved words) to squeak by. + */ + switch (tok) { + case (MDOC_An): + /* FALLTHROUGH */ + case (MDOC_Ar): + /* FALLTHROUGH */ + case (MDOC_Fl): + /* FALLTHROUGH */ + case (MDOC_Lk): + /* FALLTHROUGH */ + case (MDOC_Nm): + /* FALLTHROUGH */ + case (MDOC_Pa): + nc = 1; + break; + default: + nc = 0; + break; + } + + for (arg = NULL;; ) { la = *pos; c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); @@ -821,7 +777,7 @@ in_line(MACRO_PROT_ARGS) return(0); } - for (call = cnt = 0, lastpunct = 1;; ) { + for (cnt = 0, lastpunct = 1;; ) { la = *pos; w = mdoc_args(mdoc, line, pos, buf, tok, &p); @@ -837,18 +793,26 @@ in_line(MACRO_PROT_ARGS) c = ARGS_QWORD == w ? MDOC_MAX : lookup(mdoc, line, la, tok, p); - /* MDOC_MAX (not a macro) or -1 (error). */ + /* + * In this case, we've located a submacro and must + * execute it. Close out scope, if open. If no + * elements have been generated, either create one (nc) + * or raise a warning. + */ if (MDOC_MAX != c && -1 != c) { if (0 == lastpunct && ! rew_elem(mdoc, tok)) return(0); - if (0 == cnt) { + if (nc && 0 == cnt) { if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) return(0); - if ( ! rew_elem(mdoc, tok)) + if ( ! rew_last(mdoc, mdoc->last)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + } else if ( ! nc && 0 == cnt) { + mdoc_argv_free(arg); + if ( ! mdoc_pwarn(mdoc, line, ppos, EIGNE)) + return(0); } c = mdoc_macro(mdoc, c, line, la, pos, buf); if (0 == c) @@ -859,7 +823,11 @@ in_line(MACRO_PROT_ARGS) } else if (-1 == c) return(0); - /* Non-quote-enclosed punctuation. */ + /* + * Non-quote-enclosed punctuation. Set up our scope, if + * a word; rewind the scope, if a delimiter; then append + * the word. + */ d = mdoc_isdelim(p); @@ -884,13 +852,25 @@ in_line(MACRO_PROT_ARGS) if (0 == lastpunct && ! rew_elem(mdoc, tok)) return(0); - if (0 == cnt) { + + /* + * If no elements have been collected and we're allowed to have + * empties (nc), open a scope and close it out. Otherwise, + * raise a warning. + * + */ + if (nc && 0 == cnt) { c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); if (0 == c) return(0); - if ( ! rew_elem(mdoc, tok)) + if ( ! rew_last(mdoc, mdoc->last)) return(0); + } else if ( ! nc && 0 == cnt) { + mdoc_argv_free(arg); + if ( ! mdoc_pwarn(mdoc, line, ppos, EIGNE)) + return(0); } + if (ppos > 1) return(1); return(append_delims(mdoc, line, pos, buf)); @@ -903,10 +883,26 @@ in_line(MACRO_PROT_ARGS) static int blk_full(MACRO_PROT_ARGS) { - int c, lastarg, reopen; + int c, lastarg, reopen, dohead; struct mdoc_arg *arg; char *p; + /* + * Whether to process a block-head section. If this is + * non-zero, then a head will be opened for all line arguments. + * If not, then the head will always be empty and only a body + * will be opened, which will stay open at the eoln. + */ + + switch (tok) { + case (MDOC_Nd): + dohead = 0; + break; + default: + dohead = 1; + break; + } + if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) @@ -951,6 +947,16 @@ blk_full(MACRO_PROT_ARGS) if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) return(0); + + /* Immediately close out head and enter body, if applicable. */ + + if (0 == dohead) { + if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + } + mdoc->next = MDOC_NEXT_CHILD; for (reopen = 0;; ) { @@ -962,6 +968,7 @@ blk_full(MACRO_PROT_ARGS) if (ARGS_EOLN == c) break; if (ARGS_PHRASE == c) { + assert(dohead); if (reopen && ! mdoc_head_alloc (mdoc, line, ppos, tok)) return(0); @@ -998,9 +1005,13 @@ blk_full(MACRO_PROT_ARGS) if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) return(0); + + /* If the body's already open, then just return. */ + if (0 == dohead) + return(1); + if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); mdoc->next = MDOC_NEXT_CHILD; @@ -1035,7 +1046,7 @@ blk_part_imp(MACRO_PROT_ARGS) /* XXX - no known argument macros. */ - for (lastarg = ppos;; ) { + for (;;) { lastarg = *pos; c = mdoc_args(mdoc, line, pos, buf, tok, &p); assert(ARGS_PHRASE != c); @@ -1071,7 +1082,7 @@ blk_part_imp(MACRO_PROT_ARGS) if (body == n) break; - if (NULL == n && ! pwarn(mdoc, body->line, body->pos, WIMPBRK)) + if (NULL == n && ! mdoc_nwarn(mdoc, body, EIMPBRK)) return(0); if (n && ! rew_last(mdoc, body)) @@ -1096,7 +1107,6 @@ blk_part_exp(MACRO_PROT_ARGS) int lastarg, flushed, j, c, maxargs; char *p; - lastarg = ppos; flushed = 0; /* @@ -1232,7 +1242,7 @@ in_line_argn(MACRO_PROT_ARGS) break; } - for (lastarg = ppos, arg = NULL;; ) { + for (arg = NULL;; ) { lastarg = *pos; c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); @@ -1374,82 +1384,48 @@ static int obsolete(MACRO_PROT_ARGS) { - return(pwarn(mdoc, line, ppos, WOBS)); + return(mdoc_pwarn(mdoc, line, ppos, EOBS)); } +/* + * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs. + * They're unusual because they're basically free-form text until a + * macro is encountered. + */ static int phrase(struct mdoc *mdoc, int line, int ppos, char *buf) { - int i, la, c, quoted; + int c, w, la, pos; + char *p; - /* - * Parse over words in a phrase. We have to handle this - * specially because we assume no calling context -- in normal - * circumstances, we switch argument parsing based on whether - * the parent macro accepts quotes, tabs, etc. Here, anything - * goes. - */ + for (pos = ppos; ; ) { + la = pos; - for (i = ppos; buf[i]; ) { - assert(' ' != buf[i]); - la = i; - quoted = 0; + /* Note: no calling context! */ + w = mdoc_zargs(mdoc, line, &pos, buf, &p); - /* - * Read to next token. If quoted (check not escaped), - * scan ahead to next unescaped quote. If not quoted or - * escape-quoted, then scan ahead to next space. - */ + if (ARGS_ERROR == w) + return(0); + if (ARGS_EOLN == w) + break; - if ((i && '\"' == buf[i] && '\\' != buf[i - 1]) || - (0 == i && '\"' == buf[i])) { - for (la = ++i; buf[i]; i++) - if ('\"' != buf[i]) - continue; - else if ('\\' != buf[i - 1]) - break; - if (0 == buf[i]) - return(perr(mdoc, line, la, EQUOT)); - quoted = 1; - } else - for ( ; buf[i]; i++) - if (i && ' ' == buf[i]) { - if ('\\' != buf[i - 1]) - break; - } else if (' ' == buf[i]) - break; + c = ARGS_QWORD == w ? MDOC_MAX : + mdoc_hash_find(mdoc->htab, p); - /* If not end-of-line, terminate argument. */ - - if (buf[i]) - buf[i++] = 0; - - /* Read to next argument. */ - - for ( ; buf[i] && ' ' == buf[i]; i++) - /* Spin. */ ; - - /* - * If we're a non-quoted string, try to look up the - * value as a macro and execute it, if found. - */ - - c = quoted ? MDOC_MAX : - mdoc_tokhash_find(mdoc->htab, &buf[la]); - - if (MDOC_MAX != c) { - if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) + if (MDOC_MAX != c && -1 != c) { + if ( ! mdoc_macro(mdoc, c, line, la, &pos, buf)) return(0); - return(append_delims(mdoc, line, &i, buf)); - } + return(append_delims(mdoc, line, &pos, buf)); + } else if (-1 == c) + return(0); - /* A regular word or quoted string. */ - - if ( ! mdoc_word_alloc(mdoc, line, la, &buf[la])) + if ( ! mdoc_word_alloc(mdoc, line, la, p)) return(0); mdoc->next = MDOC_NEXT_SIBLING; } return(1); } + +