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

Annotation of mandoc/man_macro.c, Revision 1.68

1.68    ! joerg       1: /*     $Id: man_macro.c,v 1.67 2011/11/18 16:39:08 joerg Exp $ */
1.1       kristaps    2: /*
1.65      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.14      kristaps    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.14      kristaps    9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16:  */
1.30      kristaps   17: #ifdef HAVE_CONFIG_H
                     18: #include "config.h"
                     19: #endif
                     20:
1.1       kristaps   21: #include <assert.h>
                     22: #include <ctype.h>
                     23: #include <stdlib.h>
                     24: #include <string.h>
                     25:
1.58      kristaps   26: #include "man.h"
1.46      kristaps   27: #include "mandoc.h"
1.57      kristaps   28: #include "libmandoc.h"
1.1       kristaps   29: #include "libman.h"
                     30:
1.34      kristaps   31: enum   rew {
                     32:        REW_REWIND,
                     33:        REW_NOHALT,
1.40      kristaps   34:        REW_HALT
1.34      kristaps   35: };
1.19      kristaps   36:
1.35      kristaps   37: static int              blk_close(MACRO_PROT_ARGS);
                     38: static int              blk_exp(MACRO_PROT_ARGS);
                     39: static int              blk_imp(MACRO_PROT_ARGS);
1.19      kristaps   40: static int              in_line_eoln(MACRO_PROT_ARGS);
1.60      kristaps   41: static int              man_args(struct man *, int,
                     42:                                int *, char *, char **);
1.19      kristaps   43:
1.33      kristaps   44: static int              rew_scope(enum man_type,
                     45:                                struct man *, enum mant);
1.34      kristaps   46: static enum rew         rew_dohalt(enum mant, enum man_type,
1.19      kristaps   47:                                const struct man_node *);
1.34      kristaps   48: static enum rew         rew_block(enum mant, enum man_type,
1.21      kristaps   49:                                const struct man_node *);
1.56      kristaps   50: static void             rew_warn(struct man *,
1.46      kristaps   51:                                struct man_node *, enum mandocerr);
1.19      kristaps   52:
                     53: const  struct man_macro __man_macros[MAN_MAX] = {
1.31      kristaps   54:        { in_line_eoln, MAN_NSCOPED }, /* br */
1.66      schwarze   55:        { in_line_eoln, MAN_BSCOPE }, /* TH */
                     56:        { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
                     57:        { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
                     58:        { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
                     59:        { blk_imp, MAN_BSCOPE }, /* LP */
                     60:        { blk_imp, MAN_BSCOPE }, /* PP */
                     61:        { blk_imp, MAN_BSCOPE }, /* P */
                     62:        { blk_imp, MAN_BSCOPE }, /* IP */
                     63:        { blk_imp, MAN_BSCOPE }, /* HP */
1.19      kristaps   64:        { in_line_eoln, MAN_SCOPED }, /* SM */
                     65:        { in_line_eoln, MAN_SCOPED }, /* SB */
                     66:        { in_line_eoln, 0 }, /* BI */
                     67:        { in_line_eoln, 0 }, /* IB */
                     68:        { in_line_eoln, 0 }, /* BR */
                     69:        { in_line_eoln, 0 }, /* RB */
                     70:        { in_line_eoln, MAN_SCOPED }, /* R */
                     71:        { in_line_eoln, MAN_SCOPED }, /* B */
                     72:        { in_line_eoln, MAN_SCOPED }, /* I */
                     73:        { in_line_eoln, 0 }, /* IR */
                     74:        { in_line_eoln, 0 }, /* RI */
1.31      kristaps   75:        { in_line_eoln, MAN_NSCOPED }, /* na */
                     76:        { in_line_eoln, MAN_NSCOPED }, /* sp */
1.66      schwarze   77:        { in_line_eoln, MAN_BSCOPE }, /* nf */
                     78:        { in_line_eoln, MAN_BSCOPE }, /* fi */
1.21      kristaps   79:        { blk_close, 0 }, /* RE */
1.35      kristaps   80:        { blk_exp, MAN_EXPLICIT }, /* RS */
1.23      kristaps   81:        { in_line_eoln, 0 }, /* DT */
1.28      kristaps   82:        { in_line_eoln, 0 }, /* UC */
1.29      kristaps   83:        { in_line_eoln, 0 }, /* PD */
1.45      joerg      84:        { in_line_eoln, 0 }, /* AT */
1.49      kristaps   85:        { in_line_eoln, 0 }, /* in */
1.53      kristaps   86:        { in_line_eoln, 0 }, /* ft */
1.19      kristaps   87: };
1.9       kristaps   88:
1.19      kristaps   89: const  struct man_macro * const man_macros = __man_macros;
1.1       kristaps   90:
                     91:
1.38      kristaps   92: /*
                     93:  * Warn when "n" is an explicit non-roff macro.
                     94:  */
1.56      kristaps   95: static void
1.46      kristaps   96: rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
1.38      kristaps   97: {
                     98:
1.46      kristaps   99:        if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
1.56      kristaps  100:                return;
1.38      kristaps  101:        if (MAN_VALID & n->flags)
1.56      kristaps  102:                return;
1.38      kristaps  103:        if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
1.56      kristaps  104:                return;
                    105:
                    106:        assert(er < MANDOCERR_FATAL);
                    107:        man_nmsg(m, n, er);
1.38      kristaps  108: }
                    109:
                    110:
                    111: /*
1.46      kristaps  112:  * Rewind scope.  If a code "er" != MANDOCERR_MAX has been provided, it
                    113:  * will be used if an explicit block scope is being closed out.
1.38      kristaps  114:  */
1.3       kristaps  115: int
1.55      kristaps  116: man_unscope(struct man *m, const struct man_node *to,
1.46      kristaps  117:                enum mandocerr er)
1.1       kristaps  118: {
1.55      kristaps  119:        struct man_node *n;
1.1       kristaps  120:
1.55      kristaps  121:        assert(to);
1.19      kristaps  122:
1.67      joerg     123:        if (MAN_ROOT != m->last->type)
1.68    ! joerg     124:                return(1);
1.64      kristaps  125:        m->next = MAN_NEXT_SIBLING;
                    126:
1.19      kristaps  127:        /* LINTED */
1.55      kristaps  128:        while (m->last != to) {
                    129:                /*
                    130:                 * Save the parent here, because we may delete the
                    131:                 * m->last node in the post-validation phase and reset
                    132:                 * it to m->last->parent, causing a step in the closing
                    133:                 * out to be lost.
                    134:                 */
                    135:                n = m->last->parent;
1.56      kristaps  136:                rew_warn(m, m->last, er);
1.19      kristaps  137:                if ( ! man_valid_post(m))
                    138:                        return(0);
1.55      kristaps  139:                m->last = n;
1.19      kristaps  140:                assert(m->last);
                    141:        }
                    142:
1.56      kristaps  143:        rew_warn(m, m->last, er);
1.19      kristaps  144:        if ( ! man_valid_post(m))
1.1       kristaps  145:                return(0);
1.35      kristaps  146:
                    147:        return(1);
1.19      kristaps  148: }
1.1       kristaps  149:
                    150:
1.34      kristaps  151: static enum rew
1.33      kristaps  152: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.21      kristaps  153: {
                    154:
                    155:        if (MAN_BLOCK == type && ntok == n->parent->tok &&
                    156:                        MAN_BODY == n->parent->type)
                    157:                return(REW_REWIND);
                    158:        return(ntok == n->tok ? REW_HALT : REW_NOHALT);
                    159: }
                    160:
                    161:
1.19      kristaps  162: /*
                    163:  * There are three scope levels: scoped to the root (all), scoped to the
                    164:  * section (all less sections), and scoped to subsections (all less
                    165:  * sections and subsections).
                    166:  */
1.34      kristaps  167: static enum rew
1.33      kristaps  168: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.19      kristaps  169: {
1.34      kristaps  170:        enum rew         c;
1.1       kristaps  171:
1.38      kristaps  172:        /* We cannot progress beyond the root ever. */
1.19      kristaps  173:        if (MAN_ROOT == n->type)
                    174:                return(REW_HALT);
1.38      kristaps  175:
1.19      kristaps  176:        assert(n->parent);
1.38      kristaps  177:
                    178:        /* Normal nodes shouldn't go to the level of the root. */
1.19      kristaps  179:        if (MAN_ROOT == n->parent->type)
                    180:                return(REW_REWIND);
1.38      kristaps  181:
                    182:        /* Already-validated nodes should be closed out. */
1.19      kristaps  183:        if (MAN_VALID & n->flags)
                    184:                return(REW_NOHALT);
                    185:
1.38      kristaps  186:        /* First: rewind to ourselves. */
1.21      kristaps  187:        if (type == n->type && tok == n->tok)
                    188:                return(REW_REWIND);
                    189:
1.38      kristaps  190:        /*
                    191:         * Next follow the implicit scope-smashings as defined by man.7:
                    192:         * section, sub-section, etc.
                    193:         */
                    194:
1.19      kristaps  195:        switch (tok) {
                    196:        case (MAN_SH):
                    197:                break;
                    198:        case (MAN_SS):
1.20      kristaps  199:                /* Rewind to a section, if a block. */
1.21      kristaps  200:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    201:                        return(c);
                    202:                break;
                    203:        case (MAN_RS):
                    204:                /* Rewind to a subsection, if a block. */
                    205:                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                    206:                        return(c);
                    207:                /* Rewind to a section, if a block. */
                    208:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    209:                        return(c);
1.19      kristaps  210:                break;
                    211:        default:
1.21      kristaps  212:                /* Rewind to an offsetter, if a block. */
                    213:                if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
                    214:                        return(c);
1.20      kristaps  215:                /* Rewind to a subsection, if a block. */
1.21      kristaps  216:                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                    217:                        return(c);
1.20      kristaps  218:                /* Rewind to a section, if a block. */
1.21      kristaps  219:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    220:                        return(c);
1.19      kristaps  221:                break;
1.3       kristaps  222:        }
1.1       kristaps  223:
1.19      kristaps  224:        return(REW_NOHALT);
                    225: }
1.9       kristaps  226:
                    227:
1.19      kristaps  228: /*
                    229:  * Rewinding entails ascending the parse tree until a coherent point,
                    230:  * for example, the `SH' macro will close out any intervening `SS'
                    231:  * scopes.  When a scope is closed, it must be validated and actioned.
                    232:  */
                    233: static int
1.33      kristaps  234: rew_scope(enum man_type type, struct man *m, enum mant tok)
1.19      kristaps  235: {
                    236:        struct man_node *n;
1.34      kristaps  237:        enum rew         c;
1.7       kristaps  238:
1.19      kristaps  239:        /* LINTED */
                    240:        for (n = m->last; n; n = n->parent) {
                    241:                /*
                    242:                 * Whether we should stop immediately (REW_HALT), stop
                    243:                 * and rewind until this point (REW_REWIND), or keep
                    244:                 * rewinding (REW_NOHALT).
                    245:                 */
                    246:                c = rew_dohalt(tok, type, n);
                    247:                if (REW_HALT == c)
                    248:                        return(1);
                    249:                if (REW_REWIND == c)
1.7       kristaps  250:                        break;
1.6       kristaps  251:        }
1.1       kristaps  252:
1.38      kristaps  253:        /*
                    254:         * Rewind until the current point.  Warn if we're a roff
                    255:         * instruction that's mowing over explicit scopes.
                    256:         */
                    257:        assert(n);
1.19      kristaps  258:
1.46      kristaps  259:        return(man_unscope(m, n, MANDOCERR_MAX));
1.19      kristaps  260: }
                    261:
1.6       kristaps  262:
1.36      kristaps  263: /*
                    264:  * Close out a generic explicit macro.
                    265:  */
1.37      kristaps  266: /* ARGSUSED */
1.35      kristaps  267: int
1.21      kristaps  268: blk_close(MACRO_PROT_ARGS)
                    269: {
1.33      kristaps  270:        enum mant                ntok;
1.21      kristaps  271:        const struct man_node   *nn;
                    272:
                    273:        switch (tok) {
                    274:        case (MAN_RE):
                    275:                ntok = MAN_RS;
                    276:                break;
                    277:        default:
                    278:                abort();
                    279:                /* NOTREACHED */
                    280:        }
                    281:
                    282:        for (nn = m->last->parent; nn; nn = nn->parent)
                    283:                if (ntok == nn->tok)
                    284:                        break;
                    285:
                    286:        if (NULL == nn)
1.56      kristaps  287:                man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
1.21      kristaps  288:
                    289:        if ( ! rew_scope(MAN_BODY, m, ntok))
                    290:                return(0);
                    291:        if ( ! rew_scope(MAN_BLOCK, m, ntok))
                    292:                return(0);
1.35      kristaps  293:
1.21      kristaps  294:        return(1);
                    295: }
                    296:
                    297:
1.48      kristaps  298: /* ARGSUSED */
1.35      kristaps  299: int
                    300: blk_exp(MACRO_PROT_ARGS)
                    301: {
1.59      kristaps  302:        int              la;
1.35      kristaps  303:        char            *p;
                    304:
                    305:        /*
                    306:         * Close out prior scopes.  "Regular" explicit macros cannot be
                    307:         * nested, but we allow roff macros to be placed just about
                    308:         * anywhere.
                    309:         */
                    310:
                    311:        if ( ! man_block_alloc(m, line, ppos, tok))
                    312:                return(0);
                    313:        if ( ! man_head_alloc(m, line, ppos, tok))
                    314:                return(0);
                    315:
                    316:        for (;;) {
                    317:                la = *pos;
1.60      kristaps  318:                if ( ! man_args(m, line, pos, buf, &p))
1.35      kristaps  319:                        break;
                    320:                if ( ! man_word_alloc(m, line, la, p))
                    321:                        return(0);
                    322:        }
                    323:
                    324:        assert(m);
                    325:        assert(tok != MAN_MAX);
                    326:
                    327:        if ( ! rew_scope(MAN_HEAD, m, tok))
                    328:                return(0);
                    329:        return(man_body_alloc(m, line, ppos, tok));
                    330: }
                    331:
                    332:
                    333:
1.19      kristaps  334: /*
                    335:  * Parse an implicit-block macro.  These contain a MAN_HEAD and a
                    336:  * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other
                    337:  * scopes, such as `SH' closing out an `SS', are defined in the rew
                    338:  * routines.
                    339:  */
1.48      kristaps  340: /* ARGSUSED */
1.19      kristaps  341: int
                    342: blk_imp(MACRO_PROT_ARGS)
                    343: {
1.59      kristaps  344:        int              la;
1.19      kristaps  345:        char            *p;
1.25      kristaps  346:        struct man_node *n;
1.19      kristaps  347:
                    348:        /* Close out prior scopes. */
1.7       kristaps  349:
1.19      kristaps  350:        if ( ! rew_scope(MAN_BODY, m, tok))
1.5       kristaps  351:                return(0);
1.19      kristaps  352:        if ( ! rew_scope(MAN_BLOCK, m, tok))
1.6       kristaps  353:                return(0);
1.1       kristaps  354:
1.19      kristaps  355:        /* Allocate new block & head scope. */
                    356:
                    357:        if ( ! man_block_alloc(m, line, ppos, tok))
                    358:                return(0);
                    359:        if ( ! man_head_alloc(m, line, ppos, tok))
                    360:                return(0);
1.1       kristaps  361:
1.25      kristaps  362:        n = m->last;
                    363:
1.19      kristaps  364:        /* Add line arguments. */
1.3       kristaps  365:
1.19      kristaps  366:        for (;;) {
                    367:                la = *pos;
1.60      kristaps  368:                if ( ! man_args(m, line, pos, buf, &p))
1.19      kristaps  369:                        break;
                    370:                if ( ! man_word_alloc(m, line, la, p))
1.6       kristaps  371:                        return(0);
                    372:        }
                    373:
1.19      kristaps  374:        /* Close out head and open body (unless MAN_SCOPE). */
                    375:
1.27      kristaps  376:        if (MAN_SCOPED & man_macros[tok].flags) {
                    377:                /* If we're forcing scope (`TP'), keep it open. */
                    378:                if (MAN_FSCOPED & man_macros[tok].flags) {
                    379:                        m->flags |= MAN_BLINE;
                    380:                        return(1);
                    381:                } else if (n == m->last) {
                    382:                        m->flags |= MAN_BLINE;
                    383:                        return(1);
                    384:                }
                    385:        }
                    386:
                    387:        if ( ! rew_scope(MAN_HEAD, m, tok))
1.6       kristaps  388:                return(0);
1.19      kristaps  389:        return(man_body_alloc(m, line, ppos, tok));
1.4       kristaps  390: }
                    391:
                    392:
1.48      kristaps  393: /* ARGSUSED */
1.19      kristaps  394: int
                    395: in_line_eoln(MACRO_PROT_ARGS)
1.3       kristaps  396: {
1.59      kristaps  397:        int              la;
1.19      kristaps  398:        char            *p;
                    399:        struct man_node *n;
1.3       kristaps  400:
1.19      kristaps  401:        if ( ! man_elem_alloc(m, line, ppos, tok))
1.3       kristaps  402:                return(0);
                    403:
1.19      kristaps  404:        n = m->last;
1.3       kristaps  405:
1.19      kristaps  406:        for (;;) {
                    407:                la = *pos;
1.60      kristaps  408:                if ( ! man_args(m, line, pos, buf, &p))
1.19      kristaps  409:                        break;
                    410:                if ( ! man_word_alloc(m, line, la, p))
                    411:                        return(0);
                    412:        }
1.3       kristaps  413:
1.31      kristaps  414:        /*
                    415:         * If no arguments are specified and this is MAN_SCOPED (i.e.,
                    416:         * next-line scoped), then set our mode to indicate that we're
                    417:         * waiting for terms to load into our context.
                    418:         */
                    419:
1.25      kristaps  420:        if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
1.31      kristaps  421:                assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.19      kristaps  422:                m->flags |= MAN_ELINE;
                    423:                return(1);
                    424:        }
1.3       kristaps  425:
1.31      kristaps  426:        /* Set ignorable context, if applicable. */
                    427:
                    428:        if (MAN_NSCOPED & man_macros[tok].flags) {
                    429:                assert( ! (MAN_SCOPED & man_macros[tok].flags));
                    430:                m->flags |= MAN_ILINE;
                    431:        }
1.64      kristaps  432:
                    433:        assert(MAN_ROOT != m->last->type);
                    434:        m->next = MAN_NEXT_SIBLING;
1.31      kristaps  435:
1.19      kristaps  436:        /*
1.31      kristaps  437:         * Rewind our element scope.  Note that when TH is pruned, we'll
                    438:         * be back at the root, so make sure that we don't clobber as
                    439:         * its sibling.
1.19      kristaps  440:         */
1.3       kristaps  441:
1.19      kristaps  442:        for ( ; m->last; m->last = m->last->parent) {
                    443:                if (m->last == n)
                    444:                        break;
                    445:                if (m->last->type == MAN_ROOT)
                    446:                        break;
                    447:                if ( ! man_valid_post(m))
                    448:                        return(0);
                    449:        }
1.3       kristaps  450:
1.19      kristaps  451:        assert(m->last);
1.3       kristaps  452:
                    453:        /*
1.19      kristaps  454:         * Same here regarding whether we're back at the root.
1.3       kristaps  455:         */
                    456:
1.19      kristaps  457:        if (m->last->type != MAN_ROOT && ! man_valid_post(m))
                    458:                return(0);
1.3       kristaps  459:
1.19      kristaps  460:        return(1);
                    461: }
1.3       kristaps  462:
                    463:
1.19      kristaps  464: int
                    465: man_macroend(struct man *m)
                    466: {
1.22      kristaps  467:
1.46      kristaps  468:        return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
1.19      kristaps  469: }
1.3       kristaps  470:
1.60      kristaps  471: static int
                    472: man_args(struct man *m, int line, int *pos, char *buf, char **v)
                    473: {
                    474:        char     *start;
                    475:
                    476:        assert(*pos);
                    477:        *v = start = buf + *pos;
                    478:        assert(' ' != *start);
                    479:
                    480:        if ('\0' == *start)
                    481:                return(0);
                    482:
1.62      kristaps  483:        *v = mandoc_getarg(m->parse, v, line, pos);
1.60      kristaps  484:        return(1);
                    485: }

CVSweb