summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--mdoc.736
-rw-r--r--mdoc_argv.c349
2 files changed, 192 insertions, 193 deletions
diff --git a/mdoc.7 b/mdoc.7
index 9298c221..49e1268e 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -131,6 +131,11 @@ also be text-decorated using the
.Sq \ef
escape followed by an indicator: B (bold), I, (italic), or P and R
(Roman, or reset). This form is not recommended.
+.Pp
+Lastly, a standalone double-quote may be produced in a macro line by
+using two consecutive double-quotes within a quoted literal. See
+.Sx Quotation
+for details.
.\" SUB-SECTION----------------------
.Ss Whitespace
In non-literal free-form lines, consecutive blocks of whitespace are
@@ -144,9 +149,7 @@ These are not.
.\" PARAGRAPH------------
.Pp
In macro lines, whitespace delimits arguments and is discarded. If
-arguments are quoted, whitespace is conditionally retained within the
-quotes.
-.\" TODO: which do and which don't?
+arguments are quoted, whitespace within the quotes is retained.
.\" PARAGRAPH------------
.Pp
Blank lines are only permitted within literal contexts, as are lines
@@ -159,7 +162,32 @@ or when in a literal context.
Macro arguments may be quoted with a double-quote to group
space-delimited terms or to retain blocks of whitespace. A quoted
argument begins with a double-quote preceded by whitespace. The next
-double-quote terminates the term, regardless of surrounding whitespace.
+double-quote that is
+.Em
+preceded by a double-quote terminates the term, regardless of
+surrounding whitespace. Thus, the following construction produces
+.Sq "a""b" ,
+since, as mentioned in
+.Sx Special Characters ,
+two consecutive double-quotes in a quoted literal produce a standalone
+double-quote:
+.Bd -literal -offset indent
+\&.Em "a""""b"
+.Ed
+.\" PARAGRAPH------------
+.Pp
+This produces tokens
+.Sq a" ,
+.Sq b c ,
+.Sq de ,
+and
+.Sq fg" .
+Note that any quoted term, be it argument or macro, is indiscriminately
+considered literal text. Thus, the following produces
+.Sq \&Em a :
+.Bd -literal -offset indent
+\&.Em "Em a"
+.Ed
.\" PARAGRAPH------------
.Pp
In free-form mode, quotes are regarded as opaque text.
diff --git a/mdoc_argv.c b/mdoc_argv.c
index 613bfa53..73388781 100644
--- a/mdoc_argv.c
+++ b/mdoc_argv.c
@@ -34,7 +34,6 @@
/* FIXME .Bf Li raises "macro-like parameter". */
-#define ARGS_QUOTED (1 << 0)
#define ARGS_DELIM (1 << 1)
#define ARGS_TABSEP (1 << 2)
@@ -93,34 +92,34 @@ static int mdoc_argflags[MDOC_MAX] = {
0, /* Dd */
0, /* Dt */
0, /* Os */
- ARGS_QUOTED, /* Sh */
- ARGS_QUOTED, /* Ss */
+ 0, /* Sh */
+ 0, /* Ss */
ARGS_DELIM, /* Pp */
ARGS_DELIM, /* D1 */
- ARGS_DELIM | ARGS_QUOTED, /* Dl */
+ ARGS_DELIM, /* Dl */
0, /* Bd */
0, /* Ed */
- ARGS_QUOTED, /* Bl */
+ 0, /* Bl */
0, /* El */
0, /* It */
ARGS_DELIM, /* Ad */
ARGS_DELIM, /* An */
- ARGS_DELIM | ARGS_QUOTED, /* Ar */
- ARGS_QUOTED, /* Cd */
+ ARGS_DELIM, /* Ar */
+ 0, /* Cd */
ARGS_DELIM, /* Cm */
ARGS_DELIM, /* Dv */
ARGS_DELIM, /* Er */
ARGS_DELIM, /* Ev */
0, /* Ex */
- ARGS_DELIM | ARGS_QUOTED, /* Fa */
+ ARGS_DELIM, /* Fa */
0, /* Fd */
ARGS_DELIM, /* Fl */
- ARGS_DELIM | ARGS_QUOTED, /* Fn */
- ARGS_DELIM | ARGS_QUOTED, /* Ft */
+ ARGS_DELIM, /* Fn */
+ ARGS_DELIM, /* Ft */
ARGS_DELIM, /* Ic */
0, /* In */
- ARGS_DELIM | ARGS_QUOTED, /* Li */
- ARGS_QUOTED, /* Nd */
+ ARGS_DELIM, /* Li */
+ 0, /* Nd */
ARGS_DELIM, /* Nm */
ARGS_DELIM, /* Op */
0, /* Ot */
@@ -130,17 +129,17 @@ static int mdoc_argflags[MDOC_MAX] = {
ARGS_DELIM, /* Va */
ARGS_DELIM, /* Vt */
ARGS_DELIM, /* Xr */
- ARGS_QUOTED, /* %A */
- ARGS_QUOTED, /* %B */
- ARGS_QUOTED, /* %D */
- ARGS_QUOTED, /* %I */
- ARGS_QUOTED, /* %J */
- ARGS_QUOTED, /* %N */
- ARGS_QUOTED, /* %O */
- ARGS_QUOTED, /* %P */
- ARGS_QUOTED, /* %R */
- ARGS_QUOTED, /* %T */
- ARGS_QUOTED, /* %V */
+ 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 */
@@ -180,12 +179,12 @@ static int mdoc_argflags[MDOC_MAX] = {
ARGS_DELIM, /* Sq */
0, /* Sm */
ARGS_DELIM, /* Sx */
- ARGS_DELIM | ARGS_QUOTED, /* Sy */
+ ARGS_DELIM, /* Sy */
ARGS_DELIM, /* Tn */
ARGS_DELIM, /* Ux */
ARGS_DELIM, /* Xc */
0, /* Xo */
- ARGS_QUOTED, /* Fo */
+ 0, /* Fo */
0, /* Fc */
0, /* Oo */
ARGS_DELIM, /* Oc */
@@ -197,16 +196,16 @@ static int mdoc_argflags[MDOC_MAX] = {
0, /* Ud */
0, /* Lb */
ARGS_DELIM, /* Lp */
- ARGS_DELIM | ARGS_QUOTED, /* Lk */
- ARGS_DELIM | ARGS_QUOTED, /* Mt */
+ ARGS_DELIM, /* Lk */
+ ARGS_DELIM, /* Mt */
ARGS_DELIM, /* Brq */
0, /* Bro */
ARGS_DELIM, /* Brc */
- ARGS_QUOTED, /* %C */
+ 0, /* %C */
0, /* Es */
0, /* En */
0, /* Dx */
- ARGS_QUOTED, /* %Q */
+ 0, /* %Q */
0, /* br */
0, /* sp */
};
@@ -336,46 +335,28 @@ mdoc_args(struct mdoc *m, int line,
fl = (0 == tok) ? 0 : mdoc_argflags[tok];
+ if (MDOC_It != tok)
+ return(args(m, line, pos, buf, fl, v));
+
/*
- * Override per-macro argument flags with context-specific ones.
- * As of now, this is only valid for `It' depending on its list
- * context.
+ * The `It' macro is a special case, as it acquires parameters from its
+ * parent `Bl' context, specifically, we're concerned with -column.
*/
- switch (tok) {
- case (MDOC_It):
- 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);
+ for (n = m->last; n; n = n->parent)
+ if (MDOC_BLOCK == n->type && MDOC_Bl == n->tok)
+ break;
- /*
- * Using `Bl -column' adds ARGS_TABSEP to the arguments
- * and invalidates ARGS_DELIM. Using `Bl -diag' allows
- * for quoted arguments.
- */
+ assert(n);
+ c = (int)(n->args ? n->args->argc : 0);
+ assert(c > 0);
- /* LINTED */
- for (i = 0; i < c; i++) {
- switch (n->args->argv[i].arg) {
- case (MDOC_Column):
- fl |= ARGS_TABSEP;
- fl &= ~ARGS_DELIM;
- i = c;
- break;
- case (MDOC_Diag):
- fl |= ARGS_QUOTED;
- i = c;
- break;
- default:
- break;
- }
- }
- break;
- default:
+ /* LINTED */
+ for (i = 0; i < c; i++) {
+ if (MDOC_Column != n->args->argv[i].arg)
+ continue;
+ fl |= ARGS_TABSEP;
+ fl &= ~ARGS_DELIM;
break;
}
@@ -390,15 +371,12 @@ args(struct mdoc *m, int line, int *pos,
int i;
char *p, *pp;
- assert(*pos > 0);
+ assert(*pos);
+ assert(' ' != buf[*pos]);
if (0 == buf[*pos])
return(ARGS_EOLN);
- if ('\"' == buf[*pos] && ! (fl & ARGS_QUOTED))
- if ( ! mdoc_pwarn(m, line, *pos, EQUOTPARM))
- return(ARGS_ERROR);
-
/*
* If the first character is a delimiter and we're to look for
* delimited strings, then pass down the buffer seeing if it
@@ -410,167 +388,160 @@ args(struct mdoc *m, int line, int *pos,
if ( ! mdoc_iscdelim(buf[i]))
break;
i++;
- /* There must be at least one space... */
if (0 == buf[i] || ' ' != buf[i])
break;
i++;
while (buf[i] && ' ' == buf[i])
i++;
}
+
+ /* FIXME: warn about trailing whitespace. */
+
if (0 == buf[i]) {
*v = &buf[*pos];
return(ARGS_PUNCT);
}
}
- /* First parse non-quoted strings. */
-
- if ('\"' != buf[*pos] || ! (ARGS_QUOTED & fl)) {
- *v = &buf[*pos];
-
- /*
- * Thar be dragons here! If we're tab-separated, search
- * ahead for either a tab or the `Ta' macro.
- * If a `Ta' is detected, it must be space-buffered before and
- * after. If either of these hold true, then prune out the
- * extra spaces and call it an argument.
- */
-
- if (ARGS_TABSEP & fl) {
- /* Scan ahead to unescaped tab. */
-
- 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;
- }
+ *v = &buf[*pos];
- /* Choose delimiter tab/Ta. */
+ /*
+ * 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 (p && pp)
- p = (p < pp ? p : pp);
- else if ( ! p && pp)
- p = pp;
+ if (ARGS_TABSEP & fl) {
+ /* Scan ahead to unescaped tab. */
+ p = strchr(*v, '\t');
- /* Strip delimiter's preceding whitespace. */
+ /* 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 (p && p > *v) {
- pp = p - 1;
- while (pp > *v && ' ' == *pp)
- pp--;
- if (pp == *v && ' ' == *pp)
- *pp = 0;
- else if (' ' == *pp)
- *(pp + 1) = 0;
- }
+ /* Choose delimiter tab/Ta. */
+ if (p && pp)
+ p = (p < pp ? p : pp);
+ else if ( ! p && pp)
+ p = pp;
+
+ /* Strip delimiter's preceding whitespace. */
+ /* FIXME: escaped whitespace? */
+ if (p && p > *v) {
+ pp = p - 1;
+ while (pp > *v && ' ' == *pp)
+ pp--;
+ if (pp == *v && ' ' == *pp)
+ *pp = 0;
+ else if (' ' == *pp)
+ *(pp + 1) = 0;
+ }
- /* ...in- and proceding whitespace. */
+ /* ...in- and proceding whitespace. */
+ if (p && ('\t' != *p)) {
+ *p++ = 0;
+ *p++ = 0;
+ } else if (p)
+ *p++ = 0;
+
+ if (p) {
+ while (' ' == *p)
+ p++;
+ if (0 != *p)
+ *(p - 1) = 0;
+ *pos += (int)(p - *v);
+ }
- if (p && ('\t' != *p)) {
- *p++ = 0;
- *p++ = 0;
- } else if (p)
- *p++ = 0;
+ /* Some warnings, if applicable. */
+ if (p && 0 == *p)
+ if ( ! mdoc_pwarn(m, line, *pos, ECOLEMPTY))
+ return(ARGS_ERROR);
+ if (p && 0 == *p && p > *v && ' ' == *(p - 1))
+ if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ return(ARGS_ERROR);
- if (p) {
- while (' ' == *p)
- p++;
- if (0 != *p)
- *(p - 1) = 0;
- *pos += (int)(p - *v);
- }
+ /* Non-eoln case returns now. */
+ if (p)
+ return(ARGS_PHRASE);
- if (p && 0 == *p)
- if ( ! mdoc_pwarn(m, line, *pos, ECOLEMPTY))
- return(ARGS_ERROR);
- if (p && 0 == *p && p > *v && ' ' == *(p - 1))
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
- return(ARGS_ERROR);
+ /* Configure the eoln case, too. */
+ p = strchr(*v, 0);
+ assert(p);
- if (p)
- return(ARGS_PHRASE);
+ if (p > *v && ' ' == *(p - 1))
+ if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ return(ARGS_ERROR);
+ *pos += (int)(p - *v);
- /* Configure the eoln case, too. */
+ return(ARGS_PHRASE);
+ }
- p = strchr(*v, 0);
- assert(p);
+ /*
+ * 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 (p > *v && ' ' == *(p - 1))
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
- return(ARGS_ERROR);
- *pos += (int)(p - *v);
+ if ('\"' == buf[*pos]) {
+ *v = &buf[++(*pos)];
- return(ARGS_PHRASE);
- }
-
- /* Do non-tabsep look-ahead here. */
-
- if ( ! (ARGS_TABSEP & fl))
- while (buf[*pos]) {
- if (' ' == buf[*pos])
- if ('\\' != buf[*pos - 1])
- break;
- (*pos)++;
- }
+ for ( ; buf[*pos]; (*pos)++) {
+ if ('\"' != buf[*pos])
+ continue;
+ if ('\"' != buf[*pos + 1])
+ break;
+ (*pos)++;
+ }
- if (0 == buf[*pos])
- return(ARGS_WORD);
+ if (0 == buf[*pos]) {
+ (void)mdoc_perr(m, line, *pos, EQUOTTERM);
+ return(ARGS_ERROR);
+ }
buf[(*pos)++] = 0;
if (0 == buf[*pos])
- return(ARGS_WORD);
+ return(ARGS_QWORD);
- if ( ! (ARGS_TABSEP & fl))
- while (buf[*pos] && ' ' == buf[*pos])
- (*pos)++;
+ while (' ' == buf[*pos])
+ (*pos)++;
- if (buf[*pos])
- return(ARGS_WORD);
-
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
- return(ARGS_ERROR);
+ if (0 == buf[*pos])
+ if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ return(ARGS_ERROR);
- return(ARGS_WORD);
+ return(ARGS_QWORD);
}
- /*
- * 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.
+ /*
+ * A non-quoted term progresses until either the end of line or
+ * a non-escaped whitespace.
*/
- *v = &buf[++(*pos)];
-
- while (buf[*pos] && '\"' != buf[*pos])
- (*pos)++;
+ for ( ; buf[*pos]; (*pos)++)
+ if (' ' == buf[*pos] && '\\' != buf[*pos - 1])
+ break;
- if (0 == buf[*pos]) {
- (void)mdoc_perr(m, line, *pos, EQUOTTERM);
- return(ARGS_ERROR);
- }
+ if (0 == buf[*pos])
+ return(ARGS_WORD);
buf[(*pos)++] = 0;
- if (0 == buf[*pos])
- return(ARGS_QWORD);
- while (buf[*pos] && ' ' == buf[*pos])
+ while (' ' == buf[*pos])
(*pos)++;
- if (buf[*pos])
- return(ARGS_QWORD);
-
- if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
- return(ARGS_ERROR);
+ if (0 == buf[*pos])
+ if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+ return(ARGS_ERROR);
- return(ARGS_QWORD);
+ return(ARGS_WORD);
}
@@ -682,7 +653,7 @@ argv_multi(struct mdoc *m, int line,
for (v->sz = 0; ; v->sz++) {
if ('-' == buf[*pos])
break;
- c = args(m, line, pos, buf, ARGS_QUOTED, &p);
+ c = args(m, line, pos, buf, 0, &p);
if (ARGS_ERROR == c)
return(0);
else if (ARGS_EOLN == c)
@@ -714,7 +685,7 @@ argv_opt_single(struct mdoc *m, int line,
if ('-' == buf[*pos])
return(1);
- c = args(m, line, pos, buf, ARGS_QUOTED, &p);
+ c = args(m, line, pos, buf, 0, &p);
if (ARGS_ERROR == c)
return(0);
if (ARGS_EOLN == c)
@@ -742,7 +713,7 @@ argv_single(struct mdoc *m, int line,
ppos = *pos;
- c = args(m, line, pos, buf, ARGS_QUOTED, &p);
+ c = args(m, line, pos, buf, 0, &p);
if (ARGS_ERROR == c)
return(0);
if (ARGS_EOLN == c)