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

Annotation of mandoc/mdoc_action.c, Revision 1.53

1.53    ! kristaps    1: /*     $Id: mdoc_action.c,v 1.52 2010/04/05 09:03:12 kristaps Exp $ */
1.1       kristaps    2: /*
1.9       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.8       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.8       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.50      kristaps   17: #ifdef HAVE_CONFIG_H
                     18: #include "config.h"
                     19: #endif
                     20:
1.44      kristaps   21: #ifndef        OSNAME
1.1       kristaps   22: #include <sys/utsname.h>
1.44      kristaps   23: #endif
1.1       kristaps   24:
                     25: #include <assert.h>
                     26: #include <stdio.h>
                     27: #include <stdlib.h>
                     28: #include <string.h>
1.44      kristaps   29: #include <time.h>
1.1       kristaps   30:
                     31: #include "libmdoc.h"
1.46      kristaps   32: #include "libmandoc.h"
1.1       kristaps   33:
1.35      kristaps   34: #define        POST_ARGS struct mdoc *m, struct mdoc_node *n
1.1       kristaps   35: #define        PRE_ARGS  struct mdoc *m, const struct mdoc_node *n
                     36:
1.46      kristaps   37: #define        NUMSIZ    32
                     38: #define        DATESIZ   32
                     39:
1.1       kristaps   40: struct actions {
                     41:        int     (*pre)(PRE_ARGS);
                     42:        int     (*post)(POST_ARGS);
                     43: };
                     44:
1.46      kristaps   45: static int       concat(struct mdoc *, char *,
                     46:                        const struct mdoc_node *, size_t);
1.39      kristaps   47: static inline int order_rs(int);
                     48:
1.1       kristaps   49: static int       post_ar(POST_ARGS);
1.25      kristaps   50: static int       post_at(POST_ARGS);
1.1       kristaps   51: static int       post_bl(POST_ARGS);
1.14      kristaps   52: static int       post_bl_head(POST_ARGS);
1.25      kristaps   53: static int       post_bl_tagwidth(POST_ARGS);
1.1       kristaps   54: static int       post_bl_width(POST_ARGS);
                     55: static int       post_dd(POST_ARGS);
                     56: static int       post_display(POST_ARGS);
                     57: static int       post_dt(POST_ARGS);
1.27      kristaps   58: static int       post_lb(POST_ARGS);
1.1       kristaps   59: static int       post_nm(POST_ARGS);
                     60: static int       post_os(POST_ARGS);
1.46      kristaps   61: static int       post_pa(POST_ARGS);
1.1       kristaps   62: static int       post_prol(POST_ARGS);
1.39      kristaps   63: static int       post_rs(POST_ARGS);
1.1       kristaps   64: static int       post_sh(POST_ARGS);
1.26      kristaps   65: static int       post_st(POST_ARGS);
1.1       kristaps   66: static int       post_std(POST_ARGS);
                     67:
                     68: static int       pre_bd(PRE_ARGS);
1.38      kristaps   69: static int       pre_bl(PRE_ARGS);
1.1       kristaps   70: static int       pre_dl(PRE_ARGS);
1.38      kristaps   71: static int       pre_offset(PRE_ARGS);
1.1       kristaps   72:
1.37      kristaps   73: static const struct actions mdoc_actions[MDOC_MAX] = {
1.12      kristaps   74:        { NULL, NULL }, /* Ap */
1.1       kristaps   75:        { NULL, post_dd }, /* Dd */
                     76:        { NULL, post_dt }, /* Dt */
                     77:        { NULL, post_os }, /* Os */
                     78:        { NULL, post_sh }, /* Sh */
                     79:        { NULL, NULL }, /* Ss */
                     80:        { NULL, NULL }, /* Pp */
                     81:        { NULL, NULL }, /* D1 */
                     82:        { pre_dl, post_display }, /* Dl */
                     83:        { pre_bd, post_display }, /* Bd */
                     84:        { NULL, NULL }, /* Ed */
1.38      kristaps   85:        { pre_bl, post_bl }, /* Bl */
1.1       kristaps   86:        { NULL, NULL }, /* El */
                     87:        { NULL, NULL }, /* It */
                     88:        { NULL, NULL }, /* Ad */
                     89:        { NULL, NULL }, /* An */
                     90:        { NULL, post_ar }, /* Ar */
1.35      kristaps   91:        { NULL, NULL }, /* Cd */
1.1       kristaps   92:        { NULL, NULL }, /* Cm */
                     93:        { NULL, NULL }, /* Dv */
                     94:        { NULL, NULL }, /* Er */
                     95:        { NULL, NULL }, /* Ev */
                     96:        { NULL, post_std }, /* Ex */
                     97:        { NULL, NULL }, /* Fa */
                     98:        { NULL, NULL }, /* Fd */
                     99:        { NULL, NULL }, /* Fl */
                    100:        { NULL, NULL }, /* Fn */
                    101:        { NULL, NULL }, /* Ft */
                    102:        { NULL, NULL }, /* Ic */
                    103:        { NULL, NULL }, /* In */
                    104:        { NULL, NULL }, /* Li */
                    105:        { NULL, NULL }, /* Nd */
                    106:        { NULL, post_nm }, /* Nm */
                    107:        { NULL, NULL }, /* Op */
                    108:        { NULL, NULL }, /* Ot */
1.46      kristaps  109:        { NULL, post_pa }, /* Pa */
1.1       kristaps  110:        { NULL, post_std }, /* Rv */
1.26      kristaps  111:        { NULL, post_st }, /* St */
1.1       kristaps  112:        { NULL, NULL }, /* Va */
                    113:        { NULL, NULL }, /* Vt */
                    114:        { NULL, NULL }, /* Xr */
                    115:        { NULL, NULL }, /* %A */
                    116:        { NULL, NULL }, /* %B */
                    117:        { NULL, NULL }, /* %D */
                    118:        { NULL, NULL }, /* %I */
                    119:        { NULL, NULL }, /* %J */
                    120:        { NULL, NULL }, /* %N */
                    121:        { NULL, NULL }, /* %O */
                    122:        { NULL, NULL }, /* %P */
                    123:        { NULL, NULL }, /* %R */
                    124:        { NULL, NULL }, /* %T */
                    125:        { NULL, NULL }, /* %V */
                    126:        { NULL, NULL }, /* Ac */
                    127:        { NULL, NULL }, /* Ao */
                    128:        { NULL, NULL }, /* Aq */
1.25      kristaps  129:        { NULL, post_at }, /* At */
1.1       kristaps  130:        { NULL, NULL }, /* Bc */
                    131:        { NULL, NULL }, /* Bf */
                    132:        { NULL, NULL }, /* Bo */
                    133:        { NULL, NULL }, /* Bq */
                    134:        { NULL, NULL }, /* Bsx */
                    135:        { NULL, NULL }, /* Bx */
                    136:        { NULL, NULL }, /* Db */
                    137:        { NULL, NULL }, /* Dc */
                    138:        { NULL, NULL }, /* Do */
                    139:        { NULL, NULL }, /* Dq */
                    140:        { NULL, NULL }, /* Ec */
                    141:        { NULL, NULL }, /* Ef */
                    142:        { NULL, NULL }, /* Em */
                    143:        { NULL, NULL }, /* Eo */
                    144:        { NULL, NULL }, /* Fx */
                    145:        { NULL, NULL }, /* Ms */
                    146:        { NULL, NULL }, /* No */
                    147:        { NULL, NULL }, /* Ns */
                    148:        { NULL, NULL }, /* Nx */
                    149:        { NULL, NULL }, /* Ox */
                    150:        { NULL, NULL }, /* Pc */
                    151:        { NULL, NULL }, /* Pf */
                    152:        { NULL, NULL }, /* Po */
                    153:        { NULL, NULL }, /* Pq */
                    154:        { NULL, NULL }, /* Qc */
                    155:        { NULL, NULL }, /* Ql */
                    156:        { NULL, NULL }, /* Qo */
                    157:        { NULL, NULL }, /* Qq */
                    158:        { NULL, NULL }, /* Re */
1.39      kristaps  159:        { NULL, post_rs }, /* Rs */
1.1       kristaps  160:        { NULL, NULL }, /* Sc */
                    161:        { NULL, NULL }, /* So */
                    162:        { NULL, NULL }, /* Sq */
                    163:        { NULL, NULL }, /* Sm */
                    164:        { NULL, NULL }, /* Sx */
                    165:        { NULL, NULL }, /* Sy */
                    166:        { NULL, NULL }, /* Tn */
                    167:        { NULL, NULL }, /* Ux */
                    168:        { NULL, NULL }, /* Xc */
                    169:        { NULL, NULL }, /* Xo */
                    170:        { NULL, NULL }, /* Fo */
                    171:        { NULL, NULL }, /* Fc */
                    172:        { NULL, NULL }, /* Oo */
                    173:        { NULL, NULL }, /* Oc */
                    174:        { NULL, NULL }, /* Bk */
                    175:        { NULL, NULL }, /* Ek */
                    176:        { NULL, NULL }, /* Bt */
                    177:        { NULL, NULL }, /* Hf */
                    178:        { NULL, NULL }, /* Fr */
                    179:        { NULL, NULL }, /* Ud */
1.27      kristaps  180:        { NULL, post_lb }, /* Lb */
1.1       kristaps  181:        { NULL, NULL }, /* Lp */
1.44      kristaps  182:        { NULL, NULL }, /* Lk */
1.1       kristaps  183:        { NULL, NULL }, /* Mt */
                    184:        { NULL, NULL }, /* Brq */
                    185:        { NULL, NULL }, /* Bro */
                    186:        { NULL, NULL }, /* Brc */
                    187:        { NULL, NULL }, /* %C */
                    188:        { NULL, NULL }, /* Es */
                    189:        { NULL, NULL }, /* En */
                    190:        { NULL, NULL }, /* Dx */
                    191:        { NULL, NULL }, /* %Q */
1.30      kristaps  192:        { NULL, NULL }, /* br */
                    193:        { NULL, NULL }, /* sp */
1.43      kristaps  194:        { NULL, NULL }, /* %U */
1.1       kristaps  195: };
                    196:
1.45      kristaps  197: #define        RSORD_MAX 14
1.1       kristaps  198:
1.39      kristaps  199: static const int rsord[RSORD_MAX] = {
                    200:        MDOC__A,
                    201:        MDOC__T,
                    202:        MDOC__B,
                    203:        MDOC__I,
                    204:        MDOC__J,
                    205:        MDOC__R,
                    206:        MDOC__N,
                    207:        MDOC__V,
                    208:        MDOC__P,
                    209:        MDOC__Q,
                    210:        MDOC__D,
                    211:        MDOC__O,
1.45      kristaps  212:        MDOC__C,
                    213:        MDOC__U
1.39      kristaps  214: };
1.2       kristaps  215:
                    216:
1.1       kristaps  217: int
                    218: mdoc_action_pre(struct mdoc *m, const struct mdoc_node *n)
                    219: {
                    220:
                    221:        switch (n->type) {
                    222:        case (MDOC_ROOT):
1.2       kristaps  223:                /* FALLTHROUGH */
1.1       kristaps  224:        case (MDOC_TEXT):
1.2       kristaps  225:                return(1);
                    226:        default:
1.1       kristaps  227:                break;
                    228:        }
1.2       kristaps  229:
1.6       kristaps  230:        if (NULL == mdoc_actions[n->tok].pre)
1.2       kristaps  231:                return(1);
1.6       kristaps  232:        return((*mdoc_actions[n->tok].pre)(m, n));
1.1       kristaps  233: }
                    234:
                    235:
                    236: int
                    237: mdoc_action_post(struct mdoc *m)
                    238: {
                    239:
                    240:        if (MDOC_ACTED & m->last->flags)
                    241:                return(1);
                    242:        m->last->flags |= MDOC_ACTED;
                    243:
                    244:        switch (m->last->type) {
                    245:        case (MDOC_TEXT):
1.2       kristaps  246:                /* FALLTHROUGH */
1.1       kristaps  247:        case (MDOC_ROOT):
1.2       kristaps  248:                return(1);
                    249:        default:
1.1       kristaps  250:                break;
                    251:        }
1.2       kristaps  252:
                    253:        if (NULL == mdoc_actions[m->last->tok].post)
                    254:                return(1);
1.35      kristaps  255:        return((*mdoc_actions[m->last->tok].post)(m, m->last));
1.2       kristaps  256: }
                    257:
                    258:
1.46      kristaps  259: /*
                    260:  * Concatenate sibling nodes together.  All siblings must be of type
                    261:  * MDOC_TEXT or an assertion is raised.  Concatenation is separated by a
                    262:  * single whitespace.
                    263:  */
1.2       kristaps  264: static int
1.46      kristaps  265: concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz)
1.2       kristaps  266: {
                    267:
1.46      kristaps  268:        assert(sz);
                    269:        p[0] = '\0';
1.2       kristaps  270:        for ( ; n; n = n->next) {
                    271:                assert(MDOC_TEXT == n->type);
1.46      kristaps  272:                if (strlcat(p, n->string, sz) >= sz)
1.23      kristaps  273:                        return(mdoc_nerr(m, n, ETOOLONG));
1.2       kristaps  274:                if (NULL == n->next)
                    275:                        continue;
1.46      kristaps  276:                if (strlcat(p, " ", sz) >= sz)
1.23      kristaps  277:                        return(mdoc_nerr(m, n, ETOOLONG));
1.2       kristaps  278:        }
                    279:
1.1       kristaps  280:        return(1);
                    281: }
                    282:
                    283:
1.46      kristaps  284: /*
                    285:  * Macros accepting `-std' as an argument have the name of the current
                    286:  * document (`Nm') filled in as the argument if it's not provided.
                    287:  */
1.1       kristaps  288: static int
                    289: post_std(POST_ARGS)
                    290: {
1.35      kristaps  291:        struct mdoc_node        *nn;
1.1       kristaps  292:
1.35      kristaps  293:        if (n->child)
1.1       kristaps  294:                return(1);
1.35      kristaps  295:
                    296:        nn = n;
                    297:        m->next = MDOC_NEXT_CHILD;
1.1       kristaps  298:        assert(m->meta.name);
1.35      kristaps  299:        if ( ! mdoc_word_alloc(m, n->line, n->pos, m->meta.name))
                    300:                return(0);
                    301:        m->last = nn;
1.1       kristaps  302:        return(1);
                    303: }
                    304:
                    305:
1.46      kristaps  306: /*
                    307:  * The `Nm' macro's first use sets the name of the document.  See also
                    308:  * post_std(), etc.
                    309:  */
1.1       kristaps  310: static int
                    311: post_nm(POST_ARGS)
                    312: {
1.46      kristaps  313:        char             buf[BUFSIZ];
1.1       kristaps  314:
                    315:        if (m->meta.name)
                    316:                return(1);
1.46      kristaps  317:        if ( ! concat(m, buf, n->child, BUFSIZ))
1.2       kristaps  318:                return(0);
1.46      kristaps  319:        m->meta.name = mandoc_strdup(buf);
1.1       kristaps  320:        return(1);
                    321: }
                    322:
                    323:
1.46      kristaps  324: /*
                    325:  * Look up the value of `Lb' for matching predefined strings.  If it has
                    326:  * one, then substitute the current value for the formatted value.  Note
                    327:  * that the lookup may fail (we can provide arbitrary strings).
                    328:  */
                    329: /* ARGSUSED */
1.1       kristaps  330: static int
1.27      kristaps  331: post_lb(POST_ARGS)
                    332: {
                    333:        const char      *p;
                    334:        char            *buf;
                    335:        size_t           sz;
                    336:
1.35      kristaps  337:        assert(MDOC_TEXT == n->child->type);
                    338:        p = mdoc_a2lib(n->child->string);
1.46      kristaps  339:
                    340:        if (p) {
1.35      kristaps  341:                free(n->child->string);
1.46      kristaps  342:                n->child->string = mandoc_strdup(p);
1.27      kristaps  343:                return(1);
                    344:        }
                    345:
1.46      kristaps  346:        sz = strlen(n->child->string) +
                    347:                2 + strlen("\\(lqlibrary\\(rq");
                    348:        buf = mandoc_malloc(sz);
                    349:        snprintf(buf, sz, "library \\(lq%s\\(rq", n->child->string);
1.35      kristaps  350:        free(n->child->string);
1.46      kristaps  351:        n->child->string = buf;
1.27      kristaps  352:        return(1);
                    353: }
                    354:
                    355:
1.46      kristaps  356: /*
                    357:  * Substitute the value of `St' for the corresponding formatted string.
                    358:  * We're guaranteed that this exists (it's been verified during the
                    359:  * validation phase).
                    360:  */
                    361: /* ARGSUSED */
1.27      kristaps  362: static int
1.26      kristaps  363: post_st(POST_ARGS)
                    364: {
                    365:        const char      *p;
                    366:
1.35      kristaps  367:        assert(MDOC_TEXT == n->child->type);
                    368:        p = mdoc_a2st(n->child->string);
1.26      kristaps  369:        assert(p);
1.35      kristaps  370:        free(n->child->string);
1.46      kristaps  371:        n->child->string = mandoc_strdup(p);
1.26      kristaps  372:        return(1);
                    373: }
                    374:
                    375:
1.46      kristaps  376: /*
                    377:  * Look up the standard string in a table.  We know that it exists from
                    378:  * the validation phase, so assert on failure.  If a standard key wasn't
                    379:  * supplied, supply the default ``AT&T UNIX''.
                    380:  */
1.26      kristaps  381: static int
1.25      kristaps  382: post_at(POST_ARGS)
                    383: {
1.35      kristaps  384:        struct mdoc_node        *nn;
                    385:        const char              *p;
1.25      kristaps  386:
1.35      kristaps  387:        if (n->child) {
                    388:                assert(MDOC_TEXT == n->child->type);
                    389:                p = mdoc_a2att(n->child->string);
1.25      kristaps  390:                assert(p);
1.35      kristaps  391:                free(n->child->string);
1.46      kristaps  392:                n->child->string = mandoc_strdup(p);
1.25      kristaps  393:                return(1);
                    394:        }
                    395:
1.35      kristaps  396:        nn = n;
1.25      kristaps  397:        m->next = MDOC_NEXT_CHILD;
1.35      kristaps  398:        if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
1.25      kristaps  399:                return(0);
1.35      kristaps  400:        m->last = nn;
1.25      kristaps  401:        return(1);
                    402: }
                    403:
                    404:
1.46      kristaps  405: /*
                    406:  * Mark the current section.  The ``named'' section (lastnamed) is set
                    407:  * whenever the current section isn't a custom section--we use this to
                    408:  * keep track of section ordering.  Also check that the section is
                    409:  * allowed within the document's manual section.
                    410:  */
1.25      kristaps  411: static int
1.1       kristaps  412: post_sh(POST_ARGS)
                    413: {
                    414:        enum mdoc_sec    sec;
1.46      kristaps  415:        char             buf[BUFSIZ];
1.1       kristaps  416:
1.35      kristaps  417:        if (MDOC_HEAD != n->type)
1.1       kristaps  418:                return(1);
1.5       kristaps  419:
1.46      kristaps  420:        if ( ! concat(m, buf, n->child, BUFSIZ))
1.2       kristaps  421:                return(0);
1.46      kristaps  422:        sec = mdoc_atosec(buf);
1.52      kristaps  423:        /*
                    424:         * The first section should always make us move into a non-new
                    425:         * state.
                    426:         */
                    427:        if (SEC_NONE == m->lastnamed || SEC_CUSTOM != sec)
1.1       kristaps  428:                m->lastnamed = sec;
                    429:
1.46      kristaps  430:        /* Some sections only live in certain manual sections. */
                    431:
1.1       kristaps  432:        switch ((m->lastsec = sec)) {
                    433:        case (SEC_RETURN_VALUES):
                    434:                /* FALLTHROUGH */
                    435:        case (SEC_ERRORS):
                    436:                switch (m->meta.msec) {
                    437:                case (2):
                    438:                        /* FALLTHROUGH */
                    439:                case (3):
                    440:                        /* FALLTHROUGH */
                    441:                case (9):
                    442:                        break;
                    443:                default:
1.35      kristaps  444:                        return(mdoc_nwarn(m, n, EBADSEC));
1.1       kristaps  445:                }
                    446:                break;
                    447:        default:
                    448:                break;
                    449:        }
                    450:        return(1);
                    451: }
                    452:
                    453:
1.46      kristaps  454: /*
                    455:  * Parse out the contents of `Dt'.  See in-line documentation for how we
                    456:  * handle the various fields of this macro.
                    457:  */
1.1       kristaps  458: static int
                    459: post_dt(POST_ARGS)
                    460: {
1.35      kristaps  461:        struct mdoc_node *nn;
1.1       kristaps  462:        const char       *cp;
                    463:        char             *ep;
                    464:        long              lval;
                    465:
                    466:        if (m->meta.title)
                    467:                free(m->meta.title);
                    468:        if (m->meta.vol)
                    469:                free(m->meta.vol);
                    470:        if (m->meta.arch)
                    471:                free(m->meta.arch);
                    472:
                    473:        m->meta.title = m->meta.vol = m->meta.arch = NULL;
                    474:        m->meta.msec = 0;
                    475:
                    476:        /* Handles: `.Dt'
                    477:         *   --> title = unknown, volume = local, msec = 0, arch = NULL
                    478:         */
                    479:
1.35      kristaps  480:        if (NULL == (nn = n->child)) {
1.46      kristaps  481:                /* XXX: make these macro values. */
                    482:                m->meta.title = mandoc_strdup("unknown");
                    483:                m->meta.vol = mandoc_strdup("local");
1.35      kristaps  484:                return(post_prol(m, n));
1.1       kristaps  485:        }
                    486:
                    487:        /* Handles: `.Dt TITLE'
                    488:         *   --> title = TITLE, volume = local, msec = 0, arch = NULL
                    489:         */
                    490:
1.46      kristaps  491:        m->meta.title = mandoc_strdup(nn->string);
1.1       kristaps  492:
1.35      kristaps  493:        if (NULL == (nn = nn->next)) {
1.46      kristaps  494:                /* XXX: make this a macro value. */
                    495:                m->meta.vol = mandoc_strdup("local");
1.35      kristaps  496:                return(post_prol(m, n));
1.1       kristaps  497:        }
                    498:
                    499:        /* Handles: `.Dt TITLE SEC'
                    500:         *   --> title = TITLE, volume = SEC is msec ?
                    501:         *           format(msec) : SEC,
                    502:         *       msec = SEC is msec ? atoi(msec) : 0,
                    503:         *       arch = NULL
                    504:         */
                    505:
1.35      kristaps  506:        cp = mdoc_a2msec(nn->string);
1.1       kristaps  507:        if (cp) {
1.46      kristaps  508:                /* FIXME: where is strtonum!? */
                    509:                m->meta.vol = mandoc_strdup(cp);
1.35      kristaps  510:                lval = strtol(nn->string, &ep, 10);
                    511:                if (nn->string[0] != '\0' && *ep == '\0')
1.1       kristaps  512:                        m->meta.msec = (int)lval;
1.46      kristaps  513:        } else
                    514:                m->meta.vol = mandoc_strdup(nn->string);
1.1       kristaps  515:
1.35      kristaps  516:        if (NULL == (nn = nn->next))
                    517:                return(post_prol(m, n));
1.1       kristaps  518:
                    519:        /* Handles: `.Dt TITLE SEC VOL'
                    520:         *   --> title = TITLE, volume = VOL is vol ?
                    521:         *       format(VOL) :
                    522:         *           VOL is arch ? format(arch) :
                    523:         *               VOL
                    524:         */
                    525:
1.35      kristaps  526:        cp = mdoc_a2vol(nn->string);
1.1       kristaps  527:        if (cp) {
                    528:                free(m->meta.vol);
1.46      kristaps  529:                m->meta.vol = mandoc_strdup(cp);
1.1       kristaps  530:        } else {
1.35      kristaps  531:                cp = mdoc_a2arch(nn->string);
1.1       kristaps  532:                if (NULL == cp) {
                    533:                        free(m->meta.vol);
1.46      kristaps  534:                        m->meta.vol = mandoc_strdup(nn->string);
                    535:                } else
                    536:                        m->meta.arch = mandoc_strdup(cp);
1.1       kristaps  537:        }
                    538:
                    539:        /* Ignore any subsequent parameters... */
1.46      kristaps  540:        /* FIXME: warn about subsequent parameters. */
1.1       kristaps  541:
1.35      kristaps  542:        return(post_prol(m, n));
1.1       kristaps  543: }
                    544:
                    545:
1.46      kristaps  546: /*
                    547:  * Set the operating system by way of the `Os' macro.  Note that if an
                    548:  * argument isn't provided and -DOSNAME="\"foo\"" is provided during
                    549:  * compilation, this value will be used instead of filling in "sysname
                    550:  * release" from uname().
                    551:  */
1.1       kristaps  552: static int
                    553: post_os(POST_ARGS)
                    554: {
1.46      kristaps  555:        char              buf[BUFSIZ];
                    556: #ifndef OSNAME
1.1       kristaps  557:        struct utsname    utsname;
1.42      kristaps  558: #endif
                    559:
1.1       kristaps  560:        if (m->meta.os)
                    561:                free(m->meta.os);
1.4       kristaps  562:
1.46      kristaps  563:        if ( ! concat(m, buf, n->child, BUFSIZ))
1.2       kristaps  564:                return(0);
1.1       kristaps  565:
1.46      kristaps  566:        if ('\0' == buf[0]) {
                    567: #ifdef OSNAME
                    568:                if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ)
1.42      kristaps  569:                        return(mdoc_nerr(m, n, EUTSNAME));
1.46      kristaps  570: #else /*!OSNAME */
1.1       kristaps  571:                if (-1 == uname(&utsname))
1.35      kristaps  572:                        return(mdoc_nerr(m, n, EUTSNAME));
1.46      kristaps  573:                if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ)
1.35      kristaps  574:                        return(mdoc_nerr(m, n, ETOOLONG));
1.46      kristaps  575:                if (strlcat(buf, " ", 64) >= BUFSIZ)
1.35      kristaps  576:                        return(mdoc_nerr(m, n, ETOOLONG));
1.46      kristaps  577:                if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ)
1.35      kristaps  578:                        return(mdoc_nerr(m, n, ETOOLONG));
1.46      kristaps  579: #endif /*!OSNAME*/
1.1       kristaps  580:        }
                    581:
1.46      kristaps  582:        m->meta.os = mandoc_strdup(buf);
1.35      kristaps  583:        return(post_prol(m, n));
1.1       kristaps  584: }
                    585:
                    586:
                    587: /*
                    588:  * Calculate the -width for a `Bl -tag' list if it hasn't been provided.
1.46      kristaps  589:  * Uses the first head macro.  NOTE AGAIN: this is ONLY if the -width
                    590:  * argument has NOT been provided.  See post_bl_width() for converting
                    591:  * the -width string.
1.1       kristaps  592:  */
                    593: static int
1.35      kristaps  594: post_bl_tagwidth(POST_ARGS)
1.1       kristaps  595: {
1.46      kristaps  596:        struct mdoc_node *nn;
                    597:        size_t            sz;
                    598:        int               i;
                    599:        char              buf[NUMSIZ];
1.1       kristaps  600:
1.46      kristaps  601:        /* Defaults to ten ens. */
1.1       kristaps  602:
1.46      kristaps  603:        sz = 10; /* XXX: make this a macro value. */
1.35      kristaps  604:        nn = n->body->child;
1.46      kristaps  605:
1.35      kristaps  606:        if (nn) {
                    607:                assert(MDOC_BLOCK == nn->type);
                    608:                assert(MDOC_It == nn->tok);
                    609:                nn = nn->head->child;
                    610:                if (MDOC_TEXT != nn->type) {
1.46      kristaps  611:                        sz = mdoc_macro2len(nn->tok);
                    612:                        if (sz == 0) {
1.35      kristaps  613:                                if ( ! mdoc_nwarn(m, n, ENOWIDTH))
1.1       kristaps  614:                                        return(0);
1.46      kristaps  615:                                sz = 10;
                    616:                        }
1.1       kristaps  617:                } else
1.46      kristaps  618:                        sz = strlen(nn->string) + 1;
1.1       kristaps  619:        }
                    620:
1.46      kristaps  621:        snprintf(buf, NUMSIZ, "%zun", sz);
1.1       kristaps  622:
                    623:        /*
                    624:         * We have to dynamically add this to the macro's argument list.
                    625:         * We're guaranteed that a MDOC_Width doesn't already exist.
                    626:         */
                    627:
1.35      kristaps  628:        nn = n;
                    629:        assert(nn->args);
1.46      kristaps  630:        i = (int)(nn->args->argc)++;
1.1       kristaps  631:
1.46      kristaps  632:        nn->args->argv = mandoc_realloc(nn->args->argv,
1.35      kristaps  633:                        nn->args->argc * sizeof(struct mdoc_argv));
1.1       kristaps  634:
1.46      kristaps  635:        nn->args->argv[i].arg = MDOC_Width;
                    636:        nn->args->argv[i].line = n->line;
                    637:        nn->args->argv[i].pos = n->pos;
                    638:        nn->args->argv[i].sz = 1;
                    639:        nn->args->argv[i].value = mandoc_malloc(sizeof(char *));
                    640:        nn->args->argv[i].value[0] = mandoc_strdup(buf);
1.1       kristaps  641:        return(1);
                    642: }
                    643:
                    644:
1.46      kristaps  645: /*
                    646:  * Calculate the real width of a list from the -width string, which may
                    647:  * contain a macro (with a known default width), a literal string, or a
                    648:  * scaling width.
                    649:  */
1.1       kristaps  650: static int
1.35      kristaps  651: post_bl_width(POST_ARGS)
1.1       kristaps  652: {
                    653:        size_t            width;
1.51      kristaps  654:        int               i;
                    655:        enum mdoct        tok;
1.46      kristaps  656:        char              buf[NUMSIZ];
1.1       kristaps  657:        char             *p;
                    658:
1.35      kristaps  659:        if (NULL == n->args)
1.1       kristaps  660:                return(1);
                    661:
1.35      kristaps  662:        for (i = 0; i < (int)n->args->argc; i++)
                    663:                if (MDOC_Width == n->args->argv[i].arg)
1.1       kristaps  664:                        break;
                    665:
1.35      kristaps  666:        if (i == (int)n->args->argc)
1.1       kristaps  667:                return(1);
1.35      kristaps  668:        p = n->args->argv[i].value[0];
1.1       kristaps  669:
                    670:        /*
                    671:         * If the value to -width is a macro, then we re-write it to be
                    672:         * the macro's width as set in share/tmac/mdoc/doc-common.
                    673:         */
                    674:
1.2       kristaps  675:        if (0 == strcmp(p, "Ds"))
1.46      kristaps  676:                /* XXX: make into a macro. */
1.18      kristaps  677:                width = 6;
1.36      kristaps  678:        else if (MDOC_MAX == (tok = mdoc_hash_find(p)))
1.1       kristaps  679:                return(1);
                    680:        else if (0 == (width = mdoc_macro2len(tok)))
1.35      kristaps  681:                return(mdoc_nwarn(m, n, ENOWIDTH));
1.1       kristaps  682:
                    683:        /* The value already exists: free and reallocate it. */
                    684:
1.46      kristaps  685:        snprintf(buf, NUMSIZ, "%zun", width);
1.35      kristaps  686:        free(n->args->argv[i].value[0]);
1.46      kristaps  687:        n->args->argv[i].value[0] = mandoc_strdup(buf);
1.1       kristaps  688:        return(1);
                    689: }
                    690:
                    691:
1.46      kristaps  692: /*
                    693:  * Do processing for -column lists, which can have two distinct styles
                    694:  * of invocation.  Merge this two styles into a consistent form.
                    695:  */
1.35      kristaps  696: /* ARGSUSED */
1.1       kristaps  697: static int
1.14      kristaps  698: post_bl_head(POST_ARGS)
                    699: {
                    700:        int                      i, c;
1.35      kristaps  701:        struct mdoc_node        *np, *nn, *nnp;
1.14      kristaps  702:
1.35      kristaps  703:        if (NULL == n->child)
1.14      kristaps  704:                return(1);
                    705:
1.35      kristaps  706:        np = n->parent;
                    707:        assert(np->args);
1.14      kristaps  708:
1.35      kristaps  709:        for (c = 0; c < (int)np->args->argc; c++)
                    710:                if (MDOC_Column == np->args->argv[c].arg)
1.14      kristaps  711:                        break;
                    712:
1.35      kristaps  713:        if (c == (int)np->args->argc)
1.14      kristaps  714:                return(1);
1.35      kristaps  715:        assert(0 == np->args->argv[c].sz);
1.14      kristaps  716:
                    717:        /*
                    718:         * Accomodate for new-style groff column syntax.  Shuffle the
                    719:         * child nodes, all of which must be TEXT, as arguments for the
                    720:         * column field.  Then, delete the head children.
                    721:         */
                    722:
1.35      kristaps  723:        np->args->argv[c].sz = (size_t)n->nchild;
1.46      kristaps  724:        np->args->argv[c].value = mandoc_malloc
1.35      kristaps  725:                ((size_t)n->nchild * sizeof(char *));
1.14      kristaps  726:
1.35      kristaps  727:        for (i = 0, nn = n->child; nn; i++) {
                    728:                np->args->argv[c].value[i] = nn->string;
1.14      kristaps  729:                nn->string = NULL;
                    730:                nnp = nn;
                    731:                nn = nn->next;
1.53    ! kristaps  732:                mdoc_node_delete(NULL, nnp);
1.14      kristaps  733:        }
                    734:
1.35      kristaps  735:        n->nchild = 0;
                    736:        n->child = NULL;
1.14      kristaps  737:        return(1);
                    738: }
                    739:
                    740:
                    741: static int
1.1       kristaps  742: post_bl(POST_ARGS)
                    743: {
                    744:        int               i, r, len;
                    745:
1.35      kristaps  746:        if (MDOC_HEAD == n->type)
                    747:                return(post_bl_head(m, n));
                    748:        if (MDOC_BLOCK != n->type)
1.1       kristaps  749:                return(1);
                    750:
                    751:        /*
                    752:         * These are fairly complicated, so we've broken them into two
                    753:         * functions.  post_bl_tagwidth() is called when a -tag is
                    754:         * specified, but no -width (it must be guessed).  The second
                    755:         * when a -width is specified (macro indicators must be
                    756:         * rewritten into real lengths).
                    757:         */
                    758:
1.35      kristaps  759:        len = (int)(n->args ? n->args->argc : 0);
1.1       kristaps  760:
                    761:        for (r = i = 0; i < len; i++) {
1.35      kristaps  762:                if (MDOC_Tag == n->args->argv[i].arg)
1.1       kristaps  763:                        r |= 1 << 0;
1.35      kristaps  764:                if (MDOC_Width == n->args->argv[i].arg)
1.1       kristaps  765:                        r |= 1 << 1;
                    766:        }
                    767:
                    768:        if (r & (1 << 0) && ! (r & (1 << 1))) {
1.35      kristaps  769:                if ( ! post_bl_tagwidth(m, n))
1.1       kristaps  770:                        return(0);
                    771:        } else if (r & (1 << 1))
1.35      kristaps  772:                if ( ! post_bl_width(m, n))
1.1       kristaps  773:                        return(0);
                    774:
                    775:        return(1);
                    776: }
                    777:
                    778:
1.46      kristaps  779: /*
                    780:  * The `Pa' macro defaults to a tilde if no value is provided as an
                    781:  * argument.
                    782:  */
1.1       kristaps  783: static int
1.46      kristaps  784: post_pa(POST_ARGS)
1.10      kristaps  785: {
1.35      kristaps  786:        struct mdoc_node *np;
1.10      kristaps  787:
1.35      kristaps  788:        if (n->child)
1.10      kristaps  789:                return(1);
                    790:
1.35      kristaps  791:        np = n;
1.10      kristaps  792:        m->next = MDOC_NEXT_CHILD;
1.46      kristaps  793:        /* XXX: make into macro value. */
1.35      kristaps  794:        if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
1.10      kristaps  795:                return(0);
1.35      kristaps  796:        m->last = np;
1.10      kristaps  797:        return(1);
                    798: }
                    799:
                    800:
1.46      kristaps  801: /*
                    802:  * The `Ar' macro defaults to two strings "file ..." if no value is
                    803:  * provided as an argument.
                    804:  */
1.10      kristaps  805: static int
1.1       kristaps  806: post_ar(POST_ARGS)
                    807: {
1.35      kristaps  808:        struct mdoc_node *np;
1.1       kristaps  809:
1.35      kristaps  810:        if (n->child)
1.1       kristaps  811:                return(1);
                    812:
1.35      kristaps  813:        np = n;
1.1       kristaps  814:        m->next = MDOC_NEXT_CHILD;
1.46      kristaps  815:        /* XXX: make into macro values. */
1.35      kristaps  816:        if ( ! mdoc_word_alloc(m, n->line, n->pos, "file"))
1.1       kristaps  817:                return(0);
1.35      kristaps  818:        if ( ! mdoc_word_alloc(m, n->line, n->pos, "..."))
1.1       kristaps  819:                return(0);
1.35      kristaps  820:        m->last = np;
1.1       kristaps  821:        return(1);
                    822: }
                    823:
                    824:
1.46      kristaps  825: /*
1.49      kristaps  826:  * Parse the date field in `Dd'.
1.46      kristaps  827:  */
1.1       kristaps  828: static int
                    829: post_dd(POST_ARGS)
                    830: {
1.46      kristaps  831:        char            buf[DATESIZ];
1.1       kristaps  832:
1.46      kristaps  833:        if ( ! concat(m, buf, n->child, DATESIZ))
1.2       kristaps  834:                return(0);
1.1       kristaps  835:
1.49      kristaps  836:        m->meta.date = mandoc_a2time
                    837:                (MTIME_MDOCDATE | MTIME_CANONICAL, buf);
                    838:
1.46      kristaps  839:        if (0 == m->meta.date) {
1.35      kristaps  840:                if ( ! mdoc_nwarn(m, n, EBADDATE))
1.1       kristaps  841:                        return(0);
                    842:                m->meta.date = time(NULL);
                    843:        }
                    844:
1.35      kristaps  845:        return(post_prol(m, n));
1.1       kristaps  846: }
                    847:
                    848:
1.46      kristaps  849: /*
                    850:  * Remove prologue macros from the document after they're processed.
                    851:  * The final document uses mdoc_meta for these values and discards the
                    852:  * originals.
                    853:  */
1.1       kristaps  854: static int
                    855: post_prol(POST_ARGS)
                    856: {
1.34      kristaps  857:
1.53    ! kristaps  858:        mdoc_node_delete(m, n);
1.34      kristaps  859:        if (m->meta.title && m->meta.date && m->meta.os)
                    860:                m->flags |= MDOC_PBODY;
1.1       kristaps  861:        return(1);
                    862: }
                    863:
                    864:
1.46      kristaps  865: /*
                    866:  * Trigger a literal context.
                    867:  */
1.1       kristaps  868: static int
                    869: pre_dl(PRE_ARGS)
                    870: {
                    871:
1.16      kristaps  872:        if (MDOC_BODY == n->type)
                    873:                m->flags |= MDOC_LITERAL;
1.1       kristaps  874:        return(1);
                    875: }
                    876:
                    877:
1.47      kristaps  878: /* ARGSUSED */
1.1       kristaps  879: static int
1.38      kristaps  880: pre_offset(PRE_ARGS)
                    881: {
                    882:        int              i;
                    883:
                    884:        /*
                    885:         * Make sure that an empty offset produces an 8n length space as
                    886:         * stipulated by mdoc.samples.
                    887:         */
                    888:
                    889:        assert(n->args);
                    890:        for (i = 0; i < (int)n->args->argc; i++) {
                    891:                if (MDOC_Offset != n->args->argv[i].arg)
                    892:                        continue;
                    893:                if (n->args->argv[i].sz)
                    894:                        break;
                    895:                assert(1 == n->args->refcnt);
                    896:                /* If no value set, length of <string>. */
                    897:                n->args->argv[i].sz++;
1.46      kristaps  898:                n->args->argv[i].value = mandoc_malloc(sizeof(char *));
                    899:                n->args->argv[i].value[0] = mandoc_strdup("8n");
1.38      kristaps  900:                break;
                    901:        }
                    902:
                    903:        return(1);
                    904: }
                    905:
                    906:
                    907: static int
                    908: pre_bl(PRE_ARGS)
                    909: {
                    910:
                    911:        return(MDOC_BLOCK == n->type ? pre_offset(m, n) : 1);
                    912: }
                    913:
                    914:
                    915: static int
1.1       kristaps  916: pre_bd(PRE_ARGS)
                    917: {
                    918:        int              i;
                    919:
1.38      kristaps  920:        if (MDOC_BLOCK == n->type)
                    921:                return(pre_offset(m, n));
1.1       kristaps  922:        if (MDOC_BODY != n->type)
                    923:                return(1);
                    924:
1.32      kristaps  925:        /* Enter literal context if `Bd -literal' or `-unfilled'. */
                    926:
1.2       kristaps  927:        for (n = n->parent, i = 0; i < (int)n->args->argc; i++)
1.1       kristaps  928:                if (MDOC_Literal == n->args->argv[i].arg)
1.38      kristaps  929:                        m->flags |= MDOC_LITERAL;
1.1       kristaps  930:                else if (MDOC_Unfilled == n->args->argv[i].arg)
1.38      kristaps  931:                        m->flags |= MDOC_LITERAL;
1.1       kristaps  932:
                    933:        return(1);
                    934: }
                    935:
                    936:
                    937: static int
                    938: post_display(POST_ARGS)
                    939: {
                    940:
1.35      kristaps  941:        if (MDOC_BODY == n->type)
1.1       kristaps  942:                m->flags &= ~MDOC_LITERAL;
                    943:        return(1);
                    944: }
                    945:
                    946:
1.39      kristaps  947: static inline int
                    948: order_rs(int t)
                    949: {
                    950:        int             i;
                    951:
                    952:        for (i = 0; i < RSORD_MAX; i++)
                    953:                if (rsord[i] == t)
                    954:                        return(i);
                    955:
                    956:        abort();
                    957:        /* NOTREACHED */
                    958: }
                    959:
                    960:
1.41      kristaps  961: /* ARGSUSED */
1.39      kristaps  962: static int
                    963: post_rs(POST_ARGS)
                    964: {
                    965:        struct mdoc_node        *nn, *next, *prev;
                    966:        int                      o;
                    967:
                    968:        if (MDOC_BLOCK != n->type)
                    969:                return(1);
                    970:
1.40      kristaps  971:        assert(n->body->child);
1.39      kristaps  972:        for (next = NULL, nn = n->body->child->next; nn; nn = next) {
                    973:                o = order_rs(nn->tok);
                    974:
                    975:                /* Remove `nn' from the chain. */
                    976:                next = nn->next;
                    977:                if (next)
                    978:                        next->prev = nn->prev;
                    979:
                    980:                prev = nn->prev;
                    981:                if (prev)
                    982:                        prev->next = nn->next;
                    983:
                    984:                nn->prev = nn->next = NULL;
                    985:
                    986:                /*
                    987:                 * Scan back until we reach a node that's ordered before
                    988:                 * us, then set ourselves as being the next.
                    989:                 */
                    990:                for ( ; prev; prev = prev->prev)
                    991:                        if (order_rs(prev->tok) <= o)
                    992:                                break;
                    993:
                    994:                nn->prev = prev;
                    995:                if (prev) {
                    996:                        if (prev->next)
                    997:                                prev->next->prev = nn;
                    998:                        nn->next = prev->next;
                    999:                        prev->next = nn;
                   1000:                        continue;
                   1001:                }
                   1002:
                   1003:                n->body->child->prev = nn;
                   1004:                nn->next = n->body->child;
                   1005:                n->body->child = nn;
                   1006:        }
                   1007:        return(1);
                   1008: }

CVSweb