[BACK]Return to mdoc.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.21

1.21    ! schwarze    1: /*     $Id: mdoc.c,v 1.20 2009/07/26 01:59:46 schwarze Exp $ */
1.1       kristaps    2: /*
1.3       schwarze    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.3       schwarze    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.3       schwarze    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:  */
                     17: #include <assert.h>
                     18: #include <ctype.h>
                     19: #include <stdarg.h>
                     20: #include <stdio.h>
                     21: #include <stdlib.h>
                     22: #include <string.h>
                     23:
                     24: #include "libmdoc.h"
                     25:
1.14      schwarze   26: const  char *const __mdoc_merrnames[MERRMAX] = {
                     27:        "trailing whitespace", /* ETAILWS */
                     28:        "empty last list column", /* ECOLEMPTY */
                     29:        "unexpected quoted parameter", /* EQUOTPARM */
                     30:        "unterminated quoted parameter", /* EQUOTTERM */
                     31:        "system: malloc error", /* EMALLOC */
                     32:        "argument parameter suggested", /* EARGVAL */
                     33:        "macro not callable", /* ENOCALL */
                     34:        "macro disallowed in prologue", /* EBODYPROL */
                     35:        "macro disallowed in body", /* EPROLBODY */
                     36:        "text disallowed in prologue", /* ETEXTPROL */
                     37:        "blank line disallowed", /* ENOBLANK */
                     38:        "text parameter too long", /* ETOOLONG */
                     39:        "invalid escape sequence", /* EESCAPE */
                     40:        "invalid character", /* EPRINT */
                     41:        "document has no body", /* ENODAT */
                     42:        "document has no prologue", /* ENOPROLOGUE */
                     43:        "expected line arguments", /* ELINE */
                     44:        "invalid AT&T argument", /* EATT */
                     45:        "default name not yet set", /* ENAME */
                     46:        "missing list type", /* ELISTTYPE */
                     47:        "missing display type", /* EDISPTYPE */
                     48:        "too many display types", /* EMULTIDISP */
                     49:        "too many list types", /* EMULTILIST */
                     50:        "NAME section must be first", /* ESECNAME */
                     51:        "badly-formed NAME section", /* ENAMESECINC */
                     52:        "argument repeated", /* EARGREP */
                     53:        "expected boolean parameter", /* EBOOL */
                     54:        "inconsistent column syntax", /* ECOLMIS */
                     55:        "nested display invalid", /* ENESTDISP */
                     56:        "width argument missing", /* EMISSWIDTH */
                     57:        "invalid section for this manual section", /* EWRONGMSEC */
                     58:        "section out of conventional order", /* ESECOOO */
                     59:        "section repeated", /* ESECREP */
                     60:        "invalid standard argument", /* EBADSTAND */
                     61:        "multi-line arguments discouraged", /* ENOMULTILINE */
                     62:        "multi-line arguments suggested", /* EMULTILINE */
                     63:        "line arguments discouraged", /* ENOLINE */
                     64:        "prologue macro out of conventional order", /* EPROLOOO */
                     65:        "prologue macro repeated", /* EPROLREP */
                     66:        "invalid manual section", /* EBADMSEC */
                     67:        "invalid section", /* EBADSEC */
                     68:        "invalid font mode", /* EFONT */
                     69:        "invalid date syntax", /* EBADDATE */
                     70:        "invalid number format", /* ENUMFMT */
                     71:        "superfluous width argument", /* ENOWIDTH */
                     72:        "system: utsname error", /* EUTSNAME */
                     73:        "obsolete macro", /* EOBS */
                     74:        "macro-like parameter", /* EMACPARM */
                     75:        "end-of-line scope violation", /* EIMPBRK */
                     76:        "empty macro ignored", /* EIGNE */
                     77:        "unclosed explicit scope", /* EOPEN */
                     78:        "unterminated quoted phrase", /* EQUOTPHR */
                     79:        "closure macro without prior context", /* ENOCTX */
                     80:        "invalid whitespace after control character", /* ESPACE */
1.18      schwarze   81:        "no description found for library" /* ELIB */
1.1       kristaps   82: };
                     83:
                     84: const  char *const __mdoc_macronames[MDOC_MAX] = {
1.7       schwarze   85:        "Ap",           "Dd",           "Dt",           "Os",
1.1       kristaps   86:        "Sh",           "Ss",           "Pp",           "D1",
                     87:        "Dl",           "Bd",           "Ed",           "Bl",
                     88:        "El",           "It",           "Ad",           "An",
                     89:        "Ar",           "Cd",           "Cm",           "Dv",
                     90:        "Er",           "Ev",           "Ex",           "Fa",
                     91:        "Fd",           "Fl",           "Fn",           "Ft",
                     92:        "Ic",           "In",           "Li",           "Nd",
                     93:        "Nm",           "Op",           "Ot",           "Pa",
                     94:        "Rv",           "St",           "Va",           "Vt",
                     95:        /* LINTED */
                     96:        "Xr",           "\%A",          "\%B",          "\%D",
                     97:        /* LINTED */
                     98:        "\%I",          "\%J",          "\%N",          "\%O",
                     99:        /* LINTED */
                    100:        "\%P",          "\%R",          "\%T",          "\%V",
                    101:        "Ac",           "Ao",           "Aq",           "At",
                    102:        "Bc",           "Bf",           "Bo",           "Bq",
                    103:        "Bsx",          "Bx",           "Db",           "Dc",
                    104:        "Do",           "Dq",           "Ec",           "Ef",
                    105:        "Em",           "Eo",           "Fx",           "Ms",
                    106:        "No",           "Ns",           "Nx",           "Ox",
                    107:        "Pc",           "Pf",           "Po",           "Pq",
                    108:        "Qc",           "Ql",           "Qo",           "Qq",
                    109:        "Re",           "Rs",           "Sc",           "So",
                    110:        "Sq",           "Sm",           "Sx",           "Sy",
                    111:        "Tn",           "Ux",           "Xc",           "Xo",
                    112:        "Fo",           "Fc",           "Oo",           "Oc",
                    113:        "Bk",           "Ek",           "Bt",           "Hf",
1.7       schwarze  114:        "Fr",           "Ud",           "Lb",           "Lp",
                    115:        "Lk",           "Mt",           "Brq",          "Bro",
1.1       kristaps  116:        /* LINTED */
1.7       schwarze  117:        "Brc",          "\%C",          "Es",           "En",
1.1       kristaps  118:        /* LINTED */
1.20      schwarze  119:        "Dx",           "\%Q",          "br",           "sp"
1.1       kristaps  120:        };
                    121:
                    122: const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {
                    123:        "split",                "nosplit",              "ragged",
                    124:        "unfilled",             "literal",              "file",
                    125:        "offset",               "bullet",               "dash",
                    126:        "hyphen",               "item",                 "enum",
                    127:        "tag",                  "diag",                 "hang",
                    128:        "ohang",                "inset",                "column",
                    129:        "width",                "compact",              "std",
                    130:        "filled",               "words",                "emphasis",
                    131:        "symbolic",             "nested"
                    132:        };
                    133:
                    134: const  char * const *mdoc_macronames = __mdoc_macronames;
                    135: const  char * const *mdoc_argnames = __mdoc_argnames;
                    136:
                    137: static void              mdoc_free1(struct mdoc *);
                    138: static int               mdoc_alloc1(struct mdoc *);
                    139: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
                    140:                                int, enum mdoc_type);
                    141: static int               node_append(struct mdoc *,
                    142:                                struct mdoc_node *);
                    143: static int               parsetext(struct mdoc *, int, char *);
                    144: static int               parsemacro(struct mdoc *, int, char *);
                    145: static int               macrowarn(struct mdoc *, int, const char *);
1.19      schwarze  146: static int               pstring(struct mdoc *, int, int,
                    147:                                const char *, size_t);
1.16      schwarze  148:
1.1       kristaps  149:
                    150: const struct mdoc_node *
                    151: mdoc_node(const struct mdoc *m)
                    152: {
                    153:
                    154:        return(MDOC_HALT & m->flags ? NULL : m->first);
                    155: }
                    156:
                    157:
                    158: const struct mdoc_meta *
                    159: mdoc_meta(const struct mdoc *m)
                    160: {
                    161:
                    162:        return(MDOC_HALT & m->flags ? NULL : &m->meta);
                    163: }
                    164:
                    165:
1.8       schwarze  166: /*
                    167:  * Frees volatile resources (parse tree, meta-data, fields).
                    168:  */
1.1       kristaps  169: static void
                    170: mdoc_free1(struct mdoc *mdoc)
                    171: {
                    172:
                    173:        if (mdoc->first)
                    174:                mdoc_node_freelist(mdoc->first);
                    175:        if (mdoc->meta.title)
                    176:                free(mdoc->meta.title);
                    177:        if (mdoc->meta.os)
                    178:                free(mdoc->meta.os);
                    179:        if (mdoc->meta.name)
                    180:                free(mdoc->meta.name);
                    181:        if (mdoc->meta.arch)
                    182:                free(mdoc->meta.arch);
                    183:        if (mdoc->meta.vol)
                    184:                free(mdoc->meta.vol);
                    185: }
                    186:
                    187:
1.8       schwarze  188: /*
                    189:  * Allocate all volatile resources (parse tree, meta-data, fields).
                    190:  */
1.1       kristaps  191: static int
                    192: mdoc_alloc1(struct mdoc *mdoc)
                    193: {
                    194:
                    195:        bzero(&mdoc->meta, sizeof(struct mdoc_meta));
                    196:        mdoc->flags = 0;
1.9       schwarze  197:        mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.1       kristaps  198:        mdoc->last = calloc(1, sizeof(struct mdoc_node));
                    199:        if (NULL == mdoc->last)
                    200:                return(0);
                    201:
                    202:        mdoc->first = mdoc->last;
                    203:        mdoc->last->type = MDOC_ROOT;
                    204:        mdoc->next = MDOC_NEXT_CHILD;
                    205:        return(1);
                    206: }
                    207:
                    208:
                    209: /*
1.8       schwarze  210:  * Free up volatile resources (see mdoc_free1()) then re-initialises the
                    211:  * data with mdoc_alloc1().  After invocation, parse data has been reset
                    212:  * and the parser is ready for re-invocation on a new tree; however,
                    213:  * cross-parse non-volatile data is kept intact.
1.1       kristaps  214:  */
                    215: int
                    216: mdoc_reset(struct mdoc *mdoc)
                    217: {
                    218:
                    219:        mdoc_free1(mdoc);
                    220:        return(mdoc_alloc1(mdoc));
                    221: }
                    222:
                    223:
                    224: /*
1.8       schwarze  225:  * Completely free up all volatile and non-volatile parse resources.
                    226:  * After invocation, the pointer is no longer usable.
1.1       kristaps  227:  */
                    228: void
                    229: mdoc_free(struct mdoc *mdoc)
                    230: {
                    231:
                    232:        mdoc_free1(mdoc);
                    233:        if (mdoc->htab)
                    234:                mdoc_hash_free(mdoc->htab);
                    235:        free(mdoc);
                    236: }
                    237:
                    238:
1.8       schwarze  239: /*
                    240:  * Allocate volatile and non-volatile parse resources.
                    241:  */
1.1       kristaps  242: struct mdoc *
                    243: mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
                    244: {
                    245:        struct mdoc     *p;
                    246:
                    247:        if (NULL == (p = calloc(1, sizeof(struct mdoc))))
                    248:                return(NULL);
                    249:        if (cb)
                    250:                (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
                    251:
                    252:        p->data = data;
                    253:        p->pflags = pflags;
                    254:
                    255:        if (NULL == (p->htab = mdoc_hash_alloc())) {
                    256:                free(p);
                    257:                return(NULL);
                    258:        } else if (mdoc_alloc1(p))
                    259:                return(p);
                    260:
                    261:        free(p);
                    262:        return(NULL);
                    263: }
                    264:
                    265:
                    266: /*
                    267:  * Climb back up the parse tree, validating open scopes.  Mostly calls
1.8       schwarze  268:  * through to macro_end() in macro.c.
1.1       kristaps  269:  */
                    270: int
                    271: mdoc_endparse(struct mdoc *m)
                    272: {
                    273:
                    274:        if (MDOC_HALT & m->flags)
                    275:                return(0);
                    276:        else if (mdoc_macroend(m))
                    277:                return(1);
                    278:        m->flags |= MDOC_HALT;
                    279:        return(0);
                    280: }
                    281:
                    282:
                    283: /*
                    284:  * Main parse routine.  Parses a single line -- really just hands off to
1.8       schwarze  285:  * the macro (parsemacro()) or text parser (parsetext()).
1.1       kristaps  286:  */
                    287: int
                    288: mdoc_parseln(struct mdoc *m, int ln, char *buf)
                    289: {
                    290:
                    291:        if (MDOC_HALT & m->flags)
                    292:                return(0);
                    293:
                    294:        return('.' == *buf ? parsemacro(m, ln, buf) :
                    295:                        parsetext(m, ln, buf));
                    296: }
                    297:
                    298:
                    299: int
1.4       schwarze  300: mdoc_verr(struct mdoc *mdoc, int ln, int pos,
                    301:                const char *fmt, ...)
1.1       kristaps  302: {
                    303:        char             buf[256];
                    304:        va_list          ap;
                    305:
                    306:        if (NULL == mdoc->cb.mdoc_err)
                    307:                return(0);
                    308:
                    309:        va_start(ap, fmt);
                    310:        (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
                    311:        va_end(ap);
1.12      schwarze  312:
1.1       kristaps  313:        return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
                    314: }
                    315:
                    316:
                    317: int
1.12      schwarze  318: mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
1.1       kristaps  319: {
                    320:        char             buf[256];
                    321:        va_list          ap;
                    322:
                    323:        if (NULL == mdoc->cb.mdoc_warn)
                    324:                return(0);
                    325:
                    326:        va_start(ap, fmt);
                    327:        (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
                    328:        va_end(ap);
1.17      schwarze  329:
1.11      schwarze  330:        return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
1.5       schwarze  331: }
                    332:
                    333:
                    334: int
1.14      schwarze  335: mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
1.5       schwarze  336: {
1.14      schwarze  337:        const char      *p;
1.5       schwarze  338:
1.14      schwarze  339:        p = __mdoc_merrnames[(int)type];
                    340:        assert(p);
1.5       schwarze  341:
1.14      schwarze  342:        if (iserr)
                    343:                return(mdoc_verr(m, line, pos, p));
1.16      schwarze  344:
1.14      schwarze  345:        return(mdoc_vwarn(m, line, pos, p));
1.5       schwarze  346: }
                    347:
                    348:
                    349: int
1.1       kristaps  350: mdoc_macro(struct mdoc *m, int tok,
                    351:                int ln, int pp, int *pos, char *buf)
                    352: {
                    353:
                    354:        if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.9       schwarze  355:                        MDOC_PBODY & m->flags)
1.16      schwarze  356:                return(mdoc_perr(m, ln, pp, EPROLBODY));
1.1       kristaps  357:        if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
1.9       schwarze  358:                        ! (MDOC_PBODY & m->flags))
1.16      schwarze  359:                return(mdoc_perr(m, ln, pp, EBODYPROL));
1.1       kristaps  360:
                    361:        if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
1.16      schwarze  362:                return(mdoc_perr(m, ln, pp, ENOCALL));
1.1       kristaps  363:
                    364:        return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
                    365: }
                    366:
                    367:
                    368: static int
                    369: node_append(struct mdoc *mdoc, struct mdoc_node *p)
                    370: {
                    371:
                    372:        assert(mdoc->last);
                    373:        assert(mdoc->first);
                    374:        assert(MDOC_ROOT != p->type);
                    375:
                    376:        switch (mdoc->next) {
                    377:        case (MDOC_NEXT_SIBLING):
                    378:                mdoc->last->next = p;
                    379:                p->prev = mdoc->last;
                    380:                p->parent = mdoc->last->parent;
                    381:                break;
                    382:        case (MDOC_NEXT_CHILD):
                    383:                mdoc->last->child = p;
                    384:                p->parent = mdoc->last;
                    385:                break;
                    386:        default:
                    387:                abort();
                    388:                /* NOTREACHED */
                    389:        }
                    390:
1.10      schwarze  391:        p->parent->nchild++;
                    392:
1.1       kristaps  393:        if ( ! mdoc_valid_pre(mdoc, p))
                    394:                return(0);
                    395:        if ( ! mdoc_action_pre(mdoc, p))
                    396:                return(0);
                    397:
                    398:        switch (p->type) {
                    399:        case (MDOC_HEAD):
                    400:                assert(MDOC_BLOCK == p->parent->type);
                    401:                p->parent->head = p;
                    402:                break;
                    403:        case (MDOC_TAIL):
                    404:                assert(MDOC_BLOCK == p->parent->type);
                    405:                p->parent->tail = p;
                    406:                break;
                    407:        case (MDOC_BODY):
                    408:                assert(MDOC_BLOCK == p->parent->type);
                    409:                p->parent->body = p;
                    410:                break;
                    411:        default:
                    412:                break;
                    413:        }
                    414:
                    415:        mdoc->last = p;
                    416:
                    417:        switch (p->type) {
                    418:        case (MDOC_TEXT):
                    419:                if ( ! mdoc_valid_post(mdoc))
                    420:                        return(0);
                    421:                if ( ! mdoc_action_post(mdoc))
                    422:                        return(0);
                    423:                break;
                    424:        default:
                    425:                break;
                    426:        }
                    427:
                    428:        return(1);
                    429: }
                    430:
                    431:
                    432: static struct mdoc_node *
1.19      schwarze  433: node_alloc(struct mdoc *m, int line,
1.1       kristaps  434:                int pos, int tok, enum mdoc_type type)
                    435: {
                    436:        struct mdoc_node *p;
                    437:
                    438:        if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) {
1.19      schwarze  439:                (void)mdoc_nerr(m, m->last, EMALLOC);
1.1       kristaps  440:                return(NULL);
                    441:        }
                    442:
1.19      schwarze  443:        p->sec = m->lastsec;
1.1       kristaps  444:        p->line = line;
                    445:        p->pos = pos;
                    446:        p->tok = tok;
                    447:        if (MDOC_TEXT != (p->type = type))
                    448:                assert(p->tok >= 0);
                    449:
                    450:        return(p);
                    451: }
                    452:
                    453:
                    454: int
1.19      schwarze  455: mdoc_tail_alloc(struct mdoc *m, int line, int pos, int tok)
1.1       kristaps  456: {
                    457:        struct mdoc_node *p;
                    458:
1.19      schwarze  459:        p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.1       kristaps  460:        if (NULL == p)
                    461:                return(0);
1.19      schwarze  462:        return(node_append(m, p));
1.1       kristaps  463: }
                    464:
                    465:
                    466: int
1.19      schwarze  467: mdoc_head_alloc(struct mdoc *m, int line, int pos, int tok)
1.1       kristaps  468: {
                    469:        struct mdoc_node *p;
                    470:
1.19      schwarze  471:        assert(m->first);
                    472:        assert(m->last);
1.1       kristaps  473:
1.19      schwarze  474:        p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.1       kristaps  475:        if (NULL == p)
                    476:                return(0);
1.19      schwarze  477:        return(node_append(m, p));
1.1       kristaps  478: }
                    479:
                    480:
                    481: int
1.19      schwarze  482: mdoc_body_alloc(struct mdoc *m, int line, int pos, int tok)
1.1       kristaps  483: {
                    484:        struct mdoc_node *p;
                    485:
1.19      schwarze  486:        p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.1       kristaps  487:        if (NULL == p)
                    488:                return(0);
1.19      schwarze  489:        return(node_append(m, p));
1.1       kristaps  490: }
                    491:
                    492:
                    493: int
1.19      schwarze  494: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.1       kristaps  495:                int tok, struct mdoc_arg *args)
                    496: {
                    497:        struct mdoc_node *p;
                    498:
1.19      schwarze  499:        p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.1       kristaps  500:        if (NULL == p)
                    501:                return(0);
1.4       schwarze  502:        p->args = args;
                    503:        if (p->args)
1.1       kristaps  504:                (args->refcnt)++;
1.19      schwarze  505:        return(node_append(m, p));
1.1       kristaps  506: }
                    507:
                    508:
                    509: int
1.19      schwarze  510: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.1       kristaps  511:                int tok, struct mdoc_arg *args)
                    512: {
                    513:        struct mdoc_node *p;
                    514:
1.19      schwarze  515:        p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.1       kristaps  516:        if (NULL == p)
                    517:                return(0);
1.4       schwarze  518:        p->args = args;
                    519:        if (p->args)
1.1       kristaps  520:                (args->refcnt)++;
1.19      schwarze  521:        return(node_append(m, p));
1.1       kristaps  522: }
                    523:
                    524:
1.19      schwarze  525: static int
                    526: pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
1.1       kristaps  527: {
1.19      schwarze  528:        struct mdoc_node *n;
                    529:        size_t            sv;
1.1       kristaps  530:
1.19      schwarze  531:        n = node_alloc(m, line, pos, -1, MDOC_TEXT);
                    532:        if (NULL == n)
                    533:                return(mdoc_nerr(m, m->last, EMALLOC));
                    534:
                    535:        n->string = malloc(len + 1);
                    536:        if (NULL == n->string) {
                    537:                free(n);
                    538:                return(mdoc_nerr(m, m->last, EMALLOC));
1.1       kristaps  539:        }
1.15      schwarze  540:
1.19      schwarze  541:        sv = strlcpy(n->string, p, len + 1);
                    542:
                    543:        /* Prohibit truncation. */
                    544:        assert(sv < len + 1);
                    545:
                    546:        return(node_append(m, n));
                    547: }
                    548:
                    549:
                    550: int
                    551: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
                    552: {
                    553:
                    554:        return(pstring(m, line, pos, p, strlen(p)));
1.1       kristaps  555: }
                    556:
                    557:
                    558: void
                    559: mdoc_node_free(struct mdoc_node *p)
                    560: {
                    561:
1.10      schwarze  562:        if (p->parent)
                    563:                p->parent->nchild--;
1.1       kristaps  564:        if (p->string)
                    565:                free(p->string);
                    566:        if (p->args)
                    567:                mdoc_argv_free(p->args);
                    568:        free(p);
                    569: }
                    570:
                    571:
                    572: void
                    573: mdoc_node_freelist(struct mdoc_node *p)
                    574: {
                    575:
                    576:        if (p->child)
                    577:                mdoc_node_freelist(p->child);
                    578:        if (p->next)
                    579:                mdoc_node_freelist(p->next);
                    580:
1.10      schwarze  581:        assert(0 == p->nchild);
1.1       kristaps  582:        mdoc_node_free(p);
                    583: }
                    584:
                    585:
                    586: /*
                    587:  * Parse free-form text, that is, a line that does not begin with the
                    588:  * control character.
                    589:  */
                    590: static int
                    591: parsetext(struct mdoc *m, int line, char *buf)
                    592: {
1.19      schwarze  593:        int              i, j;
1.1       kristaps  594:
1.9       schwarze  595:        if (SEC_NONE == m->lastnamed)
1.16      schwarze  596:                return(mdoc_perr(m, line, 0, ETEXTPROL));
1.19      schwarze  597:
                    598:        /*
                    599:         * If in literal mode, then pass the buffer directly to the
                    600:         * back-end, as it should be preserved as a single term.
                    601:         */
1.1       kristaps  602:
1.19      schwarze  603:        if (MDOC_LITERAL & m->flags) {
                    604:                if ( ! mdoc_word_alloc(m, line, 0, buf))
                    605:                        return(0);
                    606:                m->next = MDOC_NEXT_SIBLING;
                    607:                return(1);
                    608:        }
                    609:
                    610:        /* Disallow blank/white-space lines in non-literal mode. */
                    611:
                    612:        for (i = 0; ' ' == buf[i]; i++)
                    613:                /* Skip leading whitespace. */ ;
                    614:        if (0 == buf[i])
1.16      schwarze  615:                return(mdoc_perr(m, line, 0, ENOBLANK));
1.1       kristaps  616:
1.19      schwarze  617:        /*
                    618:         * Break apart a free-form line into tokens.  Spaces are
                    619:         * stripped out of the input.
                    620:         */
                    621:
                    622:        for (j = i; buf[i]; i++) {
                    623:                if (' ' != buf[i])
                    624:                        continue;
                    625:
                    626:                /* Escaped whitespace. */
                    627:                if (i && ' ' == buf[i] && '\\' == buf[i - 1])
                    628:                        continue;
                    629:
                    630:                buf[i++] = 0;
                    631:                if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
                    632:                        return(0);
                    633:                m->next = MDOC_NEXT_SIBLING;
                    634:
                    635:                for ( ; ' ' == buf[i]; i++)
                    636:                        /* Skip trailing whitespace. */ ;
                    637:
                    638:                j = i;
                    639:                if (0 == buf[i])
                    640:                        break;
                    641:        }
                    642:
                    643:        if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
1.1       kristaps  644:                return(0);
                    645:
                    646:        m->next = MDOC_NEXT_SIBLING;
                    647:        return(1);
                    648: }
1.19      schwarze  649:
                    650:
1.1       kristaps  651:
                    652:
                    653: static int
                    654: macrowarn(struct mdoc *m, int ln, const char *buf)
                    655: {
                    656:        if ( ! (MDOC_IGN_MACRO & m->pflags))
1.13      schwarze  657:                return(mdoc_verr(m, ln, 1,
1.1       kristaps  658:                                "unknown macro: %s%s",
                    659:                                buf, strlen(buf) > 3 ? "..." : ""));
1.12      schwarze  660:        return(mdoc_vwarn(m, ln, 1, "unknown macro: %s%s",
1.1       kristaps  661:                                buf, strlen(buf) > 3 ? "..." : ""));
                    662: }
                    663:
                    664:
                    665: /*
                    666:  * Parse a macro line, that is, a line beginning with the control
                    667:  * character.
                    668:  */
                    669: int
                    670: parsemacro(struct mdoc *m, int ln, char *buf)
                    671: {
                    672:        int               i, c;
                    673:        char              mac[5];
                    674:
1.7       schwarze  675:        /* Empty lines are ignored. */
1.1       kristaps  676:
                    677:        if (0 == buf[1])
                    678:                return(1);
                    679:
                    680:        if (' ' == buf[1]) {
                    681:                i = 2;
                    682:                while (buf[i] && ' ' == buf[i])
                    683:                        i++;
                    684:                if (0 == buf[i])
                    685:                        return(1);
1.16      schwarze  686:                return(mdoc_perr(m, ln, 1, ESPACE));
1.1       kristaps  687:        }
                    688:
                    689:        /* Copy the first word into a nil-terminated buffer. */
                    690:
                    691:        for (i = 1; i < 5; i++) {
                    692:                if (0 == (mac[i - 1] = buf[i]))
                    693:                        break;
                    694:                else if (' ' == buf[i])
                    695:                        break;
                    696:        }
                    697:
                    698:        mac[i - 1] = 0;
                    699:
                    700:        if (i == 5 || i <= 2) {
                    701:                if ( ! macrowarn(m, ln, mac))
                    702:                        goto err;
                    703:                return(1);
                    704:        }
                    705:
                    706:        if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) {
                    707:                if ( ! macrowarn(m, ln, mac))
                    708:                        goto err;
                    709:                return(1);
                    710:        }
                    711:
                    712:        /* The macro is sane.  Jump to the next word. */
                    713:
                    714:        while (buf[i] && ' ' == buf[i])
                    715:                i++;
                    716:
                    717:        /* Begin recursive parse sequence. */
                    718:
                    719:        if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
                    720:                goto err;
                    721:
                    722:        return(1);
                    723:
                    724: err:   /* Error out. */
                    725:
                    726:        m->flags |= MDOC_HALT;
                    727:        return(0);
                    728: }