Annotation of src/usr.bin/mandoc/man.c, Revision 1.106
1.106 ! schwarze 1: /* $OpenBSD: man.c,v 1.105 2015/04/18 17:50:02 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_breakscope(struct roff_man *, int);
52: static void man_descope(struct roff_man *, int, int);
53: static int man_ptext(struct roff_man *, int, char *, int);
54: static int man_pmacro(struct roff_man *, int, char *, int);
1.1 kristaps 55:
56:
1.16 schwarze 57: void
1.101 schwarze 58: man_endparse(struct roff_man *man)
1.1 kristaps 59: {
60:
1.92 schwarze 61: man_macroend(man);
1.1 kristaps 62: }
63:
64: int
1.101 schwarze 65: man_parseln(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 66: {
1.25 schwarze 67:
1.98 schwarze 68: if (man->last->type != ROFFT_EQN || ln > man->last->line)
1.89 schwarze 69: man->flags |= MAN_NEWLINE;
1.54 schwarze 70:
1.69 schwarze 71: return (roff_getcontrol(man->roff, buf, &offs) ?
1.79 schwarze 72: man_pmacro(man, ln, buf, offs) :
73: man_ptext(man, ln, buf, offs));
1.1 kristaps 74: }
75:
1.92 schwarze 76: void
1.101 schwarze 77: man_elem_alloc(struct roff_man *man, int line, int pos, int tok)
1.1 kristaps 78: {
1.99 schwarze 79: struct roff_node *p;
1.1 kristaps 80:
1.106 ! schwarze 81: p = roff_node_alloc(man, line, pos, ROFFT_ELEM, tok);
! 82: roff_node_append(man, p);
1.101 schwarze 83: man->next = ROFF_NEXT_CHILD;
1.9 schwarze 84: }
85:
1.92 schwarze 86: void
1.101 schwarze 87: man_block_alloc(struct roff_man *man, int line, int pos, int tok)
1.9 schwarze 88: {
1.99 schwarze 89: struct roff_node *p;
1.9 schwarze 90:
1.106 ! schwarze 91: p = roff_node_alloc(man, line, pos, ROFFT_BLOCK, tok);
! 92: roff_node_append(man, p);
1.101 schwarze 93: man->next = ROFF_NEXT_CHILD;
1.9 schwarze 94: }
95:
1.92 schwarze 96: void
1.101 schwarze 97: man_word_alloc(struct roff_man *man, int line, int pos, const char *word)
1.1 kristaps 98: {
1.99 schwarze 99: struct roff_node *n;
1.1 kristaps 100:
1.106 ! schwarze 101: n = roff_node_alloc(man, line, pos, ROFFT_TEXT, MAN_MAX);
1.69 schwarze 102: n->string = roff_strdup(man->roff, word);
1.106 ! schwarze 103: roff_node_append(man, n);
! 104: man_valid_post(man);
1.101 schwarze 105: man->next = ROFF_NEXT_SIBLING;
1.90 schwarze 106: }
107:
108: void
1.101 schwarze 109: man_word_append(struct roff_man *man, const char *word)
1.90 schwarze 110: {
1.99 schwarze 111: struct roff_node *n;
1.90 schwarze 112: char *addstr, *newstr;
113:
114: n = man->last;
115: addstr = roff_strdup(man->roff, word);
116: mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
117: free(addstr);
118: free(n->string);
119: n->string = newstr;
1.101 schwarze 120: man->next = ROFF_NEXT_SIBLING;
1.10 schwarze 121: }
122:
1.93 schwarze 123: void
1.101 schwarze 124: man_addeqn(struct roff_man *man, const struct eqn *ep)
1.57 schwarze 125: {
1.99 schwarze 126: struct roff_node *n;
1.57 schwarze 127:
1.106 ! schwarze 128: n = roff_node_alloc(man, ep->ln, ep->pos, ROFFT_EQN, MAN_MAX);
1.57 schwarze 129: n->eqn = ep;
1.88 schwarze 130: if (ep->ln > man->last->line)
131: n->flags |= MAN_LINE;
1.106 ! schwarze 132: roff_node_append(man, n);
1.101 schwarze 133: man->next = ROFF_NEXT_SIBLING;
1.92 schwarze 134: man_descope(man, ep->ln, ep->pos);
1.57 schwarze 135: }
1.1 kristaps 136:
1.93 schwarze 137: void
1.101 schwarze 138: man_addspan(struct roff_man *man, const struct tbl_span *sp)
1.52 schwarze 139: {
1.99 schwarze 140: struct roff_node *n;
1.52 schwarze 141:
1.97 schwarze 142: man_breakscope(man, MAN_MAX);
1.106 ! schwarze 143: n = roff_node_alloc(man, sp->line, 0, ROFFT_TBL, MAN_MAX);
1.55 schwarze 144: n->span = sp;
1.106 ! schwarze 145: roff_node_append(man, n);
! 146: man_valid_post(man);
1.101 schwarze 147: man->next = ROFF_NEXT_SIBLING;
1.92 schwarze 148: man_descope(man, sp->line, 0);
1.52 schwarze 149: }
150:
1.92 schwarze 151: static void
1.101 schwarze 152: man_descope(struct roff_man *man, int line, int offs)
1.52 schwarze 153: {
154: /*
155: * Co-ordinate what happens with having a next-line scope open:
156: * first close out the element scope (if applicable), then close
157: * out the block scope (also if applicable).
158: */
159:
1.92 schwarze 160: if (man->flags & MAN_ELINE) {
1.69 schwarze 161: man->flags &= ~MAN_ELINE;
1.92 schwarze 162: man_unscope(man, man->last->parent);
1.52 schwarze 163: }
1.92 schwarze 164: if ( ! (man->flags & MAN_BLINE))
165: return;
1.69 schwarze 166: man->flags &= ~MAN_BLINE;
1.92 schwarze 167: man_unscope(man, man->last->parent);
1.106 ! schwarze 168: roff_body_alloc(man, line, offs, man->last->tok);
1.52 schwarze 169: }
170:
1.1 kristaps 171: static int
1.101 schwarze 172: man_ptext(struct roff_man *man, int line, char *buf, int offs)
1.1 kristaps 173: {
1.27 schwarze 174: int i;
1.26 schwarze 175:
1.10 schwarze 176: /* Literal free-form text whitespace is preserved. */
177:
1.92 schwarze 178: if (man->flags & MAN_LITERAL) {
179: man_word_alloc(man, line, offs, buf + offs);
180: man_descope(man, line, offs);
181: return(1);
1.10 schwarze 182: }
183:
1.92 schwarze 184: for (i = offs; buf[i] == ' '; i++)
1.10 schwarze 185: /* Skip leading whitespace. */ ;
1.18 schwarze 186:
1.71 schwarze 187: /*
188: * Blank lines are ignored right after headings
189: * but add a single vertical space elsewhere.
190: */
191:
1.92 schwarze 192: if (buf[i] == '\0') {
1.27 schwarze 193: /* Allocate a blank entry. */
1.92 schwarze 194: if (man->last->tok != MAN_SH &&
195: man->last->tok != MAN_SS) {
196: man_elem_alloc(man, line, offs, MAN_sp);
1.101 schwarze 197: man->next = ROFF_NEXT_SIBLING;
1.71 schwarze 198: }
1.68 schwarze 199: return(1);
1.10 schwarze 200: }
1.1 kristaps 201:
1.79 schwarze 202: /*
1.27 schwarze 203: * Warn if the last un-escaped character is whitespace. Then
1.79 schwarze 204: * strip away the remaining spaces (tabs stay!).
1.27 schwarze 205: */
1.18 schwarze 206:
1.27 schwarze 207: i = (int)strlen(buf);
208: assert(i);
1.18 schwarze 209:
1.27 schwarze 210: if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
211: if (i > 1 && '\\' != buf[i - 2])
1.81 schwarze 212: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
213: line, i - 1, NULL);
1.18 schwarze 214:
1.27 schwarze 215: for (--i; i && ' ' == buf[i]; i--)
216: /* Spin back to non-space. */ ;
1.10 schwarze 217:
1.27 schwarze 218: /* Jump ahead of escaped whitespace. */
219: i += '\\' == buf[i] ? 2 : 1;
1.18 schwarze 220:
1.27 schwarze 221: buf[i] = '\0';
1.10 schwarze 222: }
1.92 schwarze 223: man_word_alloc(man, line, offs, buf + offs);
1.28 schwarze 224:
225: /*
226: * End-of-sentence check. If the last character is an unescaped
227: * EOS character, then flag the node as being the end of a
228: * sentence. The front-end will know how to interpret this.
229: */
230:
231: assert(i);
1.72 schwarze 232: if (mandoc_eos(buf, (size_t)i))
1.69 schwarze 233: man->last->flags |= MAN_EOS;
1.10 schwarze 234:
1.92 schwarze 235: man_descope(man, line, offs);
236: return(1);
1.1 kristaps 237: }
238:
1.53 schwarze 239: static int
1.101 schwarze 240: man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
1.1 kristaps 241: {
1.99 schwarze 242: struct roff_node *n;
1.91 schwarze 243: const char *cp;
1.99 schwarze 244: int tok;
1.84 schwarze 245: int i, ppos;
246: int bline;
1.91 schwarze 247: char mac[5];
1.1 kristaps 248:
1.59 schwarze 249: ppos = offs;
1.1 kristaps 250:
1.23 schwarze 251: /*
1.59 schwarze 252: * Copy the first word into a nil-terminated buffer.
1.91 schwarze 253: * Stop when a space, tab, escape, or eoln is encountered.
1.23 schwarze 254: */
1.27 schwarze 255:
1.59 schwarze 256: i = 0;
1.91 schwarze 257: while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
1.59 schwarze 258: mac[i++] = buf[offs++];
1.1 kristaps 259:
1.59 schwarze 260: mac[i] = '\0';
1.1 kristaps 261:
1.59 schwarze 262: tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;
1.1 kristaps 263:
1.91 schwarze 264: if (tok == MAN_MAX) {
1.85 schwarze 265: mandoc_msg(MANDOCERR_MACRO, man->parse,
266: ln, ppos, buf + ppos - 1);
1.1 kristaps 267: return(1);
268: }
269:
1.91 schwarze 270: /* Skip a leading escape sequence or tab. */
271:
272: switch (buf[offs]) {
273: case '\\':
274: cp = buf + offs + 1;
275: mandoc_escape(&cp, NULL, NULL);
276: offs = cp - buf;
277: break;
278: case '\t':
279: offs++;
280: break;
281: default:
282: break;
283: }
284:
285: /* Jump to the next non-whitespace word. */
1.1 kristaps 286:
1.92 schwarze 287: while (buf[offs] && buf[offs] == ' ')
1.59 schwarze 288: offs++;
1.18 schwarze 289:
1.79 schwarze 290: /*
1.27 schwarze 291: * Trailing whitespace. Note that tabs are allowed to be passed
292: * into the parser as "text", so we only warn about spaces here.
293: */
1.18 schwarze 294:
1.92 schwarze 295: if (buf[offs] == '\0' && buf[offs - 1] == ' ')
1.81 schwarze 296: mandoc_msg(MANDOCERR_SPACE_EOL, man->parse,
297: ln, offs - 1, NULL);
1.1 kristaps 298:
1.79 schwarze 299: /*
1.97 schwarze 300: * Some macros break next-line scopes; otherwise, remember
301: * whether we are in next-line scope for a block head.
1.21 schwarze 302: */
303:
1.97 schwarze 304: man_breakscope(man, tok);
1.84 schwarze 305: bline = man->flags & MAN_BLINE;
1.24 schwarze 306:
307: /* Call to handler... */
1.1 kristaps 308:
1.22 schwarze 309: assert(man_macros[tok].fp);
1.92 schwarze 310: (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
1.73 schwarze 311:
312: /* In quick mode (for mandocdb), abort after the NAME section. */
313:
1.92 schwarze 314: if (man->quick && tok == MAN_SH) {
1.80 schwarze 315: n = man->last;
1.98 schwarze 316: if (n->type == ROFFT_BODY &&
1.80 schwarze 317: strcmp(n->prev->child->string, "NAME"))
318: return(2);
319: }
1.1 kristaps 320:
1.79 schwarze 321: /*
1.84 schwarze 322: * If we are in a next-line scope for a block head,
323: * close it out now and switch to the body,
324: * unless the next-line scope is allowed to continue.
1.21 schwarze 325: */
326:
1.84 schwarze 327: if ( ! bline || man->flags & MAN_ELINE ||
328: man_macros[tok].flags & MAN_NSCOPED)
1.21 schwarze 329: return(1);
1.1 kristaps 330:
1.92 schwarze 331: assert(man->flags & MAN_BLINE);
1.69 schwarze 332: man->flags &= ~MAN_BLINE;
1.1 kristaps 333:
1.92 schwarze 334: man_unscope(man, man->last->parent);
1.106 ! schwarze 335: roff_body_alloc(man, ln, ppos, man->last->tok);
1.92 schwarze 336: return(1);
1.97 schwarze 337: }
338:
339: void
1.101 schwarze 340: man_breakscope(struct roff_man *man, int tok)
1.97 schwarze 341: {
1.99 schwarze 342: struct roff_node *n;
1.97 schwarze 343:
344: /*
345: * An element next line scope is open,
346: * and the new macro is not allowed inside elements.
347: * Delete the element that is being broken.
348: */
349:
350: if (man->flags & MAN_ELINE && (tok == MAN_MAX ||
351: ! (man_macros[tok].flags & MAN_NSCOPED))) {
352: n = man->last;
1.98 schwarze 353: assert(n->type != ROFFT_TEXT);
1.97 schwarze 354: if (man_macros[n->tok].flags & MAN_NSCOPED)
355: n = n->parent;
356:
357: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
358: n->line, n->pos, "%s breaks %s",
359: tok == MAN_MAX ? "TS" : man_macronames[tok],
360: man_macronames[n->tok]);
361:
1.106 ! schwarze 362: roff_node_delete(man, n);
1.97 schwarze 363: man->flags &= ~MAN_ELINE;
364: }
365:
366: /*
367: * A block header next line scope is open,
368: * and the new macro is not allowed inside block headers.
369: * Delete the block that is being broken.
370: */
371:
372: if (man->flags & MAN_BLINE && (tok == MAN_MAX ||
373: man_macros[tok].flags & MAN_BSCOPE)) {
374: n = man->last;
1.98 schwarze 375: if (n->type == ROFFT_TEXT)
1.97 schwarze 376: n = n->parent;
377: if ( ! (man_macros[n->tok].flags & MAN_BSCOPE))
378: n = n->parent;
379:
1.98 schwarze 380: assert(n->type == ROFFT_HEAD);
1.97 schwarze 381: n = n->parent;
1.98 schwarze 382: assert(n->type == ROFFT_BLOCK);
1.97 schwarze 383: assert(man_macros[n->tok].flags & MAN_SCOPED);
384:
385: mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse,
386: n->line, n->pos, "%s breaks %s",
387: tok == MAN_MAX ? "TS" : man_macronames[tok],
388: man_macronames[n->tok]);
389:
1.106 ! schwarze 390: roff_node_delete(man, n);
1.97 schwarze 391: man->flags &= ~MAN_BLINE;
392: }
1.62 schwarze 393: }
394:
395: const struct mparse *
1.101 schwarze 396: man_mparse(const struct roff_man *man)
1.62 schwarze 397: {
398:
1.69 schwarze 399: assert(man && man->parse);
400: return(man->parse);
1.76 schwarze 401: }
402:
403: void
1.99 schwarze 404: man_deroff(char **dest, const struct roff_node *n)
1.76 schwarze 405: {
406: char *cp;
407: size_t sz;
408:
1.98 schwarze 409: if (n->type != ROFFT_TEXT) {
1.76 schwarze 410: for (n = n->child; n; n = n->next)
411: man_deroff(dest, n);
412: return;
413: }
414:
1.77 schwarze 415: /* Skip leading whitespace and escape sequences. */
1.76 schwarze 416:
1.77 schwarze 417: cp = n->string;
418: while ('\0' != *cp) {
419: if ('\\' == *cp) {
420: cp++;
421: mandoc_escape((const char **)&cp, NULL, NULL);
422: } else if (isspace((unsigned char)*cp))
423: cp++;
424: else
1.76 schwarze 425: break;
1.77 schwarze 426: }
1.76 schwarze 427:
428: /* Skip trailing whitespace. */
429:
430: for (sz = strlen(cp); sz; sz--)
431: if (0 == isspace((unsigned char)cp[sz-1]))
432: break;
433:
434: /* Skip empty strings. */
435:
436: if (0 == sz)
437: return;
438:
439: if (NULL == *dest) {
440: *dest = mandoc_strndup(cp, sz);
441: return;
442: }
443:
444: mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
445: free(*dest);
446: *dest = cp;
1.4 schwarze 447: }
![[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