path: root/argv.c

/* $Id$ */
/*
 * Copyright (c) 2008 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 <assert.h>
#include <ctype.h>
#include <err.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

#include "private.h"

/*
 * Parse arguments and parameters of macros.  Arguments follow the
 * syntax of `-arg [val [valN...]]', while parameters are free-form text
 * following arguments (if any).  This file must correctly handle the
 * strange punctuation rules dictated by groff.
 */

/* FIXME: .It called with -column and quoted arguments. */

static	int		 lookup(int, const char *);
static	int		 parse(struct mdoc *, int,
				struct mdoc_arg *, int *, char *);
static	int		 parse_single(struct mdoc *, int, 
				struct mdoc_arg *, int *, char *);
static	int		 parse_multi(struct mdoc *, int, 
				struct mdoc_arg *, int *, char *);
static	int		 postparse(struct mdoc *, int, 
				const struct mdoc_arg *, int);


int
mdoc_args(struct mdoc *mdoc, int line, int *pos, char *buf, int fl, char **v)
{
	int		 i;

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

	if ('\"' == buf[*pos] && ! (fl & ARGS_QUOTED))
		if ( ! mdoc_pwarn(mdoc, line, *pos, WARN_SYNTAX, "unexpected quoted parameter"))
			return(ARGS_ERROR);

	if ('-' == buf[*pos]) 
		if ( ! mdoc_pwarn(mdoc, line, *pos, WARN_SYNTAX, "argument-like parameter"))
			return(ARGS_ERROR);

	if ((fl & ARGS_DELIM) && mdoc_iscdelim(buf[*pos])) {
		/* 
		 * If ARGS_DELIM, return ARGS_PUNCT if only space-separated
		 * punctuation remains.  
		 */
		for (i = *pos; buf[i]; ) {
			if ( ! mdoc_iscdelim(buf[i]))
				break;
			i++;
			if (0 == buf[i] || ! isspace((int)buf[i]))
				break;
			i++;
			while (buf[i] && isspace((int)buf[i]))
				i++;
		}
		if (0 == buf[i]) {
			*v = &buf[*pos];
			return(ARGS_PUNCT);
		}
	}

	/* Parse routine for non-quoted string. */

	assert(*pos > 0);
	if ('\"' != buf[*pos] || ! (ARGS_QUOTED & fl)) {
		*v = &buf[*pos];

		/* FIXME: UGLY tab-sep processing. */

		if (ARGS_TABSEP & fl)
			while (buf[*pos]) {
				if ('\t' == buf[*pos])
					break;
				if ('T' == buf[*pos]) {
					(*pos)++;
					if (0 == buf[*pos])
						break;
					if ('a' == buf[*pos]) {
						buf[*pos - 1] = 0;
						break;
					}
				}
				(*pos)++;
			}
		else {
			while (buf[*pos]) {
				if (isspace((int)buf[*pos]))
					if ('\\' != buf[*pos - 1])
						break;
				(*pos)++;
			}
		}

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

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

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

		if ( ! (ARGS_TABSEP & fl))
			while (buf[*pos] && isspace((int)buf[*pos]))
				(*pos)++;

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

		if ( ! mdoc_pwarn(mdoc, line, *pos, WARN_COMPAT, "whitespace at end-of-line"))
			return(ARGS_ERROR);

		return(ARGS_WORD);
	}

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

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

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

	if (0 == buf[*pos]) {
		(void)mdoc_perr(mdoc, line, *pos, "unterminated quoted parameter");
		return(ARGS_ERROR);
	}

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

	while (buf[*pos] && isspace((int)buf[*pos]))
		(*pos)++;

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

	if ( ! mdoc_pwarn(mdoc, line, *pos, WARN_COMPAT, "whitespace at end-of-line"))
		return(ARGS_ERROR);

	return(ARGS_QWORD);
}


static int
lookup(int tok, const char *argv)
{

	switch (tok) {
	case (MDOC_An):
		if (xstrcmp(argv, "split"))
			return(MDOC_Split);
		else if (xstrcmp(argv, "nosplit"))
			return(MDOC_Nosplit);
		break;

	case (MDOC_Bd):
		if (xstrcmp(argv, "ragged"))
			return(MDOC_Ragged);
		else if (xstrcmp(argv, "unfilled"))
			return(MDOC_Unfilled);
		else if (xstrcmp(argv, "filled"))
			return(MDOC_Filled);
		else if (xstrcmp(argv, "literal"))
			return(MDOC_Literal);
		else if (xstrcmp(argv, "file"))
			return(MDOC_File);
		else if (xstrcmp(argv, "offset"))
			return(MDOC_Offset);
		break;

	case (MDOC_Bf):
		if (xstrcmp(argv, "emphasis"))
			return(MDOC_Emphasis);
		else if (xstrcmp(argv, "literal"))
			return(MDOC_Literal);
		else if (xstrcmp(argv, "symbolic"))
			return(MDOC_Symbolic);
		break;

	case (MDOC_Bk):
		if (xstrcmp(argv, "words"))
			return(MDOC_Words);
		break;

	case (MDOC_Bl):
		if (xstrcmp(argv, "bullet"))
			return(MDOC_Bullet);
		else if (xstrcmp(argv, "dash"))
			return(MDOC_Dash);
		else if (xstrcmp(argv, "hyphen"))
			return(MDOC_Hyphen);
		else if (xstrcmp(argv, "item"))
			return(MDOC_Item);
		else if (xstrcmp(argv, "enum"))
			return(MDOC_Enum);
		else if (xstrcmp(argv, "tag"))
			return(MDOC_Tag);
		else if (xstrcmp(argv, "diag"))
			return(MDOC_Diag);
		else if (xstrcmp(argv, "hang"))
			return(MDOC_Hang);
		else if (xstrcmp(argv, "ohang"))
			return(MDOC_Ohang);
		else if (xstrcmp(argv, "inset"))
			return(MDOC_Inset);
		else if (xstrcmp(argv, "column"))
			return(MDOC_Column);
		else if (xstrcmp(argv, "width"))
			return(MDOC_Width);
		else if (xstrcmp(argv, "offset"))
			return(MDOC_Offset);
		else if (xstrcmp(argv, "compact"))
			return(MDOC_Compact);
		break;
	
	case (MDOC_Rv):
		/* FALLTHROUGH */
	case (MDOC_Ex):
		if (xstrcmp(argv, "std"))
			return(MDOC_Std);
		break;
	
	case (MDOC_St):
		if (xstrcmp(argv, "p1003.1-88"))
			return(MDOC_p1003_1_88);
		else if (xstrcmp(argv, "p1003.1-90"))
			return(MDOC_p1003_1_90);
		else if (xstrcmp(argv, "p1003.1-96"))
			return(MDOC_p1003_1_96);
		else if (xstrcmp(argv, "p1003.1-2001"))
			return(MDOC_p1003_1_2001);
		else if (xstrcmp(argv, "p1003.1-2004"))
			return(MDOC_p1003_1_2004);
		else if (xstrcmp(argv, "p1003.1"))
			return(MDOC_p1003_1);
		else if (xstrcmp(argv, "p1003.1b"))
			return(MDOC_p1003_1b);
		else if (xstrcmp(argv, "p1003.1b-93"))
			return(MDOC_p1003_1b_93);
		else if (xstrcmp(argv, "p1003.1c-95"))
			return(MDOC_p1003_1c_95);
		else if (xstrcmp(argv, "p1003.1g-2000"))
			return(MDOC_p1003_1g_2000);
		else if (xstrcmp(argv, "p1003.2-92"))
			return(MDOC_p1003_2_92);
		else if (xstrcmp(argv, "p1003.2-95"))
			return(MDOC_p1387_2_95);
		else if (xstrcmp(argv, "p1003.2"))
			return(MDOC_p1003_2);
		else if (xstrcmp(argv, "p1387.2-95"))
			return(MDOC_p1387_2);
		else if (xstrcmp(argv, "isoC-90"))
			return(MDOC_isoC_90);
		else if (xstrcmp(argv, "isoC-amd1"))
			return(MDOC_isoC_amd1);
		else if (xstrcmp(argv, "isoC-tcor1"))
			return(MDOC_isoC_tcor1);
		else if (xstrcmp(argv, "isoC-tcor2"))
			return(MDOC_isoC_tcor2);
		else if (xstrcmp(argv, "isoC-99"))
			return(MDOC_isoC_99);
		else if (xstrcmp(argv, "ansiC"))
			return(MDOC_ansiC);
		else if (xstrcmp(argv, "ansiC-89"))
			return(MDOC_ansiC_89);
		else if (xstrcmp(argv, "ansiC-99"))
			return(MDOC_ansiC_99);
		else if (xstrcmp(argv, "ieee754"))
			return(MDOC_ieee754);
		else if (xstrcmp(argv, "iso8802-3"))
			return(MDOC_iso8802_3);
		else if (xstrcmp(argv, "xpg3"))
			return(MDOC_xpg3);
		else if (xstrcmp(argv, "xpg4"))
			return(MDOC_xpg4);
		else if (xstrcmp(argv, "xpg4.2"))
			return(MDOC_xpg4_2);
		else if (xstrcmp(argv, "xpg4.3"))
			return(MDOC_xpg4_3);
		else if (xstrcmp(argv, "xbd5"))
			return(MDOC_xbd5);
		else if (xstrcmp(argv, "xcu5"))
			return(MDOC_xcu5);
		else if (xstrcmp(argv, "xsh5"))
			return(MDOC_xsh5);
		else if (xstrcmp(argv, "xns5"))
			return(MDOC_xns5);
		else if (xstrcmp(argv, "xns5.2d2.0"))
			return(MDOC_xns5_2d2_0);
		else if (xstrcmp(argv, "xcurses4.2"))
			return(MDOC_xcurses4_2);
		else if (xstrcmp(argv, "susv2"))
			return(MDOC_susv2);
		else if (xstrcmp(argv, "susv3"))
			return(MDOC_susv3);
		else if (xstrcmp(argv, "svid4"))
			return(MDOC_svid4);
		break;

	default:
		break;
	}

	return(MDOC_ARG_MAX);
}


static int
postparse(struct mdoc *mdoc, int line, const struct mdoc_arg *v, int pos)
{

	switch (v->arg) {
	case (MDOC_Offset):
		assert(v->value);
		assert(v->value[0]);
		if (xstrcmp(v->value[0], "left"))
			break;
		if (xstrcmp(v->value[0], "right"))
			break;
		if (xstrcmp(v->value[0], "center"))
			break;
		if (xstrcmp(v->value[0], "indent"))
			break;
		if (xstrcmp(v->value[0], "indent-two"))
			break;
		return(mdoc_perr(mdoc, line, pos, "invalid offset value"));
	default:
		break;
	}

	return(1);
}


static int
parse_multi(struct mdoc *mdoc, int line, 
		struct mdoc_arg *v, int *pos, char *buf)
{
	int		 c, ppos;
	char		*p;

	v->sz = 0;
	v->value = xcalloc(MDOC_LINEARG_MAX, sizeof(char *));

	ppos = *pos;

	for (v->sz = 0; v->sz < MDOC_LINEARG_MAX; v->sz++) {
		if ('-' == buf[*pos])
			break;
		c = mdoc_args(mdoc, line, pos, buf, ARGS_QUOTED, &p);
		if (ARGS_ERROR == c) {
			free(v->value);
			return(0);
		} else if (ARGS_EOLN == c)
			break;
		v->value[v->sz] = p;
	}

	if (0 < v->sz && v->sz < MDOC_LINEARG_MAX)
		return(1);

	free(v->value);
	return(mdoc_perr(mdoc, line, ppos, 0 == v->sz ?
				"argument requires a value" :
				"too many values to argument"));
}


static int
parse_single(struct mdoc *mdoc, int line, 
		struct mdoc_arg *v, int *pos, char *buf)
{
	int		 c, ppos;
	char		*p;

	ppos = *pos;

	c = mdoc_args(mdoc, line, pos, buf, ARGS_QUOTED, &p);
	if (ARGS_ERROR == c)
		return(0);
	if (ARGS_EOLN == c)
		return(mdoc_perr(mdoc, line, ppos,  "argument requires a value"));

	v->sz = 1;
	v->value = xcalloc(1, sizeof(char *));
	v->value[0] = p;
	return(1);
}


static int
parse(struct mdoc *mdoc, int line, 
		struct mdoc_arg *v, int *pos, char *buf)
{

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

	switch (v->arg) {
	case(MDOC_Std):
		/* FALLTHROUGH */
	case(MDOC_Width):
		/* FALLTHROUGH */
	case(MDOC_Offset):
		return(parse_single(mdoc, line, v, pos, buf));
	case(MDOC_Column):
		return(parse_multi(mdoc, line, v, pos, buf));
	default:
		break;
	}

	return(1);
}


int
mdoc_argv(struct mdoc *mdoc, int line, int tok,
		struct mdoc_arg *v, int *pos, char *buf)
{
	int		 i, ppos;
	char		*argv;

	(void)memset(v, 0, sizeof(struct mdoc_arg));

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

	assert( ! isspace((int)buf[*pos]));

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

	i = *pos;
	argv = &buf[++(*pos)];

	v->line = line;
	v->pos = *pos;

	assert(*pos > 0);
	while (buf[*pos]) {
		if (isspace((int)buf[*pos])) 
			if ('\\' != buf[*pos - 1])
				break;
		(*pos)++;
	}

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

	if (MDOC_ARG_MAX == (v->arg = lookup(tok, argv))) {
		if ( ! mdoc_pwarn(mdoc, line, i, WARN_SYNTAX, "argument-like parameter"))
			return(ARGV_ERROR);
		return(ARGV_WORD);
	}

	while (buf[*pos] && isspace((int)buf[*pos]))
		(*pos)++;

	/* FIXME: whitespace if no value. */

	ppos = *pos;
	if ( ! parse(mdoc, line, v, pos, buf))
		return(ARGV_ERROR);
	if ( ! postparse(mdoc, line, v, ppos))
		return(ARGV_ERROR);

	return(ARGV_ARG);
}


void
mdoc_argv_free(int sz, struct mdoc_arg *arg)
{
	int		 i;

	for (i = 0; i < sz; i++) {
		if (0 == arg[i].sz) {
			assert(NULL == arg[i].value);
			continue;
		}
		assert(arg[i].value);
		free(arg[i].value);
	}
}