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

Annotation of mandoc/man_macro.c, Revision 1.70

1.70    ! schwarze    1: /*     $Id: man_macro.c,v 1.69 2011/11/18 17:06:19 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.64      kristaps  123:        m->next = MAN_NEXT_SIBLING;
                    124:
1.19      kristaps  125:        /* LINTED */
1.55      kristaps  126:        while (m->last != to) {
                    127:                /*
                    128:                 * Save the parent here, because we may delete the
                    129:                 * m->last node in the post-validation phase and reset
                    130:                 * it to m->last->parent, causing a step in the closing
                    131:                 * out to be lost.
                    132:                 */
                    133:                n = m->last->parent;
1.56      kristaps  134:                rew_warn(m, m->last, er);
1.19      kristaps  135:                if ( ! man_valid_post(m))
                    136:                        return(0);
1.55      kristaps  137:                m->last = n;
1.19      kristaps  138:                assert(m->last);
                    139:        }
                    140:
1.56      kristaps  141:        rew_warn(m, m->last, er);
1.19      kristaps  142:        if ( ! man_valid_post(m))
1.1       kristaps  143:                return(0);
1.35      kristaps  144:
                    145:        return(1);
1.19      kristaps  146: }
1.1       kristaps  147:
                    148:
1.34      kristaps  149: static enum rew
1.33      kristaps  150: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.21      kristaps  151: {
                    152:
                    153:        if (MAN_BLOCK == type && ntok == n->parent->tok &&
                    154:                        MAN_BODY == n->parent->type)
                    155:                return(REW_REWIND);
                    156:        return(ntok == n->tok ? REW_HALT : REW_NOHALT);
                    157: }
                    158:
                    159:
1.19      kristaps  160: /*
                    161:  * There are three scope levels: scoped to the root (all), scoped to the
                    162:  * section (all less sections), and scoped to subsections (all less
                    163:  * sections and subsections).
                    164:  */
1.34      kristaps  165: static enum rew
1.33      kristaps  166: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.19      kristaps  167: {
1.34      kristaps  168:        enum rew         c;
1.1       kristaps  169:
1.38      kristaps  170:        /* We cannot progress beyond the root ever. */
1.19      kristaps  171:        if (MAN_ROOT == n->type)
                    172:                return(REW_HALT);
1.38      kristaps  173:
1.19      kristaps  174:        assert(n->parent);
1.38      kristaps  175:
                    176:        /* Normal nodes shouldn't go to the level of the root. */
1.19      kristaps  177:        if (MAN_ROOT == n->parent->type)
                    178:                return(REW_REWIND);
1.38      kristaps  179:
                    180:        /* Already-validated nodes should be closed out. */
1.19      kristaps  181:        if (MAN_VALID & n->flags)
                    182:                return(REW_NOHALT);
                    183:
1.38      kristaps  184:        /* First: rewind to ourselves. */
1.21      kristaps  185:        if (type == n->type && tok == n->tok)
                    186:                return(REW_REWIND);
                    187:
1.38      kristaps  188:        /*
                    189:         * Next follow the implicit scope-smashings as defined by man.7:
                    190:         * section, sub-section, etc.
                    191:         */
                    192:
1.19      kristaps  193:        switch (tok) {
                    194:        case (MAN_SH):
                    195:                break;
                    196:        case (MAN_SS):
1.20      kristaps  197:                /* Rewind to a section, if a block. */
1.21      kristaps  198:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    199:                        return(c);
                    200:                break;
                    201:        case (MAN_RS):
                    202:                /* Rewind to a subsection, if a block. */
                    203:                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                    204:                        return(c);
                    205:                /* Rewind to a section, if a block. */
                    206:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    207:                        return(c);
1.19      kristaps  208:                break;
                    209:        default:
1.21      kristaps  210:                /* Rewind to an offsetter, if a block. */
                    211:                if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
                    212:                        return(c);
1.20      kristaps  213:                /* Rewind to a subsection, if a block. */
1.21      kristaps  214:                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                    215:                        return(c);
1.20      kristaps  216:                /* Rewind to a section, if a block. */
1.21      kristaps  217:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    218:                        return(c);
1.19      kristaps  219:                break;
1.3       kristaps  220:        }
1.1       kristaps  221:
1.19      kristaps  222:        return(REW_NOHALT);
                    223: }
1.9       kristaps  224:
                    225:
1.19      kristaps  226: /*
                    227:  * Rewinding entails ascending the parse tree until a coherent point,
                    228:  * for example, the `SH' macro will close out any intervening `SS'
                    229:  * scopes.  When a scope is closed, it must be validated and actioned.
                    230:  */
                    231: static int
1.33      kristaps  232: rew_scope(enum man_type type, struct man *m, enum mant tok)
1.19      kristaps  233: {
                    234:        struct man_node *n;
1.34      kristaps  235:        enum rew         c;
1.7       kristaps  236:
1.19      kristaps  237:        /* LINTED */
                    238:        for (n = m->last; n; n = n->parent) {
                    239:                /*
                    240:                 * Whether we should stop immediately (REW_HALT), stop
                    241:                 * and rewind until this point (REW_REWIND), or keep
                    242:                 * rewinding (REW_NOHALT).
                    243:                 */
                    244:                c = rew_dohalt(tok, type, n);
                    245:                if (REW_HALT == c)
                    246:                        return(1);
                    247:                if (REW_REWIND == c)
1.7       kristaps  248:                        break;
1.6       kristaps  249:        }
1.1       kristaps  250:
1.38      kristaps  251:        /*
                    252:         * Rewind until the current point.  Warn if we're a roff
                    253:         * instruction that's mowing over explicit scopes.
                    254:         */
                    255:        assert(n);
1.19      kristaps  256:
1.46      kristaps  257:        return(man_unscope(m, n, MANDOCERR_MAX));
1.19      kristaps  258: }
                    259:
1.6       kristaps  260:
1.36      kristaps  261: /*
                    262:  * Close out a generic explicit macro.
                    263:  */
1.37      kristaps  264: /* ARGSUSED */
1.35      kristaps  265: int
1.21      kristaps  266: blk_close(MACRO_PROT_ARGS)
                    267: {
1.33      kristaps  268:        enum mant                ntok;
1.21      kristaps  269:        const struct man_node   *nn;
                    270:
                    271:        switch (tok) {
                    272:        case (MAN_RE):
                    273:                ntok = MAN_RS;
                    274:                break;
                    275:        default:
                    276:                abort();
                    277:                /* NOTREACHED */
                    278:        }
                    279:
                    280:        for (nn = m->last->parent; nn; nn = nn->parent)
                    281:                if (ntok == nn->tok)
                    282:                        break;
                    283:
                    284:        if (NULL == nn)
1.56      kristaps  285:                man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
1.21      kristaps  286:
                    287:        if ( ! rew_scope(MAN_BODY, m, ntok))
                    288:                return(0);
                    289:        if ( ! rew_scope(MAN_BLOCK, m, ntok))
                    290:                return(0);
1.35      kristaps  291:
1.21      kristaps  292:        return(1);
                    293: }
                    294:
                    295:
1.48      kristaps  296: /* ARGSUSED */
1.35      kristaps  297: int
                    298: blk_exp(MACRO_PROT_ARGS)
                    299: {
1.59      kristaps  300:        int              la;
1.35      kristaps  301:        char            *p;
                    302:
                    303:        /*
                    304:         * Close out prior scopes.  "Regular" explicit macros cannot be
                    305:         * nested, but we allow roff macros to be placed just about
                    306:         * anywhere.
                    307:         */
                    308:
                    309:        if ( ! man_block_alloc(m, line, ppos, tok))
                    310:                return(0);
                    311:        if ( ! man_head_alloc(m, line, ppos, tok))
                    312:                return(0);
                    313:
                    314:        for (;;) {
                    315:                la = *pos;
1.60      kristaps  316:                if ( ! man_args(m, line, pos, buf, &p))
1.35      kristaps  317:                        break;
                    318:                if ( ! man_word_alloc(m, line, la, p))
                    319:                        return(0);
                    320:        }
                    321:
                    322:        assert(m);
                    323:        assert(tok != MAN_MAX);
                    324:
                    325:        if ( ! rew_scope(MAN_HEAD, m, tok))
                    326:                return(0);
                    327:        return(man_body_alloc(m, line, ppos, tok));
                    328: }
                    329:
                    330:
                    331:
1.19      kristaps  332: /*
                    333:  * Parse an implicit-block macro.  These contain a MAN_HEAD and a
                    334:  * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other
                    335:  * scopes, such as `SH' closing out an `SS', are defined in the rew
                    336:  * routines.
                    337:  */
1.48      kristaps  338: /* ARGSUSED */
1.19      kristaps  339: int
                    340: blk_imp(MACRO_PROT_ARGS)
                    341: {
1.59      kristaps  342:        int              la;
1.19      kristaps  343:        char            *p;
1.25      kristaps  344:        struct man_node *n;
1.19      kristaps  345:
                    346:        /* Close out prior scopes. */
1.7       kristaps  347:
1.19      kristaps  348:        if ( ! rew_scope(MAN_BODY, m, tok))
1.5       kristaps  349:                return(0);
1.19      kristaps  350:        if ( ! rew_scope(MAN_BLOCK, m, tok))
1.6       kristaps  351:                return(0);
1.1       kristaps  352:
1.19      kristaps  353:        /* Allocate new block & head scope. */
                    354:
                    355:        if ( ! man_block_alloc(m, line, ppos, tok))
                    356:                return(0);
                    357:        if ( ! man_head_alloc(m, line, ppos, tok))
                    358:                return(0);
1.1       kristaps  359:
1.25      kristaps  360:        n = m->last;
                    361:
1.19      kristaps  362:        /* Add line arguments. */
1.3       kristaps  363:
1.19      kristaps  364:        for (;;) {
                    365:                la = *pos;
1.60      kristaps  366:                if ( ! man_args(m, line, pos, buf, &p))
1.19      kristaps  367:                        break;
                    368:                if ( ! man_word_alloc(m, line, la, p))
1.6       kristaps  369:                        return(0);
                    370:        }
                    371:
1.19      kristaps  372:        /* Close out head and open body (unless MAN_SCOPE). */
                    373:
1.27      kristaps  374:        if (MAN_SCOPED & man_macros[tok].flags) {
                    375:                /* If we're forcing scope (`TP'), keep it open. */
                    376:                if (MAN_FSCOPED & man_macros[tok].flags) {
                    377:                        m->flags |= MAN_BLINE;
                    378:                        return(1);
                    379:                } else if (n == m->last) {
                    380:                        m->flags |= MAN_BLINE;
                    381:                        return(1);
                    382:                }
                    383:        }
                    384:
                    385:        if ( ! rew_scope(MAN_HEAD, m, tok))
1.6       kristaps  386:                return(0);
1.19      kristaps  387:        return(man_body_alloc(m, line, ppos, tok));
1.4       kristaps  388: }
                    389:
                    390:
1.48      kristaps  391: /* ARGSUSED */
1.19      kristaps  392: int
                    393: in_line_eoln(MACRO_PROT_ARGS)
1.3       kristaps  394: {
1.59      kristaps  395:        int              la;
1.19      kristaps  396:        char            *p;
                    397:        struct man_node *n;
1.3       kristaps  398:
1.19      kristaps  399:        if ( ! man_elem_alloc(m, line, ppos, tok))
1.3       kristaps  400:                return(0);
                    401:
1.19      kristaps  402:        n = m->last;
1.3       kristaps  403:
1.19      kristaps  404:        for (;;) {
                    405:                la = *pos;
1.60      kristaps  406:                if ( ! man_args(m, line, pos, buf, &p))
1.19      kristaps  407:                        break;
                    408:                if ( ! man_word_alloc(m, line, la, p))
                    409:                        return(0);
                    410:        }
1.3       kristaps  411:
1.31      kristaps  412:        /*
                    413:         * If no arguments are specified and this is MAN_SCOPED (i.e.,
                    414:         * next-line scoped), then set our mode to indicate that we're
                    415:         * waiting for terms to load into our context.
                    416:         */
                    417:
1.25      kristaps  418:        if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
1.31      kristaps  419:                assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.19      kristaps  420:                m->flags |= MAN_ELINE;
                    421:                return(1);
                    422:        }
1.3       kristaps  423:
1.31      kristaps  424:        /* Set ignorable context, if applicable. */
                    425:
                    426:        if (MAN_NSCOPED & man_macros[tok].flags) {
                    427:                assert( ! (MAN_SCOPED & man_macros[tok].flags));
                    428:                m->flags |= MAN_ILINE;
                    429:        }
1.64      kristaps  430:
                    431:        assert(MAN_ROOT != m->last->type);
                    432:        m->next = MAN_NEXT_SIBLING;
1.31      kristaps  433:
1.19      kristaps  434:        /*
1.31      kristaps  435:         * Rewind our element scope.  Note that when TH is pruned, we'll
                    436:         * be back at the root, so make sure that we don't clobber as
                    437:         * its sibling.
1.19      kristaps  438:         */
1.3       kristaps  439:
1.19      kristaps  440:        for ( ; m->last; m->last = m->last->parent) {
                    441:                if (m->last == n)
                    442:                        break;
                    443:                if (m->last->type == MAN_ROOT)
                    444:                        break;
                    445:                if ( ! man_valid_post(m))
                    446:                        return(0);
                    447:        }
1.3       kristaps  448:
1.19      kristaps  449:        assert(m->last);
1.3       kristaps  450:
                    451:        /*
1.19      kristaps  452:         * Same here regarding whether we're back at the root.
1.3       kristaps  453:         */
                    454:
1.19      kristaps  455:        if (m->last->type != MAN_ROOT && ! man_valid_post(m))
                    456:                return(0);
1.3       kristaps  457:
1.19      kristaps  458:        return(1);
                    459: }
1.3       kristaps  460:
                    461:
1.19      kristaps  462: int
                    463: man_macroend(struct man *m)
                    464: {
1.22      kristaps  465:
1.46      kristaps  466:        return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
1.19      kristaps  467: }
1.3       kristaps  468:
1.60      kristaps  469: static int
                    470: man_args(struct man *m, int line, int *pos, char *buf, char **v)
                    471: {
                    472:        char     *start;
                    473:
                    474:        assert(*pos);
                    475:        *v = start = buf + *pos;
                    476:        assert(' ' != *start);
                    477:
                    478:        if ('\0' == *start)
                    479:                return(0);
                    480:
1.62      kristaps  481:        *v = mandoc_getarg(m->parse, v, line, pos);
1.60      kristaps  482:        return(1);
                    483: }

CVSweb