Annotation of mandoc/man.c, Revision 1.174
1.174 ! schwarze 1: /* $Id: man.c,v 1.173 2017/05/08 20:33:53 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: /*
1.174 ! schwarze 92: * Blank lines are ignored in next line scope and right
! 93: * after headings but add a single vertical space elsewhere.
1.121 schwarze 94: */
95:
1.144 schwarze 96: if (buf[i] == '\0') {
1.174 ! schwarze 97: if (man->flags & (MAN_ELINE | MAN_BLINE))
! 98: mandoc_msg(MANDOCERR_BLK_BLANK, man->parse,
! 99: line, 0, NULL);
! 100: else if (man->last->tok != MAN_SH &&
1.144 schwarze 101: man->last->tok != MAN_SS) {
1.172 schwarze 102: roff_elem_alloc(man, line, offs, ROFF_sp);
1.153 schwarze 103: man->next = ROFF_NEXT_SIBLING;
1.121 schwarze 104: }
1.165 schwarze 105: return 1;
1.31 kristaps 106: }
107:
1.129 schwarze 108: /*
1.63 kristaps 109: * Warn if the last un-escaped character is whitespace. Then
1.129 schwarze 110: * strip away the remaining spaces (tabs stay!).
1.63 kristaps 111: */
1.29 kristaps 112:
1.61 kristaps 113: i = (int)strlen(buf);
114: assert(i);
1.49 kristaps 115:
1.63 kristaps 116: if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
1.64 kristaps 117: if (i > 1 && '\\' != buf[i - 2])
1.131 schwarze 118: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
119: line, i - 1, NULL);
1.63 kristaps 120:
121: for (--i; i && ' ' == buf[i]; i--)
122: /* Spin back to non-space. */ ;
123:
124: /* Jump ahead of escaped whitespace. */
125: i += '\\' == buf[i] ? 2 : 1;
126:
127: buf[i] = '\0';
128: }
1.160 schwarze 129: roff_word_alloc(man, line, offs, buf + offs);
1.65 kristaps 130:
131: /*
132: * End-of-sentence check. If the last character is an unescaped
133: * EOS character, then flag the node as being the end of a
134: * sentence. The front-end will know how to interpret this.
135: */
1.67 kristaps 136:
1.65 kristaps 137: assert(i);
1.122 schwarze 138: if (mandoc_eos(buf, (size_t)i))
1.167 schwarze 139: man->last->flags |= NODE_EOS;
1.31 kristaps 140:
1.144 schwarze 141: man_descope(man, line, offs);
1.165 schwarze 142: return 1;
1.1 kristaps 143: }
144:
1.96 kristaps 145: static int
1.153 schwarze 146: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 147: {
1.151 schwarze 148: struct roff_node *n;
1.143 schwarze 149: const char *cp;
1.170 schwarze 150: size_t sz;
151: enum roff_tok tok;
152: int ppos;
1.134 schwarze 153: int bline;
1.170 schwarze 154:
155: /* Determine the line macro. */
1.1 kristaps 156:
1.107 kristaps 157: ppos = offs;
1.170 schwarze 158: tok = TOKEN_NONE;
159: for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
160: offs++;
161: if (sz > 0 && sz < 4)
162: tok = roffhash_find(man->manmac, buf + ppos, sz);
1.159 schwarze 163: if (tok == TOKEN_NONE) {
1.136 schwarze 164: mandoc_msg(MANDOCERR_MACRO, man->parse,
165: ln, ppos, buf + ppos - 1);
1.165 schwarze 166: return 1;
1.1 kristaps 167: }
168:
1.143 schwarze 169: /* Skip a leading escape sequence or tab. */
170:
171: switch (buf[offs]) {
172: case '\\':
173: cp = buf + offs + 1;
174: mandoc_escape(&cp, NULL, NULL);
175: offs = cp - buf;
176: break;
177: case '\t':
178: offs++;
179: break;
180: default:
181: break;
182: }
183:
184: /* Jump to the next non-whitespace word. */
1.1 kristaps 185:
1.168 schwarze 186: while (buf[offs] == ' ')
1.107 kristaps 187: offs++;
1.1 kristaps 188:
1.129 schwarze 189: /*
1.62 kristaps 190: * Trailing whitespace. Note that tabs are allowed to be passed
191: * into the parser as "text", so we only warn about spaces here.
192: */
1.48 kristaps 193:
1.144 schwarze 194: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.131 schwarze 195: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
196: ln, offs - 1, NULL);
1.48 kristaps 197:
1.129 schwarze 198: /*
1.149 schwarze 199: * Some macros break next-line scopes; otherwise, remember
200: * whether we are in next-line scope for a block head.
1.50 kristaps 201: */
1.34 kristaps 202:
1.149 schwarze 203: man_breakscope(man, tok);
1.134 schwarze 204: bline = man->flags & MAN_BLINE;
1.171 schwarze 205:
206: /*
207: * If the line in next-line scope ends with \c, keep the
208: * next-line scope open for the subsequent input line.
209: * That is not at all portable, only groff >= 1.22.4
210: * does it, but *if* this weird idiom occurs in a manual
211: * page, that's very likely what the author intended.
212: */
213:
214: if (bline) {
215: cp = strchr(buf + offs, '\0') - 2;
216: if (cp >= buf && cp[0] == '\\' && cp[1] == 'c')
217: bline = 0;
218: }
1.59 kristaps 219:
220: /* Call to handler... */
1.1 kristaps 221:
1.53 kristaps 222: assert(man_macros[tok].fp);
1.144 schwarze 223: (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.123 schwarze 224:
225: /* In quick mode (for mandocdb), abort after the NAME section. */
226:
1.144 schwarze 227: if (man->quick && tok == MAN_SH) {
1.130 schwarze 228: n = man->last;
1.150 schwarze 229: if (n->type == ROFFT_BODY &&
1.130 schwarze 230: strcmp(n->prev->child->string, "NAME"))
1.165 schwarze 231: return 2;
1.130 schwarze 232: }
1.1 kristaps 233:
1.129 schwarze 234: /*
1.135 schwarze 235: * If we are in a next-line scope for a block head,
236: * close it out now and switch to the body,
237: * unless the next-line scope is allowed to continue.
1.29 kristaps 238: */
239:
1.135 schwarze 240: if ( ! bline || man->flags & MAN_ELINE ||
241: man_macros[tok].flags & MAN_NSCOPED)
1.165 schwarze 242: return 1;
1.29 kristaps 243:
1.144 schwarze 244: assert(man->flags & MAN_BLINE);
1.119 schwarze 245: man->flags &= ~MAN_BLINE;
1.11 kristaps 246:
1.144 schwarze 247: man_unscope(man, man->last->parent);
1.158 schwarze 248: roff_body_alloc(man, ln, ppos, man->last->tok);
1.165 schwarze 249: return 1;
1.149 schwarze 250: }
251:
252: void
1.153 schwarze 253: man_breakscope(struct roff_man *man, int tok)
1.149 schwarze 254: {
1.151 schwarze 255: struct roff_node *n;
1.149 schwarze 256:
257: /*
258: * An element next line scope is open,
259: * and the new macro is not allowed inside elements.
260: * Delete the element that is being broken.
261: */
262:
1.173 schwarze 263: if (man->flags & MAN_ELINE && (tok < MAN_TH ||
1.149 schwarze 264: ! (man_macros[tok].flags & MAN_NSCOPED))) {
265: n = man->last;
1.150 schwarze 266: assert(n->type != ROFFT_TEXT);
1.149 schwarze 267: if (man_macros[n->tok].flags & MAN_NSCOPED)
268: n = n->parent;
269:
270: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
271: n->line, n->pos, "%s breaks %s",
1.173 schwarze 272: roff_name[tok], roff_name[n->tok]);
1.149 schwarze 273:
1.158 schwarze 274: roff_node_delete(man, n);
1.149 schwarze 275: man->flags &= ~MAN_ELINE;
1.164 schwarze 276: }
277:
278: /*
279: * Weird special case:
280: * Switching fill mode closes section headers.
281: */
282:
283: if (man->flags & MAN_BLINE &&
284: (tok == MAN_nf || tok == MAN_fi) &&
285: (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
286: n = man->last;
287: man_unscope(man, n);
288: roff_body_alloc(man, n->line, n->pos, n->tok);
289: man->flags &= ~MAN_BLINE;
1.149 schwarze 290: }
291:
292: /*
293: * A block header next line scope is open,
294: * and the new macro is not allowed inside block headers.
295: * Delete the block that is being broken.
296: */
297:
1.173 schwarze 298: if (man->flags & MAN_BLINE && (tok < MAN_TH ||
1.149 schwarze 299: man_macros[tok].flags & MAN_BSCOPE)) {
300: n = man->last;
1.150 schwarze 301: if (n->type == ROFFT_TEXT)
1.149 schwarze 302: n = n->parent;
303: if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
304: n = n->parent;
305:
1.150 schwarze 306: assert(n->type == ROFFT_HEAD);
1.149 schwarze 307: n = n->parent;
1.150 schwarze 308: assert(n->type == ROFFT_BLOCK);
1.149 schwarze 309: assert(man_macros[n->tok].flags & MAN_SCOPED);
310:
311: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
312: n->line, n->pos, "%s breaks %s",
1.173 schwarze 313: roff_name[tok], 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
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to man.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc