=================================================================== RCS file: /cvs/mandoc/Attic/macro.c,v retrieving revision 1.7 retrieving revision 1.15 diff -u -p -r1.7 -r1.15 --- mandoc/Attic/macro.c 2008/12/28 00:34:20 1.7 +++ mandoc/Attic/macro.c 2008/12/30 19:06:03 1.15 @@ -1,4 +1,4 @@ -/* $Id: macro.c,v 1.7 2008/12/28 00:34:20 kristaps Exp $ */ +/* $Id: macro.c,v 1.15 2008/12/30 19:06:03 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,47 +21,31 @@ #include #include #include +#ifdef __linux__ +#include +#endif #include "private.h" +/* FIXME: maxlineargs should be per LINE, no per TOKEN. */ +/* FIXME: prologue check should be in macro_call. */ +/* FIXME: prologue macros should be part of macro_constant. */ + #define _CC(p) ((const char **)p) static int scope_rewind_exp(struct mdoc *, int, int, int); static int scope_rewind_imp(struct mdoc *, int, int); static int append_text(struct mdoc *, int, int, int, char *[]); +static int append_const(struct mdoc *, int, int, int, char *[]); +static int append_constarg(struct mdoc *, int, int, + int, const struct mdoc_arg *); static int append_scoped(struct mdoc *, int, int, int, const char *[], int, const struct mdoc_arg *); static int append_delims(struct mdoc *, int, int *, char *); static int -append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) -{ - int c, lastarg; - char *p; - - if (0 == buf[*pos]) - return(1); - - mdoc_msg(mdoc, *pos, "appending delimiters"); - - for (;;) { - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, 0, &p); - if (ARGS_ERROR == c) - return(0); - else if (ARGS_EOLN == c) - break; - assert(mdoc_isdelim(p)); - mdoc_word_alloc(mdoc, lastarg, p); - } - - return(1); -} - - -static int scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok) { struct mdoc_node *n; @@ -80,15 +64,8 @@ scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok) return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); } - if (n) { + if (n) mdoc->last = n; - mdoc_msg(mdoc, ppos, "scope: rewound implicit `%s'", - mdoc_macronames[tok]); - return(1); - } - - mdoc_msg(mdoc, ppos, "scope: new implicit `%s'", - mdoc_macronames[tok]); return(1); } @@ -109,66 +86,67 @@ scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); } - if (NULL == (mdoc->last = n)) - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX)); + if ((mdoc->last = n)) + return(1); + return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX)); +} - mdoc_msg(mdoc, ppos, "scope: rewound explicit `%s' to `%s'", - mdoc_macronames[tok], mdoc_macronames[dst]); +static int +append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) +{ + int c, lastarg; + char *p; + + if (0 == buf[*pos]) + return(1); + + for (;;) { + lastarg = *pos; + c = mdoc_args(mdoc, tok, pos, buf, 0, &p); + if (ARGS_ERROR == c) + return(0); + else if (ARGS_EOLN == c) + break; + assert(mdoc_isdelim(p)); + mdoc_word_alloc(mdoc, lastarg, p); + } + return(1); } static int +append_constarg(struct mdoc *mdoc, int tok, int pos, + int argc, const struct mdoc_arg *argv) +{ + + if ( ! mdoc_valid(mdoc, tok, pos, 0, NULL, argc, argv)) + return(0); + mdoc_elem_alloc(mdoc, pos, tok, argc, argv, 0, NULL); + return(1); +} + + +static int append_scoped(struct mdoc *mdoc, int tok, int pos, int sz, const char *args[], int argc, const struct mdoc_arg *argv) { enum mdoc_sec sec; - struct mdoc_node *node; + if ( ! mdoc_valid(mdoc, tok, pos, sz, args, argc, argv)) + return(0); + switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ case (MDOC_Sh): - if (0 == sz) - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); - sec = mdoc_atosec((size_t)sz, _CC(args)); - if (SEC_CUSTOM != sec && sec < mdoc->sec_lastn) - if ( ! mdoc_warn(mdoc, tok, pos, WARN_SEC_OO)) - return(0); - - if (SEC_BODY == mdoc->sec_last && SEC_NAME != sec) - return(mdoc_err(mdoc, tok, pos, ERR_SEC_NAME)); - if (SEC_CUSTOM != sec) mdoc->sec_lastn = sec; mdoc->sec_last = sec; break; - - case (MDOC_Ss): - if (0 == sz) - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); - break; - - case (MDOC_Bd): - assert(mdoc->last); - for (node = mdoc->last->parent; node; node = node->parent) { - if (node->type != MDOC_BLOCK) - continue; - if (node->data.block.tok != MDOC_Bd) - continue; - return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NONEST)); - } - break; - - case (MDOC_Bl): - break; - - /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ default: - abort(); - /* NOTREACHED */ + break; } mdoc_block_alloc(mdoc, pos, tok, (size_t)argc, argv); @@ -179,71 +157,44 @@ append_scoped(struct mdoc *mdoc, int tok, int pos, static int -append_text(struct mdoc *mdoc, int tok, +append_const(struct mdoc *mdoc, int tok, int pos, int sz, char *args[]) { - assert(sz >= 0); - args[sz] = NULL; + if ( ! mdoc_valid(mdoc, tok, pos, sz, _CC(args), 0, NULL)) + return(0); switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ - case (MDOC_Pp): + case (MDOC_At): if (0 == sz) break; - if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_EQ0)) - return(0); - break; + if (ATT_DEFAULT == mdoc_atoatt(args[0])) { + mdoc_elem_alloc(mdoc, pos, tok, + 0, NULL, 0, NULL); + mdoc_word_alloc(mdoc, pos, args[0]); + } else + mdoc_elem_alloc(mdoc, pos, tok, 0, + NULL, 1, _CC(&args[0])); - case (MDOC_Ft): - /* FALLTHROUGH */ - case (MDOC_Li): - /* FALLTHROUGH */ - case (MDOC_Ms): - /* FALLTHROUGH */ - case (MDOC_Pa): - /* FALLTHROUGH */ - case (MDOC_Tn): - if (0 < sz) - break; - if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1)) - return(0); + if (sz > 1) + mdoc_word_alloc(mdoc, pos, args[1]); + return(1); + default: break; + } - case (MDOC_Ar): - /* FALLTHROUGH */ - case (MDOC_Cm): - /* FALLTHROUGH */ - case (MDOC_Fl): - /* These can have no arguments. */ - break; + mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); + return(1); +} - case (MDOC_Ad): - /* FALLTHROUGH */ - case (MDOC_Em): - /* FALLTHROUGH */ - case (MDOC_Er): - /* FALLTHROUGH */ - case (MDOC_Ev): - /* FALLTHROUGH */ - case (MDOC_Fa): - /* FALLTHROUGH */ - case (MDOC_Dv): - /* FALLTHROUGH */ - case (MDOC_Ic): - /* FALLTHROUGH */ - case (MDOC_Va): - /* FALLTHROUGH */ - case (MDOC_Vt): - if (0 < sz) - break; - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); - /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ - default: - abort(); - /* NOTREACHED */ - } +static int +append_text(struct mdoc *mdoc, int tok, + int pos, int sz, char *args[]) +{ + + if ( ! mdoc_valid(mdoc, tok, pos, sz, _CC(args), 0, NULL)) + return(0); mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); return(1); } @@ -252,8 +203,8 @@ append_text(struct mdoc *mdoc, int tok, int macro_text(MACRO_PROT_ARGS) { - int lastarg, lastpunct, c, j; - char *args[MDOC_LINEARG_MAX], *p; + int lastarg, lastpunct, c, j, fl; + char *args[MDOC_LINEARG_MAX]; if (SEC_PROLOGUE == mdoc->sec_lastn) return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); @@ -286,7 +237,11 @@ macro_text(MACRO_PROT_ARGS) j = 0; lastarg = ppos; lastpunct = 0; + fl = ARGS_DELIM; + if (MDOC_QUOTABLE & mdoc_macros[tok].flags) + fl |= ARGS_QUOTED; + again: if (j == MDOC_LINEARG_MAX) return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); @@ -301,7 +256,7 @@ again: lastarg = *pos; - switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &args[j])) { + switch (mdoc_args(mdoc, tok, pos, buf, fl, &args[j])) { case (ARGS_ERROR): return(0); case (ARGS_WORD): @@ -309,8 +264,12 @@ again: case (ARGS_PUNCT): if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) return(0); + if (ppos > 1) + return(1); return(append_delims(mdoc, tok, pos, buf)); case (ARGS_EOLN): + if (lastpunct) + return(1); return(append_text(mdoc, tok, ppos, j, args)); default: abort(); @@ -338,7 +297,7 @@ again: if ( ! mdoc_isdelim(args[j])) { /* Words are appended to the array of arguments. */ j++; - lastpunct = 1; + lastpunct = 0; goto again; } @@ -348,16 +307,14 @@ again: * is non-terminal punctuation. */ - p = args[j]; if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) return(0); - mdoc_word_alloc(mdoc, lastarg, p); + mdoc_word_alloc(mdoc, lastarg, args[j]); j = 0; lastpunct = 1; goto again; - /* NOTREACHED */ } @@ -434,6 +391,8 @@ macro_prologue_os(MACRO_PROT_ARGS) int lastarg, j; char *args[MDOC_LINEARG_MAX]; + /* FIXME: if we use `Os' again... ? */ + if (SEC_PROLOGUE != mdoc->sec_lastn) return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE)); if (0 == mdoc->meta.title[0]) @@ -512,7 +471,7 @@ again: return(0); if (0 == j) { - if (xstrcmp("$Mdocdate: December 28 2008 $", args[j])) { + if (xstrcmp("$Mdocdate: December 30 2008 $", args[j])) { mdoc->meta.date = time(NULL); goto again; } else if (xstrcmp("$Mdocdate:", args[j])) @@ -607,6 +566,18 @@ macro_scoped_explicit(MACRO_PROT_ARGS) } +/* + * Implicity-scoped macros, like `.Ss', have a scope that terminates + * with a subsequent call to the same macro. Implicit macros cannot + * break the scope of explicitly-scoped macros; however, they can break + * the scope of other implicit macros (so `.Sh' can break `.Ss'). This + * is ok with macros like `.It' because they exist only within an + * explicit context. + * + * These macros put line arguments (which it's allowed to have) into the + * HEAD section and open a BODY scope to be used until the macro scope + * closes. + */ int macro_scoped_implicit(MACRO_PROT_ARGS) { @@ -636,6 +607,7 @@ macro_scoped_implicit(MACRO_PROT_ARGS) return(0); assert(mdoc->last->prev); n = mdoc->last; + mdoc_msg(mdoc, ppos, "removing prior `Pp' macro"); mdoc->last = mdoc->last->prev; mdoc->last->next = NULL; mdoc_node_free(n); @@ -644,17 +616,166 @@ macro_scoped_implicit(MACRO_PROT_ARGS) break; } + /* Rewind our scope. */ + + if ( ! scope_rewind_imp(mdoc, ppos, tok)) + return(0); + + j = 0; + lastarg = ppos; + + /* + * Process until we hit a line. Note that current implicit + * macros don't have any arguments, so we don't need to do any + * argument processing. + */ + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + + switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) { + case (ARGS_ERROR): + return(0); + case (ARGS_EOLN): + return(append_scoped(mdoc, tok, ppos, j, _CC(args), 0, NULL)); + default: + break; + } + + if (MDOC_MAX != mdoc_find(mdoc, args[j])) + if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + return(0); + + j++; + goto again; + /* NOTREACHED */ +} + + +/* + * A line-scoped macro opens a scope for the contents of its line, which + * are placed under the HEAD node. Punctuation trailing the line is put + * as a sibling to the HEAD node, under the BLOCK node. + */ +int +macro_scoped_line(MACRO_PROT_ARGS) +{ + int lastarg, c, j; + char *p; + struct mdoc_node *n; + + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + assert(1 == ppos); + + /* Token pre-processing. */ + switch (tok) { - case (MDOC_Sh): + case (MDOC_D1): /* FALLTHROUGH */ - case (MDOC_Ss): - if ( ! scope_rewind_imp(mdoc, ppos, tok)) + case (MDOC_Dl): + /* These can't be nested in a display block. */ + assert(mdoc->last); + for (n = mdoc->last->parent ; n; n = n->parent) + if (MDOC_BLOCK != n->type) + continue; + else if (MDOC_Bd == n->data.block.tok) + break; + if (NULL == n) + break; + return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NONEST)); + default: + break; + } + + /* + * All line-scoped macros have a HEAD and optionally a BODY + * section. We open our scope here; when we exit this function, + * we'll rewind our scope appropriately. + */ + + mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); + mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); + + /* Process line parameters. */ + + j = 0; + lastarg = ppos; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + + switch (c) { + case (ARGS_ERROR): + return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! append_delims(mdoc, tok, pos, buf)) return(0); + return(scope_rewind_imp(mdoc, ppos, tok)); + case (ARGS_EOLN): + return(scope_rewind_imp(mdoc, ppos, tok)); + default: + abort(); + /* NOTREACHED */ + } + + if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if ( ! append_delims(mdoc, tok, pos, buf)) + return(0); + return(scope_rewind_imp(mdoc, ppos, tok)); + } + + if (mdoc_isdelim(p)) + j = 0; + + mdoc_word_alloc(mdoc, lastarg, p); + goto again; + /* NOTREACHED */ +} + + +/* + * Partial-line scope is identical to line scope (macro_scoped_line()) + * except that trailing punctuation is appended to the BLOCK, instead of + * contained within the HEAD. + */ +int +macro_scoped_pline(MACRO_PROT_ARGS) +{ + int lastarg, c, j; + char *p; + + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + /* Token pre-processing. */ + + switch (tok) { + case (MDOC_Ql): + if ( ! mdoc_warn(mdoc, tok, ppos, WARN_COMPAT_TROFF)) + return(0); break; default: break; } + mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); + mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); + + /* Process line parameters. */ + j = 0; lastarg = ppos; @@ -663,34 +784,217 @@ again: return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); lastarg = *pos; + c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); - switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) { + switch (c) { case (ARGS_ERROR): return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! scope_rewind_imp(mdoc, ppos, tok)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); case (ARGS_EOLN): - return(append_scoped(mdoc, tok, ppos, j, _CC(args), 0, NULL)); + return(scope_rewind_imp(mdoc, ppos, tok)); default: + abort(); + /* NOTREACHED */ + } + + if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if ( ! scope_rewind_imp(mdoc, ppos, tok)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + } + + if (mdoc_isdelim(p)) + j = 0; + + mdoc_word_alloc(mdoc, lastarg, p); + goto again; + /* NOTREACHED */ +} + + +/* + * A delimited-constant macro is similar to a general text macro: the + * macro is followed by a 0 or 1 arguments (possibly-unspecified) then + * terminating punctuation, other words, or another callable macro. + */ +int +macro_constant_delimited(MACRO_PROT_ARGS) +{ + int lastarg, flushed, c, maxargs; + char *p; + + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + /* Process line parameters. */ + + lastarg = ppos; + flushed = 0; + + /* Token pre-processing. */ + + switch (tok) { + case (MDOC_Ux): + maxargs = 0; break; + default: + maxargs = 1; + break; } - /* Command found. */ +again: + lastarg = *pos; - if (MDOC_MAX != mdoc_find(mdoc, args[j])) - if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p)) { + case (ARGS_ERROR): + return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p)) return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + case (ARGS_EOLN): + if (flushed) + return(1); + return(append_const(mdoc, tok, ppos, 0, &p)); + default: + abort(); + /* NOTREACHED */ + } - /* Word found. */ + /* Accepts no arguments: flush out symbol and continue. */ - j++; + if (0 == maxargs) { + if ( ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + flushed = 1; + } + + if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { + if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + } + + /* + * We only accept one argument; subsequent tokens are considered + * as literal words (until a macro). + */ + + if ( ! flushed && ! mdoc_isdelim(p)) { + if ( ! append_const(mdoc, tok, ppos, 1, &p)) + return(0); + flushed = 1; + goto again; + } else if ( ! flushed) { + if ( ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + flushed = 1; + } + + mdoc_word_alloc(mdoc, lastarg, p); goto again; + /* NOTREACHED */ +} + +int +macro_constant(MACRO_PROT_ARGS) +{ + int lastarg, j, fl; + char *args[MDOC_LINEARG_MAX]; + + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + j = fl = 0; + lastarg = ppos; + if (MDOC_QUOTABLE & mdoc_macros[tok].flags) + fl = ARGS_QUOTED; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + + switch (mdoc_args(mdoc, tok, pos, buf, fl, &args[j])) { + case (ARGS_ERROR): + return(0); + case (ARGS_WORD): + break; + case (ARGS_EOLN): + return(append_const(mdoc, tok, ppos, j, args)); + default: + abort(); + /* NOTREACHED */ + } + + if (MDOC_MAX != mdoc_find(mdoc, args[j])) + if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + return(0); + + j++; + goto again; /* NOTREACHED */ } int -macro_scoped_line(MACRO_PROT_ARGS) +macro_constant_argv(MACRO_PROT_ARGS) { + int c, lastarg, j; + struct mdoc_arg argv[MDOC_LINEARG_MAX]; - return(1); + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + lastarg = *pos; + + for (j = 0; j < MDOC_LINEARG_MAX; j++) { + lastarg = *pos; + c = mdoc_argv(mdoc, tok, &argv[j], pos, buf); + if (0 == c) + break; + else if (1 == c) + continue; + + mdoc_argv_free(j, argv); + return(0); + } + + if (MDOC_LINEARG_MAX == j) { + mdoc_argv_free(j, argv); + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + } + + c = append_constarg(mdoc, tok, ppos, j, argv); + mdoc_argv_free(j, argv); + return(c); +} + + +int +macro_obsolete(MACRO_PROT_ARGS) +{ + + return(mdoc_warn(mdoc, tok, ppos, WARN_IGN_OBSOLETE)); }