[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.122

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