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