[BACK]Return to man.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/man.c, Revision 1.99

1.99    ! schwarze    1: /*     $OpenBSD: man.c,v 1.98 2015/04/02 21:03:18 schwarze Exp $ */
1.1       kristaps    2: /*
1.52      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.97      schwarze    4:  * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.74      schwarze    5:  * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
1.1       kristaps    6:  *
                      7:  * Permission to use, copy, modify, and distribute this software for any
1.2       schwarze    8:  * purpose with or without fee is hereby granted, provided that the above
                      9:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps   10:  *
1.98      schwarze   11:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2       schwarze   12:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.98      schwarze   13:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2       schwarze   14:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     15:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     16:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     17:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   18:  */
1.14      schwarze   19: #include <sys/types.h>
                     20:
1.1       kristaps   21: #include <assert.h>
1.76      schwarze   22: #include <ctype.h>
1.1       kristaps   23: #include <stdarg.h>
                     24: #include <stdlib.h>
                     25: #include <stdio.h>
                     26: #include <string.h>
                     27:
1.98      schwarze   28: #include "mandoc_aux.h"
                     29: #include "mandoc.h"
                     30: #include "roff.h"
1.59      schwarze   31: #include "man.h"
1.98      schwarze   32: #include "libmandoc.h"
1.1       kristaps   33: #include "libman.h"
                     34:
1.79      schwarze   35: const  char *const __man_macronames[MAN_MAX] = {
1.3       schwarze   36:        "br",           "TH",           "SH",           "SS",
1.79      schwarze   37:        "TP",           "LP",           "PP",           "P",
1.1       kristaps   38:        "IP",           "HP",           "SM",           "SB",
                     39:        "BI",           "IB",           "BR",           "RB",
                     40:        "R",            "B",            "I",            "IR",
1.96      schwarze   41:        "RI",           "sp",           "nf",
1.50      schwarze   42:        "fi",           "RE",           "RS",           "DT",
                     43:        "UC",           "PD",           "AT",           "in",
1.70      schwarze   44:        "ft",           "OP",           "EX",           "EE",
1.78      schwarze   45:        "UR",           "UE",           "ll"
1.1       kristaps   46:        };
                     47:
                     48: const  char * const *man_macronames = __man_macronames;
                     49:
1.97      schwarze   50: static void             man_alloc1(struct man *);
1.99    ! schwarze   51: static void             man_breakscope(struct man *, int);
1.97      schwarze   52: static void             man_descope(struct man *, int, int);
                     53: static void             man_free1(struct man *);
1.99    ! schwarze   54: static struct roff_node *man_node_alloc(struct man *, int, int,
        !            55:                                enum roff_type, int);
        !            56: static void             man_node_append(struct man *, struct roff_node *);
        !            57: static void             man_node_free(struct roff_node *);
        !            58: static void             man_node_unlink(struct man *, struct roff_node *);
1.31      schwarze   59: static int              man_ptext(struct man *, int, char *, int);
                     60: static int              man_pmacro(struct man *, int, char *, int);
1.1       kristaps   61:
                     62:
1.99    ! schwarze   63: const struct roff_node *
1.69      schwarze   64: man_node(const struct man *man)
1.1       kristaps   65: {
                     66:
1.69      schwarze   67:        return(man->first);
1.1       kristaps   68: }
                     69:
                     70: const struct man_meta *
1.69      schwarze   71: man_meta(const struct man *man)
1.1       kristaps   72: {
                     73:
1.69      schwarze   74:        return(&man->meta);
1.1       kristaps   75: }
                     76:
1.16      schwarze   77: void
1.1       kristaps   78: man_reset(struct man *man)
                     79: {
                     80:
                     81:        man_free1(man);
1.16      schwarze   82:        man_alloc1(man);
1.1       kristaps   83: }
                     84:
                     85: void
                     86: man_free(struct man *man)
                     87: {
                     88:
                     89:        man_free1(man);
                     90:        free(man);
                     91: }
                     92:
                     93: struct man *
1.94      schwarze   94: man_alloc(struct roff *roff, struct mparse *parse,
                     95:        const char *defos, int quick)
1.1       kristaps   96: {
                     97:        struct man      *p;
                     98:
1.16      schwarze   99:        p = mandoc_calloc(1, sizeof(struct man));
1.1       kristaps  100:
1.13      schwarze  101:        man_hash_init();
1.59      schwarze  102:        p->parse = parse;
1.94      schwarze  103:        p->defos = defos;
1.73      schwarze  104:        p->quick = quick;
1.60      schwarze  105:        p->roff = roff;
1.16      schwarze  106:
                    107:        man_alloc1(p);
1.1       kristaps  108:        return(p);
                    109: }
                    110:
1.95      schwarze  111: void
1.69      schwarze  112: man_endparse(struct man *man)
1.1       kristaps  113: {
                    114:
1.92      schwarze  115:        man_macroend(man);
1.1       kristaps  116: }
                    117:
                    118: int
1.69      schwarze  119: man_parseln(struct man *man, int ln, char *buf, int offs)
1.1       kristaps  120: {
1.25      schwarze  121:
1.98      schwarze  122:        if (man->last->type != ROFFT_EQN || ln > man->last->line)
1.89      schwarze  123:                man->flags |= MAN_NEWLINE;
1.54      schwarze  124:
1.69      schwarze  125:        return (roff_getcontrol(man->roff, buf, &offs) ?
1.79      schwarze  126:            man_pmacro(man, ln, buf, offs) :
                    127:            man_ptext(man, ln, buf, offs));
1.1       kristaps  128: }
                    129:
                    130: static void
                    131: man_free1(struct man *man)
                    132: {
                    133:
                    134:        if (man->first)
1.22      schwarze  135:                man_node_delete(man, man->first);
1.92      schwarze  136:        free(man->meta.title);
                    137:        free(man->meta.source);
                    138:        free(man->meta.date);
                    139:        free(man->meta.vol);
                    140:        free(man->meta.msec);
1.1       kristaps  141: }
                    142:
1.16      schwarze  143: static void
1.69      schwarze  144: man_alloc1(struct man *man)
1.1       kristaps  145: {
                    146:
1.69      schwarze  147:        memset(&man->meta, 0, sizeof(struct man_meta));
                    148:        man->flags = 0;
1.99    ! schwarze  149:        man->last = mandoc_calloc(1, sizeof(*man->last));
1.69      schwarze  150:        man->first = man->last;
1.98      schwarze  151:        man->last->type = ROFFT_ROOT;
1.69      schwarze  152:        man->last->tok = MAN_MAX;
                    153:        man->next = MAN_NEXT_CHILD;
1.1       kristaps  154: }
                    155:
                    156:
1.92      schwarze  157: static void
1.99    ! schwarze  158: man_node_append(struct man *man, struct roff_node *p)
1.1       kristaps  159: {
                    160:
                    161:        assert(man->last);
                    162:        assert(man->first);
1.98      schwarze  163:        assert(p->type != ROFFT_ROOT);
1.1       kristaps  164:
                    165:        switch (man->next) {
1.79      schwarze  166:        case MAN_NEXT_SIBLING:
1.1       kristaps  167:                man->last->next = p;
                    168:                p->prev = man->last;
                    169:                p->parent = man->last->parent;
                    170:                break;
1.79      schwarze  171:        case MAN_NEXT_CHILD:
1.1       kristaps  172:                man->last->child = p;
                    173:                p->parent = man->last;
                    174:                break;
                    175:        default:
                    176:                abort();
                    177:                /* NOTREACHED */
                    178:        }
1.79      schwarze  179:
1.22      schwarze  180:        assert(p->parent);
1.5       schwarze  181:        p->parent->nchild++;
1.1       kristaps  182:
1.9       schwarze  183:        switch (p->type) {
1.98      schwarze  184:        case ROFFT_BLOCK:
1.86      schwarze  185:                if (p->tok == MAN_SH || p->tok == MAN_SS)
                    186:                        man->flags &= ~MAN_LITERAL;
                    187:                break;
1.98      schwarze  188:        case ROFFT_HEAD:
                    189:                assert(p->parent->type == ROFFT_BLOCK);
1.9       schwarze  190:                p->parent->head = p;
                    191:                break;
1.98      schwarze  192:        case ROFFT_BODY:
                    193:                assert(p->parent->type == ROFFT_BLOCK);
1.9       schwarze  194:                p->parent->body = p;
                    195:                break;
                    196:        default:
                    197:                break;
                    198:        }
                    199:
1.1       kristaps  200:        man->last = p;
                    201:
                    202:        switch (p->type) {
1.98      schwarze  203:        case ROFFT_TBL:
1.52      schwarze  204:                /* FALLTHROUGH */
1.98      schwarze  205:        case ROFFT_TEXT:
1.92      schwarze  206:                man_valid_post(man);
1.1       kristaps  207:                break;
                    208:        default:
                    209:                break;
                    210:        }
                    211: }
                    212:
1.99    ! schwarze  213: static struct roff_node *
1.79      schwarze  214: man_node_alloc(struct man *man, int line, int pos,
1.99    ! schwarze  215:                enum roff_type type, int tok)
1.1       kristaps  216: {
1.99    ! schwarze  217:        struct roff_node *p;
1.1       kristaps  218:
1.99    ! schwarze  219:        p = mandoc_calloc(1, sizeof(*p));
1.1       kristaps  220:        p->line = line;
                    221:        p->pos = pos;
                    222:        p->type = type;
                    223:        p->tok = tok;
1.54      schwarze  224:
1.92      schwarze  225:        if (man->flags & MAN_NEWLINE)
1.54      schwarze  226:                p->flags |= MAN_LINE;
1.69      schwarze  227:        man->flags &= ~MAN_NEWLINE;
1.1       kristaps  228:        return(p);
                    229: }
                    230:
1.92      schwarze  231: void
1.99    ! schwarze  232: man_elem_alloc(struct man *man, int line, int pos, int tok)
1.1       kristaps  233: {
1.99    ! schwarze  234:        struct roff_node *p;
1.1       kristaps  235:
1.98      schwarze  236:        p = man_node_alloc(man, line, pos, ROFFT_ELEM, tok);
1.92      schwarze  237:        man_node_append(man, p);
1.69      schwarze  238:        man->next = MAN_NEXT_CHILD;
1.1       kristaps  239: }
                    240:
1.92      schwarze  241: void
1.99    ! schwarze  242: man_head_alloc(struct man *man, int line, int pos, int tok)
1.9       schwarze  243: {
1.99    ! schwarze  244:        struct roff_node *p;
1.9       schwarze  245:
1.98      schwarze  246:        p = man_node_alloc(man, line, pos, ROFFT_HEAD, tok);
1.92      schwarze  247:        man_node_append(man, p);
1.69      schwarze  248:        man->next = MAN_NEXT_CHILD;
1.9       schwarze  249: }
                    250:
1.92      schwarze  251: void
1.99    ! schwarze  252: man_body_alloc(struct man *man, int line, int pos, int tok)
1.9       schwarze  253: {
1.99    ! schwarze  254:        struct roff_node *p;
1.9       schwarze  255:
1.98      schwarze  256:        p = man_node_alloc(man, line, pos, ROFFT_BODY, tok);
1.92      schwarze  257:        man_node_append(man, p);
1.69      schwarze  258:        man->next = MAN_NEXT_CHILD;
1.9       schwarze  259: }
                    260:
1.92      schwarze  261: void
1.99    ! schwarze  262: man_block_alloc(struct man *man, int line, int pos, int tok)
1.9       schwarze  263: {
1.99    ! schwarze  264:        struct roff_node *p;
1.9       schwarze  265:
1.98      schwarze  266:        p = man_node_alloc(man, line, pos, ROFFT_BLOCK, tok);
1.92      schwarze  267:        man_node_append(man, p);
1.69      schwarze  268:        man->next = MAN_NEXT_CHILD;
1.9       schwarze  269: }
                    270:
1.92      schwarze  271: void
1.69      schwarze  272: man_word_alloc(struct man *man, int line, int pos, const char *word)
1.1       kristaps  273: {
1.99    ! schwarze  274:        struct roff_node *n;
1.1       kristaps  275:
1.98      schwarze  276:        n = man_node_alloc(man, line, pos, ROFFT_TEXT, MAN_MAX);
1.69      schwarze  277:        n->string = roff_strdup(man->roff, word);
1.92      schwarze  278:        man_node_append(man, n);
1.69      schwarze  279:        man->next = MAN_NEXT_SIBLING;
1.90      schwarze  280: }
                    281:
                    282: void
                    283: man_word_append(struct man *man, const char *word)
                    284: {
1.99    ! schwarze  285:        struct roff_node *n;
1.90      schwarze  286:        char            *addstr, *newstr;
                    287:
                    288:        n = man->last;
                    289:        addstr = roff_strdup(man->roff, word);
                    290:        mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
                    291:        free(addstr);
                    292:        free(n->string);
                    293:        n->string = newstr;
                    294:        man->next = MAN_NEXT_SIBLING;
1.10      schwarze  295: }
                    296:
1.22      schwarze  297: /*
                    298:  * Free all of the resources held by a node.  This does NOT unlink a
                    299:  * node from its context; for that, see man_node_unlink().
                    300:  */
                    301: static void
1.99    ! schwarze  302: man_node_free(struct roff_node *p)
1.1       kristaps  303: {
                    304:
1.92      schwarze  305:        free(p->string);
1.1       kristaps  306:        free(p);
                    307: }
                    308:
                    309: void
1.99    ! schwarze  310: man_node_delete(struct man *man, struct roff_node *p)
1.1       kristaps  311: {
                    312:
1.22      schwarze  313:        while (p->child)
1.69      schwarze  314:                man_node_delete(man, p->child);
1.22      schwarze  315:
1.69      schwarze  316:        man_node_unlink(man, p);
1.1       kristaps  317:        man_node_free(p);
                    318: }
                    319:
1.93      schwarze  320: void
1.69      schwarze  321: man_addeqn(struct man *man, const struct eqn *ep)
1.57      schwarze  322: {
1.99    ! schwarze  323:        struct roff_node *n;
1.57      schwarze  324:
1.98      schwarze  325:        n = man_node_alloc(man, ep->ln, ep->pos, ROFFT_EQN, MAN_MAX);
1.57      schwarze  326:        n->eqn = ep;
1.88      schwarze  327:        if (ep->ln > man->last->line)
                    328:                n->flags |= MAN_LINE;
1.92      schwarze  329:        man_node_append(man, n);
1.69      schwarze  330:        man->next = MAN_NEXT_SIBLING;
1.92      schwarze  331:        man_descope(man, ep->ln, ep->pos);
1.57      schwarze  332: }
1.1       kristaps  333:
1.93      schwarze  334: void
1.69      schwarze  335: man_addspan(struct man *man, const struct tbl_span *sp)
1.52      schwarze  336: {
1.99    ! schwarze  337:        struct roff_node *n;
1.52      schwarze  338:
1.97      schwarze  339:        man_breakscope(man, MAN_MAX);
1.98      schwarze  340:        n = man_node_alloc(man, sp->line, 0, ROFFT_TBL, MAN_MAX);
1.55      schwarze  341:        n->span = sp;
1.92      schwarze  342:        man_node_append(man, n);
1.69      schwarze  343:        man->next = MAN_NEXT_SIBLING;
1.92      schwarze  344:        man_descope(man, sp->line, 0);
1.52      schwarze  345: }
                    346:
1.92      schwarze  347: static void
1.69      schwarze  348: man_descope(struct man *man, int line, int offs)
1.52      schwarze  349: {
                    350:        /*
                    351:         * Co-ordinate what happens with having a next-line scope open:
                    352:         * first close out the element scope (if applicable), then close
                    353:         * out the block scope (also if applicable).
                    354:         */
                    355:
1.92      schwarze  356:        if (man->flags & MAN_ELINE) {
1.69      schwarze  357:                man->flags &= ~MAN_ELINE;
1.92      schwarze  358:                man_unscope(man, man->last->parent);
1.52      schwarze  359:        }
1.92      schwarze  360:        if ( ! (man->flags & MAN_BLINE))
                    361:                return;
1.69      schwarze  362:        man->flags &= ~MAN_BLINE;
1.92      schwarze  363:        man_unscope(man, man->last->parent);
                    364:        man_body_alloc(man, line, offs, man->last->tok);
1.52      schwarze  365: }
                    366:
1.1       kristaps  367: static int
1.69      schwarze  368: man_ptext(struct man *man, int line, char *buf, int offs)
1.1       kristaps  369: {
1.27      schwarze  370:        int              i;
1.26      schwarze  371:
1.10      schwarze  372:        /* Literal free-form text whitespace is preserved. */
                    373:
1.92      schwarze  374:        if (man->flags & MAN_LITERAL) {
                    375:                man_word_alloc(man, line, offs, buf + offs);
                    376:                man_descope(man, line, offs);
                    377:                return(1);
1.10      schwarze  378:        }
                    379:
1.92      schwarze  380:        for (i = offs; buf[i] == ' '; i++)
1.10      schwarze  381:                /* Skip leading whitespace. */ ;
1.18      schwarze  382:
1.71      schwarze  383:        /*
                    384:         * Blank lines are ignored right after headings
                    385:         * but add a single vertical space elsewhere.
                    386:         */
                    387:
1.92      schwarze  388:        if (buf[i] == '\0') {
1.27      schwarze  389:                /* Allocate a blank entry. */
1.92      schwarze  390:                if (man->last->tok != MAN_SH &&
                    391:                    man->last->tok != MAN_SS) {
                    392:                        man_elem_alloc(man, line, offs, MAN_sp);
1.71      schwarze  393:                        man->next = MAN_NEXT_SIBLING;
                    394:                }
1.68      schwarze  395:                return(1);
1.10      schwarze  396:        }
1.1       kristaps  397:
1.79      schwarze  398:        /*
1.27      schwarze  399:         * Warn if the last un-escaped character is whitespace. Then
1.79      schwarze  400:         * strip away the remaining spaces (tabs stay!).
1.27      schwarze  401:         */
1.18      schwarze  402:
1.27      schwarze  403:        i = (int)strlen(buf);
                    404:        assert(i);
1.18      schwarze  405:
1.27      schwarze  406:        if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                    407:                if (i > 1 && '\\' != buf[i - 2])
1.81      schwarze  408:                        mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                    409:                            line, i - 1, NULL);
1.18      schwarze  410:
1.27      schwarze  411:                for (--i; i && ' ' == buf[i]; i--)
                    412:                        /* Spin back to non-space. */ ;
1.10      schwarze  413:
1.27      schwarze  414:                /* Jump ahead of escaped whitespace. */
                    415:                i += '\\' == buf[i] ? 2 : 1;
1.18      schwarze  416:
1.27      schwarze  417:                buf[i] = '\0';
1.10      schwarze  418:        }
1.92      schwarze  419:        man_word_alloc(man, line, offs, buf + offs);
1.28      schwarze  420:
                    421:        /*
                    422:         * End-of-sentence check.  If the last character is an unescaped
                    423:         * EOS character, then flag the node as being the end of a
                    424:         * sentence.  The front-end will know how to interpret this.
                    425:         */
                    426:
                    427:        assert(i);
1.72      schwarze  428:        if (mandoc_eos(buf, (size_t)i))
1.69      schwarze  429:                man->last->flags |= MAN_EOS;
1.10      schwarze  430:
1.92      schwarze  431:        man_descope(man, line, offs);
                    432:        return(1);
1.1       kristaps  433: }
                    434:
1.53      schwarze  435: static int
1.69      schwarze  436: man_pmacro(struct man *man, int ln, char *buf, int offs)
1.1       kristaps  437: {
1.99    ! schwarze  438:        struct roff_node *n;
1.91      schwarze  439:        const char      *cp;
1.99    ! schwarze  440:        int              tok;
1.84      schwarze  441:        int              i, ppos;
                    442:        int              bline;
1.91      schwarze  443:        char             mac[5];
1.1       kristaps  444:
1.59      schwarze  445:        ppos = offs;
1.1       kristaps  446:
1.23      schwarze  447:        /*
1.59      schwarze  448:         * Copy the first word into a nil-terminated buffer.
1.91      schwarze  449:         * Stop when a space, tab, escape, or eoln is encountered.
1.23      schwarze  450:         */
1.27      schwarze  451:
1.59      schwarze  452:        i = 0;
1.91      schwarze  453:        while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
1.59      schwarze  454:                mac[i++] = buf[offs++];
1.1       kristaps  455:
1.59      schwarze  456:        mac[i] = '\0';
1.1       kristaps  457:
1.59      schwarze  458:        tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;
1.1       kristaps  459:
1.91      schwarze  460:        if (tok == MAN_MAX) {
1.85      schwarze  461:                mandoc_msg(MANDOCERR_MACRO, man->parse,
                    462:                    ln, ppos, buf + ppos - 1);
1.1       kristaps  463:                return(1);
                    464:        }
                    465:
1.91      schwarze  466:        /* Skip a leading escape sequence or tab. */
                    467:
                    468:        switch (buf[offs]) {
                    469:        case '\\':
                    470:                cp = buf + offs + 1;
                    471:                mandoc_escape(&cp, NULL, NULL);
                    472:                offs = cp - buf;
                    473:                break;
                    474:        case '\t':
                    475:                offs++;
                    476:                break;
                    477:        default:
                    478:                break;
                    479:        }
                    480:
                    481:        /* Jump to the next non-whitespace word. */
1.1       kristaps  482:
1.92      schwarze  483:        while (buf[offs] && buf[offs] == ' ')
1.59      schwarze  484:                offs++;
1.18      schwarze  485:
1.79      schwarze  486:        /*
1.27      schwarze  487:         * Trailing whitespace.  Note that tabs are allowed to be passed
                    488:         * into the parser as "text", so we only warn about spaces here.
                    489:         */
1.18      schwarze  490:
1.92      schwarze  491:        if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.81      schwarze  492:                mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                    493:                    ln, offs - 1, NULL);
1.1       kristaps  494:
1.79      schwarze  495:        /*
1.97      schwarze  496:         * Some macros break next-line scopes; otherwise, remember
                    497:         * whether we are in next-line scope for a block head.
1.21      schwarze  498:         */
                    499:
1.97      schwarze  500:        man_breakscope(man, tok);
1.84      schwarze  501:        bline = man->flags & MAN_BLINE;
1.24      schwarze  502:
                    503:        /* Call to handler... */
1.1       kristaps  504:
1.22      schwarze  505:        assert(man_macros[tok].fp);
1.92      schwarze  506:        (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.73      schwarze  507:
                    508:        /* In quick mode (for mandocdb), abort after the NAME section. */
                    509:
1.92      schwarze  510:        if (man->quick && tok == MAN_SH) {
1.80      schwarze  511:                n = man->last;
1.98      schwarze  512:                if (n->type == ROFFT_BODY &&
1.80      schwarze  513:                    strcmp(n->prev->child->string, "NAME"))
                    514:                        return(2);
                    515:        }
1.1       kristaps  516:
1.79      schwarze  517:        /*
1.84      schwarze  518:         * If we are in a next-line scope for a block head,
                    519:         * close it out now and switch to the body,
                    520:         * unless the next-line scope is allowed to continue.
1.21      schwarze  521:         */
                    522:
1.84      schwarze  523:        if ( ! bline || man->flags & MAN_ELINE ||
                    524:            man_macros[tok].flags & MAN_NSCOPED)
1.21      schwarze  525:                return(1);
1.1       kristaps  526:
1.92      schwarze  527:        assert(man->flags & MAN_BLINE);
1.69      schwarze  528:        man->flags &= ~MAN_BLINE;
1.1       kristaps  529:
1.92      schwarze  530:        man_unscope(man, man->last->parent);
                    531:        man_body_alloc(man, ln, ppos, man->last->tok);
                    532:        return(1);
1.97      schwarze  533: }
                    534:
                    535: void
1.99    ! schwarze  536: man_breakscope(struct man *man, int tok)
1.97      schwarze  537: {
1.99    ! schwarze  538:        struct roff_node *n;
1.97      schwarze  539:
                    540:        /*
                    541:         * An element next line scope is open,
                    542:         * and the new macro is not allowed inside elements.
                    543:         * Delete the element that is being broken.
                    544:         */
                    545:
                    546:        if (man->flags & MAN_ELINE && (tok == MAN_MAX ||
                    547:            ! (man_macros[tok].flags & MAN_NSCOPED))) {
                    548:                n = man->last;
1.98      schwarze  549:                assert(n->type != ROFFT_TEXT);
1.97      schwarze  550:                if (man_macros[n->tok].flags & MAN_NSCOPED)
                    551:                        n = n->parent;
                    552:
                    553:                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    554:                    n->line, n->pos, "%s breaks %s",
                    555:                    tok == MAN_MAX ? "TS" : man_macronames[tok],
                    556:                    man_macronames[n->tok]);
                    557:
                    558:                man_node_delete(man, n);
                    559:                man->flags &= ~MAN_ELINE;
                    560:        }
                    561:
                    562:        /*
                    563:         * A block header next line scope is open,
                    564:         * and the new macro is not allowed inside block headers.
                    565:         * Delete the block that is being broken.
                    566:         */
                    567:
                    568:        if (man->flags & MAN_BLINE && (tok == MAN_MAX ||
                    569:            man_macros[tok].flags & MAN_BSCOPE)) {
                    570:                n = man->last;
1.98      schwarze  571:                if (n->type == ROFFT_TEXT)
1.97      schwarze  572:                        n = n->parent;
                    573:                if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
                    574:                        n = n->parent;
                    575:
1.98      schwarze  576:                assert(n->type == ROFFT_HEAD);
1.97      schwarze  577:                n = n->parent;
1.98      schwarze  578:                assert(n->type == ROFFT_BLOCK);
1.97      schwarze  579:                assert(man_macros[n->tok].flags & MAN_SCOPED);
                    580:
                    581:                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    582:                    n->line, n->pos, "%s breaks %s",
                    583:                    tok == MAN_MAX ? "TS" : man_macronames[tok],
                    584:                    man_macronames[n->tok]);
                    585:
                    586:                man_node_delete(man, n);
                    587:                man->flags &= ~MAN_BLINE;
                    588:        }
1.1       kristaps  589: }
1.21      schwarze  590:
1.22      schwarze  591: /*
1.69      schwarze  592:  * Unlink a node from its context.  If "man" is provided, the last parse
1.22      schwarze  593:  * point will also be adjusted accordingly.
                    594:  */
                    595: static void
1.99    ! schwarze  596: man_node_unlink(struct man *man, struct roff_node *n)
1.21      schwarze  597: {
                    598:
1.22      schwarze  599:        /* Adjust siblings. */
                    600:
                    601:        if (n->prev)
1.21      schwarze  602:                n->prev->next = n->next;
1.22      schwarze  603:        if (n->next)
                    604:                n->next->prev = n->prev;
                    605:
                    606:        /* Adjust parent. */
                    607:
                    608:        if (n->parent) {
                    609:                n->parent->nchild--;
                    610:                if (n->parent->child == n)
                    611:                        n->parent->child = n->prev ? n->prev : n->next;
                    612:        }
                    613:
                    614:        /* Adjust parse point, if applicable. */
                    615:
1.69      schwarze  616:        if (man && man->last == n) {
1.22      schwarze  617:                /*XXX: this can occur when bailing from validation. */
                    618:                /*assert(NULL == n->next);*/
                    619:                if (n->prev) {
1.69      schwarze  620:                        man->last = n->prev;
                    621:                        man->next = MAN_NEXT_SIBLING;
1.22      schwarze  622:                } else {
1.69      schwarze  623:                        man->last = n->parent;
                    624:                        man->next = MAN_NEXT_CHILD;
1.21      schwarze  625:                }
                    626:        }
                    627:
1.69      schwarze  628:        if (man && man->first == n)
                    629:                man->first = NULL;
1.62      schwarze  630: }
                    631:
                    632: const struct mparse *
1.69      schwarze  633: man_mparse(const struct man *man)
1.62      schwarze  634: {
                    635:
1.69      schwarze  636:        assert(man && man->parse);
                    637:        return(man->parse);
1.76      schwarze  638: }
                    639:
                    640: void
1.99    ! schwarze  641: man_deroff(char **dest, const struct roff_node *n)
1.76      schwarze  642: {
                    643:        char    *cp;
                    644:        size_t   sz;
                    645:
1.98      schwarze  646:        if (n->type != ROFFT_TEXT) {
1.76      schwarze  647:                for (n = n->child; n; n = n->next)
                    648:                        man_deroff(dest, n);
                    649:                return;
                    650:        }
                    651:
1.77      schwarze  652:        /* Skip leading whitespace and escape sequences. */
1.76      schwarze  653:
1.77      schwarze  654:        cp = n->string;
                    655:        while ('\0' != *cp) {
                    656:                if ('\\' == *cp) {
                    657:                        cp++;
                    658:                        mandoc_escape((const char **)&cp, NULL, NULL);
                    659:                } else if (isspace((unsigned char)*cp))
                    660:                        cp++;
                    661:                else
1.76      schwarze  662:                        break;
1.77      schwarze  663:        }
1.76      schwarze  664:
                    665:        /* Skip trailing whitespace. */
                    666:
                    667:        for (sz = strlen(cp); sz; sz--)
                    668:                if (0 == isspace((unsigned char)cp[sz-1]))
                    669:                        break;
                    670:
                    671:        /* Skip empty strings. */
                    672:
                    673:        if (0 == sz)
                    674:                return;
                    675:
                    676:        if (NULL == *dest) {
                    677:                *dest = mandoc_strndup(cp, sz);
                    678:                return;
                    679:        }
                    680:
                    681:        mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
                    682:        free(*dest);
                    683:        *dest = cp;
1.4       schwarze  684: }