]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_macro.c
add arm64 architecture; from deraadt@
[mandoc.git] / mdoc_macro.c
index d87da2cf092fbc3d295d7869a402779da6f79965..d4edcea1416269ac5121615e2da7a2a0b15c3808 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: mdoc_macro.c,v 1.199 2015/05/01 16:02:47 schwarze Exp $ */
+/*     $Id: mdoc_macro.c,v 1.210 2017/01/10 13:47:00 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012-2016 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -216,7 +216,7 @@ mdoc_endparse(struct roff_man *mdoc)
 
        /* Scan for open explicit scopes. */
 
-       n = mdoc->last->flags & MDOC_VALID ?
+       n = mdoc->last->flags & NODE_VALID ?
            mdoc->last->parent : mdoc->last;
 
        for ( ; n; n = n->parent)
@@ -228,6 +228,7 @@ mdoc_endparse(struct roff_man *mdoc)
        /* Rewind to the first. */
 
        rew_last(mdoc, mdoc->first);
+       mdoc_state_reset(mdoc);
 }
 
 /*
@@ -239,17 +240,21 @@ lookup(struct roff_man *mdoc, int from, int line, int ppos, const char *p)
 {
        int      res;
 
+       if (mdoc->flags & MDOC_PHRASEQF) {
+               mdoc->flags &= ~MDOC_PHRASEQF;
+               return TOKEN_NONE;
+       }
        if (from == TOKEN_NONE || mdoc_macros[from].flags & MDOC_PARSED) {
                res = mdoc_hash_find(p);
                if (res != TOKEN_NONE) {
                        if (mdoc_macros[res].flags & MDOC_CALLABLE)
-                               return(res);
+                               return res;
                        if (res != MDOC_br && res != MDOC_sp && res != MDOC_ll)
                                mandoc_msg(MANDOCERR_MACRO_CALL,
                                    mdoc->parse, line, ppos, p);
                }
        }
-       return(TOKEN_NONE);
+       return TOKEN_NONE;
 }
 
 /*
@@ -258,25 +263,18 @@ lookup(struct roff_man *mdoc, int from, int line, int ppos, const char *p)
 static void
 rew_last(struct roff_man *mdoc, const struct roff_node *to)
 {
-       struct roff_node        *np;
 
-       if (to->flags & MDOC_VALID)
+       if (to->flags & NODE_VALID)
                return;
 
-       mdoc->next = ROFF_NEXT_SIBLING;
        while (mdoc->last != to) {
-               /*
-                * Save the parent here, because we may delete the
-                * mdoc->last node in the post-validation phase and reset
-                * it to mdoc->last->parent, causing a step in the closing
-                * out to be lost.
-                */
-               np = mdoc->last->parent;
-               mdoc_valid_post(mdoc);
-               mdoc->last = np;
-               assert(mdoc->last);
+               mdoc_state(mdoc, mdoc->last);
+               mdoc->last->flags |= NODE_VALID | NODE_ENDED;
+               mdoc->last = mdoc->last->parent;
        }
-       mdoc_valid_post(mdoc);
+       mdoc_state(mdoc, mdoc->last);
+       mdoc->last->flags |= NODE_VALID | NODE_ENDED;
+       mdoc->next = ROFF_NEXT_SIBLING;
 }
 
 /*
@@ -294,13 +292,13 @@ rew_pending(struct roff_man *mdoc, const struct roff_node *n)
                        case ROFFT_HEAD:
                                roff_body_alloc(mdoc, n->line, n->pos,
                                    n->tok);
-                               return;
+                               break;
                        case ROFFT_BLOCK:
                                break;
                        default:
                                return;
                        }
-                       if ( ! (n->flags & MDOC_BROKEN))
+                       if ( ! (n->flags & NODE_BROKEN))
                                return;
                } else
                        n = mdoc->last;
@@ -311,7 +309,7 @@ rew_pending(struct roff_man *mdoc, const struct roff_node *n)
 
                        if (n->type == ROFFT_BLOCK ||
                            n->type == ROFFT_HEAD) {
-                               if (n->flags & MDOC_ENDED)
+                               if (n->flags & NODE_ENDED)
                                        break;
                                else
                                        return;
@@ -329,41 +327,40 @@ rew_alt(int tok)
 {
        switch (tok) {
        case MDOC_Ac:
-               return(MDOC_Ao);
+               return MDOC_Ao;
        case MDOC_Bc:
-               return(MDOC_Bo);
+               return MDOC_Bo;
        case MDOC_Brc:
-               return(MDOC_Bro);
+               return MDOC_Bro;
        case MDOC_Dc:
-               return(MDOC_Do);
+               return MDOC_Do;
        case MDOC_Ec:
-               return(MDOC_Eo);
+               return MDOC_Eo;
        case MDOC_Ed:
-               return(MDOC_Bd);
+               return MDOC_Bd;
        case MDOC_Ef:
-               return(MDOC_Bf);
+               return MDOC_Bf;
        case MDOC_Ek:
-               return(MDOC_Bk);
+               return MDOC_Bk;
        case MDOC_El:
-               return(MDOC_Bl);
+               return MDOC_Bl;
        case MDOC_Fc:
-               return(MDOC_Fo);
+               return MDOC_Fo;
        case MDOC_Oc:
-               return(MDOC_Oo);
+               return MDOC_Oo;
        case MDOC_Pc:
-               return(MDOC_Po);
+               return MDOC_Po;
        case MDOC_Qc:
-               return(MDOC_Qo);
+               return MDOC_Qo;
        case MDOC_Re:
-               return(MDOC_Rs);
+               return MDOC_Rs;
        case MDOC_Sc:
-               return(MDOC_So);
+               return MDOC_So;
        case MDOC_Xc:
-               return(MDOC_Xo);
+               return MDOC_Xo;
        default:
-               return(tok);
+               return tok;
        }
-       /* NOTREACHED */
 }
 
 static void
@@ -393,18 +390,18 @@ find_pending(struct roff_man *mdoc, int tok, int line, int ppos,
 
        irc = 0;
        for (n = mdoc->last; n != NULL && n != target; n = n->parent) {
-               if (n->flags & MDOC_ENDED) {
-                       if ( ! (n->flags & MDOC_VALID))
-                               n->flags |= MDOC_BROKEN;
+               if (n->flags & NODE_ENDED) {
+                       if ( ! (n->flags & NODE_VALID))
+                               n->flags |= NODE_BROKEN;
                        continue;
                }
                if (n->type == ROFFT_BLOCK &&
                    mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
                        irc = 1;
-                       n->flags = MDOC_BROKEN;
+                       n->flags = NODE_BROKEN;
                        if (target->type == ROFFT_HEAD)
-                               target->flags = MDOC_ENDED;
-                       else if ( ! (target->flags & MDOC_ENDED)) {
+                               target->flags = NODE_ENDED;
+                       else if ( ! (target->flags & NODE_ENDED)) {
                                mandoc_vmsg(MANDOCERR_BLK_NEST,
                                    mdoc->parse, line, ppos,
                                    "%s breaks %s", mdoc_macronames[tok],
@@ -414,7 +411,7 @@ find_pending(struct roff_man *mdoc, int tok, int line, int ppos,
                        }
                }
        }
-       return(irc);
+       return irc;
 }
 
 /*
@@ -447,11 +444,11 @@ dword(struct roff_man *mdoc, int line, int col, const char *p,
         */
 
        if (d == DELIM_OPEN)
-               mdoc->last->flags |= MDOC_DELIMO;
+               mdoc->last->flags |= NODE_DELIMO;
        else if (d == DELIM_CLOSE &&
            ! (mdoc->flags & MDOC_NODELIMC) &&
            mdoc->last->parent->tok != MDOC_Fd)
-               mdoc->last->flags |= MDOC_DELIMC;
+               mdoc->last->flags |= NODE_DELIMC;
        mdoc->flags &= ~MDOC_NODELIMC;
 }
 
@@ -484,7 +481,7 @@ append_delims(struct roff_man *mdoc, int line, int *pos, char *buf)
                 */
 
                if (mandoc_eos(p, strlen(p)))
-                       mdoc->last->flags |= MDOC_EOS;
+                       mdoc->last->flags |= NODE_EOS;
        }
 }
 
@@ -509,14 +506,14 @@ macro_or_word(MACRO_PROT_ARGS, int parsed)
        if (ntok == TOKEN_NONE) {
                dword(mdoc, line, ppos, p, DELIM_MAX, tok == TOKEN_NONE ||
                    mdoc_macros[tok].flags & MDOC_JOIN);
-               return(0);
+               return 0;
        } else {
                if (mdoc_macros[tok].fp == in_line_eoln)
                        rew_elem(mdoc, tok);
                mdoc_macro(mdoc, ntok, line, ppos, pos, buf);
                if (tok == TOKEN_NONE)
                        append_delims(mdoc, line, pos, buf);
-               return(1);
+               return 1;
        }
 }
 
@@ -552,29 +549,40 @@ blk_exp_close(MACRO_PROT_ARGS)
                break;
        }
 
+       /* Search backwards for the beginning of our own body. */
+
+       atok = rew_alt(tok);
+       body = NULL;
+       for (n = mdoc->last; n; n = n->parent) {
+               if (n->flags & NODE_ENDED || n->tok != atok ||
+                   n->type != ROFFT_BODY || n->end != ENDBODY_NOT)
+                       continue;
+               body = n;
+               break;
+       }
+
        /*
         * Search backwards for beginnings of blocks,
         * both of our own and of pending sub-blocks.
         */
 
-       atok = rew_alt(tok);
-       body = endbody = itblk = later = NULL;
+       endbody = itblk = later = NULL;
        for (n = mdoc->last; n; n = n->parent) {
-               if (n->flags & MDOC_ENDED) {
-                       if ( ! (n->flags & MDOC_VALID))
-                               n->flags |= MDOC_BROKEN;
+               if (n->flags & NODE_ENDED) {
+                       if ( ! (n->flags & NODE_VALID))
+                               n->flags |= NODE_BROKEN;
                        continue;
                }
 
-               /* Remember the start of our own body. */
-
-               if (n->type == ROFFT_BODY && atok == n->tok) {
-                       if (n->end == ENDBODY_NOT)
-                               body = n;
-                       continue;
-               }
+               /*
+                * Mismatching end macros can never break anything,
+                * SYNOPSIS name blocks can never be broken,
+                * and we only care about the breaking of BLOCKs.
+                */
 
-               if (n->type != ROFFT_BLOCK || n->tok == MDOC_Nm)
+               if (body == NULL ||
+                   n->tok == MDOC_Nm ||
+                   n->type != ROFFT_BLOCK)
                        continue;
 
                if (n->tok == MDOC_It) {
@@ -612,7 +620,7 @@ blk_exp_close(MACRO_PROT_ARGS)
                            atok, body, ENDBODY_SPACE);
 
                        if (tok == MDOC_El)
-                               itblk->flags |= MDOC_ENDED | MDOC_BROKEN;
+                               itblk->flags |= NODE_ENDED | NODE_BROKEN;
 
                        /*
                         * If a block closing macro taking arguments
@@ -634,7 +642,7 @@ blk_exp_close(MACRO_PROT_ARGS)
 
                /* Breaking an open sub block. */
 
-               n->flags |= MDOC_BROKEN;
+               n->flags |= NODE_BROKEN;
                if (later == NULL)
                        later = n;
        }
@@ -642,8 +650,6 @@ blk_exp_close(MACRO_PROT_ARGS)
        if (body == NULL) {
                mandoc_msg(MANDOCERR_BLK_NOTOPEN, mdoc->parse,
                    line, ppos, mdoc_macronames[tok]);
-               if (later != NULL)
-                       later->flags &= ~MDOC_BROKEN;
                if (maxargs && endbody == NULL) {
                        /*
                         * Stray .Ec without previous .Eo:
@@ -700,11 +706,11 @@ blk_exp_close(MACRO_PROT_ARGS)
        }
 
        if (n != NULL) {
-               if (ntok != TOKEN_NONE && n->flags & MDOC_BROKEN) {
+               if (ntok != TOKEN_NONE && n->flags & NODE_BROKEN) {
                        target = n;
                        do
                                target = target->parent;
-                       while ( ! (target->flags & MDOC_ENDED));
+                       while ( ! (target->flags & NODE_ENDED));
                        pending = find_pending(mdoc, ntok, line, ppos,
                            target);
                } else
@@ -735,15 +741,10 @@ in_line(MACRO_PROT_ARGS)
 
        switch (tok) {
        case MDOC_An:
-               /* FALLTHROUGH */
        case MDOC_Ar:
-               /* FALLTHROUGH */
        case MDOC_Fl:
-               /* FALLTHROUGH */
        case MDOC_Mt:
-               /* FALLTHROUGH */
        case MDOC_Nm:
-               /* FALLTHROUGH */
        case MDOC_Pa:
                nc = 1;
                break;
@@ -768,7 +769,7 @@ in_line(MACRO_PROT_ARGS)
 
                if (ac == ARGS_EOLN) {
                        if (d == DELIM_OPEN)
-                               mdoc->last->flags &= ~MDOC_DELIMO;
+                               mdoc->last->flags &= ~NODE_DELIMO;
                        break;
                }
 
@@ -862,7 +863,7 @@ in_line(MACRO_PROT_ARGS)
                 */
 
                if (firstarg && d == DELIM_CLOSE && !nc)
-                       mdoc->last->flags &= ~MDOC_DELIMC;
+                       mdoc->last->flags &= ~NODE_DELIMC;
                firstarg = 0;
 
                /*
@@ -925,9 +926,9 @@ blk_full(MACRO_PROT_ARGS)
 
                blk = NULL;
                for (n = mdoc->last; n != NULL; n = n->parent) {
-                       if (n->flags & MDOC_ENDED) {
-                               if ( ! (n->flags & MDOC_VALID))
-                                       n->flags |= MDOC_BROKEN;
+                       if (n->flags & NODE_ENDED) {
+                               if ( ! (n->flags & NODE_VALID))
+                                       n->flags |= NODE_BROKEN;
                                continue;
                        }
                        if (n->type != ROFFT_BLOCK)
@@ -947,7 +948,6 @@ blk_full(MACRO_PROT_ARGS)
                        if (mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
                                switch (tok) {
                                case MDOC_Sh:
-                                       /* FALLTHROUGH */
                                case MDOC_Ss:
                                        mandoc_vmsg(MANDOCERR_BLK_BROKEN,
                                            mdoc->parse, line, ppos,
@@ -1037,26 +1037,39 @@ blk_full(MACRO_PROT_ARGS)
        if (tok == MDOC_Bk)
                mdoc->flags |= MDOC_KEEP;
 
-       ac = ARGS_PEND;
+       ac = ARGS_EOLN;
        for (;;) {
+
+               /*
+                * If we are right after a tab character,
+                * do not parse the first word for macros.
+                */
+
+               if (mdoc->flags & MDOC_PHRASEQN) {
+                       mdoc->flags &= ~MDOC_PHRASEQN;
+                       mdoc->flags |= MDOC_PHRASEQF;
+               }
+
                la = *pos;
                lac = ac;
                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
                if (ac == ARGS_EOLN) {
-                       if (lac != ARGS_PPHRASE && lac != ARGS_PHRASE)
+                       if (lac != ARGS_PHRASE ||
+                           ! (mdoc->flags & MDOC_PHRASEQF))
                                break;
+
                        /*
-                        * This is necessary: if the last token on a
-                        * line is a `Ta' or tab, then we'll get
-                        * ARGS_EOLN, so we must be smart enough to
-                        * reopen our scope if the last parse was a
-                        * phrase or partial phrase.
+                        * This line ends in a tab; start the next
+                        * column now, with a leading blank.
                         */
+
                        if (body != NULL)
                                rew_last(mdoc, body);
                        body = roff_body_alloc(mdoc, line, ppos, tok);
+                       roff_word_alloc(mdoc, line, ppos, "\\&");
                        break;
                }
+
                if (tok == MDOC_Bd || tok == MDOC_Bk) {
                        mandoc_vmsg(MANDOCERR_ARG_EXCESS,
                            mdoc->parse, line, la, "%s ... %s",
@@ -1077,9 +1090,7 @@ blk_full(MACRO_PROT_ARGS)
                 */
 
                if (head == NULL &&
-                   ac != ARGS_PEND &&
                    ac != ARGS_PHRASE &&
-                   ac != ARGS_PPHRASE &&
                    ac != ARGS_QWORD &&
                    mdoc_isdelim(p) == DELIM_OPEN) {
                        dword(mdoc, line, la, p, DELIM_OPEN, 0);
@@ -1091,9 +1102,7 @@ blk_full(MACRO_PROT_ARGS)
                if (head == NULL)
                        head = roff_head_alloc(mdoc, line, ppos, tok);
 
-               if (ac == ARGS_PHRASE ||
-                   ac == ARGS_PEND ||
-                   ac == ARGS_PPHRASE) {
+               if (ac == ARGS_PHRASE) {
 
                        /*
                         * If we haven't opened a body yet, rewind the
@@ -1103,18 +1112,16 @@ blk_full(MACRO_PROT_ARGS)
                        rew_last(mdoc, body == NULL ? head : body);
                        body = roff_body_alloc(mdoc, line, ppos, tok);
 
-                       /*
-                        * Process phrases: set whether we're in a
-                        * partial-phrase (this effects line handling)
-                        * then call down into the phrase parser.
-                        */
+                       /* Process to the tab or to the end of the line. */
 
-                       if (ac == ARGS_PPHRASE)
-                               mdoc->flags |= MDOC_PPHRASE;
-                       if (ac == ARGS_PEND && lac == ARGS_PPHRASE)
-                               mdoc->flags |= MDOC_PPHRASE;
+                       mdoc->flags |= MDOC_PHRASE;
                        parse_rest(mdoc, TOKEN_NONE, line, &la, buf);
-                       mdoc->flags &= ~MDOC_PPHRASE;
+                       mdoc->flags &= ~MDOC_PHRASE;
+
+                       /* There may have been `Ta' macros. */
+
+                       while (body->next != NULL)
+                               body = body->next;
                        continue;
                }
 
@@ -1122,7 +1129,7 @@ blk_full(MACRO_PROT_ARGS)
                        break;
        }
 
-       if (blk->flags & MDOC_VALID)
+       if (blk->flags & NODE_VALID)
                return;
        if (head == NULL)
                head = roff_head_alloc(mdoc, line, ppos, tok);
@@ -1290,16 +1297,12 @@ in_line_argn(MACRO_PROT_ARGS)
 
        switch (tok) {
        case MDOC_Ap:
-               /* FALLTHROUGH */
        case MDOC_Ns:
-               /* FALLTHROUGH */
        case MDOC_Ux:
                maxargs = 0;
                break;
        case MDOC_Bx:
-               /* FALLTHROUGH */
        case MDOC_Es:
-               /* FALLTHROUGH */
        case MDOC_Xr:
                maxargs = 2;
                break;
@@ -1427,9 +1430,9 @@ parse_rest(struct roff_man *mdoc, int tok, int line, int *pos, char *buf)
        for (;;) {
                la = *pos;
                if (mdoc_args(mdoc, line, pos, buf, tok, NULL) == ARGS_EOLN)
-                       return(0);
+                       return 0;
                if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
-                       return(1);
+                       return 1;
        }
 }
 
@@ -1461,11 +1464,11 @@ phrase_ta(MACRO_PROT_ARGS)
 
        body = NULL;
        for (n = mdoc->last; n != NULL; n = n->parent) {
-               if (n->flags & MDOC_ENDED)
+               if (n->flags & NODE_ENDED)
                        continue;
                if (n->tok == MDOC_It && n->type == ROFFT_BODY)
                        body = n;
-               if (n->tok == MDOC_Bl)
+               if (n->tok == MDOC_Bl && n->end == ENDBODY_NOT)
                        break;
        }