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

Annotation of mandoc/man_macro.c, Revision 1.116

1.116   ! schwarze    1: /*     $Id: man_macro.c,v 1.115 2017/01/10 13:47:00 schwarze Exp $ */
1.1       kristaps    2: /*
1.65      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.116   ! schwarze    4:  * Copyright (c) 2012-2015, 2017 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.116   ! schwarze   43: 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.66      schwarze   48:        { blk_imp, MAN_BSCOPE }, /* LP */
                     49:        { blk_imp, MAN_BSCOPE }, /* PP */
                     50:        { blk_imp, MAN_BSCOPE }, /* P */
                     51:        { blk_imp, MAN_BSCOPE }, /* IP */
                     52:        { blk_imp, MAN_BSCOPE }, /* HP */
1.90      schwarze   53:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
                     54:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
1.19      kristaps   55:        { in_line_eoln, 0 }, /* BI */
                     56:        { in_line_eoln, 0 }, /* IB */
                     57:        { in_line_eoln, 0 }, /* BR */
                     58:        { in_line_eoln, 0 }, /* RB */
1.90      schwarze   59:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
                     60:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
                     61:        { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
1.19      kristaps   62:        { in_line_eoln, 0 }, /* IR */
                     63:        { in_line_eoln, 0 }, /* RI */
1.116   ! schwarze   64:        { in_line_eoln, MAN_NSCOPED }, /* br */
1.31      kristaps   65:        { in_line_eoln, MAN_NSCOPED }, /* sp */
1.110     schwarze   66:        { in_line_eoln, MAN_NSCOPED }, /* nf */
                     67:        { in_line_eoln, MAN_NSCOPED }, /* fi */
1.92      schwarze   68:        { blk_close, MAN_BSCOPE }, /* RE */
1.99      schwarze   69:        { blk_exp, MAN_BSCOPE }, /* RS */
1.23      kristaps   70:        { in_line_eoln, 0 }, /* DT */
1.28      kristaps   71:        { in_line_eoln, 0 }, /* UC */
1.100     schwarze   72:        { in_line_eoln, MAN_NSCOPED }, /* PD */
1.45      joerg      73:        { in_line_eoln, 0 }, /* AT */
1.49      kristaps   74:        { in_line_eoln, 0 }, /* in */
1.53      kristaps   75:        { in_line_eoln, 0 }, /* ft */
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.81      schwarze   81:        { in_line_eoln, 0 }, /* ll */
1.19      kristaps   82: };
1.116   ! schwarze   83: const  struct man_macro *const man_macros = __man_macros - MAN_TH;
1.1       kristaps   84:
                     85:
1.91      schwarze   86: void
1.105     schwarze   87: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1       kristaps   88: {
1.102     schwarze   89:        struct roff_node *n;
1.1       kristaps   90:
1.83      schwarze   91:        to = to->parent;
                     92:        n = man->last;
                     93:        while (n != to) {
1.87      schwarze   94:
                     95:                /* Reached the end of the document? */
                     96:
1.115     schwarze   97:                if (to == NULL && ! (n->flags & NODE_VALID)) {
1.87      schwarze   98:                        if (man->flags & (MAN_BLINE | MAN_ELINE) &&
                     99:                            man_macros[n->tok].flags & MAN_SCOPED) {
                    100:                                mandoc_vmsg(MANDOCERR_BLK_LINE,
                    101:                                    man->parse, n->line, n->pos,
1.116   ! schwarze  102:                                    "EOF breaks %s", roff_name[n->tok]);
1.87      schwarze  103:                                if (man->flags & MAN_ELINE)
                    104:                                        man->flags &= ~MAN_ELINE;
                    105:                                else {
1.101     schwarze  106:                                        assert(n->type == ROFFT_HEAD);
1.87      schwarze  107:                                        n = n->parent;
                    108:                                        man->flags &= ~MAN_BLINE;
                    109:                                }
                    110:                                man->last = n;
                    111:                                n = n->parent;
1.106     schwarze  112:                                roff_node_delete(man, man->last);
1.87      schwarze  113:                                continue;
                    114:                        }
1.101     schwarze  115:                        if (n->type == ROFFT_BLOCK &&
1.99      schwarze  116:                            man_macros[n->tok].fp == blk_exp)
1.87      schwarze  117:                                mandoc_msg(MANDOCERR_BLK_NOEND,
                    118:                                    man->parse, n->line, n->pos,
1.116   ! schwarze  119:                                    roff_name[n->tok]);
1.87      schwarze  120:                }
                    121:
1.55      kristaps  122:                /*
1.83      schwarze  123:                 * We might delete the man->last node
                    124:                 * in the post-validation phase.
                    125:                 * Save a pointer to the parent such that
                    126:                 * we know where to continue the iteration.
1.55      kristaps  127:                 */
1.89      schwarze  128:
1.83      schwarze  129:                man->last = n;
                    130:                n = n->parent;
1.115     schwarze  131:                man->last->flags |= NODE_VALID;
1.19      kristaps  132:        }
1.89      schwarze  133:
                    134:        /*
                    135:         * If we ended up at the parent of the node we were
                    136:         * supposed to rewind to, that means the target node
                    137:         * got deleted, so add the next node we parse as a child
                    138:         * of the parent instead of as a sibling of the target.
                    139:         */
                    140:
                    141:        man->next = (man->last == to) ?
1.105     schwarze  142:            ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.19      kristaps  143: }
1.1       kristaps  144:
1.19      kristaps  145: /*
                    146:  * Rewinding entails ascending the parse tree until a coherent point,
                    147:  * for example, the `SH' macro will close out any intervening `SS'
                    148:  * scopes.  When a scope is closed, it must be validated and actioned.
                    149:  */
1.91      schwarze  150: static void
1.116   ! schwarze  151: rew_scope(struct roff_man *man, enum roff_tok tok)
1.19      kristaps  152: {
1.102     schwarze  153:        struct roff_node *n;
1.7       kristaps  154:
1.104     schwarze  155:        /* Preserve empty paragraphs before RS. */
                    156:
                    157:        n = man->last;
1.114     schwarze  158:        if (tok == MAN_RS && n->child == NULL &&
1.104     schwarze  159:            (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
                    160:                return;
                    161:
                    162:        for (;;) {
                    163:                if (n->type == ROFFT_ROOT)
                    164:                        return;
1.115     schwarze  165:                if (n->flags & NODE_VALID) {
1.104     schwarze  166:                        n = n->parent;
                    167:                        continue;
                    168:                }
                    169:                if (n->type != ROFFT_BLOCK) {
                    170:                        if (n->parent->type == ROFFT_ROOT) {
                    171:                                man_unscope(man, n);
                    172:                                return;
                    173:                        } else {
                    174:                                n = n->parent;
                    175:                                continue;
                    176:                        }
                    177:                }
                    178:                if (tok != MAN_SH && (n->tok == MAN_SH ||
                    179:                    (tok != MAN_SS && (n->tok == MAN_SS ||
                    180:                     man_macros[n->tok].fp == blk_exp))))
1.91      schwarze  181:                        return;
1.104     schwarze  182:                man_unscope(man, n);
                    183:                n = man->last;
1.6       kristaps  184:        }
1.19      kristaps  185: }
                    186:
1.6       kristaps  187:
1.36      kristaps  188: /*
                    189:  * Close out a generic explicit macro.
                    190:  */
1.91      schwarze  191: void
1.21      kristaps  192: blk_close(MACRO_PROT_ARGS)
                    193: {
1.116   ! schwarze  194:        enum roff_tok            ntok;
1.102     schwarze  195:        const struct roff_node  *nn;
1.93      schwarze  196:        char                    *p;
                    197:        int                      nrew, target;
1.21      kristaps  198:
1.93      schwarze  199:        nrew = 1;
1.21      kristaps  200:        switch (tok) {
1.82      schwarze  201:        case MAN_RE:
1.21      kristaps  202:                ntok = MAN_RS;
1.93      schwarze  203:                if ( ! man_args(man, line, pos, buf, &p))
                    204:                        break;
                    205:                for (nn = man->last->parent; nn; nn = nn->parent)
1.101     schwarze  206:                        if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.93      schwarze  207:                                nrew++;
                    208:                target = strtol(p, &p, 10);
                    209:                if (*p != '\0')
                    210:                        mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                    211:                            line, p - buf, "RE ... %s", p);
                    212:                if (target == 0)
                    213:                        target = 1;
                    214:                nrew -= target;
                    215:                if (nrew < 1) {
                    216:                        mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
                    217:                            line, ppos, "RE %d", target);
                    218:                        return;
                    219:                }
1.76      schwarze  220:                break;
1.82      schwarze  221:        case MAN_UE:
1.76      schwarze  222:                ntok = MAN_UR;
1.21      kristaps  223:                break;
                    224:        default:
                    225:                abort();
                    226:        }
                    227:
1.75      schwarze  228:        for (nn = man->last->parent; nn; nn = nn->parent)
1.101     schwarze  229:                if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.21      kristaps  230:                        break;
                    231:
1.91      schwarze  232:        if (nn == NULL) {
1.84      schwarze  233:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
1.116   ! schwarze  234:                    line, ppos, roff_name[tok]);
1.104     schwarze  235:                rew_scope(man, MAN_PP);
1.95      schwarze  236:        } else {
                    237:                line = man->last->line;
                    238:                ppos = man->last->pos;
                    239:                ntok = man->last->tok;
1.83      schwarze  240:                man_unscope(man, nn);
1.95      schwarze  241:
                    242:                /* Move a trailing paragraph behind the block. */
                    243:
                    244:                if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
                    245:                        *pos = strlen(buf);
                    246:                        blk_imp(man, ntok, line, ppos, pos, buf);
                    247:                }
                    248:        }
1.21      kristaps  249: }
                    250:
1.91      schwarze  251: void
1.35      kristaps  252: blk_exp(MACRO_PROT_ARGS)
                    253: {
1.102     schwarze  254:        struct roff_node *head;
1.98      schwarze  255:        char            *p;
1.59      kristaps  256:        int              la;
1.35      kristaps  257:
1.104     schwarze  258:        rew_scope(man, tok);
1.108     schwarze  259:        roff_block_alloc(man, line, ppos, tok);
1.106     schwarze  260:        head = roff_head_alloc(man, line, ppos, tok);
1.35      kristaps  261:
1.98      schwarze  262:        la = *pos;
                    263:        if (man_args(man, line, pos, buf, &p))
1.107     schwarze  264:                roff_word_alloc(man, line, la, p);
1.35      kristaps  265:
1.98      schwarze  266:        if (buf[*pos] != '\0')
1.116   ! schwarze  267:                mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
        !           268:                    *pos, "%s ... %s", roff_name[tok], buf + *pos);
1.73      schwarze  269:
1.98      schwarze  270:        man_unscope(man, head);
1.106     schwarze  271:        roff_body_alloc(man, line, ppos, tok);
1.35      kristaps  272: }
                    273:
1.19      kristaps  274: /*
1.101     schwarze  275:  * Parse an implicit-block macro.  These contain a ROFFT_HEAD and a
                    276:  * ROFFT_BODY contained within a ROFFT_BLOCK.  Rules for closing out other
1.19      kristaps  277:  * scopes, such as `SH' closing out an `SS', are defined in the rew
                    278:  * routines.
                    279:  */
1.91      schwarze  280: void
1.19      kristaps  281: blk_imp(MACRO_PROT_ARGS)
                    282: {
1.59      kristaps  283:        int              la;
1.19      kristaps  284:        char            *p;
1.102     schwarze  285:        struct roff_node *n;
1.19      kristaps  286:
1.104     schwarze  287:        rew_scope(man, tok);
1.108     schwarze  288:        n = roff_block_alloc(man, line, ppos, tok);
1.106     schwarze  289:        if (n->tok == MAN_SH || n->tok == MAN_SS)
                    290:                man->flags &= ~MAN_LITERAL;
                    291:        n = roff_head_alloc(man, line, ppos, tok);
1.25      kristaps  292:
1.19      kristaps  293:        /* Add line arguments. */
1.3       kristaps  294:
1.19      kristaps  295:        for (;;) {
                    296:                la = *pos;
1.75      schwarze  297:                if ( ! man_args(man, line, pos, buf, &p))
1.19      kristaps  298:                        break;
1.107     schwarze  299:                roff_word_alloc(man, line, la, p);
1.6       kristaps  300:        }
                    301:
1.99      schwarze  302:        /*
                    303:         * For macros having optional next-line scope,
                    304:         * keep the head open if there were no arguments.
                    305:         * For `TP', always keep the head open.
                    306:         */
1.19      kristaps  307:
1.99      schwarze  308:        if (man_macros[tok].flags & MAN_SCOPED &&
                    309:            (tok == MAN_TP || n == man->last)) {
                    310:                man->flags |= MAN_BLINE;
                    311:                return;
1.27      kristaps  312:        }
1.99      schwarze  313:
                    314:        /* Close out the head and open the body. */
                    315:
1.103     schwarze  316:        man_unscope(man, n);
1.106     schwarze  317:        roff_body_alloc(man, line, ppos, tok);
1.4       kristaps  318: }
                    319:
1.91      schwarze  320: void
1.19      kristaps  321: in_line_eoln(MACRO_PROT_ARGS)
1.3       kristaps  322: {
1.59      kristaps  323:        int              la;
1.19      kristaps  324:        char            *p;
1.102     schwarze  325:        struct roff_node *n;
1.3       kristaps  326:
1.108     schwarze  327:        roff_elem_alloc(man, line, ppos, tok);
1.75      schwarze  328:        n = man->last;
1.3       kristaps  329:
1.19      kristaps  330:        for (;;) {
1.96      schwarze  331:                if (buf[*pos] != '\0' && (tok == MAN_br ||
                    332:                    tok == MAN_fi || tok == MAN_nf)) {
                    333:                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                    334:                            man->parse, line, *pos, "%s %s",
1.116   ! schwarze  335:                            roff_name[tok], buf + *pos);
1.97      schwarze  336:                        break;
                    337:                }
                    338:                if (buf[*pos] != '\0' && man->last != n &&
                    339:                    (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) {
                    340:                        mandoc_vmsg(MANDOCERR_ARG_EXCESS,
                    341:                            man->parse, line, *pos, "%s ... %s",
1.116   ! schwarze  342:                            roff_name[tok], buf + *pos);
1.96      schwarze  343:                        break;
                    344:                }
1.19      kristaps  345:                la = *pos;
1.75      schwarze  346:                if ( ! man_args(man, line, pos, buf, &p))
1.19      kristaps  347:                        break;
1.90      schwarze  348:                if (man_macros[tok].flags & MAN_JOIN &&
1.101     schwarze  349:                    man->last->type == ROFFT_TEXT)
1.107     schwarze  350:                        roff_word_append(man, p);
1.91      schwarze  351:                else
1.107     schwarze  352:                        roff_word_alloc(man, line, la, p);
1.19      kristaps  353:        }
1.78      schwarze  354:
                    355:        /*
1.115     schwarze  356:         * Append NODE_EOS in case the last snipped argument
1.78      schwarze  357:         * ends with a dot, e.g. `.IR syslog (3).'
                    358:         */
                    359:
                    360:        if (n != man->last &&
1.80      schwarze  361:            mandoc_eos(man->last->string, strlen(man->last->string)))
1.115     schwarze  362:                man->last->flags |= NODE_EOS;
1.3       kristaps  363:
1.31      kristaps  364:        /*
                    365:         * If no arguments are specified and this is MAN_SCOPED (i.e.,
                    366:         * next-line scoped), then set our mode to indicate that we're
                    367:         * waiting for terms to load into our context.
                    368:         */
                    369:
1.91      schwarze  370:        if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
                    371:                assert( ! (man_macros[tok].flags & MAN_NSCOPED));
1.75      schwarze  372:                man->flags |= MAN_ELINE;
1.91      schwarze  373:                return;
1.31      kristaps  374:        }
1.64      kristaps  375:
1.101     schwarze  376:        assert(man->last->type != ROFFT_ROOT);
1.105     schwarze  377:        man->next = ROFF_NEXT_SIBLING;
1.82      schwarze  378:
1.113     schwarze  379:        /* Rewind our element scope. */
1.3       kristaps  380:
1.75      schwarze  381:        for ( ; man->last; man->last = man->last->parent) {
1.113     schwarze  382:                man_state(man, man->last);
1.75      schwarze  383:                if (man->last == n)
1.19      kristaps  384:                        break;
                    385:        }
                    386: }
1.3       kristaps  387:
1.91      schwarze  388: void
1.109     schwarze  389: man_endparse(struct roff_man *man)
1.19      kristaps  390: {
1.22      kristaps  391:
1.91      schwarze  392:        man_unscope(man, man->first);
1.113     schwarze  393:        man->flags &= ~MAN_LITERAL;
1.19      kristaps  394: }
1.3       kristaps  395:
1.60      kristaps  396: static int
1.105     schwarze  397: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.60      kristaps  398: {
                    399:        char     *start;
                    400:
                    401:        assert(*pos);
                    402:        *v = start = buf + *pos;
                    403:        assert(' ' != *start);
                    404:
                    405:        if ('\0' == *start)
1.112     schwarze  406:                return 0;
1.60      kristaps  407:
1.75      schwarze  408:        *v = mandoc_getarg(man->parse, v, line, pos);
1.112     schwarze  409:        return 1;
1.60      kristaps  410: }

CVSweb