=================================================================== RCS file: /cvs/mandoc/mdoc_argv.c,v retrieving revision 1.51 retrieving revision 1.75 diff -u -p -r1.51 -r1.75 --- mandoc/mdoc_argv.c 2010/05/31 10:28:04 1.51 +++ mandoc/mdoc_argv.c 2011/04/17 09:13:01 1.75 @@ -1,6 +1,6 @@ -/* $Id: mdoc_argv.c,v 1.51 2010/05/31 10:28:04 kristaps Exp $ */ +/* $Id: mdoc_argv.c,v 1.75 2011/04/17 09:13:01 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010 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 @@ -26,28 +26,18 @@ #include #include +#include "mdoc.h" #include "mandoc.h" #include "libmdoc.h" #include "libmandoc.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 ARGV_NONE (1 << 0) -#define ARGV_SINGLE (1 << 1) -#define ARGV_MULTI (1 << 2) -#define ARGV_OPT_SINGLE (1 << 3) - -#define MULTI_STEP 5 - -static int argv_a2arg(enum mdoct, const char *); +static enum mdocargt argv_a2arg(enum mdoct, const char *); static enum margserr args(struct mdoc *, int, int *, char *, int, char **); +static int args_checkpunct(struct mdoc *, + const char *, int, int, int); static int argv(struct mdoc *, int, struct mdoc_argv *, int *, char *); static int argv_single(struct mdoc *, int, @@ -56,10 +46,16 @@ 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 void argn_free(struct mdoc_arg *, int); -/* Per-argument flags. */ +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) */ + ARGV_OPT_SINGLE /* optional arg (e.g., -offset [xxx]) */ +}; -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 */ @@ -88,14 +84,14 @@ static int mdoc_argvflags[MDOC_ARG_MAX] = { ARGV_NONE /* MDOC_Symbolic */ }; -static int mdoc_argflags[MDOC_MAX] = { +static const int argflags[MDOC_MAX] = { 0, /* Ap */ 0, /* Dd */ 0, /* Dt */ 0, /* Os */ 0, /* Sh */ 0, /* Ss */ - ARGS_DELIM, /* Pp */ + 0, /* Pp */ ARGS_DELIM, /* D1 */ ARGS_DELIM, /* Dl */ 0, /* Bd */ @@ -196,7 +192,7 @@ static int mdoc_argflags[MDOC_MAX] = { 0, /* Fr */ 0, /* Ud */ 0, /* Lb */ - ARGS_DELIM, /* Lp */ + 0, /* Lp */ ARGS_DELIM, /* Lk */ ARGS_DELIM, /* Mt */ ARGS_DELIM, /* Brq */ @@ -213,7 +209,60 @@ static int mdoc_argflags[MDOC_MAX] = { 0, /* Ta */ }; +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 +}; + /* * Parse an argument from line text. This comes in the form of -key * [value0...], which may either have a single mandatory value, at least @@ -227,7 +276,7 @@ mdoc_argv(struct mdoc *m, int line, enum mdoct tok, struct mdoc_argv tmp; struct mdoc_arg *arg; - if (0 == buf[*pos]) + if ('\0' == buf[*pos]) return(ARGV_EOLN); assert(' ' != buf[*pos]); @@ -248,13 +297,13 @@ mdoc_argv(struct mdoc *m, int line, enum mdoct tok, /* XXX - save zeroed byte, if not an argument. */ - sv = 0; + sv = '\0'; if (buf[*pos]) { sv = buf[*pos]; - buf[(*pos)++] = 0; + buf[(*pos)++] = '\0'; } - (void)memset(&tmp, 0, sizeof(struct mdoc_argv)); + memset(&tmp, 0, sizeof(struct mdoc_argv)); tmp.line = line; tmp.pos = *pos; @@ -280,13 +329,12 @@ mdoc_argv(struct mdoc *m, int line, enum mdoct tok, arg->argv = mandoc_realloc (arg->argv, arg->argc * sizeof(struct mdoc_argv)); - (void)memcpy(&arg->argv[(int)arg->argc - 1], + memcpy(&arg->argv[(int)arg->argc - 1], &tmp, sizeof(struct mdoc_argv)); return(ARGV_ARG); } - void mdoc_argv_free(struct mdoc_arg *p) { @@ -303,19 +351,20 @@ mdoc_argv_free(struct mdoc_arg *p) assert(p->argc); for (i = (int)p->argc - 1; i >= 0; i--) - mdoc_argn_free(p, i); + argn_free(p, i); free(p->argv); free(p); } - -void -mdoc_argn_free(struct mdoc_arg *p, int iarg) +static void +argn_free(struct mdoc_arg *p, int iarg) { - struct mdoc_argv *arg = &p->argv[iarg]; + struct mdoc_argv *arg; int j; + arg = &p->argv[iarg]; + if (arg->sz && arg->value) { for (j = (int)arg->sz - 1; j >= 0; j--) free(arg->value[j]); @@ -326,7 +375,6 @@ mdoc_argn_free(struct mdoc_arg *p, int iarg) p->argv[iarg] = p->argv[iarg+1]; } - enum margserr mdoc_zargs(struct mdoc *m, int line, int *pos, char *buf, int flags, char **v) @@ -335,7 +383,6 @@ mdoc_zargs(struct mdoc *m, int line, int *pos, return(args(m, line, pos, buf, flags, v)); } - enum margserr mdoc_args(struct mdoc *m, int line, int *pos, char *buf, enum mdoct tok, char **v) @@ -343,7 +390,7 @@ mdoc_args(struct mdoc *m, int line, int *pos, int fl; struct mdoc_node *n; - fl = mdoc_argflags[tok]; + fl = argflags[tok]; if (MDOC_It != tok) return(args(m, line, pos, buf, fl, v)); @@ -359,7 +406,7 @@ mdoc_args(struct mdoc *m, int line, int *pos, if (MDOC_Bl == n->tok) break; - if (n && LIST_column == n->data.list) { + if (n && LIST_column == n->norm->Bl.type) { fl |= ARGS_TABSEP; fl &= ~ARGS_DELIM; } @@ -367,14 +414,12 @@ mdoc_args(struct mdoc *m, int line, int *pos, return(args(m, line, pos, buf, fl, v)); } - static enum margserr args(struct mdoc *m, int line, int *pos, char *buf, int fl, char **v) { - int i; - char *p, *pp; - enum margserr rc; + char *p, *pp; + enum margserr rc; /* * Parse out the terms (like `val' in `.Xx -arg val' or simply @@ -391,7 +436,6 @@ args(struct mdoc *m, int line, int *pos, * phrases like in `Bl -column'. */ - assert(*pos); assert(' ' != buf[*pos]); if ('\0' == buf[*pos]) { @@ -403,47 +447,17 @@ args(struct mdoc *m, int line, int *pos, * is unterminated. */ if (MDOC_PHRASELIT & m->flags) - if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE)) - return(ARGS_ERROR); + mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE); m->flags &= ~MDOC_PHRASELIT; return(ARGS_EOLN); } - /* - * If the first character is a closing delimiter and we're to - * look for delimited strings, then pass down the buffer seeing - * if it follows the pattern of [[::delim::][ ]+]+. Note that - * we ONLY care about closing delimiters. - */ - - if ((fl & ARGS_DELIM) && DELIM_CLOSE == mdoc_iscdelim(buf[*pos])) { - for (i = *pos; buf[i]; ) { - enum mdelim d = mdoc_iscdelim(buf[i]); - if (DELIM_NONE == d || DELIM_OPEN == d) - break; - i++; - if ('\0' == buf[i] || ' ' != buf[i]) - break; - i++; - while (buf[i] && ' ' == buf[i]) - i++; - } - - if ('\0' == buf[i]) { - *v = &buf[*pos]; - if (' ' != buf[i - 1]) - return(ARGS_PUNCT); - if (ARGS_NOWARN & fl) - return(ARGS_PUNCT); - if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE)) - return(ARGS_ERROR); - return(ARGS_PUNCT); - } - } - *v = &buf[*pos]; + if (ARGS_DELIM & fl && args_checkpunct(m, buf, *pos, line, fl)) + return(ARGS_PUNCT); + /* * First handle TABSEP items, restricted to `Bl -column'. This * ignores conventional token parsing and instead uses tabs or @@ -490,9 +504,8 @@ args(struct mdoc *m, int line, int *pos, } /* Whitespace check for eoln case... */ - if (0 == *p && ' ' == *(p - 1) && ! (ARGS_NOWARN & fl)) - if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE)) - return(ARGS_ERROR); + if ('\0' == *p && ' ' == *(p - 1) && ! (ARGS_NOWARN & fl)) + mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE); *pos += (int)(p - *v); @@ -536,8 +549,7 @@ args(struct mdoc *m, int line, int *pos, if ('\0' == buf[*pos]) { if (ARGS_NOWARN & fl || MDOC_PPHRASE & m->flags) return(ARGS_QWORD); - if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE)) - return(ARGS_ERROR); + mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE); return(ARGS_QWORD); } @@ -551,137 +563,117 @@ args(struct mdoc *m, int line, int *pos, (*pos)++; if (0 == buf[*pos] && ! (ARGS_NOWARN & fl)) - if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE)) - return(ARGS_ERROR); + mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE); return(ARGS_QWORD); } - /* - * A non-quoted term progresses until either the end of line or - * a non-escaped whitespace. - */ + p = &buf[*pos]; + *v = mandoc_getarg(m->parse, &p, line, + ! (ARGS_NOWARN & fl), pos); - for ( ; buf[*pos]; (*pos)++) - if (' ' == buf[*pos] && '\\' != buf[*pos - 1]) - break; + return(ARGS_WORD); +} - if ('\0' == buf[*pos]) - 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 +args_checkpunct(struct mdoc *m, const char *buf, int i, int ln, int fl) +{ + int j; + char dbuf[DELIMSZ]; + enum mdelim d; - buf[(*pos)++] = '\0'; + /* First token must be a close-delimiter. */ - while (' ' == buf[*pos]) - (*pos)++; + for (j = 0; buf[i] && ' ' != buf[i] && j < DELIMSZ; j++, i++) + dbuf[j] = buf[i]; - if ('\0' == buf[*pos] && ! (ARGS_NOWARN & fl)) - if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE)) - return(ARGS_ERROR); + if (DELIMSZ == j) + return(0); - return(ARGS_WORD); -} + dbuf[j] = '\0'; + if (DELIM_CLOSE != mdoc_isdelim(dbuf)) + return(0); + while (' ' == buf[i]) + i++; -static int + /* Remaining must NOT be open/none. */ + + while (buf[i]) { + j = 0; + while (buf[i] && ' ' != buf[i] && j < DELIMSZ) + dbuf[j++] = buf[i++]; + + if (DELIMSZ == j) + return(0); + + dbuf[j] = '\0'; + d = mdoc_isdelim(dbuf); + if (DELIM_NONE == d || DELIM_OPEN == d) + return(0); + + while (' ' == buf[i]) + i++; + } + + if ( ! (ARGS_NOWARN & fl) && i && ' ' == buf[i - 1]) + mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE); + + return('\0' == buf[i]); +} + +/* + * Match up an argument string (e.g., `-foo bar' having "foo") with the + * correrct identifier. It must apply to the given macro. If none was + * found (including bad matches), return MDOC_ARG_MAX. + */ +static enum mdocargt argv_a2arg(enum mdoct tok, const char *p) { + const enum mdocargt *argsp; - /* - * 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! - */ + argsp = NULL; switch (tok) { case (MDOC_An): - if (0 == strcmp(p, "split")) - return(MDOC_Split); - else if (0 == strcmp(p, "nosplit")) - return(MDOC_Nosplit); + argsp = args_An; break; - case (MDOC_Bd): - if (0 == strcmp(p, "ragged")) - return(MDOC_Ragged); - else if (0 == strcmp(p, "unfilled")) - return(MDOC_Unfilled); - else if (0 == strcmp(p, "filled")) - return(MDOC_Filled); - else if (0 == strcmp(p, "literal")) - return(MDOC_Literal); - else if (0 == strcmp(p, "file")) - return(MDOC_File); - else if (0 == strcmp(p, "offset")) - return(MDOC_Offset); - else if (0 == strcmp(p, "compact")) - return(MDOC_Compact); - else if (0 == strcmp(p, "centered")) - return(MDOC_Centred); + argsp = args_Bd; break; - case (MDOC_Bf): - if (0 == strcmp(p, "emphasis")) - return(MDOC_Emphasis); - else if (0 == strcmp(p, "literal")) - return(MDOC_Literal); - else if (0 == strcmp(p, "symbolic")) - return(MDOC_Symbolic); + argsp = args_Bf; break; - case (MDOC_Bk): - if (0 == strcmp(p, "words")) - return(MDOC_Words); + argsp = args_Bk; break; - case (MDOC_Bl): - if (0 == strcmp(p, "bullet")) - return(MDOC_Bullet); - else if (0 == strcmp(p, "dash")) - return(MDOC_Dash); - else if (0 == strcmp(p, "hyphen")) - return(MDOC_Hyphen); - else if (0 == strcmp(p, "item")) - return(MDOC_Item); - else if (0 == strcmp(p, "enum")) - return(MDOC_Enum); - else if (0 == strcmp(p, "tag")) - return(MDOC_Tag); - else if (0 == strcmp(p, "diag")) - return(MDOC_Diag); - else if (0 == strcmp(p, "hang")) - return(MDOC_Hang); - else if (0 == strcmp(p, "ohang")) - return(MDOC_Ohang); - else if (0 == strcmp(p, "inset")) - return(MDOC_Inset); - else if (0 == strcmp(p, "column")) - return(MDOC_Column); - else if (0 == strcmp(p, "width")) - return(MDOC_Width); - else if (0 == strcmp(p, "offset")) - return(MDOC_Offset); - else if (0 == strcmp(p, "compact")) - return(MDOC_Compact); - else if (0 == strcmp(p, "nested")) - return(MDOC_Nested); + argsp = args_Bl; break; - case (MDOC_Rv): /* FALLTHROUGH */ case (MDOC_Ex): - if (0 == strcmp(p, "std")) - return(MDOC_Std); + argsp = args_Ex; break; default: - break; + return(MDOC_ARG_MAX); } + assert(argsp); + + for ( ; MDOC_ARG_MAX != *argsp ; argsp++) + if (0 == strcmp(p, mdoc_argnames[*argsp])) + return(*argsp); + return(MDOC_ARG_MAX); } - static int argv_multi(struct mdoc *m, int line, struct mdoc_argv *v, int *pos, char *buf) @@ -708,7 +700,6 @@ argv_multi(struct mdoc *m, int line, return(1); } - static int argv_opt_single(struct mdoc *m, int line, struct mdoc_argv *v, int *pos, char *buf) @@ -732,7 +723,6 @@ argv_opt_single(struct mdoc *m, int line, return(1); } - /* * Parse a single, mandatory value from the stream. */ @@ -760,7 +750,6 @@ argv_single(struct mdoc *m, int line, return(1); } - /* * Determine rules for parsing arguments. Arguments can either accept * no parameters, an optional single parameter, one parameter, or @@ -774,16 +763,18 @@ argv(struct mdoc *mdoc, int line, v->sz = 0; v->value = NULL; - switch (mdoc_argvflags[v->arg]) { + switch (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 */ + case (ARGV_NONE): break; + default: + abort(); + /* NOTREACHED */ } return(1);