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

Annotation of mandoc/mdoc.c, Revision 1.180

1.180   ! kristaps    1: /*     $Id: mdoc.c,v 1.179 2011/02/06 22:05:20 kristaps Exp $ */
1.1       kristaps    2: /*
1.157     schwarze    3:  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
                      4:  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.75      kristaps    7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    9:  *
1.75      kristaps   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   17:  */
1.114     kristaps   18: #ifdef HAVE_CONFIG_H
                     19: #include "config.h"
                     20: #endif
                     21:
1.106     kristaps   22: #include <sys/types.h>
                     23:
1.1       kristaps   24: #include <assert.h>
                     25: #include <stdarg.h>
1.73      kristaps   26: #include <stdio.h>
1.1       kristaps   27: #include <stdlib.h>
                     28: #include <string.h>
1.120     kristaps   29: #include <time.h>
1.1       kristaps   30:
1.136     kristaps   31: #include "mandoc.h"
1.70      kristaps   32: #include "libmdoc.h"
1.113     kristaps   33: #include "libmandoc.h"
1.1       kristaps   34:
                     35: const  char *const __mdoc_macronames[MDOC_MAX] = {
1.82      kristaps   36:        "Ap",           "Dd",           "Dt",           "Os",
1.1       kristaps   37:        "Sh",           "Ss",           "Pp",           "D1",
                     38:        "Dl",           "Bd",           "Ed",           "Bl",
                     39:        "El",           "It",           "Ad",           "An",
                     40:        "Ar",           "Cd",           "Cm",           "Dv",
                     41:        "Er",           "Ev",           "Ex",           "Fa",
                     42:        "Fd",           "Fl",           "Fn",           "Ft",
                     43:        "Ic",           "In",           "Li",           "Nd",
                     44:        "Nm",           "Op",           "Ot",           "Pa",
                     45:        "Rv",           "St",           "Va",           "Vt",
                     46:        /* LINTED */
1.114     kristaps   47:        "Xr",           "%A",           "%B",           "%D",
1.1       kristaps   48:        /* LINTED */
1.114     kristaps   49:        "%I",           "%J",           "%N",           "%O",
1.1       kristaps   50:        /* LINTED */
1.114     kristaps   51:        "%P",           "%R",           "%T",           "%V",
1.1       kristaps   52:        "Ac",           "Ao",           "Aq",           "At",
                     53:        "Bc",           "Bf",           "Bo",           "Bq",
                     54:        "Bsx",          "Bx",           "Db",           "Dc",
                     55:        "Do",           "Dq",           "Ec",           "Ef",
                     56:        "Em",           "Eo",           "Fx",           "Ms",
                     57:        "No",           "Ns",           "Nx",           "Ox",
                     58:        "Pc",           "Pf",           "Po",           "Pq",
                     59:        "Qc",           "Ql",           "Qo",           "Qq",
                     60:        "Re",           "Rs",           "Sc",           "So",
                     61:        "Sq",           "Sm",           "Sx",           "Sy",
                     62:        "Tn",           "Ux",           "Xc",           "Xo",
                     63:        "Fo",           "Fc",           "Oo",           "Oc",
                     64:        "Bk",           "Ek",           "Bt",           "Hf",
1.82      kristaps   65:        "Fr",           "Ud",           "Lb",           "Lp",
                     66:        "Lk",           "Mt",           "Brq",          "Bro",
1.64      kristaps   67:        /* LINTED */
1.114     kristaps   68:        "Brc",          "%C",           "Es",           "En",
1.69      kristaps   69:        /* LINTED */
1.114     kristaps   70:        "Dx",           "%Q",           "br",           "sp",
1.110     kristaps   71:        /* LINTED */
1.141     kristaps   72:        "%U",           "Ta"
1.1       kristaps   73:        };
                     74:
                     75: const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {
                     76:        "split",                "nosplit",              "ragged",
                     77:        "unfilled",             "literal",              "file",
                     78:        "offset",               "bullet",               "dash",
                     79:        "hyphen",               "item",                 "enum",
                     80:        "tag",                  "diag",                 "hang",
                     81:        "ohang",                "inset",                "column",
                     82:        "width",                "compact",              "std",
1.52      kristaps   83:        "filled",               "words",                "emphasis",
1.108     kristaps   84:        "symbolic",             "nested",               "centered"
1.1       kristaps   85:        };
                     86:
                     87: const  char * const *mdoc_macronames = __mdoc_macronames;
                     88: const  char * const *mdoc_argnames = __mdoc_argnames;
                     89:
1.121     kristaps   90: static void              mdoc_node_free(struct mdoc_node *);
                     91: static void              mdoc_node_unlink(struct mdoc *,
                     92:                                struct mdoc_node *);
1.73      kristaps   93: static void              mdoc_free1(struct mdoc *);
1.113     kristaps   94: static void              mdoc_alloc1(struct mdoc *);
1.73      kristaps   95: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
1.117     kristaps   96:                                enum mdoct, enum mdoc_type);
1.73      kristaps   97: static int               node_append(struct mdoc *,
1.71      kristaps   98:                                struct mdoc_node *);
1.149     kristaps   99: static int               mdoc_ptext(struct mdoc *, int, char *, int);
                    100: static int               mdoc_pmacro(struct mdoc *, int, char *, int);
1.88      kristaps  101:
1.1       kristaps  102: const struct mdoc_node *
1.71      kristaps  103: mdoc_node(const struct mdoc *m)
1.1       kristaps  104: {
                    105:
1.177     kristaps  106:        assert( ! (MDOC_HALT & m->flags));
                    107:        return(m->first);
1.1       kristaps  108: }
                    109:
                    110:
1.37      kristaps  111: const struct mdoc_meta *
1.71      kristaps  112: mdoc_meta(const struct mdoc *m)
1.37      kristaps  113: {
                    114:
1.177     kristaps  115:        assert( ! (MDOC_HALT & m->flags));
                    116:        return(&m->meta);
1.37      kristaps  117: }
                    118:
                    119:
1.85      kristaps  120: /*
                    121:  * Frees volatile resources (parse tree, meta-data, fields).
                    122:  */
1.73      kristaps  123: static void
                    124: mdoc_free1(struct mdoc *mdoc)
1.67      kristaps  125: {
                    126:
                    127:        if (mdoc->first)
1.121     kristaps  128:                mdoc_node_delete(mdoc, mdoc->first);
1.67      kristaps  129:        if (mdoc->meta.title)
                    130:                free(mdoc->meta.title);
                    131:        if (mdoc->meta.os)
                    132:                free(mdoc->meta.os);
                    133:        if (mdoc->meta.name)
                    134:                free(mdoc->meta.name);
                    135:        if (mdoc->meta.arch)
                    136:                free(mdoc->meta.arch);
                    137:        if (mdoc->meta.vol)
                    138:                free(mdoc->meta.vol);
1.133     kristaps  139:        if (mdoc->meta.msec)
                    140:                free(mdoc->meta.msec);
1.73      kristaps  141: }
                    142:
                    143:
1.85      kristaps  144: /*
                    145:  * Allocate all volatile resources (parse tree, meta-data, fields).
                    146:  */
1.113     kristaps  147: static void
1.73      kristaps  148: mdoc_alloc1(struct mdoc *mdoc)
                    149: {
1.67      kristaps  150:
1.112     kristaps  151:        memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.67      kristaps  152:        mdoc->flags = 0;
1.85      kristaps  153:        mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.113     kristaps  154:        mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.70      kristaps  155:        mdoc->first = mdoc->last;
1.67      kristaps  156:        mdoc->last->type = MDOC_ROOT;
                    157:        mdoc->next = MDOC_NEXT_CHILD;
1.73      kristaps  158: }
                    159:
                    160:
                    161: /*
1.85      kristaps  162:  * Free up volatile resources (see mdoc_free1()) then re-initialises the
                    163:  * data with mdoc_alloc1().  After invocation, parse data has been reset
                    164:  * and the parser is ready for re-invocation on a new tree; however,
                    165:  * cross-parse non-volatile data is kept intact.
1.73      kristaps  166:  */
1.113     kristaps  167: void
1.73      kristaps  168: mdoc_reset(struct mdoc *mdoc)
                    169: {
                    170:
                    171:        mdoc_free1(mdoc);
1.113     kristaps  172:        mdoc_alloc1(mdoc);
1.67      kristaps  173: }
                    174:
                    175:
1.68      kristaps  176: /*
1.85      kristaps  177:  * Completely free up all volatile and non-volatile parse resources.
                    178:  * After invocation, the pointer is no longer usable.
1.68      kristaps  179:  */
1.67      kristaps  180: void
1.38      kristaps  181: mdoc_free(struct mdoc *mdoc)
1.34      kristaps  182: {
                    183:
1.73      kristaps  184:        mdoc_free1(mdoc);
1.1       kristaps  185:        free(mdoc);
                    186: }
                    187:
                    188:
1.85      kristaps  189: /*
                    190:  * Allocate volatile and non-volatile parse resources.
                    191:  */
1.1       kristaps  192: struct mdoc *
1.163     schwarze  193: mdoc_alloc(struct regset *regs, void *data, mandocmsg msg)
1.1       kristaps  194: {
                    195:        struct mdoc     *p;
                    196:
1.113     kristaps  197:        p = mandoc_calloc(1, sizeof(struct mdoc));
                    198:
1.136     kristaps  199:        p->msg = msg;
1.1       kristaps  200:        p->data = data;
1.149     kristaps  201:        p->regs = regs;
1.73      kristaps  202:
1.113     kristaps  203:        mdoc_hash_init();
                    204:        mdoc_alloc1(p);
                    205:        return(p);
1.1       kristaps  206: }
                    207:
                    208:
1.68      kristaps  209: /*
                    210:  * Climb back up the parse tree, validating open scopes.  Mostly calls
1.85      kristaps  211:  * through to macro_end() in macro.c.
1.68      kristaps  212:  */
1.1       kristaps  213: int
1.72      kristaps  214: mdoc_endparse(struct mdoc *m)
1.20      kristaps  215: {
                    216:
1.177     kristaps  217:        assert( ! (MDOC_HALT & m->flags));
                    218:        if (mdoc_macroend(m))
1.20      kristaps  219:                return(1);
1.72      kristaps  220:        m->flags |= MDOC_HALT;
                    221:        return(0);
1.20      kristaps  222: }
                    223:
1.175     kristaps  224: int
                    225: mdoc_addspan(struct mdoc *m, const struct tbl_span *sp)
                    226: {
1.180   ! kristaps  227:        struct mdoc_node *n;
1.175     kristaps  228:
1.177     kristaps  229:        assert( ! (MDOC_HALT & m->flags));
1.175     kristaps  230:
                    231:        /* No text before an initial macro. */
                    232:
                    233:        if (SEC_NONE == m->lastnamed) {
1.179     kristaps  234:                mdoc_pmsg(m, sp->line, 0, MANDOCERR_NOTEXT);
1.175     kristaps  235:                return(1);
                    236:        }
                    237:
1.180   ! kristaps  238:        n = node_alloc(m, sp->line, 0, MDOC_MAX, MDOC_TBL);
        !           239:        n->span = sp;
        !           240:
        !           241:        if ( ! node_append(m, n))
        !           242:                return(0);
        !           243:
        !           244:        m->next = MDOC_NEXT_SIBLING;
        !           245:        return(1);
1.175     kristaps  246: }
                    247:
1.20      kristaps  248:
1.50      kristaps  249: /*
1.53      kristaps  250:  * Main parse routine.  Parses a single line -- really just hands off to
1.123     kristaps  251:  * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.50      kristaps  252:  */
1.20      kristaps  253: int
1.149     kristaps  254: mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
1.1       kristaps  255: {
                    256:
1.177     kristaps  257:        assert( ! (MDOC_HALT & m->flags));
1.50      kristaps  258:
1.130     kristaps  259:        m->flags |= MDOC_NEWLINE;
1.153     schwarze  260:
                    261:        /*
                    262:         * Let the roff nS register switch SYNOPSIS mode early,
                    263:         * such that the parser knows at all times
                    264:         * whether this mode is on or off.
                    265:         * Note that this mode is also switched by the Sh macro.
                    266:         */
                    267:        if (m->regs->regs[(int)REG_nS].set) {
                    268:                if (m->regs->regs[(int)REG_nS].v.u)
                    269:                        m->flags |= MDOC_SYNOPSIS;
                    270:                else
                    271:                        m->flags &= ~MDOC_SYNOPSIS;
                    272:        }
                    273:
1.135     kristaps  274:        return(('.' == buf[offs] || '\'' == buf[offs]) ?
1.149     kristaps  275:                        mdoc_pmacro(m, ln, buf, offs) :
                    276:                        mdoc_ptext(m, ln, buf, offs));
1.1       kristaps  277: }
                    278:
                    279:
                    280: int
1.136     kristaps  281: mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
                    282:                int ln, int pos, const char *fmt, ...)
1.1       kristaps  283: {
1.31      kristaps  284:        char             buf[256];
                    285:        va_list          ap;
1.1       kristaps  286:
1.31      kristaps  287:        va_start(ap, fmt);
1.136     kristaps  288:        vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
1.31      kristaps  289:        va_end(ap);
1.88      kristaps  290:
1.136     kristaps  291:        return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
1.88      kristaps  292: }
                    293:
                    294:
                    295: int
1.148     kristaps  296: mdoc_macro(MACRO_PROT_ARGS)
1.88      kristaps  297: {
1.122     kristaps  298:        assert(tok < MDOC_MAX);
                    299:
                    300:        /* If we're in the body, deny prologue calls. */
1.117     kristaps  301:
1.88      kristaps  302:        if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.174     kristaps  303:                        MDOC_PBODY & m->flags) {
                    304:                mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY);
                    305:                return(1);
                    306:        }
1.122     kristaps  307:
                    308:        /* If we're in the prologue, deny "body" macros.  */
                    309:
                    310:        if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
                    311:                        ! (MDOC_PBODY & m->flags)) {
1.174     kristaps  312:                mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG);
1.167     kristaps  313:                if (NULL == m->meta.msec)
                    314:                        m->meta.msec = mandoc_strdup("1");
1.120     kristaps  315:                if (NULL == m->meta.title)
1.140     kristaps  316:                        m->meta.title = mandoc_strdup("UNKNOWN");
1.120     kristaps  317:                if (NULL == m->meta.vol)
1.140     kristaps  318:                        m->meta.vol = mandoc_strdup("LOCAL");
1.120     kristaps  319:                if (NULL == m->meta.os)
1.140     kristaps  320:                        m->meta.os = mandoc_strdup("LOCAL");
1.120     kristaps  321:                if (0 == m->meta.date)
                    322:                        m->meta.date = time(NULL);
                    323:                m->flags |= MDOC_PBODY;
                    324:        }
1.88      kristaps  325:
1.149     kristaps  326:        return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
1.73      kristaps  327: }
                    328:
                    329:
                    330: static int
                    331: node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1       kristaps  332: {
                    333:
1.25      kristaps  334:        assert(mdoc->last);
                    335:        assert(mdoc->first);
                    336:        assert(MDOC_ROOT != p->type);
1.1       kristaps  337:
1.13      kristaps  338:        switch (mdoc->next) {
                    339:        case (MDOC_NEXT_SIBLING):
1.6       kristaps  340:                mdoc->last->next = p;
                    341:                p->prev = mdoc->last;
1.13      kristaps  342:                p->parent = mdoc->last->parent;
1.1       kristaps  343:                break;
1.13      kristaps  344:        case (MDOC_NEXT_CHILD):
                    345:                mdoc->last->child = p;
1.1       kristaps  346:                p->parent = mdoc->last;
                    347:                break;
                    348:        default:
1.13      kristaps  349:                abort();
                    350:                /* NOTREACHED */
1.1       kristaps  351:        }
                    352:
1.86      kristaps  353:        p->parent->nchild++;
                    354:
1.172     kristaps  355:        /*
                    356:         * Copy over the normalised-data pointer of our parent.  Not
                    357:         * everybody has one, but copying a null pointer is fine.
                    358:         */
                    359:
                    360:        switch (p->type) {
                    361:        case (MDOC_BODY):
                    362:                /* FALLTHROUGH */
                    363:        case (MDOC_TAIL):
                    364:                /* FALLTHROUGH */
                    365:        case (MDOC_HEAD):
                    366:                p->norm = p->parent->norm;
                    367:                break;
                    368:        default:
                    369:                break;
                    370:        }
                    371:
1.23      kristaps  372:        if ( ! mdoc_valid_pre(mdoc, p))
                    373:                return(0);
1.27      kristaps  374:
                    375:        switch (p->type) {
                    376:        case (MDOC_HEAD):
                    377:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  378:                p->parent->head = p;
1.27      kristaps  379:                break;
                    380:        case (MDOC_TAIL):
                    381:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  382:                p->parent->tail = p;
1.27      kristaps  383:                break;
                    384:        case (MDOC_BODY):
1.152     schwarze  385:                if (p->end)
                    386:                        break;
1.27      kristaps  387:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  388:                p->parent->body = p;
1.27      kristaps  389:                break;
                    390:        default:
                    391:                break;
                    392:        }
                    393:
1.1       kristaps  394:        mdoc->last = p;
1.71      kristaps  395:
                    396:        switch (p->type) {
1.176     kristaps  397:        case (MDOC_TBL):
                    398:                /* FALLTHROUGH */
1.71      kristaps  399:        case (MDOC_TEXT):
                    400:                if ( ! mdoc_valid_post(mdoc))
                    401:                        return(0);
                    402:                break;
                    403:        default:
                    404:                break;
                    405:        }
                    406:
1.23      kristaps  407:        return(1);
1.1       kristaps  408: }
                    409:
                    410:
1.45      kristaps  411: static struct mdoc_node *
1.117     kristaps  412: node_alloc(struct mdoc *m, int line, int pos,
                    413:                enum mdoct tok, enum mdoc_type type)
1.45      kristaps  414: {
1.46      kristaps  415:        struct mdoc_node *p;
                    416:
1.113     kristaps  417:        p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.91      kristaps  418:        p->sec = m->lastsec;
1.73      kristaps  419:        p->line = line;
                    420:        p->pos = pos;
                    421:        p->tok = tok;
1.118     kristaps  422:        p->type = type;
1.150     kristaps  423:
                    424:        /* Flag analysis. */
                    425:
1.153     schwarze  426:        if (MDOC_SYNOPSIS & m->flags)
                    427:                p->flags |= MDOC_SYNPRETTY;
                    428:        else
                    429:                p->flags &= ~MDOC_SYNPRETTY;
1.130     kristaps  430:        if (MDOC_NEWLINE & m->flags)
                    431:                p->flags |= MDOC_LINE;
                    432:        m->flags &= ~MDOC_NEWLINE;
1.150     kristaps  433:
1.46      kristaps  434:        return(p);
1.45      kristaps  435: }
                    436:
                    437:
1.23      kristaps  438: int
1.117     kristaps  439: mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.17      kristaps  440: {
                    441:        struct mdoc_node *p;
                    442:
1.91      kristaps  443:        p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.102     kristaps  444:        if ( ! node_append(m, p))
                    445:                return(0);
                    446:        m->next = MDOC_NEXT_CHILD;
                    447:        return(1);
1.17      kristaps  448: }
                    449:
                    450:
1.23      kristaps  451: int
1.117     kristaps  452: mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1       kristaps  453: {
                    454:        struct mdoc_node *p;
                    455:
1.91      kristaps  456:        assert(m->first);
                    457:        assert(m->last);
1.1       kristaps  458:
1.91      kristaps  459:        p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.102     kristaps  460:        if ( ! node_append(m, p))
                    461:                return(0);
                    462:        m->next = MDOC_NEXT_CHILD;
                    463:        return(1);
1.1       kristaps  464: }
                    465:
                    466:
1.23      kristaps  467: int
1.117     kristaps  468: mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1       kristaps  469: {
                    470:        struct mdoc_node *p;
                    471:
1.91      kristaps  472:        p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.102     kristaps  473:        if ( ! node_append(m, p))
                    474:                return(0);
                    475:        m->next = MDOC_NEXT_CHILD;
1.152     schwarze  476:        return(1);
                    477: }
                    478:
                    479:
                    480: int
                    481: mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
                    482:                struct mdoc_node *body, enum mdoc_endbody end)
                    483: {
                    484:        struct mdoc_node *p;
                    485:
                    486:        p = node_alloc(m, line, pos, tok, MDOC_BODY);
                    487:        p->pending = body;
                    488:        p->end = end;
                    489:        if ( ! node_append(m, p))
                    490:                return(0);
                    491:        m->next = MDOC_NEXT_SIBLING;
1.102     kristaps  492:        return(1);
1.1       kristaps  493: }
                    494:
                    495:
1.23      kristaps  496: int
1.91      kristaps  497: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.117     kristaps  498:                enum mdoct tok, struct mdoc_arg *args)
1.1       kristaps  499: {
                    500:        struct mdoc_node *p;
                    501:
1.91      kristaps  502:        p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.77      kristaps  503:        p->args = args;
                    504:        if (p->args)
1.53      kristaps  505:                (args->refcnt)++;
1.172     kristaps  506:
                    507:        switch (tok) {
                    508:        case (MDOC_Bd):
                    509:                /* FALLTHROUGH */
                    510:        case (MDOC_Bf):
                    511:                /* FALLTHROUGH */
                    512:        case (MDOC_Bl):
1.173     kristaps  513:                /* FALLTHROUGH */
                    514:        case (MDOC_Rs):
1.172     kristaps  515:                p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                    516:                break;
                    517:        default:
                    518:                break;
                    519:        }
                    520:
1.102     kristaps  521:        if ( ! node_append(m, p))
                    522:                return(0);
                    523:        m->next = MDOC_NEXT_CHILD;
                    524:        return(1);
1.1       kristaps  525: }
                    526:
                    527:
1.23      kristaps  528: int
1.91      kristaps  529: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.117     kristaps  530:                enum mdoct tok, struct mdoc_arg *args)
1.1       kristaps  531: {
                    532:        struct mdoc_node *p;
                    533:
1.91      kristaps  534:        p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.77      kristaps  535:        p->args = args;
                    536:        if (p->args)
1.53      kristaps  537:                (args->refcnt)++;
1.172     kristaps  538:
                    539:        switch (tok) {
                    540:        case (MDOC_An):
                    541:                p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                    542:                break;
                    543:        default:
                    544:                break;
                    545:        }
                    546:
1.102     kristaps  547:        if ( ! node_append(m, p))
                    548:                return(0);
                    549:        m->next = MDOC_NEXT_CHILD;
1.175     kristaps  550:        return(1);
                    551: }
1.1       kristaps  552:
1.124     kristaps  553: int
                    554: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
1.1       kristaps  555: {
1.91      kristaps  556:        struct mdoc_node *n;
1.124     kristaps  557:        size_t            sv, len;
                    558:
                    559:        len = strlen(p);
1.1       kristaps  560:
1.125     kristaps  561:        n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
1.113     kristaps  562:        n->string = mandoc_malloc(len + 1);
1.91      kristaps  563:        sv = strlcpy(n->string, p, len + 1);
                    564:
                    565:        /* Prohibit truncation. */
                    566:        assert(sv < len + 1);
                    567:
1.101     kristaps  568:        if ( ! node_append(m, n))
                    569:                return(0);
1.124     kristaps  570:
1.101     kristaps  571:        m->next = MDOC_NEXT_SIBLING;
                    572:        return(1);
1.91      kristaps  573: }
                    574:
                    575:
1.155     kristaps  576: static void
1.53      kristaps  577: mdoc_node_free(struct mdoc_node *p)
1.1       kristaps  578: {
                    579:
1.172     kristaps  580:        if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
1.171     kristaps  581:                free(p->norm);
1.53      kristaps  582:        if (p->string)
                    583:                free(p->string);
                    584:        if (p->args)
                    585:                mdoc_argv_free(p->args);
1.1       kristaps  586:        free(p);
                    587: }
                    588:
                    589:
1.121     kristaps  590: static void
                    591: mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
                    592: {
                    593:
                    594:        /* Adjust siblings. */
                    595:
                    596:        if (n->prev)
                    597:                n->prev->next = n->next;
                    598:        if (n->next)
                    599:                n->next->prev = n->prev;
                    600:
                    601:        /* Adjust parent. */
                    602:
                    603:        if (n->parent) {
                    604:                n->parent->nchild--;
                    605:                if (n->parent->child == n)
                    606:                        n->parent->child = n->prev ? n->prev : n->next;
1.169     kristaps  607:                if (n->parent->last == n)
                    608:                        n->parent->last = n->prev ? n->prev : NULL;
1.121     kristaps  609:        }
                    610:
                    611:        /* Adjust parse point, if applicable. */
                    612:
                    613:        if (m && m->last == n) {
                    614:                if (n->prev) {
                    615:                        m->last = n->prev;
                    616:                        m->next = MDOC_NEXT_SIBLING;
                    617:                } else {
                    618:                        m->last = n->parent;
                    619:                        m->next = MDOC_NEXT_CHILD;
                    620:                }
                    621:        }
                    622:
                    623:        if (m && m->first == n)
                    624:                m->first = NULL;
                    625: }
                    626:
                    627:
1.53      kristaps  628: void
1.121     kristaps  629: mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
1.1       kristaps  630: {
                    631:
1.121     kristaps  632:        while (p->child) {
                    633:                assert(p->nchild);
                    634:                mdoc_node_delete(m, p->child);
                    635:        }
                    636:        assert(0 == p->nchild);
1.1       kristaps  637:
1.121     kristaps  638:        mdoc_node_unlink(m, p);
1.53      kristaps  639:        mdoc_node_free(p);
1.1       kristaps  640: }
                    641:
                    642:
1.53      kristaps  643: /*
                    644:  * Parse free-form text, that is, a line that does not begin with the
                    645:  * control character.
                    646:  */
                    647: static int
1.149     kristaps  648: mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
1.1       kristaps  649: {
1.142     kristaps  650:        char             *c, *ws, *end;
                    651:        struct mdoc_node *n;
1.1       kristaps  652:
1.123     kristaps  653:        /* Ignore bogus comments. */
                    654:
1.135     kristaps  655:        if ('\\' == buf[offs] &&
                    656:                        '.' == buf[offs + 1] &&
1.174     kristaps  657:                        '"' == buf[offs + 2]) {
                    658:                mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT);
                    659:                return(1);
                    660:        }
1.123     kristaps  661:
1.124     kristaps  662:        /* No text before an initial macro. */
                    663:
1.174     kristaps  664:        if (SEC_NONE == m->lastnamed) {
                    665:                mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT);
                    666:                return(1);
                    667:        }
1.142     kristaps  668:
                    669:        assert(m->last);
                    670:        n = m->last;
                    671:
                    672:        /*
1.144     kristaps  673:         * Divert directly to list processing if we're encountering a
1.142     kristaps  674:         * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
1.144     kristaps  675:         * (a MDOC_BODY means it's already open, in which case we should
                    676:         * process within its context in the normal way).
1.142     kristaps  677:         */
                    678:
1.143     kristaps  679:        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.172     kristaps  680:                        LIST_column == n->norm->Bl.type) {
1.144     kristaps  681:                /* `Bl' is open without any children. */
1.142     kristaps  682:                m->flags |= MDOC_FREECOL;
1.149     kristaps  683:                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
1.142     kristaps  684:        }
                    685:
                    686:        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                    687:                        NULL != n->parent &&
                    688:                        MDOC_Bl == n->parent->tok &&
1.172     kristaps  689:                        LIST_column == n->parent->norm->Bl.type) {
1.144     kristaps  690:                /* `Bl' has block-level `It' children. */
1.142     kristaps  691:                m->flags |= MDOC_FREECOL;
1.149     kristaps  692:                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
1.142     kristaps  693:        }
1.124     kristaps  694:
1.137     schwarze  695:        /*
                    696:         * Search for the beginning of unescaped trailing whitespace (ws)
                    697:         * and for the first character not to be output (end).
                    698:         */
1.139     kristaps  699:
                    700:        /* FIXME: replace with strcspn(). */
1.137     schwarze  701:        ws = NULL;
                    702:        for (c = end = buf + offs; *c; c++) {
                    703:                switch (*c) {
1.138     kristaps  704:                case '-':
                    705:                        if (mandoc_hyph(buf + offs, c))
                    706:                                *c = ASCII_HYPH;
1.145     kristaps  707:                        ws = NULL;
1.138     kristaps  708:                        break;
1.137     schwarze  709:                case ' ':
                    710:                        if (NULL == ws)
                    711:                                ws = c;
                    712:                        continue;
                    713:                case '\t':
                    714:                        /*
                    715:                         * Always warn about trailing tabs,
                    716:                         * even outside literal context,
                    717:                         * where they should be put on the next line.
                    718:                         */
                    719:                        if (NULL == ws)
                    720:                                ws = c;
                    721:                        /*
                    722:                         * Strip trailing tabs in literal context only;
                    723:                         * outside, they affect the next line.
                    724:                         */
                    725:                        if (MDOC_LITERAL & m->flags)
                    726:                                continue;
                    727:                        break;
                    728:                case '\\':
                    729:                        /* Skip the escaped character, too, if any. */
                    730:                        if (c[1])
                    731:                                c++;
                    732:                        /* FALLTHROUGH */
                    733:                default:
                    734:                        ws = NULL;
                    735:                        break;
                    736:                }
                    737:                end = c + 1;
                    738:        }
                    739:        *end = '\0';
1.91      kristaps  740:
1.137     schwarze  741:        if (ws)
1.174     kristaps  742:                mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
1.115     kristaps  743:
1.137     schwarze  744:        if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
1.174     kristaps  745:                mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
1.124     kristaps  746:
1.119     kristaps  747:                /*
1.165     schwarze  748:                 * Insert a `sp' in the case of a blank line.  Technically,
1.124     kristaps  749:                 * blank lines aren't allowed, but enough manuals assume this
                    750:                 * behaviour that we want to work around it.
1.119     kristaps  751:                 */
1.165     schwarze  752:                if ( ! mdoc_elem_alloc(m, line, offs, MDOC_sp, NULL))
1.119     kristaps  753:                        return(0);
1.124     kristaps  754:
                    755:                m->next = MDOC_NEXT_SIBLING;
                    756:                return(1);
1.119     kristaps  757:        }
1.68      kristaps  758:
1.137     schwarze  759:        if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
                    760:                return(0);
1.91      kristaps  761:
1.137     schwarze  762:        if (MDOC_LITERAL & m->flags)
                    763:                return(1);
1.128     kristaps  764:
                    765:        /*
                    766:         * End-of-sentence check.  If the last character is an unescaped
                    767:         * EOS character, then flag the node as being the end of a
                    768:         * sentence.  The front-end will know how to interpret this.
                    769:         */
1.132     kristaps  770:
1.137     schwarze  771:        assert(buf < end);
                    772:
1.159     schwarze  773:        if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
1.128     kristaps  774:                m->last->flags |= MDOC_EOS;
                    775:
                    776:        return(1);
1.1       kristaps  777: }
                    778:
                    779:
1.53      kristaps  780: /*
                    781:  * Parse a macro line, that is, a line beginning with the control
                    782:  * character.
                    783:  */
1.155     kristaps  784: static int
1.149     kristaps  785: mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
1.1       kristaps  786: {
1.144     kristaps  787:        enum mdoct        tok;
                    788:        int               i, j, sv;
                    789:        char              mac[5];
                    790:        struct mdoc_node *n;
1.1       kristaps  791:
1.81      kristaps  792:        /* Empty lines are ignored. */
1.63      kristaps  793:
1.135     kristaps  794:        offs++;
                    795:
                    796:        if ('\0' == buf[offs])
1.63      kristaps  797:                return(1);
                    798:
1.135     kristaps  799:        i = offs;
1.100     kristaps  800:
1.160     kristaps  801:        /* Accept tabs/whitespace after the initial control char. */
1.100     kristaps  802:
1.160     kristaps  803:        if (' ' == buf[i] || '\t' == buf[i]) {
1.100     kristaps  804:                i++;
1.160     kristaps  805:                while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
1.63      kristaps  806:                        i++;
1.115     kristaps  807:                if ('\0' == buf[i])
1.63      kristaps  808:                        return(1);
                    809:        }
1.1       kristaps  810:
1.130     kristaps  811:        sv = i;
                    812:
1.160     kristaps  813:        /*
1.162     schwarze  814:         * Copy the first word into a nil-terminated buffer.
1.165     schwarze  815:         * Stop copying when a tab, space, or eoln is encountered.
1.160     kristaps  816:         */
1.1       kristaps  817:
1.162     schwarze  818:        j = 0;
1.165     schwarze  819:        while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i])
1.162     schwarze  820:                mac[j++] = buf[i++];
1.135     kristaps  821:        mac[j] = '\0';
1.1       kristaps  822:
1.163     schwarze  823:        tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
                    824:        if (MDOC_MAX == tok) {
1.168     kristaps  825:                mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv, "%s", buf + sv - 1);
1.58      kristaps  826:                return(1);
1.53      kristaps  827:        }
1.1       kristaps  828:
1.160     kristaps  829:        /* Disregard the first trailing tab, if applicable. */
                    830:
                    831:        if ('\t' == buf[i])
                    832:                i++;
                    833:
                    834:        /* Jump to the next non-whitespace word. */
1.1       kristaps  835:
1.65      kristaps  836:        while (buf[i] && ' ' == buf[i])
1.53      kristaps  837:                i++;
1.1       kristaps  838:
1.125     kristaps  839:        /*
                    840:         * Trailing whitespace.  Note that tabs are allowed to be passed
                    841:         * into the parser as "text", so we only warn about spaces here.
                    842:         */
1.115     kristaps  843:
                    844:        if ('\0' == buf[i] && ' ' == buf[i - 1])
1.174     kristaps  845:                mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE);
1.115     kristaps  846:
1.144     kristaps  847:        /*
                    848:         * If an initial macro or a list invocation, divert directly
                    849:         * into macro processing.
                    850:         */
                    851:
                    852:        if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
1.149     kristaps  853:                if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
1.144     kristaps  854:                        goto err;
                    855:                return(1);
                    856:        }
                    857:
                    858:        n = m->last;
                    859:        assert(m->last);
                    860:
                    861:        /*
                    862:         * If the first macro of a `Bl -column', open an `It' block
                    863:         * context around the parsed macro.
                    864:         */
                    865:
                    866:        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.172     kristaps  867:                        LIST_column == n->norm->Bl.type) {
1.144     kristaps  868:                m->flags |= MDOC_FREECOL;
1.149     kristaps  869:                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
1.144     kristaps  870:                        goto err;
                    871:                return(1);
                    872:        }
                    873:
                    874:        /*
                    875:         * If we're following a block-level `It' within a `Bl -column'
                    876:         * context (perhaps opened in the above block or in ptext()),
                    877:         * then open an `It' block context around the parsed macro.
1.98      kristaps  878:         */
1.144     kristaps  879:
                    880:        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                    881:                        NULL != n->parent &&
                    882:                        MDOC_Bl == n->parent->tok &&
1.172     kristaps  883:                        LIST_column == n->parent->norm->Bl.type) {
1.144     kristaps  884:                m->flags |= MDOC_FREECOL;
1.149     kristaps  885:                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
1.144     kristaps  886:                        goto err;
                    887:                return(1);
                    888:        }
                    889:
                    890:        /* Normal processing of a macro. */
                    891:
1.149     kristaps  892:        if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
1.53      kristaps  893:                goto err;
1.1       kristaps  894:
1.53      kristaps  895:        return(1);
1.1       kristaps  896:
1.53      kristaps  897: err:   /* Error out. */
1.1       kristaps  898:
1.53      kristaps  899:        m->flags |= MDOC_HALT;
                    900:        return(0);
1.1       kristaps  901: }
1.100     kristaps  902:
                    903:

CVSweb