[dragonfly.git] / usr.bin / mandoc / mdoc_argv.c

/*	$Id: mdoc_argv.c,v 1.32 2009/10/30 05:58:38 kristaps Exp $ */
/*
 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
 *
 * 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
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#include <sys/types.h>

#include <assert.h>
#include <ctype.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.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	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(int, const char *);
static	int		 args(struct mdoc *, int, int *,
				char *, int, char **);
static	int		 argv(struct mdoc *, int,
				struct mdoc_argv *, int *, char *);
static	int		 argv_single(struct mdoc *, 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 *);

/* Per-argument flags. */

static	int mdoc_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_SINGLE,	/* MDOC_File */
	ARGV_OPT_SINGLE, /* MDOC_Offset */
	ARGV_NONE,	/* MDOC_Bullet */
	ARGV_NONE,	/* MDOC_Dash */
	ARGV_NONE,	/* MDOC_Hyphen */
	ARGV_NONE,	/* MDOC_Item */
	ARGV_NONE,	/* MDOC_Enum */
	ARGV_NONE,	/* MDOC_Tag */
	ARGV_NONE,	/* MDOC_Diag */
	ARGV_NONE,	/* MDOC_Hang */
	ARGV_NONE,	/* MDOC_Ohang */
	ARGV_NONE,	/* MDOC_Inset */
	ARGV_MULTI,	/* MDOC_Column */
	ARGV_SINGLE,	/* MDOC_Width */
	ARGV_NONE,	/* MDOC_Compact */
	ARGV_NONE,	/* MDOC_Std */
	ARGV_NONE,	/* MDOC_Filled */
	ARGV_NONE,	/* MDOC_Words */
	ARGV_NONE,	/* MDOC_Emphasis */
	ARGV_NONE,	/* MDOC_Symbolic */
	ARGV_NONE	/* MDOC_Symbolic */
};

static	int mdoc_argflags[MDOC_MAX] = {
	0, /* Ap */
	0, /* Dd */
	0, /* Dt */
	0, /* Os */
	0, /* Sh */
	0, /* Ss */
	ARGS_DELIM, /* Pp */
	ARGS_DELIM, /* D1 */
	ARGS_DELIM, /* Dl */
	0, /* Bd */
	0, /* Ed */
	0, /* Bl */
	0, /* El */
	0, /* It */
	ARGS_DELIM, /* Ad */
	ARGS_DELIM, /* An */
	ARGS_DELIM, /* Ar */
	0, /* Cd */
	ARGS_DELIM, /* Cm */
	ARGS_DELIM, /* Dv */
	ARGS_DELIM, /* Er */
	ARGS_DELIM, /* Ev */
	0, /* Ex */
	ARGS_DELIM, /* Fa */
	0, /* Fd */
	ARGS_DELIM, /* Fl */
	ARGS_DELIM, /* Fn */
	ARGS_DELIM, /* Ft */
	ARGS_DELIM, /* Ic */
	0, /* In */
	ARGS_DELIM, /* Li */
	0, /* Nd */
	ARGS_DELIM, /* Nm */
	ARGS_DELIM, /* Op */
	0, /* Ot */
	ARGS_DELIM, /* Pa */
	0, /* Rv */
	ARGS_DELIM, /* St */
	ARGS_DELIM, /* Va */
	ARGS_DELIM, /* Vt */
	ARGS_DELIM, /* Xr */
	0, /* %A */
	0, /* %B */
	0, /* %D */
	0, /* %I */
	0, /* %J */
	0, /* %N */
	0, /* %O */
	0, /* %P */
	0, /* %R */
	0, /* %T */
	0, /* %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, /* Sy */
	ARGS_DELIM, /* Tn */
	ARGS_DELIM, /* Ux */
	ARGS_DELIM, /* Xc */
	0, /* Xo */
	0, /* Fo */
	0, /* Fc */
	0, /* Oo */
	ARGS_DELIM, /* Oc */
	0, /* Bk */
	0, /* Ek */
	0, /* Bt */
	0, /* Hf */
	0, /* Fr */
	0, /* Ud */
	0, /* Lb */
	ARGS_DELIM, /* Lp */
	ARGS_DELIM, /* Lk */
	ARGS_DELIM, /* Mt */
	ARGS_DELIM, /* Brq */
	0, /* Bro */
	ARGS_DELIM, /* Brc */
	0, /* %C */
	0, /* Es */
	0, /* En */
	0, /* Dx */
	0, /* %Q */
	0, /* br */
	0, /* sp */
	0, /* %U */
};


/*
 * 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.
 */
int
mdoc_argv(struct mdoc *m, int line, int tok,
		struct mdoc_arg **v, int *pos, char *buf)
{
	char		 *p, sv;
	struct mdoc_argv tmp;
	struct mdoc_arg	 *arg;

	if (0 == buf[*pos])
		return(ARGV_EOLN);

	assert(' ' != buf[*pos]);

	/* Parse through to the first unescaped space. */

	p = &buf[++(*pos)];

	assert(*pos > 0);

	/* LINTED */
	while (buf[*pos]) {
		if (' ' == buf[*pos])
			if ('\\' != buf[*pos - 1])
				break;
		(*pos)++;
	}

	/* XXX - save zeroed byte, if not an argument. */

	sv = 0;
	if (buf[*pos]) {
		sv = buf[*pos];
		buf[(*pos)++] = 0;
	}

	(void)memset(&tmp, 0, sizeof(struct mdoc_argv));
	tmp.line = line;
	tmp.pos = *pos;

	/* See if our token accepts the argument. */

	if (MDOC_ARG_MAX == (tmp.arg = argv_a2arg(tok, p))) {
		/* XXX - restore saved zeroed byte. */
		if (sv)
			buf[*pos - 1] = sv;
		return(ARGV_WORD);
	}

	while (buf[*pos] && ' ' == buf[*pos])
		(*pos)++;

	if ( ! argv(m, line, &tmp, pos, buf))
		return(ARGV_ERROR);

	if (NULL == (arg = *v))
		arg = *v = mandoc_calloc(1, sizeof(struct mdoc_arg));

	arg->argc++;
	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));

	return(ARGV_ARG);
}


void
mdoc_argv_free(struct mdoc_arg *p)
{
	int		 i, j;

	if (NULL == p)
		return;

	if (p->refcnt) {
		--(p->refcnt);
		if (p->refcnt)
			return;
	}
	assert(p->argc);

	/* LINTED */
	for (i = 0; i < (int)p->argc; i++) {
		if (0 == p->argv[i].sz)
			continue;
		if (NULL == p->argv[i].value)
			continue;

		/* LINTED */
		for (j = 0; j < (int)p->argv[i].sz; j++)
			if (p->argv[i].value[j])
				free(p->argv[i].value[j]);

		free(p->argv[i].value);
	}

	free(p->argv);
	free(p);
}


int
mdoc_zargs(struct mdoc *m, int line, int *pos,
		char *buf, int flags, char **v)
{

	return(args(m, line, pos, buf, flags, v));
}


int
mdoc_args(struct mdoc *m, int line,
		int *pos, char *buf, int tok, char **v)
{
	int		  fl, c, i;
	struct mdoc_node *n;

	fl = (0 == tok) ? 0 : 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.
	 */

	for (n = m->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);

	/* LINTED */
	for (i = 0; i < c; i++) {
		if (MDOC_Column != n->args->argv[i].arg)
			continue;
		fl |= ARGS_TABSEP;
		fl &= ~ARGS_DELIM;
		break;
	}

	return(args(m, line, pos, buf, fl, v));
}


static int
args(struct mdoc *m, int line, int *pos,
		char *buf, int fl, char **v)
{
	int		  i;
	char		 *p, *pp;

	/*
	 * 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])
		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 ((fl & ARGS_DELIM) && mdoc_iscdelim(buf[*pos])) {
		for (i = *pos; buf[i]; ) {
			if ( ! mdoc_iscdelim(buf[i]))
				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_pwarn(m, line, *pos, ETAILWS))
				return(ARGS_ERROR);
			return(ARGS_PUNCT);
		}
	}

	*v = &buf[*pos];

	/*
	 * First handle TABSEP items, restricted to `Bl -column'.  This
	 * ignores conventional token parsing and instead uses tabs or
	 * `Ta' macros to separate phrases.  Phrases are parsed again
	 * for arguments at a later phase.
	 */

	if (ARGS_TABSEP & fl) {
		/* Scan ahead to tab (can't be escaped). */
		p = strchr(*v, '\t');

		/* 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;
		}

		/*
		 * Adjust new-buffer position to be beyond delimiter
		 * mark (e.g., Ta -> end + 2).
		 */
		if (p && pp) {
			*pos += pp < p ? 2 : 1;
			p = pp < p ? pp : p;
		} else if (p && ! pp) {
			*pos += 1;
		} else if (pp && ! p) {
			p = pp;
			*pos += 2;
		} else
			p = strchr(*v, 0);

		/* Whitespace check for eoln case... */
		if (0 == *p && ' ' == *(p - 1) && ! (ARGS_NOWARN & fl))
			if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
				return(ARGS_ERROR);

		*pos += (int)(p - *v);

		/* Strip delimiter's preceding whitespace. */
		pp = p - 1;
		while (pp > *v && ' ' == *pp) {
			if (pp > *v && '\\' == *(pp - 1))
				break;
			pp--;
		}
		*(pp + 1) = 0;

		/* Strip delimiter's proceeding whitespace. */
		for (pp = &buf[*pos]; ' ' == *pp; pp++, (*pos)++)
			/* Skip ahead. */ ;

		return(ARGS_PHRASE);
	}

	/*
	 * Process a quoted literal.  A quote begins with a double-quote
	 * and ends with a double-quote NOT preceded by a double-quote.
	 * Whitespace is NOT involved in literal termination.
	 */

	if ('\"' == buf[*pos]) {
		*v = &buf[++(*pos)];

		for ( ; buf[*pos]; (*pos)++) {
			if ('\"' != buf[*pos])
				continue;
			if ('\"' != buf[*pos + 1])
				break;
			(*pos)++;
		}

		if (0 == buf[*pos]) {
			if (ARGS_NOWARN & fl)
				return(ARGS_QWORD);
			if ( ! mdoc_pwarn(m, line, *pos, EQUOTTERM))
				return(ARGS_ERROR);
			return(ARGS_QWORD);
		}

		buf[(*pos)++] = 0;

		if (0 == buf[*pos])
			return(ARGS_QWORD);

		while (' ' == buf[*pos])
			(*pos)++;

		if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
			if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
				return(ARGS_ERROR);

		return(ARGS_QWORD);
	}

	/*
	 * A non-quoted term progresses until either the end of line or
	 * a non-escaped whitespace.
	 */

	for ( ; buf[*pos]; (*pos)++)
		if (' ' == buf[*pos] && '\\' != buf[*pos - 1])
			break;

	if (0 == buf[*pos])
		return(ARGS_WORD);

	buf[(*pos)++] = 0;

	while (' ' == buf[*pos])
		(*pos)++;

	if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
		if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
			return(ARGS_ERROR);

	return(ARGS_WORD);
}


static int
argv_a2arg(int tok, const char *p)
{

	/*
	 * 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!
	 */

	switch (tok) {
	case (MDOC_An):
		if (0 == strcmp(p, "split"))
			return(MDOC_Split);
		else if (0 == strcmp(p, "nosplit"))
			return(MDOC_Nosplit);
		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);
		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);
		break;

	case (MDOC_Bk):
		if (0 == strcmp(p, "words"))
			return(MDOC_Words);
		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);
		break;

	case (MDOC_Rv):
		/* FALLTHROUGH */
	case (MDOC_Ex):
		if (0 == strcmp(p, "std"))
			return(MDOC_Std);
		break;
	default:
		break;
	}

	return(MDOC_ARG_MAX);
}


static int
argv_multi(struct mdoc *m, int line,
		struct mdoc_argv *v, int *pos, char *buf)
{
	int		 c;
	char		*p;

	for (v->sz = 0; ; v->sz++) {
		if ('-' == buf[*pos])
			break;
		c = args(m, line, pos, buf, 0, &p);
		if (ARGS_ERROR == c)
			return(0);
		else if (ARGS_EOLN == c)
			break;

		if (0 == v->sz % MULTI_STEP)
			v->value = mandoc_realloc(v->value,
				(v->sz + MULTI_STEP) * sizeof(char *));

		v->value[(int)v->sz] = mandoc_strdup(p);
	}

	return(1);
}


static int
argv_opt_single(struct mdoc *m, int line,
		struct mdoc_argv *v, int *pos, char *buf)
{
	int		 c;
	char		*p;

	if ('-' == buf[*pos])
		return(1);

	c = args(m, line, pos, buf, 0, &p);
	if (ARGS_ERROR == c)
		return(0);
	if (ARGS_EOLN == c)
		return(1);

	v->sz = 1;
	v->value = mandoc_malloc(sizeof(char *));
	v->value[0] = mandoc_strdup(p);

	return(1);
}


/*
 * Parse a single, mandatory value from the stream.
 */
static int
argv_single(struct mdoc *m, int line,
		struct mdoc_argv *v, int *pos, char *buf)
{
	int		 c, ppos;
	char		*p;

	ppos = *pos;

	c = args(m, line, pos, buf, 0, &p);
	if (ARGS_ERROR == c)
		return(0);
	if (ARGS_EOLN == c)
		return(mdoc_perr(m, line, ppos, EARGVAL));

	v->sz = 1;
	v->value = mandoc_malloc(sizeof(char *));
	v->value[0] = mandoc_strdup(p);

	return(1);
}


/*
 * 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,
		struct mdoc_argv *v, int *pos, char *buf)
{

	v->sz = 0;
	v->value = NULL;

	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);
}
Commit	Line	Data
32c903ac	1	/* $Id: mdoc_argv.c,v 1.32 2009/10/30 05:58:38 kristaps Exp $ */
589e7c1d SW	2	/*
	3	* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
	4	*
	5	* Permission to use, copy, modify, and distribute this software for any
	6	* purpose with or without fee is hereby granted, provided that the above
	7	* copyright notice and this permission notice appear in all copies.
	8	*
	9	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	10	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	11	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	12	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	13	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	14	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	15	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	16	*/
	17	#include <sys/types.h>
	18
	19	#include <assert.h>
	20	#include <ctype.h>
	21	#include <stdlib.h>
	22	#include <stdio.h>
	23	#include <string.h>
	24
	25	#include "libmdoc.h"
32c903ac	26	#include "libmandoc.h"
589e7c1d SW	27
	28	/*
	29	* Routines to parse arguments of macros. Arguments follow the syntax
	30	* of `-arg [val [valN...]]'. Arguments come in all types: quoted
	31	* arguments, multiple arguments per value, no-value arguments, etc.
	32	*
	33	* There's no limit to the number or arguments that may be allocated.
	34	*/
	35
	36	#define ARGV_NONE (1 << 0)
	37	#define ARGV_SINGLE (1 << 1)
	38	#define ARGV_MULTI (1 << 2)
	39	#define ARGV_OPT_SINGLE (1 << 3)
	40
	41	#define MULTI_STEP 5
	42
	43	static int argv_a2arg(int, const char *);
	44	static int args(struct mdoc , int, int ,
	45	char , int, char *);
	46	static int argv(struct mdoc *, int,
	47	struct mdoc_argv , int , char *);
	48	static int argv_single(struct mdoc *, int,
	49	struct mdoc_argv , int , char *);
	50	static int argv_opt_single(struct mdoc *, int,
	51	struct mdoc_argv , int , char *);
	52	static int argv_multi(struct mdoc *, int,
	53	struct mdoc_argv , int , char *);
	54
	55	/* Per-argument flags. */
	56
	57	static int mdoc_argvflags[MDOC_ARG_MAX] = {
	58	ARGV_NONE, /* MDOC_Split */
	59	ARGV_NONE, /* MDOC_Nosplit */
	60	ARGV_NONE, /* MDOC_Ragged */
	61	ARGV_NONE, /* MDOC_Unfilled */
	62	ARGV_NONE, /* MDOC_Literal */
	63	ARGV_SINGLE, /* MDOC_File */
	64	ARGV_OPT_SINGLE, /* MDOC_Offset */
	65	ARGV_NONE, /* MDOC_Bullet */
	66	ARGV_NONE, /* MDOC_Dash */
	67	ARGV_NONE, /* MDOC_Hyphen */
	68	ARGV_NONE, /* MDOC_Item */
	69	ARGV_NONE, /* MDOC_Enum */
	70	ARGV_NONE, /* MDOC_Tag */
	71	ARGV_NONE, /* MDOC_Diag */
	72	ARGV_NONE, /* MDOC_Hang */
	73	ARGV_NONE, /* MDOC_Ohang */
	74	ARGV_NONE, /* MDOC_Inset */
	75	ARGV_MULTI, /* MDOC_Column */
	76	ARGV_SINGLE, /* MDOC_Width */
	77	ARGV_NONE, /* MDOC_Compact */
	78	ARGV_NONE, /* MDOC_Std */
	79	ARGV_NONE, /* MDOC_Filled */
	80	ARGV_NONE, /* MDOC_Words */
	81	ARGV_NONE, /* MDOC_Emphasis */
	82	ARGV_NONE, /* MDOC_Symbolic */
	83	ARGV_NONE /* MDOC_Symbolic */
	84	};
	85
	86	static int mdoc_argflags[MDOC_MAX] = {
	87	0, /* Ap */
	88	0, /* Dd */
	89	0, /* Dt */
	90	0, /* Os */
91	0, /* Sh */
92	0, /* Ss */
93	ARGS_DELIM, /* Pp */
94	ARGS_DELIM, /* D1 */
95	ARGS_DELIM, /* Dl */
96	0, /* Bd */
97	0, /* Ed */
98	0, /* Bl */
99	0, /* El */
100	0, /* It */
101	ARGS_DELIM, /* Ad */
102	ARGS_DELIM, /* An */
103	ARGS_DELIM, /* Ar */
104	0, /* Cd */
105	ARGS_DELIM, /* Cm */
106	ARGS_DELIM, /* Dv */
107	ARGS_DELIM, /* Er */
108	ARGS_DELIM, /* Ev */
109	0, /* Ex */
110	ARGS_DELIM, /* Fa */
111	0, /* Fd */
112	ARGS_DELIM, /* Fl */
113	ARGS_DELIM, /* Fn */
114	ARGS_DELIM, /* Ft */
115	ARGS_DELIM, /* Ic */
116	0, /* In */
117	ARGS_DELIM, /* Li */
118	0, /* Nd */
119	ARGS_DELIM, /* Nm */
120	ARGS_DELIM, /* Op */
121	0, /* Ot */
122	ARGS_DELIM, /* Pa */
123	0, /* Rv */
124	ARGS_DELIM, /* St */
125	ARGS_DELIM, /* Va */
126	ARGS_DELIM, /* Vt */
127	ARGS_DELIM, /* Xr */
128	0, /* %A */
129	0, /* %B */
130	0, /* %D */
131	0, /* %I */
132	0, /* %J */
133	0, /* %N */
134	0, /* %O */
135	0, /* %P */
136	0, /* %R */
137	0, /* %T */
138	0, /* %V */
139	ARGS_DELIM, /* Ac */
140	0, /* Ao */
141	ARGS_DELIM, /* Aq */
142	ARGS_DELIM, /* At */
143	ARGS_DELIM, /* Bc */
144	0, /* Bf */
145	0, /* Bo */
146	ARGS_DELIM, /* Bq */
147	ARGS_DELIM, /* Bsx */
148	ARGS_DELIM, /* Bx */
149	0, /* Db */
150	ARGS_DELIM, /* Dc */
151	0, /* Do */
152	ARGS_DELIM, /* Dq */
153	ARGS_DELIM, /* Ec */
154	0, /* Ef */
155	ARGS_DELIM, /* Em */
156	0, /* Eo */
157	ARGS_DELIM, /* Fx */
158	ARGS_DELIM, /* Ms */
159	ARGS_DELIM, /* No */
160	ARGS_DELIM, /* Ns */
161	ARGS_DELIM, /* Nx */
162	ARGS_DELIM, /* Ox */
163	ARGS_DELIM, /* Pc */
164	ARGS_DELIM, /* Pf */
165	0, /* Po */
166	ARGS_DELIM, /* Pq */
167	ARGS_DELIM, /* Qc */
168	ARGS_DELIM, /* Ql */
169	0, /* Qo */
170	ARGS_DELIM, /* Qq */
171	0, /* Re */
172	0, /* Rs */
173	ARGS_DELIM, /* Sc */
174	0, /* So */
175	ARGS_DELIM, /* Sq */
176	0, /* Sm */
177	ARGS_DELIM, /* Sx */
178	ARGS_DELIM, /* Sy */
179	ARGS_DELIM, /* Tn */
180	ARGS_DELIM, /* Ux */
181	ARGS_DELIM, /* Xc */
182	0, /* Xo */
183	0, /* Fo */
184	0, /* Fc */
185	0, /* Oo */
186	ARGS_DELIM, /* Oc */
187	0, /* Bk */
188	0, /* Ek */
189	0, /* Bt */
190	0, /* Hf */
191	0, /* Fr */
192	0, /* Ud */
193	0, /* Lb */
194	ARGS_DELIM, /* Lp */
195	ARGS_DELIM, /* Lk */
196	ARGS_DELIM, /* Mt */
197	ARGS_DELIM, /* Brq */
198	0, /* Bro */
199	ARGS_DELIM, /* Brc */
200	0, /* %C */
201	0, /* Es */
202	0, /* En */
203	0, /* Dx */
204	0, /* %Q */
205	0, /* br */
206	0, /* sp */
cbce6d97	207	0, /* %U */
589e7c1d SW	208	};
	209
	210
	211	/*
	212	* Parse an argument from line text. This comes in the form of -key
	213	* [value0...], which may either have a single mandatory value, at least
	214	* one mandatory value, an optional single value, or no value.
	215	*/
	216	int
	217	mdoc_argv(struct mdoc *m, int line, int tok,
	218	struct mdoc_arg *v, int pos, char *buf)
	219	{
	220	char *p, sv;
	221	struct mdoc_argv tmp;
	222	struct mdoc_arg *arg;
	223
	224	if (0 == buf[*pos])
	225	return(ARGV_EOLN);
	226
	227	assert(' ' != buf[*pos]);
	228
	229	/* Parse through to the first unescaped space. */
	230
	231	p = &buf[++(*pos)];
	232
	233	assert(*pos > 0);
	234
	235	/* LINTED */
	236	while (buf[*pos]) {
	237	if (' ' == buf[*pos])
	238	if ('\\' != buf[*pos - 1])
	239	break;
	240	(*pos)++;
	241	}
	242
	243	/* XXX - save zeroed byte, if not an argument. */
	244
	245	sv = 0;
	246	if (buf[*pos]) {
	247	sv = buf[*pos];
	248	buf[(*pos)++] = 0;
	249	}
	250
	251	(void)memset(&tmp, 0, sizeof(struct mdoc_argv));
	252	tmp.line = line;
	253	tmp.pos = *pos;
	254
	255	/* See if our token accepts the argument. */
	256
	257	if (MDOC_ARG_MAX == (tmp.arg = argv_a2arg(tok, p))) {
	258	/* XXX - restore saved zeroed byte. */
	259	if (sv)
	260	buf[*pos - 1] = sv;
	261	return(ARGV_WORD);
	262	}
	263
	264	while (buf[pos] && ' ' == buf[pos])
	265	(*pos)++;
	266
	267	if ( ! argv(m, line, &tmp, pos, buf))
	268	return(ARGV_ERROR);
	269
32c903ac SW	270	if (NULL == (arg = *v))
32c903ac SW	271	arg = *v = mandoc_calloc(1, sizeof(struct mdoc_arg));
589e7c1d SW	272
589e7c1d SW	273	arg->argc++;
32c903ac SW	274	arg->argv = mandoc_realloc
32c903ac SW	275	(arg->argv, arg->argc * sizeof(struct mdoc_argv));
589e7c1d SW	276
	277	(void)memcpy(&arg->argv[(int)arg->argc - 1],
	278	&tmp, sizeof(struct mdoc_argv));
	279
	280	return(ARGV_ARG);
	281	}
	282
	283
	284	void
	285	mdoc_argv_free(struct mdoc_arg *p)
	286	{
	287	int i, j;
	288
	289	if (NULL == p)
	290	return;
	291
	292	if (p->refcnt) {
	293	--(p->refcnt);
	294	if (p->refcnt)
	295	return;
	296	}
	297	assert(p->argc);
	298
	299	/* LINTED */
	300	for (i = 0; i < (int)p->argc; i++) {
	301	if (0 == p->argv[i].sz)
	302	continue;
	303	if (NULL == p->argv[i].value)
	304	continue;
	305
	306	/* LINTED */
	307	for (j = 0; j < (int)p->argv[i].sz; j++)
	308	if (p->argv[i].value[j])
	309	free(p->argv[i].value[j]);
	310
	311	free(p->argv[i].value);
	312	}
	313
	314	free(p->argv);
	315	free(p);
	316	}
	317
	318
	319	int
	320	mdoc_zargs(struct mdoc m, int line, int pos,
	321	char buf, int flags, char *v)
	322	{
	323
	324	return(args(m, line, pos, buf, flags, v));
	325	}
	326
	327
	328	int
	329	mdoc_args(struct mdoc *m, int line,
	330	int pos, char buf, int tok, char **v)
	331	{
	332	int fl, c, i;
	333	struct mdoc_node *n;
	334
	335	fl = (0 == tok) ? 0 : mdoc_argflags[tok];
	336
	337	if (MDOC_It != tok)
	338	return(args(m, line, pos, buf, fl, v));
	339
340	/*
341	* The `It' macro is a special case, as it acquires parameters from its
342	* parent `Bl' context, specifically, we're concerned with -column.
343	*/
344
345	for (n = m->last; n; n = n->parent)
346	if (MDOC_BLOCK == n->type && MDOC_Bl == n->tok)
347	break;
348
349	assert(n);
350	c = (int)(n->args ? n->args->argc : 0);
351	assert(c > 0);
352
353	/* LINTED */
354	for (i = 0; i < c; i++) {
355	if (MDOC_Column != n->args->argv[i].arg)
356	continue;
357	fl \|= ARGS_TABSEP;
358	fl &= ~ARGS_DELIM;
359	break;
360	}
361
362	return(args(m, line, pos, buf, fl, v));
363	}
364
365
366	static int
367	args(struct mdoc m, int line, int pos,
368	char buf, int fl, char *v)
369	{
370	int i;
371	char p, pp;
372
373	/*
374	* Parse out the terms (like `val' in `.Xx -arg val' or simply
375	* `.Xx val'), which can have all sorts of properties:
376	*
377	* ARGS_DELIM: use special handling if encountering trailing
378	* delimiters in the form of [[::delim::][ ]+]+.
379	*
380	* ARGS_NOWARN: don't post warnings. This is only used when
381	* re-parsing delimiters, as the warnings have already been
382	* posted.
383	*
384	* ARGS_TABSEP: use special handling for tab/`Ta' separated
385	* phrases like in `Bl -column'.
386	*/
387
388	assert(*pos);
389	assert(' ' != buf[*pos]);
390
391	if (0 == buf[*pos])
392	return(ARGS_EOLN);
393
394	/*
395	* If the first character is a delimiter and we're to look for
396	* delimited strings, then pass down the buffer seeing if it
397	* follows the pattern of [[::delim::][ ]+]+.
398	*/
399
400	if ((fl & ARGS_DELIM) && mdoc_iscdelim(buf[*pos])) {
401	for (i = *pos; buf[i]; ) {
402	if ( ! mdoc_iscdelim(buf[i]))
403	break;
404	i++;
405	if (0 == buf[i] \|\| ' ' != buf[i])
406	break;
407	i++;
408	while (buf[i] && ' ' == buf[i])
409	i++;
410	}
411
412	if (0 == buf[i]) {
413	v = &buf[pos];
414	if (' ' != buf[i - 1])
415	return(ARGS_PUNCT);
416	if (ARGS_NOWARN & fl)
417	return(ARGS_PUNCT);
418	if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
419	return(ARGS_ERROR);
420	return(ARGS_PUNCT);
421	}
422	}
423
424	v = &buf[pos];
425
426	/*
427	* First handle TABSEP items, restricted to `Bl -column'. This
428	* ignores conventional token parsing and instead uses tabs or
429	* `Ta' macros to separate phrases. Phrases are parsed again
430	* for arguments at a later phase.
431	*/
432
433	if (ARGS_TABSEP & fl) {
434	/* Scan ahead to tab (can't be escaped). */
435	p = strchr(*v, '\t');
436
437	/* Scan ahead to unescaped `Ta'. */
438	for (pp = *v; ; pp++) {
439	if (NULL == (pp = strstr(pp, "Ta")))
440	break;
441	if (pp > v && ' ' != (pp - 1))
442	continue;
443	if (' ' == (pp + 2) \|\| 0 == (pp + 2))
444	break;
445	}
446
447	/*
448	* Adjust new-buffer position to be beyond delimiter
449	* mark (e.g., Ta -> end + 2).
450	*/
451	if (p && pp) {
452	*pos += pp < p ? 2 : 1;
453	p = pp < p ? pp : p;
454	} else if (p && ! pp) {
455	*pos += 1;
456	} else if (pp && ! p) {
457	p = pp;
458	*pos += 2;
459	} else
460	p = strchr(*v, 0);
461
462	/* Whitespace check for eoln case... */
463	if (0 == p && ' ' == (p - 1) && ! (ARGS_NOWARN & fl))
464	if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
465	return(ARGS_ERROR);
466
467	pos += (int)(p - v);
468
469	/* Strip delimiter's preceding whitespace. */
470	pp = p - 1;
471	while (pp > v && ' ' == pp) {
472	if (pp > v && '\\' == (pp - 1))
473	break;
474	pp--;
475	}
476	*(pp + 1) = 0;
477
478	/* Strip delimiter's proceeding whitespace. */
479	for (pp = &buf[pos]; ' ' == pp; pp++, (*pos)++)
480	/* Skip ahead. */ ;
481
482	return(ARGS_PHRASE);
483	}
484
485	/*
486	* Process a quoted literal. A quote begins with a double-quote
487	* and ends with a double-quote NOT preceded by a double-quote.
488	* Whitespace is NOT involved in literal termination.
489	*/
490
491	if ('\"' == buf[*pos]) {
492	v = &buf[++(pos)];
493
494	for ( ; buf[pos]; (pos)++) {
495	if ('\"' != buf[*pos])
496	continue;
497	if ('\"' != buf[*pos + 1])
498	break;
499	(*pos)++;
500	}
501
502	if (0 == buf[*pos]) {
503	if (ARGS_NOWARN & fl)
504	return(ARGS_QWORD);
505	if ( ! mdoc_pwarn(m, line, *pos, EQUOTTERM))
506	return(ARGS_ERROR);
507	return(ARGS_QWORD);
508	}
509
510	buf[(*pos)++] = 0;
511
512	if (0 == buf[*pos])
513	return(ARGS_QWORD);
514
515	while (' ' == buf[*pos])
516	(*pos)++;
517
518	if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
519	if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
520	return(ARGS_ERROR);
521
522	return(ARGS_QWORD);
523	}
524
525	/*
526	* A non-quoted term progresses until either the end of line or
527	* a non-escaped whitespace.
528	*/
529
530	for ( ; buf[pos]; (pos)++)
531	if (' ' == buf[pos] && '\\' != buf[pos - 1])
532	break;
533
534	if (0 == buf[*pos])
535	return(ARGS_WORD);
536
537	buf[(*pos)++] = 0;
538
539	while (' ' == buf[*pos])
540	(*pos)++;
541
542	if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
543	if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
544	return(ARGS_ERROR);
545
546	return(ARGS_WORD);
547	}
548
549
550	static int
551	argv_a2arg(int tok, const char *p)
552	{
553
554	/*
555	* Parse an argument identifier from its text. XXX - this
556	* should really be table-driven to clarify the code.
557	*
558	* If you add an argument to the list, make sure that you
559	* register it here with its one or more macros!
560	*/
561
562	switch (tok) {
563	case (MDOC_An):
564	if (0 == strcmp(p, "split"))
565	return(MDOC_Split);
566	else if (0 == strcmp(p, "nosplit"))
567	return(MDOC_Nosplit);
568	break;
569
570	case (MDOC_Bd):
571	if (0 == strcmp(p, "ragged"))
572	return(MDOC_Ragged);
573	else if (0 == strcmp(p, "unfilled"))
574	return(MDOC_Unfilled);
575	else if (0 == strcmp(p, "filled"))
576	return(MDOC_Filled);
577	else if (0 == strcmp(p, "literal"))
578	return(MDOC_Literal);
579	else if (0 == strcmp(p, "file"))
580	return(MDOC_File);
581	else if (0 == strcmp(p, "offset"))
582	return(MDOC_Offset);
583	else if (0 == strcmp(p, "compact"))
584	return(MDOC_Compact);
585	else if (0 == strcmp(p, "centered"))
586	return(MDOC_Centred);
587	break;
588
589	case (MDOC_Bf):
590	if (0 == strcmp(p, "emphasis"))
591	return(MDOC_Emphasis);
592	else if (0 == strcmp(p, "literal"))
593	return(MDOC_Literal);
594	else if (0 == strcmp(p, "symbolic"))
595	return(MDOC_Symbolic);
596	break;
597
598	case (MDOC_Bk):
599	if (0 == strcmp(p, "words"))
600	return(MDOC_Words);
601	break;
602
603	case (MDOC_Bl):
604	if (0 == strcmp(p, "bullet"))
605	return(MDOC_Bullet);
606	else if (0 == strcmp(p, "dash"))
607	return(MDOC_Dash);
608	else if (0 == strcmp(p, "hyphen"))
609	return(MDOC_Hyphen);
610	else if (0 == strcmp(p, "item"))
611	return(MDOC_Item);
612	else if (0 == strcmp(p, "enum"))
613	return(MDOC_Enum);
614	else if (0 == strcmp(p, "tag"))
615	return(MDOC_Tag);
616	else if (0 == strcmp(p, "diag"))
617	return(MDOC_Diag);
618	else if (0 == strcmp(p, "hang"))
619	return(MDOC_Hang);
620	else if (0 == strcmp(p, "ohang"))
621	return(MDOC_Ohang);
622	else if (0 == strcmp(p, "inset"))
623	return(MDOC_Inset);
624	else if (0 == strcmp(p, "column"))
625	return(MDOC_Column);
626	else if (0 == strcmp(p, "width"))
627	return(MDOC_Width);
628	else if (0 == strcmp(p, "offset"))
629	return(MDOC_Offset);
630	else if (0 == strcmp(p, "compact"))
631	return(MDOC_Compact);
632	else if (0 == strcmp(p, "nested"))
633	return(MDOC_Nested);
634	break;
635
636	case (MDOC_Rv):
637	/* FALLTHROUGH */
638	case (MDOC_Ex):
639	if (0 == strcmp(p, "std"))
640	return(MDOC_Std);
641	break;
642	default:
643	break;
644	}
645
646	return(MDOC_ARG_MAX);
647	}
648
649
650	static int
651	argv_multi(struct mdoc *m, int line,
652	struct mdoc_argv v, int pos, char *buf)
653	{
654	int c;
655	char *p;
656
657	for (v->sz = 0; ; v->sz++) {
658	if ('-' == buf[*pos])
659	break;
660	c = args(m, line, pos, buf, 0, &p);
661	if (ARGS_ERROR == c)
662	return(0);
663	else if (ARGS_EOLN == c)
664	break;
665
32c903ac SW	666	if (0 == v->sz % MULTI_STEP)
32c903ac SW	667	v->value = mandoc_realloc(v->value,
589e7c1d	668	(v->sz + MULTI_STEP) * sizeof(char *));
32c903ac SW	669
32c903ac SW	670	v->value[(int)v->sz] = mandoc_strdup(p);
589e7c1d SW	671	}
	672
	673	return(1);
	674	}
	675
	676
	677	static int
	678	argv_opt_single(struct mdoc *m, int line,
	679	struct mdoc_argv v, int pos, char *buf)
	680	{
	681	int c;
	682	char *p;
	683
	684	if ('-' == buf[*pos])
	685	return(1);
	686
	687	c = args(m, line, pos, buf, 0, &p);
	688	if (ARGS_ERROR == c)
	689	return(0);
	690	if (ARGS_EOLN == c)
	691	return(1);
	692
	693	v->sz = 1;
32c903ac SW	694	v->value = mandoc_malloc(sizeof(char *));
32c903ac SW	695	v->value[0] = mandoc_strdup(p);
589e7c1d SW	696
	697	return(1);
	698	}
	699
	700
	701	/*
	702	* Parse a single, mandatory value from the stream.
	703	*/
	704	static int
	705	argv_single(struct mdoc *m, int line,
	706	struct mdoc_argv v, int pos, char *buf)
	707	{
	708	int c, ppos;
	709	char *p;
	710
	711	ppos = *pos;
	712
	713	c = args(m, line, pos, buf, 0, &p);
	714	if (ARGS_ERROR == c)
	715	return(0);
	716	if (ARGS_EOLN == c)
	717	return(mdoc_perr(m, line, ppos, EARGVAL));
	718
	719	v->sz = 1;
32c903ac SW	720	v->value = mandoc_malloc(sizeof(char *));
32c903ac SW	721	v->value[0] = mandoc_strdup(p);
589e7c1d SW	722
	723	return(1);
	724	}
	725
	726
	727	/*
	728	* Determine rules for parsing arguments. Arguments can either accept
	729	* no parameters, an optional single parameter, one parameter, or
	730	* multiple parameters.
	731	*/
	732	static int
	733	argv(struct mdoc *mdoc, int line,
	734	struct mdoc_argv v, int pos, char *buf)
	735	{
	736
	737	v->sz = 0;
	738	v->value = NULL;
	739
	740	switch (mdoc_argvflags[v->arg]) {
	741	case (ARGV_SINGLE):
	742	return(argv_single(mdoc, line, v, pos, buf));
	743	case (ARGV_MULTI):
	744	return(argv_multi(mdoc, line, v, pos, buf));
	745	case (ARGV_OPT_SINGLE):
	746	return(argv_opt_single(mdoc, line, v, pos, buf));
	747	default:
	748	/* ARGV_NONE */
	749	break;
	750	}
	751
	752	return(1);
	753	}