=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.148 retrieving revision 1.161 diff -u -p -r1.148 -r1.161 --- mandoc/man.c 2015/01/24 02:41:49 1.148 +++ mandoc/man.c 2015/04/19 14:57:38 1.161 @@ -1,16 +1,16 @@ -/* $Id: man.c,v 1.148 2015/01/24 02:41:49 schwarze Exp $ */ +/* $Id: man.c,v 1.161 2015/04/19 14:57:38 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons - * Copyright (c) 2013, 2014 Ingo Schwarze + * Copyright (c) 2013, 2014, 2015 Ingo Schwarze * Copyright (c) 2011 Joerg Sonnenberger * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF @@ -27,11 +27,13 @@ #include #include -#include "man.h" -#include "mandoc.h" #include "mandoc_aux.h" -#include "libman.h" +#include "mandoc.h" +#include "roff.h" +#include "man.h" #include "libmandoc.h" +#include "roff_int.h" +#include "libman.h" const char *const __man_macronames[MAN_MAX] = { "br", "TH", "SH", "SS", @@ -48,79 +50,23 @@ const char *const __man_macronames[MAN_MAX] = { const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(struct man *, int, int, - enum man_type, enum mant); -static void man_node_append(struct man *, struct man_node *); -static void man_node_free(struct man_node *); -static void man_node_unlink(struct man *, - struct man_node *); -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 void man_descope(struct man *, int, int); +static void man_descope(struct roff_man *, int, int); +static int man_ptext(struct roff_man *, int, char *, int); +static int man_pmacro(struct roff_man *, int, char *, int); -const struct man_node * -man_node(const struct man *man) -{ - - return(man->first); -} - -const struct man_meta * -man_meta(const struct man *man) -{ - - return(&man->meta); -} - void -man_reset(struct man *man) +man_endparse(struct roff_man *man) { - man_free1(man); - man_alloc1(man); -} - -void -man_free(struct man *man) -{ - - man_free1(man); - free(man); -} - -struct man * -man_alloc(struct roff *roff, struct mparse *parse, - const char *defos, int quick) -{ - struct man *p; - - p = mandoc_calloc(1, sizeof(struct man)); - - man_hash_init(); - p->parse = parse; - p->defos = defos; - p->quick = quick; - p->roff = roff; - - man_alloc1(p); - return(p); -} - -void -man_endparse(struct man *man) -{ - man_macroend(man); } int -man_parseln(struct man *man, int ln, char *buf, int offs) +man_parseln(struct roff_man *man, int ln, char *buf, int offs) { - if (man->last->type != MAN_EQN || ln > man->last->line) + if (man->last->type != ROFFT_EQN || ln > man->last->line) man->flags |= MAN_NEWLINE; return (roff_getcontrol(man->roff, buf, &offs) ? @@ -129,224 +75,8 @@ man_parseln(struct man *man, int ln, char *buf, int of } static void -man_free1(struct man *man) +man_descope(struct roff_man *man, int line, int offs) { - - if (man->first) - man_node_delete(man, man->first); - free(man->meta.title); - free(man->meta.source); - free(man->meta.date); - free(man->meta.vol); - free(man->meta.msec); -} - -static void -man_alloc1(struct man *man) -{ - - 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; -} - - -static void -man_node_append(struct man *man, struct man_node *p) -{ - - assert(man->last); - assert(man->first); - assert(p->type != MAN_ROOT); - - switch (man->next) { - case MAN_NEXT_SIBLING: - man->last->next = p; - p->prev = man->last; - p->parent = man->last->parent; - break; - case MAN_NEXT_CHILD: - man->last->child = p; - p->parent = man->last; - break; - default: - abort(); - /* NOTREACHED */ - } - - assert(p->parent); - p->parent->nchild++; - - switch (p->type) { - case MAN_BLOCK: - if (p->tok == MAN_SH || p->tok == MAN_SS) - man->flags &= ~MAN_LITERAL; - break; - case MAN_HEAD: - assert(p->parent->type == MAN_BLOCK); - p->parent->head = p; - break; - case MAN_BODY: - assert(p->parent->type == MAN_BLOCK); - p->parent->body = p; - break; - default: - break; - } - - man->last = p; - - switch (p->type) { - case MAN_TBL: - /* FALLTHROUGH */ - case MAN_TEXT: - man_valid_post(man); - break; - default: - break; - } -} - -static struct man_node * -man_node_alloc(struct man *man, int line, int pos, - enum man_type type, enum mant tok) -{ - struct man_node *p; - - p = mandoc_calloc(1, sizeof(struct man_node)); - p->line = line; - p->pos = pos; - p->type = type; - p->tok = tok; - - if (man->flags & MAN_NEWLINE) - p->flags |= MAN_LINE; - man->flags &= ~MAN_NEWLINE; - return(p); -} - -void -man_elem_alloc(struct man *man, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(man, line, pos, MAN_ELEM, tok); - man_node_append(man, p); - man->next = MAN_NEXT_CHILD; -} - -void -man_head_alloc(struct man *man, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(man, line, pos, MAN_HEAD, tok); - man_node_append(man, p); - man->next = MAN_NEXT_CHILD; -} - -void -man_body_alloc(struct man *man, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(man, line, pos, MAN_BODY, tok); - man_node_append(man, p); - man->next = MAN_NEXT_CHILD; -} - -void -man_block_alloc(struct man *man, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(man, line, pos, MAN_BLOCK, tok); - man_node_append(man, p); - man->next = MAN_NEXT_CHILD; -} - -void -man_word_alloc(struct man *man, int line, int pos, const char *word) -{ - struct man_node *n; - - n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX); - n->string = roff_strdup(man->roff, word); - man_node_append(man, n); - man->next = MAN_NEXT_SIBLING; -} - -void -man_word_append(struct man *man, const char *word) -{ - struct man_node *n; - char *addstr, *newstr; - - n = man->last; - addstr = roff_strdup(man->roff, word); - mandoc_asprintf(&newstr, "%s %s", n->string, addstr); - free(addstr); - free(n->string); - n->string = newstr; - man->next = MAN_NEXT_SIBLING; -} - -/* - * Free all of the resources held by a node. This does NOT unlink a - * node from its context; for that, see man_node_unlink(). - */ -static void -man_node_free(struct man_node *p) -{ - - free(p->string); - free(p); -} - -void -man_node_delete(struct man *man, struct man_node *p) -{ - - while (p->child) - man_node_delete(man, p->child); - - man_node_unlink(man, p); - man_node_free(p); -} - -void -man_addeqn(struct man *man, const struct eqn *ep) -{ - struct man_node *n; - - n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX); - n->eqn = ep; - if (ep->ln > man->last->line) - n->flags |= MAN_LINE; - man_node_append(man, n); - man->next = MAN_NEXT_SIBLING; - man_descope(man, ep->ln, ep->pos); -} - -void -man_addspan(struct man *man, const struct tbl_span *sp) -{ - struct man_node *n; - - n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX); - n->span = sp; - man_node_append(man, n); - man->next = MAN_NEXT_SIBLING; - man_descope(man, sp->line, 0); -} - -static void -man_descope(struct man *man, int line, int offs) -{ /* * Co-ordinate what happens with having a next-line scope open: * first close out the element scope (if applicable), then close @@ -361,18 +91,18 @@ man_descope(struct man *man, int line, int offs) return; man->flags &= ~MAN_BLINE; man_unscope(man, man->last->parent); - man_body_alloc(man, line, offs, man->last->tok); + roff_body_alloc(man, line, offs, man->last->tok); } static int -man_ptext(struct man *man, int line, char *buf, int offs) +man_ptext(struct roff_man *man, int line, char *buf, int offs) { int i; /* Literal free-form text whitespace is preserved. */ if (man->flags & MAN_LITERAL) { - man_word_alloc(man, line, offs, buf + offs); + roff_word_alloc(man, line, offs, buf + offs); man_descope(man, line, offs); return(1); } @@ -389,8 +119,8 @@ man_ptext(struct man *man, int line, char *buf, int of /* Allocate a blank entry. */ if (man->last->tok != MAN_SH && man->last->tok != MAN_SS) { - man_elem_alloc(man, line, offs, MAN_sp); - man->next = MAN_NEXT_SIBLING; + roff_elem_alloc(man, line, offs, MAN_sp); + man->next = ROFF_NEXT_SIBLING; } return(1); } @@ -416,7 +146,7 @@ man_ptext(struct man *man, int line, char *buf, int of buf[i] = '\0'; } - man_word_alloc(man, line, offs, buf + offs); + roff_word_alloc(man, line, offs, buf + offs); /* * End-of-sentence check. If the last character is an unescaped @@ -433,11 +163,11 @@ man_ptext(struct man *man, int line, char *buf, int of } static int -man_pmacro(struct man *man, int ln, char *buf, int offs) +man_pmacro(struct roff_man *man, int ln, char *buf, int offs) { - struct man_node *n; + struct roff_node *n; const char *cp; - enum mant tok; + int tok; int i, ppos; int bline; char mac[5]; @@ -455,9 +185,9 @@ man_pmacro(struct man *man, int ln, char *buf, int off mac[i] = '\0'; - tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; + tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE; - if (tok == MAN_MAX) { + if (tok == TOKEN_NONE) { mandoc_msg(MANDOCERR_MACRO, man->parse, ln, ppos, buf + ppos - 1); return(1); @@ -493,62 +223,11 @@ man_pmacro(struct man *man, int ln, char *buf, int off ln, offs - 1, NULL); /* - * 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. + * Some macros break next-line scopes; otherwise, remember + * whether we are in next-line scope for a block head. */ - if ( ! (man_macros[tok].flags & MAN_NSCOPED) && - man->flags & MAN_ELINE) { - n = man->last; - assert(MAN_TEXT != n->type); - - /* Remove repeated NSCOPED macros causing ELINE. */ - - if (man_macros[n->tok].flags & MAN_NSCOPED) - n = n->parent; - - mandoc_vmsg(MANDOCERR_BLK_LINE, 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_macros[tok].flags & MAN_BSCOPE)) { - n = man->last; - - /* Might be a text node like 8 in - * .TP 8 - * .SH foo - */ - if (n->type == MAN_TEXT) - n = n->parent; - - /* Remove element that didn't end BLINE, if any. */ - if ( ! (man_macros[n->tok].flags & MAN_BSCOPE)) - n = n->parent; - - assert(n->type == MAN_HEAD); - n = n->parent; - assert(n->type == MAN_BLOCK); - assert(man_macros[n->tok].flags & MAN_SCOPED); - - mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, n->line, - n->pos, "%s breaks %s", man_macronames[tok], - man_macronames[n->tok]); - - man_node_delete(man, n); - man->flags &= ~MAN_BLINE; - } - - /* Remember whether we are in next-line scope for a block head. */ - + man_breakscope(man, tok); bline = man->flags & MAN_BLINE; /* Call to handler... */ @@ -560,7 +239,7 @@ man_pmacro(struct man *man, int ln, char *buf, int off if (man->quick && tok == MAN_SH) { n = man->last; - if (n->type == MAN_BODY && + if (n->type == ROFFT_BODY && strcmp(n->prev->child->string, "NAME")) return(2); } @@ -579,53 +258,68 @@ man_pmacro(struct man *man, int ln, char *buf, int off man->flags &= ~MAN_BLINE; man_unscope(man, man->last->parent); - man_body_alloc(man, ln, ppos, man->last->tok); + roff_body_alloc(man, ln, ppos, man->last->tok); return(1); } -/* - * 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 *man, struct man_node *n) +void +man_breakscope(struct roff_man *man, int tok) { + struct roff_node *n; - /* Adjust siblings. */ + /* + * An element next line scope is open, + * and the new macro is not allowed inside elements. + * Delete the element that is being broken. + */ - if (n->prev) - n->prev->next = n->next; - if (n->next) - n->next->prev = n->prev; + if (man->flags & MAN_ELINE && (tok == TOKEN_NONE || + ! (man_macros[tok].flags & MAN_NSCOPED))) { + n = man->last; + assert(n->type != ROFFT_TEXT); + if (man_macros[n->tok].flags & MAN_NSCOPED) + n = n->parent; - /* Adjust parent. */ + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == TOKEN_NONE ? "TS" : man_macronames[tok], + man_macronames[n->tok]); - if (n->parent) { - n->parent->nchild--; - if (n->parent->child == n) - n->parent->child = n->prev ? n->prev : n->next; + roff_node_delete(man, n); + man->flags &= ~MAN_ELINE; } - /* Adjust parse point, if applicable. */ + /* + * A block header next line scope is open, + * and the new macro is not allowed inside block headers. + * Delete the block that is being broken. + */ - if (man && man->last == n) { - /*XXX: this can occur when bailing from validation. */ - /*assert(NULL == n->next);*/ - if (n->prev) { - man->last = n->prev; - man->next = MAN_NEXT_SIBLING; - } else { - man->last = n->parent; - man->next = MAN_NEXT_CHILD; - } - } + if (man->flags & MAN_BLINE && (tok == TOKEN_NONE || + man_macros[tok].flags & MAN_BSCOPE)) { + n = man->last; + if (n->type == ROFFT_TEXT) + n = n->parent; + if ( ! (man_macros[n->tok].flags & MAN_BSCOPE)) + n = n->parent; - if (man && man->first == n) - man->first = NULL; + assert(n->type == ROFFT_HEAD); + n = n->parent; + assert(n->type == ROFFT_BLOCK); + assert(man_macros[n->tok].flags & MAN_SCOPED); + + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == TOKEN_NONE ? "TS" : man_macronames[tok], + man_macronames[n->tok]); + + roff_node_delete(man, n); + man->flags &= ~MAN_BLINE; + } } const struct mparse * -man_mparse(const struct man *man) +man_mparse(const struct roff_man *man) { assert(man && man->parse); @@ -633,12 +327,12 @@ man_mparse(const struct man *man) } void -man_deroff(char **dest, const struct man_node *n) +man_deroff(char **dest, const struct roff_node *n) { char *cp; size_t sz; - if (n->type != MAN_TEXT) { + if (n->type != ROFFT_TEXT) { for (n = n->child; n; n = n->next) man_deroff(dest, n); return;