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

Annotation of mandoc/man.c, Revision 1.169

1.169   ! schwarze    1: /*     $Id: man.c,v 1.168 2017/03/03 13:55:31 schwarze Exp $ */
1.1       kristaps    2: /*
1.102     schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.149     schwarze    4:  * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.124     schwarze    5:  * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
1.1       kristaps    6:  *
                      7:  * Permission to use, copy, modify, and distribute this software for any
1.18      kristaps    8:  * purpose with or without fee is hereby granted, provided that the above
                      9:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps   10:  *
1.150     schwarze   11:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.18      kristaps   12:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.150     schwarze   13:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.18      kristaps   14:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     15:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     16:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     17:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   18:  */
1.47      kristaps   19: #include "config.h"
                     20:
1.41      kristaps   21: #include <sys/types.h>
                     22:
1.1       kristaps   23: #include <assert.h>
1.126     schwarze   24: #include <ctype.h>
1.1       kristaps   25: #include <stdarg.h>
                     26: #include <stdlib.h>
                     27: #include <stdio.h>
                     28: #include <string.h>
                     29:
1.150     schwarze   30: #include "mandoc_aux.h"
                     31: #include "mandoc.h"
                     32: #include "roff.h"
1.105     kristaps   33: #include "man.h"
1.150     schwarze   34: #include "libmandoc.h"
1.158     schwarze   35: #include "roff_int.h"
1.1       kristaps   36: #include "libman.h"
                     37:
1.153     schwarze   38: static void             man_descope(struct roff_man *, int, int);
                     39: static int              man_ptext(struct roff_man *, int, char *, int);
                     40: static int              man_pmacro(struct roff_man *, int, char *, int);
1.1       kristaps   41:
                     42:
                     43: int
1.153     schwarze   44: man_parseln(struct roff_man *man, int ln, char *buf, int offs)
1.1       kristaps   45: {
                     46:
1.150     schwarze   47:        if (man->last->type != ROFFT_EQN || ln > man->last->line)
1.141     schwarze   48:                man->flags |= MAN_NEWLINE;
1.97      kristaps   49:
1.165     schwarze   50:        return roff_getcontrol(man->roff, buf, &offs) ?
1.129     schwarze   51:            man_pmacro(man, ln, buf, offs) :
1.165     schwarze   52:            man_ptext(man, ln, buf, offs);
1.1       kristaps   53: }
1.2       kristaps   54:
1.144     schwarze   55: static void
1.153     schwarze   56: man_descope(struct roff_man *man, int line, int offs)
1.94      kristaps   57: {
                     58:        /*
                     59:         * Co-ordinate what happens with having a next-line scope open:
                     60:         * first close out the element scope (if applicable), then close
                     61:         * out the block scope (also if applicable).
                     62:         */
                     63:
1.144     schwarze   64:        if (man->flags & MAN_ELINE) {
1.119     schwarze   65:                man->flags &= ~MAN_ELINE;
1.144     schwarze   66:                man_unscope(man, man->last->parent);
1.94      kristaps   67:        }
1.144     schwarze   68:        if ( ! (man->flags & MAN_BLINE))
                     69:                return;
1.119     schwarze   70:        man->flags &= ~MAN_BLINE;
1.144     schwarze   71:        man_unscope(man, man->last->parent);
1.158     schwarze   72:        roff_body_alloc(man, line, offs, man->last->tok);
1.94      kristaps   73: }
                     74:
1.1       kristaps   75: static int
1.153     schwarze   76: man_ptext(struct roff_man *man, int line, char *buf, int offs)
1.1       kristaps   77: {
1.61      kristaps   78:        int              i;
1.60      kristaps   79:
1.35      kristaps   80:        /* Literal free-form text whitespace is preserved. */
                     81:
1.144     schwarze   82:        if (man->flags & MAN_LITERAL) {
1.160     schwarze   83:                roff_word_alloc(man, line, offs, buf + offs);
1.144     schwarze   84:                man_descope(man, line, offs);
1.165     schwarze   85:                return 1;
1.35      kristaps   86:        }
                     87:
1.144     schwarze   88:        for (i = offs; buf[i] == ' '; i++)
1.31      kristaps   89:                /* Skip leading whitespace. */ ;
1.48      kristaps   90:
1.121     schwarze   91:        /*
                     92:         * Blank lines are ignored right after headings
                     93:         * but add a single vertical space elsewhere.
                     94:         */
                     95:
1.144     schwarze   96:        if (buf[i] == '\0') {
1.61      kristaps   97:                /* Allocate a blank entry. */
1.144     schwarze   98:                if (man->last->tok != MAN_SH &&
                     99:                    man->last->tok != MAN_SS) {
1.161     schwarze  100:                        roff_elem_alloc(man, line, offs, MAN_sp);
1.153     schwarze  101:                        man->next = ROFF_NEXT_SIBLING;
1.121     schwarze  102:                }
1.165     schwarze  103:                return 1;
1.31      kristaps  104:        }
                    105:
1.129     schwarze  106:        /*
1.63      kristaps  107:         * Warn if the last un-escaped character is whitespace. Then
1.129     schwarze  108:         * strip away the remaining spaces (tabs stay!).
1.63      kristaps  109:         */
1.29      kristaps  110:
1.61      kristaps  111:        i = (int)strlen(buf);
                    112:        assert(i);
1.49      kristaps  113:
1.63      kristaps  114:        if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
1.64      kristaps  115:                if (i > 1 && '\\' != buf[i - 2])
1.131     schwarze  116:                        mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                    117:                            line, i - 1, NULL);
1.63      kristaps  118:
                    119:                for (--i; i && ' ' == buf[i]; i--)
                    120:                        /* Spin back to non-space. */ ;
                    121:
                    122:                /* Jump ahead of escaped whitespace. */
                    123:                i += '\\' == buf[i] ? 2 : 1;
                    124:
                    125:                buf[i] = '\0';
                    126:        }
1.160     schwarze  127:        roff_word_alloc(man, line, offs, buf + offs);
1.65      kristaps  128:
                    129:        /*
                    130:         * End-of-sentence check.  If the last character is an unescaped
                    131:         * EOS character, then flag the node as being the end of a
                    132:         * sentence.  The front-end will know how to interpret this.
                    133:         */
1.67      kristaps  134:
1.65      kristaps  135:        assert(i);
1.122     schwarze  136:        if (mandoc_eos(buf, (size_t)i))
1.167     schwarze  137:                man->last->flags |= NODE_EOS;
1.31      kristaps  138:
1.144     schwarze  139:        man_descope(man, line, offs);
1.165     schwarze  140:        return 1;
1.1       kristaps  141: }
                    142:
1.96      kristaps  143: static int
1.153     schwarze  144: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1       kristaps  145: {
1.151     schwarze  146:        struct roff_node *n;
1.143     schwarze  147:        const char      *cp;
1.151     schwarze  148:        int              tok;
1.134     schwarze  149:        int              i, ppos;
                    150:        int              bline;
1.143     schwarze  151:        char             mac[5];
1.1       kristaps  152:
1.107     kristaps  153:        ppos = offs;
1.9       kristaps  154:
1.56      kristaps  155:        /*
1.107     kristaps  156:         * Copy the first word into a nil-terminated buffer.
1.143     schwarze  157:         * Stop when a space, tab, escape, or eoln is encountered.
1.56      kristaps  158:         */
1.62      kristaps  159:
1.107     kristaps  160:        i = 0;
1.143     schwarze  161:        while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
1.107     kristaps  162:                mac[i++] = buf[offs++];
1.10      kristaps  163:
1.107     kristaps  164:        mac[i] = '\0';
1.1       kristaps  165:
1.159     schwarze  166:        tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;
1.1       kristaps  167:
1.159     schwarze  168:        if (tok == TOKEN_NONE) {
1.136     schwarze  169:                mandoc_msg(MANDOCERR_MACRO, man->parse,
                    170:                    ln, ppos, buf + ppos - 1);
1.165     schwarze  171:                return 1;
1.1       kristaps  172:        }
                    173:
1.143     schwarze  174:        /* Skip a leading escape sequence or tab. */
                    175:
                    176:        switch (buf[offs]) {
                    177:        case '\\':
                    178:                cp = buf + offs + 1;
                    179:                mandoc_escape(&cp, NULL, NULL);
                    180:                offs = cp - buf;
                    181:                break;
                    182:        case '\t':
                    183:                offs++;
                    184:                break;
                    185:        default:
                    186:                break;
                    187:        }
                    188:
                    189:        /* Jump to the next non-whitespace word. */
1.1       kristaps  190:
1.168     schwarze  191:        while (buf[offs] == ' ')
1.107     kristaps  192:                offs++;
1.1       kristaps  193:
1.129     schwarze  194:        /*
1.62      kristaps  195:         * Trailing whitespace.  Note that tabs are allowed to be passed
                    196:         * into the parser as "text", so we only warn about spaces here.
                    197:         */
1.48      kristaps  198:
1.144     schwarze  199:        if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.131     schwarze  200:                mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                    201:                    ln, offs - 1, NULL);
1.48      kristaps  202:
1.129     schwarze  203:        /*
1.149     schwarze  204:         * Some macros break next-line scopes; otherwise, remember
                    205:         * whether we are in next-line scope for a block head.
1.50      kristaps  206:         */
1.34      kristaps  207:
1.149     schwarze  208:        man_breakscope(man, tok);
1.134     schwarze  209:        bline = man->flags & MAN_BLINE;
1.59      kristaps  210:
                    211:        /* Call to handler... */
1.1       kristaps  212:
1.53      kristaps  213:        assert(man_macros[tok].fp);
1.144     schwarze  214:        (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.123     schwarze  215:
                    216:        /* In quick mode (for mandocdb), abort after the NAME section. */
                    217:
1.144     schwarze  218:        if (man->quick && tok == MAN_SH) {
1.130     schwarze  219:                n = man->last;
1.150     schwarze  220:                if (n->type == ROFFT_BODY &&
1.130     schwarze  221:                    strcmp(n->prev->child->string, "NAME"))
1.165     schwarze  222:                        return 2;
1.130     schwarze  223:        }
1.1       kristaps  224:
1.129     schwarze  225:        /*
1.135     schwarze  226:         * If we are in a next-line scope for a block head,
                    227:         * close it out now and switch to the body,
                    228:         * unless the next-line scope is allowed to continue.
1.29      kristaps  229:         */
                    230:
1.135     schwarze  231:        if ( ! bline || man->flags & MAN_ELINE ||
                    232:            man_macros[tok].flags & MAN_NSCOPED)
1.165     schwarze  233:                return 1;
1.29      kristaps  234:
1.144     schwarze  235:        assert(man->flags & MAN_BLINE);
1.119     schwarze  236:        man->flags &= ~MAN_BLINE;
1.11      kristaps  237:
1.144     schwarze  238:        man_unscope(man, man->last->parent);
1.158     schwarze  239:        roff_body_alloc(man, ln, ppos, man->last->tok);
1.165     schwarze  240:        return 1;
1.149     schwarze  241: }
                    242:
                    243: void
1.153     schwarze  244: man_breakscope(struct roff_man *man, int tok)
1.149     schwarze  245: {
1.151     schwarze  246:        struct roff_node *n;
1.149     schwarze  247:
                    248:        /*
                    249:         * An element next line scope is open,
                    250:         * and the new macro is not allowed inside elements.
                    251:         * Delete the element that is being broken.
                    252:         */
                    253:
1.159     schwarze  254:        if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
1.149     schwarze  255:            ! (man_macros[tok].flags & MAN_NSCOPED))) {
                    256:                n = man->last;
1.150     schwarze  257:                assert(n->type != ROFFT_TEXT);
1.149     schwarze  258:                if (man_macros[n->tok].flags & MAN_NSCOPED)
                    259:                        n = n->parent;
                    260:
                    261:                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    262:                    n->line, n->pos, "%s breaks %s",
1.169   ! schwarze  263:                    tok == TOKEN_NONE ? "TS" : roff_name[tok],
        !           264:                    roff_name[n->tok]);
1.149     schwarze  265:
1.158     schwarze  266:                roff_node_delete(man, n);
1.149     schwarze  267:                man->flags &= ~MAN_ELINE;
1.164     schwarze  268:        }
                    269:
                    270:        /*
                    271:         * Weird special case:
                    272:         * Switching fill mode closes section headers.
                    273:         */
                    274:
                    275:        if (man->flags & MAN_BLINE &&
                    276:            (tok == MAN_nf || tok == MAN_fi) &&
                    277:            (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
                    278:                n = man->last;
                    279:                man_unscope(man, n);
                    280:                roff_body_alloc(man, n->line, n->pos, n->tok);
                    281:                man->flags &= ~MAN_BLINE;
1.149     schwarze  282:        }
                    283:
                    284:        /*
                    285:         * A block header next line scope is open,
                    286:         * and the new macro is not allowed inside block headers.
                    287:         * Delete the block that is being broken.
                    288:         */
                    289:
1.159     schwarze  290:        if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
1.149     schwarze  291:            man_macros[tok].flags & MAN_BSCOPE)) {
                    292:                n = man->last;
1.150     schwarze  293:                if (n->type == ROFFT_TEXT)
1.149     schwarze  294:                        n = n->parent;
                    295:                if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
                    296:                        n = n->parent;
                    297:
1.150     schwarze  298:                assert(n->type == ROFFT_HEAD);
1.149     schwarze  299:                n = n->parent;
1.150     schwarze  300:                assert(n->type == ROFFT_BLOCK);
1.149     schwarze  301:                assert(man_macros[n->tok].flags & MAN_SCOPED);
                    302:
                    303:                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    304:                    n->line, n->pos, "%s breaks %s",
1.169   ! schwarze  305:                    tok == TOKEN_NONE ? "TS" : roff_name[tok],
        !           306:                    roff_name[n->tok]);
1.149     schwarze  307:
1.158     schwarze  308:                roff_node_delete(man, n);
1.149     schwarze  309:                man->flags &= ~MAN_BLINE;
                    310:        }
1.112     kristaps  311: }
                    312:
                    313: const struct mparse *
1.153     schwarze  314: man_mparse(const struct roff_man *man)
1.112     kristaps  315: {
                    316:
1.119     schwarze  317:        assert(man && man->parse);
1.165     schwarze  318:        return man->parse;
1.166     schwarze  319: }
                    320:
                    321: void
                    322: man_state(struct roff_man *man, struct roff_node *n)
                    323: {
                    324:
                    325:        switch(n->tok) {
                    326:        case MAN_nf:
                    327:        case MAN_EX:
1.167     schwarze  328:                if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
1.166     schwarze  329:                        mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                    330:                            n->line, n->pos, "nf");
                    331:                man->flags |= MAN_LITERAL;
                    332:                break;
                    333:        case MAN_fi:
                    334:        case MAN_EE:
                    335:                if ( ! (man->flags & MAN_LITERAL) &&
1.167     schwarze  336:                     ! (n->flags & NODE_VALID))
1.166     schwarze  337:                        mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                    338:                            n->line, n->pos, "fi");
                    339:                man->flags &= ~MAN_LITERAL;
                    340:                break;
                    341:        default:
                    342:                break;
                    343:        }
1.167     schwarze  344:        man->last->flags |= NODE_VALID;
1.166     schwarze  345: }
                    346:
                    347: void
                    348: man_validate(struct roff_man *man)
                    349: {
                    350:
                    351:        man->last = man->first;
                    352:        man_node_validate(man);
                    353:        man->flags &= ~MAN_LITERAL;
1.23      kristaps  354: }

CVSweb