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

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