Annotation of mandoc/man.c, Revision 1.187
1.187 ! schwarze 1: /* $Id: man.c,v 1.186 2018/12/31 10:04:39 schwarze Exp $ */
1.1 kristaps 2: /*
1.102 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.187 ! schwarze 4: * Copyright (c) 2013-2015, 2017-2019 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.179 schwarze 38: static char *man_hasc(char *);
1.153 schwarze 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.179 schwarze 55: /*
56: * If the string ends with \c, return a pointer to the backslash.
57: * Otherwise, return NULL.
58: */
59: static char *
60: man_hasc(char *start)
61: {
62: char *cp, *ep;
63:
64: ep = strchr(start, '\0') - 2;
65: if (ep < start || ep[0] != '\\' || ep[1] != 'c')
66: return NULL;
67: for (cp = ep; cp > start; cp--)
68: if (cp[-1] != '\\')
69: break;
70: return (ep - cp) % 2 ? NULL : ep;
71: }
72:
1.180 schwarze 73: void
1.179 schwarze 74: man_descope(struct roff_man *man, int line, int offs, char *start)
1.94 kristaps 75: {
1.179 schwarze 76: /* Trailing \c keeps next-line scope open. */
77:
1.180 schwarze 78: if (start != NULL && man_hasc(start) != NULL)
1.179 schwarze 79: return;
80:
1.94 kristaps 81: /*
82: * Co-ordinate what happens with having a next-line scope open:
1.180 schwarze 83: * first close out the element scopes (if applicable),
84: * then close out the block scope (also if applicable).
1.94 kristaps 85: */
86:
1.144 schwarze 87: if (man->flags & MAN_ELINE) {
1.180 schwarze 88: while (man->last->parent->type != ROFFT_ROOT &&
89: man_macro(man->last->parent->tok)->flags & MAN_ESCOPED)
90: man_unscope(man, man->last->parent);
1.119 schwarze 91: man->flags &= ~MAN_ELINE;
1.94 kristaps 92: }
1.144 schwarze 93: if ( ! (man->flags & MAN_BLINE))
94: return;
95: man_unscope(man, man->last->parent);
1.158 schwarze 96: roff_body_alloc(man, line, offs, man->last->tok);
1.187 ! schwarze 97: man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
1.94 kristaps 98: }
99:
1.1 kristaps 100: static int
1.153 schwarze 101: man_ptext(struct roff_man *man, int line, char *buf, int offs)
1.1 kristaps 102: {
1.61 kristaps 103: int i;
1.175 schwarze 104: char *ep;
1.60 kristaps 105:
1.184 schwarze 106: /* In no-fill mode, whitespace is preserved on text lines. */
1.35 kristaps 107:
1.184 schwarze 108: if (man->flags & ROFF_NOFILL) {
1.160 schwarze 109: roff_word_alloc(man, line, offs, buf + offs);
1.179 schwarze 110: man_descope(man, line, offs, buf + offs);
1.165 schwarze 111: return 1;
1.35 kristaps 112: }
113:
1.144 schwarze 114: for (i = offs; buf[i] == ' '; i++)
1.31 kristaps 115: /* Skip leading whitespace. */ ;
1.48 kristaps 116:
1.121 schwarze 117: /*
1.175 schwarze 118: * Blank lines are ignored in next line scope
119: * and right after headings and cancel preceding \c,
120: * but add a single vertical space elsewhere.
1.121 schwarze 121: */
122:
1.144 schwarze 123: if (buf[i] == '\0') {
1.175 schwarze 124: if (man->flags & (MAN_ELINE | MAN_BLINE)) {
1.181 schwarze 125: mandoc_msg(MANDOCERR_BLK_BLANK, line, 0, NULL);
1.175 schwarze 126: return 1;
1.121 schwarze 127: }
1.175 schwarze 128: if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
129: return 1;
1.179 schwarze 130: if (man->last->type == ROFFT_TEXT &&
131: ((ep = man_hasc(man->last->string)) != NULL)) {
1.175 schwarze 132: *ep = '\0';
133: return 1;
134: }
135: roff_elem_alloc(man, line, offs, ROFF_sp);
136: man->next = ROFF_NEXT_SIBLING;
1.165 schwarze 137: return 1;
1.31 kristaps 138: }
139:
1.129 schwarze 140: /*
1.63 kristaps 141: * Warn if the last un-escaped character is whitespace. Then
1.129 schwarze 142: * strip away the remaining spaces (tabs stay!).
1.63 kristaps 143: */
1.29 kristaps 144:
1.61 kristaps 145: i = (int)strlen(buf);
146: assert(i);
1.49 kristaps 147:
1.63 kristaps 148: if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
1.64 kristaps 149: if (i > 1 && '\\' != buf[i - 2])
1.181 schwarze 150: mandoc_msg(MANDOCERR_SPACE_EOL, line, i - 1, NULL);
1.63 kristaps 151:
152: for (--i; i && ' ' == buf[i]; i--)
153: /* Spin back to non-space. */ ;
154:
155: /* Jump ahead of escaped whitespace. */
156: i += '\\' == buf[i] ? 2 : 1;
157:
158: buf[i] = '\0';
159: }
1.160 schwarze 160: roff_word_alloc(man, line, offs, buf + offs);
1.65 kristaps 161:
162: /*
163: * End-of-sentence check. If the last character is an unescaped
164: * EOS character, then flag the node as being the end of a
165: * sentence. The front-end will know how to interpret this.
166: */
1.67 kristaps 167:
1.65 kristaps 168: assert(i);
1.122 schwarze 169: if (mandoc_eos(buf, (size_t)i))
1.167 schwarze 170: man->last->flags |= NODE_EOS;
1.31 kristaps 171:
1.179 schwarze 172: man_descope(man, line, offs, buf + offs);
1.165 schwarze 173: return 1;
1.1 kristaps 174: }
175:
1.96 kristaps 176: static int
1.153 schwarze 177: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 178: {
1.151 schwarze 179: struct roff_node *n;
1.143 schwarze 180: const char *cp;
1.170 schwarze 181: size_t sz;
182: enum roff_tok tok;
183: int ppos;
1.134 schwarze 184: int bline;
1.170 schwarze 185:
186: /* Determine the line macro. */
1.1 kristaps 187:
1.107 kristaps 188: ppos = offs;
1.170 schwarze 189: tok = TOKEN_NONE;
190: for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
191: offs++;
192: if (sz > 0 && sz < 4)
193: tok = roffhash_find(man->manmac, buf + ppos, sz);
1.159 schwarze 194: if (tok == TOKEN_NONE) {
1.181 schwarze 195: mandoc_msg(MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
1.165 schwarze 196: return 1;
1.1 kristaps 197: }
198:
1.143 schwarze 199: /* Skip a leading escape sequence or tab. */
200:
201: switch (buf[offs]) {
202: case '\\':
203: cp = buf + offs + 1;
204: mandoc_escape(&cp, NULL, NULL);
205: offs = cp - buf;
206: break;
207: case '\t':
208: offs++;
209: break;
210: default:
211: break;
212: }
213:
214: /* Jump to the next non-whitespace word. */
1.1 kristaps 215:
1.168 schwarze 216: while (buf[offs] == ' ')
1.107 kristaps 217: offs++;
1.1 kristaps 218:
1.129 schwarze 219: /*
1.62 kristaps 220: * Trailing whitespace. Note that tabs are allowed to be passed
221: * into the parser as "text", so we only warn about spaces here.
222: */
1.48 kristaps 223:
1.144 schwarze 224: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.181 schwarze 225: mandoc_msg(MANDOCERR_SPACE_EOL, ln, offs - 1, NULL);
1.48 kristaps 226:
1.129 schwarze 227: /*
1.149 schwarze 228: * Some macros break next-line scopes; otherwise, remember
229: * whether we are in next-line scope for a block head.
1.50 kristaps 230: */
1.34 kristaps 231:
1.149 schwarze 232: man_breakscope(man, tok);
1.134 schwarze 233: bline = man->flags & MAN_BLINE;
1.171 schwarze 234:
235: /*
236: * If the line in next-line scope ends with \c, keep the
237: * next-line scope open for the subsequent input line.
238: * That is not at all portable, only groff >= 1.22.4
239: * does it, but *if* this weird idiom occurs in a manual
240: * page, that's very likely what the author intended.
241: */
242:
1.180 schwarze 243: if (bline && man_hasc(buf + offs))
244: bline = 0;
1.59 kristaps 245:
246: /* Call to handler... */
1.1 kristaps 247:
1.177 schwarze 248: (*man_macro(tok)->fp)(man, tok, ln, ppos, &offs, buf);
1.123 schwarze 249:
250: /* In quick mode (for mandocdb), abort after the NAME section. */
251:
1.144 schwarze 252: if (man->quick && tok == MAN_SH) {
1.130 schwarze 253: n = man->last;
1.150 schwarze 254: if (n->type == ROFFT_BODY &&
1.130 schwarze 255: strcmp(n->prev->child->string, "NAME"))
1.165 schwarze 256: return 2;
1.130 schwarze 257: }
1.1 kristaps 258:
1.129 schwarze 259: /*
1.135 schwarze 260: * If we are in a next-line scope for a block head,
261: * close it out now and switch to the body,
262: * unless the next-line scope is allowed to continue.
1.29 kristaps 263: */
264:
1.180 schwarze 265: if (bline == 0 ||
266: (man->flags & MAN_BLINE) == 0 ||
267: man->flags & MAN_ELINE ||
1.177 schwarze 268: man_macro(tok)->flags & MAN_NSCOPED)
1.165 schwarze 269: return 1;
1.29 kristaps 270:
1.144 schwarze 271: man_unscope(man, man->last->parent);
1.158 schwarze 272: roff_body_alloc(man, ln, ppos, man->last->tok);
1.187 ! schwarze 273: man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
1.165 schwarze 274: return 1;
1.149 schwarze 275: }
276:
277: void
1.153 schwarze 278: man_breakscope(struct roff_man *man, int tok)
1.149 schwarze 279: {
1.151 schwarze 280: struct roff_node *n;
1.149 schwarze 281:
282: /*
283: * An element next line scope is open,
284: * and the new macro is not allowed inside elements.
285: * Delete the element that is being broken.
286: */
287:
1.173 schwarze 288: if (man->flags & MAN_ELINE && (tok < MAN_TH ||
1.177 schwarze 289: (man_macro(tok)->flags & MAN_NSCOPED) == 0)) {
1.149 schwarze 290: n = man->last;
1.176 schwarze 291: if (n->type == ROFFT_TEXT)
292: n = n->parent;
293: if (n->tok < MAN_TH ||
1.180 schwarze 294: (man_macro(n->tok)->flags & (MAN_NSCOPED | MAN_ESCOPED))
295: == MAN_NSCOPED)
1.149 schwarze 296: n = n->parent;
297:
1.181 schwarze 298: mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
299: "%s breaks %s", roff_name[tok], roff_name[n->tok]);
1.149 schwarze 300:
1.158 schwarze 301: roff_node_delete(man, n);
1.149 schwarze 302: man->flags &= ~MAN_ELINE;
1.164 schwarze 303: }
304:
305: /*
306: * Weird special case:
307: * Switching fill mode closes section headers.
308: */
309:
310: if (man->flags & MAN_BLINE &&
1.184 schwarze 311: (tok == ROFF_nf || tok == ROFF_fi) &&
1.164 schwarze 312: (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
313: n = man->last;
314: man_unscope(man, n);
315: roff_body_alloc(man, n->line, n->pos, n->tok);
1.187 ! schwarze 316: man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
1.149 schwarze 317: }
318:
319: /*
320: * A block header next line scope is open,
321: * and the new macro is not allowed inside block headers.
322: * Delete the block that is being broken.
323: */
324:
1.184 schwarze 325: if (man->flags & MAN_BLINE && tok != ROFF_nf && tok != ROFF_fi &&
326: (tok < MAN_TH || man_macro(tok)->flags & MAN_XSCOPE)) {
1.149 schwarze 327: n = man->last;
1.150 schwarze 328: if (n->type == ROFFT_TEXT)
1.149 schwarze 329: n = n->parent;
1.176 schwarze 330: if (n->tok < MAN_TH ||
1.180 schwarze 331: (man_macro(n->tok)->flags & MAN_XSCOPE) == 0)
1.149 schwarze 332: n = n->parent;
333:
1.150 schwarze 334: assert(n->type == ROFFT_HEAD);
1.149 schwarze 335: n = n->parent;
1.150 schwarze 336: assert(n->type == ROFFT_BLOCK);
1.180 schwarze 337: assert(man_macro(n->tok)->flags & MAN_BSCOPED);
1.149 schwarze 338:
1.181 schwarze 339: mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
340: "%s breaks %s", roff_name[tok], roff_name[n->tok]);
1.149 schwarze 341:
1.158 schwarze 342: roff_node_delete(man, n);
1.187 ! schwarze 343: man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
1.149 schwarze 344: }
1.23 kristaps 345: }
CVSweb