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

Annotation of mandoc/mdoc.c, Revision 1.57

1.57    ! kristaps    1: /* $Id: mdoc.c,v 1.56 2009/03/08 20:50:12 kristaps Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
                      4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
                      6:  * purpose with or without fee is hereby granted, provided that the
                      7:  * above copyright notice and this permission notice appear in all
                      8:  * copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                     11:  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
                     12:  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                     13:  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                     14:  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                     15:  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                     16:  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                     17:  * PERFORMANCE OF THIS SOFTWARE.
                     18:  */
                     19: #include <assert.h>
                     20: #include <ctype.h>
                     21: #include <err.h>
                     22: #include <stdarg.h>
                     23: #include <stdlib.h>
                     24: #include <stdio.h>
                     25: #include <string.h>
                     26:
                     27: #include "private.h"
                     28:
1.41      kristaps   29: /*
                     30:  * Main caller in the libmdoc library.  This begins the parsing routine,
                     31:  * handles allocation of data, and so forth.  Most of the "work" is done
1.48      kristaps   32:  * in macro.c and validate.c.
1.41      kristaps   33:  */
                     34:
1.48      kristaps   35: static struct mdoc_node *mdoc_node_alloc(const struct mdoc *);
                     36: static int               mdoc_node_append(struct mdoc *,
                     37:                                struct mdoc_node *);
1.53      kristaps   38:
                     39: static int               parsetext(struct mdoc *, int, char *);
                     40: static int               parsemacro(struct mdoc *, int, char *);
1.48      kristaps   41:
                     42:
1.1       kristaps   43: const  char *const __mdoc_macronames[MDOC_MAX] = {
                     44:        "\\\"",         "Dd",           "Dt",           "Os",
                     45:        "Sh",           "Ss",           "Pp",           "D1",
                     46:        "Dl",           "Bd",           "Ed",           "Bl",
                     47:        "El",           "It",           "Ad",           "An",
                     48:        "Ar",           "Cd",           "Cm",           "Dv",
                     49:        "Er",           "Ev",           "Ex",           "Fa",
                     50:        "Fd",           "Fl",           "Fn",           "Ft",
                     51:        "Ic",           "In",           "Li",           "Nd",
                     52:        "Nm",           "Op",           "Ot",           "Pa",
                     53:        "Rv",           "St",           "Va",           "Vt",
                     54:        /* LINTED */
                     55:        "Xr",           "\%A",          "\%B",          "\%D",
                     56:        /* LINTED */
                     57:        "\%I",          "\%J",          "\%N",          "\%O",
                     58:        /* LINTED */
                     59:        "\%P",          "\%R",          "\%T",          "\%V",
                     60:        "Ac",           "Ao",           "Aq",           "At",
                     61:        "Bc",           "Bf",           "Bo",           "Bq",
                     62:        "Bsx",          "Bx",           "Db",           "Dc",
                     63:        "Do",           "Dq",           "Ec",           "Ef",
                     64:        "Em",           "Eo",           "Fx",           "Ms",
                     65:        "No",           "Ns",           "Nx",           "Ox",
                     66:        "Pc",           "Pf",           "Po",           "Pq",
                     67:        "Qc",           "Ql",           "Qo",           "Qq",
                     68:        "Re",           "Rs",           "Sc",           "So",
                     69:        "Sq",           "Sm",           "Sx",           "Sy",
                     70:        "Tn",           "Ux",           "Xc",           "Xo",
                     71:        "Fo",           "Fc",           "Oo",           "Oc",
                     72:        "Bk",           "Ek",           "Bt",           "Hf",
1.57    ! kristaps   73:        "Fr",           "Ud",           "Lb",           "Ap",
        !            74:        "Lp"
1.1       kristaps   75:        };
                     76:
                     77: const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {
                     78:        "split",                "nosplit",              "ragged",
                     79:        "unfilled",             "literal",              "file",
                     80:        "offset",               "bullet",               "dash",
                     81:        "hyphen",               "item",                 "enum",
                     82:        "tag",                  "diag",                 "hang",
                     83:        "ohang",                "inset",                "column",
                     84:        "width",                "compact",              "std",
1.52      kristaps   85:        "filled",               "words",                "emphasis",
                     86:        "symbolic"
1.1       kristaps   87:        };
                     88:
                     89: const  char * const *mdoc_macronames = __mdoc_macronames;
                     90: const  char * const *mdoc_argnames = __mdoc_argnames;
                     91:
1.45      kristaps   92:
1.1       kristaps   93: const struct mdoc_node *
1.47      kristaps   94: mdoc_node(const struct mdoc *mdoc)
1.1       kristaps   95: {
                     96:
                     97:        return(mdoc->first);
                     98: }
                     99:
                    100:
1.37      kristaps  101: const struct mdoc_meta *
1.47      kristaps  102: mdoc_meta(const struct mdoc *mdoc)
1.37      kristaps  103: {
                    104:
                    105:        return(&mdoc->meta);
                    106: }
                    107:
                    108:
1.1       kristaps  109: void
1.38      kristaps  110: mdoc_free(struct mdoc *mdoc)
1.34      kristaps  111: {
                    112:
1.38      kristaps  113:        if (mdoc->first)
                    114:                mdoc_node_freelist(mdoc->first);
                    115:        if (mdoc->htab)
                    116:                mdoc_tokhash_free(mdoc->htab);
1.34      kristaps  117:        if (mdoc->meta.title)
                    118:                free(mdoc->meta.title);
                    119:        if (mdoc->meta.os)
                    120:                free(mdoc->meta.os);
                    121:        if (mdoc->meta.name)
                    122:                free(mdoc->meta.name);
1.52      kristaps  123:        if (mdoc->meta.arch)
                    124:                free(mdoc->meta.arch);
                    125:        if (mdoc->meta.vol)
                    126:                free(mdoc->meta.vol);
1.34      kristaps  127:
1.1       kristaps  128:        free(mdoc);
                    129: }
                    130:
                    131:
                    132: struct mdoc *
1.55      kristaps  133: mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
1.1       kristaps  134: {
                    135:        struct mdoc     *p;
                    136:
                    137:        p = xcalloc(1, sizeof(struct mdoc));
                    138:
                    139:        p->data = data;
1.33      kristaps  140:        if (cb)
                    141:                (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
1.1       kristaps  142:
1.25      kristaps  143:        p->last = xcalloc(1, sizeof(struct mdoc_node));
                    144:        p->last->type = MDOC_ROOT;
                    145:        p->first = p->last;
1.55      kristaps  146:        p->pflags = pflags;
1.25      kristaps  147:        p->next = MDOC_NEXT_CHILD;
1.4       kristaps  148:        p->htab = mdoc_tokhash_alloc();
1.25      kristaps  149:
1.1       kristaps  150:        return(p);
                    151: }
                    152:
                    153:
                    154: int
1.20      kristaps  155: mdoc_endparse(struct mdoc *mdoc)
                    156: {
                    157:
                    158:        if (MDOC_HALT & mdoc->flags)
                    159:                return(0);
                    160:        if (NULL == mdoc->first)
                    161:                return(1);
                    162:
                    163:        assert(mdoc->last);
                    164:        if ( ! macro_end(mdoc)) {
                    165:                mdoc->flags |= MDOC_HALT;
                    166:                return(0);
                    167:        }
                    168:        return(1);
                    169: }
                    170:
                    171:
1.50      kristaps  172: /*
1.53      kristaps  173:  * Main parse routine.  Parses a single line -- really just hands off to
                    174:  * the macro or text parser.
1.50      kristaps  175:  */
1.20      kristaps  176: int
1.53      kristaps  177: mdoc_parseln(struct mdoc *m, int ln, char *buf)
1.1       kristaps  178: {
                    179:
1.53      kristaps  180:        /* If in error-mode, then we parse no more. */
1.50      kristaps  181:
1.53      kristaps  182:        if (MDOC_HALT & m->flags)
1.20      kristaps  183:                return(0);
1.50      kristaps  184:
1.53      kristaps  185:        return('.' == *buf ? parsemacro(m, ln, buf) :
                    186:                        parsetext(m, ln, buf));
1.1       kristaps  187: }
                    188:
                    189:
                    190: void
1.31      kristaps  191: mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
1.1       kristaps  192: {
1.31      kristaps  193:        char              buf[256];
1.23      kristaps  194:        va_list           ap;
1.1       kristaps  195:
                    196:        if (NULL == mdoc->cb.mdoc_msg)
                    197:                return;
                    198:
                    199:        va_start(ap, fmt);
1.31      kristaps  200:        (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
1.1       kristaps  201:        va_end(ap);
1.31      kristaps  202:        (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);
1.1       kristaps  203: }
                    204:
                    205:
                    206: int
1.31      kristaps  207: mdoc_verr(struct mdoc *mdoc, int ln, int pos,
                    208:                const char *fmt, ...)
1.1       kristaps  209: {
1.31      kristaps  210:        char             buf[256];
                    211:        va_list          ap;
1.1       kristaps  212:
                    213:        if (NULL == mdoc->cb.mdoc_err)
                    214:                return(0);
1.31      kristaps  215:
                    216:        va_start(ap, fmt);
                    217:        (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
                    218:        va_end(ap);
                    219:        return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
1.1       kristaps  220: }
                    221:
                    222:
                    223: int
1.31      kristaps  224: mdoc_vwarn(struct mdoc *mdoc, int ln, int pos,
                    225:                enum mdoc_warn type, const char *fmt, ...)
1.1       kristaps  226: {
1.31      kristaps  227:        char             buf[256];
                    228:        va_list          ap;
1.1       kristaps  229:
                    230:        if (NULL == mdoc->cb.mdoc_warn)
                    231:                return(0);
1.31      kristaps  232:
                    233:        va_start(ap, fmt);
                    234:        (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
                    235:        va_end(ap);
                    236:        return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf));
1.1       kristaps  237: }
                    238:
                    239:
                    240: int
1.53      kristaps  241: mdoc_macro(struct mdoc *m, int tok,
                    242:                int ln, int pp, int *pos, char *buf)
1.1       kristaps  243: {
                    244:
1.53      kristaps  245:        /* FIXME - these should happen during validation. */
1.31      kristaps  246:
1.44      kristaps  247:        if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.53      kristaps  248:                        SEC_PROLOGUE != m->lastnamed)
                    249:                return(mdoc_perr(m, ln, pp,
                    250:                                "disallowed in document body"));
                    251:
1.44      kristaps  252:        if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
1.53      kristaps  253:                        SEC_PROLOGUE == m->lastnamed)
                    254:                return(mdoc_perr(m, ln, pp,
                    255:                                "disallowed in prologue"));
                    256:
                    257:        if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
                    258:                return(mdoc_perr(m, ln, pp, "not callable"));
                    259:
                    260:        return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
1.1       kristaps  261: }
                    262:
                    263:
1.23      kristaps  264: static int
                    265: mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1       kristaps  266: {
                    267:
1.25      kristaps  268:        assert(mdoc->last);
                    269:        assert(mdoc->first);
                    270:        assert(MDOC_ROOT != p->type);
1.1       kristaps  271:
1.13      kristaps  272:        switch (mdoc->next) {
                    273:        case (MDOC_NEXT_SIBLING):
1.6       kristaps  274:                mdoc->last->next = p;
                    275:                p->prev = mdoc->last;
1.13      kristaps  276:                p->parent = mdoc->last->parent;
1.1       kristaps  277:                break;
1.13      kristaps  278:        case (MDOC_NEXT_CHILD):
                    279:                mdoc->last->child = p;
1.1       kristaps  280:                p->parent = mdoc->last;
                    281:                break;
                    282:        default:
1.13      kristaps  283:                abort();
                    284:                /* NOTREACHED */
1.1       kristaps  285:        }
                    286:
1.23      kristaps  287:        if ( ! mdoc_valid_pre(mdoc, p))
                    288:                return(0);
1.27      kristaps  289:
                    290:        switch (p->type) {
                    291:        case (MDOC_HEAD):
                    292:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  293:                p->parent->head = p;
1.27      kristaps  294:                break;
                    295:        case (MDOC_TAIL):
                    296:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  297:                p->parent->tail = p;
1.27      kristaps  298:                break;
                    299:        case (MDOC_BODY):
                    300:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  301:                p->parent->body = p;
1.27      kristaps  302:                break;
                    303:        default:
                    304:                break;
                    305:        }
                    306:
1.1       kristaps  307:        mdoc->last = p;
1.23      kristaps  308:        return(1);
1.1       kristaps  309: }
                    310:
                    311:
1.45      kristaps  312: static struct mdoc_node *
1.46      kristaps  313: mdoc_node_alloc(const struct mdoc *mdoc)
1.45      kristaps  314: {
1.46      kristaps  315:        struct mdoc_node *p;
                    316:
                    317:        p = xcalloc(1, sizeof(struct mdoc_node));
                    318:        p->sec = mdoc->lastsec;
1.45      kristaps  319:
1.46      kristaps  320:        return(p);
1.45      kristaps  321: }
                    322:
                    323:
1.23      kristaps  324: int
1.22      kristaps  325: mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.17      kristaps  326: {
                    327:        struct mdoc_node *p;
                    328:
                    329:        assert(mdoc->first);
                    330:        assert(mdoc->last);
                    331:
1.46      kristaps  332:        p = mdoc_node_alloc(mdoc);
1.17      kristaps  333:
1.22      kristaps  334:        p->line = line;
                    335:        p->pos = pos;
1.17      kristaps  336:        p->type = MDOC_TAIL;
1.27      kristaps  337:        p->tok = tok;
1.17      kristaps  338:
1.23      kristaps  339:        return(mdoc_node_append(mdoc, p));
1.17      kristaps  340: }
                    341:
                    342:
1.23      kristaps  343: int
1.22      kristaps  344: mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1       kristaps  345: {
                    346:        struct mdoc_node *p;
                    347:
                    348:        assert(mdoc->first);
                    349:        assert(mdoc->last);
                    350:
1.46      kristaps  351:        p = mdoc_node_alloc(mdoc);
1.13      kristaps  352:
1.22      kristaps  353:        p->line = line;
                    354:        p->pos = pos;
1.1       kristaps  355:        p->type = MDOC_HEAD;
1.27      kristaps  356:        p->tok = tok;
1.1       kristaps  357:
1.23      kristaps  358:        return(mdoc_node_append(mdoc, p));
1.1       kristaps  359: }
                    360:
                    361:
1.23      kristaps  362: int
1.22      kristaps  363: mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1       kristaps  364: {
                    365:        struct mdoc_node *p;
                    366:
                    367:        assert(mdoc->first);
                    368:        assert(mdoc->last);
                    369:
1.46      kristaps  370:        p = mdoc_node_alloc(mdoc);
1.1       kristaps  371:
1.22      kristaps  372:        p->line = line;
                    373:        p->pos = pos;
1.1       kristaps  374:        p->type = MDOC_BODY;
1.27      kristaps  375:        p->tok = tok;
1.1       kristaps  376:
1.23      kristaps  377:        return(mdoc_node_append(mdoc, p));
1.1       kristaps  378: }
                    379:
                    380:
1.23      kristaps  381: int
1.25      kristaps  382: mdoc_root_alloc(struct mdoc *mdoc)
                    383: {
                    384:        struct mdoc_node *p;
                    385:
1.46      kristaps  386:        p = mdoc_node_alloc(mdoc);
1.25      kristaps  387:
                    388:        p->type = MDOC_ROOT;
                    389:
                    390:        return(mdoc_node_append(mdoc, p));
                    391: }
                    392:
                    393:
                    394: int
1.22      kristaps  395: mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
1.53      kristaps  396:                int tok, struct mdoc_arg *args)
1.1       kristaps  397: {
                    398:        struct mdoc_node *p;
                    399:
1.46      kristaps  400:        p = mdoc_node_alloc(mdoc);
1.1       kristaps  401:
1.22      kristaps  402:        p->pos = pos;
                    403:        p->line = line;
1.1       kristaps  404:        p->type = MDOC_BLOCK;
1.27      kristaps  405:        p->tok = tok;
1.53      kristaps  406:        p->args = args;
                    407:
                    408:        if (args)
                    409:                (args->refcnt)++;
1.1       kristaps  410:
1.23      kristaps  411:        return(mdoc_node_append(mdoc, p));
1.1       kristaps  412: }
                    413:
                    414:
1.23      kristaps  415: int
1.22      kristaps  416: mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
1.53      kristaps  417:                int tok, struct mdoc_arg *args)
1.1       kristaps  418: {
                    419:        struct mdoc_node *p;
                    420:
1.46      kristaps  421:        p = mdoc_node_alloc(mdoc);
1.22      kristaps  422:
                    423:        p->line = line;
                    424:        p->pos = pos;
1.1       kristaps  425:        p->type = MDOC_ELEM;
1.27      kristaps  426:        p->tok = tok;
1.53      kristaps  427:        p->args = args;
                    428:
                    429:        if (args)
                    430:                (args->refcnt)++;
1.1       kristaps  431:
1.23      kristaps  432:        return(mdoc_node_append(mdoc, p));
1.1       kristaps  433: }
                    434:
                    435:
1.23      kristaps  436: int
1.22      kristaps  437: mdoc_word_alloc(struct mdoc *mdoc,
                    438:                int line, int pos, const char *word)
1.1       kristaps  439: {
                    440:        struct mdoc_node *p;
                    441:
1.46      kristaps  442:        p = mdoc_node_alloc(mdoc);
1.45      kristaps  443:
1.22      kristaps  444:        p->line = line;
                    445:        p->pos = pos;
1.1       kristaps  446:        p->type = MDOC_TEXT;
1.53      kristaps  447:        p->string = xstrdup(word);
1.1       kristaps  448:
1.23      kristaps  449:        return(mdoc_node_append(mdoc, p));
1.1       kristaps  450: }
                    451:
                    452:
1.53      kristaps  453: void
                    454: mdoc_node_free(struct mdoc_node *p)
1.1       kristaps  455: {
                    456:
1.53      kristaps  457:        if (p->string)
                    458:                free(p->string);
                    459:        if (p->args)
                    460:                mdoc_argv_free(p->args);
1.1       kristaps  461:        free(p);
                    462: }
                    463:
                    464:
1.53      kristaps  465: void
                    466: mdoc_node_freelist(struct mdoc_node *p)
1.1       kristaps  467: {
                    468:
1.53      kristaps  469:        if (p->child)
                    470:                mdoc_node_freelist(p->child);
                    471:        if (p->next)
                    472:                mdoc_node_freelist(p->next);
1.1       kristaps  473:
1.53      kristaps  474:        mdoc_node_free(p);
1.1       kristaps  475: }
                    476:
                    477:
1.53      kristaps  478: /*
                    479:  * Parse free-form text, that is, a line that does not begin with the
                    480:  * control character.
                    481:  */
                    482: static int
                    483: parsetext(struct mdoc *mdoc, int line, char *buf)
1.1       kristaps  484: {
                    485:
1.53      kristaps  486:        if (SEC_PROLOGUE == mdoc->lastnamed)
                    487:                return(mdoc_perr(mdoc, line, 0,
                    488:                        "text disallowed in prologue"));
1.1       kristaps  489:
1.53      kristaps  490:        if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
                    491:                return(0);
1.1       kristaps  492:
1.53      kristaps  493:        mdoc->next = MDOC_NEXT_SIBLING;
                    494:        return(1);
1.1       kristaps  495: }
                    496:
                    497:
1.53      kristaps  498: /*
                    499:  * Parse a macro line, that is, a line beginning with the control
                    500:  * character.
                    501:  */
                    502: int
                    503: parsemacro(struct mdoc *m, int ln, char *buf)
1.1       kristaps  504: {
1.53      kristaps  505:        int               i, c;
                    506:        char              mac[5];
1.1       kristaps  507:
1.53      kristaps  508:        /* Comments are quickly ignored. */
1.1       kristaps  509:
1.53      kristaps  510:        if (buf[1] && '\\' == buf[1])
                    511:                if (buf[2] && '\"' == buf[2])
                    512:                        return(1);
1.1       kristaps  513:
1.53      kristaps  514:        /* Copy the first word into a nil-terminated buffer. */
1.1       kristaps  515:
1.53      kristaps  516:        for (i = 1; i < 5; i++) {
                    517:                if (0 == (mac[i - 1] = buf[i]))
                    518:                        break;
                    519:                else if (isspace((unsigned char)buf[i]))
                    520:                        break;
                    521:        }
1.1       kristaps  522:
1.54      kristaps  523:        /* FIXME: be able to skip unknown macro lines! */
                    524:
1.53      kristaps  525:        mac[i - 1] = 0;
1.1       kristaps  526:
1.53      kristaps  527:        if (i == 5 || i <= 2) {
                    528:                (void)mdoc_perr(m, ln, 1, "unknown macro: %s%s",
                    529:                                mac, i == 5 ? "..." : "");
                    530:                goto err;
                    531:        }
                    532:
                    533:        if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) {
                    534:                (void)mdoc_perr(m, ln, 1, "unknown macro: %s", mac);
                    535:                goto err;
                    536:        }
1.1       kristaps  537:
1.53      kristaps  538:        /* The macro is sane.  Jump to the next word. */
1.1       kristaps  539:
1.53      kristaps  540:        while (buf[i] && isspace((unsigned char)buf[i]))
                    541:                i++;
1.1       kristaps  542:
1.53      kristaps  543:        /* Begin recursive parse sequence. */
1.1       kristaps  544:
1.53      kristaps  545:        if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
                    546:                goto err;
1.1       kristaps  547:
1.53      kristaps  548:        return(1);
1.1       kristaps  549:
1.53      kristaps  550: err:   /* Error out. */
1.1       kristaps  551:
1.53      kristaps  552:        m->flags |= MDOC_HALT;
                    553:        return(0);
1.1       kristaps  554: }

CVSweb