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

Annotation of mandoc/mdoc.c, Revision 1.203

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

CVSweb