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

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