Annotation of mandoc/man.c, Revision 1.171
1.171 ! schwarze 1: /* $Id: man.c,v 1.170 2017/04/29 12:45:41 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.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.170 schwarze 148: size_t sz;
149: enum roff_tok tok;
150: int ppos;
1.134 schwarze 151: int bline;
1.170 schwarze 152:
153: /* Determine the line macro. */
1.1 kristaps 154:
1.107 kristaps 155: ppos = offs;
1.170 schwarze 156: tok = TOKEN_NONE;
157: for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
158: offs++;
159: if (sz > 0 && sz < 4)
160: tok = roffhash_find(man->manmac, buf + ppos, sz);
1.159 schwarze 161: if (tok == TOKEN_NONE) {
1.136 schwarze 162: mandoc_msg(MANDOCERR_MACRO, man->parse,
163: ln, ppos, buf + ppos - 1);
1.165 schwarze 164: return 1;
1.1 kristaps 165: }
166:
1.143 schwarze 167: /* Skip a leading escape sequence or tab. */
168:
169: switch (buf[offs]) {
170: case '\\':
171: cp = buf + offs + 1;
172: mandoc_escape(&cp, NULL, NULL);
173: offs = cp - buf;
174: break;
175: case '\t':
176: offs++;
177: break;
178: default:
179: break;
180: }
181:
182: /* Jump to the next non-whitespace word. */
1.1 kristaps 183:
1.168 schwarze 184: while (buf[offs] == ' ')
1.107 kristaps 185: offs++;
1.1 kristaps 186:
1.129 schwarze 187: /*
1.62 kristaps 188: * Trailing whitespace. Note that tabs are allowed to be passed
189: * into the parser as "text", so we only warn about spaces here.
190: */
1.48 kristaps 191:
1.144 schwarze 192: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.131 schwarze 193: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
194: ln, offs - 1, NULL);
1.48 kristaps 195:
1.129 schwarze 196: /*
1.149 schwarze 197: * Some macros break next-line scopes; otherwise, remember
198: * whether we are in next-line scope for a block head.
1.50 kristaps 199: */
1.34 kristaps 200:
1.149 schwarze 201: man_breakscope(man, tok);
1.134 schwarze 202: bline = man->flags & MAN_BLINE;
1.171 ! schwarze 203:
! 204: /*
! 205: * If the line in next-line scope ends with \c, keep the
! 206: * next-line scope open for the subsequent input line.
! 207: * That is not at all portable, only groff >= 1.22.4
! 208: * does it, but *if* this weird idiom occurs in a manual
! 209: * page, that's very likely what the author intended.
! 210: */
! 211:
! 212: if (bline) {
! 213: cp = strchr(buf + offs, '\0') - 2;
! 214: if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
! 215: bline = 0;
! 216: }
1.59 kristaps 217:
218: /* Call to handler... */
1.1 kristaps 219:
1.53 kristaps 220: assert(man_macros[tok].fp);
1.144 schwarze 221: (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.123 schwarze 222:
223: /* In quick mode (for mandocdb), abort after the NAME section. */
224:
1.144 schwarze 225: if (man->quick && tok == MAN_SH) {
1.130 schwarze 226: n = man->last;
1.150 schwarze 227: if (n->type == ROFFT_BODY &&
1.130 schwarze 228: strcmp(n->prev->child->string, "NAME"))
1.165 schwarze 229: return 2;
1.130 schwarze 230: }
1.1 kristaps 231:
1.129 schwarze 232: /*
1.135 schwarze 233: * If we are in a next-line scope for a block head,
234: * close it out now and switch to the body,
235: * unless the next-line scope is allowed to continue.
1.29 kristaps 236: */
237:
1.135 schwarze 238: if ( ! bline || man->flags & MAN_ELINE ||
239: man_macros[tok].flags & MAN_NSCOPED)
1.165 schwarze 240: return 1;
1.29 kristaps 241:
1.144 schwarze 242: assert(man->flags & MAN_BLINE);
1.119 schwarze 243: man->flags &= ~MAN_BLINE;
1.11 kristaps 244:
1.144 schwarze 245: man_unscope(man, man->last->parent);
1.158 schwarze 246: roff_body_alloc(man, ln, ppos, man->last->tok);
1.165 schwarze 247: return 1;
1.149 schwarze 248: }
249:
250: void
1.153 schwarze 251: man_breakscope(struct roff_man *man, int tok)
1.149 schwarze 252: {
1.151 schwarze 253: struct roff_node *n;
1.149 schwarze 254:
255: /*
256: * An element next line scope is open,
257: * and the new macro is not allowed inside elements.
258: * Delete the element that is being broken.
259: */
260:
1.159 schwarze 261: if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
1.149 schwarze 262: ! (man_macros[tok].flags & MAN_NSCOPED))) {
263: n = man->last;
1.150 schwarze 264: assert(n->type != ROFFT_TEXT);
1.149 schwarze 265: if (man_macros[n->tok].flags & MAN_NSCOPED)
266: n = n->parent;
267:
268: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
269: n->line, n->pos, "%s breaks %s",
1.169 schwarze 270: tok == TOKEN_NONE ? "TS" : roff_name[tok],
271: roff_name[n->tok]);
1.149 schwarze 272:
1.158 schwarze 273: roff_node_delete(man, n);
1.149 schwarze 274: man->flags &= ~MAN_ELINE;
1.164 schwarze 275: }
276:
277: /*
278: * Weird special case:
279: * Switching fill mode closes section headers.
280: */
281:
282: if (man->flags & MAN_BLINE &&
283: (tok == MAN_nf || tok == MAN_fi) &&
284: (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
285: n = man->last;
286: man_unscope(man, n);
287: roff_body_alloc(man, n->line, n->pos, n->tok);
288: man->flags &= ~MAN_BLINE;
1.149 schwarze 289: }
290:
291: /*
292: * A block header next line scope is open,
293: * and the new macro is not allowed inside block headers.
294: * Delete the block that is being broken.
295: */
296:
1.159 schwarze 297: if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
1.149 schwarze 298: man_macros[tok].flags & MAN_BSCOPE)) {
299: n = man->last;
1.150 schwarze 300: if (n->type == ROFFT_TEXT)
1.149 schwarze 301: n = n->parent;
302: if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
303: n = n->parent;
304:
1.150 schwarze 305: assert(n->type == ROFFT_HEAD);
1.149 schwarze 306: n = n->parent;
1.150 schwarze 307: assert(n->type == ROFFT_BLOCK);
1.149 schwarze 308: assert(man_macros[n->tok].flags & MAN_SCOPED);
309:
310: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
311: n->line, n->pos, "%s breaks %s",
1.169 schwarze 312: tok == TOKEN_NONE ? "TS" : roff_name[tok],
313: roff_name[n->tok]);
1.149 schwarze 314:
1.158 schwarze 315: roff_node_delete(man, n);
1.149 schwarze 316: man->flags &= ~MAN_BLINE;
317: }
1.112 kristaps 318: }
319:
320: const struct mparse *
1.153 schwarze 321: man_mparse(const struct roff_man *man)
1.112 kristaps 322: {
323:
1.119 schwarze 324: assert(man && man->parse);
1.165 schwarze 325: return man->parse;
1.166 schwarze 326: }
327:
328: void
329: man_state(struct roff_man *man, struct roff_node *n)
330: {
331:
332: switch(n->tok) {
333: case MAN_nf:
334: case MAN_EX:
1.167 schwarze 335: if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
1.166 schwarze 336: mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
337: n->line, n->pos, "nf");
338: man->flags |= MAN_LITERAL;
339: break;
340: case MAN_fi:
341: case MAN_EE:
342: if ( ! (man->flags & MAN_LITERAL) &&
1.167 schwarze 343: ! (n->flags & NODE_VALID))
1.166 schwarze 344: mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
345: n->line, n->pos, "fi");
346: man->flags &= ~MAN_LITERAL;
347: break;
348: default:
349: break;
350: }
1.167 schwarze 351: man->last->flags |= NODE_VALID;
1.166 schwarze 352: }
353:
354: void
355: man_validate(struct roff_man *man)
356: {
357:
358: man->last = man->first;
359: man_node_validate(man);
360: man->flags &= ~MAN_LITERAL;
1.23 kristaps 361: }
CVSweb