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

Annotation of mandoc/mdoc.c, Revision 1.182

1.182   ! schwarze    1: /*     $Id: mdoc.c,v 1.181 2011/02/09 09:05:52 kristaps Exp $ */
1.1       kristaps    2: /*
1.182   ! schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.157     schwarze    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.181     kristaps  222: }
                    223:
                    224: int
                    225: mdoc_addeqn(struct mdoc *m, const struct eqn *ep)
                    226: {
                    227:        struct mdoc_node *n;
                    228:
                    229:        assert( ! (MDOC_HALT & m->flags));
                    230:
                    231:        /* No text before an initial macro. */
                    232:
                    233:        if (SEC_NONE == m->lastnamed) {
                    234:                mdoc_pmsg(m, ep->line, ep->pos, MANDOCERR_NOTEXT);
                    235:                return(1);
                    236:        }
                    237:
                    238:        n = node_alloc(m, ep->line, ep->pos, MDOC_MAX, MDOC_EQN);
                    239:        n->eqn = ep;
                    240:
                    241:        if ( ! node_append(m, n))
                    242:                return(0);
                    243:
                    244:        m->next = MDOC_NEXT_SIBLING;
                    245:        return(1);
1.20      kristaps  246: }
                    247:
1.175     kristaps  248: int
                    249: mdoc_addspan(struct mdoc *m, const struct tbl_span *sp)
                    250: {
1.180     kristaps  251:        struct mdoc_node *n;
1.175     kristaps  252:
1.177     kristaps  253:        assert( ! (MDOC_HALT & m->flags));
1.175     kristaps  254:
                    255:        /* No text before an initial macro. */
                    256:
                    257:        if (SEC_NONE == m->lastnamed) {
1.179     kristaps  258:                mdoc_pmsg(m, sp->line, 0, MANDOCERR_NOTEXT);
1.175     kristaps  259:                return(1);
                    260:        }
                    261:
1.180     kristaps  262:        n = node_alloc(m, sp->line, 0, MDOC_MAX, MDOC_TBL);
                    263:        n->span = sp;
                    264:
                    265:        if ( ! node_append(m, n))
                    266:                return(0);
                    267:
                    268:        m->next = MDOC_NEXT_SIBLING;
                    269:        return(1);
1.175     kristaps  270: }
                    271:
1.20      kristaps  272:
1.50      kristaps  273: /*
1.53      kristaps  274:  * Main parse routine.  Parses a single line -- really just hands off to
1.123     kristaps  275:  * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.50      kristaps  276:  */
1.20      kristaps  277: int
1.149     kristaps  278: mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
1.1       kristaps  279: {
                    280:
1.177     kristaps  281:        assert( ! (MDOC_HALT & m->flags));
1.50      kristaps  282:
1.130     kristaps  283:        m->flags |= MDOC_NEWLINE;
1.153     schwarze  284:
                    285:        /*
                    286:         * Let the roff nS register switch SYNOPSIS mode early,
                    287:         * such that the parser knows at all times
                    288:         * whether this mode is on or off.
                    289:         * Note that this mode is also switched by the Sh macro.
                    290:         */
                    291:        if (m->regs->regs[(int)REG_nS].set) {
                    292:                if (m->regs->regs[(int)REG_nS].v.u)
                    293:                        m->flags |= MDOC_SYNOPSIS;
                    294:                else
                    295:                        m->flags &= ~MDOC_SYNOPSIS;
                    296:        }
                    297:
1.135     kristaps  298:        return(('.' == buf[offs] || '\'' == buf[offs]) ?
1.149     kristaps  299:                        mdoc_pmacro(m, ln, buf, offs) :
                    300:                        mdoc_ptext(m, ln, buf, offs));
1.1       kristaps  301: }
                    302:
                    303:
                    304: int
1.136     kristaps  305: mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
                    306:                int ln, int pos, const char *fmt, ...)
1.1       kristaps  307: {
1.31      kristaps  308:        char             buf[256];
                    309:        va_list          ap;
1.1       kristaps  310:
1.31      kristaps  311:        va_start(ap, fmt);
1.136     kristaps  312:        vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
1.31      kristaps  313:        va_end(ap);
1.88      kristaps  314:
1.136     kristaps  315:        return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
1.88      kristaps  316: }
                    317:
                    318:
                    319: int
1.148     kristaps  320: mdoc_macro(MACRO_PROT_ARGS)
1.88      kristaps  321: {
1.122     kristaps  322:        assert(tok < MDOC_MAX);
                    323:
                    324:        /* If we're in the body, deny prologue calls. */
1.117     kristaps  325:
1.88      kristaps  326:        if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.174     kristaps  327:                        MDOC_PBODY & m->flags) {
                    328:                mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY);
                    329:                return(1);
                    330:        }
1.122     kristaps  331:
                    332:        /* If we're in the prologue, deny "body" macros.  */
                    333:
                    334:        if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
                    335:                        ! (MDOC_PBODY & m->flags)) {
1.174     kristaps  336:                mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG);
1.167     kristaps  337:                if (NULL == m->meta.msec)
                    338:                        m->meta.msec = mandoc_strdup("1");
1.120     kristaps  339:                if (NULL == m->meta.title)
1.140     kristaps  340:                        m->meta.title = mandoc_strdup("UNKNOWN");
1.120     kristaps  341:                if (NULL == m->meta.vol)
1.140     kristaps  342:                        m->meta.vol = mandoc_strdup("LOCAL");
1.120     kristaps  343:                if (NULL == m->meta.os)
1.140     kristaps  344:                        m->meta.os = mandoc_strdup("LOCAL");
1.182   ! schwarze  345:                if (NULL == m->meta.date)
        !           346:                        m->meta.date = mandoc_normdate(NULL,
        !           347:                            m->msg, m->data, line, ppos);
1.120     kristaps  348:                m->flags |= MDOC_PBODY;
                    349:        }
1.88      kristaps  350:
1.149     kristaps  351:        return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
1.73      kristaps  352: }
                    353:
                    354:
                    355: static int
                    356: node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1       kristaps  357: {
                    358:
1.25      kristaps  359:        assert(mdoc->last);
                    360:        assert(mdoc->first);
                    361:        assert(MDOC_ROOT != p->type);
1.1       kristaps  362:
1.13      kristaps  363:        switch (mdoc->next) {
                    364:        case (MDOC_NEXT_SIBLING):
1.6       kristaps  365:                mdoc->last->next = p;
                    366:                p->prev = mdoc->last;
1.13      kristaps  367:                p->parent = mdoc->last->parent;
1.1       kristaps  368:                break;
1.13      kristaps  369:        case (MDOC_NEXT_CHILD):
                    370:                mdoc->last->child = p;
1.1       kristaps  371:                p->parent = mdoc->last;
                    372:                break;
                    373:        default:
1.13      kristaps  374:                abort();
                    375:                /* NOTREACHED */
1.1       kristaps  376:        }
                    377:
1.86      kristaps  378:        p->parent->nchild++;
                    379:
1.172     kristaps  380:        /*
                    381:         * Copy over the normalised-data pointer of our parent.  Not
                    382:         * everybody has one, but copying a null pointer is fine.
                    383:         */
                    384:
                    385:        switch (p->type) {
                    386:        case (MDOC_BODY):
                    387:                /* FALLTHROUGH */
                    388:        case (MDOC_TAIL):
                    389:                /* FALLTHROUGH */
                    390:        case (MDOC_HEAD):
                    391:                p->norm = p->parent->norm;
                    392:                break;
                    393:        default:
                    394:                break;
                    395:        }
                    396:
1.23      kristaps  397:        if ( ! mdoc_valid_pre(mdoc, p))
                    398:                return(0);
1.27      kristaps  399:
                    400:        switch (p->type) {
                    401:        case (MDOC_HEAD):
                    402:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  403:                p->parent->head = p;
1.27      kristaps  404:                break;
                    405:        case (MDOC_TAIL):
                    406:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  407:                p->parent->tail = p;
1.27      kristaps  408:                break;
                    409:        case (MDOC_BODY):
1.152     schwarze  410:                if (p->end)
                    411:                        break;
1.27      kristaps  412:                assert(MDOC_BLOCK == p->parent->type);
1.53      kristaps  413:                p->parent->body = p;
1.27      kristaps  414:                break;
                    415:        default:
                    416:                break;
                    417:        }
                    418:
1.1       kristaps  419:        mdoc->last = p;
1.71      kristaps  420:
                    421:        switch (p->type) {
1.176     kristaps  422:        case (MDOC_TBL):
                    423:                /* FALLTHROUGH */
1.71      kristaps  424:        case (MDOC_TEXT):
                    425:                if ( ! mdoc_valid_post(mdoc))
                    426:                        return(0);
                    427:                break;
                    428:        default:
                    429:                break;
                    430:        }
                    431:
1.23      kristaps  432:        return(1);
1.1       kristaps  433: }
                    434:
                    435:
1.45      kristaps  436: static struct mdoc_node *
1.117     kristaps  437: node_alloc(struct mdoc *m, int line, int pos,
                    438:                enum mdoct tok, enum mdoc_type type)
1.45      kristaps  439: {
1.46      kristaps  440:        struct mdoc_node *p;
                    441:
1.113     kristaps  442:        p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.91      kristaps  443:        p->sec = m->lastsec;
1.73      kristaps  444:        p->line = line;
                    445:        p->pos = pos;
                    446:        p->tok = tok;
1.118     kristaps  447:        p->type = type;
1.150     kristaps  448:
                    449:        /* Flag analysis. */
                    450:
1.153     schwarze  451:        if (MDOC_SYNOPSIS & m->flags)
                    452:                p->flags |= MDOC_SYNPRETTY;
                    453:        else
                    454:                p->flags &= ~MDOC_SYNPRETTY;
1.130     kristaps  455:        if (MDOC_NEWLINE & m->flags)
                    456:                p->flags |= MDOC_LINE;
                    457:        m->flags &= ~MDOC_NEWLINE;
1.150     kristaps  458:
1.46      kristaps  459:        return(p);
1.45      kristaps  460: }
                    461:
                    462:
1.23      kristaps  463: int
1.117     kristaps  464: mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.17      kristaps  465: {
                    466:        struct mdoc_node *p;
                    467:
1.91      kristaps  468:        p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.102     kristaps  469:        if ( ! node_append(m, p))
                    470:                return(0);
                    471:        m->next = MDOC_NEXT_CHILD;
                    472:        return(1);
1.17      kristaps  473: }
                    474:
                    475:
1.23      kristaps  476: int
1.117     kristaps  477: mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1       kristaps  478: {
                    479:        struct mdoc_node *p;
                    480:
1.91      kristaps  481:        assert(m->first);
                    482:        assert(m->last);
1.1       kristaps  483:
1.91      kristaps  484:        p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.102     kristaps  485:        if ( ! node_append(m, p))
                    486:                return(0);
                    487:        m->next = MDOC_NEXT_CHILD;
                    488:        return(1);
1.1       kristaps  489: }
                    490:
                    491:
1.23      kristaps  492: int
1.117     kristaps  493: mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1       kristaps  494: {
                    495:        struct mdoc_node *p;
                    496:
1.91      kristaps  497:        p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.102     kristaps  498:        if ( ! node_append(m, p))
                    499:                return(0);
                    500:        m->next = MDOC_NEXT_CHILD;
1.152     schwarze  501:        return(1);
                    502: }
                    503:
                    504:
                    505: int
                    506: mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
                    507:                struct mdoc_node *body, enum mdoc_endbody end)
                    508: {
                    509:        struct mdoc_node *p;
                    510:
                    511:        p = node_alloc(m, line, pos, tok, MDOC_BODY);
                    512:        p->pending = body;
                    513:        p->end = end;
                    514:        if ( ! node_append(m, p))
                    515:                return(0);
                    516:        m->next = MDOC_NEXT_SIBLING;
1.102     kristaps  517:        return(1);
1.1       kristaps  518: }
                    519:
                    520:
1.23      kristaps  521: int
1.91      kristaps  522: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.117     kristaps  523:                enum mdoct tok, struct mdoc_arg *args)
1.1       kristaps  524: {
                    525:        struct mdoc_node *p;
                    526:
1.91      kristaps  527:        p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.77      kristaps  528:        p->args = args;
                    529:        if (p->args)
1.53      kristaps  530:                (args->refcnt)++;
1.172     kristaps  531:
                    532:        switch (tok) {
                    533:        case (MDOC_Bd):
                    534:                /* FALLTHROUGH */
                    535:        case (MDOC_Bf):
                    536:                /* FALLTHROUGH */
                    537:        case (MDOC_Bl):
1.173     kristaps  538:                /* FALLTHROUGH */
                    539:        case (MDOC_Rs):
1.172     kristaps  540:                p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                    541:                break;
                    542:        default:
                    543:                break;
                    544:        }
                    545:
1.102     kristaps  546:        if ( ! node_append(m, p))
                    547:                return(0);
                    548:        m->next = MDOC_NEXT_CHILD;
                    549:        return(1);
1.1       kristaps  550: }
                    551:
                    552:
1.23      kristaps  553: int
1.91      kristaps  554: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.117     kristaps  555:                enum mdoct tok, struct mdoc_arg *args)
1.1       kristaps  556: {
                    557:        struct mdoc_node *p;
                    558:
1.91      kristaps  559:        p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.77      kristaps  560:        p->args = args;
                    561:        if (p->args)
1.53      kristaps  562:                (args->refcnt)++;
1.172     kristaps  563:
                    564:        switch (tok) {
                    565:        case (MDOC_An):
                    566:                p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
                    567:                break;
                    568:        default:
                    569:                break;
                    570:        }
                    571:
1.102     kristaps  572:        if ( ! node_append(m, p))
                    573:                return(0);
                    574:        m->next = MDOC_NEXT_CHILD;
1.175     kristaps  575:        return(1);
                    576: }
1.1       kristaps  577:
1.124     kristaps  578: int
                    579: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
1.1       kristaps  580: {
1.91      kristaps  581:        struct mdoc_node *n;
1.124     kristaps  582:        size_t            sv, len;
                    583:
                    584:        len = strlen(p);
1.1       kristaps  585:
1.125     kristaps  586:        n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
1.113     kristaps  587:        n->string = mandoc_malloc(len + 1);
1.91      kristaps  588:        sv = strlcpy(n->string, p, len + 1);
                    589:
                    590:        /* Prohibit truncation. */
                    591:        assert(sv < len + 1);
                    592:
1.101     kristaps  593:        if ( ! node_append(m, n))
                    594:                return(0);
1.124     kristaps  595:
1.101     kristaps  596:        m->next = MDOC_NEXT_SIBLING;
                    597:        return(1);
1.91      kristaps  598: }
                    599:
                    600:
1.155     kristaps  601: static void
1.53      kristaps  602: mdoc_node_free(struct mdoc_node *p)
1.1       kristaps  603: {
                    604:
1.172     kristaps  605:        if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
1.171     kristaps  606:                free(p->norm);
1.53      kristaps  607:        if (p->string)
                    608:                free(p->string);
                    609:        if (p->args)
                    610:                mdoc_argv_free(p->args);
1.1       kristaps  611:        free(p);
                    612: }
                    613:
                    614:
1.121     kristaps  615: static void
                    616: mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
                    617: {
                    618:
                    619:        /* Adjust siblings. */
                    620:
                    621:        if (n->prev)
                    622:                n->prev->next = n->next;
                    623:        if (n->next)
                    624:                n->next->prev = n->prev;
                    625:
                    626:        /* Adjust parent. */
                    627:
                    628:        if (n->parent) {
                    629:                n->parent->nchild--;
                    630:                if (n->parent->child == n)
                    631:                        n->parent->child = n->prev ? n->prev : n->next;
1.169     kristaps  632:                if (n->parent->last == n)
                    633:                        n->parent->last = n->prev ? n->prev : NULL;
1.121     kristaps  634:        }
                    635:
                    636:        /* Adjust parse point, if applicable. */
                    637:
                    638:        if (m && m->last == n) {
                    639:                if (n->prev) {
                    640:                        m->last = n->prev;
                    641:                        m->next = MDOC_NEXT_SIBLING;
                    642:                } else {
                    643:                        m->last = n->parent;
                    644:                        m->next = MDOC_NEXT_CHILD;
                    645:                }
                    646:        }
                    647:
                    648:        if (m && m->first == n)
                    649:                m->first = NULL;
                    650: }
                    651:
                    652:
1.53      kristaps  653: void
1.121     kristaps  654: mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
1.1       kristaps  655: {
                    656:
1.121     kristaps  657:        while (p->child) {
                    658:                assert(p->nchild);
                    659:                mdoc_node_delete(m, p->child);
                    660:        }
                    661:        assert(0 == p->nchild);
1.1       kristaps  662:
1.121     kristaps  663:        mdoc_node_unlink(m, p);
1.53      kristaps  664:        mdoc_node_free(p);
1.1       kristaps  665: }
                    666:
                    667:
1.53      kristaps  668: /*
                    669:  * Parse free-form text, that is, a line that does not begin with the
                    670:  * control character.
                    671:  */
                    672: static int
1.149     kristaps  673: mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
1.1       kristaps  674: {
1.142     kristaps  675:        char             *c, *ws, *end;
                    676:        struct mdoc_node *n;
1.1       kristaps  677:
1.123     kristaps  678:        /* Ignore bogus comments. */
                    679:
1.135     kristaps  680:        if ('\\' == buf[offs] &&
                    681:                        '.' == buf[offs + 1] &&
1.174     kristaps  682:                        '"' == buf[offs + 2]) {
                    683:                mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT);
                    684:                return(1);
                    685:        }
1.123     kristaps  686:
1.124     kristaps  687:        /* No text before an initial macro. */
                    688:
1.174     kristaps  689:        if (SEC_NONE == m->lastnamed) {
                    690:                mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT);
                    691:                return(1);
                    692:        }
1.142     kristaps  693:
                    694:        assert(m->last);
                    695:        n = m->last;
                    696:
                    697:        /*
1.144     kristaps  698:         * Divert directly to list processing if we're encountering a
1.142     kristaps  699:         * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
1.144     kristaps  700:         * (a MDOC_BODY means it's already open, in which case we should
                    701:         * process within its context in the normal way).
1.142     kristaps  702:         */
                    703:
1.143     kristaps  704:        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.172     kristaps  705:                        LIST_column == n->norm->Bl.type) {
1.144     kristaps  706:                /* `Bl' is open without any children. */
1.142     kristaps  707:                m->flags |= MDOC_FREECOL;
1.149     kristaps  708:                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
1.142     kristaps  709:        }
                    710:
                    711:        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                    712:                        NULL != n->parent &&
                    713:                        MDOC_Bl == n->parent->tok &&
1.172     kristaps  714:                        LIST_column == n->parent->norm->Bl.type) {
1.144     kristaps  715:                /* `Bl' has block-level `It' children. */
1.142     kristaps  716:                m->flags |= MDOC_FREECOL;
1.149     kristaps  717:                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
1.142     kristaps  718:        }
1.124     kristaps  719:
1.137     schwarze  720:        /*
                    721:         * Search for the beginning of unescaped trailing whitespace (ws)
                    722:         * and for the first character not to be output (end).
                    723:         */
1.139     kristaps  724:
                    725:        /* FIXME: replace with strcspn(). */
1.137     schwarze  726:        ws = NULL;
                    727:        for (c = end = buf + offs; *c; c++) {
                    728:                switch (*c) {
1.138     kristaps  729:                case '-':
                    730:                        if (mandoc_hyph(buf + offs, c))
                    731:                                *c = ASCII_HYPH;
1.145     kristaps  732:                        ws = NULL;
1.138     kristaps  733:                        break;
1.137     schwarze  734:                case ' ':
                    735:                        if (NULL == ws)
                    736:                                ws = c;
                    737:                        continue;
                    738:                case '\t':
                    739:                        /*
                    740:                         * Always warn about trailing tabs,
                    741:                         * even outside literal context,
                    742:                         * where they should be put on the next line.
                    743:                         */
                    744:                        if (NULL == ws)
                    745:                                ws = c;
                    746:                        /*
                    747:                         * Strip trailing tabs in literal context only;
                    748:                         * outside, they affect the next line.
                    749:                         */
                    750:                        if (MDOC_LITERAL & m->flags)
                    751:                                continue;
                    752:                        break;
                    753:                case '\\':
                    754:                        /* Skip the escaped character, too, if any. */
                    755:                        if (c[1])
                    756:                                c++;
                    757:                        /* FALLTHROUGH */
                    758:                default:
                    759:                        ws = NULL;
                    760:                        break;
                    761:                }
                    762:                end = c + 1;
                    763:        }
                    764:        *end = '\0';
1.91      kristaps  765:
1.137     schwarze  766:        if (ws)
1.174     kristaps  767:                mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
1.115     kristaps  768:
1.137     schwarze  769:        if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
1.174     kristaps  770:                mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
1.124     kristaps  771:
1.119     kristaps  772:                /*
1.165     schwarze  773:                 * Insert a `sp' in the case of a blank line.  Technically,
1.124     kristaps  774:                 * blank lines aren't allowed, but enough manuals assume this
                    775:                 * behaviour that we want to work around it.
1.119     kristaps  776:                 */
1.165     schwarze  777:                if ( ! mdoc_elem_alloc(m, line, offs, MDOC_sp, NULL))
1.119     kristaps  778:                        return(0);
1.124     kristaps  779:
                    780:                m->next = MDOC_NEXT_SIBLING;
                    781:                return(1);
1.119     kristaps  782:        }
1.68      kristaps  783:
1.137     schwarze  784:        if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
                    785:                return(0);
1.91      kristaps  786:
1.137     schwarze  787:        if (MDOC_LITERAL & m->flags)
                    788:                return(1);
1.128     kristaps  789:
                    790:        /*
                    791:         * End-of-sentence check.  If the last character is an unescaped
                    792:         * EOS character, then flag the node as being the end of a
                    793:         * sentence.  The front-end will know how to interpret this.
                    794:         */
1.132     kristaps  795:
1.137     schwarze  796:        assert(buf < end);
                    797:
1.159     schwarze  798:        if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
1.128     kristaps  799:                m->last->flags |= MDOC_EOS;
                    800:
                    801:        return(1);
1.1       kristaps  802: }
                    803:
                    804:
1.53      kristaps  805: /*
                    806:  * Parse a macro line, that is, a line beginning with the control
                    807:  * character.
                    808:  */
1.155     kristaps  809: static int
1.149     kristaps  810: mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
1.1       kristaps  811: {
1.144     kristaps  812:        enum mdoct        tok;
                    813:        int               i, j, sv;
                    814:        char              mac[5];
                    815:        struct mdoc_node *n;
1.1       kristaps  816:
1.81      kristaps  817:        /* Empty lines are ignored. */
1.63      kristaps  818:
1.135     kristaps  819:        offs++;
                    820:
                    821:        if ('\0' == buf[offs])
1.63      kristaps  822:                return(1);
                    823:
1.135     kristaps  824:        i = offs;
1.100     kristaps  825:
1.160     kristaps  826:        /* Accept tabs/whitespace after the initial control char. */
1.100     kristaps  827:
1.160     kristaps  828:        if (' ' == buf[i] || '\t' == buf[i]) {
1.100     kristaps  829:                i++;
1.160     kristaps  830:                while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
1.63      kristaps  831:                        i++;
1.115     kristaps  832:                if ('\0' == buf[i])
1.63      kristaps  833:                        return(1);
                    834:        }
1.1       kristaps  835:
1.130     kristaps  836:        sv = i;
                    837:
1.160     kristaps  838:        /*
1.162     schwarze  839:         * Copy the first word into a nil-terminated buffer.
1.165     schwarze  840:         * Stop copying when a tab, space, or eoln is encountered.
1.160     kristaps  841:         */
1.1       kristaps  842:
1.162     schwarze  843:        j = 0;
1.165     schwarze  844:        while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i])
1.162     schwarze  845:                mac[j++] = buf[i++];
1.135     kristaps  846:        mac[j] = '\0';
1.1       kristaps  847:
1.163     schwarze  848:        tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
                    849:        if (MDOC_MAX == tok) {
1.168     kristaps  850:                mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv, "%s", buf + sv - 1);
1.58      kristaps  851:                return(1);
1.53      kristaps  852:        }
1.1       kristaps  853:
1.160     kristaps  854:        /* Disregard the first trailing tab, if applicable. */
                    855:
                    856:        if ('\t' == buf[i])
                    857:                i++;
                    858:
                    859:        /* Jump to the next non-whitespace word. */
1.1       kristaps  860:
1.65      kristaps  861:        while (buf[i] && ' ' == buf[i])
1.53      kristaps  862:                i++;
1.1       kristaps  863:
1.125     kristaps  864:        /*
                    865:         * Trailing whitespace.  Note that tabs are allowed to be passed
                    866:         * into the parser as "text", so we only warn about spaces here.
                    867:         */
1.115     kristaps  868:
                    869:        if ('\0' == buf[i] && ' ' == buf[i - 1])
1.174     kristaps  870:                mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE);
1.115     kristaps  871:
1.144     kristaps  872:        /*
                    873:         * If an initial macro or a list invocation, divert directly
                    874:         * into macro processing.
                    875:         */
                    876:
                    877:        if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
1.149     kristaps  878:                if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
1.144     kristaps  879:                        goto err;
                    880:                return(1);
                    881:        }
                    882:
                    883:        n = m->last;
                    884:        assert(m->last);
                    885:
                    886:        /*
                    887:         * If the first macro of a `Bl -column', open an `It' block
                    888:         * context around the parsed macro.
                    889:         */
                    890:
                    891:        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.172     kristaps  892:                        LIST_column == n->norm->Bl.type) {
1.144     kristaps  893:                m->flags |= MDOC_FREECOL;
1.149     kristaps  894:                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
1.144     kristaps  895:                        goto err;
                    896:                return(1);
                    897:        }
                    898:
                    899:        /*
                    900:         * If we're following a block-level `It' within a `Bl -column'
                    901:         * context (perhaps opened in the above block or in ptext()),
                    902:         * then open an `It' block context around the parsed macro.
1.98      kristaps  903:         */
1.144     kristaps  904:
                    905:        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                    906:                        NULL != n->parent &&
                    907:                        MDOC_Bl == n->parent->tok &&
1.172     kristaps  908:                        LIST_column == n->parent->norm->Bl.type) {
1.144     kristaps  909:                m->flags |= MDOC_FREECOL;
1.149     kristaps  910:                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
1.144     kristaps  911:                        goto err;
                    912:                return(1);
                    913:        }
                    914:
                    915:        /* Normal processing of a macro. */
                    916:
1.149     kristaps  917:        if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
1.53      kristaps  918:                goto err;
1.1       kristaps  919:
1.53      kristaps  920:        return(1);
1.1       kristaps  921:
1.53      kristaps  922: err:   /* Error out. */
1.1       kristaps  923:
1.53      kristaps  924:        m->flags |= MDOC_HALT;
                    925:        return(0);
1.1       kristaps  926: }
1.100     kristaps  927:
                    928:

CVSweb