[BACK]Return to man_macro.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man_macro.c, Revision 1.129

1.129   ! schwarze    1: /*     $Id: man_macro.c,v 1.128 2018/08/18 02:08:27 schwarze Exp $ */
1.1       kristaps    2: /*
1.65      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.124     schwarze    4:  * Copyright (c) 2012-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
1.79      schwarze    5:  * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
1.1       kristaps    6:  *
                      7:  * Permission to use, copy, modify, and distribute this software for any
1.14      kristaps    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.101     schwarze   11:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.14      kristaps   12:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.101     schwarze   13:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.14      kristaps   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.30      kristaps   19: #include "config.h"
1.88      schwarze   20:
                     21: #include <sys/types.h>
1.30      kristaps   22:
1.1       kristaps   23: #include <assert.h>
                     24: #include <ctype.h>
                     25: #include <stdlib.h>
                     26: #include <string.h>
                     27:
1.101     schwarze   28: #include "mandoc.h"
                     29: #include "roff.h"
1.58      kristaps   30: #include "man.h"
1.57      kristaps   31: #include "libmandoc.h"
1.106     schwarze   32: #include "roff_int.h"
1.1       kristaps   33: #include "libman.h"
                     34:
1.91      schwarze   35: static void             blk_close(MACRO_PROT_ARGS);
                     36: static void             blk_exp(MACRO_PROT_ARGS);
                     37: static void             blk_imp(MACRO_PROT_ARGS);
                     38: static void             in_line_eoln(MACRO_PROT_ARGS);
1.105     schwarze   39: static int              man_args(struct roff_man *, int,
1.60      kristaps   40:                                int *, char *, char **);
1.116     schwarze   41: static void             rew_scope(struct roff_man *, enum roff_tok);
1.19      kristaps   42:
1.127     schwarze   43: static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
1.66      schwarze   44:        { in_line_eoln, MAN_BSCOPE }, /* TH */
                     45:        { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
                     46:        { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
1.99      schwarze   47:        { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
1.126     schwarze   48:        { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TQ */
1.66      schwarze   49:        { blk_imp, MAN_BSCOPE }, /* LP */
                     50:        { blk_imp, MAN_BSCOPE }, /* PP */
                     51:        { blk_imp, MAN_BSCOPE }, /* P */
                     52:        { blk_imp, MAN_BSCOPE }, /* IP */
                     53:        { blk_imp, MAN_BSCOPE }, /* HP */
1.90      schwarze   54:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
                     55:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
1.19      kristaps   56:        { in_line_eoln, 0 }, /* BI */
                     57:        { in_line_eoln, 0 }, /* IB */
                     58:        { in_line_eoln, 0 }, /* BR */
                     59:        { in_line_eoln, 0 }, /* RB */
1.90      schwarze   60:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
                     61:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
                     62:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
1.19      kristaps   63:        { in_line_eoln, 0 }, /* IR */
                     64:        { in_line_eoln, 0 }, /* RI */
1.110     schwarze   65:        { in_line_eoln, MAN_NSCOPED }, /* nf */
                     66:        { in_line_eoln, MAN_NSCOPED }, /* fi */
1.92      schwarze   67:        { blk_close, MAN_BSCOPE }, /* RE */
1.99      schwarze   68:        { blk_exp, MAN_BSCOPE }, /* RS */
1.23      kristaps   69:        { in_line_eoln, 0 }, /* DT */
1.28      kristaps   70:        { in_line_eoln, 0 }, /* UC */
1.100     schwarze   71:        { in_line_eoln, MAN_NSCOPED }, /* PD */
1.45      joerg      72:        { in_line_eoln, 0 }, /* AT */
1.122     schwarze   73:        { in_line_eoln, MAN_NSCOPED }, /* in */
1.129   ! schwarze   74:        { blk_imp, MAN_BSCOPE }, /* SY */
1.128     schwarze   75:        { blk_close, MAN_BSCOPE }, /* YS */
1.71      kristaps   76:        { in_line_eoln, 0 }, /* OP */
1.72      schwarze   77:        { in_line_eoln, MAN_BSCOPE }, /* EX */
                     78:        { in_line_eoln, MAN_BSCOPE }, /* EE */
1.99      schwarze   79:        { blk_exp, MAN_BSCOPE }, /* UR */
1.92      schwarze   80:        { blk_close, MAN_BSCOPE }, /* UE */
1.123     schwarze   81:        { blk_exp, MAN_BSCOPE }, /* MT */
                     82:        { blk_close, MAN_BSCOPE }, /* ME */
1.19      kristaps   83: };
1.1       kristaps   84:
                     85:
1.127     schwarze   86: const struct man_macro *
                     87: man_macro(enum roff_tok tok)
                     88: {
                     89:        assert(tok >= MAN_TH && tok <= MAN_MAX);
                     90:        return man_macros + (tok - MAN_TH);
                     91: }
                     92:
1.91      schwarze   93: void
1.105     schwarze   94: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1       kristaps   95: {
1.102     schwarze   96:        struct roff_node *n;
1.1       kristaps   97:
1.83      schwarze   98:        to = to->parent;
                     99:        n = man->last;
                    100:        while (n != to) {
1.87      schwarze  101:
                    102:                /* Reached the end of the document? */
                    103:
1.115     schwarze  104:                if (to == NULL && ! (n->flags & NODE_VALID)) {
1.87      schwarze  105:                        if (man->flags & (MAN_BLINE | MAN_ELINE) &&
1.127     schwarze  106:                            man_macro(n->tok)->flags & MAN_SCOPED) {
1.87      schwarze  107:                                mandoc_vmsg(MANDOCERR_BLK_LINE,
                    108:                                    man->parse, n->line, n->pos,
1.116     schwarze  109:                                    "EOF breaks %s", roff_name[n->tok]);
1.87      schwarze  110:                                if (man->flags & MAN_ELINE)
                    111:                                        man->flags &= ~MAN_ELINE;
                    112:                                else {
1.101     schwarze  113:                                        assert(n->type == ROFFT_HEAD);
1.87      schwarze  114:                                        n = n->parent;
                    115:                                        man->flags &= ~MAN_BLINE;
                    116:                                }
                    117:                                man->last = n;
                    118:                                n = n->parent;
1.106     schwarze  119:                                roff_node_delete(man, man->last);
1.87      schwarze  120:                                continue;
                    121:                        }
1.101     schwarze  122:                        if (n->type == ROFFT_BLOCK &&
1.127     schwarze  123:                            man_macro(n->tok)->fp == blk_exp)
1.87      schwarze  124:                                mandoc_msg(MANDOCERR_BLK_NOEND,
                    125:                                    man->parse, n->line, n->pos,
1.116     schwarze  126:                                    roff_name[n->tok]);
1.87      schwarze  127:                }
                    128:
1.55      kristaps  129:                /*
1.83      schwarze  130:                 * We might delete the man->last node
                    131:                 * in the post-validation phase.
                    132:                 * Save a pointer to the parent such that
                    133:                 * we know where to continue the iteration.
1.55      kristaps  134:                 */
1.89      schwarze  135:
1.83      schwarze  136:                man->last = n;
                    137:                n = n->parent;
1.115     schwarze  138:                man->last->flags |= NODE_VALID;
1.19      kristaps  139:        }
1.89      schwarze  140:
                    141:        /*
                    142:         * If we ended up at the parent of the node we were
                    143:         * supposed to rewind to, that means the target node
                    144:         * got deleted, so add the next node we parse as a child
                    145:         * of the parent instead of as a sibling of the target.
                    146:         */
                    147:
                    148:        man->next = (man->last == to) ?
1.105     schwarze  149:            ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.19      kristaps  150: }
1.1       kristaps  151:
1.19      kristaps  152: /*
                    153:  * Rewinding entails ascending the parse tree until a coherent point,
                    154:  * for example, the `SH' macro will close out any intervening `SS'
                    155:  * scopes.  When a scope is closed, it must be validated and actioned.
                    156:  */
1.91      schwarze  157: static void
1.116     schwarze  158: rew_scope(struct roff_man *man, enum roff_tok tok)
1.19      kristaps  159: {
1.102     schwarze  160:        struct roff_node *n;
1.7       kristaps  161:
1.104     schwarze  162:        /* Preserve empty paragraphs before RS. */
                    163:
                    164:        n = man->last;
1.114     schwarze  165:        if (tok == MAN_RS && n->child == NULL &&
1.104     schwarze  166:            (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
                    167:                return;
                    168:
                    169:        for (;;) {
                    170:                if (n->type == ROFFT_ROOT)
                    171:                        return;
1.115     schwarze  172:                if (n->flags & NODE_VALID) {
1.104     schwarze  173:                        n = n->parent;
                    174:                        continue;
                    175:                }
                    176:                if (n->type != ROFFT_BLOCK) {
                    177:                        if (n->parent->type == ROFFT_ROOT) {
                    178:                                man_unscope(man, n);
                    179:                                return;
                    180:                        } else {
                    181:                                n = n->parent;
                    182:                                continue;
                    183:                        }
                    184:                }
                    185:                if (tok != MAN_SH && (n->tok == MAN_SH ||
                    186:                    (tok != MAN_SS && (n->tok == MAN_SS ||
1.127     schwarze  187:                     man_macro(n->tok)->fp == blk_exp))))
1.91      schwarze  188:                        return;
1.104     schwarze  189:                man_unscope(man, n);
                    190:                n = man->last;
1.6       kristaps  191:        }
1.19      kristaps  192: }
                    193:
1.6       kristaps  194:
1.36      kristaps  195: /*
                    196:  * Close out a generic explicit macro.
                    197:  */
1.91      schwarze  198: void
1.21      kristaps  199: blk_close(MACRO_PROT_ARGS)
                    200: {
1.124     schwarze  201:        enum roff_tok            ctok, ntok;
1.102     schwarze  202:        const struct roff_node  *nn;
1.93      schwarze  203:        char                    *p;
1.124     schwarze  204:        int                      cline, cpos, nrew, target;
1.21      kristaps  205:
1.93      schwarze  206:        nrew = 1;
1.21      kristaps  207:        switch (tok) {
1.82      schwarze  208:        case MAN_RE:
1.21      kristaps  209:                ntok = MAN_RS;
1.93      schwarze  210:                if ( ! man_args(man, line, pos, buf, &p))
                    211:                        break;
                    212:                for (nn = man->last->parent; nn; nn = nn->parent)
1.101     schwarze  213:                        if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.93      schwarze  214:                                nrew++;
                    215:                target = strtol(p, &p, 10);
                    216:                if (*p != '\0')
                    217:                        mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                    218:                            line, p - buf, "RE ... %s", p);
                    219:                if (target == 0)
                    220:                        target = 1;
                    221:                nrew -= target;
                    222:                if (nrew < 1) {
                    223:                        mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
                    224:                            line, ppos, "RE %d", target);
                    225:                        return;
                    226:                }
1.128     schwarze  227:                break;
                    228:        case MAN_YS:
                    229:                ntok = MAN_SY;
1.76      schwarze  230:                break;
1.82      schwarze  231:        case MAN_UE:
1.76      schwarze  232:                ntok = MAN_UR;
1.123     schwarze  233:                break;
                    234:        case MAN_ME:
                    235:                ntok = MAN_MT;
1.21      kristaps  236:                break;
                    237:        default:
                    238:                abort();
                    239:        }
                    240:
1.75      schwarze  241:        for (nn = man->last->parent; nn; nn = nn->parent)
1.101     schwarze  242:                if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.21      kristaps  243:                        break;
                    244:
1.91      schwarze  245:        if (nn == NULL) {
1.84      schwarze  246:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
1.116     schwarze  247:                    line, ppos, roff_name[tok]);
1.104     schwarze  248:                rew_scope(man, MAN_PP);
1.124     schwarze  249:                return;
                    250:        }
                    251:
                    252:        cline = man->last->line;
                    253:        cpos = man->last->pos;
                    254:        ctok = man->last->tok;
                    255:        man_unscope(man, nn);
                    256:
                    257:        if (tok == MAN_RE && nn->head->aux > 0)
                    258:                roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
                    259:
                    260:        /* Trailing text. */
                    261:
                    262:        if (buf[*pos] != '\0') {
                    263:                roff_word_alloc(man, line, ppos, buf + *pos);
                    264:                man->last->flags |= NODE_DELIMC;
                    265:        }
                    266:
                    267:        /* Move a trailing paragraph behind the block. */
                    268:
                    269:        if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
                    270:                *pos = strlen(buf);
1.125     schwarze  271:                blk_imp(man, ctok, cline, cpos, pos, buf);
1.129   ! schwarze  272:        }
        !           273:
        !           274:        /* Synopsis blocks need an explicit end marker for spacing. */
        !           275:
        !           276:        if (tok == MAN_YS && man->last == nn) {
        !           277:                roff_elem_alloc(man, line, ppos, tok);
        !           278:                man_unscope(man, man->last);
1.95      schwarze  279:        }
1.21      kristaps  280: }
                    281:
1.91      schwarze  282: void
1.35      kristaps  283: blk_exp(MACRO_PROT_ARGS)
                    284: {
1.102     schwarze  285:        struct roff_node *head;
1.98      schwarze  286:        char            *p;
1.59      kristaps  287:        int              la;
1.35      kristaps  288:
1.104     schwarze  289:        rew_scope(man, tok);
1.108     schwarze  290:        roff_block_alloc(man, line, ppos, tok);
1.106     schwarze  291:        head = roff_head_alloc(man, line, ppos, tok);
1.35      kristaps  292:
1.98      schwarze  293:        la = *pos;
1.121     schwarze  294:        if (man_args(man, line, pos, buf, &p)) {
1.107     schwarze  295:                roff_word_alloc(man, line, la, p);
1.121     schwarze  296:                if (tok == MAN_RS) {
                    297:                        if (roff_getreg(man->roff, "an-margin") == 0)
                    298:                                roff_setreg(man->roff, "an-margin",
                    299:                                    7 * 24, '=');
                    300:                        if ((head->aux = strtod(p, NULL) * 24.0) > 0)
                    301:                                roff_setreg(man->roff, "an-margin",
                    302:                                    head->aux, '+');
                    303:                }
                    304:        }
1.35      kristaps  305:
1.98      schwarze  306:        if (buf[*pos] != '\0')
1.116     schwarze  307:                mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
                    308:                    *pos, "%s ... %s", roff_name[tok], buf + *pos);
1.73      schwarze  309:
1.98      schwarze  310:        man_unscope(man, head);
1.106     schwarze  311:        roff_body_alloc(man, line, ppos, tok);
1.35      kristaps  312: }
                    313:
1.19      kristaps  314: /*
1.101     schwarze  315:  * Parse an implicit-block macro.  These contain a ROFFT_HEAD and a
                    316:  * ROFFT_BODY contained within a ROFFT_BLOCK.  Rules for closing out other
1.19      kristaps  317:  * scopes, such as `SH' closing out an `SS', are defined in the rew
                    318:  * routines.
                    319:  */
1.91      schwarze  320: void
1.19      kristaps  321: blk_imp(MACRO_PROT_ARGS)
                    322: {
1.59      kristaps  323:        int              la;
1.19      kristaps  324:        char            *p;
1.102     schwarze  325:        struct roff_node *n;
1.19      kristaps  326:
1.104     schwarze  327:        rew_scope(man, tok);
1.108     schwarze  328:        n = roff_block_alloc(man, line, ppos, tok);
1.106     schwarze  329:        if (n->tok == MAN_SH || n->tok == MAN_SS)
                    330:                man->flags &= ~MAN_LITERAL;
                    331:        n = roff_head_alloc(man, line, ppos, tok);
1.25      kristaps  332:
1.19      kristaps  333:        /* Add line arguments. */
1.3       kristaps  334:
1.19      kristaps  335:        for (;;) {
                    336:                la = *pos;
1.75      schwarze  337:                if ( ! man_args(man, line, pos, buf, &p))
1.19      kristaps  338:                        break;
1.107     schwarze  339:                roff_word_alloc(man, line, la, p);
1.6       kristaps  340:        }
                    341:
1.99      schwarze  342:        /*
                    343:         * For macros having optional next-line scope,
                    344:         * keep the head open if there were no arguments.
                    345:         * For `TP', always keep the head open.
                    346:         */
1.19      kristaps  347:
1.127     schwarze  348:        if (man_macro(tok)->flags & MAN_SCOPED &&
1.126     schwarze  349:            (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.99      schwarze  350:                man->flags |= MAN_BLINE;
                    351:                return;
1.27      kristaps  352:        }
1.99      schwarze  353:
                    354:        /* Close out the head and open the body. */
                    355:
1.103     schwarze  356:        man_unscope(man, n);
1.106     schwarze  357:        roff_body_alloc(man, line, ppos, tok);
1.4       kristaps  358: }
                    359:
1.91      schwarze  360: void
1.19      kristaps  361: in_line_eoln(MACRO_PROT_ARGS)
1.3       kristaps  362: {
1.59      kristaps  363:        int              la;
1.19      kristaps  364:        char            *p;
1.102     schwarze  365:        struct roff_node *n;
1.3       kristaps  366:
1.108     schwarze  367:        roff_elem_alloc(man, line, ppos, tok);
1.75      schwarze  368:        n = man->last;
1.3       kristaps  369:
1.19      kristaps  370:        for (;;) {
1.117     schwarze  371:                if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
1.96      schwarze  372:                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                    373:                            man->parse, line, *pos, "%s %s",
1.116     schwarze  374:                            roff_name[tok], buf + *pos);
1.97      schwarze  375:                        break;
                    376:                }
1.120     schwarze  377:                if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.97      schwarze  378:                        mandoc_vmsg(MANDOCERR_ARG_EXCESS,
                    379:                            man->parse, line, *pos, "%s ... %s",
1.116     schwarze  380:                            roff_name[tok], buf + *pos);
1.96      schwarze  381:                        break;
                    382:                }
1.19      kristaps  383:                la = *pos;
1.75      schwarze  384:                if ( ! man_args(man, line, pos, buf, &p))
1.19      kristaps  385:                        break;
1.127     schwarze  386:                if (man_macro(tok)->flags & MAN_JOIN &&
1.101     schwarze  387:                    man->last->type == ROFFT_TEXT)
1.107     schwarze  388:                        roff_word_append(man, p);
1.91      schwarze  389:                else
1.107     schwarze  390:                        roff_word_alloc(man, line, la, p);
1.19      kristaps  391:        }
1.78      schwarze  392:
                    393:        /*
1.115     schwarze  394:         * Append NODE_EOS in case the last snipped argument
1.78      schwarze  395:         * ends with a dot, e.g. `.IR syslog (3).'
                    396:         */
                    397:
                    398:        if (n != man->last &&
1.80      schwarze  399:            mandoc_eos(man->last->string, strlen(man->last->string)))
1.115     schwarze  400:                man->last->flags |= NODE_EOS;
1.3       kristaps  401:
1.31      kristaps  402:        /*
                    403:         * If no arguments are specified and this is MAN_SCOPED (i.e.,
                    404:         * next-line scoped), then set our mode to indicate that we're
                    405:         * waiting for terms to load into our context.
                    406:         */
                    407:
1.127     schwarze  408:        if (n == man->last && man_macro(tok)->flags & MAN_SCOPED) {
                    409:                assert((man_macro(tok)->flags & MAN_NSCOPED) == 0);
1.75      schwarze  410:                man->flags |= MAN_ELINE;
1.91      schwarze  411:                return;
1.31      kristaps  412:        }
1.64      kristaps  413:
1.101     schwarze  414:        assert(man->last->type != ROFFT_ROOT);
1.105     schwarze  415:        man->next = ROFF_NEXT_SIBLING;
1.82      schwarze  416:
1.113     schwarze  417:        /* Rewind our element scope. */
1.3       kristaps  418:
1.75      schwarze  419:        for ( ; man->last; man->last = man->last->parent) {
1.113     schwarze  420:                man_state(man, man->last);
1.75      schwarze  421:                if (man->last == n)
1.19      kristaps  422:                        break;
                    423:        }
                    424: }
1.3       kristaps  425:
1.91      schwarze  426: void
1.109     schwarze  427: man_endparse(struct roff_man *man)
1.19      kristaps  428: {
1.22      kristaps  429:
1.91      schwarze  430:        man_unscope(man, man->first);
1.113     schwarze  431:        man->flags &= ~MAN_LITERAL;
1.19      kristaps  432: }
1.3       kristaps  433:
1.60      kristaps  434: static int
1.105     schwarze  435: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.60      kristaps  436: {
                    437:        char     *start;
                    438:
                    439:        assert(*pos);
                    440:        *v = start = buf + *pos;
                    441:        assert(' ' != *start);
                    442:
                    443:        if ('\0' == *start)
1.112     schwarze  444:                return 0;
1.60      kristaps  445:
1.75      schwarze  446:        *v = mandoc_getarg(man->parse, v, line, pos);
1.112     schwarze  447:        return 1;
1.60      kristaps  448: }

CVSweb