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

Annotation of mandoc/mdoc.c, Revision 1.119

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

CVSweb