=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.144 retrieving revision 1.154 diff -u -p -r1.144 -r1.154 --- mandoc/man.c 2014/11/28 05:51:32 1.144 +++ mandoc/man.c 2015/04/18 16:34:25 1.154 @@ -1,16 +1,16 @@ -/* $Id: man.c,v 1.144 2014/11/28 05:51:32 schwarze Exp $ */ +/* $Id: man.c,v 1.154 2015/04/18 16:34:25 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,12 @@ #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 "libman.h" const char *const __man_macronames[MAN_MAX] = { "br", "TH", "SH", "SS", @@ -39,7 +40,7 @@ const char *const __man_macronames[MAN_MAX] = { "IP", "HP", "SM", "SB", "BI", "IB", "BR", "RB", "R", "B", "I", "IR", - "RI", "na", "sp", "nf", + "RI", "sp", "nf", "fi", "RE", "RS", "DT", "UC", "PD", "AT", "in", "ft", "OP", "EX", "EE", @@ -48,35 +49,37 @@ 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_alloc1(struct roff_man *); +static void man_breakscope(struct roff_man *, int); +static void man_descope(struct roff_man *, int, int); +static void man_free1(struct roff_man *); +static struct roff_node *man_node_alloc(struct roff_man *, int, int, + enum roff_type, int); +static void man_node_append(struct roff_man *, + struct roff_node *); +static void man_node_free(struct roff_node *); +static void man_node_unlink(struct roff_man *, + struct roff_node *); +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) +const struct roff_node * +man_node(const struct roff_man *man) { return(man->first); } -const struct man_meta * -man_meta(const struct man *man) +const struct roff_meta * +man_meta(const struct roff_man *man) { return(&man->meta); } void -man_reset(struct man *man) +man_reset(struct roff_man *man) { man_free1(man); @@ -84,22 +87,24 @@ man_reset(struct man *man) } void -man_free(struct man *man) +man_free(struct roff_man *man) { man_free1(man); free(man); } -struct man * -man_alloc(struct roff *roff, struct mparse *parse, int quick) +struct roff_man * +man_alloc(struct roff *roff, struct mparse *parse, + const char *defos, int quick) { - struct man *p; + struct roff_man *p; - p = mandoc_calloc(1, sizeof(struct man)); + p = mandoc_calloc(1, sizeof(*p)); man_hash_init(); p->parse = parse; + p->defos = defos; p->quick = quick; p->roff = roff; @@ -107,19 +112,18 @@ man_alloc(struct roff *roff, struct mparse *parse, int return(p); } -int -man_endparse(struct man *man) +void +man_endparse(struct roff_man *man) { man_macroend(man); - return(1); } 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) ? @@ -128,47 +132,48 @@ man_parseln(struct man *man, int ln, char *buf, int of } static void -man_free1(struct man *man) +man_free1(struct roff_man *man) { if (man->first) man_node_delete(man, man->first); free(man->meta.title); - free(man->meta.source); + free(man->meta.os); free(man->meta.date); free(man->meta.vol); free(man->meta.msec); } static void -man_alloc1(struct man *man) +man_alloc1(struct roff_man *man) { - memset(&man->meta, 0, sizeof(struct man_meta)); + memset(&man->meta, 0, sizeof(man->meta)); + man->macroset = MACROSET_MAN; man->flags = 0; - man->last = mandoc_calloc(1, sizeof(struct man_node)); + man->last = mandoc_calloc(1, sizeof(*man->last)); man->first = man->last; - man->last->type = MAN_ROOT; + man->last->type = ROFFT_ROOT; man->last->tok = MAN_MAX; - man->next = MAN_NEXT_CHILD; + man->next = ROFF_NEXT_CHILD; } static void -man_node_append(struct man *man, struct man_node *p) +man_node_append(struct roff_man *man, struct roff_node *p) { assert(man->last); assert(man->first); - assert(p->type != MAN_ROOT); + assert(p->type != ROFFT_ROOT); switch (man->next) { - case MAN_NEXT_SIBLING: + case ROFF_NEXT_SIBLING: man->last->next = p; p->prev = man->last; p->parent = man->last->parent; break; - case MAN_NEXT_CHILD: + case ROFF_NEXT_CHILD: man->last->child = p; p->parent = man->last; break; @@ -181,16 +186,16 @@ man_node_append(struct man *man, struct man_node *p) p->parent->nchild++; switch (p->type) { - case MAN_BLOCK: + case ROFFT_BLOCK: if (p->tok == MAN_SH || p->tok == MAN_SS) man->flags &= ~MAN_LITERAL; break; - case MAN_HEAD: - assert(p->parent->type == MAN_BLOCK); + case ROFFT_HEAD: + assert(p->parent->type == ROFFT_BLOCK); p->parent->head = p; break; - case MAN_BODY: - assert(p->parent->type == MAN_BLOCK); + case ROFFT_BODY: + assert(p->parent->type == ROFFT_BLOCK); p->parent->body = p; break; default: @@ -200,9 +205,9 @@ man_node_append(struct man *man, struct man_node *p) man->last = p; switch (p->type) { - case MAN_TBL: + case ROFFT_TBL: /* FALLTHROUGH */ - case MAN_TEXT: + case ROFFT_TEXT: man_valid_post(man); break; default: @@ -210,13 +215,13 @@ man_node_append(struct man *man, struct man_node *p) } } -static struct man_node * -man_node_alloc(struct man *man, int line, int pos, - enum man_type type, enum mant tok) +static struct roff_node * +man_node_alloc(struct roff_man *man, int line, int pos, + enum roff_type type, int tok) { - struct man_node *p; + struct roff_node *p; - p = mandoc_calloc(1, sizeof(struct man_node)); + p = mandoc_calloc(1, sizeof(*p)); p->line = line; p->pos = pos; p->type = type; @@ -229,60 +234,60 @@ man_node_alloc(struct man *man, int line, int pos, } void -man_elem_alloc(struct man *man, int line, int pos, enum mant tok) +man_elem_alloc(struct roff_man *man, int line, int pos, int tok) { - struct man_node *p; + struct roff_node *p; - p = man_node_alloc(man, line, pos, MAN_ELEM, tok); + p = man_node_alloc(man, line, pos, ROFFT_ELEM, tok); man_node_append(man, p); - man->next = MAN_NEXT_CHILD; + man->next = ROFF_NEXT_CHILD; } void -man_head_alloc(struct man *man, int line, int pos, enum mant tok) +man_head_alloc(struct roff_man *man, int line, int pos, int tok) { - struct man_node *p; + struct roff_node *p; - p = man_node_alloc(man, line, pos, MAN_HEAD, tok); + p = man_node_alloc(man, line, pos, ROFFT_HEAD, tok); man_node_append(man, p); - man->next = MAN_NEXT_CHILD; + man->next = ROFF_NEXT_CHILD; } void -man_body_alloc(struct man *man, int line, int pos, enum mant tok) +man_body_alloc(struct roff_man *man, int line, int pos, int tok) { - struct man_node *p; + struct roff_node *p; - p = man_node_alloc(man, line, pos, MAN_BODY, tok); + p = man_node_alloc(man, line, pos, ROFFT_BODY, tok); man_node_append(man, p); - man->next = MAN_NEXT_CHILD; + man->next = ROFF_NEXT_CHILD; } void -man_block_alloc(struct man *man, int line, int pos, enum mant tok) +man_block_alloc(struct roff_man *man, int line, int pos, int tok) { - struct man_node *p; + struct roff_node *p; - p = man_node_alloc(man, line, pos, MAN_BLOCK, tok); + p = man_node_alloc(man, line, pos, ROFFT_BLOCK, tok); man_node_append(man, p); - man->next = MAN_NEXT_CHILD; + man->next = ROFF_NEXT_CHILD; } void -man_word_alloc(struct man *man, int line, int pos, const char *word) +man_word_alloc(struct roff_man *man, int line, int pos, const char *word) { - struct man_node *n; + struct roff_node *n; - n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX); + n = man_node_alloc(man, line, pos, ROFFT_TEXT, MAN_MAX); n->string = roff_strdup(man->roff, word); man_node_append(man, n); - man->next = MAN_NEXT_SIBLING; + man->next = ROFF_NEXT_SIBLING; } void -man_word_append(struct man *man, const char *word) +man_word_append(struct roff_man *man, const char *word) { - struct man_node *n; + struct roff_node *n; char *addstr, *newstr; n = man->last; @@ -291,7 +296,7 @@ man_word_append(struct man *man, const char *word) free(addstr); free(n->string); n->string = newstr; - man->next = MAN_NEXT_SIBLING; + man->next = ROFF_NEXT_SIBLING; } /* @@ -299,7 +304,7 @@ man_word_append(struct man *man, const char *word) * node from its context; for that, see man_node_unlink(). */ static void -man_node_free(struct man_node *p) +man_node_free(struct roff_node *p) { free(p->string); @@ -307,7 +312,7 @@ man_node_free(struct man_node *p) } void -man_node_delete(struct man *man, struct man_node *p) +man_node_delete(struct roff_man *man, struct roff_node *p) { while (p->child) @@ -317,36 +322,35 @@ man_node_delete(struct man *man, struct man_node *p) man_node_free(p); } -int -man_addeqn(struct man *man, const struct eqn *ep) +void +man_addeqn(struct roff_man *man, const struct eqn *ep) { - struct man_node *n; + struct roff_node *n; - n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX); + n = man_node_alloc(man, ep->ln, ep->pos, ROFFT_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->next = ROFF_NEXT_SIBLING; man_descope(man, ep->ln, ep->pos); - return(1); } -int -man_addspan(struct man *man, const struct tbl_span *sp) +void +man_addspan(struct roff_man *man, const struct tbl_span *sp) { - struct man_node *n; + struct roff_node *n; - n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX); + man_breakscope(man, MAN_MAX); + n = man_node_alloc(man, sp->line, 0, ROFFT_TBL, MAN_MAX); n->span = sp; man_node_append(man, n); - man->next = MAN_NEXT_SIBLING; + man->next = ROFF_NEXT_SIBLING; man_descope(man, sp->line, 0); - return(1); } static void -man_descope(struct man *man, int line, int offs) +man_descope(struct roff_man *man, int line, int offs) { /* * Co-ordinate what happens with having a next-line scope open: @@ -366,7 +370,7 @@ man_descope(struct man *man, int line, int offs) } 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; @@ -391,7 +395,7 @@ man_ptext(struct man *man, int line, char *buf, int of if (man->last->tok != MAN_SH && man->last->tok != MAN_SS) { man_elem_alloc(man, line, offs, MAN_sp); - man->next = MAN_NEXT_SIBLING; + man->next = ROFF_NEXT_SIBLING; } return(1); } @@ -434,11 +438,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]; @@ -494,62 +498,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... */ @@ -561,7 +514,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); } @@ -584,12 +537,68 @@ man_pmacro(struct man *man, int ln, char *buf, int off return(1); } +void +man_breakscope(struct roff_man *man, int tok) +{ + struct roff_node *n; + + /* + * An element next line scope is open, + * and the new macro is not allowed inside elements. + * Delete the element that is being broken. + */ + + if (man->flags & MAN_ELINE && (tok == MAN_MAX || + ! (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; + + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == MAN_MAX ? "TS" : man_macronames[tok], + man_macronames[n->tok]); + + man_node_delete(man, n); + man->flags &= ~MAN_ELINE; + } + + /* + * 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->flags & MAN_BLINE && (tok == MAN_MAX || + 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; + + 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 == MAN_MAX ? "TS" : man_macronames[tok], + man_macronames[n->tok]); + + man_node_delete(man, n); + man->flags &= ~MAN_BLINE; + } +} + /* * 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) +man_node_unlink(struct roff_man *man, struct roff_node *n) { /* Adjust siblings. */ @@ -614,10 +623,10 @@ man_node_unlink(struct man *man, struct man_node *n) /*assert(NULL == n->next);*/ if (n->prev) { man->last = n->prev; - man->next = MAN_NEXT_SIBLING; + man->next = ROFF_NEXT_SIBLING; } else { man->last = n->parent; - man->next = MAN_NEXT_CHILD; + man->next = ROFF_NEXT_CHILD; } } @@ -626,7 +635,7 @@ man_node_unlink(struct man *man, struct man_node *n) } const struct mparse * -man_mparse(const struct man *man) +man_mparse(const struct roff_man *man) { assert(man && man->parse); @@ -634,12 +643,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;