=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.91 retrieving revision 1.104 diff -u -p -r1.91 -r1.104 --- mandoc/roff.c 2010/06/27 16:36:22 1.91 +++ mandoc/roff.c 2010/12/01 10:31:35 1.104 @@ -1,6 +1,7 @@ -/* $Id: roff.c,v 1.91 2010/06/27 16:36:22 kristaps Exp $ */ +/* $Id: roff.c,v 1.104 2010/12/01 10:31:35 kristaps Exp $ */ /* * Copyright (c) 2010 Kristaps Dzonsons + * Copyright (c) 2010 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -27,8 +28,8 @@ #include #include "mandoc.h" -#include "regs.h" #include "roff.h" +#include "libmandoc.h" #define RSTACK_MAX 128 @@ -44,6 +45,7 @@ #endif enum rofft { + ROFF_ad, ROFF_am, ROFF_ami, ROFF_am1, @@ -52,14 +54,17 @@ enum rofft { ROFF_de1, ROFF_ds, ROFF_el, + ROFF_hy, ROFF_ie, ROFF_if, ROFF_ig, + ROFF_ne, + ROFF_nh, + ROFF_nr, ROFF_rm, ROFF_tr, ROFF_cblock, - ROFF_ccond, - ROFF_nr, + ROFF_ccond, /* FIXME: remove this. */ ROFF_MAX }; @@ -68,6 +73,13 @@ enum roffrule { ROFFRULE_DENY }; + +struct roffstr { + char *name; /* key of symbol */ + char *string; /* current value */ + struct roffstr *next; /* next in list */ +}; + struct roff { struct roffnode *last; /* leaf of stack */ mandocmsg msg; /* err/warn/fatal messages */ @@ -75,6 +87,7 @@ struct roff { enum roffrule rstack[RSTACK_MAX]; /* stack of !`ie' rules */ int rstackpos; /* position in rstack */ struct regset *regs; /* read/writable registers */ + struct roffstr *first_string; }; struct roffnode { @@ -116,9 +129,19 @@ static enum rofferr roff_ccond(ROFF_ARGS); static enum rofferr roff_cond(ROFF_ARGS); static enum rofferr roff_cond_text(ROFF_ARGS); static enum rofferr roff_cond_sub(ROFF_ARGS); -static enum rofferr roff_line(ROFF_ARGS); -static enum rofferr roff_nr(ROFF_ARGS); +static enum rofferr roff_ds(ROFF_ARGS); static enum roffrule roff_evalcond(const char *, int *); +static void roff_freestr(struct roff *); +static const char *roff_getstrn(const struct roff *, + const char *, size_t); +static enum rofferr roff_line_ignore(ROFF_ARGS); +static enum rofferr roff_line_error(ROFF_ARGS); +static enum rofferr roff_nr(ROFF_ARGS); +static int roff_res(struct roff *, + char **, size_t *, int); +static void roff_setstr(struct roff *, + const char *, const char *); +static char *roff_strdup(const char *); /* See roff_hash_find() */ @@ -129,29 +152,33 @@ static enum roffrule roff_evalcond(const char *, int static struct roffmac *hash[HASHWIDTH]; static struct roffmac roffs[ROFF_MAX] = { + { "ad", roff_line_ignore, NULL, NULL, 0, NULL }, { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL }, { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL }, { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL }, { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL }, { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL }, { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL }, - { "ds", roff_line, NULL, NULL, 0, NULL }, + { "ds", roff_ds, NULL, NULL, 0, NULL }, { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL }, + { "hy", roff_line_ignore, NULL, NULL, 0, NULL }, { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL }, { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL }, { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL }, - { "rm", roff_line, NULL, NULL, 0, NULL }, - { "tr", roff_line, NULL, NULL, 0, NULL }, + { "ne", roff_line_ignore, NULL, NULL, 0, NULL }, + { "nh", roff_line_ignore, NULL, NULL, 0, NULL }, + { "nr", roff_nr, NULL, NULL, 0, NULL }, + { "rm", roff_line_error, NULL, NULL, 0, NULL }, + { "tr", roff_line_ignore, NULL, NULL, 0, NULL }, { ".", roff_cblock, NULL, NULL, 0, NULL }, { "\\}", roff_ccond, NULL, NULL, 0, NULL }, - { "nr", roff_nr, NULL, NULL, 0, NULL }, }; static void roff_free1(struct roff *); static enum rofft roff_hash_find(const char *); static void roff_hash_init(void); static void roffnode_cleanscope(struct roff *); -static int roffnode_push(struct roff *, +static void roffnode_push(struct roff *, enum rofft, int, int); static void roffnode_pop(struct roff *); static enum rofft roff_parse(const char *, int *); @@ -230,6 +257,7 @@ roffnode_pop(struct roff *r) if (r->rstackpos > -1) r->rstackpos--; + ROFF_DEBUG("roff: popping scope\n"); r->last = r->last->parent; if (p->end) free(p->end); @@ -241,16 +269,12 @@ roffnode_pop(struct roff *r) * Push a roff node onto the instruction stack. This must later be * removed with roffnode_pop(). */ -static int +static void roffnode_push(struct roff *r, enum rofft tok, int line, int col) { struct roffnode *p; - if (NULL == (p = calloc(1, sizeof(struct roffnode)))) { - (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL); - return(0); - } - + p = mandoc_calloc(1, sizeof(struct roffnode)); p->tok = tok; p->parent = r->last; p->line = line; @@ -258,7 +282,6 @@ roffnode_push(struct roff *r, enum rofft tok, int line p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY; r->last = p; - return(1); } @@ -268,6 +291,7 @@ roff_free1(struct roff *r) while (r->last) roffnode_pop(r); + roff_freestr(r); } @@ -289,15 +313,11 @@ roff_free(struct roff *r) struct roff * -roff_alloc(struct regset *regs, const mandocmsg msg, void *data) +roff_alloc(struct regset *regs, void *data, const mandocmsg msg) { struct roff *r; - if (NULL == (r = calloc(1, sizeof(struct roff)))) { - (*msg)(MANDOCERR_MEM, data, 0, 0, NULL); - return(0); - } - + r = mandoc_calloc(1, sizeof(struct roff)); r->regs = regs; r->msg = msg; r->data = data; @@ -308,6 +328,74 @@ roff_alloc(struct regset *regs, const mandocmsg msg, v } +/* + * Pre-filter each and every line for reserved words (one beginning with + * `\*', e.g., `\*(ab'). These must be handled before the actual line + * is processed. + */ +static int +roff_res(struct roff *r, char **bufp, size_t *szp, int pos) +{ + const char *cp, *cpp, *st, *res; + int i, maxl; + size_t nsz; + char *n; + + /* LINTED */ + for (cp = &(*bufp)[pos]; (cpp = strstr(cp, "\\*")); cp++) { + cp = cpp + 2; + switch (*cp) { + case ('('): + cp++; + maxl = 2; + break; + case ('['): + cp++; + maxl = 0; + break; + default: + maxl = 1; + break; + } + + st = cp; + + for (i = 0; 0 == maxl || i < maxl; i++, cp++) { + if ('\0' == *cp) + return(1); /* Error. */ + if (0 == maxl && ']' == *cp) + break; + } + + res = roff_getstrn(r, st, (size_t)i); + + if (NULL == res) { + cp -= maxl ? 1 : 0; + continue; + } + + ROFF_DEBUG("roff: splicing reserved: [%.*s]\n", i, st); + + nsz = *szp + strlen(res) + 1; + n = mandoc_malloc(nsz); + + *n = '\0'; + + strlcat(n, *bufp, (size_t)(cpp - *bufp + 1)); + strlcat(n, res, nsz); + strlcat(n, cp + (maxl ? 0 : 1), nsz); + + free(*bufp); + + *bufp = n; + *szp = nsz; + return(0); + } + + return(1); +} + + enum rofferr roff_parseln(struct roff *r, int ln, char **bufp, size_t *szp, int pos, int *offs) @@ -316,6 +404,14 @@ roff_parseln(struct roff *r, int ln, char **bufp, int ppos; /* + * Run the reserved-word filter only if we have some reserved + * words to fill in. + */ + + if (r->first_string && ! roff_res(r, bufp, szp, pos)) + return(ROFF_RERUN); + + /* * First, if a scope is open and we're not a macro, pass the * text through the macro's filter. If a scope isn't open and * we're not a macro, just let it through. @@ -329,11 +425,8 @@ roff_parseln(struct roff *r, int ln, char **bufp, return((*roffs[t].text) (r, t, bufp, szp, ln, pos, pos, offs)); - } else if ( ! ROFF_CTL((*bufp)[pos])) { - ROFF_DEBUG("roff: pass non-scoped text: [%s]\n", - &(*bufp)[pos]); + } else if ( ! ROFF_CTL((*bufp)[pos])) return(ROFF_CONT); - } /* * If a scope is open, go to the child handler for that macro, @@ -343,8 +436,8 @@ roff_parseln(struct roff *r, int ln, char **bufp, if (r->last) { t = r->last->tok; assert(roffs[t].sub); - ROFF_DEBUG("roff: intercept scoped context: %s\n", - roffs[t].name); + ROFF_DEBUG("roff: intercept scoped context: %s, [%s]\n", + roffs[t].name, &(*bufp)[pos]); return((*roffs[t].sub) (r, t, bufp, szp, ln, pos, pos, offs)); @@ -357,11 +450,8 @@ roff_parseln(struct roff *r, int ln, char **bufp, */ ppos = pos; - if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) { - ROFF_DEBUG("roff: pass non-scoped non-macro: [%s]\n", - &(*bufp)[pos]); + if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) return(ROFF_CONT); - } ROFF_DEBUG("roff: intercept new-scope: %s, [%s]\n", roffs[t].name, &(*bufp)[pos]); @@ -562,8 +652,7 @@ roff_block(ROFF_ARGS) pos++; } - if ( ! roffnode_push(r, tok, ln, ppos)) - return(ROFF_ERR); + roffnode_push(r, tok, ln, ppos); if ('\0' == (*bufp)[pos]) return(ROFF_IGN); @@ -585,13 +674,8 @@ roff_block(ROFF_ARGS) if (1 == sz && '.' == (*bufp)[sv]) return(ROFF_IGN); - r->last->end = malloc(sz + 1); + r->last->end = mandoc_malloc(sz + 1); - if (NULL == r->last->end) { - (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL); - return(ROFF_ERR); - } - memcpy(r->last->end, *bufp + sv, sz); r->last->end[(int)sz] = '\0'; @@ -674,7 +758,6 @@ roff_cond_sub(ROFF_ARGS) { enum rofft t; enum roffrule rr; - struct roffnode *l; ppos = pos; rr = r->last->rule; @@ -684,15 +767,16 @@ roff_cond_sub(ROFF_ARGS) * continue. */ - l = r->last; roffnode_cleanscope(r); - if (l != r->last) + if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) { + if ('\\' == (*bufp)[pos] && '}' == (*bufp)[pos + 1]) + return(roff_ccond + (r, ROFF_ccond, bufp, szp, + ln, pos, pos + 2, offs)); return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT); + } - if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) - return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT); - /* * A denied conditional must evaluate its children if and only * if they're either structurally required (such as loops and @@ -723,6 +807,8 @@ roff_cond_text(ROFF_ARGS) * scope permits us to do so. */ + /* FIXME: use roff_ccond? */ + st = &(*bufp)[pos]; if (NULL == (ep = strstr(st, "\\}"))) { roffnode_cleanscope(r); @@ -761,16 +847,23 @@ roff_evalcond(const char *v, int *pos) return(ROFFRULE_DENY); } - /* ARGSUSED */ static enum rofferr -roff_line(ROFF_ARGS) +roff_line_ignore(ROFF_ARGS) { return(ROFF_IGN); } +/* ARGSUSED */ +static enum rofferr +roff_line_error(ROFF_ARGS) +{ + (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, roffs[tok].name); + return(ROFF_IGN); +} + /* ARGSUSED */ static enum rofferr roff_cond(ROFF_ARGS) @@ -817,8 +910,7 @@ roff_cond(ROFF_ARGS) return(ROFF_ERR); } - if ( ! roffnode_push(r, tok, ln, ppos)) - return(ROFF_ERR); + roffnode_push(r, tok, ln, ppos); r->last->rule = rule; @@ -879,6 +971,49 @@ roff_cond(ROFF_ARGS) /* ARGSUSED */ static enum rofferr +roff_ds(ROFF_ARGS) +{ + char *name, *string; + + /* + * A symbol is named by the first word following the macro + * invocation up to a space. Its value is anything after the + * name's trailing whitespace and optional double-quote. Thus, + * + * [.ds foo "bar " ] + * + * will have `bar " ' as its value. + */ + + name = *bufp + pos; + if ('\0' == *name) + return(ROFF_IGN); + + string = name; + /* Read until end of name. */ + while (*string && ' ' != *string) + string++; + + /* Nil-terminate name. */ + if (*string) + *(string++) = '\0'; + + /* Read past spaces. */ + while (*string && ' ' == *string) + string++; + + /* Read passed initial double-quote. */ + if (*string && '"' == *string) + string++; + + /* The rest is the value. */ + roff_setstr(r, name, string); + return(ROFF_IGN); +} + + +/* ARGSUSED */ +static enum rofferr roff_nr(ROFF_ARGS) { const char *key, *val; @@ -917,4 +1052,79 @@ roff_nr(ROFF_ARGS) ROFF_DEBUG("roff: ignoring register: %s\n", key); return(ROFF_IGN); +} + + +static char * +roff_strdup(const char *name) +{ + char *namecopy, *sv; + + /* + * This isn't a nice simple mandoc_strdup() because we must + * handle roff's stupid double-escape rule. + */ + sv = namecopy = mandoc_malloc(strlen(name) + 1); + while (*name) { + if ('\\' == *name && '\\' == *(name + 1)) + name++; + *namecopy++ = *name++; + } + + *namecopy = '\0'; + return(sv); +} + + +static void +roff_setstr(struct roff *r, const char *name, const char *string) +{ + struct roffstr *n; + char *namecopy; + + n = r->first_string; + while (n && strcmp(name, n->name)) + n = n->next; + + if (NULL == n) { + namecopy = mandoc_strdup(name); + n = mandoc_malloc(sizeof(struct roffstr)); + n->name = namecopy; + n->next = r->first_string; + r->first_string = n; + } else + free(n->string); + + /* Don't use mandoc_strdup: clean out double-escapes. */ + n->string = string ? roff_strdup(string) : NULL; + ROFF_DEBUG("roff: new symbol: [%s] = [%s]\n", name, n->string); +} + + +static const char * +roff_getstrn(const struct roff *r, const char *name, size_t len) +{ + const struct roffstr *n; + + n = r->first_string; + while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len])) + n = n->next; + + return(n ? n->string : NULL); +} + + +static void +roff_freestr(struct roff *r) +{ + struct roffstr *n, *nn; + + for (n = r->first_string; n; n = nn) { + free(n->name); + free(n->string); + nn = n->next; + free(n); + } + + r->first_string = NULL; }