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

Annotation of mandoc/mdoc.c, Revision 1.152

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

CVSweb