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

Annotation of src/usr.bin/mandoc/mdoc_macro.c, Revision 1.107

1.107   ! schwarze    1: /*     $OpenBSD: mdoc_macro.c,v 1.106 2014/11/28 03:13:58 schwarze Exp $ */
1.1       kristaps    2: /*
1.74      schwarze    3:  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.99      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.2       schwarze    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.2       schwarze   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.100     schwarze   18: #include <sys/types.h>
                     19:
1.1       kristaps   20: #include <assert.h>
                     21: #include <ctype.h>
                     22: #include <stdlib.h>
                     23: #include <stdio.h>
                     24: #include <string.h>
1.26      schwarze   25: #include <time.h>
1.1       kristaps   26:
1.66      schwarze   27: #include "mdoc.h"
1.44      schwarze   28: #include "mandoc.h"
1.1       kristaps   29: #include "libmdoc.h"
1.39      schwarze   30: #include "libmandoc.h"
1.1       kristaps   31:
1.48      schwarze   32: enum   rew {   /* see rew_dohalt() */
                     33:        REWIND_NONE,
                     34:        REWIND_THIS,
                     35:        REWIND_MORE,
1.59      schwarze   36:        REWIND_FORCE,
1.48      schwarze   37:        REWIND_LATER,
1.54      schwarze   38:        REWIND_ERROR
1.35      schwarze   39: };
1.1       kristaps   40:
1.107   ! schwarze   41: static void            blk_full(MACRO_PROT_ARGS);
        !            42: static void            blk_exp_close(MACRO_PROT_ARGS);
        !            43: static void            blk_part_exp(MACRO_PROT_ARGS);
        !            44: static void            blk_part_imp(MACRO_PROT_ARGS);
        !            45: static void            ctx_synopsis(MACRO_PROT_ARGS);
        !            46: static void            in_line_eoln(MACRO_PROT_ARGS);
        !            47: static void            in_line_argn(MACRO_PROT_ARGS);
        !            48: static void            in_line(MACRO_PROT_ARGS);
        !            49: static void            phrase_ta(MACRO_PROT_ARGS);
1.36      schwarze   50:
1.106     schwarze   51: static void            dword(struct mdoc *, int, int, const char *,
1.80      schwarze   52:                                 enum mdelim, int);
1.106     schwarze   53: static void            append_delims(struct mdoc *, int, int *, char *);
1.36      schwarze   54: static enum mdoct      lookup(enum mdoct, const char *);
                     55: static enum mdoct      lookup_raw(const char *);
1.49      schwarze   56: static int             make_pending(struct mdoc_node *, enum mdoct,
1.47      schwarze   57:                                struct mdoc *, int, int);
1.107   ! schwarze   58: static void            phrase(struct mdoc *, int, int, char *);
1.88      schwarze   59: static enum mdoct      rew_alt(enum mdoct);
                     60: static enum rew        rew_dohalt(enum mdoct, enum mdoc_type,
1.36      schwarze   61:                                const struct mdoc_node *);
1.105     schwarze   62: static void            rew_elem(struct mdoc *, enum mdoct);
                     63: static void            rew_last(struct mdoc *, const struct mdoc_node *);
1.106     schwarze   64: static void            rew_sub(enum mdoc_type, struct mdoc *,
1.36      schwarze   65:                                enum mdoct, int, int);
1.1       kristaps   66:
                     67: const  struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
1.80      schwarze   68:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ap */
1.1       kristaps   69:        { in_line_eoln, MDOC_PROLOGUE }, /* Dd */
                     70:        { in_line_eoln, MDOC_PROLOGUE }, /* Dt */
                     71:        { in_line_eoln, MDOC_PROLOGUE }, /* Os */
1.80      schwarze   72:        { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Sh */
                     73:        { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Ss */
                     74:        { in_line_eoln, 0 }, /* Pp */
                     75:        { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* D1 */
                     76:        { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* Dl */
1.1       kristaps   77:        { blk_full, MDOC_EXPLICIT }, /* Bd */
1.80      schwarze   78:        { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ed */
1.1       kristaps   79:        { blk_full, MDOC_EXPLICIT }, /* Bl */
1.80      schwarze   80:        { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* El */
                     81:        { blk_full, MDOC_PARSED | MDOC_JOIN }, /* It */
                     82:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
                     83:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* An */
1.1       kristaps   84:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
1.86      schwarze   85:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Cd */
1.1       kristaps   86:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
1.80      schwarze   87:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
                     88:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
                     89:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
1.1       kristaps   90:        { in_line_eoln, 0 }, /* Ex */
1.80      schwarze   91:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
                     92:        { in_line_eoln, 0 }, /* Fd */
1.1       kristaps   93:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
1.80      schwarze   94:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
                     95:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
1.85      schwarze   96:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ic */
1.11      schwarze   97:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
1.80      schwarze   98:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Li */
                     99:        { blk_full, MDOC_JOIN }, /* Nd */
                    100:        { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
1.1       kristaps  101:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
1.89      schwarze  102:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ot */
1.1       kristaps  103:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
                    104:        { in_line_eoln, 0 }, /* Rv */
1.80      schwarze  105:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
1.1       kristaps  106:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
1.80      schwarze  107:        { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
1.28      schwarze  108:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
1.80      schwarze  109:        { in_line_eoln, MDOC_JOIN }, /* %A */
                    110:        { in_line_eoln, MDOC_JOIN }, /* %B */
                    111:        { in_line_eoln, MDOC_JOIN }, /* %D */
                    112:        { in_line_eoln, MDOC_JOIN }, /* %I */
                    113:        { in_line_eoln, MDOC_JOIN }, /* %J */
1.1       kristaps  114:        { in_line_eoln, 0 }, /* %N */
1.80      schwarze  115:        { in_line_eoln, MDOC_JOIN }, /* %O */
1.1       kristaps  116:        { in_line_eoln, 0 }, /* %P */
1.80      schwarze  117:        { in_line_eoln, MDOC_JOIN }, /* %R */
                    118:        { in_line_eoln, MDOC_JOIN }, /* %T */
1.1       kristaps  119:        { in_line_eoln, 0 }, /* %V */
1.80      schwarze  120:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    121:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Ac */
                    122:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    123:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Ao */
                    124:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Aq */
1.1       kristaps  125:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
1.80      schwarze  126:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    127:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Bc */
                    128:        { blk_full, MDOC_EXPLICIT }, /* Bf */
                    129:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    130:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Bo */
                    131:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Bq */
1.1       kristaps  132:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
                    133:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
                    134:        { in_line_eoln, 0 }, /* Db */
1.80      schwarze  135:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    136:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Dc */
                    137:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    138:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Do */
                    139:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Dq */
                    140:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ec */
                    141:        { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ef */
                    142:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Em */
1.1       kristaps  143:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
                    144:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
1.3       schwarze  145:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
1.100     schwarze  146:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* No */
1.80      schwarze  147:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED |
                    148:                        MDOC_IGNDELIM | MDOC_JOIN }, /* Ns */
1.1       kristaps  149:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
                    150:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
1.80      schwarze  151:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    152:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */
1.35      schwarze  153:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
1.80      schwarze  154:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    155:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Po */
                    156:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */
                    157:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    158:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */
                    159:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */
                    160:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    161:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */
                    162:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */
                    163:        { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */
1.1       kristaps  164:        { blk_full, MDOC_EXPLICIT }, /* Rs */
1.80      schwarze  165:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    166:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */
                    167:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    168:                        MDOC_EXPLICIT | MDOC_JOIN }, /* So */
                    169:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */
1.103     schwarze  170:        { in_line_argn, 0 }, /* Sm */
1.80      schwarze  171:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */
                    172:        { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */
1.1       kristaps  173:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
1.80      schwarze  174:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */
1.1       kristaps  175:        { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
                    176:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
1.80      schwarze  177:        { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
                    178:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    179:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */
                    180:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    181:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */
                    182:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    183:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */
1.1       kristaps  184:        { blk_full, MDOC_EXPLICIT }, /* Bk */
1.80      schwarze  185:        { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */
1.1       kristaps  186:        { in_line_eoln, 0 }, /* Bt */
                    187:        { in_line_eoln, 0 }, /* Hf */
1.89      schwarze  188:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fr */
1.1       kristaps  189:        { in_line_eoln, 0 }, /* Ud */
1.45      schwarze  190:        { in_line, 0 }, /* Lb */
1.80      schwarze  191:        { in_line_eoln, 0 }, /* Lp */
                    192:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
                    193:        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
                    194:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Brq */
                    195:        { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED |
                    196:                        MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */
                    197:        { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED |
                    198:                         MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */
                    199:        { in_line_eoln, MDOC_JOIN }, /* %C */
1.89      schwarze  200:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Es */
                    201:        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* En */
1.1       kristaps  202:        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
1.80      schwarze  203:        { in_line_eoln, MDOC_JOIN }, /* %Q */
1.13      schwarze  204:        { in_line_eoln, 0 }, /* br */
                    205:        { in_line_eoln, 0 }, /* sp */
1.25      schwarze  206:        { in_line_eoln, 0 }, /* %U */
1.80      schwarze  207:        { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */
1.99      schwarze  208:        { in_line_eoln, MDOC_PROLOGUE }, /* ll */
1.1       kristaps  209: };
                    210:
                    211: const  struct mdoc_macro * const mdoc_macros = __mdoc_macros;
                    212:
                    213:
                    214: /*
                    215:  * This is called at the end of parsing.  It must traverse up the tree,
                    216:  * closing out open [implicit] scopes.  Obviously, open explicit scopes
                    217:  * are errors.
                    218:  */
1.107   ! schwarze  219: void
1.76      schwarze  220: mdoc_macroend(struct mdoc *mdoc)
1.1       kristaps  221: {
                    222:        struct mdoc_node *n;
                    223:
                    224:        /* Scan for open explicit scopes. */
                    225:
1.107   ! schwarze  226:        n = mdoc->last->flags & MDOC_VALID ?
1.88      schwarze  227:            mdoc->last->parent : mdoc->last;
1.1       kristaps  228:
1.56      schwarze  229:        for ( ; n; n = n->parent)
1.107   ! schwarze  230:                if (n->type == MDOC_BLOCK &&
        !           231:                    mdoc_macros[n->tok].flags & MDOC_EXPLICIT)
1.94      schwarze  232:                        mandoc_msg(MANDOCERR_BLK_NOEND, mdoc->parse,
                    233:                            n->line, n->pos, mdoc_macronames[n->tok]);
1.1       kristaps  234:
1.22      schwarze  235:        /* Rewind to the first. */
                    236:
1.105     schwarze  237:        rew_last(mdoc, mdoc->first);
1.1       kristaps  238: }
                    239:
1.22      schwarze  240: /*
                    241:  * Look up a macro from within a subsequent context.
                    242:  */
1.36      schwarze  243: static enum mdoct
                    244: lookup(enum mdoct from, const char *p)
1.21      schwarze  245: {
                    246:
                    247:        if ( ! (MDOC_PARSED & mdoc_macros[from].flags))
                    248:                return(MDOC_MAX);
1.24      schwarze  249:        return(lookup_raw(p));
1.21      schwarze  250: }
                    251:
1.22      schwarze  252: /*
                    253:  * Lookup a macro following the initial line macro.
                    254:  */
1.36      schwarze  255: static enum mdoct
1.24      schwarze  256: lookup_raw(const char *p)
1.1       kristaps  257: {
1.36      schwarze  258:        enum mdoct       res;
1.1       kristaps  259:
1.24      schwarze  260:        if (MDOC_MAX == (res = mdoc_hash_find(p)))
1.21      schwarze  261:                return(MDOC_MAX);
                    262:        if (MDOC_CALLABLE & mdoc_macros[res].flags)
1.1       kristaps  263:                return(res);
                    264:        return(MDOC_MAX);
                    265: }
                    266:
1.105     schwarze  267: static void
1.22      schwarze  268: rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
1.1       kristaps  269: {
1.63      schwarze  270:        struct mdoc_node *n, *np;
1.1       kristaps  271:
                    272:        assert(to);
                    273:        mdoc->next = MDOC_NEXT_SIBLING;
                    274:        while (mdoc->last != to) {
1.63      schwarze  275:                /*
                    276:                 * Save the parent here, because we may delete the
1.76      schwarze  277:                 * mdoc->last node in the post-validation phase and reset
                    278:                 * it to mdoc->last->parent, causing a step in the closing
1.63      schwarze  279:                 * out to be lost.
                    280:                 */
                    281:                np = mdoc->last->parent;
1.105     schwarze  282:                mdoc_valid_post(mdoc);
1.61      schwarze  283:                n = mdoc->last;
1.63      schwarze  284:                mdoc->last = np;
1.1       kristaps  285:                assert(mdoc->last);
1.61      schwarze  286:                mdoc->last->last = n;
1.1       kristaps  287:        }
1.105     schwarze  288:        mdoc_valid_post(mdoc);
1.1       kristaps  289: }
                    290:
1.22      schwarze  291: /*
1.48      schwarze  292:  * For a block closing macro, return the corresponding opening one.
                    293:  * Otherwise, return the macro itself.
1.22      schwarze  294:  */
1.34      schwarze  295: static enum mdoct
                    296: rew_alt(enum mdoct tok)
1.1       kristaps  297: {
                    298:        switch (tok) {
1.88      schwarze  299:        case MDOC_Ac:
1.1       kristaps  300:                return(MDOC_Ao);
1.88      schwarze  301:        case MDOC_Bc:
1.1       kristaps  302:                return(MDOC_Bo);
1.88      schwarze  303:        case MDOC_Brc:
1.1       kristaps  304:                return(MDOC_Bro);
1.88      schwarze  305:        case MDOC_Dc:
1.1       kristaps  306:                return(MDOC_Do);
1.88      schwarze  307:        case MDOC_Ec:
1.1       kristaps  308:                return(MDOC_Eo);
1.88      schwarze  309:        case MDOC_Ed:
1.1       kristaps  310:                return(MDOC_Bd);
1.88      schwarze  311:        case MDOC_Ef:
1.1       kristaps  312:                return(MDOC_Bf);
1.88      schwarze  313:        case MDOC_Ek:
1.1       kristaps  314:                return(MDOC_Bk);
1.88      schwarze  315:        case MDOC_El:
1.1       kristaps  316:                return(MDOC_Bl);
1.88      schwarze  317:        case MDOC_Fc:
1.1       kristaps  318:                return(MDOC_Fo);
1.88      schwarze  319:        case MDOC_Oc:
1.1       kristaps  320:                return(MDOC_Oo);
1.88      schwarze  321:        case MDOC_Pc:
1.1       kristaps  322:                return(MDOC_Po);
1.88      schwarze  323:        case MDOC_Qc:
1.1       kristaps  324:                return(MDOC_Qo);
1.88      schwarze  325:        case MDOC_Re:
1.1       kristaps  326:                return(MDOC_Rs);
1.88      schwarze  327:        case MDOC_Sc:
1.1       kristaps  328:                return(MDOC_So);
1.88      schwarze  329:        case MDOC_Xc:
1.1       kristaps  330:                return(MDOC_Xo);
                    331:        default:
1.48      schwarze  332:                return(tok);
1.1       kristaps  333:        }
                    334:        /* NOTREACHED */
                    335: }
                    336:
1.48      schwarze  337: /*
                    338:  * Rewinding to tok, how do we have to handle *p?
                    339:  * REWIND_NONE: *p would delimit tok, but no tok scope is open
                    340:  *   inside *p, so there is no need to rewind anything at all.
                    341:  * REWIND_THIS: *p matches tok, so rewind *p and nothing else.
                    342:  * REWIND_MORE: *p is implicit, rewind it and keep searching for tok.
1.59      schwarze  343:  * REWIND_FORCE: *p is explicit, but tok is full, force rewinding *p.
1.48      schwarze  344:  * REWIND_LATER: *p is explicit and still open, postpone rewinding.
                    345:  * REWIND_ERROR: No tok block is open at all.
1.1       kristaps  346:  */
1.35      schwarze  347: static enum rew
1.88      schwarze  348: rew_dohalt(enum mdoct tok, enum mdoc_type type,
1.34      schwarze  349:                const struct mdoc_node *p)
1.1       kristaps  350: {
                    351:
1.50      schwarze  352:        /*
                    353:         * No matching token, no delimiting block, no broken block.
                    354:         * This can happen when full implicit macros are called for
                    355:         * the first time but try to rewind their previous
                    356:         * instance anyway.
                    357:         */
1.1       kristaps  358:        if (MDOC_ROOT == p->type)
1.48      schwarze  359:                return(MDOC_BLOCK == type &&
                    360:                    MDOC_EXPLICIT & mdoc_macros[tok].flags ?
                    361:                    REWIND_ERROR : REWIND_NONE);
1.50      schwarze  362:
                    363:        /*
1.88      schwarze  364:         * When starting to rewind, skip plain text
1.50      schwarze  365:         * and nodes that have already been rewound.
                    366:         */
1.48      schwarze  367:        if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)
                    368:                return(REWIND_MORE);
                    369:
1.50      schwarze  370:        /*
                    371:         * The easiest case:  Found a matching token.
                    372:         * This applies to both blocks and elements.
                    373:         */
1.48      schwarze  374:        tok = rew_alt(tok);
                    375:        if (tok == p->tok)
                    376:                return(p->end ? REWIND_NONE :
                    377:                    type == p->type ? REWIND_THIS : REWIND_MORE);
                    378:
1.50      schwarze  379:        /*
                    380:         * While elements do require rewinding for themselves,
                    381:         * they never affect rewinding of other nodes.
                    382:         */
1.48      schwarze  383:        if (MDOC_ELEM == p->type)
                    384:                return(REWIND_MORE);
1.1       kristaps  385:
1.50      schwarze  386:        /*
                    387:         * Blocks delimited by our target token get REWIND_MORE.
1.88      schwarze  388:         * Blocks delimiting our target token get REWIND_NONE.
1.50      schwarze  389:         */
1.1       kristaps  390:        switch (tok) {
1.88      schwarze  391:        case MDOC_Bl:
1.48      schwarze  392:                if (MDOC_It == p->tok)
                    393:                        return(REWIND_MORE);
1.1       kristaps  394:                break;
1.88      schwarze  395:        case MDOC_It:
1.1       kristaps  396:                if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
1.48      schwarze  397:                        return(REWIND_NONE);
1.1       kristaps  398:                break;
1.48      schwarze  399:        /*
                    400:         * XXX Badly nested block handling still fails badly
                    401:         * when one block is breaking two blocks of the same type.
                    402:         * This is an incomplete and extremely ugly workaround,
                    403:         * required to let the OpenBSD tree build.
                    404:         */
1.88      schwarze  405:        case MDOC_Oo:
1.48      schwarze  406:                if (MDOC_Op == p->tok)
                    407:                        return(REWIND_MORE);
1.1       kristaps  408:                break;
1.88      schwarze  409:        case MDOC_Nm:
1.51      schwarze  410:                return(REWIND_NONE);
1.88      schwarze  411:        case MDOC_Nd:
1.12      schwarze  412:                /* FALLTHROUGH */
1.88      schwarze  413:        case MDOC_Ss:
1.1       kristaps  414:                if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
1.48      schwarze  415:                        return(REWIND_NONE);
1.1       kristaps  416:                /* FALLTHROUGH */
1.88      schwarze  417:        case MDOC_Sh:
1.95      schwarze  418:                if (MDOC_ROOT == p->parent->type)
                    419:                        return(REWIND_THIS);
1.48      schwarze  420:                if (MDOC_Nd == p->tok || MDOC_Ss == p->tok ||
                    421:                    MDOC_Sh == p->tok)
                    422:                        return(REWIND_MORE);
1.1       kristaps  423:                break;
                    424:        default:
                    425:                break;
                    426:        }
                    427:
1.50      schwarze  428:        /*
                    429:         * Default block rewinding rules.
1.51      schwarze  430:         * In particular, always skip block end markers,
                    431:         * and let all blocks rewind Nm children.
1.102     schwarze  432:         * Do not warn again when closing a block,
                    433:         * since closing the body already warned.
1.50      schwarze  434:         */
1.54      schwarze  435:        if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||
1.102     schwarze  436:            MDOC_BLOCK == type || (MDOC_BLOCK == p->type &&
1.50      schwarze  437:            ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))
                    438:                return(REWIND_MORE);
                    439:
                    440:        /*
1.59      schwarze  441:         * By default, closing out full blocks
                    442:         * forces closing of broken explicit blocks,
                    443:         * while closing out partial blocks
                    444:         * allows delayed rewinding by default.
1.50      schwarze  445:         */
1.59      schwarze  446:        return (&blk_full == mdoc_macros[tok].fp ?
                    447:            REWIND_FORCE : REWIND_LATER);
1.1       kristaps  448: }
                    449:
1.105     schwarze  450: static void
1.34      schwarze  451: rew_elem(struct mdoc *mdoc, enum mdoct tok)
1.1       kristaps  452: {
                    453:        struct mdoc_node *n;
                    454:
                    455:        n = mdoc->last;
                    456:        if (MDOC_ELEM != n->type)
                    457:                n = n->parent;
                    458:        assert(MDOC_ELEM == n->type);
                    459:        assert(tok == n->tok);
1.105     schwarze  460:        rew_last(mdoc, n);
1.1       kristaps  461: }
                    462:
1.47      schwarze  463: /*
                    464:  * We are trying to close a block identified by tok,
                    465:  * but the child block *broken is still open.
                    466:  * Thus, postpone closing the tok block
                    467:  * until the rew_sub call closing *broken.
                    468:  */
                    469: static int
                    470: make_pending(struct mdoc_node *broken, enum mdoct tok,
1.76      schwarze  471:                struct mdoc *mdoc, int line, int ppos)
1.47      schwarze  472: {
                    473:        struct mdoc_node *breaker;
                    474:
                    475:        /*
                    476:         * Iterate backwards, searching for the block matching tok,
                    477:         * that is, the block breaking the *broken block.
                    478:         */
                    479:        for (breaker = broken->parent; breaker; breaker = breaker->parent) {
                    480:
                    481:                /*
                    482:                 * If the *broken block had already been broken before
                    483:                 * and we encounter its breaker, make the tok block
                    484:                 * pending on the inner breaker.
                    485:                 * Graphically, "[A breaker=[B broken=[C->B B] tok=A] C]"
                    486:                 * becomes "[A broken=[B [C->B B] tok=A] C]"
                    487:                 * and finally "[A [B->A [C->B B] A] C]".
                    488:                 */
                    489:                if (breaker == broken->pending) {
                    490:                        broken = breaker;
                    491:                        continue;
                    492:                }
                    493:
1.48      schwarze  494:                if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))
1.47      schwarze  495:                        continue;
                    496:                if (MDOC_BODY == broken->type)
                    497:                        broken = broken->parent;
                    498:
                    499:                /*
                    500:                 * Found the breaker.
                    501:                 * If another, outer breaker is already pending on
                    502:                 * the *broken block, we must not clobber the link
                    503:                 * to the outer breaker, but make it pending on the
                    504:                 * new, now inner breaker.
                    505:                 * Graphically, "[A breaker=[B broken=[C->A A] tok=B] C]"
                    506:                 * becomes "[A breaker=[B->A broken=[C A] tok=B] C]"
                    507:                 * and finally "[A [B->A [C->B A] B] C]".
                    508:                 */
                    509:                if (broken->pending) {
                    510:                        struct mdoc_node *taker;
                    511:
                    512:                        /*
                    513:                         * If the breaker had also been broken before,
                    514:                         * it cannot take on the outer breaker itself,
                    515:                         * but must hand it on to its own breakers.
                    516:                         * Graphically, this is the following situation:
                    517:                         * "[A [B breaker=[C->B B] broken=[D->A A] tok=C] D]"
                    518:                         * "[A taker=[B->A breaker=[C->B B] [D->C A] C] D]"
                    519:                         */
                    520:                        taker = breaker;
                    521:                        while (taker->pending)
                    522:                                taker = taker->pending;
                    523:                        taker->pending = broken->pending;
                    524:                }
                    525:                broken->pending = breaker;
1.94      schwarze  526:                mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse, line, ppos,
1.88      schwarze  527:                    "%s breaks %s", mdoc_macronames[tok],
                    528:                    mdoc_macronames[broken->tok]);
1.47      schwarze  529:                return(1);
                    530:        }
                    531:
                    532:        /*
                    533:         * Found no matching block for tok.
                    534:         * Are you trying to close a block that is not open?
                    535:         */
                    536:        return(0);
                    537: }
                    538:
1.106     schwarze  539: static void
1.88      schwarze  540: rew_sub(enum mdoc_type t, struct mdoc *mdoc,
1.34      schwarze  541:                enum mdoct tok, int line, int ppos)
1.1       kristaps  542: {
                    543:        struct mdoc_node *n;
                    544:
1.76      schwarze  545:        n = mdoc->last;
1.48      schwarze  546:        while (n) {
                    547:                switch (rew_dohalt(tok, t, n)) {
1.88      schwarze  548:                case REWIND_NONE:
1.106     schwarze  549:                        return;
1.88      schwarze  550:                case REWIND_THIS:
1.81      schwarze  551:                        n->lastline = line -
1.106     schwarze  552:                            (mdoc->flags & MDOC_NEWLINE &&
                    553:                             ! (mdoc_macros[tok].flags & MDOC_EXPLICIT));
1.48      schwarze  554:                        break;
1.88      schwarze  555:                case REWIND_FORCE:
1.94      schwarze  556:                        mandoc_vmsg(MANDOCERR_BLK_BROKEN, mdoc->parse,
1.88      schwarze  557:                            line, ppos, "%s breaks %s",
                    558:                            mdoc_macronames[tok],
                    559:                            mdoc_macronames[n->tok]);
1.59      schwarze  560:                        /* FALLTHROUGH */
1.88      schwarze  561:                case REWIND_MORE:
1.81      schwarze  562:                        n->lastline = line -
1.106     schwarze  563:                            (mdoc->flags & MDOC_NEWLINE ? 1 : 0);
1.48      schwarze  564:                        n = n->parent;
                    565:                        continue;
1.88      schwarze  566:                case REWIND_LATER:
1.76      schwarze  567:                        if (make_pending(n, tok, mdoc, line, ppos) ||
1.106     schwarze  568:                            t != MDOC_BLOCK)
                    569:                                return;
1.59      schwarze  570:                        /* FALLTHROUGH */
1.88      schwarze  571:                case REWIND_ERROR:
1.94      schwarze  572:                        mandoc_msg(MANDOCERR_BLK_NOTOPEN,
                    573:                            mdoc->parse, line, ppos,
                    574:                            mdoc_macronames[tok]);
1.106     schwarze  575:                        return;
1.22      schwarze  576:                }
1.48      schwarze  577:                break;
1.1       kristaps  578:        }
                    579:        assert(n);
1.105     schwarze  580:        rew_last(mdoc, n);
1.29      schwarze  581:
                    582:        /*
1.47      schwarze  583:         * The current block extends an enclosing block.
                    584:         * Now that the current block ends, close the enclosing block, too.
1.29      schwarze  585:         */
1.106     schwarze  586:        while ((n = n->pending) != NULL) {
1.105     schwarze  587:                rew_last(mdoc, n);
1.106     schwarze  588:                if (n->type == MDOC_HEAD)
                    589:                        mdoc_body_alloc(mdoc, n->line, n->pos, n->tok);
1.29      schwarze  590:        }
1.1       kristaps  591: }
                    592:
1.66      schwarze  593: /*
                    594:  * Allocate a word and check whether it's punctuation or not.
                    595:  * Punctuation consists of those tokens found in mdoc_isdelim().
                    596:  */
1.106     schwarze  597: static void
1.80      schwarze  598: dword(struct mdoc *mdoc, int line, int col, const char *p,
                    599:                enum mdelim d, int may_append)
1.66      schwarze  600: {
1.88      schwarze  601:
1.106     schwarze  602:        if (d == DELIM_MAX)
1.66      schwarze  603:                d = mdoc_isdelim(p);
                    604:
1.80      schwarze  605:        if (may_append &&
1.106     schwarze  606:            ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) &&
                    607:            d == DELIM_NONE && mdoc->last->type == MDOC_TEXT &&
                    608:            mdoc_isdelim(mdoc->last->string) == DELIM_NONE) {
1.80      schwarze  609:                mdoc_word_append(mdoc, p);
1.106     schwarze  610:                return;
1.80      schwarze  611:        }
                    612:
1.106     schwarze  613:        mdoc_word_alloc(mdoc, line, col, p);
1.66      schwarze  614:
1.71      schwarze  615:        /*
1.100     schwarze  616:         * If the word consists of a bare delimiter,
                    617:         * flag the new node accordingly,
                    618:         * unless doing so was vetoed by the invoking macro.
                    619:         * Always clear the veto, it is only valid for one word.
1.71      schwarze  620:         */
                    621:
1.100     schwarze  622:        if (d == DELIM_OPEN)
                    623:                mdoc->last->flags |= MDOC_DELIMO;
                    624:        else if (d == DELIM_CLOSE &&
                    625:            ! (mdoc->flags & MDOC_NODELIMC) &&
1.88      schwarze  626:            mdoc->last->parent->tok != MDOC_Fd)
1.76      schwarze  627:                mdoc->last->flags |= MDOC_DELIMC;
1.100     schwarze  628:        mdoc->flags &= ~MDOC_NODELIMC;
1.66      schwarze  629: }
1.1       kristaps  630:
1.106     schwarze  631: static void
1.76      schwarze  632: append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
1.1       kristaps  633: {
1.42      schwarze  634:        int              la;
1.36      schwarze  635:        enum margserr    ac;
1.1       kristaps  636:        char            *p;
                    637:
1.106     schwarze  638:        if (buf[*pos] == '\0')
                    639:                return;
1.1       kristaps  640:
                    641:        for (;;) {
1.42      schwarze  642:                la = *pos;
1.76      schwarze  643:                ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1.106     schwarze  644:                if (ac == ARGS_EOLN)
1.1       kristaps  645:                        break;
1.80      schwarze  646:                dword(mdoc, line, la, p, DELIM_MAX, 1);
1.43      schwarze  647:
1.42      schwarze  648:                /*
                    649:                 * If we encounter end-of-sentence symbols, then trigger
                    650:                 * the double-space.
                    651:                 *
1.68      schwarze  652:                 * XXX: it's easy to allow this to propagate outward to
1.42      schwarze  653:                 * the last symbol, such that `. )' will cause the
                    654:                 * correct double-spacing.  However, (1) groff isn't
                    655:                 * smart enough to do this and (2) it would require
                    656:                 * knowing which symbols break this behaviour, for
1.68      schwarze  657:                 * example, `.  ;' shouldn't propagate the double-space.
1.42      schwarze  658:                 */
1.106     schwarze  659:
1.84      schwarze  660:                if (mandoc_eos(p, strlen(p)))
1.76      schwarze  661:                        mdoc->last->flags |= MDOC_EOS;
1.1       kristaps  662:        }
                    663: }
                    664:
                    665: /*
1.88      schwarze  666:  * Close out block partial/full explicit.
1.1       kristaps  667:  */
1.107   ! schwarze  668: static void
1.1       kristaps  669: blk_exp_close(MACRO_PROT_ARGS)
                    670: {
1.47      schwarze  671:        struct mdoc_node *body;         /* Our own body. */
1.104     schwarze  672:        struct mdoc_node *endbody;      /* Our own end marker. */
1.47      schwarze  673:        struct mdoc_node *later;        /* A sub-block starting later. */
                    674:        struct mdoc_node *n;            /* For searching backwards. */
                    675:
1.88      schwarze  676:        int              j, lastarg, maxargs, flushed, nl;
1.36      schwarze  677:        enum margserr    ac;
1.47      schwarze  678:        enum mdoct       atok, ntok;
1.1       kristaps  679:        char            *p;
                    680:
1.76      schwarze  681:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze  682:
1.1       kristaps  683:        switch (tok) {
1.88      schwarze  684:        case MDOC_Ec:
1.1       kristaps  685:                maxargs = 1;
                    686:                break;
1.88      schwarze  687:        case MDOC_Ek:
1.82      schwarze  688:                mdoc->flags &= ~MDOC_KEEP;
1.107   ! schwarze  689:                /* FALLTHROUGH */
1.1       kristaps  690:        default:
                    691:                maxargs = 0;
                    692:                break;
                    693:        }
                    694:
1.47      schwarze  695:        /*
                    696:         * Search backwards for beginnings of blocks,
                    697:         * both of our own and of pending sub-blocks.
                    698:         */
1.107   ! schwarze  699:
1.47      schwarze  700:        atok = rew_alt(tok);
1.104     schwarze  701:        body = endbody = later = NULL;
1.76      schwarze  702:        for (n = mdoc->last; n; n = n->parent) {
1.106     schwarze  703:                if (n->flags & MDOC_VALID)
1.47      schwarze  704:                        continue;
                    705:
                    706:                /* Remember the start of our own body. */
1.107   ! schwarze  707:
1.106     schwarze  708:                if (n->type == MDOC_BODY && atok == n->tok) {
                    709:                        if (n->end == ENDBODY_NOT)
1.47      schwarze  710:                                body = n;
                    711:                        continue;
                    712:                }
                    713:
1.106     schwarze  714:                if (n->type != MDOC_BLOCK || n->tok == MDOC_Nm)
1.47      schwarze  715:                        continue;
                    716:                if (atok == n->tok) {
                    717:                        assert(body);
                    718:
                    719:                        /*
                    720:                         * Found the start of our own block.
                    721:                         * When there is no pending sub block,
                    722:                         * just proceed to closing out.
                    723:                         */
1.107   ! schwarze  724:
1.106     schwarze  725:                        if (later == NULL)
1.47      schwarze  726:                                break;
                    727:
1.88      schwarze  728:                        /*
1.47      schwarze  729:                         * When there is a pending sub block,
                    730:                         * postpone closing out the current block
                    731:                         * until the rew_sub() closing out the sub-block.
                    732:                         */
1.107   ! schwarze  733:
1.76      schwarze  734:                        make_pending(later, tok, mdoc, line, ppos);
1.47      schwarze  735:
                    736:                        /*
                    737:                         * Mark the place where the formatting - but not
                    738:                         * the scope - of the current block ends.
                    739:                         */
1.107   ! schwarze  740:
1.106     schwarze  741:                        mdoc_endbody_alloc(mdoc, line, ppos,
                    742:                            atok, body, ENDBODY_SPACE);
1.107   ! schwarze  743:
        !           744:                        /*
        !           745:                         * If a block closing macro taking arguments
        !           746:                         * breaks another block, put the arguments
        !           747:                         * into the end marker and remeber the
        !           748:                         * end marker in order to close it out.
        !           749:                         */
        !           750:
1.104     schwarze  751:                        if (maxargs) {
                    752:                                endbody = mdoc->last;
                    753:                                mdoc->next = MDOC_NEXT_CHILD;
                    754:                        }
1.47      schwarze  755:                        break;
                    756:                }
                    757:
                    758:                /*
                    759:                 * When finding an open sub block, remember the last
                    760:                 * open explicit block, or, in case there are only
                    761:                 * implicit ones, the first open implicit block.
                    762:                 */
1.107   ! schwarze  763:
1.47      schwarze  764:                if (later &&
1.106     schwarze  765:                    mdoc_macros[later->tok].flags & MDOC_EXPLICIT)
1.47      schwarze  766:                        continue;
1.106     schwarze  767:                if (n->tok != MDOC_It)
1.47      schwarze  768:                        later = n;
                    769:        }
1.107   ! schwarze  770:        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
1.47      schwarze  771:
1.106     schwarze  772:        if ( ! (mdoc_macros[tok].flags & MDOC_PARSED)) {
                    773:                if (buf[*pos] != '\0')
1.93      schwarze  774:                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                    775:                            mdoc->parse, line, ppos,
                    776:                            "%s %s", mdoc_macronames[tok],
                    777:                            buf + *pos);
1.106     schwarze  778:                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
1.107   ! schwarze  779:                return;
1.1       kristaps  780:        }
                    781:
1.104     schwarze  782:        if (maxargs && endbody == NULL) {
                    783:                if (n == NULL) {
                    784:                        /*
                    785:                         * Stray .Ec without previous .Eo:
                    786:                         * Break the output line, ignore any arguments.
                    787:                         */
1.106     schwarze  788:                        mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL);
1.105     schwarze  789:                        rew_elem(mdoc, MDOC_br);
1.106     schwarze  790:                } else
                    791:                        mdoc_tail_alloc(mdoc, line, ppos, atok);
1.104     schwarze  792:        }
1.1       kristaps  793:
1.104     schwarze  794:        flushed = n == NULL;
                    795:        for (j = 0; ; j++) {
1.1       kristaps  796:                lastarg = *pos;
                    797:
                    798:                if (j == maxargs && ! flushed) {
1.106     schwarze  799:                        if (endbody == NULL)
                    800:                                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                    801:                        else
1.105     schwarze  802:                                rew_last(mdoc, endbody);
1.1       kristaps  803:                        flushed = 1;
                    804:                }
                    805:
1.76      schwarze  806:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze  807:                if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1.1       kristaps  808:                        break;
                    809:
1.106     schwarze  810:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
1.36      schwarze  811:
1.106     schwarze  812:                if (ntok == MDOC_MAX) {
                    813:                        dword(mdoc, line, lastarg, p, DELIM_MAX,
                    814:                            MDOC_JOIN & mdoc_macros[tok].flags);
1.36      schwarze  815:                        continue;
                    816:                }
1.1       kristaps  817:
1.36      schwarze  818:                if ( ! flushed) {
1.106     schwarze  819:                        if (endbody == NULL)
                    820:                                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                    821:                        else
1.105     schwarze  822:                                rew_last(mdoc, endbody);
1.36      schwarze  823:                        flushed = 1;
                    824:                }
1.79      schwarze  825:                mdoc->flags &= ~MDOC_NEWLINE;
1.107   ! schwarze  826:                mdoc_macro(mdoc, ntok, line, lastarg, pos, buf);
1.36      schwarze  827:                break;
1.1       kristaps  828:        }
                    829:
1.105     schwarze  830:        if ( ! flushed) {
1.106     schwarze  831:                if (endbody == NULL)
                    832:                        rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                    833:                else
1.105     schwarze  834:                        rew_last(mdoc, endbody);
                    835:        }
1.106     schwarze  836:        if (nl)
                    837:                append_delims(mdoc, line, pos, buf);
1.1       kristaps  838: }
                    839:
1.107   ! schwarze  840: static void
1.1       kristaps  841: in_line(MACRO_PROT_ARGS)
                    842: {
1.100     schwarze  843:        int              la, scope, cnt, firstarg, mayopen, nc, nl;
1.36      schwarze  844:        enum margverr    av;
                    845:        enum mdoct       ntok;
                    846:        enum margserr    ac;
1.40      schwarze  847:        enum mdelim      d;
1.36      schwarze  848:        struct mdoc_arg *arg;
                    849:        char            *p;
1.1       kristaps  850:
1.76      schwarze  851:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze  852:
1.1       kristaps  853:        /*
                    854:         * Whether we allow ignored elements (those without content,
                    855:         * usually because of reserved words) to squeak by.
                    856:         */
1.32      schwarze  857:
1.1       kristaps  858:        switch (tok) {
1.88      schwarze  859:        case MDOC_An:
1.19      schwarze  860:                /* FALLTHROUGH */
1.88      schwarze  861:        case MDOC_Ar:
1.1       kristaps  862:                /* FALLTHROUGH */
1.88      schwarze  863:        case MDOC_Fl:
1.1       kristaps  864:                /* FALLTHROUGH */
1.88      schwarze  865:        case MDOC_Mt:
1.18      schwarze  866:                /* FALLTHROUGH */
1.88      schwarze  867:        case MDOC_Nm:
1.19      schwarze  868:                /* FALLTHROUGH */
1.88      schwarze  869:        case MDOC_Pa:
1.1       kristaps  870:                nc = 1;
                    871:                break;
                    872:        default:
                    873:                nc = 0;
                    874:                break;
                    875:        }
                    876:
1.20      schwarze  877:        for (arg = NULL;; ) {
1.1       kristaps  878:                la = *pos;
1.76      schwarze  879:                av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.107   ! schwarze  880:                if (av == ARGV_ARG)
        !           881:                        continue;
        !           882:                if (av == ARGV_WORD)
1.1       kristaps  883:                        *pos = la;
1.107   ! schwarze  884:                break;
1.1       kristaps  885:        }
                    886:
1.100     schwarze  887:        d = DELIM_NONE;
                    888:        firstarg = 1;
1.98      schwarze  889:        mayopen = 1;
1.45      schwarze  890:        for (cnt = scope = 0;; ) {
1.1       kristaps  891:                la = *pos;
1.76      schwarze  892:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1       kristaps  893:
1.100     schwarze  894:                /*
                    895:                 * At the end of a macro line,
                    896:                 * opening delimiters do not suppress spacing.
                    897:                 */
                    898:
                    899:                if (ac == ARGS_EOLN) {
                    900:                        if (d == DELIM_OPEN)
                    901:                                mdoc->last->flags &= ~MDOC_DELIMO;
1.1       kristaps  902:                        break;
1.100     schwarze  903:                }
                    904:
                    905:                /*
                    906:                 * The rest of the macro line is only punctuation,
                    907:                 * to be handled by append_delims().
                    908:                 * If there were no other arguments,
                    909:                 * do not allow the first one to suppress spacing,
                    910:                 * even if it turns out to be a closing one.
                    911:                 */
                    912:
                    913:                if (ac == ARGS_PUNCT) {
                    914:                        if (cnt == 0 && nc == 0)
                    915:                                mdoc->flags |= MDOC_NODELIMC;
1.1       kristaps  916:                        break;
1.100     schwarze  917:                }
1.1       kristaps  918:
1.101     schwarze  919:                ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ?
                    920:                    MDOC_MAX : lookup(tok, p);
1.1       kristaps  921:
1.88      schwarze  922:                /*
1.1       kristaps  923:                 * In this case, we've located a submacro and must
                    924:                 * execute it.  Close out scope, if open.  If no
                    925:                 * elements have been generated, either create one (nc)
                    926:                 * or raise a warning.
                    927:                 */
                    928:
1.106     schwarze  929:                if (ntok != MDOC_MAX) {
1.105     schwarze  930:                        if (scope)
                    931:                                rew_elem(mdoc, tok);
1.106     schwarze  932:                        if (nc && ! cnt) {
                    933:                                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.105     schwarze  934:                                rew_last(mdoc, mdoc->last);
1.106     schwarze  935:                        } else if ( ! nc && ! cnt) {
1.1       kristaps  936:                                mdoc_argv_free(arg);
1.92      schwarze  937:                                mandoc_msg(MANDOCERR_MACRO_EMPTY,
                    938:                                    mdoc->parse, line, ppos,
                    939:                                    mdoc_macronames[tok]);
1.1       kristaps  940:                        }
1.107   ! schwarze  941:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
1.106     schwarze  942:                        if (nl)
                    943:                                append_delims(mdoc, line, pos, buf);
1.107   ! schwarze  944:                        return;
1.88      schwarze  945:                }
1.1       kristaps  946:
1.88      schwarze  947:                /*
1.1       kristaps  948:                 * Non-quote-enclosed punctuation.  Set up our scope, if
                    949:                 * a word; rewind the scope, if a delimiter; then append
1.88      schwarze  950:                 * the word.
1.1       kristaps  951:                 */
                    952:
1.106     schwarze  953:                d = ac == ARGS_QWORD ? DELIM_NONE : mdoc_isdelim(p);
1.1       kristaps  954:
1.45      schwarze  955:                if (DELIM_NONE != d) {
                    956:                        /*
                    957:                         * If we encounter closing punctuation, no word
1.100     schwarze  958:                         * has been emitted, no scope is open, and we're
1.45      schwarze  959:                         * allowed to have an empty element, then start
1.98      schwarze  960:                         * a new scope.
1.45      schwarze  961:                         */
1.98      schwarze  962:                        if ((d == DELIM_CLOSE ||
                    963:                             (d == DELIM_MIDDLE && tok == MDOC_Fl)) &&
1.100     schwarze  964:                            !cnt && !scope && nc && mayopen) {
1.106     schwarze  965:                                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.45      schwarze  966:                                scope = 1;
1.98      schwarze  967:                                cnt++;
1.106     schwarze  968:                                if (tok == MDOC_Nm)
1.98      schwarze  969:                                        mayopen = 0;
1.45      schwarze  970:                        }
                    971:                        /*
                    972:                         * Close out our scope, if one is open, before
                    973:                         * any punctuation.
                    974:                         */
1.105     schwarze  975:                        if (scope)
                    976:                                rew_elem(mdoc, tok);
1.45      schwarze  977:                        scope = 0;
1.101     schwarze  978:                        if (tok == MDOC_Fn)
                    979:                                mayopen = 0;
1.98      schwarze  980:                } else if (mayopen && !scope) {
1.106     schwarze  981:                        mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.45      schwarze  982:                        scope = 1;
1.98      schwarze  983:                        cnt++;
1.1       kristaps  984:                }
1.66      schwarze  985:
1.106     schwarze  986:                dword(mdoc, line, la, p, d,
                    987:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.27      schwarze  988:
                    989:                /*
1.100     schwarze  990:                 * If the first argument is a closing delimiter,
                    991:                 * do not suppress spacing before it.
                    992:                 */
                    993:
                    994:                if (firstarg && d == DELIM_CLOSE && !nc)
                    995:                        mdoc->last->flags &= ~MDOC_DELIMC;
                    996:                firstarg = 0;
                    997:
                    998:                /*
1.27      schwarze  999:                 * `Fl' macros have their scope re-opened with each new
                   1000:                 * word so that the `-' can be added to each one without
                   1001:                 * having to parse out spaces.
                   1002:                 */
1.106     schwarze 1003:                if (scope && tok == MDOC_Fl) {
1.105     schwarze 1004:                        rew_elem(mdoc, tok);
1.45      schwarze 1005:                        scope = 0;
1.27      schwarze 1006:                }
1.1       kristaps 1007:        }
                   1008:
1.105     schwarze 1009:        if (scope)
                   1010:                rew_elem(mdoc, tok);
1.1       kristaps 1011:
                   1012:        /*
                   1013:         * If no elements have been collected and we're allowed to have
                   1014:         * empties (nc), open a scope and close it out.  Otherwise,
                   1015:         * raise a warning.
                   1016:         */
1.32      schwarze 1017:
1.106     schwarze 1018:        if ( ! cnt) {
                   1019:                if (nc) {
                   1020:                        mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
                   1021:                        rew_last(mdoc, mdoc->last);
                   1022:                } else {
                   1023:                        mdoc_argv_free(arg);
                   1024:                        mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
                   1025:                            line, ppos, mdoc_macronames[tok]);
                   1026:                }
1.1       kristaps 1027:        }
1.106     schwarze 1028:        if (nl)
                   1029:                append_delims(mdoc, line, pos, buf);
1.1       kristaps 1030: }
                   1031:
1.107   ! schwarze 1032: static void
1.1       kristaps 1033: blk_full(MACRO_PROT_ARGS)
                   1034: {
1.73      schwarze 1035:        int               la, nl, nparsed;
1.1       kristaps 1036:        struct mdoc_arg  *arg;
1.32      schwarze 1037:        struct mdoc_node *head; /* save of head macro */
1.34      schwarze 1038:        struct mdoc_node *body; /* save of body macro */
1.32      schwarze 1039:        struct mdoc_node *n;
1.36      schwarze 1040:        enum mdoct        ntok;
1.37      schwarze 1041:        enum margserr     ac, lac;
1.36      schwarze 1042:        enum margverr     av;
1.1       kristaps 1043:        char             *p;
                   1044:
1.76      schwarze 1045:        nl = MDOC_NEWLINE & mdoc->flags;
1.95      schwarze 1046:
                   1047:        /* Skip items outside lists. */
                   1048:
                   1049:        if (tok == MDOC_It) {
                   1050:                for (n = mdoc->last; n; n = n->parent)
1.97      schwarze 1051:                        if (n->tok == MDOC_Bl &&
                   1052:                            ! (n->flags & MDOC_VALID))
1.95      schwarze 1053:                                break;
                   1054:                if (n == NULL) {
                   1055:                        mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse,
                   1056:                            line, ppos, "It %s", buf + *pos);
1.106     schwarze 1057:                        mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL);
1.105     schwarze 1058:                        rew_elem(mdoc, MDOC_br);
1.107   ! schwarze 1059:                        return;
1.95      schwarze 1060:                }
                   1061:        }
1.43      schwarze 1062:
1.32      schwarze 1063:        /* Close out prior implicit scope. */
1.12      schwarze 1064:
1.106     schwarze 1065:        if ( ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)) {
                   1066:                rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1067:                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
1.1       kristaps 1068:        }
                   1069:
1.32      schwarze 1070:        /*
1.68      schwarze 1071:         * This routine accommodates implicitly- and explicitly-scoped
1.32      schwarze 1072:         * macro openings.  Implicit ones first close out prior scope
                   1073:         * (seen above).  Delay opening the head until necessary to
                   1074:         * allow leading punctuation to print.  Special consideration
                   1075:         * for `It -column', which has phrase-part syntax instead of
                   1076:         * regular child nodes.
                   1077:         */
                   1078:
1.1       kristaps 1079:        for (arg = NULL;; ) {
1.32      schwarze 1080:                la = *pos;
1.76      schwarze 1081:                av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.107   ! schwarze 1082:                if (av == ARGV_ARG)
        !          1083:                        continue;
        !          1084:                if (av == ARGV_WORD)
1.32      schwarze 1085:                        *pos = la;
1.107   ! schwarze 1086:                break;
1.1       kristaps 1087:        }
                   1088:
1.106     schwarze 1089:        mdoc_block_alloc(mdoc, line, ppos, tok, arg);
1.34      schwarze 1090:        head = body = NULL;
1.1       kristaps 1091:
1.32      schwarze 1092:        /*
1.73      schwarze 1093:         * Exception: Heads of `It' macros in `-diag' lists are not
                   1094:         * parsed, even though `It' macros in general are parsed.
                   1095:         */
1.107   ! schwarze 1096:
1.106     schwarze 1097:        nparsed = tok == MDOC_It &&
                   1098:            mdoc->last->parent->tok == MDOC_Bl &&
                   1099:            mdoc->last->parent->norm->Bl.type == LIST_diag;
1.73      schwarze 1100:
                   1101:        /*
1.32      schwarze 1102:         * The `Nd' macro has all arguments in its body: it's a hybrid
                   1103:         * of block partial-explicit and full-implicit.  Stupid.
                   1104:         */
1.12      schwarze 1105:
1.106     schwarze 1106:        if (tok == MDOC_Nd) {
                   1107:                head = mdoc_head_alloc(mdoc, line, ppos, tok);
                   1108:                rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1109:                body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.80      schwarze 1110:        }
                   1111:
1.106     schwarze 1112:        if (tok == MDOC_Bk)
1.80      schwarze 1113:                mdoc->flags |= MDOC_KEEP;
1.12      schwarze 1114:
1.106     schwarze 1115:        ac = ARGS_PEND;
                   1116:        for (;;) {
1.32      schwarze 1117:                la = *pos;
1.106     schwarze 1118:                lac = ac;
1.76      schwarze 1119:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1120:                if (ac == ARGS_PUNCT)
1.52      schwarze 1121:                        break;
1.106     schwarze 1122:                if (ac == ARGS_EOLN) {
                   1123:                        if (lac != ARGS_PPHRASE && lac != ARGS_PHRASE)
1.46      schwarze 1124:                                break;
                   1125:                        /*
                   1126:                         * This is necessary: if the last token on a
                   1127:                         * line is a `Ta' or tab, then we'll get
                   1128:                         * ARGS_EOLN, so we must be smart enough to
                   1129:                         * reopen our scope if the last parse was a
                   1130:                         * phrase or partial phrase.
                   1131:                         */
1.106     schwarze 1132:                        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1133:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1134:                        break;
1.41      schwarze 1135:                }
                   1136:
1.88      schwarze 1137:                /*
1.46      schwarze 1138:                 * Emit leading punctuation (i.e., punctuation before
                   1139:                 * the MDOC_HEAD) for non-phrase types.
                   1140:                 */
1.32      schwarze 1141:
1.106     schwarze 1142:                if (head == NULL &&
                   1143:                    ac != ARGS_PEND &&
                   1144:                    ac != ARGS_PHRASE &&
                   1145:                    ac != ARGS_PPHRASE &&
                   1146:                    ac != ARGS_QWORD &&
                   1147:                    mdoc_isdelim(p) == DELIM_OPEN) {
                   1148:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.32      schwarze 1149:                        continue;
                   1150:                }
                   1151:
1.46      schwarze 1152:                /* Open a head if one hasn't been opened. */
1.32      schwarze 1153:
1.106     schwarze 1154:                if (head == NULL)
                   1155:                        head = mdoc_head_alloc(mdoc, line, ppos, tok);
1.32      schwarze 1156:
1.106     schwarze 1157:                if (ac == ARGS_PHRASE ||
                   1158:                    ac == ARGS_PEND ||
                   1159:                    ac == ARGS_PPHRASE) {
1.107   ! schwarze 1160:
1.46      schwarze 1161:                        /*
                   1162:                         * If we haven't opened a body yet, rewind the
                   1163:                         * head; if we have, rewind that instead.
                   1164:                         */
                   1165:
1.106     schwarze 1166:                        rew_sub(body ? MDOC_BODY : MDOC_HEAD,
                   1167:                            mdoc, tok, line, ppos);
                   1168:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.46      schwarze 1169:
                   1170:                        /*
                   1171:                         * Process phrases: set whether we're in a
                   1172:                         * partial-phrase (this effects line handling)
                   1173:                         * then call down into the phrase parser.
                   1174:                         */
                   1175:
1.106     schwarze 1176:                        if (ac == ARGS_PPHRASE)
1.76      schwarze 1177:                                mdoc->flags |= MDOC_PPHRASE;
1.106     schwarze 1178:                        if (ac == ARGS_PEND && lac == ARGS_PPHRASE)
1.76      schwarze 1179:                                mdoc->flags |= MDOC_PPHRASE;
1.107   ! schwarze 1180:                        phrase(mdoc, line, la, buf);
1.76      schwarze 1181:                        mdoc->flags &= ~MDOC_PPHRASE;
1.1       kristaps 1182:                        continue;
                   1183:                }
                   1184:
1.106     schwarze 1185:                ntok = nparsed || ac == ARGS_QWORD ?
1.88      schwarze 1186:                    MDOC_MAX : lookup(tok, p);
1.36      schwarze 1187:
1.107   ! schwarze 1188:                if (ntok != MDOC_MAX) {
        !          1189:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
        !          1190:                        break;
1.32      schwarze 1191:                }
1.107   ! schwarze 1192:                dword(mdoc, line, la, p, DELIM_MAX,
        !          1193:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.32      schwarze 1194:        }
1.1       kristaps 1195:
1.106     schwarze 1196:        if (head == NULL)
                   1197:                head = mdoc_head_alloc(mdoc, line, ppos, tok);
                   1198:        if (nl)
                   1199:                append_delims(mdoc, line, pos, buf);
1.107   ! schwarze 1200:        if (body != NULL)
1.46      schwarze 1201:                goto out;
1.29      schwarze 1202:
                   1203:        /*
1.34      schwarze 1204:         * If there is an open (i.e., unvalidated) sub-block requiring
                   1205:         * explicit close-out, postpone switching the current block from
                   1206:         * head to body until the rew_sub() call closing out that
                   1207:         * sub-block.
1.29      schwarze 1208:         */
1.76      schwarze 1209:        for (n = mdoc->last; n && n != head; n = n->parent) {
1.107   ! schwarze 1210:                if (n->type == MDOC_BLOCK &&
        !          1211:                    mdoc_macros[n->tok].flags & MDOC_EXPLICIT &&
        !          1212:                    ! (n->flags & MDOC_VALID)) {
1.29      schwarze 1213:                        n->pending = head;
1.107   ! schwarze 1214:                        return;
1.29      schwarze 1215:                }
                   1216:        }
1.54      schwarze 1217:
1.32      schwarze 1218:        /* Close out scopes to remain in a consistent state. */
1.12      schwarze 1219:
1.106     schwarze 1220:        rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1221:        mdoc_body_alloc(mdoc, line, ppos, tok);
1.46      schwarze 1222: out:
1.106     schwarze 1223:        if (mdoc->flags & MDOC_FREECOL) {
                   1224:                rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1225:                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                   1226:                mdoc->flags &= ~MDOC_FREECOL;
                   1227:        }
1.1       kristaps 1228: }
                   1229:
1.107   ! schwarze 1230: static void
1.1       kristaps 1231: blk_part_imp(MACRO_PROT_ARGS)
                   1232: {
1.43      schwarze 1233:        int               la, nl;
1.36      schwarze 1234:        enum mdoct        ntok;
                   1235:        enum margserr     ac;
1.1       kristaps 1236:        char             *p;
1.32      schwarze 1237:        struct mdoc_node *blk; /* saved block context */
                   1238:        struct mdoc_node *body; /* saved body context */
                   1239:        struct mdoc_node *n;
1.1       kristaps 1240:
1.76      schwarze 1241:        nl = MDOC_NEWLINE & mdoc->flags;
1.43      schwarze 1242:
1.32      schwarze 1243:        /*
                   1244:         * A macro that spans to the end of the line.  This is generally
                   1245:         * (but not necessarily) called as the first macro.  The block
                   1246:         * has a head as the immediate child, which is always empty,
                   1247:         * followed by zero or more opening punctuation nodes, then the
                   1248:         * body (which may be empty, depending on the macro), then zero
                   1249:         * or more closing punctuation nodes.
                   1250:         */
1.22      schwarze 1251:
1.106     schwarze 1252:        blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
                   1253:        mdoc_head_alloc(mdoc, line, ppos, tok);
                   1254:        rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
1.1       kristaps 1255:
1.32      schwarze 1256:        /*
                   1257:         * Open the body scope "on-demand", that is, after we've
                   1258:         * processed all our the leading delimiters (open parenthesis,
                   1259:         * etc.).
                   1260:         */
1.1       kristaps 1261:
1.32      schwarze 1262:        for (body = NULL; ; ) {
1.22      schwarze 1263:                la = *pos;
1.76      schwarze 1264:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1265:                if (ac == ARGS_EOLN || ac == ARGS_PUNCT)
1.1       kristaps 1266:                        break;
                   1267:
1.106     schwarze 1268:                if (body == NULL && ac != ARGS_QWORD &&
                   1269:                    mdoc_isdelim(p) == DELIM_OPEN) {
                   1270:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.1       kristaps 1271:                        continue;
1.80      schwarze 1272:                }
1.1       kristaps 1273:
1.106     schwarze 1274:                if (body == NULL)
                   1275:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.32      schwarze 1276:
1.106     schwarze 1277:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
1.36      schwarze 1278:
1.107   ! schwarze 1279:                if (ntok != MDOC_MAX) {
        !          1280:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
        !          1281:                        break;
1.36      schwarze 1282:                }
1.107   ! schwarze 1283:                dword(mdoc, line, la, p, DELIM_MAX,
        !          1284:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.32      schwarze 1285:        }
1.106     schwarze 1286:        if (body == NULL)
                   1287:                body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1288:
1.47      schwarze 1289:        /*
                   1290:         * If there is an open sub-block requiring explicit close-out,
                   1291:         * postpone closing out the current block
                   1292:         * until the rew_sub() call closing out the sub-block.
                   1293:         */
1.107   ! schwarze 1294:
1.76      schwarze 1295:        for (n = mdoc->last; n && n != body && n != blk->parent;
1.88      schwarze 1296:             n = n->parent) {
1.106     schwarze 1297:                if (n->type == MDOC_BLOCK &&
                   1298:                    mdoc_macros[n->tok].flags & MDOC_EXPLICIT &&
                   1299:                    ! (n->flags & MDOC_VALID)) {
1.76      schwarze 1300:                        make_pending(n, tok, mdoc, line, ppos);
1.106     schwarze 1301:                        mdoc_endbody_alloc(mdoc, line, ppos,
                   1302:                            tok, body, ENDBODY_NOSPACE);
1.107   ! schwarze 1303:                        return;
1.47      schwarze 1304:                }
                   1305:        }
1.91      schwarze 1306:        assert(n == body);
1.106     schwarze 1307:        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1308:        if (nl)
                   1309:                append_delims(mdoc, line, pos, buf);
                   1310:        rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
1.74      schwarze 1311:
                   1312:        /* Move trailing .Ns out of scope. */
                   1313:
                   1314:        for (n = body->child; n && n->next; n = n->next)
                   1315:                /* Do nothing. */ ;
1.106     schwarze 1316:        if (n && n->tok == MDOC_Ns)
1.76      schwarze 1317:                mdoc_node_relink(mdoc, n);
1.1       kristaps 1318: }
                   1319:
1.107   ! schwarze 1320: static void
1.1       kristaps 1321: blk_part_exp(MACRO_PROT_ARGS)
                   1322: {
1.37      schwarze 1323:        int               la, nl;
1.36      schwarze 1324:        enum margserr     ac;
1.32      schwarze 1325:        struct mdoc_node *head; /* keep track of head */
                   1326:        struct mdoc_node *body; /* keep track of body */
1.1       kristaps 1327:        char             *p;
1.36      schwarze 1328:        enum mdoct        ntok;
1.1       kristaps 1329:
1.76      schwarze 1330:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze 1331:
1.32      schwarze 1332:        /*
                   1333:         * The opening of an explicit macro having zero or more leading
                   1334:         * punctuation nodes; a head with optional single element (the
                   1335:         * case of `Eo'); and a body that may be empty.
                   1336:         */
1.22      schwarze 1337:
1.106     schwarze 1338:        mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
1.32      schwarze 1339:        for (head = body = NULL; ; ) {
1.22      schwarze 1340:                la = *pos;
1.76      schwarze 1341:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1342:                if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1.1       kristaps 1343:                        break;
                   1344:
1.32      schwarze 1345:                /* Flush out leading punctuation. */
                   1346:
1.106     schwarze 1347:                if (head == NULL && ac != ARGS_QWORD &&
                   1348:                    mdoc_isdelim(p) == DELIM_OPEN) {
1.32      schwarze 1349:                        assert(NULL == body);
1.106     schwarze 1350:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.32      schwarze 1351:                        continue;
1.80      schwarze 1352:                }
1.32      schwarze 1353:
1.106     schwarze 1354:                if (head == NULL) {
                   1355:                        assert(body == NULL);
                   1356:                        head = mdoc_head_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1357:                }
                   1358:
1.32      schwarze 1359:                /*
                   1360:                 * `Eo' gobbles any data into the head, but most other
                   1361:                 * macros just immediately close out and begin the body.
                   1362:                 */
                   1363:
1.106     schwarze 1364:                if (body == NULL) {
1.32      schwarze 1365:                        assert(head);
                   1366:                        /* No check whether it's a macro! */
1.106     schwarze 1367:                        if (tok == MDOC_Eo)
                   1368:                                dword(mdoc, line, la, p, DELIM_MAX, 0);
                   1369:                        rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1370:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
                   1371:                        if (tok == MDOC_Eo)
1.32      schwarze 1372:                                continue;
                   1373:                }
1.106     schwarze 1374:                assert(head != NULL && body != NULL);
1.32      schwarze 1375:
1.106     schwarze 1376:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
1.107   ! schwarze 1377:                if (ntok != MDOC_MAX) {
        !          1378:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
        !          1379:                        break;
1.1       kristaps 1380:                }
1.107   ! schwarze 1381:                dword(mdoc, line, la, p, DELIM_MAX,
        !          1382:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.1       kristaps 1383:        }
                   1384:
1.32      schwarze 1385:        /* Clean-up to leave in a consistent state. */
                   1386:
1.106     schwarze 1387:        if (head == NULL)
                   1388:                mdoc_head_alloc(mdoc, line, ppos, tok);
1.22      schwarze 1389:
1.106     schwarze 1390:        if (body == NULL) {
                   1391:                rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1392:                mdoc_body_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1393:        }
1.106     schwarze 1394:        if (nl)
                   1395:                append_delims(mdoc, line, pos, buf);
1.1       kristaps 1396: }
                   1397:
1.107   ! schwarze 1398: static void
1.1       kristaps 1399: in_line_argn(MACRO_PROT_ARGS)
                   1400: {
1.37      schwarze 1401:        int              la, flushed, j, maxargs, nl;
1.36      schwarze 1402:        enum margserr    ac;
                   1403:        enum margverr    av;
                   1404:        struct mdoc_arg *arg;
                   1405:        char            *p;
                   1406:        enum mdoct       ntok;
1.1       kristaps 1407:
1.76      schwarze 1408:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze 1409:
1.32      schwarze 1410:        /*
                   1411:         * A line macro that has a fixed number of arguments (maxargs).
                   1412:         * Only open the scope once the first non-leading-punctuation is
                   1413:         * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
                   1414:         * keep it open until the maximum number of arguments are
                   1415:         * exhausted.
                   1416:         */
1.1       kristaps 1417:
                   1418:        switch (tok) {
1.88      schwarze 1419:        case MDOC_Ap:
1.1       kristaps 1420:                /* FALLTHROUGH */
1.88      schwarze 1421:        case MDOC_Ns:
1.1       kristaps 1422:                /* FALLTHROUGH */
1.88      schwarze 1423:        case MDOC_Ux:
1.1       kristaps 1424:                maxargs = 0;
                   1425:                break;
1.88      schwarze 1426:        case MDOC_Bx:
1.64      schwarze 1427:                /* FALLTHROUGH */
1.89      schwarze 1428:        case MDOC_Es:
                   1429:                /* FALLTHROUGH */
1.88      schwarze 1430:        case MDOC_Xr:
1.28      schwarze 1431:                maxargs = 2;
                   1432:                break;
1.1       kristaps 1433:        default:
                   1434:                maxargs = 1;
                   1435:                break;
                   1436:        }
                   1437:
1.32      schwarze 1438:        for (arg = NULL; ; ) {
1.22      schwarze 1439:                la = *pos;
1.76      schwarze 1440:                av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.107   ! schwarze 1441:                if (av == ARGV_ARG)
        !          1442:                        continue;
        !          1443:                if (av == ARGV_WORD)
1.22      schwarze 1444:                        *pos = la;
1.107   ! schwarze 1445:                break;
1.1       kristaps 1446:        }
                   1447:
1.32      schwarze 1448:        for (flushed = j = 0; ; ) {
1.22      schwarze 1449:                la = *pos;
1.76      schwarze 1450:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1451:                if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1.1       kristaps 1452:                        break;
                   1453:
1.106     schwarze 1454:                if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
                   1455:                    ac != ARGS_QWORD && j == 0 &&
                   1456:                    mdoc_isdelim(p) == DELIM_OPEN) {
                   1457:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.32      schwarze 1458:                        continue;
1.106     schwarze 1459:                } else if (j == 0)
                   1460:                       mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.32      schwarze 1461:
                   1462:                if (j == maxargs && ! flushed) {
1.105     schwarze 1463:                        rew_elem(mdoc, tok);
1.32      schwarze 1464:                        flushed = 1;
                   1465:                }
                   1466:
1.106     schwarze 1467:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
1.36      schwarze 1468:
1.106     schwarze 1469:                if (ntok != MDOC_MAX) {
1.105     schwarze 1470:                        if ( ! flushed)
                   1471:                                rew_elem(mdoc, tok);
1.1       kristaps 1472:                        flushed = 1;
1.107   ! schwarze 1473:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
1.32      schwarze 1474:                        j++;
1.1       kristaps 1475:                        break;
                   1476:                }
                   1477:
1.106     schwarze 1478:                if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
                   1479:                    ac != ARGS_QWORD && ! flushed &&
                   1480:                    mdoc_isdelim(p) != DELIM_NONE) {
1.105     schwarze 1481:                        rew_elem(mdoc, tok);
1.1       kristaps 1482:                        flushed = 1;
1.28      schwarze 1483:                }
                   1484:
1.106     schwarze 1485:                dword(mdoc, line, la, p, DELIM_MAX,
                   1486:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.32      schwarze 1487:                j++;
1.1       kristaps 1488:        }
                   1489:
1.106     schwarze 1490:        if (j == 0)
                   1491:                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.105     schwarze 1492:        if ( ! flushed)
                   1493:                rew_elem(mdoc, tok);
1.106     schwarze 1494:        if (nl)
                   1495:                append_delims(mdoc, line, pos, buf);
1.1       kristaps 1496: }
                   1497:
1.107   ! schwarze 1498: static void
1.1       kristaps 1499: in_line_eoln(MACRO_PROT_ARGS)
                   1500: {
1.36      schwarze 1501:        int              la;
                   1502:        enum margserr    ac;
                   1503:        enum margverr    av;
                   1504:        struct mdoc_arg *arg;
                   1505:        char            *p;
                   1506:        enum mdoct       ntok;
1.1       kristaps 1507:
                   1508:        assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
                   1509:
1.53      schwarze 1510:        if (tok == MDOC_Pp)
1.76      schwarze 1511:                rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos);
1.53      schwarze 1512:
1.22      schwarze 1513:        /* Parse macro arguments. */
1.1       kristaps 1514:
1.22      schwarze 1515:        for (arg = NULL; ; ) {
1.1       kristaps 1516:                la = *pos;
1.76      schwarze 1517:                av = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.107   ! schwarze 1518:                if (av == ARGV_ARG)
        !          1519:                        continue;
        !          1520:                if (av == ARGV_WORD)
1.1       kristaps 1521:                        *pos = la;
1.107   ! schwarze 1522:                break;
1.1       kristaps 1523:        }
                   1524:
1.22      schwarze 1525:        /* Open element scope. */
                   1526:
1.106     schwarze 1527:        mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.1       kristaps 1528:
1.22      schwarze 1529:        /* Parse argument terms. */
1.1       kristaps 1530:
                   1531:        for (;;) {
                   1532:                la = *pos;
1.76      schwarze 1533:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1534:                if (ac == ARGS_EOLN)
1.1       kristaps 1535:                        break;
                   1536:
1.106     schwarze 1537:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
1.1       kristaps 1538:
1.107   ! schwarze 1539:                if (ntok != MDOC_MAX) {
        !          1540:                        rew_elem(mdoc, tok);
        !          1541:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
        !          1542:                        return;
1.36      schwarze 1543:                }
1.107   ! schwarze 1544:                dword(mdoc, line, la, p, DELIM_MAX,
        !          1545:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.1       kristaps 1546:        }
                   1547:
1.22      schwarze 1548:        /* Close out (no delimiters). */
                   1549:
1.105     schwarze 1550:        rew_elem(mdoc, tok);
1.28      schwarze 1551: }
                   1552:
1.107   ! schwarze 1553: static void
1.28      schwarze 1554: ctx_synopsis(MACRO_PROT_ARGS)
                   1555: {
1.37      schwarze 1556:
1.107   ! schwarze 1557:        if (~mdoc->flags & (MDOC_SYNOPSIS | MDOC_NEWLINE))
        !          1558:                in_line(mdoc, tok, line, ppos, pos, buf);
        !          1559:        else if (tok == MDOC_Nm)
        !          1560:                blk_full(mdoc, tok, line, ppos, pos, buf);
        !          1561:        else {
        !          1562:                assert(tok == MDOC_Vt);
        !          1563:                blk_part_imp(mdoc, tok, line, ppos, pos, buf);
        !          1564:        }
1.1       kristaps 1565: }
                   1566:
1.17      schwarze 1567: /*
                   1568:  * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
                   1569:  * They're unusual because they're basically free-form text until a
                   1570:  * macro is encountered.
                   1571:  */
1.107   ! schwarze 1572: static void
1.76      schwarze 1573: phrase(struct mdoc *mdoc, int line, int ppos, char *buf)
1.1       kristaps 1574: {
1.36      schwarze 1575:        int              la, pos;
1.46      schwarze 1576:        enum margserr    ac;
1.36      schwarze 1577:        enum mdoct       ntok;
                   1578:        char            *p;
1.1       kristaps 1579:
1.17      schwarze 1580:        for (pos = ppos; ; ) {
                   1581:                la = pos;
1.1       kristaps 1582:
1.76      schwarze 1583:                ac = mdoc_zargs(mdoc, line, &pos, buf, &p);
1.106     schwarze 1584:                if (ac == ARGS_EOLN)
1.17      schwarze 1585:                        break;
1.1       kristaps 1586:
1.106     schwarze 1587:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup_raw(p);
1.1       kristaps 1588:
1.107   ! schwarze 1589:                if (ntok != MDOC_MAX) {
        !          1590:                        mdoc_macro(mdoc, ntok, line, la, &pos, buf);
        !          1591:                        append_delims(mdoc, line, &pos, buf);
        !          1592:                        return;
1.36      schwarze 1593:                }
1.107   ! schwarze 1594:                dword(mdoc, line, la, p, DELIM_MAX, 1);
1.1       kristaps 1595:        }
                   1596: }
1.17      schwarze 1597:
1.107   ! schwarze 1598: static void
1.46      schwarze 1599: phrase_ta(MACRO_PROT_ARGS)
                   1600: {
1.78      schwarze 1601:        struct mdoc_node *n;
1.46      schwarze 1602:        int               la;
                   1603:        enum mdoct        ntok;
                   1604:        enum margserr     ac;
                   1605:        char             *p;
                   1606:
1.78      schwarze 1607:        /* Make sure we are in a column list or ignore this macro. */
1.107   ! schwarze 1608:
1.78      schwarze 1609:        n = mdoc->last;
1.107   ! schwarze 1610:        while (n != NULL && n->tok != MDOC_Bl)
1.78      schwarze 1611:                n = n->parent;
1.107   ! schwarze 1612:        if (n == NULL || n->norm->Bl.type != LIST_column) {
1.94      schwarze 1613:                mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse,
1.96      schwarze 1614:                    line, ppos, "Ta");
1.107   ! schwarze 1615:                return;
1.78      schwarze 1616:        }
1.46      schwarze 1617:
1.78      schwarze 1618:        /* Advance to the next column. */
1.106     schwarze 1619:
                   1620:        rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos);
                   1621:        mdoc_body_alloc(mdoc, line, ppos, MDOC_It);
1.46      schwarze 1622:
                   1623:        for (;;) {
                   1624:                la = *pos;
1.76      schwarze 1625:                ac = mdoc_zargs(mdoc, line, pos, buf, &p);
1.106     schwarze 1626:                if (ac == ARGS_EOLN)
1.46      schwarze 1627:                        break;
                   1628:
1.106     schwarze 1629:                ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup_raw(p);
1.46      schwarze 1630:
1.107   ! schwarze 1631:                if (ntok != MDOC_MAX) {
        !          1632:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
        !          1633:                        append_delims(mdoc, line, pos, buf);
        !          1634:                        return;
1.46      schwarze 1635:                }
1.107   ! schwarze 1636:                dword(mdoc, line, la, p, DELIM_MAX,
        !          1637:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.46      schwarze 1638:        }
                   1639: }