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

Annotation of mandoc/man_macro.c, Revision 1.119

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

CVSweb