=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.1 retrieving revision 1.4 diff -u -p -r1.1 -r1.4 --- mandoc/roff.c 2008/11/24 14:24:55 1.1 +++ mandoc/roff.c 2008/11/25 12:14:02 1.4 @@ -1,4 +1,4 @@ -/* $Id: roff.c,v 1.1 2008/11/24 14:24:55 kristaps Exp $ */ +/* $Id: roff.c,v 1.4 2008/11/25 12:14:02 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -34,20 +34,21 @@ enum roffd { ROFF_EXIT }; +/* FIXME: prolog roffs can be text roffs, too. */ + enum rofftype { - ROFF_TITLE, ROFF_COMMENT, ROFF_TEXT, ROFF_LAYOUT }; #define ROFFCALL_ARGS \ - struct rofftree *tree, const char *argv[], enum roffd type + int tok, struct rofftree *tree, \ + const char *argv[], enum roffd type struct rofftree; struct rofftok { - char *name; int (*cb)(ROFFCALL_ARGS); enum rofftype type; int flags; @@ -58,7 +59,7 @@ struct rofftok { }; struct roffarg { - char *name; + int tok; int flags; #define ROFF_VALUE (1 << 0) }; @@ -72,72 +73,92 @@ struct roffnode { struct rofftree { struct roffnode *last; time_t date; - char title[256]; - char section[256]; - char volume[256]; + char os[64]; + char title[64]; + char section[64]; + char volume[64]; int state; #define ROFF_PRELUDE (1 << 1) #define ROFF_PRELUDE_Os (1 << 2) #define ROFF_PRELUDE_Dt (1 << 3) #define ROFF_PRELUDE_Dd (1 << 4) #define ROFF_BODY (1 << 5) - struct md_mbuf *mbuf; /* NULL if ROFF_EXIT and error. */ + roffin roffin; + roffblkin roffblkin; + roffout roffout; + roffblkout roffblkout; + + struct md_mbuf *mbuf; /* NULL if !flush. */ const struct md_args *args; const struct md_rbuf *rbuf; }; -#define ROFF___ 0 -#define ROFF_Dd 1 -#define ROFF_Dt 2 -#define ROFF_Os 3 -#define ROFF_Sh 4 -#define ROFF_An 5 -#define ROFF_Li 6 -#define ROFF_MAX 7 - static int roff_Dd(ROFFCALL_ARGS); static int roff_Dt(ROFFCALL_ARGS); static int roff_Os(ROFFCALL_ARGS); -static int roff_Sh(ROFFCALL_ARGS); -static int roff_An(ROFFCALL_ARGS); -static int roff_Li(ROFFCALL_ARGS); -static struct roffnode *roffnode_new(int, size_t, - struct rofftree *); +static int roff_layout(ROFFCALL_ARGS); +static int roff_text(ROFFCALL_ARGS); + +static struct roffnode *roffnode_new(int, struct rofftree *); static void roffnode_free(int, struct rofftree *); static int rofffindtok(const char *); static int rofffindarg(const char *); +static int rofffindcallable(const char *); static int roffargs(int, char *, char **); static int roffparse(struct rofftree *, char *, size_t); static int textparse(const struct rofftree *, const char *, size_t); -static void dbg_enter(const struct md_args *, int); -static void dbg_leave(const struct md_args *, int); - -static const struct rofftok tokens[ROFF_MAX] = { - { "\\\"", NULL, ROFF_COMMENT, 0 }, - { "Dd", roff_Dd, ROFF_TITLE, 0 }, - { "Dt", roff_Dt, ROFF_TITLE, 0 }, - { "Os", roff_Os, ROFF_TITLE, 0 }, - { "Sh", roff_Sh, ROFF_LAYOUT, 0 }, - { "An", roff_An, ROFF_TEXT, ROFF_PARSED }, - { "Li", roff_Li, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, +static const struct rofftok tokens[ROFF_MAX] = { + { NULL, ROFF_COMMENT, 0 }, + { roff_Dd, ROFF_TEXT, 0 }, /* Dd */ + { roff_Dt, ROFF_TEXT, 0 }, /* Dt */ + { roff_Os, ROFF_TEXT, 0 }, /* Os */ + { roff_layout, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */ + { roff_layout, ROFF_LAYOUT, ROFF_PARSED }, /* Ss XXX */ + { roff_layout, ROFF_LAYOUT, 0 }, /* Pp */ + { roff_layout, ROFF_LAYOUT, 0 }, /* D1 */ + { roff_layout, ROFF_LAYOUT, 0 }, /* Dl */ + { roff_layout, ROFF_LAYOUT, 0 }, /* Bd */ + { roff_layout, ROFF_LAYOUT, 0 }, /* Ed */ + { roff_layout, ROFF_LAYOUT, 0 }, /* Bl */ + { roff_layout, ROFF_LAYOUT, 0 }, /* El */ + { roff_layout, ROFF_LAYOUT, 0 }, /* It */ + { roff_text, ROFF_TEXT, ROFF_PARSED }, /* An */ + { roff_text, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */ }; -#define ROFF_Split 0 -#define ROFF_Nosplit 1 -#define ROFF_ARGMAX 2 +/* FIXME: multiple owners? */ -static const struct roffarg tokenargs[ROFF_ARGMAX] = { - { "split", 0 }, - { "nosplit", 0 }, +static const struct roffarg tokenargs[ROFF_ARGMAX] = { + { ROFF_An, 0 }, /* split */ + { ROFF_An, 0 }, /* nosplit */ + { ROFF_Bd, 0 }, /* ragged */ + { ROFF_Bd, 0 }, /* unfilled */ + { ROFF_Bd, 0 }, /* literal */ + { ROFF_Bd, ROFF_VALUE }, /* file */ + { ROFF_Bd, ROFF_VALUE }, /* offset */ + { ROFF_Bl, 0 }, /* bullet */ + { ROFF_Bl, 0 }, /* dash */ + { ROFF_Bl, 0 }, /* hyphen */ + { ROFF_Bl, 0 }, /* item */ + { ROFF_Bl, 0 }, /* enum */ + { ROFF_Bl, 0 }, /* tag */ + { ROFF_Bl, 0 }, /* diag */ + { ROFF_Bl, 0 }, /* hang */ + { ROFF_Bl, 0 }, /* ohang */ + { ROFF_Bl, 0 }, /* inset */ + { ROFF_Bl, 0 }, /* column */ }; +static const char *const toknames[ROFF_MAX] = ROFF_NAMES; +static const char *const tokargnames[ROFF_ARGMAX] = ROFF_ARGNAMES; + int roff_free(struct rofftree *tree, int flush) { @@ -150,7 +171,7 @@ roff_free(struct rofftree *tree, int flush) /* LINTED */ while (tree->last) if ( ! (*tokens[tree->last->tok].cb) - (tree, NULL, ROFF_EXIT)) + (tree->last->tok, tree, NULL, ROFF_EXIT)) /* Disallow flushing. */ tree->mbuf = NULL; @@ -169,7 +190,8 @@ roff_free(struct rofftree *tree, int flush) struct rofftree * roff_alloc(const struct md_args *args, struct md_mbuf *out, - const struct md_rbuf *in) + const struct md_rbuf *in, roffin textin, + roffout textout, roffblkin blkin, roffblkout blkout) { struct rofftree *tree; @@ -182,6 +204,10 @@ roff_alloc(const struct md_args *args, struct md_mbuf tree->args = args; tree->mbuf = out; tree->rbuf = in; + tree->roffin = textin; + tree->roffout = textout; + tree->roffblkin = blkin; + tree->roffblkout = blkout; return(tree); } @@ -290,42 +316,11 @@ roffparse(struct rofftree *tree, char *buf, size_t sz) if ( ! roffargs(tok, buf, argv)) { warnx("%s: too many arguments to `%s' (line %zu)", - tree->rbuf->name, tokens[tok].name, + tree->rbuf->name, toknames[tok], tree->rbuf->line); return(0); } - /* Domain cross-contamination (and sanity) checks. */ - - switch (tokens[tok].type) { - case (ROFF_TITLE): - if (ROFF_PRELUDE & tree->state) { - assert( ! (ROFF_BODY & tree->state)); - break; - } - assert(ROFF_BODY & tree->state); - warnx("%s: prelude token `%s' in body (line %zu)", - tree->rbuf->name, tokens[tok].name, - tree->rbuf->line); - return(0); - case (ROFF_LAYOUT): - /* FALLTHROUGH */ - case (ROFF_TEXT): - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - break; - } - assert(ROFF_PRELUDE & tree->state); - warnx("%s: body token `%s' in prelude (line %zu)", - tree->rbuf->name, tokens[tok].name, - tree->rbuf->line); - return(0); - case (ROFF_COMMENT): - return(1); - default: - abort(); - } - /* * If this is a non-nestable layout token and we're below a * token of the same type, then recurse upward to the token, @@ -351,9 +346,8 @@ roffparse(struct rofftree *tree, char *buf, size_t sz) warnx("%s: scope of %s (line %zu) broken by " "%s (line %zu)", tree->rbuf->name, - tokens[tok].name, - node->line, - tokens[node->tok].name, + toknames[tok], node->line, + toknames[node->tok], tree->rbuf->line); return(0); } @@ -370,7 +364,7 @@ roffparse(struct rofftree *tree, char *buf, size_t sz) do { t = tree->last->tok; if ( ! (*tokens[tree->last->tok].cb) - (tree, NULL, ROFF_EXIT)) + (tree->last->tok, tree, NULL, ROFF_EXIT)) return(0); } while (t != tok); } @@ -378,7 +372,7 @@ roffparse(struct rofftree *tree, char *buf, size_t sz) /* Proceed with actual token processing. */ argvp = (const char **)&argv[1]; - return((*tokens[tok].cb)(tree, argvp, ROFF_ENTER)); + return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); } @@ -392,7 +386,7 @@ rofffindarg(const char *name) /* LINTED */ for (i = 0; i < ROFF_ARGMAX; i++) /* LINTED */ - if (0 == strcmp(name, tokenargs[i].name)) + if (0 == strcmp(name, tokargnames[i])) return((int)i); return(ROFF_ARGMAX); @@ -409,16 +403,26 @@ rofffindtok(const char *name) /* LINTED */ for (i = 0; i < ROFF_MAX; i++) /* LINTED */ - if (0 == strncmp(name, tokens[i].name, 2)) + if (0 == strncmp(name, toknames[i], 2)) return((int)i); return(ROFF_MAX); } -/* FIXME: accept only struct rofftree *. */ +static int +rofffindcallable(const char *name) +{ + int c; + + if (ROFF_MAX == (c = rofffindtok(name))) + return(ROFF_MAX); + return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX); +} + + static struct roffnode * -roffnode_new(int tokid, size_t line, struct rofftree *tree) +roffnode_new(int tokid, struct rofftree *tree) { struct roffnode *p; @@ -427,7 +431,7 @@ roffnode_new(int tokid, size_t line, struct rofftree * return(NULL); } - p->line = line; + p->line = tree->rbuf->line; p->tok = tokid; p->parent = tree->last; tree->last = p; @@ -449,83 +453,32 @@ roffnode_free(int tokid, struct rofftree *tree) } -static int dbg_lvl = 0; - - -static void -dbg_enter(const struct md_args *args, int tokid) -{ - int i; - static char buf[72]; - - assert(args); - if ( ! (args->dbg & MD_DBG_TREE)) - return; - assert(tokid >= 0 && tokid <= ROFF_MAX); - - buf[0] = buf[71] = 0; - - switch (tokens[tokid].type) { - case (ROFF_LAYOUT): - (void)strncat(buf, "[body-layout] ", sizeof(buf) - 1); - break; - case (ROFF_TEXT): - (void)strncat(buf, "[ body-text] ", sizeof(buf) - 1); - break; - case (ROFF_TITLE): - (void)strncat(buf, "[ prelude] ", sizeof(buf) - 1); - break; - default: - abort(); - } - - /* LINTED */ - for (i = 0; i < dbg_lvl; i++) - (void)strncat(buf, " ", sizeof(buf) - 1); - - (void)strncat(buf, tokens[tokid].name, sizeof(buf) - 1); - - (void)printf("%s\n", buf); - - dbg_lvl++; -} - - -/* FIXME: accept only struct rofftree *. */ -static void -dbg_leave(const struct md_args *args, int tokid) -{ - assert(args); - if ( ! (args->dbg & MD_DBG_TREE)) - return; - - assert(tokid >= 0 && tokid <= ROFF_MAX); - assert(dbg_lvl > 0); - dbg_lvl--; -} - - -/* FIXME: accept only struct rofftree *. */ /* ARGSUSED */ static int roff_Dd(ROFFCALL_ARGS) { - dbg_enter(tree->args, ROFF_Dd); + if (ROFF_BODY & tree->state) { + assert( ! (ROFF_PRELUDE & tree->state)); + assert(ROFF_PRELUDE_Dd & tree->state); + return(roff_text(tok, tree, argv, type)); + } assert(ROFF_PRELUDE & tree->state); - if (ROFF_PRELUDE_Dt & tree->state || - ROFF_PRELUDE_Dd & tree->state) { + assert( ! (ROFF_BODY & tree->state)); + + if (ROFF_PRELUDE_Dd & tree->state || + ROFF_PRELUDE_Dt & tree->state) { warnx("%s: prelude `Dd' out-of-order (line %zu)", tree->rbuf->name, tree->rbuf->line); return(0); } + /* TODO: parse date. */ + assert(NULL == tree->last); tree->state |= ROFF_PRELUDE_Dd; - dbg_leave(tree->args, ROFF_Dd); - return(1); } @@ -535,9 +488,15 @@ static int roff_Dt(ROFFCALL_ARGS) { - dbg_enter(tree->args, ROFF_Dt); + if (ROFF_BODY & tree->state) { + assert( ! (ROFF_PRELUDE & tree->state)); + assert(ROFF_PRELUDE_Dt & tree->state); + return(roff_text(tok, tree, argv, type)); + } assert(ROFF_PRELUDE & tree->state); + assert( ! (ROFF_BODY & tree->state)); + if ( ! (ROFF_PRELUDE_Dd & tree->state) || (ROFF_PRELUDE_Dt & tree->state)) { warnx("%s: prelude `Dt' out-of-order (line %zu)", @@ -545,11 +504,11 @@ roff_Dt(ROFFCALL_ARGS) return(0); } + /* TODO: parse date. */ + assert(NULL == tree->last); tree->state |= ROFF_PRELUDE_Dt; - dbg_leave(tree->args, ROFF_Dt); - return(1); } @@ -560,13 +519,14 @@ roff_Os(ROFFCALL_ARGS) { if (ROFF_EXIT == type) { - roffnode_free(ROFF_Os, tree); - dbg_leave(tree->args, ROFF_Os); - return(1); - } + assert(ROFF_PRELUDE_Os & tree->state); + return(roff_layout(tok, tree, argv, type)); + } else if (ROFF_BODY & tree->state) { + assert( ! (ROFF_PRELUDE & tree->state)); + assert(ROFF_PRELUDE_Os & tree->state); + return(roff_text(tok, tree, argv, type)); + } - dbg_enter(tree->args, ROFF_Os); - assert(ROFF_PRELUDE & tree->state); if ( ! (ROFF_PRELUDE_Dt & tree->state) || ! (ROFF_PRELUDE_Dd & tree->state)) { @@ -575,51 +535,20 @@ roff_Os(ROFFCALL_ARGS) return(0); } - assert(NULL == tree->last); - if (NULL == roffnode_new(ROFF_Os, tree->rbuf->line, tree)) - return(0); + /* TODO: extract OS. */ tree->state |= ROFF_PRELUDE_Os; tree->state &= ~ROFF_PRELUDE; tree->state |= ROFF_BODY; - return(1); -} + assert(NULL == tree->last); - -/* ARGSUSED */ -static int -roff_Sh(ROFFCALL_ARGS) -{ - - if (ROFF_EXIT == type) { - roffnode_free(ROFF_Sh, tree); - dbg_leave(tree->args, ROFF_Sh); - return(1); - } - - dbg_enter(tree->args, ROFF_Sh); - - if (NULL == roffnode_new(ROFF_Sh, tree->rbuf->line, tree)) - return(0); - - return(1); + return(roff_layout(tok, tree, argv, type)); } -/* ARGSUSED */ +/* ARGUSED */ static int -roff_Li(ROFFCALL_ARGS) -{ - - dbg_enter(tree->args, ROFF_Li); - dbg_leave(tree->args, ROFF_Li); - - return(1); -} - - -static int roffnextopt(const char ***in, char **val) { const char *arg, **argv; @@ -648,54 +577,115 @@ roffnextopt(const char ***in, char **val) /* ARGSUSED */ static int -roff_An(ROFFCALL_ARGS) +roff_layout(ROFFCALL_ARGS) { - int c; - char *val; + int i, c, argcp[ROFF_MAXARG]; + char *v, *argvp[ROFF_MAXARG]; - dbg_enter(tree->args, ROFF_An); + if (ROFF_PRELUDE & tree->state) { + warnx("%s: macro `%s' called in prelude (line %zu)", + tree->rbuf->name, toknames[tok], + tree->rbuf->line); + return(0); + } - while (-1 != (c = roffnextopt(&argv, &val))) { - switch (c) { - case (ROFF_Split): - /* Process argument. */ - break; - case (ROFF_Nosplit): - /* Process argument. */ - break; - default: - warnx("%s: error parsing `An' args (line %zu)", + if (ROFF_EXIT == type) { + roffnode_free(tok, tree); + return((*tree->roffblkout)(tok)); + } + + i = 0; + while (-1 != (c = roffnextopt(&argv, &v))) { + if (ROFF_ARGMAX == c) { + warnx("%s: error parsing `%s' args (line %zu)", tree->rbuf->name, + toknames[tok], tree->rbuf->line); return(0); } + argcp[i] = c; + argvp[i] = v; argv++; } - /* Print header. */ - + if (NULL == roffnode_new(tok, tree)) + return(0); + + if ( ! (*tree->roffin)(tok, argcp, argvp)) + return(0); + + if ( ! (ROFF_PARSED & tokens[tok].flags)) { + /* TODO: print all tokens. */ + + if ( ! ((*tree->roffout)(tok))) + return(0); + return((*tree->roffblkin)(tok)); + } + while (*argv) { - if (/* is_parsable && */ 2 >= strlen(*argv)) { - if (ROFF_MAX != (c = rofffindtok(*argv))) { - if (ROFF_CALLABLE & tokens[c].flags) { - /* Call to token. */ - if ( ! (*tokens[c].cb)(tree, (const char **)argv + 1, ROFF_ENTER)) - return(0); - } - /* Print token. */ - } else { - /* Print token. */ - } - } else { - /* Print token. */ + if (2 >= strlen(*argv) && ROFF_MAX != + (c = rofffindcallable(*argv))) + if ( ! (*tokens[c].cb)(c, tree, + argv + 1, ROFF_ENTER)) + return(0); + + /* TODO: print token. */ + argv++; + } + + if ( ! ((*tree->roffout)(tok))) + return(0); + + return((*tree->roffblkin)(tok)); +} + + +/* ARGSUSED */ +static int +roff_text(ROFFCALL_ARGS) +{ + int i, c, argcp[ROFF_MAXARG]; + char *v, *argvp[ROFF_MAXARG]; + + if (ROFF_PRELUDE & tree->state) { + warnx("%s: macro `%s' called in prelude (line %zu)", + tree->rbuf->name, toknames[tok], + tree->rbuf->line); + return(0); + } + + i = 0; + while (-1 != (c = roffnextopt(&argv, &v))) { + if (ROFF_ARGMAX == c) { + warnx("%s: error parsing `%s' args (line %zu)", + tree->rbuf->name, + toknames[tok], + tree->rbuf->line); + return(0); } + argcp[i] = c; + argvp[i] = v; argv++; } - /* Print footer. */ + if ( ! (*tree->roffin)(tok, argcp, argvp)) + return(0); - dbg_leave(tree->args, ROFF_An); + if ( ! (ROFF_PARSED & tokens[tok].flags)) { + /* TODO: print all tokens. */ + return((*tree->roffout)(tok)); + } - return(1); -} + while (*argv) { + if (2 >= strlen(*argv) && ROFF_MAX != + (c = rofffindcallable(*argv))) + if ( ! (*tokens[c].cb)(c, tree, + argv + 1, ROFF_ENTER)) + return(0); + /* TODO: print token. */ + argv++; + } + + return((*tree->roffout)(tok)); +}