Annotation of src/usr.bin/mandoc/man.c, Revision 1.123
1.123 ! schwarze 1: /* $OpenBSD: man.c,v 1.122 2017/06/03 15:54:09 schwarze Exp $ */
1.1 kristaps 2: /*
1.52 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.119 schwarze 4: * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
1.74 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.2 schwarze 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.98 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.98 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 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.14 schwarze 19: #include <sys/types.h>
20:
1.1 kristaps 21: #include <assert.h>
1.76 schwarze 22: #include <ctype.h>
1.1 kristaps 23: #include <stdarg.h>
24: #include <stdlib.h>
25: #include <stdio.h>
26: #include <string.h>
27:
1.98 schwarze 28: #include "mandoc_aux.h"
29: #include "mandoc.h"
30: #include "roff.h"
1.59 schwarze 31: #include "man.h"
1.98 schwarze 32: #include "libmandoc.h"
1.106 schwarze 33: #include "roff_int.h"
1.1 kristaps 34: #include "libman.h"
35:
1.101 schwarze 36: static void man_descope(struct roff_man *, int, int);
37: static int man_ptext(struct roff_man *, int, char *, int);
38: static int man_pmacro(struct roff_man *, int, char *, int);
1.1 kristaps 39:
40:
41: int
1.101 schwarze 42: man_parseln(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 43: {
1.25 schwarze 44:
1.98 schwarze 45: if (man->last->type != ROFFT_EQN || ln > man->last->line)
1.89 schwarze 46: man->flags |= MAN_NEWLINE;
1.54 schwarze 47:
1.113 schwarze 48: return roff_getcontrol(man->roff, buf, &offs) ?
1.79 schwarze 49: man_pmacro(man, ln, buf, offs) :
1.113 schwarze 50: man_ptext(man, ln, buf, offs);
1.1 kristaps 51: }
52:
1.92 schwarze 53: static void
1.101 schwarze 54: man_descope(struct roff_man *man, int line, int offs)
1.52 schwarze 55: {
56: /*
57: * Co-ordinate what happens with having a next-line scope open:
58: * first close out the element scope (if applicable), then close
59: * out the block scope (also if applicable).
60: */
61:
1.92 schwarze 62: if (man->flags & MAN_ELINE) {
1.69 schwarze 63: man->flags &= ~MAN_ELINE;
1.92 schwarze 64: man_unscope(man, man->last->parent);
1.52 schwarze 65: }
1.92 schwarze 66: if ( ! (man->flags & MAN_BLINE))
67: return;
1.69 schwarze 68: man->flags &= ~MAN_BLINE;
1.92 schwarze 69: man_unscope(man, man->last->parent);
1.106 schwarze 70: roff_body_alloc(man, line, offs, man->last->tok);
1.52 schwarze 71: }
72:
1.1 kristaps 73: static int
1.101 schwarze 74: man_ptext(struct roff_man *man, int line, char *buf, int offs)
1.1 kristaps 75: {
1.27 schwarze 76: int i;
1.123 ! schwarze 77: const char *cp, *sp;
! 78: char *ep;
1.26 schwarze 79:
1.10 schwarze 80: /* Literal free-form text whitespace is preserved. */
81:
1.92 schwarze 82: if (man->flags & MAN_LITERAL) {
1.108 schwarze 83: roff_word_alloc(man, line, offs, buf + offs);
1.92 schwarze 84: man_descope(man, line, offs);
1.113 schwarze 85: return 1;
1.10 schwarze 86: }
87:
1.92 schwarze 88: for (i = offs; buf[i] == ' '; i++)
1.10 schwarze 89: /* Skip leading whitespace. */ ;
1.18 schwarze 90:
1.71 schwarze 91: /*
1.123 ! schwarze 92: * Blank lines are ignored in next line scope
! 93: * and right after headings and cancel preceding \c,
! 94: * but add a single vertical space elsewhere.
1.71 schwarze 95: */
96:
1.92 schwarze 97: if (buf[i] == '\0') {
1.123 ! schwarze 98: if (man->flags & (MAN_ELINE | MAN_BLINE)) {
1.122 schwarze 99: mandoc_msg(MANDOCERR_BLK_BLANK, man->parse,
100: line, 0, NULL);
1.123 ! schwarze 101: return 1;
1.71 schwarze 102: }
1.123 ! schwarze 103: if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
! 104: return 1;
! 105: switch (man->last->type) {
! 106: case ROFFT_TEXT:
! 107: sp = man->last->string;
! 108: cp = ep = strchr(sp, '\0') - 2;
! 109: if (cp < sp || cp[0] != '\\' || cp[1] != 'c')
! 110: break;
! 111: while (cp > sp && cp[-1] == '\\')
! 112: cp--;
! 113: if ((ep - cp) % 2)
! 114: break;
! 115: *ep = '\0';
! 116: return 1;
! 117: default:
! 118: break;
! 119: }
! 120: roff_elem_alloc(man, line, offs, ROFF_sp);
! 121: man->next = ROFF_NEXT_SIBLING;
1.113 schwarze 122: return 1;
1.10 schwarze 123: }
1.1 kristaps 124:
1.79 schwarze 125: /*
1.27 schwarze 126: * Warn if the last un-escaped character is whitespace. Then
1.79 schwarze 127: * strip away the remaining spaces (tabs stay!).
1.27 schwarze 128: */
1.18 schwarze 129:
1.27 schwarze 130: i = (int)strlen(buf);
131: assert(i);
1.18 schwarze 132:
1.27 schwarze 133: if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
134: if (i > 1 && '\\' != buf[i - 2])
1.81 schwarze 135: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
136: line, i - 1, NULL);
1.18 schwarze 137:
1.27 schwarze 138: for (--i; i && ' ' == buf[i]; i--)
139: /* Spin back to non-space. */ ;
1.10 schwarze 140:
1.27 schwarze 141: /* Jump ahead of escaped whitespace. */
142: i += '\\' == buf[i] ? 2 : 1;
1.18 schwarze 143:
1.27 schwarze 144: buf[i] = '\0';
1.10 schwarze 145: }
1.108 schwarze 146: roff_word_alloc(man, line, offs, buf + offs);
1.28 schwarze 147:
148: /*
149: * End-of-sentence check. If the last character is an unescaped
150: * EOS character, then flag the node as being the end of a
151: * sentence. The front-end will know how to interpret this.
152: */
153:
154: assert(i);
1.72 schwarze 155: if (mandoc_eos(buf, (size_t)i))
1.115 schwarze 156: man->last->flags |= NODE_EOS;
1.10 schwarze 157:
1.92 schwarze 158: man_descope(man, line, offs);
1.113 schwarze 159: return 1;
1.1 kristaps 160: }
161:
1.53 schwarze 162: static int
1.101 schwarze 163: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 164: {
1.99 schwarze 165: struct roff_node *n;
1.91 schwarze 166: const char *cp;
1.118 schwarze 167: size_t sz;
168: enum roff_tok tok;
169: int ppos;
1.84 schwarze 170: int bline;
1.118 schwarze 171:
172: /* Determine the line macro. */
1.1 kristaps 173:
1.59 schwarze 174: ppos = offs;
1.118 schwarze 175: tok = TOKEN_NONE;
176: for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
177: offs++;
178: if (sz > 0 && sz < 4)
179: tok = roffhash_find(man->manmac, buf + ppos, sz);
1.107 schwarze 180: if (tok == TOKEN_NONE) {
1.85 schwarze 181: mandoc_msg(MANDOCERR_MACRO, man->parse,
182: ln, ppos, buf + ppos - 1);
1.113 schwarze 183: return 1;
1.1 kristaps 184: }
185:
1.91 schwarze 186: /* Skip a leading escape sequence or tab. */
187:
188: switch (buf[offs]) {
189: case '\\':
190: cp = buf + offs + 1;
191: mandoc_escape(&cp, NULL, NULL);
192: offs = cp - buf;
193: break;
194: case '\t':
195: offs++;
196: break;
197: default:
198: break;
199: }
200:
201: /* Jump to the next non-whitespace word. */
1.1 kristaps 202:
1.116 schwarze 203: while (buf[offs] == ' ')
1.59 schwarze 204: offs++;
1.18 schwarze 205:
1.79 schwarze 206: /*
1.27 schwarze 207: * Trailing whitespace. Note that tabs are allowed to be passed
208: * into the parser as "text", so we only warn about spaces here.
209: */
1.18 schwarze 210:
1.92 schwarze 211: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.81 schwarze 212: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
213: ln, offs - 1, NULL);
1.1 kristaps 214:
1.79 schwarze 215: /*
1.97 schwarze 216: * Some macros break next-line scopes; otherwise, remember
217: * whether we are in next-line scope for a block head.
1.21 schwarze 218: */
219:
1.97 schwarze 220: man_breakscope(man, tok);
1.84 schwarze 221: bline = man->flags & MAN_BLINE;
1.119 schwarze 222:
223: /*
224: * If the line in next-line scope ends with \c, keep the
225: * next-line scope open for the subsequent input line.
226: * That is not at all portable, only groff >= 1.22.4
227: * does it, but *if* this weird idiom occurs in a manual
228: * page, that's very likely what the author intended.
229: */
230:
231: if (bline) {
232: cp = strchr(buf + offs, '\0') - 2;
233: if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
234: bline = 0;
235: }
1.24 schwarze 236:
237: /* Call to handler... */
1.1 kristaps 238:
1.22 schwarze 239: assert(man_macros[tok].fp);
1.92 schwarze 240: (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.73 schwarze 241:
242: /* In quick mode (for mandocdb), abort after the NAME section. */
243:
1.92 schwarze 244: if (man->quick && tok == MAN_SH) {
1.80 schwarze 245: n = man->last;
1.98 schwarze 246: if (n->type == ROFFT_BODY &&
1.80 schwarze 247: strcmp(n->prev->child->string, "NAME"))
1.113 schwarze 248: return 2;
1.80 schwarze 249: }
1.1 kristaps 250:
1.79 schwarze 251: /*
1.84 schwarze 252: * If we are in a next-line scope for a block head,
253: * close it out now and switch to the body,
254: * unless the next-line scope is allowed to continue.
1.21 schwarze 255: */
256:
1.84 schwarze 257: if ( ! bline || man->flags & MAN_ELINE ||
258: man_macros[tok].flags & MAN_NSCOPED)
1.113 schwarze 259: return 1;
1.1 kristaps 260:
1.92 schwarze 261: assert(man->flags & MAN_BLINE);
1.69 schwarze 262: man->flags &= ~MAN_BLINE;
1.1 kristaps 263:
1.92 schwarze 264: man_unscope(man, man->last->parent);
1.106 schwarze 265: roff_body_alloc(man, ln, ppos, man->last->tok);
1.113 schwarze 266: return 1;
1.97 schwarze 267: }
268:
269: void
1.101 schwarze 270: man_breakscope(struct roff_man *man, int tok)
1.97 schwarze 271: {
1.99 schwarze 272: struct roff_node *n;
1.97 schwarze 273:
274: /*
275: * An element next line scope is open,
276: * and the new macro is not allowed inside elements.
277: * Delete the element that is being broken.
278: */
279:
1.121 schwarze 280: if (man->flags & MAN_ELINE && (tok < MAN_TH ||
1.97 schwarze 281: ! (man_macros[tok].flags & MAN_NSCOPED))) {
282: n = man->last;
1.98 schwarze 283: assert(n->type != ROFFT_TEXT);
1.97 schwarze 284: if (man_macros[n->tok].flags & MAN_NSCOPED)
285: n = n->parent;
286:
287: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
288: n->line, n->pos, "%s breaks %s",
1.121 schwarze 289: roff_name[tok], roff_name[n->tok]);
1.97 schwarze 290:
1.106 schwarze 291: roff_node_delete(man, n);
1.97 schwarze 292: man->flags &= ~MAN_ELINE;
1.112 schwarze 293: }
294:
295: /*
296: * Weird special case:
297: * Switching fill mode closes section headers.
298: */
299:
300: if (man->flags & MAN_BLINE &&
301: (tok == MAN_nf || tok == MAN_fi) &&
302: (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
303: n = man->last;
304: man_unscope(man, n);
305: roff_body_alloc(man, n->line, n->pos, n->tok);
306: man->flags &= ~MAN_BLINE;
1.97 schwarze 307: }
308:
309: /*
310: * A block header next line scope is open,
311: * and the new macro is not allowed inside block headers.
312: * Delete the block that is being broken.
313: */
314:
1.121 schwarze 315: if (man->flags & MAN_BLINE && (tok < MAN_TH ||
1.97 schwarze 316: man_macros[tok].flags & MAN_BSCOPE)) {
317: n = man->last;
1.98 schwarze 318: if (n->type == ROFFT_TEXT)
1.97 schwarze 319: n = n->parent;
320: if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
321: n = n->parent;
322:
1.98 schwarze 323: assert(n->type == ROFFT_HEAD);
1.97 schwarze 324: n = n->parent;
1.98 schwarze 325: assert(n->type == ROFFT_BLOCK);
1.97 schwarze 326: assert(man_macros[n->tok].flags & MAN_SCOPED);
327:
328: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
329: n->line, n->pos, "%s breaks %s",
1.121 schwarze 330: roff_name[tok], roff_name[n->tok]);
1.97 schwarze 331:
1.106 schwarze 332: roff_node_delete(man, n);
1.97 schwarze 333: man->flags &= ~MAN_BLINE;
334: }
1.62 schwarze 335: }
336:
337: const struct mparse *
1.101 schwarze 338: man_mparse(const struct roff_man *man)
1.62 schwarze 339: {
340:
1.69 schwarze 341: assert(man && man->parse);
1.113 schwarze 342: return man->parse;
1.114 schwarze 343: }
344:
345: void
346: man_state(struct roff_man *man, struct roff_node *n)
347: {
348:
349: switch(n->tok) {
350: case MAN_nf:
351: case MAN_EX:
1.115 schwarze 352: if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
1.114 schwarze 353: mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
354: n->line, n->pos, "nf");
355: man->flags |= MAN_LITERAL;
356: break;
357: case MAN_fi:
358: case MAN_EE:
359: if ( ! (man->flags & MAN_LITERAL) &&
1.115 schwarze 360: ! (n->flags & NODE_VALID))
1.114 schwarze 361: mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
362: n->line, n->pos, "fi");
363: man->flags &= ~MAN_LITERAL;
364: break;
365: default:
366: break;
367: }
1.115 schwarze 368: man->last->flags |= NODE_VALID;
1.114 schwarze 369: }
370:
371: void
372: man_validate(struct roff_man *man)
373: {
374:
375: man->last = man->first;
376: man_node_validate(man);
377: man->flags &= ~MAN_LITERAL;
1.4 schwarze 378: }
![[BACK]](/icons/back.gif){kind=icon}
Return to man.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc