xref: /minix3/external/bsd/mdocml/dist/tbl_opts.c (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc /*	Id: tbl_opts.c,v 1.12 2011/09/18 14:14:15 schwarze Exp  */
2d65f6f70SBen Gras /*
392395e9cSLionel Sambuc  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4d65f6f70SBen Gras  *
5d65f6f70SBen Gras  * Permission to use, copy, modify, and distribute this software for any
6d65f6f70SBen Gras  * purpose with or without fee is hereby granted, provided that the above
7d65f6f70SBen Gras  * copyright notice and this permission notice appear in all copies.
8d65f6f70SBen Gras  *
9d65f6f70SBen Gras  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10d65f6f70SBen Gras  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11d65f6f70SBen Gras  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12d65f6f70SBen Gras  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13d65f6f70SBen Gras  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14d65f6f70SBen Gras  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15d65f6f70SBen Gras  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16d65f6f70SBen Gras  */
1792395e9cSLionel Sambuc #ifdef HAVE_CONFIG_H
1892395e9cSLionel Sambuc #include "config.h"
1992395e9cSLionel Sambuc #endif
2092395e9cSLionel Sambuc 
21d65f6f70SBen Gras #include <ctype.h>
22d65f6f70SBen Gras #include <stdio.h>
23d65f6f70SBen Gras #include <stdlib.h>
24d65f6f70SBen Gras #include <string.h>
25d65f6f70SBen Gras 
26d65f6f70SBen Gras #include "mandoc.h"
2792395e9cSLionel Sambuc #include "libmandoc.h"
28d65f6f70SBen Gras #include "libroff.h"
29d65f6f70SBen Gras 
30d65f6f70SBen Gras enum	tbl_ident {
31d65f6f70SBen Gras 	KEY_CENTRE = 0,
32d65f6f70SBen Gras 	KEY_DELIM,
33d65f6f70SBen Gras 	KEY_EXPAND,
34d65f6f70SBen Gras 	KEY_BOX,
35d65f6f70SBen Gras 	KEY_DBOX,
36d65f6f70SBen Gras 	KEY_ALLBOX,
37d65f6f70SBen Gras 	KEY_TAB,
38d65f6f70SBen Gras 	KEY_LINESIZE,
39d65f6f70SBen Gras 	KEY_NOKEEP,
40d65f6f70SBen Gras 	KEY_DPOINT,
41d65f6f70SBen Gras 	KEY_NOSPACE,
42d65f6f70SBen Gras 	KEY_FRAME,
43d65f6f70SBen Gras 	KEY_DFRAME,
44d65f6f70SBen Gras 	KEY_MAX
45d65f6f70SBen Gras };
46d65f6f70SBen Gras 
47d65f6f70SBen Gras struct	tbl_phrase {
48d65f6f70SBen Gras 	const char	*name;
49d65f6f70SBen Gras 	int		 key;
50d65f6f70SBen Gras 	enum tbl_ident	 ident;
51d65f6f70SBen Gras };
52d65f6f70SBen Gras 
53d65f6f70SBen Gras /* Handle Commonwealth/American spellings. */
54d65f6f70SBen Gras #define	KEY_MAXKEYS	 14
55d65f6f70SBen Gras 
56d65f6f70SBen Gras /* Maximum length of key name string. */
57d65f6f70SBen Gras #define	KEY_MAXNAME	 13
58d65f6f70SBen Gras 
59d65f6f70SBen Gras /* Maximum length of key number size. */
60d65f6f70SBen Gras #define	KEY_MAXNUMSZ	 10
61d65f6f70SBen Gras 
62d65f6f70SBen Gras static	const struct tbl_phrase keys[KEY_MAXKEYS] = {
63d65f6f70SBen Gras 	{ "center",	 TBL_OPT_CENTRE,	KEY_CENTRE},
64d65f6f70SBen Gras 	{ "centre",	 TBL_OPT_CENTRE,	KEY_CENTRE},
65d65f6f70SBen Gras 	{ "delim",	 0,	       		KEY_DELIM},
66d65f6f70SBen Gras 	{ "expand",	 TBL_OPT_EXPAND,	KEY_EXPAND},
67d65f6f70SBen Gras 	{ "box",	 TBL_OPT_BOX,   	KEY_BOX},
68d65f6f70SBen Gras 	{ "doublebox",	 TBL_OPT_DBOX,  	KEY_DBOX},
69d65f6f70SBen Gras 	{ "allbox",	 TBL_OPT_ALLBOX,	KEY_ALLBOX},
70d65f6f70SBen Gras 	{ "frame",	 TBL_OPT_BOX,		KEY_FRAME},
71d65f6f70SBen Gras 	{ "doubleframe", TBL_OPT_DBOX,		KEY_DFRAME},
72d65f6f70SBen Gras 	{ "tab",	 0,			KEY_TAB},
73d65f6f70SBen Gras 	{ "linesize",	 0,			KEY_LINESIZE},
74d65f6f70SBen Gras 	{ "nokeep",	 TBL_OPT_NOKEEP,	KEY_NOKEEP},
75d65f6f70SBen Gras 	{ "decimalpoint", 0,			KEY_DPOINT},
76d65f6f70SBen Gras 	{ "nospaces",	 TBL_OPT_NOSPACE,	KEY_NOSPACE},
77d65f6f70SBen Gras };
78d65f6f70SBen Gras 
79d65f6f70SBen Gras static	int		 arg(struct tbl_node *, int,
80d65f6f70SBen Gras 				const char *, int *, enum tbl_ident);
81d65f6f70SBen Gras static	void		 opt(struct tbl_node *, int,
82d65f6f70SBen Gras 				const char *, int *);
83d65f6f70SBen Gras 
84d65f6f70SBen Gras static int
arg(struct tbl_node * tbl,int ln,const char * p,int * pos,enum tbl_ident key)85d65f6f70SBen Gras arg(struct tbl_node *tbl, int ln, const char *p, int *pos, enum tbl_ident key)
86d65f6f70SBen Gras {
87d65f6f70SBen Gras 	int		 i;
88d65f6f70SBen Gras 	char		 buf[KEY_MAXNUMSZ];
89d65f6f70SBen Gras 
90d65f6f70SBen Gras 	while (isspace((unsigned char)p[*pos]))
91d65f6f70SBen Gras 		(*pos)++;
92d65f6f70SBen Gras 
93d65f6f70SBen Gras 	/* Arguments always begin with a parenthesis. */
94d65f6f70SBen Gras 
95d65f6f70SBen Gras 	if ('(' != p[*pos]) {
9692395e9cSLionel Sambuc 		mandoc_msg(MANDOCERR_TBL, tbl->parse,
9792395e9cSLionel Sambuc 				ln, *pos, NULL);
98d65f6f70SBen Gras 		return(0);
99d65f6f70SBen Gras 	}
100d65f6f70SBen Gras 
101d65f6f70SBen Gras 	(*pos)++;
102d65f6f70SBen Gras 
103d65f6f70SBen Gras 	/*
104d65f6f70SBen Gras 	 * The arguments can be ANY value, so we can't just stop at the
105d65f6f70SBen Gras 	 * next close parenthesis (the argument can be a closed
106d65f6f70SBen Gras 	 * parenthesis itself).
107d65f6f70SBen Gras 	 */
108d65f6f70SBen Gras 
109d65f6f70SBen Gras 	switch (key) {
110d65f6f70SBen Gras 	case (KEY_DELIM):
111d65f6f70SBen Gras 		if ('\0' == p[(*pos)++]) {
11292395e9cSLionel Sambuc 			mandoc_msg(MANDOCERR_TBL, tbl->parse,
11392395e9cSLionel Sambuc 					ln, *pos - 1, NULL);
114d65f6f70SBen Gras 			return(0);
115d65f6f70SBen Gras 		}
116d65f6f70SBen Gras 
117d65f6f70SBen Gras 		if ('\0' == p[(*pos)++]) {
11892395e9cSLionel Sambuc 			mandoc_msg(MANDOCERR_TBL, tbl->parse,
11992395e9cSLionel Sambuc 					ln, *pos - 1, NULL);
120d65f6f70SBen Gras 			return(0);
121d65f6f70SBen Gras 		}
122d65f6f70SBen Gras 		break;
123d65f6f70SBen Gras 	case (KEY_TAB):
124d65f6f70SBen Gras 		if ('\0' != (tbl->opts.tab = p[(*pos)++]))
125d65f6f70SBen Gras 			break;
126d65f6f70SBen Gras 
12792395e9cSLionel Sambuc 		mandoc_msg(MANDOCERR_TBL, tbl->parse,
12892395e9cSLionel Sambuc 				ln, *pos - 1, NULL);
129d65f6f70SBen Gras 		return(0);
130d65f6f70SBen Gras 	case (KEY_LINESIZE):
131d65f6f70SBen Gras 		for (i = 0; i < KEY_MAXNUMSZ && p[*pos]; i++, (*pos)++) {
132d65f6f70SBen Gras 			buf[i] = p[*pos];
133d65f6f70SBen Gras 			if ( ! isdigit((unsigned char)buf[i]))
134d65f6f70SBen Gras 				break;
135d65f6f70SBen Gras 		}
136d65f6f70SBen Gras 
137d65f6f70SBen Gras 		if (i < KEY_MAXNUMSZ) {
138d65f6f70SBen Gras 			buf[i] = '\0';
139d65f6f70SBen Gras 			tbl->opts.linesize = atoi(buf);
140d65f6f70SBen Gras 			break;
141d65f6f70SBen Gras 		}
142d65f6f70SBen Gras 
14392395e9cSLionel Sambuc 		mandoc_msg(MANDOCERR_TBL, tbl->parse, ln, *pos, NULL);
144d65f6f70SBen Gras 		return(0);
145d65f6f70SBen Gras 	case (KEY_DPOINT):
146d65f6f70SBen Gras 		if ('\0' != (tbl->opts.decimal = p[(*pos)++]))
147d65f6f70SBen Gras 			break;
148d65f6f70SBen Gras 
14992395e9cSLionel Sambuc 		mandoc_msg(MANDOCERR_TBL, tbl->parse,
15092395e9cSLionel Sambuc 				ln, *pos - 1, NULL);
151d65f6f70SBen Gras 		return(0);
152d65f6f70SBen Gras 	default:
153d65f6f70SBen Gras 		abort();
154d65f6f70SBen Gras 		/* NOTREACHED */
155d65f6f70SBen Gras 	}
156d65f6f70SBen Gras 
157d65f6f70SBen Gras 	/* End with a close parenthesis. */
158d65f6f70SBen Gras 
159d65f6f70SBen Gras 	if (')' == p[(*pos)++])
160d65f6f70SBen Gras 		return(1);
161d65f6f70SBen Gras 
16292395e9cSLionel Sambuc 	mandoc_msg(MANDOCERR_TBL, tbl->parse, ln, *pos - 1, NULL);
163d65f6f70SBen Gras 	return(0);
164d65f6f70SBen Gras }
165d65f6f70SBen Gras 
166d65f6f70SBen Gras static void
opt(struct tbl_node * tbl,int ln,const char * p,int * pos)167d65f6f70SBen Gras opt(struct tbl_node *tbl, int ln, const char *p, int *pos)
168d65f6f70SBen Gras {
169d65f6f70SBen Gras 	int		 i, sv;
170d65f6f70SBen Gras 	char		 buf[KEY_MAXNAME];
171d65f6f70SBen Gras 
172d65f6f70SBen Gras 	/*
173d65f6f70SBen Gras 	 * Parse individual options from the stream as surrounded by
174d65f6f70SBen Gras 	 * this goto.  Each pass through the routine parses out a single
175d65f6f70SBen Gras 	 * option and registers it.  Option arguments are processed in
176d65f6f70SBen Gras 	 * the arg() function.
177d65f6f70SBen Gras 	 */
178d65f6f70SBen Gras 
179d65f6f70SBen Gras again:	/*
180d65f6f70SBen Gras 	 * EBNF describing this section:
181d65f6f70SBen Gras 	 *
182d65f6f70SBen Gras 	 * options	::= option_list [:space:]* [;][\n]
183d65f6f70SBen Gras 	 * option_list	::= option option_tail
184d65f6f70SBen Gras 	 * option_tail	::= [:space:]+ option_list |
185d65f6f70SBen Gras 	 * 		::= epsilon
186d65f6f70SBen Gras 	 * option	::= [:alpha:]+ args
187d65f6f70SBen Gras 	 * args		::= [:space:]* [(] [:alpha:]+ [)]
188d65f6f70SBen Gras 	 */
189d65f6f70SBen Gras 
190d65f6f70SBen Gras 	while (isspace((unsigned char)p[*pos]))
191d65f6f70SBen Gras 		(*pos)++;
192d65f6f70SBen Gras 
193d65f6f70SBen Gras 	/* Safe exit point. */
194d65f6f70SBen Gras 
195d65f6f70SBen Gras 	if (';' == p[*pos])
196d65f6f70SBen Gras 		return;
197d65f6f70SBen Gras 
198d65f6f70SBen Gras 	/* Copy up to first non-alpha character. */
199d65f6f70SBen Gras 
200d65f6f70SBen Gras 	for (sv = *pos, i = 0; i < KEY_MAXNAME; i++, (*pos)++) {
20192395e9cSLionel Sambuc 		buf[i] = (char)tolower((unsigned char)p[*pos]);
202d65f6f70SBen Gras 		if ( ! isalpha((unsigned char)buf[i]))
203d65f6f70SBen Gras 			break;
204d65f6f70SBen Gras 	}
205d65f6f70SBen Gras 
206d65f6f70SBen Gras 	/* Exit if buffer is empty (or overrun). */
207d65f6f70SBen Gras 
208d65f6f70SBen Gras 	if (KEY_MAXNAME == i || 0 == i) {
20992395e9cSLionel Sambuc 		mandoc_msg(MANDOCERR_TBL, tbl->parse, ln, *pos, NULL);
210d65f6f70SBen Gras 		return;
211d65f6f70SBen Gras 	}
212d65f6f70SBen Gras 
213d65f6f70SBen Gras 	buf[i] = '\0';
214d65f6f70SBen Gras 
215d65f6f70SBen Gras 	while (isspace((unsigned char)p[*pos]))
216d65f6f70SBen Gras 		(*pos)++;
217d65f6f70SBen Gras 
218d65f6f70SBen Gras 	/*
219d65f6f70SBen Gras 	 * Look through all of the available keys to find one that
220d65f6f70SBen Gras 	 * matches the input.  FIXME: hashtable this.
221d65f6f70SBen Gras 	 */
222d65f6f70SBen Gras 
223d65f6f70SBen Gras 	for (i = 0; i < KEY_MAXKEYS; i++) {
224d65f6f70SBen Gras 		if (strcmp(buf, keys[i].name))
225d65f6f70SBen Gras 			continue;
226d65f6f70SBen Gras 
227d65f6f70SBen Gras 		/*
228d65f6f70SBen Gras 		 * Note: this is more difficult to recover from, as we
229d65f6f70SBen Gras 		 * can be anywhere in the option sequence and it's
230d65f6f70SBen Gras 		 * harder to jump to the next.  Meanwhile, just bail out
231d65f6f70SBen Gras 		 * of the sequence altogether.
232d65f6f70SBen Gras 		 */
233d65f6f70SBen Gras 
234d65f6f70SBen Gras 		if (keys[i].key)
235d65f6f70SBen Gras 			tbl->opts.opts |= keys[i].key;
236d65f6f70SBen Gras 		else if ( ! arg(tbl, ln, p, pos, keys[i].ident))
237d65f6f70SBen Gras 			return;
238d65f6f70SBen Gras 
239d65f6f70SBen Gras 		break;
240d65f6f70SBen Gras 	}
241d65f6f70SBen Gras 
242d65f6f70SBen Gras 	/*
243d65f6f70SBen Gras 	 * Allow us to recover from bad options by continuing to another
244d65f6f70SBen Gras 	 * parse sequence.
245d65f6f70SBen Gras 	 */
246d65f6f70SBen Gras 
247d65f6f70SBen Gras 	if (KEY_MAXKEYS == i)
24892395e9cSLionel Sambuc 		mandoc_msg(MANDOCERR_TBLOPT, tbl->parse, ln, sv, NULL);
249d65f6f70SBen Gras 
250d65f6f70SBen Gras 	goto again;
251d65f6f70SBen Gras 	/* NOTREACHED */
252d65f6f70SBen Gras }
253d65f6f70SBen Gras 
254d65f6f70SBen Gras int
tbl_option(struct tbl_node * tbl,int ln,const char * p)255d65f6f70SBen Gras tbl_option(struct tbl_node *tbl, int ln, const char *p)
256d65f6f70SBen Gras {
257d65f6f70SBen Gras 	int		 pos;
258d65f6f70SBen Gras 
259d65f6f70SBen Gras 	/*
260d65f6f70SBen Gras 	 * Table options are always on just one line, so automatically
261d65f6f70SBen Gras 	 * switch into the next input mode here.
262d65f6f70SBen Gras 	 */
263d65f6f70SBen Gras 	tbl->part = TBL_PART_LAYOUT;
264d65f6f70SBen Gras 
265d65f6f70SBen Gras 	pos = 0;
266d65f6f70SBen Gras 	opt(tbl, ln, p, &pos);
267d65f6f70SBen Gras 
268d65f6f70SBen Gras 	/* Always succeed. */
269d65f6f70SBen Gras 	return(1);
270d65f6f70SBen Gras }
271