Annotation of src/usr.bin/mandoc/man.c, Revision 1.118
1.118 ! schwarze 1: /* $OpenBSD: man.c,v 1.117 2017/04/24 23:06:09 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.118 ! schwarze 146: size_t sz;
! 147: enum roff_tok tok;
! 148: int ppos;
1.84 schwarze 149: int bline;
1.118 ! schwarze 150:
! 151: /* Determine the line macro. */
1.1 kristaps 152:
1.59 schwarze 153: ppos = offs;
1.118 ! schwarze 154: tok = TOKEN_NONE;
! 155: for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
! 156: offs++;
! 157: if (sz > 0 && sz < 4)
! 158: tok = roffhash_find(man->manmac, buf + ppos, sz);
1.107 schwarze 159: if (tok == TOKEN_NONE) {
1.85 schwarze 160: mandoc_msg(MANDOCERR_MACRO, man->parse,
161: ln, ppos, buf + ppos - 1);
1.113 schwarze 162: return 1;
1.1 kristaps 163: }
164:
1.91 schwarze 165: /* Skip a leading escape sequence or tab. */
166:
167: switch (buf[offs]) {
168: case '\\':
169: cp = buf + offs + 1;
170: mandoc_escape(&cp, NULL, NULL);
171: offs = cp - buf;
172: break;
173: case '\t':
174: offs++;
175: break;
176: default:
177: break;
178: }
179:
180: /* Jump to the next non-whitespace word. */
1.1 kristaps 181:
1.116 schwarze 182: while (buf[offs] == ' ')
1.59 schwarze 183: offs++;
1.18 schwarze 184:
1.79 schwarze 185: /*
1.27 schwarze 186: * Trailing whitespace. Note that tabs are allowed to be passed
187: * into the parser as "text", so we only warn about spaces here.
188: */
1.18 schwarze 189:
1.92 schwarze 190: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.81 schwarze 191: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
192: ln, offs - 1, NULL);
1.1 kristaps 193:
1.79 schwarze 194: /*
1.97 schwarze 195: * Some macros break next-line scopes; otherwise, remember
196: * whether we are in next-line scope for a block head.
1.21 schwarze 197: */
198:
1.97 schwarze 199: man_breakscope(man, tok);
1.84 schwarze 200: bline = man->flags & MAN_BLINE;
1.24 schwarze 201:
202: /* Call to handler... */
1.1 kristaps 203:
1.22 schwarze 204: assert(man_macros[tok].fp);
1.92 schwarze 205: (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.73 schwarze 206:
207: /* In quick mode (for mandocdb), abort after the NAME section. */
208:
1.92 schwarze 209: if (man->quick && tok == MAN_SH) {
1.80 schwarze 210: n = man->last;
1.98 schwarze 211: if (n->type == ROFFT_BODY &&
1.80 schwarze 212: strcmp(n->prev->child->string, "NAME"))
1.113 schwarze 213: return 2;
1.80 schwarze 214: }
1.1 kristaps 215:
1.79 schwarze 216: /*
1.84 schwarze 217: * If we are in a next-line scope for a block head,
218: * close it out now and switch to the body,
219: * unless the next-line scope is allowed to continue.
1.21 schwarze 220: */
221:
1.84 schwarze 222: if ( ! bline || man->flags & MAN_ELINE ||
223: man_macros[tok].flags & MAN_NSCOPED)
1.113 schwarze 224: return 1;
1.1 kristaps 225:
1.92 schwarze 226: assert(man->flags & MAN_BLINE);
1.69 schwarze 227: man->flags &= ~MAN_BLINE;
1.1 kristaps 228:
1.92 schwarze 229: man_unscope(man, man->last->parent);
1.106 schwarze 230: roff_body_alloc(man, ln, ppos, man->last->tok);
1.113 schwarze 231: return 1;
1.97 schwarze 232: }
233:
234: void
1.101 schwarze 235: man_breakscope(struct roff_man *man, int tok)
1.97 schwarze 236: {
1.99 schwarze 237: struct roff_node *n;
1.97 schwarze 238:
239: /*
240: * An element next line scope is open,
241: * and the new macro is not allowed inside elements.
242: * Delete the element that is being broken.
243: */
244:
1.107 schwarze 245: if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
1.97 schwarze 246: ! (man_macros[tok].flags & MAN_NSCOPED))) {
247: n = man->last;
1.98 schwarze 248: assert(n->type != ROFFT_TEXT);
1.97 schwarze 249: if (man_macros[n->tok].flags & MAN_NSCOPED)
250: n = n->parent;
251:
252: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
253: n->line, n->pos, "%s breaks %s",
1.117 schwarze 254: tok == TOKEN_NONE ? "TS" : roff_name[tok],
255: roff_name[n->tok]);
1.97 schwarze 256:
1.106 schwarze 257: roff_node_delete(man, n);
1.97 schwarze 258: man->flags &= ~MAN_ELINE;
1.112 schwarze 259: }
260:
261: /*
262: * Weird special case:
263: * Switching fill mode closes section headers.
264: */
265:
266: if (man->flags & MAN_BLINE &&
267: (tok == MAN_nf || tok == MAN_fi) &&
268: (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
269: n = man->last;
270: man_unscope(man, n);
271: roff_body_alloc(man, n->line, n->pos, n->tok);
272: man->flags &= ~MAN_BLINE;
1.97 schwarze 273: }
274:
275: /*
276: * A block header next line scope is open,
277: * and the new macro is not allowed inside block headers.
278: * Delete the block that is being broken.
279: */
280:
1.107 schwarze 281: if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
1.97 schwarze 282: man_macros[tok].flags & MAN_BSCOPE)) {
283: n = man->last;
1.98 schwarze 284: if (n->type == ROFFT_TEXT)
1.97 schwarze 285: n = n->parent;
286: if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
287: n = n->parent;
288:
1.98 schwarze 289: assert(n->type == ROFFT_HEAD);
1.97 schwarze 290: n = n->parent;
1.98 schwarze 291: assert(n->type == ROFFT_BLOCK);
1.97 schwarze 292: assert(man_macros[n->tok].flags & MAN_SCOPED);
293:
294: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
295: n->line, n->pos, "%s breaks %s",
1.117 schwarze 296: tok == TOKEN_NONE ? "TS" : roff_name[tok],
297: roff_name[n->tok]);
1.97 schwarze 298:
1.106 schwarze 299: roff_node_delete(man, n);
1.97 schwarze 300: man->flags &= ~MAN_BLINE;
301: }
1.62 schwarze 302: }
303:
304: const struct mparse *
1.101 schwarze 305: man_mparse(const struct roff_man *man)
1.62 schwarze 306: {
307:
1.69 schwarze 308: assert(man && man->parse);
1.113 schwarze 309: return man->parse;
1.114 schwarze 310: }
311:
312: void
313: man_state(struct roff_man *man, struct roff_node *n)
314: {
315:
316: switch(n->tok) {
317: case MAN_nf:
318: case MAN_EX:
1.115 schwarze 319: if (man->flags & MAN_LITERAL && ! (n->flags & NODE_VALID))
1.114 schwarze 320: mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
321: n->line, n->pos, "nf");
322: man->flags |= MAN_LITERAL;
323: break;
324: case MAN_fi:
325: case MAN_EE:
326: if ( ! (man->flags & MAN_LITERAL) &&
1.115 schwarze 327: ! (n->flags & NODE_VALID))
1.114 schwarze 328: mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
329: n->line, n->pos, "fi");
330: man->flags &= ~MAN_LITERAL;
331: break;
332: default:
333: break;
334: }
1.115 schwarze 335: man->last->flags |= NODE_VALID;
1.114 schwarze 336: }
337:
338: void
339: man_validate(struct roff_man *man)
340: {
341:
342: man->last = man->first;
343: man_node_validate(man);
344: man->flags &= ~MAN_LITERAL;
1.4 schwarze 345: }
![[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