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

Annotation of mandoc/mdoc.c, Revision 1.227

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

CVSweb