=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.81 retrieving revision 1.122 diff -u -p -r1.81 -r1.122 --- mandoc/man.c 2010/07/07 15:04:54 1.81 +++ mandoc/man.c 2013/12/31 23:23:10 1.122 @@ -1,6 +1,6 @@ -/* $Id: man.c,v 1.81 2010/07/07 15:04:54 kristaps Exp $ */ +/* $Id: man.c,v 1.122 2013/12/31 23:23:10 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -21,12 +21,12 @@ #include #include -#include #include #include #include #include +#include "man.h" #include "mandoc.h" #include "libman.h" #include "libmandoc.h" @@ -37,15 +37,16 @@ const char *const __man_macronames[MAN_MAX] = { "IP", "HP", "SM", "SB", "BI", "IB", "BR", "RB", "R", "B", "I", "IR", - "RI", "na", "i", "sp", - "nf", "fi", "r", "RE", - "RS", "DT", "UC", "PD", - "Sp", "Vb", "Ve", "AT", + "RI", "na", "sp", "nf", + "fi", "RE", "RS", "DT", + "UC", "PD", "AT", "in", + "ft", "OP", "EX", "EE", + "UR", "UE" }; const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(int, int, +static struct man_node *man_node_alloc(struct man *, int, int, enum man_type, enum mant); static int man_node_append(struct man *, struct man_node *); @@ -56,22 +57,24 @@ static int man_ptext(struct man *, int, char *, int) static int man_pmacro(struct man *, int, char *, int); static void man_free1(struct man *); static void man_alloc1(struct man *); -static int macrowarn(struct man *, int, const char *, int); +static int man_descope(struct man *, int, int); const struct man_node * -man_node(const struct man *m) +man_node(const struct man *man) { - return(MAN_HALT & m->flags ? NULL : m->first); + assert( ! (MAN_HALT & man->flags)); + return(man->first); } const struct man_meta * -man_meta(const struct man *m) +man_meta(const struct man *man) { - return(MAN_HALT & m->flags ? NULL : &m->meta); + assert( ! (MAN_HALT & man->flags)); + return(&man->meta); } @@ -94,18 +97,15 @@ man_free(struct man *man) struct man * -man_alloc(struct regset *regs, void *data, - int pflags, mandocmsg msg) +man_alloc(struct roff *roff, struct mparse *parse) { struct man *p; p = mandoc_calloc(1, sizeof(struct man)); man_hash_init(); - p->data = data; - p->pflags = pflags; - p->msg = msg; - p->regs = regs; + p->parse = parse; + p->roff = roff; man_alloc1(p); return(p); @@ -113,28 +113,28 @@ man_alloc(struct regset *regs, void *data, int -man_endparse(struct man *m) +man_endparse(struct man *man) { - if (MAN_HALT & m->flags) - return(0); - else if (man_macroend(m)) + assert( ! (MAN_HALT & man->flags)); + if (man_macroend(man)) return(1); - m->flags |= MAN_HALT; + man->flags |= MAN_HALT; return(0); } int -man_parseln(struct man *m, int ln, char *buf, int offs) +man_parseln(struct man *man, int ln, char *buf, int offs) { - if (MAN_HALT & m->flags) - return(0); + man->flags |= MAN_NEWLINE; - return(('.' == buf[offs] || '\'' == buf[offs]) ? - man_pmacro(m, ln, buf, offs) : - man_ptext(m, ln, buf, offs)); + assert( ! (MAN_HALT & man->flags)); + + return (roff_getcontrol(man->roff, buf, &offs) ? + man_pmacro(man, ln, buf, offs) : + man_ptext(man, ln, buf, offs)); } @@ -148,8 +148,8 @@ man_free1(struct man *man) free(man->meta.title); if (man->meta.source) free(man->meta.source); - if (man->meta.rawdate) - free(man->meta.rawdate); + if (man->meta.date) + free(man->meta.date); if (man->meta.vol) free(man->meta.vol); if (man->meta.msec) @@ -158,16 +158,16 @@ man_free1(struct man *man) static void -man_alloc1(struct man *m) +man_alloc1(struct man *man) { - memset(&m->meta, 0, sizeof(struct man_meta)); - m->flags = 0; - m->last = mandoc_calloc(1, sizeof(struct man_node)); - m->first = m->last; - m->last->type = MAN_ROOT; - m->last->tok = MAN_MAX; - m->next = MAN_NEXT_CHILD; + memset(&man->meta, 0, sizeof(struct man_meta)); + man->flags = 0; + man->last = mandoc_calloc(1, sizeof(struct man_node)); + man->first = man->last; + man->last->type = MAN_ROOT; + man->last->tok = MAN_MAX; + man->next = MAN_NEXT_CHILD; } @@ -205,6 +205,10 @@ man_node_append(struct man *man, struct man_node *p) assert(MAN_BLOCK == p->parent->type); p->parent->head = p; break; + case (MAN_TAIL): + assert(MAN_BLOCK == p->parent->type); + p->parent->tail = p; + break; case (MAN_BODY): assert(MAN_BLOCK == p->parent->type); p->parent->body = p; @@ -216,11 +220,11 @@ man_node_append(struct man *man, struct man_node *p) man->last = p; switch (p->type) { + case (MAN_TBL): + /* FALLTHROUGH */ case (MAN_TEXT): if ( ! man_valid_post(man)) return(0); - if ( ! man_action_post(man)) - return(0); break; default: break; @@ -231,7 +235,8 @@ man_node_append(struct man *man, struct man_node *p) static struct man_node * -man_node_alloc(int line, int pos, enum man_type type, enum mant tok) +man_node_alloc(struct man *man, int line, int pos, + enum man_type type, enum mant tok) { struct man_node *p; @@ -240,81 +245,90 @@ man_node_alloc(int line, int pos, enum man_type type, p->pos = pos; p->type = type; p->tok = tok; + + if (MAN_NEWLINE & man->flags) + p->flags |= MAN_LINE; + man->flags &= ~MAN_NEWLINE; return(p); } int -man_elem_alloc(struct man *m, int line, int pos, enum mant tok) +man_elem_alloc(struct man *man, int line, int pos, enum mant tok) { struct man_node *p; - p = man_node_alloc(line, pos, MAN_ELEM, tok); - if ( ! man_node_append(m, p)) + p = man_node_alloc(man, line, pos, MAN_ELEM, tok); + if ( ! man_node_append(man, p)) return(0); - m->next = MAN_NEXT_CHILD; + man->next = MAN_NEXT_CHILD; return(1); } int -man_head_alloc(struct man *m, int line, int pos, enum mant tok) +man_tail_alloc(struct man *man, int line, int pos, enum mant tok) { struct man_node *p; - p = man_node_alloc(line, pos, MAN_HEAD, tok); - if ( ! man_node_append(m, p)) + p = man_node_alloc(man, line, pos, MAN_TAIL, tok); + if ( ! man_node_append(man, p)) return(0); - m->next = MAN_NEXT_CHILD; + man->next = MAN_NEXT_CHILD; return(1); } int -man_body_alloc(struct man *m, int line, int pos, enum mant tok) +man_head_alloc(struct man *man, int line, int pos, enum mant tok) { struct man_node *p; - p = man_node_alloc(line, pos, MAN_BODY, tok); - if ( ! man_node_append(m, p)) + p = man_node_alloc(man, line, pos, MAN_HEAD, tok); + if ( ! man_node_append(man, p)) return(0); - m->next = MAN_NEXT_CHILD; + man->next = MAN_NEXT_CHILD; return(1); } int -man_block_alloc(struct man *m, int line, int pos, enum mant tok) +man_body_alloc(struct man *man, int line, int pos, enum mant tok) { struct man_node *p; - p = man_node_alloc(line, pos, MAN_BLOCK, tok); - if ( ! man_node_append(m, p)) + p = man_node_alloc(man, line, pos, MAN_BODY, tok); + if ( ! man_node_append(man, p)) return(0); - m->next = MAN_NEXT_CHILD; + man->next = MAN_NEXT_CHILD; return(1); } int -man_word_alloc(struct man *m, int line, int pos, const char *word) +man_block_alloc(struct man *man, int line, int pos, enum mant tok) { - struct man_node *n; - size_t sv, len; + struct man_node *p; - len = strlen(word); + p = man_node_alloc(man, line, pos, MAN_BLOCK, tok); + if ( ! man_node_append(man, p)) + return(0); + man->next = MAN_NEXT_CHILD; + return(1); +} - n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX); - n->string = mandoc_malloc(len + 1); - sv = strlcpy(n->string, word, len + 1); +int +man_word_alloc(struct man *man, int line, int pos, const char *word) +{ + struct man_node *n; - /* Prohibit truncation. */ - assert(sv < len + 1); + n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX); + n->string = roff_strdup(man->roff, word); - if ( ! man_node_append(m, n)) + if ( ! man_node_append(man, n)) return(0); - m->next = MAN_NEXT_SIBLING; + man->next = MAN_NEXT_SIBLING; return(1); } @@ -334,47 +348,104 @@ man_node_free(struct man_node *p) void -man_node_delete(struct man *m, struct man_node *p) +man_node_delete(struct man *man, struct man_node *p) { while (p->child) - man_node_delete(m, p->child); + man_node_delete(man, p->child); - man_node_unlink(m, p); + man_node_unlink(man, p); man_node_free(p); } +int +man_addeqn(struct man *man, const struct eqn *ep) +{ + struct man_node *n; + assert( ! (MAN_HALT & man->flags)); + + n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX); + n->eqn = ep; + + if ( ! man_node_append(man, n)) + return(0); + + man->next = MAN_NEXT_SIBLING; + return(man_descope(man, ep->ln, ep->pos)); +} + +int +man_addspan(struct man *man, const struct tbl_span *sp) +{ + struct man_node *n; + + assert( ! (MAN_HALT & man->flags)); + + n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX); + n->span = sp; + + if ( ! man_node_append(man, n)) + return(0); + + man->next = MAN_NEXT_SIBLING; + return(man_descope(man, sp->line, 0)); +} + static int -man_ptext(struct man *m, int line, char *buf, int offs) +man_descope(struct man *man, int line, int offs) { - int i; + /* + * Co-ordinate what happens with having a next-line scope open: + * first close out the element scope (if applicable), then close + * out the block scope (also if applicable). + */ - /* Ignore bogus comments. */ + if (MAN_ELINE & man->flags) { + man->flags &= ~MAN_ELINE; + if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) + return(0); + } - if ('\\' == buf[offs] && - '.' == buf[offs + 1] && - '"' == buf[offs + 2]) - return(man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); + if ( ! (MAN_BLINE & man->flags)) + return(1); + man->flags &= ~MAN_BLINE; + if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) + return(0); + return(man_body_alloc(man, line, offs, man->last->tok)); +} + +static int +man_ptext(struct man *man, int line, char *buf, int offs) +{ + int i; + /* Literal free-form text whitespace is preserved. */ - if (MAN_LITERAL & m->flags) { - if ( ! man_word_alloc(m, line, offs, buf + offs)) + if (MAN_LITERAL & man->flags) { + if ( ! man_word_alloc(man, line, offs, buf + offs)) return(0); - goto descope; + return(man_descope(man, line, offs)); } - /* Pump blank lines directly into the backend. */ - for (i = offs; ' ' == buf[i]; i++) /* Skip leading whitespace. */ ; + /* + * Blank lines are ignored right after headings + * but add a single vertical space elsewhere. + */ + if ('\0' == buf[i]) { /* Allocate a blank entry. */ - if ( ! man_word_alloc(m, line, offs, "")) - return(0); - goto descope; + if (MAN_SH != man->last->tok && + MAN_SS != man->last->tok) { + if ( ! man_elem_alloc(man, line, offs, MAN_sp)) + return(0); + man->next = MAN_NEXT_SIBLING; + } + return(1); } /* @@ -387,8 +458,7 @@ man_ptext(struct man *m, int line, char *buf, int offs if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { if (i > 1 && '\\' != buf[i - 2]) - if ( ! man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE)) - return(0); + man_pmsg(man, line, i - 1, MANDOCERR_EOLNSPACE); for (--i; i && ' ' == buf[i]; i--) /* Spin back to non-space. */ ; @@ -399,7 +469,7 @@ man_ptext(struct man *m, int line, char *buf, int offs buf[i] = '\0'; } - if ( ! man_word_alloc(m, line, offs, buf + offs)) + if ( ! man_word_alloc(man, line, offs, buf + offs)) return(0); /* @@ -410,156 +480,113 @@ man_ptext(struct man *m, int line, char *buf, int offs assert(i); if (mandoc_eos(buf, (size_t)i)) - m->last->flags |= MAN_EOS; + man->last->flags |= MAN_EOS; -descope: - /* - * Co-ordinate what happens with having a next-line scope open: - * first close out the element scope (if applicable), then close - * out the block scope (also if applicable). - */ - - if (MAN_ELINE & m->flags) { - m->flags &= ~MAN_ELINE; - if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) - return(0); - } - - if ( ! (MAN_BLINE & m->flags)) - return(1); - m->flags &= ~MAN_BLINE; - - if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) - return(0); - return(man_body_alloc(m, line, offs, m->last->tok)); + return(man_descope(man, line, offs)); } - static int -macrowarn(struct man *m, int ln, const char *buf, int offs) +man_pmacro(struct man *man, int ln, char *buf, int offs) { - int rc; - - rc = man_vmsg(m, MANDOCERR_MACRO, ln, offs, - "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : ""); - - return(MAN_IGN_MACRO & m->pflags ? rc : 0); -} - - -int -man_pmacro(struct man *m, int ln, char *buf, int offs) -{ - int i, j, ppos; + int i, ppos; enum mant tok; char mac[5]; struct man_node *n; - /* Comments and empties are quickly ignored. */ - - offs++; - - if ('\0' == buf[offs]) + if ('"' == buf[offs]) { + man_pmsg(man, ln, offs, MANDOCERR_BADCOMMENT); return(1); + } else if ('\0' == buf[offs]) + return(1); - i = offs; + ppos = offs; /* - * Skip whitespace between the control character and initial - * text. "Whitespace" is both spaces and tabs. + * Copy the first word into a nil-terminated buffer. + * Stop copying when a tab, space, or eoln is encountered. */ - if (' ' == buf[i] || '\t' == buf[i]) { - i++; - while (buf[i] && (' ' == buf[i] || '\t' == buf[i])) - i++; - if ('\0' == buf[i]) - goto out; - } + i = 0; + while (i < 4 && '\0' != buf[offs] && + ' ' != buf[offs] && '\t' != buf[offs]) + mac[i++] = buf[offs++]; - ppos = i; + mac[i] = '\0'; - /* Copy the first word into a nil-terminated buffer. */ + tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; - for (j = 0; j < 4; j++, i++) { - if ('\0' == (mac[j] = buf[i])) - break; - else if (' ' == buf[i]) - break; - - /* Check for invalid characters. */ - - if (isgraph((u_char)buf[i])) - continue; - if ( ! man_pmsg(m, ln, i, MANDOCERR_BADCHAR)) - return(0); - i--; - } - - mac[j] = '\0'; - - if (j == 4 || j < 1) { - if ( ! macrowarn(m, ln, mac, ppos)) - goto err; + if (MAN_MAX == tok) { + mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln, + ppos, "%s", buf + ppos - 1); return(1); } - - if (MAN_MAX == (tok = man_hash_find(mac))) { - if ( ! macrowarn(m, ln, mac, ppos)) - goto err; - return(1); - } /* The macro is sane. Jump to the next word. */ - while (buf[i] && ' ' == buf[i]) - i++; + while (buf[offs] && ' ' == buf[offs]) + offs++; /* * Trailing whitespace. Note that tabs are allowed to be passed * into the parser as "text", so we only warn about spaces here. */ - if ('\0' == buf[i] && ' ' == buf[i - 1]) - if ( ! man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) - goto err; + if ('\0' == buf[offs] && ' ' == buf[offs - 1]) + man_pmsg(man, ln, offs - 1, MANDOCERR_EOLNSPACE); /* - * Remove prior ELINE macro, as it's being clobbering by a new + * Remove prior ELINE macro, as it's being clobbered by a new * macro. Note that NSCOPED macros do not close out ELINE * macros---they don't print text---so we let those slip by. */ if ( ! (MAN_NSCOPED & man_macros[tok].flags) && - m->flags & MAN_ELINE) { - assert(MAN_TEXT != m->last->type); + man->flags & MAN_ELINE) { + n = man->last; + assert(MAN_TEXT != n->type); - /* - * This occurs in the following construction: - * .B - * .br - * .B - * .br - * I hate man macros. - * Flat-out disallow this madness. + /* Remove repeated NSCOPED macros causing ELINE. */ + + if (MAN_NSCOPED & man_macros[n->tok].flags) + n = n->parent; + + mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line, + n->pos, "%s breaks %s", man_macronames[tok], + man_macronames[n->tok]); + + man_node_delete(man, n); + man->flags &= ~MAN_ELINE; + } + + /* + * Remove prior BLINE macro that is being clobbered. + */ + if ((man->flags & MAN_BLINE) && + (MAN_BSCOPE & man_macros[tok].flags)) { + n = man->last; + + /* Might be a text node like 8 in + * .TP 8 + * .SH foo */ - if (MAN_NSCOPED & man_macros[m->last->tok].flags) { - man_pmsg(m, ln, ppos, MANDOCERR_SYNTLINESCOPE); - return(0); - } + if (MAN_TEXT == n->type) + n = n->parent; - n = m->last; + /* Remove element that didn't end BLINE, if any. */ + if ( ! (MAN_BSCOPE & man_macros[n->tok].flags)) + n = n->parent; - assert(n); - assert(NULL == n->child); - assert(0 == n->nchild); + assert(MAN_HEAD == n->type); + n = n->parent; + assert(MAN_BLOCK == n->type); + assert(MAN_SCOPED & man_macros[n->tok].flags); - if ( ! man_nmsg(m, n, MANDOCERR_LINESCOPE)) - return(0); + mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line, + n->pos, "%s breaks %s", man_macronames[tok], + man_macronames[n->tok]); - man_node_delete(m, n); - m->flags &= ~MAN_ELINE; + man_node_delete(man, n); + man->flags &= ~MAN_BLINE; } /* @@ -568,34 +595,33 @@ man_pmacro(struct man *m, int ln, char *buf, int offs) * when they exit. */ - if (MAN_BLINE & m->flags) - m->flags |= MAN_BPLINE; + if (MAN_BLINE & man->flags) + man->flags |= MAN_BPLINE; /* Call to handler... */ assert(man_macros[tok].fp); - if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf)) + if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf)) goto err; -out: /* * We weren't in a block-line scope when entering the * above-parsed macro, so return. */ - if ( ! (MAN_BPLINE & m->flags)) { - m->flags &= ~MAN_ILINE; + if ( ! (MAN_BPLINE & man->flags)) { + man->flags &= ~MAN_ILINE; return(1); } - m->flags &= ~MAN_BPLINE; + man->flags &= ~MAN_BPLINE; /* * If we're in a block scope, then allow this macro to slip by * without closing scope around it. */ - if (MAN_ILINE & m->flags) { - m->flags &= ~MAN_ILINE; + if (MAN_ILINE & man->flags) { + man->flags &= ~MAN_ILINE; return(1); } @@ -604,45 +630,30 @@ out: * now, as the next line will close out the block scope. */ - if (MAN_ELINE & m->flags) + if (MAN_ELINE & man->flags) return(1); /* Close out the block scope opened in the prior line. */ - assert(MAN_BLINE & m->flags); - m->flags &= ~MAN_BLINE; + assert(MAN_BLINE & man->flags); + man->flags &= ~MAN_BLINE; - if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) + if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) return(0); - return(man_body_alloc(m, ln, offs, m->last->tok)); + return(man_body_alloc(man, ln, ppos, man->last->tok)); err: /* Error out. */ - m->flags |= MAN_HALT; + man->flags |= MAN_HALT; return(0); } - -int -man_vmsg(struct man *man, enum mandocerr t, - int ln, int pos, const char *fmt, ...) -{ - char buf[256]; - va_list ap; - - va_start(ap, fmt); - vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - return((*man->msg)(t, man->data, ln, pos, buf)); -} - - /* - * Unlink a node from its context. If "m" is provided, the last parse + * Unlink a node from its context. If "man" is provided, the last parse * point will also be adjusted accordingly. */ static void -man_node_unlink(struct man *m, struct man_node *n) +man_node_unlink(struct man *man, struct man_node *n) { /* Adjust siblings. */ @@ -662,18 +673,26 @@ man_node_unlink(struct man *m, struct man_node *n) /* Adjust parse point, if applicable. */ - if (m && m->last == n) { + if (man && man->last == n) { /*XXX: this can occur when bailing from validation. */ /*assert(NULL == n->next);*/ if (n->prev) { - m->last = n->prev; - m->next = MAN_NEXT_SIBLING; + man->last = n->prev; + man->next = MAN_NEXT_SIBLING; } else { - m->last = n->parent; - m->next = MAN_NEXT_CHILD; + man->last = n->parent; + man->next = MAN_NEXT_CHILD; } } - if (m && m->first == n) - m->first = NULL; + if (man && man->first == n) + man->first = NULL; +} + +const struct mparse * +man_mparse(const struct man *man) +{ + + assert(man && man->parse); + return(man->parse); }