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

Annotation of mandoc/mdoc_macro.c, Revision 1.135

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

CVSweb