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

Annotation of mandoc/man_macro.c, Revision 1.59

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

CVSweb