=================================================================== RCS file: /cvs/mandoc/Attic/macro.c,v retrieving revision 1.45 retrieving revision 1.71 diff -u -p -r1.45 -r1.71 --- mandoc/Attic/macro.c 2009/01/20 13:05:28 1.45 +++ mandoc/Attic/macro.c 2009/03/12 23:05:21 1.71 @@ -1,4 +1,4 @@ -/* $Id: macro.c,v 1.45 2009/01/20 13:05:28 kristaps Exp $ */ +/* $Id: macro.c,v 1.71 2009/03/12 23:05:21 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,65 +21,31 @@ #include #include #include -#ifdef __linux__ -#include -#endif +#include "private.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. Macros are parsed according as follows: - * - * ELEMENT: TEXT | epsilon - * BLOCK: HEAD PUNCT BODY PUNCT BLOCK_TAIL PUNCT - * BLOCK_TAIL: TAIL | epsilon - * HEAD: ELEMENT | TEXT | BLOCK | epsilon - * BODY: ELEMENT | TEXT | BLOCK | epsilon - * TAIL: TEXT | epsilon - * PUNCT: TEXT (delimiters) | epsilon - * - * These are arranged into a parse tree, an example of which follows: - * - * ROOT - * BLOCK (.Sh) - * HEAD - * TEXT (`NAME') - * BODY - * ELEMENT (.Nm) - * TEXT (`mdocml') - * ELEMENT (.Nd) - * TEXT (`mdoc macro compiler') - * BLOCK (.Op) - * HEAD - * ELEMENT (.Fl) - * TEXT (`v') - * BLOCK (.Op) - * HEAD - * ELEMENT (.Fl) - * TEXT (`v') - * ELEMENT (.Fl) - * TEXT (`W') - * ELEMENT (.Ns) - * ELEMENT (.Ar) - * TEXT (`err...') - * - * These types are always per-line except for block bodies, which may - * span multiple lines. Macros are assigned a parsing routine, which - * corresponds to the type, in the mdoc_macros table. - * - * Note that types are general: there can be several parsing routines - * corresponding to a single type. The macro_text function, for - * example, parses an ELEMENT type (see the function definition for - * details) that may be interrupted by further macros; the - * macro_constant function, on the other hand, parses an ELEMENT type - * spanning a single line. + * macro. */ -#include "private.h" +/* FIXME: .Fl, .Ar, .Cd handling of `|'. */ +static int macro_obsolete(MACRO_PROT_ARGS); +static int macro_constant(MACRO_PROT_ARGS); +static int macro_constant_scoped(MACRO_PROT_ARGS); +static int macro_constant_delimited(MACRO_PROT_ARGS); +static int macro_text(MACRO_PROT_ARGS); +static int macro_scoped(MACRO_PROT_ARGS); +static int macro_scoped_close(MACRO_PROT_ARGS); +static int macro_scoped_line(MACRO_PROT_ARGS); +static int macro_phrase(struct mdoc *, int, int, char *); + #define REWIND_REWIND (1 << 0) #define REWIND_NOHALT (1 << 1) #define REWIND_HALT (1 << 2) + static int rewind_dohalt(int, enum mdoc_type, const struct mdoc_node *); static int rewind_alt(int); @@ -92,19 +58,274 @@ static int rewind_subblock(enum mdoc_type, static int rewind_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, int); +static int perr(struct mdoc *, int, int, int); +static int scopewarn(struct mdoc *, enum mdoc_type, int, int, + const struct mdoc_node *); +#define WMACPARM (1) +#define WOBS (2) +#define ENOCTX (1) +#define ENOPARMS (2) + +/* Central table of library: who gets parsed how. */ + +const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { + { NULL, 0 }, /* \" */ + { macro_constant, MDOC_PROLOGUE }, /* Dd */ + { macro_constant, MDOC_PROLOGUE }, /* Dt */ + { macro_constant, MDOC_PROLOGUE }, /* Os */ + { macro_scoped, 0 }, /* Sh */ + { macro_scoped, 0 }, /* Ss */ + { macro_text, 0 }, /* Pp */ + { macro_scoped_line, MDOC_PARSED }, /* D1 */ + { macro_scoped_line, MDOC_PARSED }, /* Dl */ + { macro_scoped, MDOC_EXPLICIT }, /* Bd */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Ed */ + { macro_scoped, MDOC_EXPLICIT }, /* Bl */ + { macro_scoped_close, MDOC_EXPLICIT }, /* El */ + { macro_scoped, MDOC_PARSED }, /* It */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ + { macro_text, MDOC_PARSED }, /* An */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ + { macro_constant, MDOC_CALLABLE }, /* Cd */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */ + { macro_constant, 0 }, /* Ex */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */ + { macro_constant, 0 }, /* Fd */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ + { macro_text, MDOC_PARSED }, /* Ft */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ + { macro_constant, 0 }, /* In */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ + { macro_constant, 0 }, /* Nd */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */ + { macro_obsolete, 0 }, /* Ot */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */ + { macro_constant, 0 }, /* Rv */ + /* XXX - .St supposed to be (but isn't) callable. */ + { macro_constant_delimited, MDOC_PARSED }, /* St */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */ + { macro_constant, 0 }, /* %A */ + { macro_constant, 0 }, /* %B */ + { macro_constant, 0 }, /* %D */ + { macro_constant, 0 }, /* %I */ + { macro_constant, 0 }, /* %J */ + { macro_constant, 0 }, /* %N */ + { macro_constant, 0 }, /* %O */ + { macro_constant, 0 }, /* %P */ + { macro_constant, 0 }, /* %R */ + { macro_constant, 0 }, /* %T */ + { macro_constant, 0 }, /* %V */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* At */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */ + { macro_scoped, MDOC_EXPLICIT }, /* Bf */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */ + { macro_constant, 0 }, /* Db */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Ef */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */ + { macro_text, MDOC_PARSED }, /* Ms */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */ + { macro_constant_delimited, MDOC_PARSED }, /* Pf */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Re */ + { macro_scoped, MDOC_EXPLICIT }, /* Rs */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */ + { macro_constant, 0 }, /* Sm */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ux */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */ + /* XXX - .Fo supposed to be (but isn't) callable. */ + { macro_scoped, MDOC_EXPLICIT }, /* Fo */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */ + { macro_scoped, MDOC_EXPLICIT }, /* Bk */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Ek */ + { macro_constant, 0 }, /* Bt */ + { macro_constant, 0 }, /* Hf */ + { macro_obsolete, 0 }, /* Fr */ + { macro_constant, 0 }, /* Ud */ + { macro_constant, 0 }, /* Lb */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ + { macro_text, 0 }, /* Lp */ + { macro_text, MDOC_PARSED }, /* Lk */ + { macro_text, MDOC_PARSED }, /* Mt */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */ + { macro_constant, 0 }, /* %C */ +}; + +const struct mdoc_macro * const mdoc_macros = __mdoc_macros; + + +/* + * This is called at the end of parsing. It must traverse up the tree, + * closing out open [implicit] scopes. Obviously, open explicit scopes + * are errors. + */ +int +macro_end(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + assert(mdoc->first); + assert(mdoc->last); + + /* Scan for open explicit scopes. */ + + n = MDOC_VALID & mdoc->last->flags ? + mdoc->last->parent : mdoc->last; + + for ( ; n; n = n->parent) { + if (MDOC_BLOCK != n->type) + continue; + if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) + continue; + return(mdoc_nerr(mdoc, n, + "macro scope still open on exit")); + } + + return(rewind_last(mdoc, mdoc->first)); +} + + static int +perr(struct mdoc *mdoc, int line, int pos, int type) +{ + int c; + + switch (type) { + case (ENOCTX): + c = mdoc_perr(mdoc, line, pos, + "closing macro has no prior context"); + break; + case (ENOPARMS): + c = mdoc_perr(mdoc, line, pos, + "macro doesn't expect parameters"); + break; + default: + abort(); + /* NOTREACHED */ + } + return(c); +} + +static int +pwarn(struct mdoc *mdoc, int line, int pos, int type) +{ + int c; + + switch (type) { + case (WMACPARM): + c = mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "macro-like parameter"); + break; + case (WOBS): + c = mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "macro is marked obsolete"); + break; + default: + abort(); + /* NOTREACHED */ + } + return(c); +} + + +static int +scopewarn(struct mdoc *mdoc, enum mdoc_type type, + int line, int pos, const struct mdoc_node *p) +{ + const char *n, *t, *tt; + + n = t = ""; + tt = "block"; + + switch (type) { + case (MDOC_BODY): + tt = "multi-line"; + break; + case (MDOC_HEAD): + tt = "line"; + break; + default: + break; + } + + switch (p->type) { + case (MDOC_BLOCK): + n = mdoc_macronames[p->tok]; + t = "block"; + break; + case (MDOC_BODY): + n = mdoc_macronames[p->tok]; + t = "multi-line"; + break; + case (MDOC_HEAD): + n = mdoc_macronames[p->tok]; + t = "line"; + break; + default: + break; + } + + if ( ! (MDOC_IGN_SCOPE & mdoc->pflags)) + return(mdoc_perr(mdoc, line, pos, + "%s scope breaks %s scope of %s", + tt, t, n)); + return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "%s scope breaks %s scope of %s", + tt, t, n)); +} + + +static int lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p) { int res; - res = mdoc_find(mdoc, p); + res = mdoc_tokhash_find(mdoc->htab, p); if (MDOC_PARSED & mdoc_macros[from].flags) return(res); if (MDOC_MAX == res) return(res); - if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, "macro-like parameter")) + if ( ! pwarn(mdoc, line, pos, WMACPARM)) return(-1); return(MDOC_MAX); } @@ -117,6 +338,7 @@ rewind_last(struct mdoc *mdoc, struct mdoc_node *to) assert(to); mdoc->next = MDOC_NEXT_SIBLING; + /* LINTED */ while (mdoc->last != to) { if ( ! mdoc_valid_post(mdoc)) return(0); @@ -140,6 +362,8 @@ rewind_alt(int tok) return(MDOC_Ao); case (MDOC_Bc): return(MDOC_Bo); + case (MDOC_Brc): + return(MDOC_Bro); case (MDOC_Dc): return(MDOC_Do); case (MDOC_Ec): @@ -189,6 +413,8 @@ rewind_dohalt(int tok, enum mdoc_type type, const stru /* FALLTHROUGH */ case (MDOC_Bq): /* FALLTHROUGH */ + case (MDOC_Brq): + /* FALLTHROUGH */ case (MDOC_D1): /* FALLTHROUGH */ case (MDOC_Dl): @@ -243,6 +469,8 @@ rewind_dohalt(int tok, enum mdoc_type type, const stru /* FALLTHROUGH */ case (MDOC_Bo): /* FALLTHROUGH */ + case (MDOC_Bro): + /* FALLTHROUGH */ case (MDOC_Do): /* FALLTHROUGH */ case (MDOC_Eo): @@ -269,6 +497,8 @@ rewind_dohalt(int tok, enum mdoc_type type, const stru /* FALLTHROUGH */ case (MDOC_Bc): /* FALLTHROUGH */ + case (MDOC_Brc): + /* FALLTHROUGH */ case (MDOC_Dc): /* FALLTHROUGH */ case (MDOC_Ec): @@ -378,7 +608,8 @@ rewind_subblock(enum mdoc_type type, struct mdoc *mdoc break; else if (rewind_dobreak(tok, n)) continue; - return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n))); + if ( ! scopewarn(mdoc, type, line, ppos, n)) + return(0); } assert(n); @@ -396,12 +627,13 @@ rewind_expblock(struct mdoc *mdoc, int tok, int line, for (n = mdoc->last; n; n = n->parent) { c = rewind_dohalt(tok, MDOC_BLOCK, n); if (REWIND_HALT == c) - return(mdoc_perr(mdoc, line, ppos, "closing macro has no context")); + return(perr(mdoc, line, ppos, ENOCTX)); if (REWIND_REWIND == c) break; else if (rewind_dobreak(tok, n)) continue; - return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n))); + if ( ! scopewarn(mdoc, MDOC_BLOCK, line, ppos, n)) + return(0); } assert(n); @@ -424,7 +656,8 @@ rewind_impblock(struct mdoc *mdoc, int tok, int line, break; else if (rewind_dobreak(tok, n)) continue; - return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n))); + if ( ! scopewarn(mdoc, MDOC_BLOCK, line, ppos, n)) + return(0); } assert(n); @@ -444,6 +677,8 @@ append_delims(struct mdoc *mdoc, int line, int *pos, c for (;;) { lastarg = *pos; c = mdoc_args(mdoc, line, pos, buf, 0, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); else if (ARGS_EOLN == c) @@ -462,7 +697,7 @@ append_delims(struct mdoc *mdoc, int line, int *pos, c * Close out an explicit scope. This optionally parses a TAIL type with * a set number of TEXT children. */ -int +static int macro_scoped_close(MACRO_PROT_ARGS) { int tt, j, c, lastarg, maxargs, flushed; @@ -484,11 +719,12 @@ macro_scoped_close(MACRO_PROT_ARGS) if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { if (0 == buf[*pos]) { - if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + if ( ! rewind_subblock(MDOC_BODY, mdoc, + tok, line, ppos)) return(0); return(rewind_expblock(mdoc, tok, line, ppos)); } - return(mdoc_perr(mdoc, line, ppos, "macro expects no parameters")); + return(perr(mdoc, line, ppos, ENOPARMS)); } if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) @@ -512,7 +748,9 @@ macro_scoped_close(MACRO_PROT_ARGS) flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); if (ARGS_PUNCT == c) @@ -524,7 +762,8 @@ macro_scoped_close(MACRO_PROT_ARGS) return(0); else if (MDOC_MAX != c) { if ( ! flushed) { - if ( ! rewind_expblock(mdoc, tok, line, ppos)) + if ( ! rewind_expblock(mdoc, tok, + line, ppos)) return(0); flushed = 1; } @@ -571,19 +810,20 @@ macro_scoped_close(MACRO_PROT_ARGS) * TEXT (`;') * TEXT (`;') */ -int +static int macro_text(MACRO_PROT_ARGS) { - int la, lastpunct, c, w, fl, argc; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; + int la, lastpunct, c, w; + struct mdoc_arg *arg; char *p; la = ppos; lastpunct = 0; + arg = NULL; - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { + for (;;) { la = *pos; - c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf); + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); if (ARGV_EOLN == c) break; if (ARGV_WORD == c) { @@ -591,76 +831,59 @@ macro_text(MACRO_PROT_ARGS) break; } else if (ARGV_ARG == c) continue; - - mdoc_argv_free(argc, argv); + mdoc_argv_free(arg); return(0); } - if (MDOC_LINEARG_MAX == argc) { - mdoc_argv_free(argc - 1, argv); - return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded")); - } - - c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv); - - if (0 == c) { - mdoc_argv_free(argc, argv); + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) return(0); - } mdoc->next = MDOC_NEXT_CHILD; - fl = ARGS_DELIM; - if (MDOC_QUOTABLE & mdoc_macros[tok].flags) - fl |= ARGS_QUOTED; - lastpunct = 0; for (;;) { la = *pos; - w = mdoc_args(mdoc, line, pos, buf, fl, &p); - if (ARGS_ERROR == w) { - mdoc_argv_free(argc, argv); - return(0); - } + w = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != w); + if (ARGS_ERROR == w) + return(0); if (ARGS_EOLN == w) break; if (ARGS_PUNCT == w) break; + /* Quoted words shouldn't be looked-up. */ + c = ARGS_QWORD == w ? MDOC_MAX : lookup(mdoc, line, la, tok, p); + /* MDOC_MAX (not a macro) or -1 (error). */ + if (MDOC_MAX != c && -1 != c) { - if (0 == lastpunct && ! rewind_elem(mdoc, tok)) { - mdoc_argv_free(argc, argv); + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) return(0); - } - mdoc_argv_free(argc, argv); c = mdoc_macro(mdoc, c, line, la, pos, buf); if (0 == c) return(0); if (ppos > 1) return(1); return(append_delims(mdoc, line, pos, buf)); - } else if (-1 == c) { - mdoc_argv_free(argc, argv); + } else if (-1 == c) return(0); - } + /* Non-quote-enclosed punctuation. */ + if (ARGS_QWORD != w && mdoc_isdelim(p)) { - if (0 == lastpunct && ! rewind_elem(mdoc, tok)) { - mdoc_argv_free(argc, argv); + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) return(0); - } lastpunct = 1; } else if (lastpunct) { - c = mdoc_elem_alloc(mdoc, line, - ppos, tok, argc, argv); - if (0 == c) { - mdoc_argv_free(argc, argv); + c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + + if (0 == c) return(0); - } + mdoc->next = MDOC_NEXT_CHILD; lastpunct = 0; } @@ -670,8 +893,6 @@ macro_text(MACRO_PROT_ARGS) mdoc->next = MDOC_NEXT_SIBLING; } - mdoc_argv_free(argc, argv); - if (0 == lastpunct && ! rewind_elem(mdoc, tok)) return(0); if (ppos > 1) @@ -702,17 +923,21 @@ macro_text(MACRO_PROT_ARGS) * TEXT (`Another.') * * Note that the `.It' macro, possibly the most difficult (as it has - * embedded scope, etc.) is handled by this routine. + * embedded scope, etc.) is handled by this routine. It handles + * columnar output, where columns are "phrases" and denote multiple + * block heads. */ -int +static int macro_scoped(MACRO_PROT_ARGS) { - int c, lastarg, argc, fl; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; + int c, lastarg, reopen; + struct mdoc_arg *arg; char *p; assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)); + /* First rewind extant implicit scope. */ + if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) return(0); @@ -720,9 +945,13 @@ macro_scoped(MACRO_PROT_ARGS) return(0); } - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { + /* Parse arguments. */ + + arg = NULL; + + for (;;) { lastarg = *pos; - c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf); + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); if (ARGV_EOLN == c) break; if (ARGV_WORD == c) { @@ -730,20 +959,11 @@ macro_scoped(MACRO_PROT_ARGS) break; } else if (ARGV_ARG == c) continue; - mdoc_argv_free(argc, argv); + mdoc_argv_free(arg); return(0); } - if (MDOC_LINEARG_MAX == argc) { - mdoc_argv_free(argc - 1, argv); - return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded")); - } - - c = mdoc_block_alloc(mdoc, line, ppos, - tok, (size_t)argc, argv); - mdoc_argv_free(argc, argv); - - if (0 == c) + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg)) return(0); mdoc->next = MDOC_NEXT_CHILD; @@ -751,7 +971,8 @@ macro_scoped(MACRO_PROT_ARGS) if (0 == buf[*pos]) { if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) return(0); - if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) return(0); if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); @@ -761,26 +982,42 @@ macro_scoped(MACRO_PROT_ARGS) if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) return(0); + + /* Indicate that columnar scope shouldn't be reopened. */ + reopen = 0; mdoc->next = MDOC_NEXT_CHILD; - fl = ARGS_DELIM; - if (MDOC_TABSEP & mdoc_macros[tok].flags) - fl |= ARGS_TABSEP; - for (;;) { lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, fl, &p); - + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ARGS_ERROR == c) return(0); - if (ARGS_PUNCT == c) - break; if (ARGS_EOLN == c) break; - + if (ARGS_PHRASE == c) { + if (reopen && ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + + /* + * Phrases are self-contained macro phrases used + * in the columnar output of a macro. They need + * special handling. + */ + if ( ! macro_phrase(mdoc, line, lastarg, buf)) + return(0); + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); + + reopen = 1; + continue; + } + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) return(0); - else if (MDOC_MAX == c) { + + if (MDOC_MAX == c) { if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) return(0); mdoc->next = MDOC_NEXT_SIBLING; @@ -791,11 +1028,11 @@ macro_scoped(MACRO_PROT_ARGS) return(0); break; } - - if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) - return(0); + if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) return(0); + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); @@ -824,13 +1061,13 @@ macro_scoped(MACRO_PROT_ARGS) * TEXT (`;') * TEXT (`;') */ -int +static int macro_scoped_line(MACRO_PROT_ARGS) { int lastarg, c; char *p; - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL)) + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) return(0); mdoc->next = MDOC_NEXT_CHILD; @@ -846,7 +1083,8 @@ macro_scoped_line(MACRO_PROT_ARGS) lastarg = ppos; for (;;) { lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); if (ARGS_ERROR == c) return(0); @@ -895,7 +1133,7 @@ macro_scoped_line(MACRO_PROT_ARGS) * TEXT (`b') * TEXT (';') */ -int +static int macro_constant_scoped(MACRO_PROT_ARGS) { int lastarg, flushed, j, c, maxargs; @@ -913,7 +1151,7 @@ macro_constant_scoped(MACRO_PROT_ARGS) break; } - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL)) + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) return(0); mdoc->next = MDOC_NEXT_CHILD; @@ -942,7 +1180,9 @@ macro_constant_scoped(MACRO_PROT_ARGS) mdoc->next = MDOC_NEXT_CHILD; } - c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); if (ARGS_PUNCT == c) @@ -954,20 +1194,24 @@ macro_constant_scoped(MACRO_PROT_ARGS) return(0); else if (MDOC_MAX != c) { if ( ! flushed) { - if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) return(0); flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + if ( ! mdoc_body_alloc(mdoc, line, + ppos, tok)) return(0); mdoc->next = MDOC_NEXT_CHILD; } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, c, line, lastarg, + pos, buf)) return(0); break; } if ( ! flushed && mdoc_isdelim(p)) { - if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) return(0); flushed = 1; if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) @@ -1007,26 +1251,30 @@ macro_constant_scoped(MACRO_PROT_ARGS) * ELEMENT (.No) * TEXT (`b') */ -int +static int macro_constant_delimited(MACRO_PROT_ARGS) { - int lastarg, flushed, j, c, maxargs, argc; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; + int lastarg, flushed, j, c, maxargs, + igndelim, ignargs; + struct mdoc_arg *arg; char *p; lastarg = ppos; flushed = 0; + + /* + * Maximum arguments per macro. Some of these have none and + * exit as soon as they're parsed. + */ switch (tok) { + case (MDOC_Ap): + /* FALLTHROUGH */ case (MDOC_No): /* FALLTHROUGH */ case (MDOC_Ns): /* FALLTHROUGH */ - case (MDOC_Pf): - /* FALLTHROUGH */ case (MDOC_Ux): - /* FALLTHROUGH */ - case (MDOC_St): maxargs = 0; break; default: @@ -1034,29 +1282,53 @@ macro_constant_delimited(MACRO_PROT_ARGS) break; } - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { - lastarg = *pos; - c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf); - if (ARGV_EOLN == c) - break; - if (ARGV_WORD == c) { - *pos = lastarg; - break; - } else if (ARGV_ARG == c) - continue; - mdoc_argv_free(argc, argv); - return(0); + /* + * Whether to ignore delimiter characters. `Pf' accepts its + * first token as a parameter no matter what it looks like (if + * it's text). + */ + + switch (tok) { + case (MDOC_Pf): + igndelim = 1; + break; + default: + igndelim = 0; + break; } - if (MDOC_LINEARG_MAX == argc) { - mdoc_argv_free(argc - 1, argv); - return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded")); + /* + * Whether to ignore arguments: `St', for example, handles its + * argument-like parameters as regular parameters. + */ + + switch (tok) { + case (MDOC_St): + ignargs = 1; + break; + default: + ignargs = 0; + break; } - c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv); - mdoc_argv_free(argc, argv); + arg = NULL; - if (0 == c) + if ( ! ignargs) + for (;;) { + lastarg = *pos; + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + if (ARGV_EOLN == c) + break; + if (ARGV_WORD == c) { + *pos = lastarg; + break; + } else if (ARGV_ARG == c) + continue; + mdoc_argv_free(arg); + return(0); + } + + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) return(0); mdoc->next = MDOC_NEXT_CHILD; @@ -1070,7 +1342,9 @@ macro_constant_delimited(MACRO_PROT_ARGS) flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); if (ARGS_PUNCT == c) @@ -1089,7 +1363,7 @@ macro_constant_delimited(MACRO_PROT_ARGS) break; } - if ( ! flushed && mdoc_isdelim(p)) { + if ( ! flushed && mdoc_isdelim(p) && ! igndelim) { if ( ! rewind_elem(mdoc, tok)) return(0); flushed = 1; @@ -1113,18 +1387,18 @@ macro_constant_delimited(MACRO_PROT_ARGS) * A constant macro is the simplest classification. It spans an entire * line. */ -int +static int macro_constant(MACRO_PROT_ARGS) { - int c, w, la, argc, fl; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; + int c, w, la; + struct mdoc_arg *arg; char *p; - assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)); + arg = NULL; - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { + for (;;) { la = *pos; - c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf); + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); if (ARGV_EOLN == c) break; if (ARGV_WORD == c) { @@ -1132,31 +1406,20 @@ macro_constant(MACRO_PROT_ARGS) break; } else if (ARGV_ARG == c) continue; - - mdoc_argv_free(argc, argv); + mdoc_argv_free(arg); return(0); } - if (MDOC_LINEARG_MAX == argc) { - mdoc_argv_free(argc - 1, argv); - return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded")); - } - - c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv); - mdoc_argv_free(argc, argv); - - if (0 == c) + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) return(0); mdoc->next = MDOC_NEXT_CHILD; - fl = 0; - if (MDOC_QUOTABLE & mdoc_macros[tok].flags) - fl = ARGS_QUOTED; - for (;;) { la = *pos; - w = mdoc_args(mdoc, line, pos, buf, fl, &p); + w = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == w) return(0); if (ARGS_EOLN == w) @@ -1182,40 +1445,52 @@ macro_constant(MACRO_PROT_ARGS) /* ARGSUSED */ -int +static int macro_obsolete(MACRO_PROT_ARGS) { - return(mdoc_pwarn(mdoc, line, ppos, WARN_SYNTAX, "macro is obsolete")); + return(pwarn(mdoc, line, ppos, WOBS)); } -/* - * This is called at the end of parsing. It must traverse up the tree, - * closing out open [implicit] scopes. Obviously, open explicit scopes - * are errors. - */ -int -macro_end(struct mdoc *mdoc) +static int +macro_phrase(struct mdoc *mdoc, int line, int ppos, char *buf) { - struct mdoc_node *n; + int i, la, c; - assert(mdoc->first); - assert(mdoc->last); + for (i = ppos; buf[i]; ) { + assert(' ' != buf[i]); - /* Scan for open explicit scopes. */ + la = i; + if ('\"' == buf[i]) { + la = ++i; + while (buf[i] && '\"' != buf[i]) + i++; + if (0 == buf[i]) + return(mdoc_err(mdoc, "unterminated quoted parameter")); + } else + while (buf[i] && ! isspace ((unsigned char)buf[i])) + i++; - n = MDOC_VALID & mdoc->last->flags ? - mdoc->last->parent : mdoc->last; + if (buf[i]) + buf[i++] = 0; - for ( ; n; n = n->parent) { - if (MDOC_BLOCK != n->type) - continue; - if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) - continue; - mdoc_nerr(mdoc, n, "macro scope still open on exit"); - return(0); + while (buf[i] && isspace((unsigned char)buf[i])) + i++; + + if (MDOC_MAX != (c = mdoc_tokhash_find(mdoc->htab, &buf[la]))) { + if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) + return(0); + return(append_delims(mdoc, line, &i, buf)); + } + + if ( ! mdoc_word_alloc(mdoc, line, la, &buf[la])) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + + while (buf[i] && isspace((unsigned char)buf[i])) + i++; } - return(rewind_last(mdoc, mdoc->first)); + return(1); }