[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.78

1.78    ! schwarze    1: /*     $Id: man.c,v 1.77 2014/03/23 20:57:23 schwarze Exp $ */
1.1       kristaps    2: /*
1.52      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.73      schwarze    4:  * Copyright (c) 2013, 2014 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.2       schwarze   11:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     12:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     13:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     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.59      schwarze   28: #include "man.h"
1.33      schwarze   29: #include "mandoc.h"
1.75      schwarze   30: #include "mandoc_aux.h"
1.1       kristaps   31: #include "libman.h"
1.16      schwarze   32: #include "libmandoc.h"
1.1       kristaps   33:
                     34: const  char *const __man_macronames[MAN_MAX] = {
1.3       schwarze   35:        "br",           "TH",           "SH",           "SS",
1.1       kristaps   36:        "TP",           "LP",           "PP",           "P",
                     37:        "IP",           "HP",           "SM",           "SB",
                     38:        "BI",           "IB",           "BR",           "RB",
                     39:        "R",            "B",            "I",            "IR",
1.50      schwarze   40:        "RI",           "na",           "sp",           "nf",
                     41:        "fi",           "RE",           "RS",           "DT",
                     42:        "UC",           "PD",           "AT",           "in",
1.70      schwarze   43:        "ft",           "OP",           "EX",           "EE",
1.78    ! schwarze   44:        "UR",           "UE",           "ll"
1.1       kristaps   45:        };
                     46:
                     47: const  char * const *man_macronames = __man_macronames;
                     48:
1.54      schwarze   49: static struct man_node *man_node_alloc(struct man *, int, int,
1.22      schwarze   50:                                enum man_type, enum mant);
1.1       kristaps   51: static int              man_node_append(struct man *,
                     52:                                struct man_node *);
1.22      schwarze   53: static void             man_node_free(struct man_node *);
                     54: static void             man_node_unlink(struct man *,
                     55:                                struct man_node *);
1.31      schwarze   56: static int              man_ptext(struct man *, int, char *, int);
                     57: static int              man_pmacro(struct man *, int, char *, int);
1.1       kristaps   58: static void             man_free1(struct man *);
1.16      schwarze   59: static void             man_alloc1(struct man *);
1.52      schwarze   60: static int              man_descope(struct man *, int, int);
1.1       kristaps   61:
                     62:
                     63: const struct man_node *
1.69      schwarze   64: man_node(const struct man *man)
1.1       kristaps   65: {
                     66:
1.69      schwarze   67:        assert( ! (MAN_HALT & man->flags));
                     68:        return(man->first);
1.1       kristaps   69: }
                     70:
                     71:
                     72: const struct man_meta *
1.69      schwarze   73: man_meta(const struct man *man)
1.1       kristaps   74: {
                     75:
1.69      schwarze   76:        assert( ! (MAN_HALT & man->flags));
                     77:        return(&man->meta);
1.1       kristaps   78: }
                     79:
                     80:
1.16      schwarze   81: void
1.1       kristaps   82: man_reset(struct man *man)
                     83: {
                     84:
                     85:        man_free1(man);
1.16      schwarze   86:        man_alloc1(man);
1.1       kristaps   87: }
                     88:
                     89:
                     90: void
                     91: man_free(struct man *man)
                     92: {
                     93:
                     94:        man_free1(man);
                     95:        free(man);
                     96: }
                     97:
                     98:
                     99: struct man *
1.73      schwarze  100: man_alloc(struct roff *roff, struct mparse *parse, int quick)
1.1       kristaps  101: {
                    102:        struct man      *p;
                    103:
1.16      schwarze  104:        p = mandoc_calloc(1, sizeof(struct man));
1.1       kristaps  105:
1.13      schwarze  106:        man_hash_init();
1.59      schwarze  107:        p->parse = parse;
1.73      schwarze  108:        p->quick = quick;
1.60      schwarze  109:        p->roff = roff;
1.16      schwarze  110:
                    111:        man_alloc1(p);
1.1       kristaps  112:        return(p);
                    113: }
                    114:
                    115:
                    116: int
1.69      schwarze  117: man_endparse(struct man *man)
1.1       kristaps  118: {
                    119:
1.69      schwarze  120:        assert( ! (MAN_HALT & man->flags));
                    121:        if (man_macroend(man))
1.1       kristaps  122:                return(1);
1.69      schwarze  123:        man->flags |= MAN_HALT;
1.1       kristaps  124:        return(0);
                    125: }
                    126:
                    127:
                    128: int
1.69      schwarze  129: man_parseln(struct man *man, int ln, char *buf, int offs)
1.1       kristaps  130: {
1.25      schwarze  131:
1.69      schwarze  132:        man->flags |= MAN_NEWLINE;
1.54      schwarze  133:
1.69      schwarze  134:        assert( ! (MAN_HALT & man->flags));
1.59      schwarze  135:
1.69      schwarze  136:        return (roff_getcontrol(man->roff, buf, &offs) ?
                    137:                        man_pmacro(man, ln, buf, offs) :
                    138:                        man_ptext(man, ln, buf, offs));
1.1       kristaps  139: }
                    140:
                    141:
                    142: static void
                    143: man_free1(struct man *man)
                    144: {
                    145:
                    146:        if (man->first)
1.22      schwarze  147:                man_node_delete(man, man->first);
1.1       kristaps  148:        if (man->meta.title)
                    149:                free(man->meta.title);
                    150:        if (man->meta.source)
                    151:                free(man->meta.source);
1.56      schwarze  152:        if (man->meta.date)
                    153:                free(man->meta.date);
1.1       kristaps  154:        if (man->meta.vol)
                    155:                free(man->meta.vol);
1.29      schwarze  156:        if (man->meta.msec)
                    157:                free(man->meta.msec);
1.1       kristaps  158: }
                    159:
                    160:
1.16      schwarze  161: static void
1.69      schwarze  162: man_alloc1(struct man *man)
1.1       kristaps  163: {
                    164:
1.69      schwarze  165:        memset(&man->meta, 0, sizeof(struct man_meta));
                    166:        man->flags = 0;
                    167:        man->last = mandoc_calloc(1, sizeof(struct man_node));
                    168:        man->first = man->last;
                    169:        man->last->type = MAN_ROOT;
                    170:        man->last->tok = MAN_MAX;
                    171:        man->next = MAN_NEXT_CHILD;
1.1       kristaps  172: }
                    173:
                    174:
                    175: static int
                    176: man_node_append(struct man *man, struct man_node *p)
                    177: {
                    178:
                    179:        assert(man->last);
                    180:        assert(man->first);
                    181:        assert(MAN_ROOT != p->type);
                    182:
                    183:        switch (man->next) {
                    184:        case (MAN_NEXT_SIBLING):
                    185:                man->last->next = p;
                    186:                p->prev = man->last;
                    187:                p->parent = man->last->parent;
                    188:                break;
                    189:        case (MAN_NEXT_CHILD):
                    190:                man->last->child = p;
                    191:                p->parent = man->last;
                    192:                break;
                    193:        default:
                    194:                abort();
                    195:                /* NOTREACHED */
                    196:        }
1.5       schwarze  197:
1.22      schwarze  198:        assert(p->parent);
1.5       schwarze  199:        p->parent->nchild++;
1.1       kristaps  200:
1.9       schwarze  201:        if ( ! man_valid_pre(man, p))
                    202:                return(0);
                    203:
                    204:        switch (p->type) {
                    205:        case (MAN_HEAD):
                    206:                assert(MAN_BLOCK == p->parent->type);
                    207:                p->parent->head = p;
                    208:                break;
1.59      schwarze  209:        case (MAN_TAIL):
                    210:                assert(MAN_BLOCK == p->parent->type);
                    211:                p->parent->tail = p;
                    212:                break;
1.9       schwarze  213:        case (MAN_BODY):
                    214:                assert(MAN_BLOCK == p->parent->type);
                    215:                p->parent->body = p;
                    216:                break;
                    217:        default:
                    218:                break;
                    219:        }
                    220:
1.1       kristaps  221:        man->last = p;
                    222:
                    223:        switch (p->type) {
1.52      schwarze  224:        case (MAN_TBL):
                    225:                /* FALLTHROUGH */
1.1       kristaps  226:        case (MAN_TEXT):
                    227:                if ( ! man_valid_post(man))
                    228:                        return(0);
                    229:                break;
                    230:        default:
                    231:                break;
                    232:        }
                    233:
                    234:        return(1);
                    235: }
                    236:
                    237:
                    238: static struct man_node *
1.69      schwarze  239: man_node_alloc(struct man *man, int line, int pos,
1.54      schwarze  240:                enum man_type type, enum mant tok)
1.1       kristaps  241: {
                    242:        struct man_node *p;
                    243:
1.16      schwarze  244:        p = mandoc_calloc(1, sizeof(struct man_node));
1.1       kristaps  245:        p->line = line;
                    246:        p->pos = pos;
                    247:        p->type = type;
                    248:        p->tok = tok;
1.54      schwarze  249:
1.69      schwarze  250:        if (MAN_NEWLINE & man->flags)
1.54      schwarze  251:                p->flags |= MAN_LINE;
1.69      schwarze  252:        man->flags &= ~MAN_NEWLINE;
1.1       kristaps  253:        return(p);
                    254: }
                    255:
                    256:
                    257: int
1.69      schwarze  258: man_elem_alloc(struct man *man, int line, int pos, enum mant tok)
1.1       kristaps  259: {
                    260:        struct man_node *p;
                    261:
1.69      schwarze  262:        p = man_node_alloc(man, line, pos, MAN_ELEM, tok);
                    263:        if ( ! man_node_append(man, p))
1.10      schwarze  264:                return(0);
1.69      schwarze  265:        man->next = MAN_NEXT_CHILD;
1.10      schwarze  266:        return(1);
1.1       kristaps  267: }
                    268:
                    269:
                    270: int
1.69      schwarze  271: man_tail_alloc(struct man *man, int line, int pos, enum mant tok)
1.59      schwarze  272: {
                    273:        struct man_node *p;
                    274:
1.69      schwarze  275:        p = man_node_alloc(man, line, pos, MAN_TAIL, tok);
                    276:        if ( ! man_node_append(man, p))
1.59      schwarze  277:                return(0);
1.69      schwarze  278:        man->next = MAN_NEXT_CHILD;
1.59      schwarze  279:        return(1);
                    280: }
                    281:
                    282:
                    283: int
1.69      schwarze  284: man_head_alloc(struct man *man, int line, int pos, enum mant tok)
1.9       schwarze  285: {
                    286:        struct man_node *p;
                    287:
1.69      schwarze  288:        p = man_node_alloc(man, line, pos, MAN_HEAD, tok);
                    289:        if ( ! man_node_append(man, p))
1.9       schwarze  290:                return(0);
1.69      schwarze  291:        man->next = MAN_NEXT_CHILD;
1.9       schwarze  292:        return(1);
                    293: }
                    294:
                    295:
                    296: int
1.69      schwarze  297: man_body_alloc(struct man *man, int line, int pos, enum mant tok)
1.9       schwarze  298: {
                    299:        struct man_node *p;
                    300:
1.69      schwarze  301:        p = man_node_alloc(man, line, pos, MAN_BODY, tok);
                    302:        if ( ! man_node_append(man, p))
1.9       schwarze  303:                return(0);
1.69      schwarze  304:        man->next = MAN_NEXT_CHILD;
1.9       schwarze  305:        return(1);
                    306: }
                    307:
                    308:
                    309: int
1.69      schwarze  310: man_block_alloc(struct man *man, int line, int pos, enum mant tok)
1.9       schwarze  311: {
                    312:        struct man_node *p;
                    313:
1.69      schwarze  314:        p = man_node_alloc(man, line, pos, MAN_BLOCK, tok);
                    315:        if ( ! man_node_append(man, p))
1.9       schwarze  316:                return(0);
1.69      schwarze  317:        man->next = MAN_NEXT_CHILD;
1.9       schwarze  318:        return(1);
                    319: }
                    320:
1.27      schwarze  321: int
1.69      schwarze  322: man_word_alloc(struct man *man, int line, int pos, const char *word)
1.1       kristaps  323: {
1.10      schwarze  324:        struct man_node *n;
1.1       kristaps  325:
1.69      schwarze  326:        n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX);
                    327:        n->string = roff_strdup(man->roff, word);
1.10      schwarze  328:
1.69      schwarze  329:        if ( ! man_node_append(man, n))
1.1       kristaps  330:                return(0);
1.27      schwarze  331:
1.69      schwarze  332:        man->next = MAN_NEXT_SIBLING;
1.10      schwarze  333:        return(1);
                    334: }
                    335:
                    336:
1.22      schwarze  337: /*
                    338:  * Free all of the resources held by a node.  This does NOT unlink a
                    339:  * node from its context; for that, see man_node_unlink().
                    340:  */
                    341: static void
1.1       kristaps  342: man_node_free(struct man_node *p)
                    343: {
                    344:
                    345:        if (p->string)
                    346:                free(p->string);
                    347:        free(p);
                    348: }
                    349:
                    350:
                    351: void
1.69      schwarze  352: man_node_delete(struct man *man, struct man_node *p)
1.1       kristaps  353: {
                    354:
1.22      schwarze  355:        while (p->child)
1.69      schwarze  356:                man_node_delete(man, p->child);
1.22      schwarze  357:
1.69      schwarze  358:        man_node_unlink(man, p);
1.1       kristaps  359:        man_node_free(p);
                    360: }
                    361:
1.57      schwarze  362: int
1.69      schwarze  363: man_addeqn(struct man *man, const struct eqn *ep)
1.57      schwarze  364: {
                    365:        struct man_node *n;
                    366:
1.69      schwarze  367:        assert( ! (MAN_HALT & man->flags));
1.57      schwarze  368:
1.69      schwarze  369:        n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX);
1.57      schwarze  370:        n->eqn = ep;
                    371:
1.69      schwarze  372:        if ( ! man_node_append(man, n))
1.57      schwarze  373:                return(0);
                    374:
1.69      schwarze  375:        man->next = MAN_NEXT_SIBLING;
                    376:        return(man_descope(man, ep->ln, ep->pos));
1.57      schwarze  377: }
1.1       kristaps  378:
1.52      schwarze  379: int
1.69      schwarze  380: man_addspan(struct man *man, const struct tbl_span *sp)
1.52      schwarze  381: {
1.55      schwarze  382:        struct man_node *n;
1.52      schwarze  383:
1.69      schwarze  384:        assert( ! (MAN_HALT & man->flags));
1.55      schwarze  385:
1.69      schwarze  386:        n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX);
1.55      schwarze  387:        n->span = sp;
                    388:
1.69      schwarze  389:        if ( ! man_node_append(man, n))
1.52      schwarze  390:                return(0);
1.55      schwarze  391:
1.69      schwarze  392:        man->next = MAN_NEXT_SIBLING;
                    393:        return(man_descope(man, sp->line, 0));
1.52      schwarze  394: }
                    395:
                    396: static int
1.69      schwarze  397: man_descope(struct man *man, int line, int offs)
1.52      schwarze  398: {
                    399:        /*
                    400:         * Co-ordinate what happens with having a next-line scope open:
                    401:         * first close out the element scope (if applicable), then close
                    402:         * out the block scope (also if applicable).
                    403:         */
                    404:
1.69      schwarze  405:        if (MAN_ELINE & man->flags) {
                    406:                man->flags &= ~MAN_ELINE;
                    407:                if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))
1.52      schwarze  408:                        return(0);
                    409:        }
                    410:
1.69      schwarze  411:        if ( ! (MAN_BLINE & man->flags))
1.52      schwarze  412:                return(1);
1.69      schwarze  413:        man->flags &= ~MAN_BLINE;
1.52      schwarze  414:
1.69      schwarze  415:        if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))
1.52      schwarze  416:                return(0);
1.69      schwarze  417:        return(man_body_alloc(man, line, offs, man->last->tok));
1.52      schwarze  418: }
                    419:
1.1       kristaps  420: static int
1.69      schwarze  421: man_ptext(struct man *man, int line, char *buf, int offs)
1.1       kristaps  422: {
1.27      schwarze  423:        int              i;
1.26      schwarze  424:
1.10      schwarze  425:        /* Literal free-form text whitespace is preserved. */
                    426:
1.69      schwarze  427:        if (MAN_LITERAL & man->flags) {
                    428:                if ( ! man_word_alloc(man, line, offs, buf + offs))
1.10      schwarze  429:                        return(0);
1.69      schwarze  430:                return(man_descope(man, line, offs));
1.10      schwarze  431:        }
                    432:
1.31      schwarze  433:        for (i = offs; ' ' == buf[i]; i++)
1.10      schwarze  434:                /* Skip leading whitespace. */ ;
1.18      schwarze  435:
1.71      schwarze  436:        /*
                    437:         * Blank lines are ignored right after headings
                    438:         * but add a single vertical space elsewhere.
                    439:         */
                    440:
1.18      schwarze  441:        if ('\0' == buf[i]) {
1.27      schwarze  442:                /* Allocate a blank entry. */
1.71      schwarze  443:                if (MAN_SH != man->last->tok &&
                    444:                    MAN_SS != man->last->tok) {
                    445:                        if ( ! man_elem_alloc(man, line, offs, MAN_sp))
                    446:                                return(0);
                    447:                        man->next = MAN_NEXT_SIBLING;
                    448:                }
1.68      schwarze  449:                return(1);
1.10      schwarze  450:        }
1.1       kristaps  451:
1.27      schwarze  452:        /*
                    453:         * Warn if the last un-escaped character is whitespace. Then
                    454:         * strip away the remaining spaces (tabs stay!).
                    455:         */
1.18      schwarze  456:
1.27      schwarze  457:        i = (int)strlen(buf);
                    458:        assert(i);
1.18      schwarze  459:
1.27      schwarze  460:        if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
                    461:                if (i > 1 && '\\' != buf[i - 2])
1.69      schwarze  462:                        man_pmsg(man, line, i - 1, MANDOCERR_EOLNSPACE);
1.18      schwarze  463:
1.27      schwarze  464:                for (--i; i && ' ' == buf[i]; i--)
                    465:                        /* Spin back to non-space. */ ;
1.10      schwarze  466:
1.27      schwarze  467:                /* Jump ahead of escaped whitespace. */
                    468:                i += '\\' == buf[i] ? 2 : 1;
1.18      schwarze  469:
1.27      schwarze  470:                buf[i] = '\0';
1.10      schwarze  471:        }
1.9       schwarze  472:
1.69      schwarze  473:        if ( ! man_word_alloc(man, line, offs, buf + offs))
1.1       kristaps  474:                return(0);
1.28      schwarze  475:
                    476:        /*
                    477:         * End-of-sentence check.  If the last character is an unescaped
                    478:         * EOS character, then flag the node as being the end of a
                    479:         * sentence.  The front-end will know how to interpret this.
                    480:         */
                    481:
                    482:        assert(i);
1.72      schwarze  483:        if (mandoc_eos(buf, (size_t)i))
1.69      schwarze  484:                man->last->flags |= MAN_EOS;
1.10      schwarze  485:
1.69      schwarze  486:        return(man_descope(man, line, offs));
1.1       kristaps  487: }
                    488:
1.53      schwarze  489: static int
1.69      schwarze  490: man_pmacro(struct man *man, int ln, char *buf, int offs)
1.1       kristaps  491: {
1.59      schwarze  492:        int              i, ppos;
1.22      schwarze  493:        enum mant        tok;
1.10      schwarze  494:        char             mac[5];
                    495:        struct man_node *n;
1.1       kristaps  496:
1.59      schwarze  497:        if ('"' == buf[offs]) {
1.69      schwarze  498:                man_pmsg(man, ln, offs, MANDOCERR_BADCOMMENT);
1.59      schwarze  499:                return(1);
                    500:        } else if ('\0' == buf[offs])
1.17      schwarze  501:                return(1);
1.1       kristaps  502:
1.59      schwarze  503:        ppos = offs;
1.1       kristaps  504:
1.23      schwarze  505:        /*
1.59      schwarze  506:         * Copy the first word into a nil-terminated buffer.
                    507:         * Stop copying when a tab, space, or eoln is encountered.
1.23      schwarze  508:         */
1.27      schwarze  509:
1.59      schwarze  510:        i = 0;
                    511:        while (i < 4 && '\0' != buf[offs] &&
                    512:                        ' ' != buf[offs] && '\t' != buf[offs])
                    513:                mac[i++] = buf[offs++];
1.1       kristaps  514:
1.59      schwarze  515:        mac[i] = '\0';
1.1       kristaps  516:
1.59      schwarze  517:        tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;
1.1       kristaps  518:
1.40      schwarze  519:        if (MAN_MAX == tok) {
1.69      schwarze  520:                mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln,
1.59      schwarze  521:                                ppos, "%s", buf + ppos - 1);
1.1       kristaps  522:                return(1);
                    523:        }
                    524:
                    525:        /* The macro is sane.  Jump to the next word. */
                    526:
1.59      schwarze  527:        while (buf[offs] && ' ' == buf[offs])
                    528:                offs++;
1.18      schwarze  529:
1.27      schwarze  530:        /*
                    531:         * Trailing whitespace.  Note that tabs are allowed to be passed
                    532:         * into the parser as "text", so we only warn about spaces here.
                    533:         */
1.18      schwarze  534:
1.59      schwarze  535:        if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.69      schwarze  536:                man_pmsg(man, ln, offs - 1, MANDOCERR_EOLNSPACE);
1.1       kristaps  537:
1.21      schwarze  538:        /*
1.46      schwarze  539:         * Remove prior ELINE macro, as it's being clobbered by a new
1.21      schwarze  540:         * macro.  Note that NSCOPED macros do not close out ELINE
                    541:         * macros---they don't print text---so we let those slip by.
                    542:         */
                    543:
1.22      schwarze  544:        if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&
1.69      schwarze  545:                        man->flags & MAN_ELINE) {
                    546:                n = man->last;
1.46      schwarze  547:                assert(MAN_TEXT != n->type);
1.21      schwarze  548:
1.49      schwarze  549:                /* Remove repeated NSCOPED macros causing ELINE. */
                    550:
1.46      schwarze  551:                if (MAN_NSCOPED & man_macros[n->tok].flags)
                    552:                        n = n->parent;
1.21      schwarze  553:
1.69      schwarze  554:                mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line,
1.63      schwarze  555:                    n->pos, "%s breaks %s", man_macronames[tok],
                    556:                    man_macronames[n->tok]);
1.10      schwarze  557:
1.69      schwarze  558:                man_node_delete(man, n);
                    559:                man->flags &= ~MAN_ELINE;
1.63      schwarze  560:        }
                    561:
                    562:        /*
                    563:         * Remove prior BLINE macro that is being clobbered.
                    564:         */
1.69      schwarze  565:        if ((man->flags & MAN_BLINE) &&
1.63      schwarze  566:            (MAN_BSCOPE & man_macros[tok].flags)) {
1.69      schwarze  567:                n = man->last;
1.64      schwarze  568:
                    569:                /* Might be a text node like 8 in
                    570:                 * .TP 8
                    571:                 * .SH foo
                    572:                 */
                    573:                if (MAN_TEXT == n->type)
                    574:                        n = n->parent;
1.63      schwarze  575:
                    576:                /* Remove element that didn't end BLINE, if any. */
                    577:                if ( ! (MAN_BSCOPE & man_macros[n->tok].flags))
                    578:                        n = n->parent;
                    579:
                    580:                assert(MAN_HEAD == n->type);
                    581:                n = n->parent;
                    582:                assert(MAN_BLOCK == n->type);
                    583:                assert(MAN_SCOPED & man_macros[n->tok].flags);
                    584:
1.69      schwarze  585:                mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line,
1.63      schwarze  586:                    n->pos, "%s breaks %s", man_macronames[tok],
                    587:                    man_macronames[n->tok]);
                    588:
1.69      schwarze  589:                man_node_delete(man, n);
                    590:                man->flags &= ~MAN_BLINE;
1.10      schwarze  591:        }
                    592:
1.24      schwarze  593:        /*
                    594:         * Save the fact that we're in the next-line for a block.  In
                    595:         * this way, embedded roff instructions can "remember" state
                    596:         * when they exit.
                    597:         */
                    598:
1.69      schwarze  599:        if (MAN_BLINE & man->flags)
                    600:                man->flags |= MAN_BPLINE;
1.24      schwarze  601:
                    602:        /* Call to handler... */
1.1       kristaps  603:
1.22      schwarze  604:        assert(man_macros[tok].fp);
1.69      schwarze  605:        if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf))
1.1       kristaps  606:                goto err;
1.73      schwarze  607:
                    608:        /* In quick mode (for mandocdb), abort after the NAME section. */
                    609:
                    610:        if (man->quick && MAN_SH == tok &&
                    611:            strcmp(man->last->prev->child->string, "NAME"))
                    612:                return(2);
1.1       kristaps  613:
1.21      schwarze  614:        /*
                    615:         * We weren't in a block-line scope when entering the
                    616:         * above-parsed macro, so return.
                    617:         */
                    618:
1.69      schwarze  619:        if ( ! (MAN_BPLINE & man->flags)) {
                    620:                man->flags &= ~MAN_ILINE;
1.9       schwarze  621:                return(1);
1.21      schwarze  622:        }
1.69      schwarze  623:        man->flags &= ~MAN_BPLINE;
1.21      schwarze  624:
                    625:        /*
                    626:         * If we're in a block scope, then allow this macro to slip by
                    627:         * without closing scope around it.
                    628:         */
                    629:
1.69      schwarze  630:        if (MAN_ILINE & man->flags) {
                    631:                man->flags &= ~MAN_ILINE;
1.21      schwarze  632:                return(1);
                    633:        }
1.9       schwarze  634:
                    635:        /*
                    636:         * If we've opened a new next-line element scope, then return
                    637:         * now, as the next line will close out the block scope.
                    638:         */
                    639:
1.69      schwarze  640:        if (MAN_ELINE & man->flags)
1.9       schwarze  641:                return(1);
                    642:
                    643:        /* Close out the block scope opened in the prior line.  */
1.1       kristaps  644:
1.69      schwarze  645:        assert(MAN_BLINE & man->flags);
                    646:        man->flags &= ~MAN_BLINE;
1.1       kristaps  647:
1.69      schwarze  648:        if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX))
1.9       schwarze  649:                return(0);
1.69      schwarze  650:        return(man_body_alloc(man, ln, ppos, man->last->tok));
1.1       kristaps  651:
                    652: err:   /* Error out. */
                    653:
1.69      schwarze  654:        man->flags |= MAN_HALT;
1.1       kristaps  655:        return(0);
                    656: }
1.21      schwarze  657:
1.22      schwarze  658: /*
1.69      schwarze  659:  * Unlink a node from its context.  If "man" is provided, the last parse
1.22      schwarze  660:  * point will also be adjusted accordingly.
                    661:  */
                    662: static void
1.69      schwarze  663: man_node_unlink(struct man *man, struct man_node *n)
1.21      schwarze  664: {
                    665:
1.22      schwarze  666:        /* Adjust siblings. */
                    667:
                    668:        if (n->prev)
1.21      schwarze  669:                n->prev->next = n->next;
1.22      schwarze  670:        if (n->next)
                    671:                n->next->prev = n->prev;
                    672:
                    673:        /* Adjust parent. */
                    674:
                    675:        if (n->parent) {
                    676:                n->parent->nchild--;
                    677:                if (n->parent->child == n)
                    678:                        n->parent->child = n->prev ? n->prev : n->next;
                    679:        }
                    680:
                    681:        /* Adjust parse point, if applicable. */
                    682:
1.69      schwarze  683:        if (man && man->last == n) {
1.22      schwarze  684:                /*XXX: this can occur when bailing from validation. */
                    685:                /*assert(NULL == n->next);*/
                    686:                if (n->prev) {
1.69      schwarze  687:                        man->last = n->prev;
                    688:                        man->next = MAN_NEXT_SIBLING;
1.22      schwarze  689:                } else {
1.69      schwarze  690:                        man->last = n->parent;
                    691:                        man->next = MAN_NEXT_CHILD;
1.21      schwarze  692:                }
                    693:        }
                    694:
1.69      schwarze  695:        if (man && man->first == n)
                    696:                man->first = NULL;
1.62      schwarze  697: }
                    698:
                    699: const struct mparse *
1.69      schwarze  700: man_mparse(const struct man *man)
1.62      schwarze  701: {
                    702:
1.69      schwarze  703:        assert(man && man->parse);
                    704:        return(man->parse);
1.76      schwarze  705: }
                    706:
                    707: void
                    708: man_deroff(char **dest, const struct man_node *n)
                    709: {
                    710:        char    *cp;
                    711:        size_t   sz;
                    712:
                    713:        if (MAN_TEXT != n->type) {
                    714:                for (n = n->child; n; n = n->next)
                    715:                        man_deroff(dest, n);
                    716:                return;
                    717:        }
                    718:
1.77      schwarze  719:        /* Skip leading whitespace and escape sequences. */
1.76      schwarze  720:
1.77      schwarze  721:        cp = n->string;
                    722:        while ('\0' != *cp) {
                    723:                if ('\\' == *cp) {
                    724:                        cp++;
                    725:                        mandoc_escape((const char **)&cp, NULL, NULL);
                    726:                } else if (isspace((unsigned char)*cp))
                    727:                        cp++;
                    728:                else
1.76      schwarze  729:                        break;
1.77      schwarze  730:        }
1.76      schwarze  731:
                    732:        /* Skip trailing whitespace. */
                    733:
                    734:        for (sz = strlen(cp); sz; sz--)
                    735:                if (0 == isspace((unsigned char)cp[sz-1]))
                    736:                        break;
                    737:
                    738:        /* Skip empty strings. */
                    739:
                    740:        if (0 == sz)
                    741:                return;
                    742:
                    743:        if (NULL == *dest) {
                    744:                *dest = mandoc_strndup(cp, sz);
                    745:                return;
                    746:        }
                    747:
                    748:        mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
                    749:        free(*dest);
                    750:        *dest = cp;
1.4       schwarze  751: }