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

Annotation of mandoc/man.c, Revision 1.175

1.175   ! schwarze    1: /*     $Id: man.c,v 1.174 2017/06/03 15:55:24 schwarze Exp $ */
1.1       kristaps    2: /*
1.102     schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.171     schwarze    4:  * Copyright (c) 2013, 2014, 2015, 2017 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.175   ! schwarze   79:        const char      *cp, *sp;
        !            80:        char            *ep;
1.60      kristaps   81:
1.35      kristaps   82:        /* Literal free-form text whitespace is preserved. */
                     83:
1.144     schwarze   84:        if (man->flags & MAN_LITERAL) {
1.160     schwarze   85:                roff_word_alloc(man, line, offs, buf + offs);
1.144     schwarze   86:                man_descope(man, line, offs);
1.165     schwarze   87:                return 1;
1.35      kristaps   88:        }
                     89:
1.144     schwarze   90:        for (i = offs; buf[i] == ' '; i++)
1.31      kristaps   91:                /* Skip leading whitespace. */ ;
1.48      kristaps   92:
1.121     schwarze   93:        /*
1.175   ! schwarze   94:         * Blank lines are ignored in next line scope
        !            95:         * and right after headings and cancel preceding \c,
        !            96:         * but add a single vertical space elsewhere.
1.121     schwarze   97:         */
                     98:
1.144     schwarze   99:        if (buf[i] == '\0') {
1.175   ! schwarze  100:                if (man->flags & (MAN_ELINE | MAN_BLINE)) {
1.174     schwarze  101:                        mandoc_msg(MANDOCERR_BLK_BLANK, man->parse,
                    102:                            line, 0, NULL);
1.175   ! schwarze  103:                        return 1;
1.121     schwarze  104:                }
1.175   ! schwarze  105:                if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
        !           106:                        return 1;
        !           107:                switch (man->last->type) {
        !           108:                case ROFFT_TEXT:
        !           109:                        sp = man->last->string;
        !           110:                        cp = ep = strchr(sp, '\0') - 2;
        !           111:                        if (cp < sp || cp[0] != '\\' || cp[1] != 'c')
        !           112:                                break;
        !           113:                        while (cp > sp && cp[-1] == '\\')
        !           114:                                cp--;
        !           115:                        if ((ep - cp) % 2)
        !           116:                                break;
        !           117:                        *ep = '\0';
        !           118:                        return 1;
        !           119:                default:
        !           120:                        break;
        !           121:                }
        !           122:                roff_elem_alloc(man, line, offs, ROFF_sp);
        !           123:                man->next = ROFF_NEXT_SIBLING;
1.165     schwarze  124:                return 1;
1.31      kristaps  125:        }
                    126:
1.129     schwarze  127:        /*
1.63      kristaps  128:         * Warn if the last un-escaped character is whitespace. Then
1.129     schwarze  129:         * strip away the remaining spaces (tabs stay!).
1.63      kristaps  130:         */
1.29      kristaps  131:
1.61      kristaps  132:        i = (int)strlen(buf);
                    133:        assert(i);
1.49      kristaps  134:
1.63      kristaps  135:        if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
1.64      kristaps  136:                if (i > 1 && '\\' != buf[i - 2])
1.131     schwarze  137:                        mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                    138:                            line, i - 1, NULL);
1.63      kristaps  139:
                    140:                for (--i; i && ' ' == buf[i]; i--)
                    141:                        /* Spin back to non-space. */ ;
                    142:
                    143:                /* Jump ahead of escaped whitespace. */
                    144:                i += '\\' == buf[i] ? 2 : 1;
                    145:
                    146:                buf[i] = '\0';
                    147:        }
1.160     schwarze  148:        roff_word_alloc(man, line, offs, buf + offs);
1.65      kristaps  149:
                    150:        /*
                    151:         * End-of-sentence check.  If the last character is an unescaped
                    152:         * EOS character, then flag the node as being the end of a
                    153:         * sentence.  The front-end will know how to interpret this.
                    154:         */
1.67      kristaps  155:
1.65      kristaps  156:        assert(i);
1.122     schwarze  157:        if (mandoc_eos(buf, (size_t)i))
1.167     schwarze  158:                man->last->flags |= NODE_EOS;
1.31      kristaps  159:
1.144     schwarze  160:        man_descope(man, line, offs);
1.165     schwarze  161:        return 1;
1.1       kristaps  162: }
                    163:
1.96      kristaps  164: static int
1.153     schwarze  165: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1       kristaps  166: {
1.151     schwarze  167:        struct roff_node *n;
1.143     schwarze  168:        const char      *cp;
1.170     schwarze  169:        size_t           sz;
                    170:        enum roff_tok    tok;
                    171:        int              ppos;
1.134     schwarze  172:        int              bline;
1.170     schwarze  173:
                    174:        /* Determine the line macro. */
1.1       kristaps  175:
1.107     kristaps  176:        ppos = offs;
1.170     schwarze  177:        tok = TOKEN_NONE;
                    178:        for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
                    179:                offs++;
                    180:        if (sz > 0 && sz < 4)
                    181:                tok = roffhash_find(man->manmac, buf + ppos, sz);
1.159     schwarze  182:        if (tok == TOKEN_NONE) {
1.136     schwarze  183:                mandoc_msg(MANDOCERR_MACRO, man->parse,
                    184:                    ln, ppos, buf + ppos - 1);
1.165     schwarze  185:                return 1;
1.1       kristaps  186:        }
                    187:
1.143     schwarze  188:        /* Skip a leading escape sequence or tab. */
                    189:
                    190:        switch (buf[offs]) {
                    191:        case '\\':
                    192:                cp = buf + offs + 1;
                    193:                mandoc_escape(&cp, NULL, NULL);
                    194:                offs = cp - buf;
                    195:                break;
                    196:        case '\t':
                    197:                offs++;
                    198:                break;
                    199:        default:
                    200:                break;
                    201:        }
                    202:
                    203:        /* Jump to the next non-whitespace word. */
1.1       kristaps  204:
1.168     schwarze  205:        while (buf[offs] == ' ')
1.107     kristaps  206:                offs++;
1.1       kristaps  207:
1.129     schwarze  208:        /*
1.62      kristaps  209:         * Trailing whitespace.  Note that tabs are allowed to be passed
                    210:         * into the parser as "text", so we only warn about spaces here.
                    211:         */
1.48      kristaps  212:
1.144     schwarze  213:        if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.131     schwarze  214:                mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
                    215:                    ln, offs - 1, NULL);
1.48      kristaps  216:
1.129     schwarze  217:        /*
1.149     schwarze  218:         * Some macros break next-line scopes; otherwise, remember
                    219:         * whether we are in next-line scope for a block head.
1.50      kristaps  220:         */
1.34      kristaps  221:
1.149     schwarze  222:        man_breakscope(man, tok);
1.134     schwarze  223:        bline = man->flags & MAN_BLINE;
1.171     schwarze  224:
                    225:        /*
                    226:         * If the line in next-line scope ends with \c, keep the
                    227:         * next-line scope open for the subsequent input line.
                    228:         * That is not at all portable, only groff >= 1.22.4
                    229:         * does it, but *if* this weird idiom occurs in a manual
                    230:         * page, that's very likely what the author intended.
                    231:         */
                    232:
                    233:        if (bline) {
                    234:                cp = strchr(buf + offs, '\0') - 2;
                    235:                if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
                    236:                        bline = 0;
                    237:        }
1.59      kristaps  238:
                    239:        /* Call to handler... */
1.1       kristaps  240:
1.53      kristaps  241:        assert(man_macros[tok].fp);
1.144     schwarze  242:        (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.123     schwarze  243:
                    244:        /* In quick mode (for mandocdb), abort after the NAME section. */
                    245:
1.144     schwarze  246:        if (man->quick && tok == MAN_SH) {
1.130     schwarze  247:                n = man->last;
1.150     schwarze  248:                if (n->type == ROFFT_BODY &&
1.130     schwarze  249:                    strcmp(n->prev->child->string, "NAME"))
1.165     schwarze  250:                        return 2;
1.130     schwarze  251:        }
1.1       kristaps  252:
1.129     schwarze  253:        /*
1.135     schwarze  254:         * If we are in a next-line scope for a block head,
                    255:         * close it out now and switch to the body,
                    256:         * unless the next-line scope is allowed to continue.
1.29      kristaps  257:         */
                    258:
1.135     schwarze  259:        if ( ! bline || man->flags & MAN_ELINE ||
                    260:            man_macros[tok].flags & MAN_NSCOPED)
1.165     schwarze  261:                return 1;
1.29      kristaps  262:
1.144     schwarze  263:        assert(man->flags & MAN_BLINE);
1.119     schwarze  264:        man->flags &= ~MAN_BLINE;
1.11      kristaps  265:
1.144     schwarze  266:        man_unscope(man, man->last->parent);
1.158     schwarze  267:        roff_body_alloc(man, ln, ppos, man->last->tok);
1.165     schwarze  268:        return 1;
1.149     schwarze  269: }
                    270:
                    271: void
1.153     schwarze  272: man_breakscope(struct roff_man *man, int tok)
1.149     schwarze  273: {
1.151     schwarze  274:        struct roff_node *n;
1.149     schwarze  275:
                    276:        /*
                    277:         * An element next line scope is open,
                    278:         * and the new macro is not allowed inside elements.
                    279:         * Delete the element that is being broken.
                    280:         */
                    281:
1.173     schwarze  282:        if (man->flags & MAN_ELINE && (tok < MAN_TH ||
1.149     schwarze  283:            ! (man_macros[tok].flags & MAN_NSCOPED))) {
                    284:                n = man->last;
1.150     schwarze  285:                assert(n->type != ROFFT_TEXT);
1.149     schwarze  286:                if (man_macros[n->tok].flags & MAN_NSCOPED)
                    287:                        n = n->parent;
                    288:
                    289:                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    290:                    n->line, n->pos, "%s breaks %s",
1.173     schwarze  291:                    roff_name[tok], roff_name[n->tok]);
1.149     schwarze  292:
1.158     schwarze  293:                roff_node_delete(man, n);
1.149     schwarze  294:                man->flags &= ~MAN_ELINE;
1.164     schwarze  295:        }
                    296:
                    297:        /*
                    298:         * Weird special case:
                    299:         * Switching fill mode closes section headers.
                    300:         */
                    301:
                    302:        if (man->flags & MAN_BLINE &&
                    303:            (tok == MAN_nf || tok == MAN_fi) &&
                    304:            (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
                    305:                n = man->last;
                    306:                man_unscope(man, n);
                    307:                roff_body_alloc(man, n->line, n->pos, n->tok);
                    308:                man->flags &= ~MAN_BLINE;
1.149     schwarze  309:        }
                    310:
                    311:        /*
                    312:         * A block header next line scope is open,
                    313:         * and the new macro is not allowed inside block headers.
                    314:         * Delete the block that is being broken.
                    315:         */
                    316:
1.173     schwarze  317:        if (man->flags & MAN_BLINE && (tok < MAN_TH ||
1.149     schwarze  318:            man_macros[tok].flags & MAN_BSCOPE)) {
                    319:                n = man->last;
1.150     schwarze  320:                if (n->type == ROFFT_TEXT)
1.149     schwarze  321:                        n = n->parent;
                    322:                if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
                    323:                        n = n->parent;
                    324:
1.150     schwarze  325:                assert(n->type == ROFFT_HEAD);
1.149     schwarze  326:                n = n->parent;
1.150     schwarze  327:                assert(n->type == ROFFT_BLOCK);
1.149     schwarze  328:                assert(man_macros[n->tok].flags & MAN_SCOPED);
                    329:
                    330:                mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
                    331:                    n->line, n->pos, "%s breaks %s",
1.173     schwarze  332:                    roff_name[tok], roff_name[n->tok]);
1.149     schwarze  333:
1.158     schwarze  334:                roff_node_delete(man, n);
1.149     schwarze  335:                man->flags &= ~MAN_BLINE;
                    336:        }
1.112     kristaps  337: }
                    338:
                    339: const struct mparse *
1.153     schwarze  340: man_mparse(const struct roff_man *man)
1.112     kristaps  341: {
                    342:
1.119     schwarze  343:        assert(man && man->parse);
1.165     schwarze  344:        return man->parse;
1.166     schwarze  345: }
                    346:
                    347: void
                    348: man_state(struct roff_man *man, struct roff_node *n)
                    349: {
                    350:
                    351:        switch(n->tok) {
                    352:        case MAN_nf:
                    353:        case MAN_EX:
1.167     schwarze  354:                if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
1.166     schwarze  355:                        mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                    356:                            n->line, n->pos, "nf");
                    357:                man->flags |= MAN_LITERAL;
                    358:                break;
                    359:        case MAN_fi:
                    360:        case MAN_EE:
                    361:                if ( ! (man->flags & MAN_LITERAL) &&
1.167     schwarze  362:                     ! (n->flags & NODE_VALID))
1.166     schwarze  363:                        mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                    364:                            n->line, n->pos, "fi");
                    365:                man->flags &= ~MAN_LITERAL;
                    366:                break;
                    367:        default:
                    368:                break;
                    369:        }
1.167     schwarze  370:        man->last->flags |= NODE_VALID;
1.166     schwarze  371: }
                    372:
                    373: void
                    374: man_validate(struct roff_man *man)
                    375: {
                    376:
                    377:        man->last = man->first;
                    378:        man_node_validate(man);
                    379:        man->flags &= ~MAN_LITERAL;
1.23      kristaps  380: }

CVSweb