=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.52 retrieving revision 1.64 diff -u -p -r1.52 -r1.64 --- mandoc/roff.c 2008/12/08 16:29:57 1.52 +++ mandoc/roff.c 2008/12/12 10:11:10 1.64 @@ -1,4 +1,4 @@ -/* $Id: roff.c,v 1.52 2008/12/08 16:29:57 kristaps Exp $ */ +/* $Id: roff.c,v 1.64 2008/12/12 10:11:10 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -28,7 +28,6 @@ #include #include -#include "libmdocml.h" #include "private.h" #include "roff.h" @@ -38,17 +37,30 @@ /* TODO: warn about empty lists. */ /* TODO: (warn) some sections need specific elements. */ /* TODO: (warn) NAME section has particular order. */ -/* TODO: unify empty-content tags a la
. */ /* TODO: macros with a set number of arguments? */ -/* TODO: validate Dt macro arguments. */ /* FIXME: Bl -diag supposed to ignore callable children. */ -/* FIXME: Nm has newline when used in NAME section. */ struct roffnode { - int tok; /* Token id. */ - struct roffnode *parent; /* Parent (or NULL). */ + int tok; /* Token id. */ + struct roffnode *parent; /* Parent (or NULL). */ }; +enum rofferr { + ERR_ARGEQ1, /* Macro requires arg == 1. */ + ERR_ARGEQ0, /* Macro requires arg == 0. */ + ERR_ARGGE1, /* Macro requires arg >= 1. */ + ERR_ARGGE2, /* Macro requires arg >= 2. */ + ERR_ARGLEN, /* Macro argument too long. */ + ERR_BADARG, /* Macro has bad arg. */ + ERR_ARGMNY, /* Too many macro arguments. */ + ERR_NOTSUP, /* Macro not supported. */ + ERR_DEPREC, /* Macro deprecated. */ + ERR_PR_OOO, /* Prelude macro bad order. */ + ERR_PR_REP, /* Prelude macro repeated. */ + ERR_NOT_PR, /* Not allowed in prelude. */ + WRN_SECORD /* Sections out-of-order. */ +}; + struct rofftree { struct roffnode *last; /* Last parsed node. */ char *cur; /* Line start. */ @@ -57,35 +69,32 @@ struct rofftree { char os[64]; /* `Os' results. */ char title[64]; /* `Dt' results. */ enum roffmsec section; - char volume[64]; /* `Dt' results. */ - int state; -#define ROFF_PRELUDE (1 << 1) /* In roff prelude. */ -#define ROFF_PRELUDE_Os (1 << 2) /* `Os' is parsed. */ -#define ROFF_PRELUDE_Dt (1 << 3) /* `Dt' is parsed. */ -#define ROFF_PRELUDE_Dd (1 << 4) /* `Dd' is parsed. */ -#define ROFF_BODY (1 << 5) /* In roff body. */ + enum roffvol volume; struct roffcb cb; /* Callbacks. */ void *arg; /* Callbacks' arg. */ int csec; /* Current section. */ int asec; /* Thus-far sections. */ + int literal; /* Literal mode. */ }; static struct roffnode *roffnode_new(int, struct rofftree *); static void roffnode_free(struct rofftree *); -static void roff_warn(const struct rofftree *, +static int roff_warn(const struct rofftree *, const char *, char *, ...); -static void roff_err(const struct rofftree *, +static int roff_warnp(const struct rofftree *, + const char *, int, enum rofferr); +static int roff_err(const struct rofftree *, const char *, char *, ...); +static int roff_errp(const struct rofftree *, + const char *, int, enum rofferr); static int roffpurgepunct(struct rofftree *, char **); static int roffscan(int, const int *); static int rofffindtok(const char *); static int rofffindarg(const char *); static int rofffindcallable(const char *); -static int roffismsec(const char *); -static int roffissec(const char **); static int roffispunct(const char *); static int roffchecksec(struct rofftree *, - const char *, int); + const char *, int, int); static int roffargs(const struct rofftree *, int, char *, char **); static int roffargok(int, int); @@ -125,21 +134,18 @@ roff_free(struct rofftree *tree, int flush) error = 1; - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, NULL, "prelude never finished"); + if ( ! (ROFFSec_NAME & tree->asec)) { + (void)roff_err(tree, NULL, "missing `NAME' section"); goto end; - } else if ( ! (ROFFSec_NAME & tree->asec)) { - roff_err(tree, NULL, "missing `NAME' section"); - goto end; } else if ( ! (ROFFSec_NMASK & tree->asec)) - roff_warn(tree, NULL, "missing suggested `NAME', " + (void)roff_warn(tree, NULL, "missing suggested `NAME', " "`SYNOPSIS', `DESCRIPTION' sections"); for (n = tree->last; n; n = n->parent) { if (0 != tokens[n->tok].ctx) continue; - roff_err(tree, NULL, "closing explicit scope `%s'", - toknames[n->tok]); + (void)roff_err(tree, NULL, "closing explicit scope " + "`%s'", toknames[n->tok]); goto end; } @@ -149,7 +155,9 @@ roff_free(struct rofftree *tree, int flush) goto end; } - if ( ! (*tree->cb.rofftail)(tree->arg)) + if ( ! (*tree->cb.rofftail)(tree->arg, &tree->tm, + tree->os, tree->title, + tree->section, tree->volume)) goto end; error = 0; @@ -176,7 +184,6 @@ roff_alloc(const struct roffcb *cb, void *args) if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) err(1, "calloc"); - tree->state = ROFF_PRELUDE; tree->arg = args; tree->section = ROFF_MSEC_MAX; @@ -193,10 +200,9 @@ roff_engine(struct rofftree *tree, char *buf) tree->cur = buf; assert(buf); - if (0 == *buf) { - roff_err(tree, buf, "blank line"); - return(0); - } else if ('.' != *buf) + if (0 == *buf) + return(roff_err(tree, buf, "blank line")); + else if ('.' != *buf) return(textparse(tree, buf)); return(roffparse(tree, buf)); @@ -210,11 +216,12 @@ textparse(struct rofftree *tree, char *buf) /* TODO: literal parsing. */ - if ( ! (ROFF_BODY & tree->state)) { - roff_err(tree, buf, "data not in body"); - return(0); - } + if ( ! (ROFFSec_NAME & tree->asec)) + return(roff_err(tree, buf, "data before `NAME' section")); + if (tree->literal) + return(roffdata(tree, 0, buf)); + /* LINTED */ while (*buf) { while (*buf && isspace(*buf)) @@ -269,13 +276,9 @@ roffargs(const struct rofftree *tree, argv[i] = ++buf; while (*buf && '\"' != *buf) buf++; - if (0 == *buf) { - roff_err(tree, argv[i], "unclosed " - "quote in argument " - "list for `%s'", - toknames[tok]); - return(0); - } + if (0 == *buf) + return(roff_err(tree, argv[i], + "unclosed quote in arg list")); } else { argv[i] = buf++; while (*buf) { @@ -298,11 +301,8 @@ roffargs(const struct rofftree *tree, } assert(i > 0); - if (ROFF_MAXLINEARG == i && *buf) { - roff_err(tree, p, "too many arguments for `%s'", toknames - [tok]); - return(0); - } + if (ROFF_MAXLINEARG == i && *buf) + return(roff_err(tree, p, "too many args")); argv[i] = NULL; return(1); @@ -336,11 +336,10 @@ roffparse(struct rofftree *tree, char *buf) if (0 == strncmp(buf, ".\\\"", 3)) return(1); - if (ROFF_MAX == (tok = rofffindtok(buf + 1))) { - roff_err(tree, buf, "bogus line macro"); + if (ROFF_MAX == (tok = rofffindtok(buf + 1))) + return(roff_err(tree, buf, "bogus line macro")); + else if ( ! roffargs(tree, tok, buf, argv)) return(0); - } else if ( ! roffargs(tree, tok, buf, argv)) - return(0); argvp = (char **)argv; @@ -348,33 +347,27 @@ roffparse(struct rofftree *tree, char *buf) * Prelude macros break some assumptions, so branch now. */ - if (ROFF_PRELUDE & tree->state) { + if ( ! (ROFFSec_PR_Dd & tree->asec)) { assert(NULL == tree->last); return(roffcall(tree, tok, argvp)); } - assert(ROFF_BODY & tree->state); - /* * First check that our possible parents and parent's possible * children are satisfied. */ if (tree->last && ! roffscan - (tree->last->tok, tokens[tok].parents)) { - roff_err(tree, *argvp, "`%s' has invalid parent `%s'", - toknames[tok], - toknames[tree->last->tok]); - return(0); - } + (tree->last->tok, tokens[tok].parents)) + return(roff_err(tree, *argvp, "`%s' has invalid " + "parent `%s'", toknames[tok], + toknames[tree->last->tok])); if (tree->last && ! roffscan - (tok, tokens[tree->last->tok].children)) { - roff_err(tree, *argvp, "`%s' is invalid child of `%s'", - toknames[tok], - toknames[tree->last->tok]); - return(0); - } + (tok, tokens[tree->last->tok].children)) + return(roff_err(tree, *argvp, "`%s' has invalid " + "child `%s'", toknames[tok], + toknames[tree->last->tok])); /* * Branch if we're not a layout token. @@ -414,9 +407,10 @@ roffparse(struct rofftree *tree, char *buf) } if (tokens[n->tok].ctx == n->tok) continue; - roff_err(tree, *argv, "`%s' breaks `%s' scope", - toknames[tok], toknames[n->tok]); - return(0); + return(roff_err(tree, *argv, "`%s' breaks " + "scope of prior`%s'", + toknames[tok], + toknames[n->tok])); } /* @@ -457,20 +451,18 @@ roffparse(struct rofftree *tree, char *buf) if (n->tok != tokens[tok].ctx) { if (n->tok == tokens[n->tok].ctx) continue; - roff_err(tree, *argv, "`%s' breaks `%s' scope", - toknames[tok], toknames[n->tok]); - return(0); + return(roff_err(tree, *argv, "`%s' breaks " + "scope of prior `%s'", + toknames[tok], + toknames[n->tok])); } else break; + if (NULL == n) + return(roff_err(tree, *argv, "`%s' has no starting " + "tag `%s'", toknames[tok], + toknames[tokens[tok].ctx])); - if (NULL == n) { - roff_err(tree, *argv, "`%s' has no starting tag `%s'", - toknames[tok], - toknames[tokens[tok].ctx]); - return(0); - } - /* LINTED */ do { t = tree->last->tok; @@ -526,160 +518,92 @@ rofffindtok(const char *buf) static int -roffchecksec(struct rofftree *tree, const char *start, int sec) +roffchecksec(struct rofftree *tree, + const char *start, int sec, int fail) { - int prior; switch (sec) { + case(ROFFSec_PR_Dd): + return(1); + case(ROFFSec_PR_Dt): + if (ROFFSec_PR_Dd & tree->asec) + return(1); + break; + case(ROFFSec_PR_Os): + if (ROFFSec_PR_Dt & tree->asec) + return(1); + break; + case(ROFFSec_NAME): + if (ROFFSec_PR_Os & tree->asec) + return(1); + break; case(ROFFSec_SYNOP): - if ((prior = ROFFSec_NAME) & tree->asec) + if (ROFFSec_NAME & tree->asec) return(1); break; case(ROFFSec_DESC): - if ((prior = ROFFSec_SYNOP) & tree->asec) + if (ROFFSec_SYNOP & tree->asec) return(1); break; case(ROFFSec_RETVAL): - if ((prior = ROFFSec_DESC) & tree->asec) + if (ROFFSec_DESC & tree->asec) return(1); break; case(ROFFSec_ENV): - if ((prior = ROFFSec_RETVAL) & tree->asec) + if (ROFFSec_RETVAL & tree->asec) return(1); break; case(ROFFSec_FILES): - if ((prior = ROFFSec_ENV) & tree->asec) + if (ROFFSec_ENV & tree->asec) return(1); break; case(ROFFSec_EX): - if ((prior = ROFFSec_FILES) & tree->asec) + if (ROFFSec_FILES & tree->asec) return(1); break; case(ROFFSec_DIAG): - if ((prior = ROFFSec_EX) & tree->asec) + if (ROFFSec_EX & tree->asec) return(1); break; case(ROFFSec_ERRS): - if ((prior = ROFFSec_DIAG) & tree->asec) + if (ROFFSec_DIAG & tree->asec) return(1); break; case(ROFFSec_SEEALSO): - if ((prior = ROFFSec_ERRS) & tree->asec) + if (ROFFSec_ERRS & tree->asec) return(1); break; case(ROFFSec_STAND): - if ((prior = ROFFSec_SEEALSO) & tree->asec) + if (ROFFSec_SEEALSO & tree->asec) return(1); break; case(ROFFSec_HIST): - if ((prior = ROFFSec_STAND) & tree->asec) + if (ROFFSec_STAND & tree->asec) return(1); break; case(ROFFSec_AUTH): - if ((prior = ROFFSec_HIST) & tree->asec) + if (ROFFSec_HIST & tree->asec) return(1); break; case(ROFFSec_CAVEATS): - if ((prior = ROFFSec_AUTH) & tree->asec) + if (ROFFSec_AUTH & tree->asec) return(1); break; case(ROFFSec_BUGS): - if ((prior = ROFFSec_CAVEATS) & tree->asec) + if (ROFFSec_CAVEATS & tree->asec) return(1); break; default: return(1); } - roff_warn(tree, start, "section violates conventional order"); - return(1); + if (fail) + return(0); + return(roff_warnp(tree, start, ROFF_Sh, WRN_SECORD)); } static int -roffissec(const char **p) -{ - - assert(*p); - if (NULL != *(p + 1)) { - if (NULL != *(p + 2)) - return(ROFFSec_OTHER); - if (0 == strcmp(*p, "RETURN") && - 0 == strcmp(*(p + 1), "VALUES")) - return(ROFFSec_RETVAL); - if (0 == strcmp(*p, "SEE") && - 0 == strcmp(*(p + 1), "ALSO")) - return(ROFFSec_SEEALSO); - return(ROFFSec_OTHER); - } - - if (0 == strcmp(*p, "NAME")) - return(ROFFSec_NAME); - else if (0 == strcmp(*p, "SYNOPSIS")) - return(ROFFSec_SYNOP); - else if (0 == strcmp(*p, "DESCRIPTION")) - return(ROFFSec_DESC); - else if (0 == strcmp(*p, "ENVIRONMENT")) - return(ROFFSec_ENV); - else if (0 == strcmp(*p, "FILES")) - return(ROFFSec_FILES); - else if (0 == strcmp(*p, "EXAMPLES")) - return(ROFFSec_EX); - else if (0 == strcmp(*p, "DIAGNOSTICS")) - return(ROFFSec_DIAG); - else if (0 == strcmp(*p, "ERRORS")) - return(ROFFSec_ERRS); - else if (0 == strcmp(*p, "STANDARDS")) - return(ROFFSec_STAND); - else if (0 == strcmp(*p, "HISTORY")) - return(ROFFSec_HIST); - else if (0 == strcmp(*p, "AUTHORS")) - return(ROFFSec_AUTH); - else if (0 == strcmp(*p, "CAVEATS")) - return(ROFFSec_CAVEATS); - else if (0 == strcmp(*p, "BUGS")) - return(ROFFSec_BUGS); - - return(ROFFSec_OTHER); -} - - -static int -roffismsec(const char *p) -{ - - if (0 == strcmp(p, "1")) - return(ROFF_MSEC_1); - else if (0 == strcmp(p, "2")) - return(ROFF_MSEC_2); - else if (0 == strcmp(p, "3")) - return(ROFF_MSEC_3); - else if (0 == strcmp(p, "3p")) - return(ROFF_MSEC_3p); - else if (0 == strcmp(p, "4")) - return(ROFF_MSEC_4); - else if (0 == strcmp(p, "5")) - return(ROFF_MSEC_5); - else if (0 == strcmp(p, "6")) - return(ROFF_MSEC_6); - else if (0 == strcmp(p, "7")) - return(ROFF_MSEC_7); - else if (0 == strcmp(p, "8")) - return(ROFF_MSEC_8); - else if (0 == strcmp(p, "9")) - return(ROFF_MSEC_9); - else if (0 == strcmp(p, "unass")) - return(ROFF_MSEC_UNASS); - else if (0 == strcmp(p, "draft")) - return(ROFF_MSEC_DRAFT); - else if (0 == strcmp(p, "paper")) - return(ROFF_MSEC_PAPER); - - return(ROFF_MSEC_MAX); -} - - -static int roffispunct(const char *p) { @@ -788,32 +712,18 @@ roffspecial(struct rofftree *tree, int tok, const char case (ROFF_At): if (0 == sz) break; - if (0 == strcmp(*ordp, "v1")) + if (ROFF_ATT_MAX != roff_att(*ordp)) break; - else if (0 == strcmp(*ordp, "v2")) - break; - else if (0 == strcmp(*ordp, "v3")) - break; - else if (0 == strcmp(*ordp, "v6")) - break; - else if (0 == strcmp(*ordp, "v7")) - break; - else if (0 == strcmp(*ordp, "32v")) - break; - else if (0 == strcmp(*ordp, "V.1")) - break; - else if (0 == strcmp(*ordp, "V.4")) - break; - roff_err(tree, *ordp, "invalid `At' arg"); - return(0); + return(roff_errp(tree, *ordp, tok, ERR_BADARG)); case (ROFF_Xr): if (2 == sz) { assert(ordp[1]); - if (ROFF_MSEC_MAX != roffismsec(ordp[1])) + if (ROFF_MSEC_MAX != roff_msec(ordp[1])) break; - roff_warn(tree, start, "invalid `%s' manual " - "section", toknames[tok]); + if ( ! roff_warn(tree, start, "invalid `%s' manual " + "section", toknames[tok])) + return(0); } /* FALLTHROUGH */ @@ -822,18 +732,16 @@ roffspecial(struct rofftree *tree, int tok, const char case (ROFF_Fn): if (0 != sz) break; - roff_err(tree, start, "`%s' expects at least " - "one arg", toknames[tok]); - return(0); + return(roff_errp(tree, start, tok, ERR_ARGGE1)); case (ROFF_Nm): if (0 == sz) { - if (0 == tree->name[0]) { - roff_err(tree, start, "`Nm' not set"); - return(0); + if (0 != tree->name[0]) { + ordp[0] = tree->name; + ordp[1] = NULL; + break; } - ordp[0] = tree->name; - ordp[1] = NULL; + return(roff_err(tree, start, "`Nm' not set")); } else if ( ! roffsetname(tree, ordp)) return(0); break; @@ -843,34 +751,24 @@ roffspecial(struct rofftree *tree, int tok, const char case (ROFF_Ex): if (1 == sz) break; - roff_err(tree, start, "`%s' expects one arg", - toknames[tok]); - return(0); + return(roff_errp(tree, start, tok, ERR_ARGEQ1)); case (ROFF_Sm): - if (1 != sz) { - roff_err(tree, start, "`Sm' expects one arg"); - return(0); - } - - if (0 != strcmp(ordp[0], "on") && - 0 != strcmp(ordp[0], "off")) { - roff_err(tree, start, "`Sm' has invalid argument"); - return(0); - } - break; + if (1 != sz) + return(roff_errp(tree, start, tok, ERR_ARGEQ1)); + else if (0 == strcmp(ordp[0], "on") || + 0 == strcmp(ordp[0], "off")) + break; + return(roff_errp(tree, *ordp, tok, ERR_BADARG)); case (ROFF_Ud): /* FALLTHROUGH */ case (ROFF_Ux): /* FALLTHROUGH */ case (ROFF_Bt): - if (0 != sz) { - roff_err(tree, start, "`%s' expects no args", - toknames[tok]); - return(0); - } - break; + if (0 == sz) + break; + return(roff_errp(tree, start, tok, ERR_ARGEQ0)); default: break; } @@ -895,11 +793,9 @@ roffcall(struct rofftree *tree, int tok, char **argv) int i; enum roffmsec c; - if (NULL == tokens[tok].cb) { - roff_err(tree, *argv, "`%s' is unsupported", - toknames[tok]); - return(0); - } + if (NULL == tokens[tok].cb) + return(roff_errp(tree, *argv, tok, ERR_NOTSUP)); + if (tokens[tok].sections && ROFF_MSEC_MAX != tree->section) { i = 0; while (ROFF_MSEC_MAX != @@ -907,9 +803,10 @@ roffcall(struct rofftree *tree, int tok, char **argv) if (c == tree->section) break; if (ROFF_MSEC_MAX == c) { - roff_warn(tree, *argv, "`%s' is not a valid " + if ( ! roff_warn(tree, *argv, "`%s' is not a valid " "macro in this manual section", - toknames[tok]); + toknames[tok])) + return(0); } } @@ -934,14 +831,16 @@ roffnextopt(const struct rofftree *tree, int tok, return(-1); if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) { - roff_warn(tree, arg, "argument-like parameter `%s' to " - "`%s'", arg, toknames[tok]); + if ( ! roff_warn(tree, arg, "argument-like parameter `%s' to " + "`%s'", arg, toknames[tok])) + return(ROFF_ARGMAX); return(-1); } if ( ! roffargok(tok, v)) { - roff_warn(tree, arg, "invalid argument parameter `%s' to " - "`%s'", tokargnames[v], toknames[tok]); + if ( ! roff_warn(tree, arg, "invalid argument parameter `%s' to " + "`%s'", tokargnames[v], toknames[tok])) + return(ROFF_ARGMAX); return(-1); } @@ -951,7 +850,7 @@ roffnextopt(const struct rofftree *tree, int tok, *in = ++argv; if (NULL == *argv) { - roff_err(tree, arg, "empty value of `%s' for `%s'", + (void)roff_err(tree, arg, "empty value of `%s' for `%s'", tokargnames[v], toknames[tok]); return(ROFF_ARGMAX); } @@ -1025,81 +924,61 @@ roff_Dd(ROFFCALL_ARGS) { time_t t; char *p, buf[32]; + size_t sz; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dd & tree->state); + if (ROFFSec_PR_Os & tree->asec) return(roff_text(tok, tree, argv, type)); - } + if (ROFFSec_PR_Dd & tree->asec) + return(roff_errp(tree, *argv, tok, ERR_PR_REP)); + if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dd, 1)) + return(roff_errp(tree, *argv, tok, ERR_PR_OOO)); - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); - - if (ROFF_PRELUDE_Dd & tree->state) { - roff_err(tree, *argv, "repeated `Dd' in prelude"); - return(0); - } else if (ROFF_PRELUDE_Dt & tree->state) { - roff_err(tree, *argv, "out-of-order `Dd' in prelude"); - return(0); - } - assert(NULL == tree->last); - argv++; + tree->asec |= (tree->csec = ROFFSec_PR_Dd); - if (0 == strcmp(*argv, "$Mdocdate: December 8 2008 $")) { + /* + * This is a bit complex because there are many forms the date + * can be in: it can be simply $Mdocdate: December 12 2008 $, $Mdocdate $, + * or a raw date. Process accordingly. + */ + + if (0 == strcmp(*argv, "$Mdocdate: December 12 2008 $")) { t = time(NULL); if (NULL == localtime_r(&t, &tree->tm)) err(1, "localtime_r"); - tree->state |= ROFF_PRELUDE_Dd; return(1); } - /* Build this from Mdocdate or raw date. */ - buf[0] = 0; p = *argv; + sz = sizeof(buf); if (0 != strcmp(*argv, "$Mdocdate:")) { while (*argv) { - if (strlcat(buf, *argv++, sizeof(buf)) - < sizeof(buf)) + if (strlcat(buf, *argv++, sz) < sz) continue; - roff_err(tree, p, "bad `Dd' date"); - return(0); + return(roff_errp(tree, p, tok, ERR_BADARG)); } - if (strptime(buf, "%b%d,%Y", &tree->tm)) { - tree->state |= ROFF_PRELUDE_Dd; + if (strptime(buf, "%b%d,%Y", &tree->tm)) return(1); - } - roff_err(tree, *argv, "bad `Dd' date"); - return(0); + return(roff_errp(tree, p, tok, ERR_BADARG)); } argv++; + while (*argv && **argv != '$') { - if (strlcat(buf, *argv++, sizeof(buf)) - >= sizeof(buf)) { - roff_err(tree, p, "bad `Dd' Mdocdate"); - return(0); - } - if (strlcat(buf, " ", sizeof(buf)) - >= sizeof(buf)) { - roff_err(tree, p, "bad `Dd' Mdocdate"); - return(0); - } + if (strlcat(buf, *argv++, sz) >= sz) + return(roff_errp(tree, p, tok, ERR_BADARG)); + if (strlcat(buf, " ", sz) >= sz) + return(roff_errp(tree, p, tok, ERR_BADARG)); } - if (NULL == *argv) { - roff_err(tree, p, "bad `Dd' Mdocdate"); - return(0); - } - if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) { - roff_err(tree, *argv, "bad `Dd' Mdocdate"); - return(0); - } + if (NULL == *argv) + return(roff_errp(tree, p, tok, ERR_BADARG)); + if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) + return(roff_errp(tree, p, tok, ERR_BADARG)); - tree->state |= ROFF_PRELUDE_Dd; return(1); } @@ -1108,56 +987,74 @@ roff_Dd(ROFFCALL_ARGS) static int roff_Dt(ROFFCALL_ARGS) { + size_t sz; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dt & tree->state); + if (ROFFSec_PR_Os & tree->asec) return(roff_text(tok, tree, argv, type)); - } + if (ROFFSec_PR_Dt & tree->asec) + return(roff_errp(tree, *argv, tok, ERR_PR_REP)); + if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Dt, 1)) + return(roff_errp(tree, *argv, tok, ERR_PR_OOO)); - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); + argv++; + tree->asec |= (tree->csec = ROFFSec_PR_Dt); + sz = sizeof(tree->title); - if ( ! (ROFF_PRELUDE_Dd & tree->state)) { - roff_err(tree, *argv, "out-of-order `Dt' in prelude"); - return(0); - } else if (ROFF_PRELUDE_Dt & tree->state) { - roff_err(tree, *argv, "repeated `Dt' in prelude"); - return(0); - } + if (NULL == *argv) + return(roff_errp(tree, *argv, tok, ERR_ARGGE2)); + if (strlcpy(tree->title, *argv, sz) >= sz) + return(roff_errp(tree, *argv, tok, ERR_ARGLEN)); argv++; - if (NULL == *argv) { - roff_err(tree, *argv, "`Dt' needs document title"); - return(0); - } else if (strlcpy(tree->title, *argv, sizeof(tree->title)) - >= sizeof(tree->title)) { - roff_err(tree, *argv, "`Dt' document title too long"); - return(0); - } + if (NULL == *argv) + return(roff_errp(tree, *argv, tok, ERR_ARGGE2)); - argv++; - if (NULL == *argv) { - roff_err(tree, *argv, "`Dt' needs section"); - return(0); - } + if (ROFF_MSEC_MAX == (tree->section = roff_msec(*argv))) + return(roff_errp(tree, *argv, tok, ERR_BADARG)); - if (ROFF_MSEC_MAX == (tree->section = roffismsec(*argv))) { - roff_err(tree, *argv, "bad `Dt' section"); - return(0); - } - argv++; + if (NULL == *argv) { - tree->volume[0] = 0; - } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume)) - >= sizeof(tree->volume)) { - roff_err(tree, *argv, "`Dt' volume too long"); - return(0); - } + switch (tree->section) { + case(ROFF_MSEC_1): + /* FALLTHROUGH */ + case(ROFF_MSEC_6): + /* FALLTHROUGH */ + case(ROFF_MSEC_7): + tree->volume = ROFF_VOL_URM; + break; + case(ROFF_MSEC_2): + /* FALLTHROUGH */ + case(ROFF_MSEC_3): + /* FALLTHROUGH */ + case(ROFF_MSEC_3p): + /* FALLTHROUGH */ + case(ROFF_MSEC_4): + /* FALLTHROUGH */ + case(ROFF_MSEC_5): + tree->volume = ROFF_VOL_PRM; + break; + case(ROFF_MSEC_8): + tree->volume = ROFF_VOL_PRM; + break; + case(ROFF_MSEC_9): + tree->volume = ROFF_VOL_KM; + break; + case(ROFF_MSEC_UNASS): + /* FALLTHROUGH */ + case(ROFF_MSEC_DRAFT): + /* FALLTHROUGH */ + case(ROFF_MSEC_PAPER): + tree->volume = ROFF_VOL_NONE; + break; + default: + abort(); + /* NOTREACHED */ + } + } else if (ROFF_VOL_MAX == (tree->volume = roff_vol(*argv))) + return(roff_errp(tree, *argv, tok, ERR_BADARG)); assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dt; return(1); } @@ -1166,21 +1063,18 @@ roff_Dt(ROFFCALL_ARGS) static int roffsetname(struct rofftree *tree, char **ordp) { + size_t sz; assert(*ordp); /* FIXME: not all sections can set this. */ - if (NULL != *(ordp + 1)) { - roff_err(tree, *ordp, "too many `Nm' args"); - return(0); - } + if (NULL != *(ordp + 1)) + return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGMNY)); - if (strlcpy(tree->name, *ordp, sizeof(tree->name)) - >= sizeof(tree->name)) { - roff_err(tree, *ordp, "`Nm' arg too long"); - return(0); - } + sz = sizeof(tree->name); + if (strlcpy(tree->name, *ordp, sz) >= sz) + return(roff_errp(tree, *ordp, ROFF_Nm, ERR_ARGLEN)); return(1); } @@ -1237,43 +1131,27 @@ static int roff_Os(ROFFCALL_ARGS) { char *p; + size_t sz; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Os & tree->state); + if (ROFFSec_PR_Os & tree->asec) return(roff_text(tok, tree, argv, type)); - } + if ( ! roffchecksec(tree, *argv, ROFFSec_PR_Os, 1)) + return(roff_errp(tree, *argv, tok, ERR_PR_OOO)); - assert(ROFF_PRELUDE & tree->state); - if ( ! (ROFF_PRELUDE_Dt & tree->state) || - ! (ROFF_PRELUDE_Dd & tree->state)) { - roff_err(tree, *argv, "out-of-order `Os' in prelude"); - return(0); - } + p = *++argv; + sz = sizeof(tree->os); + tree->asec |= (tree->csec = ROFFSec_PR_Os); tree->os[0] = 0; - p = *++argv; + while (*argv) + if (strlcat(tree->os, *argv++, sz) >= sz) + return(roff_errp(tree, p, tok, ERR_ARGLEN)); - while (*argv) { - if (strlcat(tree->os, *argv++, sizeof(tree->os)) - < sizeof(tree->os)) - continue; - roff_err(tree, p, "`Os' value too long"); - return(0); - } - if (0 == tree->os[0]) - if (strlcpy(tree->os, "LOCAL", sizeof(tree->os)) - >= sizeof(tree->os)) { - roff_err(tree, p, "`Os' value too long"); - return(0); - } + if (strlcpy(tree->os, "LOCAL", sz) >= sz) + return(roff_errp(tree, p, tok, ERR_ARGLEN)); - tree->state |= ROFF_PRELUDE_Os; - tree->state &= ~ROFF_PRELUDE; - tree->state |= ROFF_BODY; - assert(ROFF_MSEC_MAX != tree->section); assert(0 != tree->title[0]); assert(0 != tree->os[0]); @@ -1281,8 +1159,8 @@ roff_Os(ROFFCALL_ARGS) assert(NULL == tree->last); return((*tree->cb.roffhead)(tree->arg, &tree->tm, - tree->os, tree->title, tree->section, - tree->volume)); + tree->os, tree->title, + tree->section, tree->volume)); } @@ -1291,7 +1169,7 @@ static int roff_layout(ROFFCALL_ARGS) { int i, c, argcp[ROFF_MAXLINEARG]; - char *argvp[ROFF_MAXLINEARG]; + char *argvp[ROFF_MAXLINEARG], *p; /* * The roff_layout function is for multi-line macros. A layout @@ -1307,21 +1185,19 @@ roff_layout(ROFFCALL_ARGS) assert( ! (ROFF_CALLABLE & tokens[tok].flags)); - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, *argv, "bad `%s' in prelude", - toknames[tok]); - return(0); - } else if (ROFF_EXIT == type) { + if ( ! (ROFFSec_PR_Os & tree->asec)) + return(roff_errp(tree, *argv, tok, ERR_NOT_PR)); + + if (ROFF_EXIT == type) { roffnode_free(tree); if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok)) return(0); return((*tree->cb.roffblkout)(tree->arg, tok)); } + p = *argv++; assert( ! (ROFF_CALLABLE & tokens[tok].flags)); - ++argv; - if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) return(0); if (NULL == roffnode_new(tok, tree)) @@ -1356,24 +1232,34 @@ roff_layout(ROFFCALL_ARGS) /* +++ Begin run macro-specific hooks over argv. */ switch (tok) { + case (ROFF_Bd): + tree->literal++; + break; + case (ROFF_Sh): if (NULL == *argv) { - roff_err(tree, *(argv - 1), - "`Sh' expects arguments"); - return(0); + argv--; + return(roff_errp(tree, *argv, tok, ERR_ARGGE1)); } - tree->csec = roffissec((const char **)argv); + + tree->csec = roff_sec((const char **)argv); + if ( ! (ROFFSec_OTHER & tree->csec) && tree->asec & tree->csec) - roff_warn(tree, *argv, "section repeated"); - if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec)) { - roff_err(tree, *argv, "`NAME' section " - "must be first"); + if ( ! roff_warn(tree, *argv, "section repeated")) + return(0); + + if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec)) + return(roff_err(tree, *argv, "`NAME' section " + "must be first")); + if ( ! roffchecksec(tree, *argv, tree->csec, 0)) return(0); - } else if ( ! roffchecksec(tree, *argv, tree->csec)) - return(0); tree->asec |= tree->csec; + + if ( ! roffspecial(tree, tok, p, argcp, + (const char **)argvp, 0, argv)) + return(0); break; default: break; @@ -1471,11 +1357,8 @@ roff_ordered(ROFFCALL_ARGS) * .Xr arg1 arg2 punctuation */ - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, *argv, "`%s' disallowed in prelude", - toknames[tok]); - return(0); - } + if ( ! (ROFFSec_PR_Os & tree->asec)) + return(roff_errp(tree, *argv, tok, ERR_NOT_PR)); first = (*argv == tree->cur); p = *argv++; @@ -1527,6 +1410,80 @@ roff_ordered(ROFFCALL_ARGS) } +static int +macro_default(struct rofftree *tree, int tok, char *args[]) +{ + char **p; + char *argv[ROFF_MAXLINEARG]; + int i, argc[ROFF_MAXLINEARG]; + + if ( ! roffparseopts(tree, tok, &args, argc, argv)) + return(0); + + if ( ! (ROFF_PARSED & tokens[tok].flags)) + return((*tree->cb.macro)(tree->arg, tok, argc, argv, 0, args)); + + p = args; + + while (*args) { + c = rofffindcallable(*args); + if (ROFF_MAX == c) { + if (roffispunct(*args)) { + + + } + } + + if (ROFF_MAX != (c = rofffindcallable(*argv))) { + if ( ! (ROFF_LSCOPE & tokens[tok].flags)) + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + + if ( ! roffcall(tree, c, argv)) + return(0); + if (ROFF_LSCOPE & tokens[tok].flags) + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + break; + } + + if ( ! roffispunct(*argv)) { + if ( ! roffdata(tree, i++, *argv++)) + return(0); + continue; + } + + i = 1; + for (j = 0; argv[j]; j++) + if ( ! roffispunct(argv[j])) + break; + + if (argv[j]) { + if (ROFF_LSCOPE & tokens[tok].flags) { + if ( ! roffdata(tree, 0, *argv++)) + return(0); + continue; + } + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + if ( ! roffdata(tree, 0, *argv++)) + return(0); + if ( ! (*tree->cb.roffin)(tree->arg, tok, + argcp, + (const char **)argvp)) + return(0); + + i = 0; + continue; + } + + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + break; + } +} + + /* ARGSUSED */ static int roff_text(ROFFCALL_ARGS) @@ -1546,11 +1503,8 @@ roff_text(ROFFCALL_ARGS) * v W f ; */ - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, *argv, "`%s' disallowed in prelude", - toknames[tok]); - return(0); - } + if ( ! (ROFFSec_PR_Os & tree->asec)) + return(roff_errp(tree, *argv, tok, ERR_NOT_PR)); first = (*argv == tree->cur); argv++; @@ -1568,7 +1522,6 @@ roff_text(ROFFCALL_ARGS) while (*argv) if ( ! roffdata(tree, i++, *argv++)) return(0); - return((*tree->cb.roffout)(tree->arg, tok)); } @@ -1590,11 +1543,9 @@ roff_text(ROFFCALL_ARGS) if ( ! roffcall(tree, c, argv)) return(0); - if (ROFF_LSCOPE & tokens[tok].flags) if ( ! (*tree->cb.roffout)(tree->arg, tok)) return(0); - break; } @@ -1647,6 +1598,14 @@ static int roff_noop(ROFFCALL_ARGS) { + switch (tok) { + case (ROFF_Ed): + tree->literal--; + break; + default: + break; + } + return(1); } @@ -1656,12 +1615,31 @@ static int roff_depr(ROFFCALL_ARGS) { - roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]); - return(0); + return(roff_errp(tree, *argv, tok, ERR_DEPREC)); } -static void +/* FIXME: push this into the filter. */ +static int +roff_warnp(const struct rofftree *tree, const char *pos, + int tok, enum rofferr type) +{ + char *p; + + switch (type) { + case (WRN_SECORD): + p = "section at `%s' out of order"; + break; + default: + abort(); + /* NOTREACHED */ + } + + return(roff_warn(tree, pos, p, toknames[tok])); +} + + +static int roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...) { va_list ap; @@ -1671,22 +1649,76 @@ roff_warn(const struct rofftree *tree, const char *pos (void)vsnprintf(buf, sizeof(buf), fmt, ap); va_end(ap); - (*tree->cb.roffmsg)(tree->arg, - ROFF_WARN, tree->cur, pos, buf); + return((*tree->cb.roffmsg)(tree->arg, + ROFF_WARN, tree->cur, pos, buf)); } -static void +/* FIXME: push this into the filter. */ +static int +roff_errp(const struct rofftree *tree, const char *pos, + int tok, enum rofferr type) +{ + char *p; + + switch (type) { + case (ERR_ARGEQ1): + p = "`%s' expects exactly one argument"; + break; + case (ERR_ARGEQ0): + p = "`%s' expects exactly zero arguments"; + break; + case (ERR_ARGGE1): + p = "`%s' expects one or more arguments"; + break; + case (ERR_ARGGE2): + p = "`%s' expects two or more arguments"; + break; + case (ERR_BADARG): + p = "invalid argument for `%s'"; + break; + case (ERR_NOTSUP): + p = "macro `%s' is not supported"; + break; + case(ERR_PR_OOO): + p = "prelude macro `%s' is out of order"; + break; + case(ERR_PR_REP): + p = "prelude macro `%s' repeated"; + break; + case(ERR_ARGLEN): + p = "macro argument for `%s' is too long"; + break; + case(ERR_DEPREC): + p = "macro `%s' is deprecated"; + break; + case(ERR_NOT_PR): + p = "macro `%s' disallowed in prelude"; + break; + case(ERR_ARGMNY): + p = "too many arguments for macro `%s'"; + break; + default: + abort(); + /* NOTREACHED */ + } + + return(roff_err(tree, pos, p, toknames[tok])); +} + + +static int roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...) { va_list ap; char buf[128]; va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf), fmt, ap); + if (-1 == vsnprintf(buf, sizeof(buf), fmt, ap)) + err(1, "vsnprintf"); va_end(ap); - (*tree->cb.roffmsg)(tree->arg, - ROFF_ERROR, tree->cur, pos, buf); + return((*tree->cb.roffmsg) + (tree->arg, ROFF_ERROR, tree->cur, pos, buf)); }