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

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