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

1.114   ! schwarze    1: /*     $OpenBSD: mdoc_macro.c,v 1.113 2014/12/13 13:13:26 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:                /*
1.114   ! schwarze  479:                 * If the *broken block (Z) is already broken and we
        !           480:                 * encounter its breaker (B), make the tok block (A)
        !           481:                 * pending on that inner breaker (B).
        !           482:                 * Graphically, [A breaker=[B! broken=[Z->B B] tok=A] Z]
        !           483:                 * becomes breaker=[A broken=[B! [Z->B B] tok=A] Z]
        !           484:                 * and finally [A! [B!->A [Z->B B] A] Z].
        !           485:                 * In these graphics, "->" indicates the "pending"
        !           486:                 * pointer and "!" indicates the MDOC_BREAK flag.
        !           487:                 * Each of the cases gets one additional pointer (B->A)
        !           488:                 * and one additional flag (A!).
1.47      schwarze  489:                 */
                    490:                if (breaker == broken->pending) {
                    491:                        broken = breaker;
                    492:                        continue;
                    493:                }
                    494:
1.48      schwarze  495:                if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))
1.47      schwarze  496:                        continue;
                    497:                if (MDOC_BODY == broken->type)
                    498:                        broken = broken->parent;
                    499:
                    500:                /*
                    501:                 * Found the breaker.
1.114   ! schwarze  502:                 * If another, outer breaker (X) is already pending on
        !           503:                 * the *broken block (B), we must not clobber the link
1.47      schwarze  504:                 * to the outer breaker, but make it pending on the
1.114   ! schwarze  505:                 * new, now inner breaker (A).
        !           506:                 * Graphically, [X! breaker=[A broken=[B->X X] tok=A] B]
        !           507:                 * becomes [X! breaker=[A->X broken=[B X] tok=A] B]
        !           508:                 * and finally [X! [A!->X [B->A X] A] B].
1.47      schwarze  509:                 */
                    510:                if (broken->pending) {
                    511:                        struct mdoc_node *taker;
                    512:
                    513:                        /*
1.114   ! schwarze  514:                         * If the inner breaker (A) is already broken,
        !           515:                         * too, it cannot take on the outer breaker (X)
        !           516:                         * but must hand it on to its own breakers (Y):
        !           517:                         * [X! [Y! breaker=[A->Y Y] broken=[B->X X] tok=A] B]
        !           518:                         * [X! take=[Y!->X brea=[A->Y Y] brok=[B X] tok=A] B]
        !           519:                         * and finally [X! [Y!->X [A!->Y Y] [B->A X] A] B].
1.47      schwarze  520:                         */
                    521:                        taker = breaker;
                    522:                        while (taker->pending)
                    523:                                taker = taker->pending;
                    524:                        taker->pending = broken->pending;
                    525:                }
1.114   ! schwarze  526:
        !           527:                /*
        !           528:                 * Now we have reduced the situation to the simplest
        !           529:                 * case, which is just breaker=[A broken=[B tok=A] B]
        !           530:                 * and becomes [A! [B->A A] B].
        !           531:                 */
1.47      schwarze  532:                broken->pending = breaker;
1.114   ! schwarze  533:                breaker->flags |= MDOC_BREAK;
1.94      schwarze  534:                mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse, line, ppos,
1.88      schwarze  535:                    "%s breaks %s", mdoc_macronames[tok],
                    536:                    mdoc_macronames[broken->tok]);
1.47      schwarze  537:                return(1);
                    538:        }
                    539:
                    540:        /*
                    541:         * Found no matching block for tok.
                    542:         * Are you trying to close a block that is not open?
                    543:         */
                    544:        return(0);
                    545: }
                    546:
1.106     schwarze  547: static void
1.88      schwarze  548: rew_sub(enum mdoc_type t, struct mdoc *mdoc,
1.34      schwarze  549:                enum mdoct tok, int line, int ppos)
1.1       kristaps  550: {
                    551:        struct mdoc_node *n;
                    552:
1.76      schwarze  553:        n = mdoc->last;
1.48      schwarze  554:        while (n) {
                    555:                switch (rew_dohalt(tok, t, n)) {
1.88      schwarze  556:                case REWIND_NONE:
1.106     schwarze  557:                        return;
1.88      schwarze  558:                case REWIND_THIS:
1.81      schwarze  559:                        n->lastline = line -
1.106     schwarze  560:                            (mdoc->flags & MDOC_NEWLINE &&
                    561:                             ! (mdoc_macros[tok].flags & MDOC_EXPLICIT));
1.48      schwarze  562:                        break;
1.88      schwarze  563:                case REWIND_FORCE:
1.94      schwarze  564:                        mandoc_vmsg(MANDOCERR_BLK_BROKEN, mdoc->parse,
1.88      schwarze  565:                            line, ppos, "%s breaks %s",
                    566:                            mdoc_macronames[tok],
                    567:                            mdoc_macronames[n->tok]);
1.59      schwarze  568:                        /* FALLTHROUGH */
1.88      schwarze  569:                case REWIND_MORE:
1.81      schwarze  570:                        n->lastline = line -
1.106     schwarze  571:                            (mdoc->flags & MDOC_NEWLINE ? 1 : 0);
1.48      schwarze  572:                        n = n->parent;
                    573:                        continue;
1.88      schwarze  574:                case REWIND_LATER:
1.76      schwarze  575:                        if (make_pending(n, tok, mdoc, line, ppos) ||
1.106     schwarze  576:                            t != MDOC_BLOCK)
                    577:                                return;
1.59      schwarze  578:                        /* FALLTHROUGH */
1.88      schwarze  579:                case REWIND_ERROR:
1.94      schwarze  580:                        mandoc_msg(MANDOCERR_BLK_NOTOPEN,
                    581:                            mdoc->parse, line, ppos,
                    582:                            mdoc_macronames[tok]);
1.106     schwarze  583:                        return;
1.22      schwarze  584:                }
1.48      schwarze  585:                break;
1.1       kristaps  586:        }
                    587:        assert(n);
1.105     schwarze  588:        rew_last(mdoc, n);
1.29      schwarze  589:
                    590:        /*
1.47      schwarze  591:         * The current block extends an enclosing block.
                    592:         * Now that the current block ends, close the enclosing block, too.
1.29      schwarze  593:         */
1.106     schwarze  594:        while ((n = n->pending) != NULL) {
1.105     schwarze  595:                rew_last(mdoc, n);
1.106     schwarze  596:                if (n->type == MDOC_HEAD)
                    597:                        mdoc_body_alloc(mdoc, n->line, n->pos, n->tok);
1.29      schwarze  598:        }
1.1       kristaps  599: }
                    600:
1.66      schwarze  601: /*
                    602:  * Allocate a word and check whether it's punctuation or not.
                    603:  * Punctuation consists of those tokens found in mdoc_isdelim().
                    604:  */
1.106     schwarze  605: static void
1.80      schwarze  606: dword(struct mdoc *mdoc, int line, int col, const char *p,
                    607:                enum mdelim d, int may_append)
1.66      schwarze  608: {
1.88      schwarze  609:
1.106     schwarze  610:        if (d == DELIM_MAX)
1.66      schwarze  611:                d = mdoc_isdelim(p);
                    612:
1.80      schwarze  613:        if (may_append &&
1.106     schwarze  614:            ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) &&
                    615:            d == DELIM_NONE && mdoc->last->type == MDOC_TEXT &&
                    616:            mdoc_isdelim(mdoc->last->string) == DELIM_NONE) {
1.80      schwarze  617:                mdoc_word_append(mdoc, p);
1.106     schwarze  618:                return;
1.80      schwarze  619:        }
                    620:
1.106     schwarze  621:        mdoc_word_alloc(mdoc, line, col, p);
1.66      schwarze  622:
1.71      schwarze  623:        /*
1.100     schwarze  624:         * If the word consists of a bare delimiter,
                    625:         * flag the new node accordingly,
                    626:         * unless doing so was vetoed by the invoking macro.
                    627:         * Always clear the veto, it is only valid for one word.
1.71      schwarze  628:         */
                    629:
1.100     schwarze  630:        if (d == DELIM_OPEN)
                    631:                mdoc->last->flags |= MDOC_DELIMO;
                    632:        else if (d == DELIM_CLOSE &&
                    633:            ! (mdoc->flags & MDOC_NODELIMC) &&
1.88      schwarze  634:            mdoc->last->parent->tok != MDOC_Fd)
1.76      schwarze  635:                mdoc->last->flags |= MDOC_DELIMC;
1.100     schwarze  636:        mdoc->flags &= ~MDOC_NODELIMC;
1.66      schwarze  637: }
1.1       kristaps  638:
1.106     schwarze  639: static void
1.76      schwarze  640: append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
1.1       kristaps  641: {
1.109     schwarze  642:        char            *p;
1.42      schwarze  643:        int              la;
1.1       kristaps  644:
1.106     schwarze  645:        if (buf[*pos] == '\0')
                    646:                return;
1.1       kristaps  647:
                    648:        for (;;) {
1.42      schwarze  649:                la = *pos;
1.109     schwarze  650:                if (mdoc_args(mdoc, line, pos, buf, MDOC_MAX, &p) == ARGS_EOLN)
1.1       kristaps  651:                        break;
1.80      schwarze  652:                dword(mdoc, line, la, p, DELIM_MAX, 1);
1.43      schwarze  653:
1.42      schwarze  654:                /*
                    655:                 * If we encounter end-of-sentence symbols, then trigger
                    656:                 * the double-space.
                    657:                 *
1.68      schwarze  658:                 * XXX: it's easy to allow this to propagate outward to
1.42      schwarze  659:                 * the last symbol, such that `. )' will cause the
                    660:                 * correct double-spacing.  However, (1) groff isn't
                    661:                 * smart enough to do this and (2) it would require
                    662:                 * knowing which symbols break this behaviour, for
1.68      schwarze  663:                 * example, `.  ;' shouldn't propagate the double-space.
1.42      schwarze  664:                 */
1.106     schwarze  665:
1.84      schwarze  666:                if (mandoc_eos(p, strlen(p)))
1.76      schwarze  667:                        mdoc->last->flags |= MDOC_EOS;
1.1       kristaps  668:        }
                    669: }
                    670:
                    671: /*
1.109     schwarze  672:  * Parse one word.
                    673:  * If it is a macro, call it and return 1.
                    674:  * Otherwise, allocate it and return 0.
                    675:  */
                    676: static int
                    677: macro_or_word(MACRO_PROT_ARGS, int parsed)
                    678: {
                    679:        char            *p;
                    680:        enum mdoct       ntok;
                    681:
                    682:        p = buf + ppos;
                    683:        ntok = MDOC_MAX;
1.113     schwarze  684:        if (*p == '"')
1.109     schwarze  685:                p++;
1.113     schwarze  686:        else if (parsed && ! (mdoc->flags & MDOC_PHRASELIT))
1.111     schwarze  687:                ntok = lookup(mdoc, tok, line, ppos, p);
1.109     schwarze  688:
                    689:        if (ntok == MDOC_MAX) {
                    690:                dword(mdoc, line, ppos, p, DELIM_MAX, tok == MDOC_MAX ||
                    691:                    mdoc_macros[tok].flags & MDOC_JOIN);
                    692:                return(0);
                    693:        } else {
                    694:                if (mdoc_macros[tok].fp == in_line_eoln)
                    695:                        rew_elem(mdoc, tok);
                    696:                mdoc_macro(mdoc, ntok, line, ppos, pos, buf);
                    697:                if (tok == MDOC_MAX)
                    698:                        append_delims(mdoc, line, pos, buf);
                    699:                return(1);
                    700:        }
                    701: }
                    702:
                    703: /*
1.88      schwarze  704:  * Close out block partial/full explicit.
1.1       kristaps  705:  */
1.107     schwarze  706: static void
1.1       kristaps  707: blk_exp_close(MACRO_PROT_ARGS)
                    708: {
1.47      schwarze  709:        struct mdoc_node *body;         /* Our own body. */
1.104     schwarze  710:        struct mdoc_node *endbody;      /* Our own end marker. */
1.47      schwarze  711:        struct mdoc_node *later;        /* A sub-block starting later. */
                    712:        struct mdoc_node *n;            /* For searching backwards. */
                    713:
1.88      schwarze  714:        int              j, lastarg, maxargs, flushed, nl;
1.36      schwarze  715:        enum margserr    ac;
1.47      schwarze  716:        enum mdoct       atok, ntok;
1.1       kristaps  717:        char            *p;
                    718:
1.76      schwarze  719:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze  720:
1.1       kristaps  721:        switch (tok) {
1.88      schwarze  722:        case MDOC_Ec:
1.1       kristaps  723:                maxargs = 1;
                    724:                break;
1.88      schwarze  725:        case MDOC_Ek:
1.82      schwarze  726:                mdoc->flags &= ~MDOC_KEEP;
1.107     schwarze  727:                /* FALLTHROUGH */
1.1       kristaps  728:        default:
                    729:                maxargs = 0;
                    730:                break;
                    731:        }
                    732:
1.47      schwarze  733:        /*
                    734:         * Search backwards for beginnings of blocks,
                    735:         * both of our own and of pending sub-blocks.
                    736:         */
1.107     schwarze  737:
1.47      schwarze  738:        atok = rew_alt(tok);
1.104     schwarze  739:        body = endbody = later = NULL;
1.76      schwarze  740:        for (n = mdoc->last; n; n = n->parent) {
1.106     schwarze  741:                if (n->flags & MDOC_VALID)
1.47      schwarze  742:                        continue;
                    743:
                    744:                /* Remember the start of our own body. */
1.107     schwarze  745:
1.106     schwarze  746:                if (n->type == MDOC_BODY && atok == n->tok) {
                    747:                        if (n->end == ENDBODY_NOT)
1.47      schwarze  748:                                body = n;
                    749:                        continue;
                    750:                }
                    751:
1.106     schwarze  752:                if (n->type != MDOC_BLOCK || n->tok == MDOC_Nm)
1.47      schwarze  753:                        continue;
                    754:                if (atok == n->tok) {
                    755:                        assert(body);
                    756:
                    757:                        /*
                    758:                         * Found the start of our own block.
                    759:                         * When there is no pending sub block,
                    760:                         * just proceed to closing out.
                    761:                         */
1.107     schwarze  762:
1.106     schwarze  763:                        if (later == NULL)
1.47      schwarze  764:                                break;
                    765:
1.88      schwarze  766:                        /*
1.47      schwarze  767:                         * When there is a pending sub block,
                    768:                         * postpone closing out the current block
                    769:                         * until the rew_sub() closing out the sub-block.
                    770:                         */
1.107     schwarze  771:
1.76      schwarze  772:                        make_pending(later, tok, mdoc, line, ppos);
1.47      schwarze  773:
                    774:                        /*
                    775:                         * Mark the place where the formatting - but not
                    776:                         * the scope - of the current block ends.
                    777:                         */
1.107     schwarze  778:
1.106     schwarze  779:                        mdoc_endbody_alloc(mdoc, line, ppos,
                    780:                            atok, body, ENDBODY_SPACE);
1.107     schwarze  781:
                    782:                        /*
                    783:                         * If a block closing macro taking arguments
                    784:                         * breaks another block, put the arguments
                    785:                         * into the end marker and remeber the
                    786:                         * end marker in order to close it out.
                    787:                         */
                    788:
1.104     schwarze  789:                        if (maxargs) {
                    790:                                endbody = mdoc->last;
                    791:                                mdoc->next = MDOC_NEXT_CHILD;
                    792:                        }
1.47      schwarze  793:                        break;
                    794:                }
                    795:
                    796:                /*
                    797:                 * When finding an open sub block, remember the last
                    798:                 * open explicit block, or, in case there are only
                    799:                 * implicit ones, the first open implicit block.
                    800:                 */
1.107     schwarze  801:
1.47      schwarze  802:                if (later &&
1.106     schwarze  803:                    mdoc_macros[later->tok].flags & MDOC_EXPLICIT)
1.47      schwarze  804:                        continue;
1.106     schwarze  805:                if (n->tok != MDOC_It)
1.47      schwarze  806:                        later = n;
                    807:        }
1.107     schwarze  808:        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
1.47      schwarze  809:
1.106     schwarze  810:        if ( ! (mdoc_macros[tok].flags & MDOC_PARSED)) {
                    811:                if (buf[*pos] != '\0')
1.93      schwarze  812:                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                    813:                            mdoc->parse, line, ppos,
                    814:                            "%s %s", mdoc_macronames[tok],
                    815:                            buf + *pos);
1.106     schwarze  816:                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
1.107     schwarze  817:                return;
1.1       kristaps  818:        }
                    819:
1.104     schwarze  820:        if (maxargs && endbody == NULL) {
                    821:                if (n == NULL) {
                    822:                        /*
                    823:                         * Stray .Ec without previous .Eo:
                    824:                         * Break the output line, ignore any arguments.
                    825:                         */
1.106     schwarze  826:                        mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL);
1.105     schwarze  827:                        rew_elem(mdoc, MDOC_br);
1.106     schwarze  828:                } else
                    829:                        mdoc_tail_alloc(mdoc, line, ppos, atok);
1.104     schwarze  830:        }
1.1       kristaps  831:
1.104     schwarze  832:        flushed = n == NULL;
                    833:        for (j = 0; ; j++) {
1.1       kristaps  834:                lastarg = *pos;
                    835:
                    836:                if (j == maxargs && ! flushed) {
1.106     schwarze  837:                        if (endbody == NULL)
                    838:                                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                    839:                        else
1.105     schwarze  840:                                rew_last(mdoc, endbody);
1.1       kristaps  841:                        flushed = 1;
                    842:                }
                    843:
1.76      schwarze  844:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze  845:                if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1.1       kristaps  846:                        break;
                    847:
1.111     schwarze  848:                ntok = ac == ARGS_QWORD ? MDOC_MAX :
                    849:                    lookup(mdoc, tok, line, lastarg, p);
1.36      schwarze  850:
1.106     schwarze  851:                if (ntok == MDOC_MAX) {
                    852:                        dword(mdoc, line, lastarg, p, DELIM_MAX,
                    853:                            MDOC_JOIN & mdoc_macros[tok].flags);
1.36      schwarze  854:                        continue;
                    855:                }
1.1       kristaps  856:
1.36      schwarze  857:                if ( ! flushed) {
1.106     schwarze  858:                        if (endbody == NULL)
                    859:                                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                    860:                        else
1.105     schwarze  861:                                rew_last(mdoc, endbody);
1.36      schwarze  862:                        flushed = 1;
                    863:                }
1.79      schwarze  864:                mdoc->flags &= ~MDOC_NEWLINE;
1.107     schwarze  865:                mdoc_macro(mdoc, ntok, line, lastarg, pos, buf);
1.36      schwarze  866:                break;
1.1       kristaps  867:        }
                    868:
1.105     schwarze  869:        if ( ! flushed) {
1.106     schwarze  870:                if (endbody == NULL)
                    871:                        rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                    872:                else
1.105     schwarze  873:                        rew_last(mdoc, endbody);
                    874:        }
1.106     schwarze  875:        if (nl)
                    876:                append_delims(mdoc, line, pos, buf);
1.1       kristaps  877: }
                    878:
1.107     schwarze  879: static void
1.1       kristaps  880: in_line(MACRO_PROT_ARGS)
                    881: {
1.100     schwarze  882:        int              la, scope, cnt, firstarg, mayopen, nc, nl;
1.36      schwarze  883:        enum mdoct       ntok;
                    884:        enum margserr    ac;
1.40      schwarze  885:        enum mdelim      d;
1.36      schwarze  886:        struct mdoc_arg *arg;
                    887:        char            *p;
1.1       kristaps  888:
1.76      schwarze  889:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze  890:
1.1       kristaps  891:        /*
                    892:         * Whether we allow ignored elements (those without content,
                    893:         * usually because of reserved words) to squeak by.
                    894:         */
1.32      schwarze  895:
1.1       kristaps  896:        switch (tok) {
1.88      schwarze  897:        case MDOC_An:
1.19      schwarze  898:                /* FALLTHROUGH */
1.88      schwarze  899:        case MDOC_Ar:
1.1       kristaps  900:                /* FALLTHROUGH */
1.88      schwarze  901:        case MDOC_Fl:
1.1       kristaps  902:                /* FALLTHROUGH */
1.88      schwarze  903:        case MDOC_Mt:
1.18      schwarze  904:                /* FALLTHROUGH */
1.88      schwarze  905:        case MDOC_Nm:
1.19      schwarze  906:                /* FALLTHROUGH */
1.88      schwarze  907:        case MDOC_Pa:
1.1       kristaps  908:                nc = 1;
                    909:                break;
                    910:        default:
                    911:                nc = 0;
                    912:                break;
                    913:        }
                    914:
1.108     schwarze  915:        mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1       kristaps  916:
1.100     schwarze  917:        d = DELIM_NONE;
                    918:        firstarg = 1;
1.98      schwarze  919:        mayopen = 1;
1.45      schwarze  920:        for (cnt = scope = 0;; ) {
1.1       kristaps  921:                la = *pos;
1.76      schwarze  922:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.1       kristaps  923:
1.100     schwarze  924:                /*
                    925:                 * At the end of a macro line,
                    926:                 * opening delimiters do not suppress spacing.
                    927:                 */
                    928:
                    929:                if (ac == ARGS_EOLN) {
                    930:                        if (d == DELIM_OPEN)
                    931:                                mdoc->last->flags &= ~MDOC_DELIMO;
1.1       kristaps  932:                        break;
1.100     schwarze  933:                }
                    934:
                    935:                /*
                    936:                 * The rest of the macro line is only punctuation,
                    937:                 * to be handled by append_delims().
                    938:                 * If there were no other arguments,
                    939:                 * do not allow the first one to suppress spacing,
                    940:                 * even if it turns out to be a closing one.
                    941:                 */
                    942:
                    943:                if (ac == ARGS_PUNCT) {
                    944:                        if (cnt == 0 && nc == 0)
                    945:                                mdoc->flags |= MDOC_NODELIMC;
1.1       kristaps  946:                        break;
1.100     schwarze  947:                }
1.1       kristaps  948:
1.101     schwarze  949:                ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ?
1.111     schwarze  950:                    MDOC_MAX : lookup(mdoc, tok, line, la, p);
1.1       kristaps  951:
1.88      schwarze  952:                /*
1.1       kristaps  953:                 * In this case, we've located a submacro and must
                    954:                 * execute it.  Close out scope, if open.  If no
                    955:                 * elements have been generated, either create one (nc)
                    956:                 * or raise a warning.
                    957:                 */
                    958:
1.106     schwarze  959:                if (ntok != MDOC_MAX) {
1.105     schwarze  960:                        if (scope)
                    961:                                rew_elem(mdoc, tok);
1.106     schwarze  962:                        if (nc && ! cnt) {
                    963:                                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.105     schwarze  964:                                rew_last(mdoc, mdoc->last);
1.106     schwarze  965:                        } else if ( ! nc && ! cnt) {
1.1       kristaps  966:                                mdoc_argv_free(arg);
1.92      schwarze  967:                                mandoc_msg(MANDOCERR_MACRO_EMPTY,
                    968:                                    mdoc->parse, line, ppos,
                    969:                                    mdoc_macronames[tok]);
1.1       kristaps  970:                        }
1.107     schwarze  971:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
1.106     schwarze  972:                        if (nl)
                    973:                                append_delims(mdoc, line, pos, buf);
1.107     schwarze  974:                        return;
1.88      schwarze  975:                }
1.1       kristaps  976:
1.88      schwarze  977:                /*
1.1       kristaps  978:                 * Non-quote-enclosed punctuation.  Set up our scope, if
                    979:                 * a word; rewind the scope, if a delimiter; then append
1.88      schwarze  980:                 * the word.
1.1       kristaps  981:                 */
                    982:
1.106     schwarze  983:                d = ac == ARGS_QWORD ? DELIM_NONE : mdoc_isdelim(p);
1.1       kristaps  984:
1.45      schwarze  985:                if (DELIM_NONE != d) {
                    986:                        /*
                    987:                         * If we encounter closing punctuation, no word
1.100     schwarze  988:                         * has been emitted, no scope is open, and we're
1.45      schwarze  989:                         * allowed to have an empty element, then start
1.98      schwarze  990:                         * a new scope.
1.45      schwarze  991:                         */
1.98      schwarze  992:                        if ((d == DELIM_CLOSE ||
                    993:                             (d == DELIM_MIDDLE && tok == MDOC_Fl)) &&
1.100     schwarze  994:                            !cnt && !scope && nc && mayopen) {
1.106     schwarze  995:                                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.45      schwarze  996:                                scope = 1;
1.98      schwarze  997:                                cnt++;
1.106     schwarze  998:                                if (tok == MDOC_Nm)
1.98      schwarze  999:                                        mayopen = 0;
1.45      schwarze 1000:                        }
                   1001:                        /*
                   1002:                         * Close out our scope, if one is open, before
                   1003:                         * any punctuation.
                   1004:                         */
1.105     schwarze 1005:                        if (scope)
                   1006:                                rew_elem(mdoc, tok);
1.45      schwarze 1007:                        scope = 0;
1.101     schwarze 1008:                        if (tok == MDOC_Fn)
                   1009:                                mayopen = 0;
1.98      schwarze 1010:                } else if (mayopen && !scope) {
1.106     schwarze 1011:                        mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.45      schwarze 1012:                        scope = 1;
1.98      schwarze 1013:                        cnt++;
1.1       kristaps 1014:                }
1.66      schwarze 1015:
1.106     schwarze 1016:                dword(mdoc, line, la, p, d,
                   1017:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.27      schwarze 1018:
                   1019:                /*
1.100     schwarze 1020:                 * If the first argument is a closing delimiter,
                   1021:                 * do not suppress spacing before it.
                   1022:                 */
                   1023:
                   1024:                if (firstarg && d == DELIM_CLOSE && !nc)
                   1025:                        mdoc->last->flags &= ~MDOC_DELIMC;
                   1026:                firstarg = 0;
                   1027:
                   1028:                /*
1.27      schwarze 1029:                 * `Fl' macros have their scope re-opened with each new
                   1030:                 * word so that the `-' can be added to each one without
                   1031:                 * having to parse out spaces.
                   1032:                 */
1.106     schwarze 1033:                if (scope && tok == MDOC_Fl) {
1.105     schwarze 1034:                        rew_elem(mdoc, tok);
1.45      schwarze 1035:                        scope = 0;
1.27      schwarze 1036:                }
1.1       kristaps 1037:        }
                   1038:
1.105     schwarze 1039:        if (scope)
                   1040:                rew_elem(mdoc, tok);
1.1       kristaps 1041:
                   1042:        /*
                   1043:         * If no elements have been collected and we're allowed to have
                   1044:         * empties (nc), open a scope and close it out.  Otherwise,
                   1045:         * raise a warning.
                   1046:         */
1.32      schwarze 1047:
1.106     schwarze 1048:        if ( ! cnt) {
                   1049:                if (nc) {
                   1050:                        mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
                   1051:                        rew_last(mdoc, mdoc->last);
                   1052:                } else {
                   1053:                        mdoc_argv_free(arg);
                   1054:                        mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
                   1055:                            line, ppos, mdoc_macronames[tok]);
                   1056:                }
1.1       kristaps 1057:        }
1.106     schwarze 1058:        if (nl)
                   1059:                append_delims(mdoc, line, pos, buf);
1.1       kristaps 1060: }
                   1061:
1.107     schwarze 1062: static void
1.1       kristaps 1063: blk_full(MACRO_PROT_ARGS)
                   1064: {
1.109     schwarze 1065:        int               la, nl, parsed;
1.1       kristaps 1066:        struct mdoc_arg  *arg;
1.32      schwarze 1067:        struct mdoc_node *head; /* save of head macro */
1.34      schwarze 1068:        struct mdoc_node *body; /* save of body macro */
1.32      schwarze 1069:        struct mdoc_node *n;
1.37      schwarze 1070:        enum margserr     ac, lac;
1.1       kristaps 1071:        char             *p;
                   1072:
1.76      schwarze 1073:        nl = MDOC_NEWLINE & mdoc->flags;
1.95      schwarze 1074:
                   1075:        /* Skip items outside lists. */
                   1076:
                   1077:        if (tok == MDOC_It) {
                   1078:                for (n = mdoc->last; n; n = n->parent)
1.114   ! schwarze 1079:                        if (n->tok == MDOC_Bl && n->type == MDOC_BLOCK &&
        !          1080:                            ! (n->flags & (MDOC_VALID | MDOC_BREAK)))
1.95      schwarze 1081:                                break;
                   1082:                if (n == NULL) {
                   1083:                        mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse,
                   1084:                            line, ppos, "It %s", buf + *pos);
1.106     schwarze 1085:                        mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL);
1.105     schwarze 1086:                        rew_elem(mdoc, MDOC_br);
1.107     schwarze 1087:                        return;
1.95      schwarze 1088:                }
                   1089:        }
1.43      schwarze 1090:
1.32      schwarze 1091:        /* Close out prior implicit scope. */
1.12      schwarze 1092:
1.106     schwarze 1093:        if ( ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)) {
                   1094:                rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1095:                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
1.1       kristaps 1096:        }
                   1097:
1.32      schwarze 1098:        /*
1.68      schwarze 1099:         * This routine accommodates implicitly- and explicitly-scoped
1.32      schwarze 1100:         * macro openings.  Implicit ones first close out prior scope
                   1101:         * (seen above).  Delay opening the head until necessary to
                   1102:         * allow leading punctuation to print.  Special consideration
                   1103:         * for `It -column', which has phrase-part syntax instead of
                   1104:         * regular child nodes.
                   1105:         */
                   1106:
1.108     schwarze 1107:        mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.106     schwarze 1108:        mdoc_block_alloc(mdoc, line, ppos, tok, arg);
1.34      schwarze 1109:        head = body = NULL;
1.1       kristaps 1110:
1.32      schwarze 1111:        /*
1.73      schwarze 1112:         * Exception: Heads of `It' macros in `-diag' lists are not
                   1113:         * parsed, even though `It' macros in general are parsed.
                   1114:         */
1.107     schwarze 1115:
1.109     schwarze 1116:        parsed = tok != MDOC_It ||
                   1117:            mdoc->last->parent->tok != MDOC_Bl ||
                   1118:            mdoc->last->parent->norm->Bl.type != LIST_diag;
1.73      schwarze 1119:
                   1120:        /*
1.32      schwarze 1121:         * The `Nd' macro has all arguments in its body: it's a hybrid
                   1122:         * of block partial-explicit and full-implicit.  Stupid.
                   1123:         */
1.12      schwarze 1124:
1.106     schwarze 1125:        if (tok == MDOC_Nd) {
                   1126:                head = mdoc_head_alloc(mdoc, line, ppos, tok);
                   1127:                rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1128:                body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.80      schwarze 1129:        }
                   1130:
1.106     schwarze 1131:        if (tok == MDOC_Bk)
1.80      schwarze 1132:                mdoc->flags |= MDOC_KEEP;
1.12      schwarze 1133:
1.106     schwarze 1134:        ac = ARGS_PEND;
                   1135:        for (;;) {
1.32      schwarze 1136:                la = *pos;
1.106     schwarze 1137:                lac = ac;
1.76      schwarze 1138:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1139:                if (ac == ARGS_PUNCT)
1.52      schwarze 1140:                        break;
1.106     schwarze 1141:                if (ac == ARGS_EOLN) {
                   1142:                        if (lac != ARGS_PPHRASE && lac != ARGS_PHRASE)
1.46      schwarze 1143:                                break;
                   1144:                        /*
                   1145:                         * This is necessary: if the last token on a
                   1146:                         * line is a `Ta' or tab, then we'll get
                   1147:                         * ARGS_EOLN, so we must be smart enough to
                   1148:                         * reopen our scope if the last parse was a
                   1149:                         * phrase or partial phrase.
                   1150:                         */
1.106     schwarze 1151:                        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1152:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1153:                        break;
1.41      schwarze 1154:                }
                   1155:
1.88      schwarze 1156:                /*
1.46      schwarze 1157:                 * Emit leading punctuation (i.e., punctuation before
                   1158:                 * the MDOC_HEAD) for non-phrase types.
                   1159:                 */
1.32      schwarze 1160:
1.106     schwarze 1161:                if (head == NULL &&
                   1162:                    ac != ARGS_PEND &&
                   1163:                    ac != ARGS_PHRASE &&
                   1164:                    ac != ARGS_PPHRASE &&
                   1165:                    ac != ARGS_QWORD &&
                   1166:                    mdoc_isdelim(p) == DELIM_OPEN) {
                   1167:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.32      schwarze 1168:                        continue;
                   1169:                }
                   1170:
1.46      schwarze 1171:                /* Open a head if one hasn't been opened. */
1.32      schwarze 1172:
1.106     schwarze 1173:                if (head == NULL)
                   1174:                        head = mdoc_head_alloc(mdoc, line, ppos, tok);
1.32      schwarze 1175:
1.106     schwarze 1176:                if (ac == ARGS_PHRASE ||
                   1177:                    ac == ARGS_PEND ||
                   1178:                    ac == ARGS_PPHRASE) {
1.107     schwarze 1179:
1.46      schwarze 1180:                        /*
                   1181:                         * If we haven't opened a body yet, rewind the
                   1182:                         * head; if we have, rewind that instead.
                   1183:                         */
                   1184:
1.106     schwarze 1185:                        rew_sub(body ? MDOC_BODY : MDOC_HEAD,
                   1186:                            mdoc, tok, line, ppos);
                   1187:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.46      schwarze 1188:
                   1189:                        /*
                   1190:                         * Process phrases: set whether we're in a
                   1191:                         * partial-phrase (this effects line handling)
                   1192:                         * then call down into the phrase parser.
                   1193:                         */
                   1194:
1.106     schwarze 1195:                        if (ac == ARGS_PPHRASE)
1.76      schwarze 1196:                                mdoc->flags |= MDOC_PPHRASE;
1.106     schwarze 1197:                        if (ac == ARGS_PEND && lac == ARGS_PPHRASE)
1.76      schwarze 1198:                                mdoc->flags |= MDOC_PPHRASE;
1.110     schwarze 1199:                        parse_rest(mdoc, MDOC_MAX, line, &la, buf);
1.76      schwarze 1200:                        mdoc->flags &= ~MDOC_PPHRASE;
1.1       kristaps 1201:                        continue;
                   1202:                }
                   1203:
1.109     schwarze 1204:                if (macro_or_word(mdoc, tok, line, la, pos, buf, parsed))
1.107     schwarze 1205:                        break;
1.32      schwarze 1206:        }
1.1       kristaps 1207:
1.106     schwarze 1208:        if (head == NULL)
                   1209:                head = mdoc_head_alloc(mdoc, line, ppos, tok);
                   1210:        if (nl)
                   1211:                append_delims(mdoc, line, pos, buf);
1.107     schwarze 1212:        if (body != NULL)
1.46      schwarze 1213:                goto out;
1.29      schwarze 1214:
                   1215:        /*
1.34      schwarze 1216:         * If there is an open (i.e., unvalidated) sub-block requiring
                   1217:         * explicit close-out, postpone switching the current block from
                   1218:         * head to body until the rew_sub() call closing out that
                   1219:         * sub-block.
1.29      schwarze 1220:         */
1.76      schwarze 1221:        for (n = mdoc->last; n && n != head; n = n->parent) {
1.107     schwarze 1222:                if (n->type == MDOC_BLOCK &&
                   1223:                    mdoc_macros[n->tok].flags & MDOC_EXPLICIT &&
                   1224:                    ! (n->flags & MDOC_VALID)) {
1.29      schwarze 1225:                        n->pending = head;
1.107     schwarze 1226:                        return;
1.29      schwarze 1227:                }
                   1228:        }
1.54      schwarze 1229:
1.32      schwarze 1230:        /* Close out scopes to remain in a consistent state. */
1.12      schwarze 1231:
1.106     schwarze 1232:        rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1233:        mdoc_body_alloc(mdoc, line, ppos, tok);
1.46      schwarze 1234: out:
1.106     schwarze 1235:        if (mdoc->flags & MDOC_FREECOL) {
                   1236:                rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1237:                rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
                   1238:                mdoc->flags &= ~MDOC_FREECOL;
                   1239:        }
1.1       kristaps 1240: }
                   1241:
1.107     schwarze 1242: static void
1.1       kristaps 1243: blk_part_imp(MACRO_PROT_ARGS)
                   1244: {
1.43      schwarze 1245:        int               la, nl;
1.36      schwarze 1246:        enum margserr     ac;
1.1       kristaps 1247:        char             *p;
1.32      schwarze 1248:        struct mdoc_node *blk; /* saved block context */
                   1249:        struct mdoc_node *body; /* saved body context */
                   1250:        struct mdoc_node *n;
1.1       kristaps 1251:
1.76      schwarze 1252:        nl = MDOC_NEWLINE & mdoc->flags;
1.43      schwarze 1253:
1.32      schwarze 1254:        /*
                   1255:         * A macro that spans to the end of the line.  This is generally
                   1256:         * (but not necessarily) called as the first macro.  The block
                   1257:         * has a head as the immediate child, which is always empty,
                   1258:         * followed by zero or more opening punctuation nodes, then the
                   1259:         * body (which may be empty, depending on the macro), then zero
                   1260:         * or more closing punctuation nodes.
                   1261:         */
1.22      schwarze 1262:
1.106     schwarze 1263:        blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
                   1264:        mdoc_head_alloc(mdoc, line, ppos, tok);
                   1265:        rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
1.1       kristaps 1266:
1.32      schwarze 1267:        /*
                   1268:         * Open the body scope "on-demand", that is, after we've
                   1269:         * processed all our the leading delimiters (open parenthesis,
                   1270:         * etc.).
                   1271:         */
1.1       kristaps 1272:
1.32      schwarze 1273:        for (body = NULL; ; ) {
1.22      schwarze 1274:                la = *pos;
1.76      schwarze 1275:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1276:                if (ac == ARGS_EOLN || ac == ARGS_PUNCT)
1.1       kristaps 1277:                        break;
                   1278:
1.106     schwarze 1279:                if (body == NULL && ac != ARGS_QWORD &&
                   1280:                    mdoc_isdelim(p) == DELIM_OPEN) {
                   1281:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.1       kristaps 1282:                        continue;
1.80      schwarze 1283:                }
1.1       kristaps 1284:
1.106     schwarze 1285:                if (body == NULL)
                   1286:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.32      schwarze 1287:
1.109     schwarze 1288:                if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1.107     schwarze 1289:                        break;
1.32      schwarze 1290:        }
1.106     schwarze 1291:        if (body == NULL)
                   1292:                body = mdoc_body_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1293:
1.47      schwarze 1294:        /*
                   1295:         * If there is an open sub-block requiring explicit close-out,
                   1296:         * postpone closing out the current block
                   1297:         * until the rew_sub() call closing out the sub-block.
                   1298:         */
1.107     schwarze 1299:
1.76      schwarze 1300:        for (n = mdoc->last; n && n != body && n != blk->parent;
1.88      schwarze 1301:             n = n->parent) {
1.106     schwarze 1302:                if (n->type == MDOC_BLOCK &&
                   1303:                    mdoc_macros[n->tok].flags & MDOC_EXPLICIT &&
                   1304:                    ! (n->flags & MDOC_VALID)) {
1.76      schwarze 1305:                        make_pending(n, tok, mdoc, line, ppos);
1.106     schwarze 1306:                        mdoc_endbody_alloc(mdoc, line, ppos,
                   1307:                            tok, body, ENDBODY_NOSPACE);
1.107     schwarze 1308:                        return;
1.47      schwarze 1309:                }
                   1310:        }
1.91      schwarze 1311:        assert(n == body);
1.106     schwarze 1312:        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
                   1313:        if (nl)
                   1314:                append_delims(mdoc, line, pos, buf);
                   1315:        rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos);
1.74      schwarze 1316:
                   1317:        /* Move trailing .Ns out of scope. */
                   1318:
                   1319:        for (n = body->child; n && n->next; n = n->next)
                   1320:                /* Do nothing. */ ;
1.106     schwarze 1321:        if (n && n->tok == MDOC_Ns)
1.76      schwarze 1322:                mdoc_node_relink(mdoc, n);
1.1       kristaps 1323: }
                   1324:
1.107     schwarze 1325: static void
1.1       kristaps 1326: blk_part_exp(MACRO_PROT_ARGS)
                   1327: {
1.37      schwarze 1328:        int               la, nl;
1.36      schwarze 1329:        enum margserr     ac;
1.32      schwarze 1330:        struct mdoc_node *head; /* keep track of head */
                   1331:        struct mdoc_node *body; /* keep track of body */
1.1       kristaps 1332:        char             *p;
                   1333:
1.76      schwarze 1334:        nl = MDOC_NEWLINE & mdoc->flags;
1.37      schwarze 1335:
1.32      schwarze 1336:        /*
                   1337:         * The opening of an explicit macro having zero or more leading
                   1338:         * punctuation nodes; a head with optional single element (the
                   1339:         * case of `Eo'); and a body that may be empty.
                   1340:         */
1.22      schwarze 1341:
1.106     schwarze 1342:        mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
1.32      schwarze 1343:        for (head = body = NULL; ; ) {
1.22      schwarze 1344:                la = *pos;
1.76      schwarze 1345:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.106     schwarze 1346:                if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
1.1       kristaps 1347:                        break;
                   1348:
1.32      schwarze 1349:                /* Flush out leading punctuation. */
                   1350:
1.106     schwarze 1351:                if (head == NULL && ac != ARGS_QWORD &&
                   1352:                    mdoc_isdelim(p) == DELIM_OPEN) {
1.32      schwarze 1353:                        assert(NULL == body);
1.106     schwarze 1354:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.32      schwarze 1355:                        continue;
1.80      schwarze 1356:                }
1.32      schwarze 1357:
1.106     schwarze 1358:                if (head == NULL) {
                   1359:                        assert(body == NULL);
                   1360:                        head = mdoc_head_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1361:                }
                   1362:
1.32      schwarze 1363:                /*
                   1364:                 * `Eo' gobbles any data into the head, but most other
                   1365:                 * macros just immediately close out and begin the body.
                   1366:                 */
                   1367:
1.106     schwarze 1368:                if (body == NULL) {
1.32      schwarze 1369:                        assert(head);
                   1370:                        /* No check whether it's a macro! */
1.106     schwarze 1371:                        if (tok == MDOC_Eo)
                   1372:                                dword(mdoc, line, la, p, DELIM_MAX, 0);
                   1373:                        rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1374:                        body = mdoc_body_alloc(mdoc, line, ppos, tok);
                   1375:                        if (tok == MDOC_Eo)
1.32      schwarze 1376:                                continue;
                   1377:                }
1.106     schwarze 1378:                assert(head != NULL && body != NULL);
1.32      schwarze 1379:
1.109     schwarze 1380:                if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1.107     schwarze 1381:                        break;
1.1       kristaps 1382:        }
                   1383:
1.32      schwarze 1384:        /* Clean-up to leave in a consistent state. */
                   1385:
1.106     schwarze 1386:        if (head == NULL)
                   1387:                mdoc_head_alloc(mdoc, line, ppos, tok);
1.22      schwarze 1388:
1.106     schwarze 1389:        if (body == NULL) {
                   1390:                rew_sub(MDOC_HEAD, mdoc, tok, line, ppos);
                   1391:                mdoc_body_alloc(mdoc, line, ppos, tok);
1.1       kristaps 1392:        }
1.106     schwarze 1393:        if (nl)
                   1394:                append_delims(mdoc, line, pos, buf);
1.1       kristaps 1395: }
                   1396:
1.107     schwarze 1397: static void
1.1       kristaps 1398: in_line_argn(MACRO_PROT_ARGS)
                   1399: {
1.37      schwarze 1400:        int              la, flushed, j, maxargs, nl;
1.36      schwarze 1401:        enum margserr    ac;
                   1402:        struct mdoc_arg *arg;
                   1403:        char            *p;
                   1404:        enum mdoct       ntok;
1.1       kristaps 1405:
1.112     schwarze 1406:        nl = mdoc->flags & MDOC_NEWLINE;
1.37      schwarze 1407:
1.32      schwarze 1408:        /*
                   1409:         * A line macro that has a fixed number of arguments (maxargs).
                   1410:         * Only open the scope once the first non-leading-punctuation is
                   1411:         * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then
                   1412:         * keep it open until the maximum number of arguments are
                   1413:         * exhausted.
                   1414:         */
1.1       kristaps 1415:
                   1416:        switch (tok) {
1.88      schwarze 1417:        case MDOC_Ap:
1.1       kristaps 1418:                /* FALLTHROUGH */
1.88      schwarze 1419:        case MDOC_Ns:
1.1       kristaps 1420:                /* FALLTHROUGH */
1.88      schwarze 1421:        case MDOC_Ux:
1.1       kristaps 1422:                maxargs = 0;
                   1423:                break;
1.88      schwarze 1424:        case MDOC_Bx:
1.64      schwarze 1425:                /* FALLTHROUGH */
1.89      schwarze 1426:        case MDOC_Es:
                   1427:                /* FALLTHROUGH */
1.88      schwarze 1428:        case MDOC_Xr:
1.28      schwarze 1429:                maxargs = 2;
                   1430:                break;
1.1       kristaps 1431:        default:
                   1432:                maxargs = 1;
                   1433:                break;
                   1434:        }
                   1435:
1.108     schwarze 1436:        mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.1       kristaps 1437:
1.112     schwarze 1438:        p = NULL;
                   1439:        flushed = j = 0;
                   1440:        for (;;) {
1.22      schwarze 1441:                la = *pos;
1.76      schwarze 1442:                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
1.112     schwarze 1443:                if (ac == ARGS_PUNCT || ac == ARGS_EOLN) {
                   1444:                        if (j < 2 && tok == MDOC_Pf)
                   1445:                                mandoc_vmsg(MANDOCERR_PF_SKIP,
                   1446:                                    mdoc->parse, line, ppos, "Pf %s",
                   1447:                                    p == NULL ? "at eol" : p);
1.1       kristaps 1448:                        break;
1.112     schwarze 1449:                }
1.1       kristaps 1450:
1.106     schwarze 1451:                if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
                   1452:                    ac != ARGS_QWORD && j == 0 &&
                   1453:                    mdoc_isdelim(p) == DELIM_OPEN) {
                   1454:                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
1.32      schwarze 1455:                        continue;
1.106     schwarze 1456:                } else if (j == 0)
                   1457:                       mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.32      schwarze 1458:
                   1459:                if (j == maxargs && ! flushed) {
1.105     schwarze 1460:                        rew_elem(mdoc, tok);
1.32      schwarze 1461:                        flushed = 1;
                   1462:                }
                   1463:
1.112     schwarze 1464:                ntok = (ac == ARGS_QWORD || (tok == MDOC_Pf && j == 0)) ?
                   1465:                    MDOC_MAX : lookup(mdoc, tok, line, la, p);
1.36      schwarze 1466:
1.106     schwarze 1467:                if (ntok != MDOC_MAX) {
1.105     schwarze 1468:                        if ( ! flushed)
                   1469:                                rew_elem(mdoc, tok);
1.1       kristaps 1470:                        flushed = 1;
1.107     schwarze 1471:                        mdoc_macro(mdoc, ntok, line, la, pos, buf);
1.32      schwarze 1472:                        j++;
1.1       kristaps 1473:                        break;
                   1474:                }
                   1475:
1.106     schwarze 1476:                if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
                   1477:                    ac != ARGS_QWORD && ! flushed &&
                   1478:                    mdoc_isdelim(p) != DELIM_NONE) {
1.105     schwarze 1479:                        rew_elem(mdoc, tok);
1.1       kristaps 1480:                        flushed = 1;
1.28      schwarze 1481:                }
                   1482:
1.106     schwarze 1483:                dword(mdoc, line, la, p, DELIM_MAX,
                   1484:                    MDOC_JOIN & mdoc_macros[tok].flags);
1.32      schwarze 1485:                j++;
1.1       kristaps 1486:        }
                   1487:
1.112     schwarze 1488:        if (j == 0) {
1.106     schwarze 1489:                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.112     schwarze 1490:                if (ac == ARGS_PUNCT && tok == MDOC_Pf)
                   1491:                        append_delims(mdoc, line, pos, buf);
                   1492:        }
1.105     schwarze 1493:        if ( ! flushed)
                   1494:                rew_elem(mdoc, tok);
1.106     schwarze 1495:        if (nl)
                   1496:                append_delims(mdoc, line, pos, buf);
1.1       kristaps 1497: }
                   1498:
1.107     schwarze 1499: static void
1.1       kristaps 1500: in_line_eoln(MACRO_PROT_ARGS)
                   1501: {
1.36      schwarze 1502:        struct mdoc_arg *arg;
1.1       kristaps 1503:
1.53      schwarze 1504:        if (tok == MDOC_Pp)
1.76      schwarze 1505:                rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos);
1.53      schwarze 1506:
1.108     schwarze 1507:        mdoc_argv(mdoc, line, tok, &arg, pos, buf);
1.106     schwarze 1508:        mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
1.110     schwarze 1509:        if (parse_rest(mdoc, tok, line, pos, buf))
                   1510:                return;
                   1511:        rew_elem(mdoc, tok);
                   1512: }
                   1513:
                   1514: /*
                   1515:  * The simplest argument parser available: Parse the remaining
                   1516:  * words until the end of the phrase or line and return 0
                   1517:  * or until the next macro, call that macro, and return 1.
                   1518:  */
                   1519: static int
                   1520: parse_rest(struct mdoc *mdoc, enum mdoct tok, int line, int *pos, char *buf)
                   1521: {
                   1522:        int              la;
1.1       kristaps 1523:
                   1524:        for (;;) {
                   1525:                la = *pos;
1.109     schwarze 1526:                if (mdoc_args(mdoc, line, pos, buf, tok, NULL) == ARGS_EOLN)
1.110     schwarze 1527:                        return(0);
1.109     schwarze 1528:                if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
1.110     schwarze 1529:                        return(1);
1.1       kristaps 1530:        }
1.28      schwarze 1531: }
                   1532:
1.107     schwarze 1533: static void
1.28      schwarze 1534: ctx_synopsis(MACRO_PROT_ARGS)
                   1535: {
1.37      schwarze 1536:
1.107     schwarze 1537:        if (~mdoc->flags & (MDOC_SYNOPSIS | MDOC_NEWLINE))
                   1538:                in_line(mdoc, tok, line, ppos, pos, buf);
                   1539:        else if (tok == MDOC_Nm)
                   1540:                blk_full(mdoc, tok, line, ppos, pos, buf);
                   1541:        else {
                   1542:                assert(tok == MDOC_Vt);
                   1543:                blk_part_imp(mdoc, tok, line, ppos, pos, buf);
                   1544:        }
1.1       kristaps 1545: }
                   1546:
1.17      schwarze 1547: /*
                   1548:  * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs.
                   1549:  * They're unusual because they're basically free-form text until a
                   1550:  * macro is encountered.
                   1551:  */
1.107     schwarze 1552: static void
1.46      schwarze 1553: phrase_ta(MACRO_PROT_ARGS)
                   1554: {
1.78      schwarze 1555:        struct mdoc_node *n;
1.46      schwarze 1556:
1.78      schwarze 1557:        /* Make sure we are in a column list or ignore this macro. */
1.107     schwarze 1558:
1.78      schwarze 1559:        n = mdoc->last;
1.107     schwarze 1560:        while (n != NULL && n->tok != MDOC_Bl)
1.78      schwarze 1561:                n = n->parent;
1.107     schwarze 1562:        if (n == NULL || n->norm->Bl.type != LIST_column) {
1.94      schwarze 1563:                mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse,
1.96      schwarze 1564:                    line, ppos, "Ta");
1.107     schwarze 1565:                return;
1.78      schwarze 1566:        }
1.46      schwarze 1567:
1.78      schwarze 1568:        /* Advance to the next column. */
1.106     schwarze 1569:
                   1570:        rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos);
                   1571:        mdoc_body_alloc(mdoc, line, ppos, MDOC_It);
1.110     schwarze 1572:        parse_rest(mdoc, MDOC_MAX, line, pos, buf);
1.46      schwarze 1573: }