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

Annotation of mandoc/mdoc_macro.c, Revision 1.158

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

CVSweb