Annotation of src/usr.bin/mandoc/man.c, Revision 1.117
1.117 ! schwarze 1: /* $OpenBSD: man.c,v 1.116 2017/03/03 13:55:06 schwarze Exp $ */
1.1 kristaps 2: /*
1.52 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.97 schwarze 4: * Copyright (c) 2013, 2014, 2015 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.26 schwarze 77:
1.10 schwarze 78: /* Literal free-form text whitespace is preserved. */
79:
1.92 schwarze 80: if (man->flags & MAN_LITERAL) {
1.108 schwarze 81: roff_word_alloc(man, line, offs, buf + offs);
1.92 schwarze 82: man_descope(man, line, offs);
1.113 schwarze 83: return 1;
1.10 schwarze 84: }
85:
1.92 schwarze 86: for (i = offs; buf[i] == ' '; i++)
1.10 schwarze 87: /* Skip leading whitespace. */ ;
1.18 schwarze 88:
1.71 schwarze 89: /*
90: * Blank lines are ignored right after headings
91: * but add a single vertical space elsewhere.
92: */
93:
1.92 schwarze 94: if (buf[i] == '\0') {
1.27 schwarze 95: /* Allocate a blank entry. */
1.92 schwarze 96: if (man->last->tok != MAN_SH &&
97: man->last->tok != MAN_SS) {
1.109 schwarze 98: roff_elem_alloc(man, line, offs, MAN_sp);
1.101 schwarze 99: man->next = ROFF_NEXT_SIBLING;
1.71 schwarze 100: }
1.113 schwarze 101: return 1;
1.10 schwarze 102: }
1.1 kristaps 103:
1.79 schwarze 104: /*
1.27 schwarze 105: * Warn if the last un-escaped character is whitespace. Then
1.79 schwarze 106: * strip away the remaining spaces (tabs stay!).
1.27 schwarze 107: */
1.18 schwarze 108:
1.27 schwarze 109: i = (int)strlen(buf);
110: assert(i);
1.18 schwarze 111:
1.27 schwarze 112: if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
113: if (i > 1 && '\\' != buf[i - 2])
1.81 schwarze 114: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
115: line, i - 1, NULL);
1.18 schwarze 116:
1.27 schwarze 117: for (--i; i && ' ' == buf[i]; i--)
118: /* Spin back to non-space. */ ;
1.10 schwarze 119:
1.27 schwarze 120: /* Jump ahead of escaped whitespace. */
121: i += '\\' == buf[i] ? 2 : 1;
1.18 schwarze 122:
1.27 schwarze 123: buf[i] = '\0';
1.10 schwarze 124: }
1.108 schwarze 125: roff_word_alloc(man, line, offs, buf + offs);
1.28 schwarze 126:
127: /*
128: * End-of-sentence check. If the last character is an unescaped
129: * EOS character, then flag the node as being the end of a
130: * sentence. The front-end will know how to interpret this.
131: */
132:
133: assert(i);
1.72 schwarze 134: if (mandoc_eos(buf, (size_t)i))
1.115 schwarze 135: man->last->flags |= NODE_EOS;
1.10 schwarze 136:
1.92 schwarze 137: man_descope(man, line, offs);
1.113 schwarze 138: return 1;
1.1 kristaps 139: }
140:
1.53 schwarze 141: static int
1.101 schwarze 142: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 143: {
1.99 schwarze 144: struct roff_node *n;
1.91 schwarze 145: const char *cp;
1.99 schwarze 146: int tok;
1.84 schwarze 147: int i, ppos;
148: int bline;
1.91 schwarze 149: char mac[5];
1.1 kristaps 150:
1.59 schwarze 151: ppos = offs;
1.1 kristaps 152:
1.23 schwarze 153: /*
1.59 schwarze 154: * Copy the first word into a nil-terminated buffer.
1.91 schwarze 155: * Stop when a space, tab, escape, or eoln is encountered.
1.23 schwarze 156: */
1.27 schwarze 157:
1.59 schwarze 158: i = 0;
1.91 schwarze 159: while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
1.59 schwarze 160: mac[i++] = buf[offs++];
1.1 kristaps 161:
1.59 schwarze 162: mac[i] = '\0';
1.1 kristaps 163:
1.107 schwarze 164: tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;
1.1 kristaps 165:
1.107 schwarze 166: if (tok == TOKEN_NONE) {
1.85 schwarze 167: mandoc_msg(MANDOCERR_MACRO, man->parse,
168: ln, ppos, buf + ppos - 1);
1.113 schwarze 169: return 1;
1.1 kristaps 170: }
171:
1.91 schwarze 172: /* Skip a leading escape sequence or tab. */
173:
174: switch (buf[offs]) {
175: case '\\':
176: cp = buf + offs + 1;
177: mandoc_escape(&cp, NULL, NULL);
178: offs = cp - buf;
179: break;
180: case '\t':
181: offs++;
182: break;
183: default:
184: break;
185: }
186:
187: /* Jump to the next non-whitespace word. */
1.1 kristaps 188:
1.116 schwarze 189: while (buf[offs] == ' ')
1.59 schwarze 190: offs++;
1.18 schwarze 191:
1.79 schwarze 192: /*
1.27 schwarze 193: * Trailing whitespace. Note that tabs are allowed to be passed
194: * into the parser as "text", so we only warn about spaces here.
195: */
1.18 schwarze 196:
1.92 schwarze 197: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.81 schwarze 198: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
199: ln, offs - 1, NULL);
1.1 kristaps 200:
1.79 schwarze 201: /*
1.97 schwarze 202: * Some macros break next-line scopes; otherwise, remember
203: * whether we are in next-line scope for a block head.
1.21 schwarze 204: */
205:
1.97 schwarze 206: man_breakscope(man, tok);
1.84 schwarze 207: bline = man->flags & MAN_BLINE;
1.24 schwarze 208:
209: /* Call to handler... */
1.1 kristaps 210:
1.22 schwarze 211: assert(man_macros[tok].fp);
1.92 schwarze 212: (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.73 schwarze 213:
214: /* In quick mode (for mandocdb), abort after the NAME section. */
215:
1.92 schwarze 216: if (man->quick && tok == MAN_SH) {
1.80 schwarze 217: n = man->last;
1.98 schwarze 218: if (n->type == ROFFT_BODY &&
1.80 schwarze 219: strcmp(n->prev->child->string, "NAME"))
1.113 schwarze 220: return 2;
1.80 schwarze 221: }
1.1 kristaps 222:
1.79 schwarze 223: /*
1.84 schwarze 224: * If we are in a next-line scope for a block head,
225: * close it out now and switch to the body,
226: * unless the next-line scope is allowed to continue.
1.21 schwarze 227: */
228:
1.84 schwarze 229: if ( ! bline || man->flags & MAN_ELINE ||
230: man_macros[tok].flags & MAN_NSCOPED)
1.113 schwarze 231: return 1;
1.1 kristaps 232:
1.92 schwarze 233: assert(man->flags & MAN_BLINE);
1.69 schwarze 234: man->flags &= ~MAN_BLINE;
1.1 kristaps 235:
1.92 schwarze 236: man_unscope(man, man->last->parent);
1.106 schwarze 237: roff_body_alloc(man, ln, ppos, man->last->tok);
1.113 schwarze 238: return 1;
1.97 schwarze 239: }
240:
241: void
1.101 schwarze 242: man_breakscope(struct roff_man *man, int tok)
1.97 schwarze 243: {
1.99 schwarze 244: struct roff_node *n;
1.97 schwarze 245:
246: /*
247: * An element next line scope is open,
248: * and the new macro is not allowed inside elements.
249: * Delete the element that is being broken.
250: */
251:
1.107 schwarze 252: if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
1.97 schwarze 253: ! (man_macros[tok].flags & MAN_NSCOPED))) {
254: n = man->last;
1.98 schwarze 255: assert(n->type != ROFFT_TEXT);
1.97 schwarze 256: if (man_macros[n->tok].flags & MAN_NSCOPED)
257: n = n->parent;
258:
259: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
260: n->line, n->pos, "%s breaks %s",
1.117 ! schwarze 261: tok == TOKEN_NONE ? "TS" : roff_name[tok],
! 262: roff_name[n->tok]);
1.97 schwarze 263:
1.106 schwarze 264: roff_node_delete(man, n);
1.97 schwarze 265: man->flags &= ~MAN_ELINE;
1.112 schwarze 266: }
267:
268: /*
269: * Weird special case:
270: * Switching fill mode closes section headers.
271: */
272:
273: if (man->flags & MAN_BLINE &&
274: (tok == MAN_nf || tok == MAN_fi) &&
275: (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
276: n = man->last;
277: man_unscope(man, n);
278: roff_body_alloc(man, n->line, n->pos, n->tok);
279: man->flags &= ~MAN_BLINE;
1.97 schwarze 280: }
281:
282: /*
283: * A block header next line scope is open,
284: * and the new macro is not allowed inside block headers.
285: * Delete the block that is being broken.
286: */
287:
1.107 schwarze 288: if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
1.97 schwarze 289: man_macros[tok].flags & MAN_BSCOPE)) {
290: n = man->last;
1.98 schwarze 291: if (n->type == ROFFT_TEXT)
1.97 schwarze 292: n = n->parent;
293: if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
294: n = n->parent;
295:
1.98 schwarze 296: assert(n->type == ROFFT_HEAD);
1.97 schwarze 297: n = n->parent;
1.98 schwarze 298: assert(n->type == ROFFT_BLOCK);
1.97 schwarze 299: assert(man_macros[n->tok].flags & MAN_SCOPED);
300:
301: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
302: n->line, n->pos, "%s breaks %s",
1.117 ! schwarze 303: tok == TOKEN_NONE ? "TS" : roff_name[tok],
! 304: roff_name[n->tok]);
1.97 schwarze 305:
1.106 schwarze 306: roff_node_delete(man, n);
1.97 schwarze 307: man->flags &= ~MAN_BLINE;
308: }
1.62 schwarze 309: }
310:
311: const struct mparse *
1.101 schwarze 312: man_mparse(const struct roff_man *man)
1.62 schwarze 313: {
314:
1.69 schwarze 315: assert(man && man->parse);
1.113 schwarze 316: return man->parse;
1.114 schwarze 317: }
318:
319: void
320: man_state(struct roff_man *man, struct roff_node *n)
321: {
322:
323: switch(n->tok) {
324: case MAN_nf:
325: case MAN_EX:
1.115 schwarze 326: if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
1.114 schwarze 327: mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
328: n->line, n->pos, "nf");
329: man->flags |= MAN_LITERAL;
330: break;
331: case MAN_fi:
332: case MAN_EE:
333: if ( ! (man->flags & MAN_LITERAL) &&
1.115 schwarze 334: ! (n->flags & NODE_VALID))
1.114 schwarze 335: mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
336: n->line, n->pos, "fi");
337: man->flags &= ~MAN_LITERAL;
338: break;
339: default:
340: break;
341: }
1.115 schwarze 342: man->last->flags |= NODE_VALID;
1.114 schwarze 343: }
344:
345: void
346: man_validate(struct roff_man *man)
347: {
348:
349: man->last = man->first;
350: man_node_validate(man);
351: man->flags &= ~MAN_LITERAL;
1.4 schwarze 352: }
![[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