-/* $Id: mdoc_argv.c,v 1.22 2009/08/19 14:44:35 kristaps Exp $ */
+/* $Id: mdoc_argv.c,v 1.60 2010/09/13 20:15:43 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
#include <sys/types.h>
#include <assert.h>
#include <stdio.h>
#include <string.h>
+#include "mandoc.h"
#include "libmdoc.h"
+#include "libmandoc.h"
/*
* Routines to parse arguments of macros. Arguments follow the syntax
* There's no limit to the number or arguments that may be allocated.
*/
-#define ARGS_DELIM (1 << 1)
-#define ARGS_TABSEP (1 << 2)
-
#define ARGV_NONE (1 << 0)
#define ARGV_SINGLE (1 << 1)
#define ARGV_MULTI (1 << 2)
#define MULTI_STEP 5
-static int argv_a2arg(int, const char *);
-static int args(struct mdoc *, int, int *,
+static enum mdocargt argv_a2arg(enum mdoct, const char *);
+static enum margserr args(struct mdoc *, int, int *,
char *, int, char **);
static int argv(struct mdoc *, int,
struct mdoc_argv *, int *, char *);
ARGV_NONE, /* MDOC_Ragged */
ARGV_NONE, /* MDOC_Unfilled */
ARGV_NONE, /* MDOC_Literal */
- ARGV_NONE, /* MDOC_File */
- ARGV_SINGLE, /* MDOC_Offset */
+ ARGV_SINGLE, /* MDOC_File */
+ ARGV_OPT_SINGLE, /* MDOC_Offset */
ARGV_NONE, /* MDOC_Bullet */
ARGV_NONE, /* MDOC_Dash */
ARGV_NONE, /* MDOC_Hyphen */
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 */
0, /* Os */
0, /* Sh */
0, /* Ss */
- ARGS_DELIM, /* Pp */
+ 0, /* Pp */
ARGS_DELIM, /* D1 */
ARGS_DELIM, /* Dl */
0, /* Bd */
0, /* Fr */
0, /* Ud */
0, /* Lb */
- ARGS_DELIM, /* Lp */
+ 0, /* Lp */
ARGS_DELIM, /* Lk */
ARGS_DELIM, /* Mt */
ARGS_DELIM, /* Brq */
0, /* %Q */
0, /* br */
0, /* sp */
+ 0, /* %U */
+ 0, /* Ta */
};
* [value0...], which may either have a single mandatory value, at least
* one mandatory value, an optional single value, or no value.
*/
-int
-mdoc_argv(struct mdoc *m, int line, int tok,
+enum margverr
+mdoc_argv(struct mdoc *m, int line, enum mdoct tok,
struct mdoc_arg **v, int *pos, char *buf)
{
char *p, sv;
struct mdoc_argv tmp;
struct mdoc_arg *arg;
- if (0 == buf[*pos])
+ if ('\0' == buf[*pos])
return(ARGV_EOLN);
assert(' ' != buf[*pos]);
/* 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));
if ( ! argv(m, line, &tmp, pos, buf))
return(ARGV_ERROR);
- if (NULL == (arg = *v)) {
- *v = calloc(1, sizeof(struct mdoc_arg));
- if (NULL == *v) {
- (void)mdoc_nerr(m, m->last, EMALLOC);
- return(ARGV_ERROR);
- }
- arg = *v;
- }
+ if (NULL == (arg = *v))
+ arg = *v = mandoc_calloc(1, sizeof(struct mdoc_arg));
arg->argc++;
- arg->argv = realloc(arg->argv, arg->argc *
- sizeof(struct mdoc_argv));
-
- if (NULL == arg->argv) {
- (void)mdoc_nerr(m, m->last, EMALLOC);
- return(ARGV_ERROR);
- }
+ arg->argv = mandoc_realloc
+ (arg->argv, arg->argc * sizeof(struct mdoc_argv));
(void)memcpy(&arg->argv[(int)arg->argc - 1],
&tmp, sizeof(struct mdoc_argv));
void
mdoc_argv_free(struct mdoc_arg *p)
{
- int i, j;
+ int i;
if (NULL == p)
return;
}
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]);
-
- free(p->argv[i].value);
- }
+ for (i = (int)p->argc - 1; i >= 0; i--)
+ mdoc_argn_free(p, i);
free(p->argv);
free(p);
}
-int
-mdoc_zargs(struct mdoc *m, int line, int *pos, char *buf, char **v)
+void
+mdoc_argn_free(struct mdoc_arg *p, int 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]);
+ free(arg->value);
+ }
- return(args(m, line, pos, buf, 0, v));
+ for (--p->argc; iarg < (int)p->argc; iarg++)
+ p->argv[iarg] = p->argv[iarg+1];
}
-int
-mdoc_args(struct mdoc *m, int line,
- int *pos, char *buf, int tok, char **v)
+enum margserr
+mdoc_zargs(struct mdoc *m, int line, int *pos,
+ char *buf, int flags, char **v)
{
- int fl, c, i;
+
+ 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)
+{
+ int fl;
struct mdoc_node *n;
- fl = (0 == tok) ? 0 : mdoc_argflags[tok];
+ fl = mdoc_argflags[tok];
if (MDOC_It != tok)
return(args(m, line, pos, buf, fl, v));
- /*
- * The `It' macro is a special case, as it acquires parameters from its
- * parent `Bl' context, specifically, we're concerned with -column.
+ /*
+ * 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.
*/
for (n = m->last; n; n = n->parent)
- if (MDOC_BLOCK == n->type && MDOC_Bl == n->tok)
+ if (MDOC_Bl == n->tok)
break;
- assert(n);
- c = (int)(n->args ? n->args->argc : 0);
- assert(c > 0);
-
- /* LINTED */
- for (i = 0; i < c; i++) {
- if (MDOC_Column != n->args->argv[i].arg)
- continue;
+ assert(n->data.Bl);
+ if (n && LIST_column == n->data.Bl->type) {
fl |= ARGS_TABSEP;
fl &= ~ARGS_DELIM;
- break;
}
return(args(m, line, pos, buf, fl, v));
}
-static int
+static enum margserr
args(struct mdoc *m, int line, int *pos,
char *buf, int fl, char **v)
{
- int i;
- char *p, *pp;
+ int i;
+ char *p, *pp;
+ enum margserr rc;
+ enum mdelim d;
+
+ /*
+ * Parse out the terms (like `val' in `.Xx -arg val' or simply
+ * `.Xx val'), which can have all sorts of properties:
+ *
+ * ARGS_DELIM: use special handling if encountering trailing
+ * delimiters in the form of [[::delim::][ ]+]+.
+ *
+ * ARGS_NOWARN: don't post warnings. This is only used when
+ * re-parsing delimiters, as the warnings have already been
+ * posted.
+ *
+ * ARGS_TABSEP: use special handling for tab/`Ta' separated
+ * phrases like in `Bl -column'.
+ */
- assert(*pos);
assert(' ' != buf[*pos]);
- if (0 == buf[*pos])
+ if ('\0' == buf[*pos]) {
+ if (MDOC_PPHRASE & m->flags)
+ return(ARGS_EOLN);
+ /*
+ * If we're not in a partial phrase and the flag for
+ * being a phrase literal is still set, the punctuation
+ * is unterminated.
+ */
+ if (MDOC_PHRASELIT & m->flags)
+ if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE))
+ return(ARGS_ERROR);
+
+ m->flags &= ~MDOC_PHRASELIT;
return(ARGS_EOLN);
+ }
/*
- * 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 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) && mdoc_iscdelim(buf[*pos])) {
+ if ((fl & ARGS_DELIM) && DELIM_CLOSE == mdoc_iscdelim(buf[*pos])) {
for (i = *pos; buf[i]; ) {
- if ( ! mdoc_iscdelim(buf[i]))
+ d = mdoc_iscdelim(buf[i]);
+ if (DELIM_NONE == d || DELIM_OPEN == d)
break;
i++;
- if (0 == buf[i] || ' ' != buf[i])
+ if ('\0' == buf[i] || ' ' != buf[i])
break;
i++;
while (buf[i] && ' ' == buf[i])
i++;
}
- /* FIXME: warn about trailing whitespace. */
-
- if (0 == buf[i]) {
+ if ('\0' == buf[i]) {
*v = &buf[*pos];
+ if (i && ' ' != 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);
}
}
if (ARGS_TABSEP & fl) {
/* Scan ahead to tab (can't be escaped). */
p = strchr(*v, '\t');
+ pp = NULL;
/* Scan ahead to unescaped `Ta'. */
- for (pp = *v; ; pp++) {
- if (NULL == (pp = strstr(pp, "Ta")))
- break;
- if (pp > *v && ' ' != *(pp - 1))
- continue;
- if (' ' == *(pp + 2) || 0 == *(pp + 2))
- break;
- }
+ if ( ! (MDOC_PHRASELIT & m->flags))
+ for (pp = *v; ; pp++) {
+ if (NULL == (pp = strstr(pp, "Ta")))
+ break;
+ if (pp > *v && ' ' != *(pp - 1))
+ continue;
+ if (' ' == *(pp + 2) || '\0' == *(pp + 2))
+ break;
+ }
+
+ /* By default, assume a phrase. */
+ rc = ARGS_PHRASE;
/*
* Adjust new-buffer position to be beyond delimiter
*/
if (p && pp) {
*pos += pp < p ? 2 : 1;
+ rc = pp < p ? ARGS_PHRASE : ARGS_PPHRASE;
p = pp < p ? pp : p;
} else if (p && ! pp) {
+ rc = ARGS_PPHRASE;
*pos += 1;
} else if (pp && ! p) {
p = pp;
*pos += 2;
- } else
+ } else {
+ rc = ARGS_PEND;
p = strchr(*v, 0);
+ }
/* Whitespace check for eoln case... */
- if (0 == *p && ' ' == *(p - 1))
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ if ('\0' == *p && ' ' == *(p - 1) && ! (ARGS_NOWARN & fl))
+ if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
return(ARGS_ERROR);
*pos += (int)(p - *v);
for (pp = &buf[*pos]; ' ' == *pp; pp++, (*pos)++)
/* Skip ahead. */ ;
- return(ARGS_PHRASE);
+ return(rc);
}
/*
* Whitespace is NOT involved in literal termination.
*/
- if ('\"' == buf[*pos]) {
- *v = &buf[++(*pos)];
+ if (MDOC_PHRASELIT & m->flags || '\"' == buf[*pos]) {
+ if ( ! (MDOC_PHRASELIT & m->flags))
+ *v = &buf[++(*pos)];
+
+ if (MDOC_PPHRASE & m->flags)
+ m->flags |= MDOC_PHRASELIT;
for ( ; buf[*pos]; (*pos)++) {
if ('\"' != buf[*pos])
(*pos)++;
}
- if (0 == buf[*pos]) {
- if ( ! mdoc_pwarn(m, line, *pos, EQUOTTERM))
+ 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);
return(ARGS_QWORD);
}
- buf[(*pos)++] = 0;
+ m->flags &= ~MDOC_PHRASELIT;
+ buf[(*pos)++] = '\0';
- if (0 == buf[*pos])
+ if ('\0' == buf[*pos])
return(ARGS_QWORD);
while (' ' == buf[*pos])
(*pos)++;
- if (0 == buf[*pos])
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
+ if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
return(ARGS_ERROR);
return(ARGS_QWORD);
*/
for ( ; buf[*pos]; (*pos)++)
- if (' ' == buf[*pos] && '\\' != buf[*pos - 1])
+ if (*pos && ' ' == buf[*pos] && '\\' != buf[*pos - 1])
break;
- if (0 == buf[*pos])
+ if ('\0' == buf[*pos])
return(ARGS_WORD);
- buf[(*pos)++] = 0;
+ buf[(*pos)++] = '\0';
while (' ' == buf[*pos])
(*pos)++;
- if (0 == buf[*pos])
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ if ('\0' == buf[*pos] && ! (ARGS_NOWARN & fl))
+ if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
return(ARGS_ERROR);
return(ARGS_WORD);
}
-static int
-argv_a2arg(int tok, const char *argv)
+static enum mdocargt
+argv_a2arg(enum mdoct tok, const char *p)
{
/*
switch (tok) {
case (MDOC_An):
- if (0 == strcmp(argv, "split"))
+ if (0 == strcmp(p, "split"))
return(MDOC_Split);
- else if (0 == strcmp(argv, "nosplit"))
+ else if (0 == strcmp(p, "nosplit"))
return(MDOC_Nosplit);
break;
case (MDOC_Bd):
- if (0 == strcmp(argv, "ragged"))
+ if (0 == strcmp(p, "ragged"))
return(MDOC_Ragged);
- else if (0 == strcmp(argv, "unfilled"))
+ else if (0 == strcmp(p, "unfilled"))
return(MDOC_Unfilled);
- else if (0 == strcmp(argv, "filled"))
+ else if (0 == strcmp(p, "filled"))
return(MDOC_Filled);
- else if (0 == strcmp(argv, "literal"))
+ else if (0 == strcmp(p, "literal"))
return(MDOC_Literal);
- else if (0 == strcmp(argv, "file"))
+ else if (0 == strcmp(p, "file"))
return(MDOC_File);
- else if (0 == strcmp(argv, "offset"))
+ else if (0 == strcmp(p, "offset"))
return(MDOC_Offset);
- else if (0 == strcmp(argv, "compact"))
+ else if (0 == strcmp(p, "compact"))
return(MDOC_Compact);
+ else if (0 == strcmp(p, "centered"))
+ return(MDOC_Centred);
break;
case (MDOC_Bf):
- if (0 == strcmp(argv, "emphasis"))
+ if (0 == strcmp(p, "emphasis"))
return(MDOC_Emphasis);
- else if (0 == strcmp(argv, "literal"))
+ else if (0 == strcmp(p, "literal"))
return(MDOC_Literal);
- else if (0 == strcmp(argv, "symbolic"))
+ else if (0 == strcmp(p, "symbolic"))
return(MDOC_Symbolic);
break;
case (MDOC_Bk):
- if (0 == strcmp(argv, "words"))
+ if (0 == strcmp(p, "words"))
return(MDOC_Words);
break;
case (MDOC_Bl):
- if (0 == strcmp(argv, "bullet"))
+ if (0 == strcmp(p, "bullet"))
return(MDOC_Bullet);
- else if (0 == strcmp(argv, "dash"))
+ else if (0 == strcmp(p, "dash"))
return(MDOC_Dash);
- else if (0 == strcmp(argv, "hyphen"))
+ else if (0 == strcmp(p, "hyphen"))
return(MDOC_Hyphen);
- else if (0 == strcmp(argv, "item"))
+ else if (0 == strcmp(p, "item"))
return(MDOC_Item);
- else if (0 == strcmp(argv, "enum"))
+ else if (0 == strcmp(p, "enum"))
return(MDOC_Enum);
- else if (0 == strcmp(argv, "tag"))
+ else if (0 == strcmp(p, "tag"))
return(MDOC_Tag);
- else if (0 == strcmp(argv, "diag"))
+ else if (0 == strcmp(p, "diag"))
return(MDOC_Diag);
- else if (0 == strcmp(argv, "hang"))
+ else if (0 == strcmp(p, "hang"))
return(MDOC_Hang);
- else if (0 == strcmp(argv, "ohang"))
+ else if (0 == strcmp(p, "ohang"))
return(MDOC_Ohang);
- else if (0 == strcmp(argv, "inset"))
+ else if (0 == strcmp(p, "inset"))
return(MDOC_Inset);
- else if (0 == strcmp(argv, "column"))
+ else if (0 == strcmp(p, "column"))
return(MDOC_Column);
- else if (0 == strcmp(argv, "width"))
+ else if (0 == strcmp(p, "width"))
return(MDOC_Width);
- else if (0 == strcmp(argv, "offset"))
+ else if (0 == strcmp(p, "offset"))
return(MDOC_Offset);
- else if (0 == strcmp(argv, "compact"))
+ else if (0 == strcmp(p, "compact"))
return(MDOC_Compact);
- else if (0 == strcmp(argv, "nested"))
+ else if (0 == strcmp(p, "nested"))
return(MDOC_Nested);
break;
case (MDOC_Rv):
/* FALLTHROUGH */
case (MDOC_Ex):
- if (0 == strcmp(argv, "std"))
+ if (0 == strcmp(p, "std"))
return(MDOC_Std);
break;
default:
argv_multi(struct mdoc *m, int line,
struct mdoc_argv *v, int *pos, char *buf)
{
- int c;
+ enum margserr ac;
char *p;
for (v->sz = 0; ; v->sz++) {
if ('-' == buf[*pos])
break;
- c = args(m, line, pos, buf, 0, &p);
- if (ARGS_ERROR == c)
+ ac = args(m, line, pos, buf, 0, &p);
+ if (ARGS_ERROR == ac)
return(0);
- else if (ARGS_EOLN == c)
+ else if (ARGS_EOLN == ac)
break;
- if (0 == v->sz % MULTI_STEP) {
- v->value = realloc(v->value,
+ if (0 == v->sz % MULTI_STEP)
+ v->value = mandoc_realloc(v->value,
(v->sz + MULTI_STEP) * sizeof(char *));
- if (NULL == v->value) {
- (void)mdoc_nerr(m, m->last, EMALLOC);
- return(ARGV_ERROR);
- }
- }
- if (NULL == (v->value[(int)v->sz] = strdup(p)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+
+ v->value[(int)v->sz] = mandoc_strdup(p);
}
return(1);
argv_opt_single(struct mdoc *m, int line,
struct mdoc_argv *v, int *pos, char *buf)
{
- int c;
+ enum margserr ac;
char *p;
if ('-' == buf[*pos])
return(1);
- c = args(m, line, pos, buf, 0, &p);
- if (ARGS_ERROR == c)
+ ac = args(m, line, pos, buf, 0, &p);
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == ac)
return(1);
v->sz = 1;
- if (NULL == (v->value = calloc(1, sizeof(char *))))
- return(mdoc_nerr(m, m->last, EMALLOC));
- if (NULL == (v->value[0] = strdup(p)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ v->value = mandoc_malloc(sizeof(char *));
+ v->value[0] = mandoc_strdup(p);
return(1);
}
argv_single(struct mdoc *m, int line,
struct mdoc_argv *v, int *pos, char *buf)
{
- int c, ppos;
+ int ppos;
+ enum margserr ac;
char *p;
ppos = *pos;
- c = args(m, line, pos, buf, 0, &p);
- if (ARGS_ERROR == c)
+ ac = args(m, line, pos, buf, 0, &p);
+ if (ARGS_EOLN == ac) {
+ mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTARGVCOUNT);
+ return(0);
+ } else if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == c)
- return(mdoc_perr(m, line, ppos, EARGVAL));
v->sz = 1;
- if (NULL == (v->value = calloc(1, sizeof(char *))))
- return(mdoc_nerr(m, m->last, EMALLOC));
- if (NULL == (v->value[0] = strdup(p)))
- return(mdoc_nerr(m, m->last, EMALLOC));
+ v->value = mandoc_malloc(sizeof(char *));
+ v->value[0] = mandoc_strdup(p);
return(1);
}