=================================================================== RCS file: /cvs/mandoc/mdoc_argv.c,v retrieving revision 1.3 retrieving revision 1.111 diff -u -p -r1.3 -r1.111 --- mandoc/mdoc_argv.c 2009/04/12 19:45:26 1.3 +++ mandoc/mdoc_argv.c 2017/04/24 23:06:18 1.111 @@ -1,87 +1,73 @@ -/* $Id: mdoc_argv.c,v 1.3 2009/04/12 19:45:26 kristaps Exp $ */ +/* $Id: mdoc_argv.c,v 1.111 2017/04/24 23:06:18 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2012, 2014-2017 Ingo Schwarze * * 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. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 "config.h" + #include #include -#include #include #include #include +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" +#include "mdoc.h" +#include "libmandoc.h" +#include "roff_int.h" #include "libmdoc.h" -/* - * Routines to parse arguments of macros. Arguments follow the syntax - * of `-arg [val [valN...]]'. Arguments come in all types: quoted - * arguments, multiple arguments per value, no-value arguments, etc. - * - * There's no limit to the number or arguments that may be allocated. - */ +#define MULTI_STEP 5 /* pre-allocate argument values */ +#define DELIMSZ 6 /* max possible size of a delimiter */ -#define ARGS_QUOTED (1 << 0) -#define ARGS_DELIM (1 << 1) -#define ARGS_TABSEP (1 << 2) -#define ARGS_ARGVLIKE (1 << 3) +enum argsflag { + ARGSFL_NONE = 0, + ARGSFL_DELIM, /* handle delimiters of [[::delim::][ ]+]+ */ + ARGSFL_TABSEP /* handle tab/`Ta' separated phrases */ +}; -#define ARGV_NONE (1 << 0) -#define ARGV_SINGLE (1 << 1) -#define ARGV_MULTI (1 << 2) -#define ARGV_OPT_SINGLE (1 << 3) - -#define MULTI_STEP 5 - -enum mwarn { - WQUOTPARM, - WARGVPARM, - WCOLEMPTY, - WTAILWS +enum argvflag { + ARGV_NONE, /* no args to flag (e.g., -split) */ + ARGV_SINGLE, /* one arg to flag (e.g., -file xxx) */ + ARGV_MULTI /* multiple args (e.g., -column xxx yyy) */ }; -enum merr { - EQUOTTERM, - EMALLOC, - EARGVAL +struct mdocarg { + enum argsflag flags; + const enum mdocargt *argvs; }; -static int argv_a2arg(int, const char *); -static int args(struct mdoc *, int, int *, - char *, int, char **); -static int argv(struct mdoc *, int, +static void argn_free(struct mdoc_arg *, int); +static enum margserr args(struct roff_man *, int, int *, + char *, enum argsflag, char **); +static int args_checkpunct(const char *, int); +static void argv_multi(struct roff_man *, int, struct mdoc_argv *, int *, char *); -static int argv_single(struct mdoc *, int, +static void argv_single(struct roff_man *, int, struct mdoc_argv *, int *, char *); -static int argv_opt_single(struct mdoc *, int, - struct mdoc_argv *, int *, char *); -static int argv_multi(struct mdoc *, int, - struct mdoc_argv *, int *, char *); -static int pwarn(struct mdoc *, int, int, enum mwarn); -static int perr(struct mdoc *, int, int, enum merr); -#define verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t)) - -/* Per-argument flags. */ - -static int mdoc_argvflags[MDOC_ARG_MAX] = { +static const enum argvflag argvflags[MDOC_ARG_MAX] = { ARGV_NONE, /* MDOC_Split */ ARGV_NONE, /* MDOC_Nosplit */ ARGV_NONE, /* MDOC_Ragged */ ARGV_NONE, /* MDOC_Unfilled */ ARGV_NONE, /* MDOC_Literal */ - ARGV_NONE, /* MDOC_File */ + ARGV_SINGLE, /* MDOC_File */ ARGV_SINGLE, /* MDOC_Offset */ ARGV_NONE, /* MDOC_Bullet */ ARGV_NONE, /* MDOC_Dash */ @@ -96,7 +82,7 @@ static int mdoc_argvflags[MDOC_ARG_MAX] = { ARGV_MULTI, /* MDOC_Column */ ARGV_SINGLE, /* MDOC_Width */ ARGV_NONE, /* MDOC_Compact */ - ARGV_OPT_SINGLE, /* MDOC_Std */ + ARGV_NONE, /* MDOC_Std */ ARGV_NONE, /* MDOC_Filled */ ARGV_NONE, /* MDOC_Words */ ARGV_NONE, /* MDOC_Emphasis */ @@ -104,224 +90,295 @@ static int mdoc_argvflags[MDOC_ARG_MAX] = { ARGV_NONE /* MDOC_Symbolic */ }; -static int mdoc_argflags[MDOC_MAX] = { - 0, /* \" */ - 0, /* Dd */ - 0, /* Dt */ - 0, /* Os */ - ARGS_QUOTED, /* Sh */ - ARGS_QUOTED, /* Ss */ - ARGS_DELIM, /* Pp */ - ARGS_DELIM, /* D1 */ - ARGS_DELIM | ARGS_QUOTED, /* Dl */ - 0, /* Bd */ - 0, /* Ed */ - 0, /* Bl */ - 0, /* El */ - 0, /* It */ - ARGS_DELIM, /* Ad */ - ARGS_DELIM, /* An */ - ARGS_DELIM | ARGS_QUOTED, /* Ar */ - ARGS_QUOTED, /* Cd */ - ARGS_DELIM, /* Cm */ - ARGS_DELIM, /* Dv */ - ARGS_DELIM, /* Er */ - ARGS_DELIM, /* Ev */ - 0, /* Ex */ - ARGS_DELIM | ARGS_QUOTED, /* Fa */ - 0, /* Fd */ - ARGS_DELIM, /* Fl */ - ARGS_DELIM | ARGS_QUOTED, /* Fn */ - ARGS_DELIM | ARGS_QUOTED, /* Ft */ - ARGS_DELIM, /* Ic */ - 0, /* In */ - ARGS_DELIM | ARGS_QUOTED, /* Li */ - ARGS_QUOTED, /* Nd */ - ARGS_DELIM, /* Nm */ - ARGS_DELIM, /* Op */ - 0, /* Ot */ - ARGS_DELIM, /* Pa */ - 0, /* Rv */ - ARGS_DELIM | ARGS_ARGVLIKE, /* St */ - ARGS_DELIM, /* Va */ - ARGS_DELIM, /* Vt */ - ARGS_DELIM, /* Xr */ - ARGS_QUOTED, /* %A */ - ARGS_QUOTED, /* %B */ - ARGS_QUOTED, /* %D */ - ARGS_QUOTED, /* %I */ - ARGS_QUOTED, /* %J */ - ARGS_QUOTED, /* %N */ - ARGS_QUOTED, /* %O */ - ARGS_QUOTED, /* %P */ - ARGS_QUOTED, /* %R */ - ARGS_QUOTED, /* %T */ - ARGS_QUOTED, /* %V */ - ARGS_DELIM, /* Ac */ - 0, /* Ao */ - ARGS_DELIM, /* Aq */ - ARGS_DELIM, /* At */ - ARGS_DELIM, /* Bc */ - 0, /* Bf */ - 0, /* Bo */ - ARGS_DELIM, /* Bq */ - ARGS_DELIM, /* Bsx */ - ARGS_DELIM, /* Bx */ - 0, /* Db */ - ARGS_DELIM, /* Dc */ - 0, /* Do */ - ARGS_DELIM, /* Dq */ - ARGS_DELIM, /* Ec */ - 0, /* Ef */ - ARGS_DELIM, /* Em */ - 0, /* Eo */ - ARGS_DELIM, /* Fx */ - ARGS_DELIM, /* Ms */ - ARGS_DELIM, /* No */ - ARGS_DELIM, /* Ns */ - ARGS_DELIM, /* Nx */ - ARGS_DELIM, /* Ox */ - ARGS_DELIM, /* Pc */ - ARGS_DELIM, /* Pf */ - 0, /* Po */ - ARGS_DELIM, /* Pq */ - ARGS_DELIM, /* Qc */ - ARGS_DELIM, /* Ql */ - 0, /* Qo */ - ARGS_DELIM, /* Qq */ - 0, /* Re */ - 0, /* Rs */ - ARGS_DELIM, /* Sc */ - 0, /* So */ - ARGS_DELIM, /* Sq */ - 0, /* Sm */ - ARGS_DELIM, /* Sx */ - ARGS_DELIM | ARGS_QUOTED, /* Sy */ - ARGS_DELIM, /* Tn */ - ARGS_DELIM, /* Ux */ - ARGS_DELIM, /* Xc */ - 0, /* Xo */ - ARGS_QUOTED, /* Fo */ - 0, /* Fc */ - 0, /* Oo */ - ARGS_DELIM, /* Oc */ - 0, /* Bk */ - 0, /* Ek */ - 0, /* Bt */ - 0, /* Hf */ - 0, /* Fr */ - 0, /* Ud */ - 0, /* Lb */ - 0, /* Ap */ - ARGS_DELIM, /* Lp */ - ARGS_DELIM | ARGS_QUOTED, /* Lk */ - ARGS_DELIM | ARGS_QUOTED, /* Mt */ - ARGS_DELIM, /* Brq */ - 0, /* Bro */ - ARGS_DELIM, /* Brc */ - ARGS_QUOTED, /* %C */ - 0, /* Es */ - 0, /* En */ - 0, /* Dx */ - ARGS_QUOTED, /* %Q */ +static const enum mdocargt args_Ex[] = { + MDOC_Std, + MDOC_ARG_MAX }; +static const enum mdocargt args_An[] = { + MDOC_Split, + MDOC_Nosplit, + MDOC_ARG_MAX +}; +static const enum mdocargt args_Bd[] = { + MDOC_Ragged, + MDOC_Unfilled, + MDOC_Filled, + MDOC_Literal, + MDOC_File, + MDOC_Offset, + MDOC_Compact, + MDOC_Centred, + MDOC_ARG_MAX +}; + +static const enum mdocargt args_Bf[] = { + MDOC_Emphasis, + MDOC_Literal, + MDOC_Symbolic, + MDOC_ARG_MAX +}; + +static const enum mdocargt args_Bk[] = { + MDOC_Words, + MDOC_ARG_MAX +}; + +static const enum mdocargt args_Bl[] = { + MDOC_Bullet, + MDOC_Dash, + MDOC_Hyphen, + MDOC_Item, + MDOC_Enum, + MDOC_Tag, + MDOC_Diag, + MDOC_Hang, + MDOC_Ohang, + MDOC_Inset, + MDOC_Column, + MDOC_Width, + MDOC_Offset, + MDOC_Compact, + MDOC_Nested, + MDOC_ARG_MAX +}; + +static const struct mdocarg __mdocargs[MDOC_MAX - MDOC_Dd] = { + { ARGSFL_NONE, NULL }, /* Dd */ + { ARGSFL_NONE, NULL }, /* Dt */ + { ARGSFL_NONE, NULL }, /* Os */ + { ARGSFL_NONE, NULL }, /* Sh */ + { ARGSFL_NONE, NULL }, /* Ss */ + { ARGSFL_NONE, NULL }, /* Pp */ + { ARGSFL_DELIM, NULL }, /* D1 */ + { ARGSFL_DELIM, NULL }, /* Dl */ + { ARGSFL_NONE, args_Bd }, /* Bd */ + { ARGSFL_NONE, NULL }, /* Ed */ + { ARGSFL_NONE, args_Bl }, /* Bl */ + { ARGSFL_NONE, NULL }, /* El */ + { ARGSFL_NONE, NULL }, /* It */ + { ARGSFL_DELIM, NULL }, /* Ad */ + { ARGSFL_DELIM, args_An }, /* An */ + { ARGSFL_DELIM, NULL }, /* Ap */ + { ARGSFL_DELIM, NULL }, /* Ar */ + { ARGSFL_DELIM, NULL }, /* Cd */ + { ARGSFL_DELIM, NULL }, /* Cm */ + { ARGSFL_DELIM, NULL }, /* Dv */ + { ARGSFL_DELIM, NULL }, /* Er */ + { ARGSFL_DELIM, NULL }, /* Ev */ + { ARGSFL_NONE, args_Ex }, /* Ex */ + { ARGSFL_DELIM, NULL }, /* Fa */ + { ARGSFL_NONE, NULL }, /* Fd */ + { ARGSFL_DELIM, NULL }, /* Fl */ + { ARGSFL_DELIM, NULL }, /* Fn */ + { ARGSFL_DELIM, NULL }, /* Ft */ + { ARGSFL_DELIM, NULL }, /* Ic */ + { ARGSFL_DELIM, NULL }, /* In */ + { ARGSFL_DELIM, NULL }, /* Li */ + { ARGSFL_NONE, NULL }, /* Nd */ + { ARGSFL_DELIM, NULL }, /* Nm */ + { ARGSFL_DELIM, NULL }, /* Op */ + { ARGSFL_DELIM, NULL }, /* Ot */ + { ARGSFL_DELIM, NULL }, /* Pa */ + { ARGSFL_NONE, args_Ex }, /* Rv */ + { ARGSFL_DELIM, NULL }, /* St */ + { ARGSFL_DELIM, NULL }, /* Va */ + { ARGSFL_DELIM, NULL }, /* Vt */ + { ARGSFL_DELIM, NULL }, /* Xr */ + { ARGSFL_NONE, NULL }, /* %A */ + { ARGSFL_NONE, NULL }, /* %B */ + { ARGSFL_NONE, NULL }, /* %D */ + { ARGSFL_NONE, NULL }, /* %I */ + { ARGSFL_NONE, NULL }, /* %J */ + { ARGSFL_NONE, NULL }, /* %N */ + { ARGSFL_NONE, NULL }, /* %O */ + { ARGSFL_NONE, NULL }, /* %P */ + { ARGSFL_NONE, NULL }, /* %R */ + { ARGSFL_NONE, NULL }, /* %T */ + { ARGSFL_NONE, NULL }, /* %V */ + { ARGSFL_DELIM, NULL }, /* Ac */ + { ARGSFL_NONE, NULL }, /* Ao */ + { ARGSFL_DELIM, NULL }, /* Aq */ + { ARGSFL_DELIM, NULL }, /* At */ + { ARGSFL_DELIM, NULL }, /* Bc */ + { ARGSFL_NONE, args_Bf }, /* Bf */ + { ARGSFL_NONE, NULL }, /* Bo */ + { ARGSFL_DELIM, NULL }, /* Bq */ + { ARGSFL_DELIM, NULL }, /* Bsx */ + { ARGSFL_DELIM, NULL }, /* Bx */ + { ARGSFL_NONE, NULL }, /* Db */ + { ARGSFL_DELIM, NULL }, /* Dc */ + { ARGSFL_NONE, NULL }, /* Do */ + { ARGSFL_DELIM, NULL }, /* Dq */ + { ARGSFL_DELIM, NULL }, /* Ec */ + { ARGSFL_NONE, NULL }, /* Ef */ + { ARGSFL_DELIM, NULL }, /* Em */ + { ARGSFL_NONE, NULL }, /* Eo */ + { ARGSFL_DELIM, NULL }, /* Fx */ + { ARGSFL_DELIM, NULL }, /* Ms */ + { ARGSFL_DELIM, NULL }, /* No */ + { ARGSFL_DELIM, NULL }, /* Ns */ + { ARGSFL_DELIM, NULL }, /* Nx */ + { ARGSFL_DELIM, NULL }, /* Ox */ + { ARGSFL_DELIM, NULL }, /* Pc */ + { ARGSFL_DELIM, NULL }, /* Pf */ + { ARGSFL_NONE, NULL }, /* Po */ + { ARGSFL_DELIM, NULL }, /* Pq */ + { ARGSFL_DELIM, NULL }, /* Qc */ + { ARGSFL_DELIM, NULL }, /* Ql */ + { ARGSFL_NONE, NULL }, /* Qo */ + { ARGSFL_DELIM, NULL }, /* Qq */ + { ARGSFL_NONE, NULL }, /* Re */ + { ARGSFL_NONE, NULL }, /* Rs */ + { ARGSFL_DELIM, NULL }, /* Sc */ + { ARGSFL_NONE, NULL }, /* So */ + { ARGSFL_DELIM, NULL }, /* Sq */ + { ARGSFL_NONE, NULL }, /* Sm */ + { ARGSFL_DELIM, NULL }, /* Sx */ + { ARGSFL_DELIM, NULL }, /* Sy */ + { ARGSFL_DELIM, NULL }, /* Tn */ + { ARGSFL_DELIM, NULL }, /* Ux */ + { ARGSFL_DELIM, NULL }, /* Xc */ + { ARGSFL_NONE, NULL }, /* Xo */ + { ARGSFL_NONE, NULL }, /* Fo */ + { ARGSFL_DELIM, NULL }, /* Fc */ + { ARGSFL_NONE, NULL }, /* Oo */ + { ARGSFL_DELIM, NULL }, /* Oc */ + { ARGSFL_NONE, args_Bk }, /* Bk */ + { ARGSFL_NONE, NULL }, /* Ek */ + { ARGSFL_NONE, NULL }, /* Bt */ + { ARGSFL_NONE, NULL }, /* Hf */ + { ARGSFL_DELIM, NULL }, /* Fr */ + { ARGSFL_NONE, NULL }, /* Ud */ + { ARGSFL_DELIM, NULL }, /* Lb */ + { ARGSFL_NONE, NULL }, /* Lp */ + { ARGSFL_DELIM, NULL }, /* Lk */ + { ARGSFL_DELIM, NULL }, /* Mt */ + { ARGSFL_DELIM, NULL }, /* Brq */ + { ARGSFL_NONE, NULL }, /* Bro */ + { ARGSFL_DELIM, NULL }, /* Brc */ + { ARGSFL_NONE, NULL }, /* %C */ + { ARGSFL_NONE, NULL }, /* Es */ + { ARGSFL_DELIM, NULL }, /* En */ + { ARGSFL_DELIM, NULL }, /* Dx */ + { ARGSFL_NONE, NULL }, /* %Q */ + { ARGSFL_NONE, NULL }, /* br */ + { ARGSFL_NONE, NULL }, /* sp */ + { ARGSFL_NONE, NULL }, /* %U */ + { ARGSFL_NONE, NULL }, /* Ta */ + { ARGSFL_NONE, NULL }, /* ll */ +}; +static const struct mdocarg *const mdocargs = __mdocargs - MDOC_Dd; + + /* - * Parse an argument from line text. This comes in the form of -key - * [value0...], which may either have a single mandatory value, at least - * one mandatory value, an optional single value, or no value. + * Parse flags and their arguments from the input line. + * These come in the form -flag [argument ...]. + * Some flags take no argument, some one, some multiple. */ -int -mdoc_argv(struct mdoc *mdoc, int line, int tok, - struct mdoc_arg **v, int *pos, char *buf) +void +mdoc_argv(struct roff_man *mdoc, int line, enum roff_tok tok, + struct mdoc_arg **reta, int *pos, char *buf) { - int i; - char *p, sv; - struct mdoc_argv tmp; - struct mdoc_arg *arg; + struct mdoc_argv tmpv; + struct mdoc_argv **retv; + const enum mdocargt *argtable; + char *argname; + int ipos, retc; + char savechar; - if (0 == buf[*pos]) - return(ARGV_EOLN); + *reta = NULL; - assert(' ' != buf[*pos]); + /* Which flags does this macro support? */ - if ('-' != buf[*pos] || ARGS_ARGVLIKE & mdoc_argflags[tok]) - return(ARGV_WORD); + assert(tok >= MDOC_Dd && tok < MDOC_MAX); + argtable = mdocargs[tok].argvs; + if (argtable == NULL) + return; - /* Parse through to the first unescaped space. */ + /* Loop over the flags on the input line. */ - i = *pos; - p = &buf[++(*pos)]; + ipos = *pos; + while (buf[ipos] == '-') { - assert(*pos > 0); + /* Seek to the first unescaped space. */ - /* LINTED */ - while (buf[*pos]) { - if (' ' == buf[*pos]) - if ('\\' != buf[*pos - 1]) + for (argname = buf + ++ipos; buf[ipos] != '\0'; ipos++) + if (buf[ipos] == ' ' && buf[ipos - 1] != '\\') break; - (*pos)++; - } - /* XXX - save zeroed byte, if not an argument. */ + /* + * We want to nil-terminate the word to look it up. + * But we may not have a flag, in which case we need + * to restore the line as-is. So keep around the + * stray byte, which we'll reset upon exiting. + */ - sv = 0; - if (buf[*pos]) { - sv = buf[*pos]; - buf[(*pos)++] = 0; - } + if ((savechar = buf[ipos]) != '\0') + buf[ipos++] = '\0'; - (void)memset(&tmp, 0, sizeof(struct mdoc_argv)); - tmp.line = line; - tmp.pos = *pos; + /* + * Now look up the word as a flag. Use temporary + * storage that we'll copy into the node's flags. + */ - /* See if our token accepts the argument. */ + while ((tmpv.arg = *argtable++) != MDOC_ARG_MAX) + if ( ! strcmp(argname, mdoc_argnames[tmpv.arg])) + break; - if (MDOC_ARG_MAX == (tmp.arg = argv_a2arg(tok, p))) { - /* XXX - restore saved zeroed byte. */ - if (sv) - buf[*pos - 1] = sv; - if ( ! pwarn(mdoc, line, i, WARGVPARM)) - return(ARGV_ERROR); - return(ARGV_WORD); - } + /* If it isn't a flag, restore the saved byte. */ - while (buf[*pos] && ' ' == buf[*pos]) - (*pos)++; + if (tmpv.arg == MDOC_ARG_MAX) { + if (savechar != '\0') + buf[ipos - 1] = savechar; + break; + } - if ( ! argv(mdoc, line, &tmp, pos, buf)) - return(ARGV_ERROR); + /* Read to the next word (the first argument). */ - if (NULL == (arg = *v)) { - *v = calloc(1, sizeof(struct mdoc_arg)); - if (NULL == *v) { - (void)verr(mdoc, EMALLOC); - return(ARGV_ERROR); + while (buf[ipos] == ' ') + ipos++; + + /* Parse the arguments of the flag. */ + + tmpv.line = line; + tmpv.pos = *pos; + tmpv.sz = 0; + tmpv.value = NULL; + + switch (argvflags[tmpv.arg]) { + case ARGV_SINGLE: + argv_single(mdoc, line, &tmpv, &ipos, buf); + break; + case ARGV_MULTI: + argv_multi(mdoc, line, &tmpv, &ipos, buf); + break; + case ARGV_NONE: + break; } - arg = *v; - } - arg->argc++; - arg->argv = realloc(arg->argv, arg->argc * - sizeof(struct mdoc_argv)); + /* Append to the return values. */ - if (NULL == arg->argv) { - (void)verr(mdoc, EMALLOC); - return(ARGV_ERROR); - } + if (*reta == NULL) + *reta = mandoc_calloc(1, sizeof(**reta)); - (void)memcpy(&arg->argv[(int)arg->argc - 1], - &tmp, sizeof(struct mdoc_argv)); + retc = ++(*reta)->argc; + retv = &(*reta)->argv; + *retv = mandoc_reallocarray(*retv, retc, sizeof(**retv)); + memcpy(*retv + retc - 1, &tmpv, sizeof(**retv)); - return(ARGV_ARG); + /* Prepare for parsing the next flag. */ + + *pos = ipos; + argtable = mdocargs[tok].argvs; + } } - void mdoc_argv_free(struct mdoc_arg *p) { - int i, j; + int i; if (NULL == p) return; @@ -333,538 +390,292 @@ mdoc_argv_free(struct mdoc_arg *p) } assert(p->argc); - /* LINTED */ - for (i = 0; i < (int)p->argc; i++) { - if (0 == p->argv[i].sz) - continue; - /* LINTED */ - for (j = 0; j < (int)p->argv[i].sz; j++) - free(p->argv[i].value[j]); + for (i = (int)p->argc - 1; i >= 0; i--) + argn_free(p, i); - free(p->argv[i].value); - } - free(p->argv); free(p); } - - -static int -perr(struct mdoc *mdoc, int line, int pos, enum merr code) +static void +argn_free(struct mdoc_arg *p, int iarg) { - char *p; + struct mdoc_argv *arg; + int j; - p = NULL; - switch (code) { - case (EMALLOC): - p = "memory exhausted"; - break; - case (EQUOTTERM): - p = "unterminated quoted parameter"; - break; - case (EARGVAL): - p = "argument requires a value"; - break; - } - assert(p); - return(mdoc_perr(mdoc, line, pos, p)); -} + arg = &p->argv[iarg]; - -static int -pwarn(struct mdoc *mdoc, int line, int pos, enum mwarn code) -{ - char *p; - int c; - - p = NULL; - c = WARN_SYNTAX; - switch (code) { - case (WQUOTPARM): - p = "unexpected quoted parameter"; - break; - case (WARGVPARM): - p = "argument-like parameter"; - break; - case (WCOLEMPTY): - p = "last list column is empty"; - c = WARN_COMPAT; - break; - case (WTAILWS): - p = "trailing whitespace"; - c = WARN_COMPAT; - break; + if (arg->sz && arg->value) { + for (j = (int)arg->sz - 1; j >= 0; j--) + free(arg->value[j]); + free(arg->value); } - assert(p); - return(mdoc_pwarn(mdoc, line, pos, c, p)); + + for (--p->argc; iarg < (int)p->argc; iarg++) + p->argv[iarg] = p->argv[iarg+1]; } - -int -mdoc_args(struct mdoc *mdoc, int line, - int *pos, char *buf, int tok, char **v) +enum margserr +mdoc_args(struct roff_man *mdoc, int line, int *pos, + char *buf, enum roff_tok tok, char **v) { - int fl, c, i; - struct mdoc_node *n; + struct roff_node *n; + char *v_local; + enum argsflag fl; - fl = (0 == tok) ? 0 : mdoc_argflags[tok]; + if (v == NULL) + v = &v_local; + fl = tok == TOKEN_NONE ? ARGSFL_NONE : mdocargs[tok].flags; - /* - * Override per-macro argument flags with context-specific ones. - * As of now, this is only valid for `It' depending on its list - * context. + /* + * We know that we're in an `It', so it's reasonable to expect + * us to be sitting in a `Bl'. Someday this may not be the case + * (if we allow random `It's sitting out there), so provide a + * safe fall-back into the default behaviour. */ - switch (tok) { - case (MDOC_It): - for (n = mdoc->last; n; n = n->parent) - if (MDOC_BLOCK == n->type && MDOC_Bl == n->tok) - break; - - assert(n); - c = (int)(n->args ? n->args->argc : 0); - assert(c > 0); - - /* - * Using `Bl -column' adds ARGS_TABSEP to the arguments - * and invalidates ARGS_DELIM. Using `Bl -diag' allows - * for quoted arguments. - */ - - /* LINTED */ - for (i = 0; i < c; i++) { - switch (n->args->argv[i].arg) { - case (MDOC_Column): - fl |= ARGS_TABSEP; - fl &= ~ARGS_DELIM; - i = c; - break; - case (MDOC_Diag): - fl |= ARGS_QUOTED; - i = c; - break; - default: - break; - } + if (tok == MDOC_It) { + for (n = mdoc->last; n != NULL; n = n->parent) { + if (n->tok != MDOC_Bl) + continue; + if (n->norm->Bl.type == LIST_column) + fl = ARGSFL_TABSEP; + break; } - break; - default: - break; } - return(args(mdoc, line, pos, buf, fl, v)); + return args(mdoc, line, pos, buf, fl, v); } - -static int -args(struct mdoc *mdoc, int line, - int *pos, char *buf, int fl, char **v) +static enum margserr +args(struct roff_man *mdoc, int line, int *pos, + char *buf, enum argsflag fl, char **v) { - int i; - char *p, *pp; + char *p; + int pairs; - assert(*pos > 0); - - if (0 == buf[*pos]) - return(ARGS_EOLN); - - if ('\"' == buf[*pos] && ! (fl & ARGS_QUOTED)) - if ( ! pwarn(mdoc, line, *pos, WQUOTPARM)) - return(ARGS_ERROR); - - if ( ! (fl & ARGS_ARGVLIKE) && '-' == buf[*pos]) - if ( ! pwarn(mdoc, line, *pos, WARGVPARM)) - return(ARGS_ERROR); - - /* - * If the first character is a delimiter and we're to look for - * delimited strings, then pass down the buffer seeing if it - * follows the pattern of [[::delim::][ ]+]+. - */ - - if ((fl & ARGS_DELIM) && mdoc_iscdelim(buf[*pos])) { - for (i = *pos; buf[i]; ) { - if ( ! mdoc_iscdelim(buf[i])) - break; - i++; - /* There must be at least one space... */ - if (0 == buf[i] || ' ' != buf[i]) - break; - i++; - while (buf[i] && ' ' == buf[i]) - i++; + if (buf[*pos] == '\0') { + if (mdoc->flags & MDOC_PHRASELIT && + ! (mdoc->flags & MDOC_PHRASE)) { + mandoc_msg(MANDOCERR_ARG_QUOTE, + mdoc->parse, line, *pos, NULL); + mdoc->flags &= ~MDOC_PHRASELIT; } - if (0 == buf[i]) { - *v = &buf[*pos]; - return(ARGS_PUNCT); - } + return ARGS_EOLN; } - /* First parse non-quoted strings. */ + *v = buf + *pos; - if ('\"' != buf[*pos] || ! (ARGS_QUOTED & fl)) { - *v = &buf[*pos]; + if (fl == ARGSFL_DELIM && args_checkpunct(buf, *pos)) + return ARGS_PUNCT; - /* - * Thar be dragons here! If we're tab-separated, search - * ahead for either a tab or the `Ta' macro. - * If a `Ta' is detected, it must be space-buffered before and - * after. If either of these hold true, then prune out the - * extra spaces and call it an argument. - */ + /* + * Tabs in `It' lines in `Bl -column' can't be escaped. + * Phrases are reparsed for `Ta' and other macros later. + */ - if (ARGS_TABSEP & fl) { - /* Scan ahead to unescaped tab. */ + if (fl == ARGSFL_TABSEP) { + if ((p = strchr(*v, '\t')) != NULL) { - p = strchr(*v, '\t'); + /* + * Words right before and right after + * tab characters are not parsed, + * unless there is a blank in between. + */ - /* Scan ahead to unescaped `Ta'. */ + if (p > buf && p[-1] != ' ') + mdoc->flags |= MDOC_PHRASEQL; + if (p[1] != ' ') + mdoc->flags |= MDOC_PHRASEQN; - for (pp = *v; ; pp++) { - if (NULL == (pp = strstr(pp, "Ta"))) - break; - if (pp > *v && ' ' != *(pp - 1)) - continue; - if (' ' == *(pp + 2) || 0 == *(pp + 2)) - break; - } + /* + * One or more blanks after a tab cause + * one leading blank in the next column. + * So skip all but one of them. + */ - /* Choose delimiter tab/Ta. */ + *pos += (int)(p - *v) + 1; + while (buf[*pos] == ' ' && buf[*pos + 1] == ' ') + (*pos)++; - if (p && pp) - p = (p < pp ? p : pp); - else if ( ! p && pp) - p = pp; + /* + * A tab at the end of an input line + * switches to the next column. + */ - /* Strip delimiter's preceding whitespace. */ - - if (p && p > *v) { - pp = p - 1; - while (pp > *v && ' ' == *pp) - pp--; - if (pp == *v && ' ' == *pp) - *pp = 0; - else if (' ' == *pp) - *(pp + 1) = 0; - } - - /* ...in- and proceding whitespace. */ - - if (p && ('\t' != *p)) { - *p++ = 0; - *p++ = 0; - } else if (p) - *p++ = 0; - - if (p) { - while (' ' == *p) - p++; - if (0 != *p) - *(p - 1) = 0; - *pos += (int)(p - *v); - } - - if (p && 0 == *p) - if ( ! pwarn(mdoc, line, *pos, WCOLEMPTY)) - return(0); - if (p && 0 == *p && p > *v && ' ' == *(p - 1)) - if ( ! pwarn(mdoc, line, *pos, WTAILWS)) - return(0); - - if (p) - return(ARGS_PHRASE); - - /* Configure the eoln case, too. */ - - p = strchr(*v, 0); - assert(p); - - if (p > *v && ' ' == *(p - 1)) - if ( ! pwarn(mdoc, line, *pos, WTAILWS)) - return(0); + if (buf[*pos] == '\0' || buf[*pos + 1] == '\0') + mdoc->flags |= MDOC_PHRASEQN; + } else { + p = strchr(*v, '\0'); + if (p[-1] == ' ') + mandoc_msg(MANDOCERR_SPACE_EOL, + mdoc->parse, line, *pos, NULL); *pos += (int)(p - *v); + } - return(ARGS_PHRASE); - } - - /* Do non-tabsep look-ahead here. */ - - if ( ! (ARGS_TABSEP & fl)) - while (buf[*pos]) { - if (' ' == buf[*pos]) - if ('\\' != buf[*pos - 1]) - break; - (*pos)++; - } + /* Skip any trailing blank characters. */ + while (p > *v && p[-1] == ' ' && + (p - 1 == *v || p[-2] != '\\')) + p--; + *p = '\0'; - if (0 == buf[*pos]) - return(ARGS_WORD); - - buf[(*pos)++] = 0; - - if (0 == buf[*pos]) - return(ARGS_WORD); - - if ( ! (ARGS_TABSEP & fl)) - while (buf[*pos] && ' ' == buf[*pos]) - (*pos)++; - - if (buf[*pos]) - return(ARGS_WORD); - - if ( ! pwarn(mdoc, line, *pos, WTAILWS)) - return(ARGS_ERROR); - - return(ARGS_WORD); + return ARGS_PHRASE; } /* - * If we're a quoted string (and quoted strings are allowed), - * then parse ahead to the next quote. If none's found, it's an - * error. After, parse to the next word. + * Process a quoted literal. A quote begins with a double-quote + * and ends with a double-quote NOT preceded by a double-quote. + * NUL-terminate the literal in place. + * Collapse pairs of quotes inside quoted literals. + * Whitespace is NOT involved in literal termination. */ - *v = &buf[++(*pos)]; + if (mdoc->flags & MDOC_PHRASELIT || buf[*pos] == '\"') { + if ( ! (mdoc->flags & MDOC_PHRASELIT)) + *v = &buf[++(*pos)]; - while (buf[*pos] && '\"' != buf[*pos]) - (*pos)++; + if (mdoc->flags & MDOC_PHRASE) + mdoc->flags |= MDOC_PHRASELIT; - if (0 == buf[*pos]) { - (void)perr(mdoc, line, *pos, EQUOTTERM); - return(ARGS_ERROR); - } + pairs = 0; + for ( ; buf[*pos]; (*pos)++) { + /* Move following text left after quoted quotes. */ + if (pairs) + buf[*pos - pairs] = buf[*pos]; + if ('\"' != buf[*pos]) + continue; + /* Unquoted quotes end quoted args. */ + if ('\"' != buf[*pos + 1]) + break; + /* Quoted quotes collapse. */ + pairs++; + (*pos)++; + } + if (pairs) + buf[*pos - pairs] = '\0'; - buf[(*pos)++] = 0; - if (0 == buf[*pos]) - return(ARGS_QWORD); + if (buf[*pos] == '\0') { + if ( ! (mdoc->flags & MDOC_PHRASE)) + mandoc_msg(MANDOCERR_ARG_QUOTE, + mdoc->parse, line, *pos, NULL); + return ARGS_QWORD; + } - while (buf[*pos] && ' ' == buf[*pos]) - (*pos)++; + mdoc->flags &= ~MDOC_PHRASELIT; + buf[(*pos)++] = '\0'; - if (buf[*pos]) - return(ARGS_QWORD); + if ('\0' == buf[*pos]) + return ARGS_QWORD; - if ( ! pwarn(mdoc, line, *pos, WTAILWS)) - return(ARGS_ERROR); + while (' ' == buf[*pos]) + (*pos)++; - return(ARGS_QWORD); -} + if ('\0' == buf[*pos]) + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + line, *pos, NULL); + return ARGS_QWORD; + } -static int -argv_a2arg(int tok, const char *argv) -{ + p = &buf[*pos]; + *v = mandoc_getarg(mdoc->parse, &p, line, pos); /* - * Parse an argument identifier from its text. XXX - this - * should really be table-driven to clarify the code. - * - * If you add an argument to the list, make sure that you - * register it here with its one or more macros! + * After parsing the last word in this phrase, + * tell lookup() whether or not to interpret it. */ - switch (tok) { - case (MDOC_An): - if (0 == strcmp(argv, "split")) - return(MDOC_Split); - else if (0 == strcmp(argv, "nosplit")) - return(MDOC_Nosplit); - break; - - case (MDOC_Bd): - if (0 == strcmp(argv, "ragged")) - return(MDOC_Ragged); - else if (0 == strcmp(argv, "unfilled")) - return(MDOC_Unfilled); - else if (0 == strcmp(argv, "filled")) - return(MDOC_Filled); - else if (0 == strcmp(argv, "literal")) - return(MDOC_Literal); - else if (0 == strcmp(argv, "file")) - return(MDOC_File); - else if (0 == strcmp(argv, "offset")) - return(MDOC_Offset); - else if (0 == strcmp(argv, "compact")) - return(MDOC_Compact); - break; - - case (MDOC_Bf): - if (0 == strcmp(argv, "emphasis")) - return(MDOC_Emphasis); - else if (0 == strcmp(argv, "literal")) - return(MDOC_Literal); - else if (0 == strcmp(argv, "symbolic")) - return(MDOC_Symbolic); - break; - - case (MDOC_Bk): - if (0 == strcmp(argv, "words")) - return(MDOC_Words); - break; - - case (MDOC_Bl): - if (0 == strcmp(argv, "bullet")) - return(MDOC_Bullet); - else if (0 == strcmp(argv, "dash")) - return(MDOC_Dash); - else if (0 == strcmp(argv, "hyphen")) - return(MDOC_Hyphen); - else if (0 == strcmp(argv, "item")) - return(MDOC_Item); - else if (0 == strcmp(argv, "enum")) - return(MDOC_Enum); - else if (0 == strcmp(argv, "tag")) - return(MDOC_Tag); - else if (0 == strcmp(argv, "diag")) - return(MDOC_Diag); - else if (0 == strcmp(argv, "hang")) - return(MDOC_Hang); - else if (0 == strcmp(argv, "ohang")) - return(MDOC_Ohang); - else if (0 == strcmp(argv, "inset")) - return(MDOC_Inset); - else if (0 == strcmp(argv, "column")) - return(MDOC_Column); - else if (0 == strcmp(argv, "width")) - return(MDOC_Width); - else if (0 == strcmp(argv, "offset")) - return(MDOC_Offset); - else if (0 == strcmp(argv, "compact")) - return(MDOC_Compact); - else if (0 == strcmp(argv, "nested")) - return(MDOC_Nested); - break; - - case (MDOC_Rv): - /* FALLTHROUGH */ - case (MDOC_Ex): - if (0 == strcmp(argv, "std")) - return(MDOC_Std); - break; - default: - break; + if (*p == '\0' && mdoc->flags & MDOC_PHRASEQL) { + mdoc->flags &= ~MDOC_PHRASEQL; + mdoc->flags |= MDOC_PHRASEQF; } - - return(MDOC_ARG_MAX); + return ARGS_WORD; } - +/* + * Check if the string consists only of space-separated closing + * delimiters. This is a bit of a dance: the first must be a close + * delimiter, but it may be followed by middle delimiters. Arbitrary + * whitespace may separate these tokens. + */ static int -argv_multi(struct mdoc *mdoc, int line, - struct mdoc_argv *v, int *pos, char *buf) +args_checkpunct(const char *buf, int i) { - int c, ppos; - char *p; + int j; + char dbuf[DELIMSZ]; + enum mdelim d; - ppos = *pos; + /* First token must be a close-delimiter. */ - for (v->sz = 0; ; v->sz++) { - if ('-' == buf[*pos]) - break; - c = args(mdoc, line, pos, buf, ARGS_QUOTED, &p); - if (ARGS_ERROR == c) - return(0); - else if (ARGS_EOLN == c) - break; + for (j = 0; buf[i] && ' ' != buf[i] && j < DELIMSZ; j++, i++) + dbuf[j] = buf[i]; - if (0 == v->sz % MULTI_STEP) { - v->value = realloc(v->value, - (v->sz + MULTI_STEP) * sizeof(char *)); - if (NULL == v->value) { - (void)verr(mdoc, EMALLOC); - return(ARGV_ERROR); - } - } - if (NULL == (v->value[(int)v->sz] = strdup(p))) - return(verr(mdoc, EMALLOC)); - } + if (DELIMSZ == j) + return 0; - if (v->sz) - return(1); + dbuf[j] = '\0'; + if (DELIM_CLOSE != mdoc_isdelim(dbuf)) + return 0; - return(perr(mdoc, line, ppos, EARGVAL)); -} + while (' ' == buf[i]) + i++; + /* Remaining must NOT be open/none. */ -static int -argv_opt_single(struct mdoc *mdoc, int line, - struct mdoc_argv *v, int *pos, char *buf) -{ - int c; - char *p; + while (buf[i]) { + j = 0; + while (buf[i] && ' ' != buf[i] && j < DELIMSZ) + dbuf[j++] = buf[i++]; - if ('-' == buf[*pos]) - return(1); + if (DELIMSZ == j) + return 0; - c = args(mdoc, line, pos, buf, ARGS_QUOTED, &p); - if (ARGS_ERROR == c) - return(0); - if (ARGS_EOLN == c) - return(1); + dbuf[j] = '\0'; + d = mdoc_isdelim(dbuf); + if (DELIM_NONE == d || DELIM_OPEN == d) + return 0; - v->sz = 1; - if (NULL == (v->value = calloc(1, sizeof(char *)))) - return(verr(mdoc, EMALLOC)); - if (NULL == (v->value[0] = strdup(p))) - return(verr(mdoc, EMALLOC)); + while (' ' == buf[i]) + i++; + } - return(1); + return '\0' == buf[i]; } - -/* - * Parse a single, mandatory value from the stream. - */ -static int -argv_single(struct mdoc *mdoc, int line, +static void +argv_multi(struct roff_man *mdoc, int line, struct mdoc_argv *v, int *pos, char *buf) { - int c, ppos; + enum margserr ac; char *p; - ppos = *pos; + for (v->sz = 0; ; v->sz++) { + if (buf[*pos] == '-') + break; + ac = args(mdoc, line, pos, buf, ARGSFL_NONE, &p); + if (ac == ARGS_EOLN) + break; - c = args(mdoc, line, pos, buf, ARGS_QUOTED, &p); - if (ARGS_ERROR == c) - return(0); - if (ARGS_EOLN == c) - return(perr(mdoc, line, ppos, EARGVAL)); + if (v->sz % MULTI_STEP == 0) + v->value = mandoc_reallocarray(v->value, + v->sz + MULTI_STEP, sizeof(char *)); - v->sz = 1; - if (NULL == (v->value = calloc(1, sizeof(char *)))) - return(verr(mdoc, EMALLOC)); - if (NULL == (v->value[0] = strdup(p))) - return(verr(mdoc, EMALLOC)); - - return(1); + v->value[(int)v->sz] = mandoc_strdup(p); + } } - -/* - * Determine rules for parsing arguments. Arguments can either accept - * no parameters, an optional single parameter, one parameter, or - * multiple parameters. - */ -static int -argv(struct mdoc *mdoc, int line, +static void +argv_single(struct roff_man *mdoc, int line, struct mdoc_argv *v, int *pos, char *buf) { + enum margserr ac; + char *p; - v->sz = 0; - v->value = NULL; + ac = args(mdoc, line, pos, buf, ARGSFL_NONE, &p); + if (ac == ARGS_EOLN) + return; - switch (mdoc_argvflags[v->arg]) { - case (ARGV_SINGLE): - return(argv_single(mdoc, line, v, pos, buf)); - case (ARGV_MULTI): - return(argv_multi(mdoc, line, v, pos, buf)); - case (ARGV_OPT_SINGLE): - return(argv_opt_single(mdoc, line, v, pos, buf)); - default: - /* ARGV_NONE */ - break; - } - - return(1); + v->sz = 1; + v->value = mandoc_malloc(sizeof(char *)); + v->value[0] = mandoc_strdup(p); }