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

Annotation of mandoc/man_macro.c, Revision 1.35

1.35    ! kristaps    1: /*     $Id: man_macro.c,v 1.34 2010/03/24 03:46:02 kristaps Exp $ */
1.1       kristaps    2: /*
1.15      kristaps    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
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:
                     26: #include "libman.h"
                     27:
1.34      kristaps   28: enum   rew {
                     29:        REW_REWIND,
                     30:        REW_NOHALT,
                     31:        REW_HALT,
                     32: };
1.19      kristaps   33:
1.35    ! kristaps   34: static int              blk_close(MACRO_PROT_ARGS);
        !            35: static int              blk_dotted(MACRO_PROT_ARGS);
        !            36: static int              blk_exp(MACRO_PROT_ARGS);
        !            37: static int              blk_imp(MACRO_PROT_ARGS);
1.19      kristaps   38: static int              in_line_eoln(MACRO_PROT_ARGS);
                     39:
1.33      kristaps   40: static int              rew_scope(enum man_type,
                     41:                                struct man *, enum mant);
1.34      kristaps   42: static enum rew         rew_dohalt(enum mant, enum man_type,
1.19      kristaps   43:                                const struct man_node *);
1.34      kristaps   44: static enum rew         rew_block(enum mant, enum man_type,
1.21      kristaps   45:                                const struct man_node *);
1.19      kristaps   46:
                     47: const  struct man_macro __man_macros[MAN_MAX] = {
1.31      kristaps   48:        { in_line_eoln, MAN_NSCOPED }, /* br */
1.19      kristaps   49:        { in_line_eoln, 0 }, /* TH */
1.24      kristaps   50:        { blk_imp, MAN_SCOPED }, /* SH */
                     51:        { blk_imp, MAN_SCOPED }, /* SS */
1.27      kristaps   52:        { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
1.19      kristaps   53:        { blk_imp, 0 }, /* LP */
                     54:        { blk_imp, 0 }, /* PP */
                     55:        { blk_imp, 0 }, /* P */
                     56:        { blk_imp, 0 }, /* IP */
                     57:        { blk_imp, 0 }, /* HP */
                     58:        { in_line_eoln, MAN_SCOPED }, /* SM */
                     59:        { in_line_eoln, MAN_SCOPED }, /* SB */
                     60:        { in_line_eoln, 0 }, /* BI */
                     61:        { in_line_eoln, 0 }, /* IB */
                     62:        { in_line_eoln, 0 }, /* BR */
                     63:        { in_line_eoln, 0 }, /* RB */
                     64:        { in_line_eoln, MAN_SCOPED }, /* R */
                     65:        { in_line_eoln, MAN_SCOPED }, /* B */
                     66:        { in_line_eoln, MAN_SCOPED }, /* I */
                     67:        { in_line_eoln, 0 }, /* IR */
                     68:        { in_line_eoln, 0 }, /* RI */
1.31      kristaps   69:        { in_line_eoln, MAN_NSCOPED }, /* na */
1.19      kristaps   70:        { in_line_eoln, 0 }, /* i */
1.31      kristaps   71:        { in_line_eoln, MAN_NSCOPED }, /* sp */
1.19      kristaps   72:        { in_line_eoln, 0 }, /* nf */
                     73:        { in_line_eoln, 0 }, /* fi */
                     74:        { in_line_eoln, 0 }, /* r */
1.21      kristaps   75:        { blk_close, 0 }, /* RE */
1.35    ! kristaps   76:        { blk_exp, MAN_EXPLICIT }, /* RS */
1.23      kristaps   77:        { in_line_eoln, 0 }, /* DT */
1.28      kristaps   78:        { in_line_eoln, 0 }, /* UC */
1.29      kristaps   79:        { in_line_eoln, 0 }, /* PD */
1.32      kristaps   80:        { in_line_eoln, MAN_NSCOPED }, /* Sp */
                     81:        { in_line_eoln, 0 }, /* Vb */
                     82:        { in_line_eoln, 0 }, /* Ve */
1.35    ! kristaps   83:        { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */
        !            84:        { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */
        !            85:        { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */
        !            86:        { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */
        !            87:        { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */
        !            88:        { blk_dotted, 0 }, /* . */
1.19      kristaps   89: };
1.9       kristaps   90:
1.19      kristaps   91: const  struct man_macro * const man_macros = __man_macros;
1.1       kristaps   92:
                     93:
1.3       kristaps   94: int
1.19      kristaps   95: man_unscope(struct man *m, const struct man_node *n)
1.1       kristaps   96: {
                     97:
1.19      kristaps   98:        assert(n);
                     99:
                    100:        /* LINTED */
                    101:        while (m->last != n) {
                    102:                if ( ! man_valid_post(m))
                    103:                        return(0);
                    104:                if ( ! man_action_post(m))
                    105:                        return(0);
                    106:                m->last = m->last->parent;
                    107:                assert(m->last);
                    108:        }
                    109:
                    110:        if ( ! man_valid_post(m))
1.1       kristaps  111:                return(0);
1.35    ! kristaps  112:        if ( ! man_action_post(m))
        !           113:                return(0);
        !           114:
        !           115:        m->next = MAN_ROOT == m->last->type ?
        !           116:                MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
        !           117:
        !           118:        return(1);
1.19      kristaps  119: }
1.1       kristaps  120:
                    121:
1.34      kristaps  122: static enum rew
1.33      kristaps  123: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.21      kristaps  124: {
                    125:
                    126:        if (MAN_BLOCK == type && ntok == n->parent->tok &&
                    127:                        MAN_BODY == n->parent->type)
                    128:                return(REW_REWIND);
                    129:        return(ntok == n->tok ? REW_HALT : REW_NOHALT);
                    130: }
                    131:
                    132:
1.19      kristaps  133: /*
                    134:  * There are three scope levels: scoped to the root (all), scoped to the
                    135:  * section (all less sections), and scoped to subsections (all less
                    136:  * sections and subsections).
                    137:  */
1.34      kristaps  138: static enum rew
1.33      kristaps  139: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.19      kristaps  140: {
1.34      kristaps  141:        enum rew         c;
1.1       kristaps  142:
1.19      kristaps  143:        if (MAN_ROOT == n->type)
                    144:                return(REW_HALT);
                    145:        assert(n->parent);
                    146:        if (MAN_ROOT == n->parent->type)
                    147:                return(REW_REWIND);
                    148:        if (MAN_VALID & n->flags)
                    149:                return(REW_NOHALT);
                    150:
1.21      kristaps  151:        /* Rewind to ourselves, first. */
                    152:        if (type == n->type && tok == n->tok)
                    153:                return(REW_REWIND);
                    154:
1.19      kristaps  155:        switch (tok) {
                    156:        case (MAN_SH):
                    157:                break;
                    158:        case (MAN_SS):
1.20      kristaps  159:                /* Rewind to a section, if a block. */
1.21      kristaps  160:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    161:                        return(c);
                    162:                break;
                    163:        case (MAN_RS):
                    164:                /* Rewind to a subsection, if a block. */
                    165:                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                    166:                        return(c);
                    167:                /* Rewind to a section, if a block. */
                    168:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    169:                        return(c);
1.19      kristaps  170:                break;
                    171:        default:
1.21      kristaps  172:                /* Rewind to an offsetter, if a block. */
                    173:                if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
                    174:                        return(c);
1.20      kristaps  175:                /* Rewind to a subsection, if a block. */
1.21      kristaps  176:                if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
                    177:                        return(c);
1.20      kristaps  178:                /* Rewind to a section, if a block. */
1.21      kristaps  179:                if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
                    180:                        return(c);
1.19      kristaps  181:                break;
1.3       kristaps  182:        }
1.1       kristaps  183:
1.19      kristaps  184:        return(REW_NOHALT);
                    185: }
1.9       kristaps  186:
                    187:
1.19      kristaps  188: /*
                    189:  * Rewinding entails ascending the parse tree until a coherent point,
                    190:  * for example, the `SH' macro will close out any intervening `SS'
                    191:  * scopes.  When a scope is closed, it must be validated and actioned.
                    192:  */
                    193: static int
1.33      kristaps  194: rew_scope(enum man_type type, struct man *m, enum mant tok)
1.19      kristaps  195: {
                    196:        struct man_node *n;
1.34      kristaps  197:        enum rew         c;
1.7       kristaps  198:
1.19      kristaps  199:        /* LINTED */
                    200:        for (n = m->last; n; n = n->parent) {
                    201:                /*
                    202:                 * Whether we should stop immediately (REW_HALT), stop
                    203:                 * and rewind until this point (REW_REWIND), or keep
                    204:                 * rewinding (REW_NOHALT).
                    205:                 */
                    206:                c = rew_dohalt(tok, type, n);
                    207:                if (REW_HALT == c)
                    208:                        return(1);
                    209:                if (REW_REWIND == c)
1.7       kristaps  210:                        break;
1.6       kristaps  211:        }
1.1       kristaps  212:
1.19      kristaps  213:        /* Rewind until the current point. */
                    214:
                    215:        assert(n);
                    216:        return(man_unscope(m, n));
                    217: }
                    218:
1.6       kristaps  219:
1.21      kristaps  220: /* ARGSUSED */
                    221: int
1.35    ! kristaps  222: blk_dotted(MACRO_PROT_ARGS)
        !           223: {
        !           224:        enum mant        ntok;
        !           225:        struct man_node *nn;
        !           226:
        !           227:        for (nn = m->last->parent; nn; nn = nn->parent)
        !           228:                if (nn->tok == MAN_de || nn->tok == MAN_dei ||
        !           229:                                nn->tok == MAN_am ||
        !           230:                                nn->tok == MAN_ami ||
        !           231:                                nn->tok == MAN_ig) {
        !           232:                        ntok = nn->tok;
        !           233:                        break;
        !           234:                }
        !           235:
        !           236:        if (NULL == nn) {
        !           237:                if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
        !           238:                        return(0);
        !           239:                return(1);
        !           240:        }
        !           241:
        !           242:        if ( ! rew_scope(MAN_BODY, m, ntok))
        !           243:                return(0);
        !           244:        if ( ! rew_scope(MAN_BLOCK, m, ntok))
        !           245:                return(0);
        !           246:
        !           247:        return(1);
        !           248: }
        !           249:
        !           250:
        !           251: /* ARGSUSED */
        !           252: int
1.21      kristaps  253: blk_close(MACRO_PROT_ARGS)
                    254: {
1.33      kristaps  255:        enum mant                ntok;
1.21      kristaps  256:        const struct man_node   *nn;
                    257:
                    258:        switch (tok) {
                    259:        case (MAN_RE):
                    260:                ntok = MAN_RS;
                    261:                break;
                    262:        default:
                    263:                abort();
                    264:                /* NOTREACHED */
                    265:        }
                    266:
                    267:        for (nn = m->last->parent; nn; nn = nn->parent)
                    268:                if (ntok == nn->tok)
                    269:                        break;
                    270:
                    271:        if (NULL == nn)
                    272:                if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
                    273:                        return(0);
                    274:
                    275:        if ( ! rew_scope(MAN_BODY, m, ntok))
                    276:                return(0);
                    277:        if ( ! rew_scope(MAN_BLOCK, m, ntok))
                    278:                return(0);
1.35    ! kristaps  279:
1.21      kristaps  280:        return(1);
                    281: }
                    282:
                    283:
1.35    ! kristaps  284: int
        !           285: blk_exp(MACRO_PROT_ARGS)
        !           286: {
        !           287:        int              w, la;
        !           288:        char            *p;
        !           289:        struct man_node *n;
        !           290:
        !           291:        /*
        !           292:         * Close out prior scopes.  "Regular" explicit macros cannot be
        !           293:         * nested, but we allow roff macros to be placed just about
        !           294:         * anywhere.
        !           295:         */
        !           296:
        !           297:        if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) {
        !           298:                if ( ! rew_scope(MAN_BODY, m, tok))
        !           299:                        return(0);
        !           300:                if ( ! rew_scope(MAN_BLOCK, m, tok))
        !           301:                        return(0);
        !           302:        }
        !           303:
        !           304:        if ( ! man_block_alloc(m, line, ppos, tok))
        !           305:                return(0);
        !           306:        if ( ! man_head_alloc(m, line, ppos, tok))
        !           307:                return(0);
        !           308:
        !           309:        n = m->last;
        !           310:
        !           311:        for (;;) {
        !           312:                la = *pos;
        !           313:                w = man_args(m, line, pos, buf, &p);
        !           314:
        !           315:                if (-1 == w)
        !           316:                        return(0);
        !           317:                if (0 == w)
        !           318:                        break;
        !           319:
        !           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:  */
                    340: int
                    341: blk_imp(MACRO_PROT_ARGS)
                    342: {
                    343:        int              w, la;
                    344:        char            *p;
1.25      kristaps  345:        struct man_node *n;
1.19      kristaps  346:
                    347:        /* Close out prior scopes. */
1.7       kristaps  348:
1.19      kristaps  349:        if ( ! rew_scope(MAN_BODY, m, tok))
1.5       kristaps  350:                return(0);
1.19      kristaps  351:        if ( ! rew_scope(MAN_BLOCK, m, tok))
1.6       kristaps  352:                return(0);
1.1       kristaps  353:
1.19      kristaps  354:        /* Allocate new block & head scope. */
                    355:
                    356:        if ( ! man_block_alloc(m, line, ppos, tok))
                    357:                return(0);
                    358:        if ( ! man_head_alloc(m, line, ppos, tok))
                    359:                return(0);
1.1       kristaps  360:
1.25      kristaps  361:        n = m->last;
                    362:
1.19      kristaps  363:        /* Add line arguments. */
1.3       kristaps  364:
1.19      kristaps  365:        for (;;) {
                    366:                la = *pos;
                    367:                w = man_args(m, line, pos, buf, &p);
1.4       kristaps  368:
1.19      kristaps  369:                if (-1 == w)
1.6       kristaps  370:                        return(0);
1.19      kristaps  371:                if (0 == w)
                    372:                        break;
                    373:
                    374:                if ( ! man_word_alloc(m, line, la, p))
1.6       kristaps  375:                        return(0);
                    376:        }
                    377:
1.19      kristaps  378:        /* Close out head and open body (unless MAN_SCOPE). */
                    379:
1.27      kristaps  380:        if (MAN_SCOPED & man_macros[tok].flags) {
                    381:                /* If we're forcing scope (`TP'), keep it open. */
                    382:                if (MAN_FSCOPED & man_macros[tok].flags) {
                    383:                        m->flags |= MAN_BLINE;
                    384:                        return(1);
                    385:                } else if (n == m->last) {
                    386:                        m->flags |= MAN_BLINE;
                    387:                        return(1);
                    388:                }
                    389:        }
                    390:
                    391:        if ( ! rew_scope(MAN_HEAD, m, tok))
1.6       kristaps  392:                return(0);
1.19      kristaps  393:        return(man_body_alloc(m, line, ppos, tok));
1.4       kristaps  394: }
                    395:
                    396:
1.19      kristaps  397: int
                    398: in_line_eoln(MACRO_PROT_ARGS)
1.3       kristaps  399: {
1.19      kristaps  400:        int              w, la;
                    401:        char            *p;
                    402:        struct man_node *n;
1.3       kristaps  403:
1.19      kristaps  404:        if ( ! man_elem_alloc(m, line, ppos, tok))
1.3       kristaps  405:                return(0);
                    406:
1.19      kristaps  407:        n = m->last;
1.3       kristaps  408:
1.19      kristaps  409:        for (;;) {
                    410:                la = *pos;
                    411:                w = man_args(m, line, pos, buf, &p);
1.3       kristaps  412:
1.19      kristaps  413:                if (-1 == w)
                    414:                        return(0);
                    415:                if (0 == w)
                    416:                        break;
                    417:                if ( ! man_word_alloc(m, line, la, p))
                    418:                        return(0);
                    419:        }
1.3       kristaps  420:
1.31      kristaps  421:        /*
                    422:         * If no arguments are specified and this is MAN_SCOPED (i.e.,
                    423:         * next-line scoped), then set our mode to indicate that we're
                    424:         * waiting for terms to load into our context.
                    425:         */
                    426:
1.25      kristaps  427:        if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
1.31      kristaps  428:                assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.19      kristaps  429:                m->flags |= MAN_ELINE;
                    430:                return(1);
                    431:        }
1.3       kristaps  432:
1.31      kristaps  433:        /* Set ignorable context, if applicable. */
                    434:
                    435:        if (MAN_NSCOPED & man_macros[tok].flags) {
                    436:                assert( ! (MAN_SCOPED & man_macros[tok].flags));
                    437:                m->flags |= MAN_ILINE;
                    438:        }
                    439:
1.19      kristaps  440:        /*
1.31      kristaps  441:         * Rewind our element scope.  Note that when TH is pruned, we'll
                    442:         * be back at the root, so make sure that we don't clobber as
                    443:         * its sibling.
1.19      kristaps  444:         */
1.3       kristaps  445:
1.19      kristaps  446:        for ( ; m->last; m->last = m->last->parent) {
                    447:                if (m->last == n)
                    448:                        break;
                    449:                if (m->last->type == MAN_ROOT)
                    450:                        break;
                    451:                if ( ! man_valid_post(m))
                    452:                        return(0);
                    453:                if ( ! man_action_post(m))
                    454:                        return(0);
                    455:        }
1.3       kristaps  456:
1.19      kristaps  457:        assert(m->last);
1.3       kristaps  458:
                    459:        /*
1.19      kristaps  460:         * Same here regarding whether we're back at the root.
1.3       kristaps  461:         */
                    462:
1.19      kristaps  463:        if (m->last->type != MAN_ROOT && ! man_valid_post(m))
                    464:                return(0);
                    465:        if (m->last->type != MAN_ROOT && ! man_action_post(m))
                    466:                return(0);
1.35    ! kristaps  467:
        !           468:        m->next = MAN_ROOT == m->last->type ?
        !           469:                MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
1.3       kristaps  470:
1.19      kristaps  471:        return(1);
                    472: }
1.3       kristaps  473:
                    474:
1.19      kristaps  475: int
                    476: man_macroend(struct man *m)
                    477: {
1.22      kristaps  478:        struct man_node *n;
                    479:
                    480:        n = MAN_VALID & m->last->flags ?
                    481:                m->last->parent : m->last;
                    482:
                    483:        for ( ; n; n = n->parent) {
                    484:                if (MAN_BLOCK != n->type)
                    485:                        continue;
                    486:                if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
                    487:                        continue;
1.26      kristaps  488:                if ( ! man_nwarn(m, n, WEXITSCOPE))
                    489:                        return(0);
1.22      kristaps  490:        }
1.3       kristaps  491:
1.19      kristaps  492:        return(man_unscope(m, m->first));
                    493: }
1.3       kristaps  494:

CVSweb