[BACK]Return to mdoc_macro.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdoc_macro.c, Revision 1.151

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

CVSweb