]>
git.cameronkatri.com Git - mandoc.git/blob - argv.c
1 /* $Id: argv.c,v 1.55 2009/03/21 21:09:00 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the
7 * above copyright notice and this permission notice appear in all
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 * PERFORMANCE OF THIS SOFTWARE.
19 #include <sys/types.h>
31 * Routines to parse arguments of macros. Arguments follow the syntax
32 * of `-arg [val [valN...]]'. Arguments come in all types: quoted
33 * arguments, multiple arguments per value, no-value arguments, etc.
35 * There's no limit to the number or arguments that may be allocated.
38 #define ARGS_QUOTED (1 << 0)
39 #define ARGS_DELIM (1 << 1)
40 #define ARGS_TABSEP (1 << 2)
41 #define ARGS_ARGVLIKE (1 << 3)
43 #define ARGV_NONE (1 << 0)
44 #define ARGV_SINGLE (1 << 1)
45 #define ARGV_MULTI (1 << 2)
46 #define ARGV_OPT_SINGLE (1 << 3)
62 static int argv_a2arg(int, const char *);
63 static int args(struct mdoc
*, int, int *,
64 char *, int, char **);
65 static int argv(struct mdoc
*, int,
66 struct mdoc_argv
*, int *, char *);
67 static int argv_single(struct mdoc
*, int,
68 struct mdoc_argv
*, int *, char *);
69 static int argv_opt_single(struct mdoc
*, int,
70 struct mdoc_argv
*, int *, char *);
71 static int argv_multi(struct mdoc
*, int,
72 struct mdoc_argv
*, int *, char *);
73 static int pwarn(struct mdoc
*, int, int, enum mwarn
);
74 static int perr(struct mdoc
*, int, int, enum merr
);
76 /* Per-argument flags. */
78 static int mdoc_argvflags
[MDOC_ARG_MAX
] = {
79 ARGV_NONE
, /* MDOC_Split */
80 ARGV_NONE
, /* MDOC_Nosplit */
81 ARGV_NONE
, /* MDOC_Ragged */
82 ARGV_NONE
, /* MDOC_Unfilled */
83 ARGV_NONE
, /* MDOC_Literal */
84 ARGV_NONE
, /* MDOC_File */
85 ARGV_SINGLE
, /* MDOC_Offset */
86 ARGV_NONE
, /* MDOC_Bullet */
87 ARGV_NONE
, /* MDOC_Dash */
88 ARGV_NONE
, /* MDOC_Hyphen */
89 ARGV_NONE
, /* MDOC_Item */
90 ARGV_NONE
, /* MDOC_Enum */
91 ARGV_NONE
, /* MDOC_Tag */
92 ARGV_NONE
, /* MDOC_Diag */
93 ARGV_NONE
, /* MDOC_Hang */
94 ARGV_NONE
, /* MDOC_Ohang */
95 ARGV_NONE
, /* MDOC_Inset */
96 ARGV_MULTI
, /* MDOC_Column */
97 ARGV_SINGLE
, /* MDOC_Width */
98 ARGV_NONE
, /* MDOC_Compact */
99 ARGV_OPT_SINGLE
, /* MDOC_Std */
100 ARGV_NONE
, /* MDOC_Filled */
101 ARGV_NONE
, /* MDOC_Words */
102 ARGV_NONE
, /* MDOC_Emphasis */
103 ARGV_NONE
, /* MDOC_Symbolic */
104 ARGV_NONE
/* MDOC_Symbolic */
107 static int mdoc_argflags
[MDOC_MAX
] = {
125 ARGS_QUOTED
, /* Cd */
131 ARGS_DELIM
| ARGS_QUOTED
, /* Fa */
134 ARGS_DELIM
| ARGS_QUOTED
, /* Fn */
135 ARGS_DELIM
| ARGS_QUOTED
, /* Ft */
145 ARGS_DELIM
| ARGS_ARGVLIKE
, /* St */
149 ARGS_QUOTED
, /* %A */
150 ARGS_QUOTED
, /* %B */
151 ARGS_QUOTED
, /* %D */
152 ARGS_QUOTED
, /* %I */
153 ARGS_QUOTED
, /* %J */
154 ARGS_QUOTED
, /* %N */
155 ARGS_QUOTED
, /* %O */
156 ARGS_QUOTED
, /* %P */
157 ARGS_QUOTED
, /* %R */
158 ARGS_QUOTED
, /* %T */
159 ARGS_QUOTED
, /* %V */
168 ARGS_DELIM
, /* Bsx */
217 ARGS_DELIM
| ARGS_QUOTED
, /* Lk */
218 ARGS_DELIM
| ARGS_QUOTED
, /* Mt */
219 ARGS_DELIM
, /* Brq */
221 ARGS_DELIM
, /* Brc */
222 ARGS_QUOTED
, /* %C */
226 ARGS_QUOTED
, /* %Q */
231 * Parse an argument from line text. This comes in the form of -key
232 * [value0...], which may either have a single mandatory value, at least
233 * one mandatory value, an optional single value, or no value.
236 mdoc_argv(struct mdoc
*mdoc
, int line
, int tok
,
237 struct mdoc_arg
**v
, int *pos
, char *buf
)
241 struct mdoc_argv tmp
;
242 struct mdoc_arg
*arg
;
247 assert(' ' != buf
[*pos
]);
249 if ('-' != buf
[*pos
] || ARGS_ARGVLIKE
& mdoc_argflags
[tok
])
252 /* Parse through to the first unescaped space. */
261 if (' ' == buf
[*pos
])
262 if ('\\' != buf
[*pos
- 1])
267 /* XXX - save zeroed byte, if not an argument. */
275 (void)memset(&tmp
, 0, sizeof(struct mdoc_argv
));
279 /* See if our token accepts the argument. */
281 if (MDOC_ARG_MAX
== (tmp
.arg
= argv_a2arg(tok
, p
))) {
282 /* XXX - restore saved zeroed byte. */
285 if ( ! pwarn(mdoc
, line
, i
, WARGVPARM
))
290 while (buf
[*pos
] && ' ' == buf
[*pos
])
293 if ( ! argv(mdoc
, line
, &tmp
, pos
, buf
))
296 if (NULL
== (arg
= *v
)) {
297 *v
= xcalloc(1, sizeof(struct mdoc_arg
));
302 arg
->argv
= xrealloc(arg
->argv
, arg
->argc
*
303 sizeof(struct mdoc_argv
));
305 (void)memcpy(&arg
->argv
[(int)arg
->argc
- 1],
306 &tmp
, sizeof(struct mdoc_argv
));
313 mdoc_argv_free(struct mdoc_arg
*p
)
329 for (i
= 0; i
< (int)p
->argc
; i
++) {
330 if (0 == p
->argv
[i
].sz
)
333 for (j
= 0; j
< (int)p
->argv
[i
].sz
; j
++)
334 free(p
->argv
[i
].value
[j
]);
336 free(p
->argv
[i
].value
);
346 perr(struct mdoc
*mdoc
, int line
, int pos
, enum merr code
)
354 p
= "unterminated quoted parameter";
357 p
= "argument requires a value";
362 return(mdoc_perr(mdoc
, line
, pos
, p
));
367 pwarn(struct mdoc
*mdoc
, int line
, int pos
, enum mwarn code
)
377 p
= "unexpected quoted parameter";
380 p
= "argument-like parameter";
383 p
= "last list column is empty";
387 p
= "trailing whitespace";
393 return(mdoc_pwarn(mdoc
, line
, pos
, c
, p
));
398 mdoc_args(struct mdoc
*mdoc
, int line
,
399 int *pos
, char *buf
, int tok
, char **v
)
404 fl
= (0 == tok
) ? 0 : mdoc_argflags
[tok
];
407 * Override per-macro argument flags with context-specific ones.
408 * As of now, this is only valid for `It' depending on its list
414 for (n
= mdoc
->last
; n
; n
= n
->parent
)
415 if (MDOC_BLOCK
== n
->type
&& MDOC_Bl
== n
->tok
)
419 c
= (int)(n
->args
? n
->args
->argc
: 0);
423 * Using `Bl -column' adds ARGS_TABSEP to the arguments
424 * and invalidates ARGS_DELIM. Using `Bl -diag' allows
425 * for quoted arguments.
429 for (i
= 0; i
< c
; i
++) {
430 switch (n
->args
->argv
[i
].arg
) {
449 return(args(mdoc
, line
, pos
, buf
, fl
, v
));
454 args(struct mdoc
*mdoc
, int line
,
455 int *pos
, char *buf
, int fl
, char **v
)
465 if ('\"' == buf
[*pos
] && ! (fl
& ARGS_QUOTED
))
466 if ( ! pwarn(mdoc
, line
, *pos
, WQUOTPARM
))
469 if ( ! (fl
& ARGS_ARGVLIKE
) && '-' == buf
[*pos
])
470 if ( ! pwarn(mdoc
, line
, *pos
, WARGVPARM
))
474 * If the first character is a delimiter and we're to look for
475 * delimited strings, then pass down the buffer seeing if it
476 * follows the pattern of [[::delim::][ ]+]+.
479 if ((fl
& ARGS_DELIM
) && mdoc_iscdelim(buf
[*pos
])) {
480 for (i
= *pos
; buf
[i
]; ) {
481 if ( ! mdoc_iscdelim(buf
[i
]))
484 /* There must be at least one space... */
485 if (0 == buf
[i
] || ' ' != buf
[i
])
488 while (buf
[i
] && ' ' == buf
[i
])
497 /* First parse non-quoted strings. */
499 if ('\"' != buf
[*pos
] || ! (ARGS_QUOTED
& fl
)) {
503 * Thar be dragons here! If we're tab-separated, search
504 * ahead for either a tab or the `Ta' macro.
505 * If a `Ta' is detected, it must be space-buffered before and
506 * after. If either of these hold true, then prune out the
507 * extra spaces and call it an argument.
510 if (ARGS_TABSEP
& fl
) {
511 /* Scan ahead to unescaped tab. */
513 p
= strchr(*v
, '\t');
515 /* Scan ahead to unescaped `Ta'. */
517 for (pp
= *v
; ; pp
++) {
518 if (NULL
== (pp
= strstr(pp
, "Ta")))
520 if (pp
> *v
&& ' ' != *(pp
- 1))
522 if (' ' == *(pp
+ 2) || 0 == *(pp
+ 2))
526 /* Choose delimiter tab/Ta. */
529 p
= (p
< pp
? p
: pp
);
533 /* Strip delimiter's preceding whitespace. */
537 while (pp
> *v
&& ' ' == *pp
)
539 if (pp
== *v
&& ' ' == *pp
)
545 /* ...in- and proceding whitespace. */
547 if (p
&& ('\t' != *p
)) {
558 *pos
+= (int)(p
- *v
);
562 if ( ! pwarn(mdoc
, line
, *pos
, WCOLEMPTY
))
564 if (p
&& 0 == *p
&& p
> *v
&& ' ' == *(p
- 1))
565 if ( ! pwarn(mdoc
, line
, *pos
, WTAILWS
))
571 /* Configure the eoln case, too. */
576 if (p
> *v
&& ' ' == *(p
- 1))
577 if ( ! pwarn(mdoc
, line
, *pos
, WTAILWS
))
579 *pos
+= (int)(p
- *v
);
584 /* Do non-tabsep look-ahead here. */
586 if ( ! (ARGS_TABSEP
& fl
))
588 if (' ' == buf
[*pos
])
589 if ('\\' != buf
[*pos
- 1])
602 if ( ! (ARGS_TABSEP
& fl
))
603 while (buf
[*pos
] && ' ' == buf
[*pos
])
609 if ( ! pwarn(mdoc
, line
, *pos
, WTAILWS
))
616 * If we're a quoted string (and quoted strings are allowed),
617 * then parse ahead to the next quote. If none's found, it's an
618 * error. After, parse to the next word.
623 while (buf
[*pos
] && '\"' != buf
[*pos
])
626 if (0 == buf
[*pos
]) {
627 (void)perr(mdoc
, line
, *pos
, EQUOTTERM
);
635 while (buf
[*pos
] && ' ' == buf
[*pos
])
641 if ( ! pwarn(mdoc
, line
, *pos
, WTAILWS
))
649 argv_a2arg(int tok
, const char *argv
)
653 * Parse an argument identifier from its text. XXX - this
654 * should really be table-driven to clarify the code.
656 * If you add an argument to the list, make sure that you
657 * register it here with its one or more macros!
662 if (xstrcmp(argv
, "split"))
664 else if (xstrcmp(argv
, "nosplit"))
665 return(MDOC_Nosplit
);
669 if (xstrcmp(argv
, "ragged"))
671 else if (xstrcmp(argv
, "unfilled"))
672 return(MDOC_Unfilled
);
673 else if (xstrcmp(argv
, "filled"))
675 else if (xstrcmp(argv
, "literal"))
676 return(MDOC_Literal
);
677 else if (xstrcmp(argv
, "file"))
679 else if (xstrcmp(argv
, "offset"))
681 else if (xstrcmp(argv
, "compact"))
682 return(MDOC_Compact
);
686 if (xstrcmp(argv
, "emphasis"))
687 return(MDOC_Emphasis
);
688 else if (xstrcmp(argv
, "literal"))
689 return(MDOC_Literal
);
690 else if (xstrcmp(argv
, "symbolic"))
691 return(MDOC_Symbolic
);
695 if (xstrcmp(argv
, "words"))
700 if (xstrcmp(argv
, "bullet"))
702 else if (xstrcmp(argv
, "dash"))
704 else if (xstrcmp(argv
, "hyphen"))
706 else if (xstrcmp(argv
, "item"))
708 else if (xstrcmp(argv
, "enum"))
710 else if (xstrcmp(argv
, "tag"))
712 else if (xstrcmp(argv
, "diag"))
714 else if (xstrcmp(argv
, "hang"))
716 else if (xstrcmp(argv
, "ohang"))
718 else if (xstrcmp(argv
, "inset"))
720 else if (xstrcmp(argv
, "column"))
722 else if (xstrcmp(argv
, "width"))
724 else if (xstrcmp(argv
, "offset"))
726 else if (xstrcmp(argv
, "compact"))
727 return(MDOC_Compact
);
728 else if (xstrcmp(argv
, "nested"))
735 if (xstrcmp(argv
, "std"))
742 return(MDOC_ARG_MAX
);
747 argv_multi(struct mdoc
*mdoc
, int line
,
748 struct mdoc_argv
*v
, int *pos
, char *buf
)
755 for (v
->sz
= 0; ; v
->sz
++) {
756 if ('-' == buf
[*pos
])
758 c
= args(mdoc
, line
, pos
, buf
, ARGS_QUOTED
, &p
);
761 else if (ARGS_EOLN
== c
)
764 if (0 == v
->sz
% MULTI_STEP
)
765 v
->value
= xrealloc(v
->value
,
766 (v
->sz
+ MULTI_STEP
) * sizeof(char *));
768 v
->value
[(int)v
->sz
] = xstrdup(p
);
774 return(perr(mdoc
, line
, ppos
, EARGVAL
));
779 argv_opt_single(struct mdoc
*mdoc
, int line
,
780 struct mdoc_argv
*v
, int *pos
, char *buf
)
785 if ('-' == buf
[*pos
])
788 c
= args(mdoc
, line
, pos
, buf
, ARGS_QUOTED
, &p
);
795 v
->value
= xcalloc(1, sizeof(char *));
796 v
->value
[0] = xstrdup(p
);
802 * Parse a single, mandatory value from the stream.
805 argv_single(struct mdoc
*mdoc
, int line
,
806 struct mdoc_argv
*v
, int *pos
, char *buf
)
813 c
= args(mdoc
, line
, pos
, buf
, ARGS_QUOTED
, &p
);
817 return(perr(mdoc
, line
, ppos
, EARGVAL
));
820 v
->value
= xcalloc(1, sizeof(char *));
821 v
->value
[0] = xstrdup(p
);
827 * Determine rules for parsing arguments. Arguments can either accept
828 * no parameters, an optional single parameter, one parameter, or
829 * multiple parameters.
832 argv(struct mdoc
*mdoc
, int line
,
833 struct mdoc_argv
*v
, int *pos
, char *buf
)
839 switch (mdoc_argvflags
[v
->arg
]) {
841 return(argv_single(mdoc
, line
, v
, pos
, buf
));
843 return(argv_multi(mdoc
, line
, v
, pos
, buf
));
844 case (ARGV_OPT_SINGLE
):
845 return(argv_opt_single(mdoc
, line
, v
, pos
, buf
));