Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.97
1.97 ! schwarze 1: /* $OpenBSD: man_macro.c,v 1.96 2018/12/14 01:17:46 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.86 schwarze 4: * Copyright (c) 2012-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
1.42 schwarze 5: * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
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.63 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.63 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.51 schwarze 19: #include <sys/types.h>
20:
1.1 kristaps 21: #include <assert.h>
22: #include <ctype.h>
1.96 schwarze 23: #include <stdio.h>
1.1 kristaps 24: #include <stdlib.h>
25: #include <string.h>
26:
1.63 schwarze 27: #include "mandoc.h"
28: #include "roff.h"
1.29 schwarze 29: #include "man.h"
30: #include "libmandoc.h"
1.68 schwarze 31: #include "roff_int.h"
1.1 kristaps 32: #include "libman.h"
33:
1.53 schwarze 34: static void blk_close(MACRO_PROT_ARGS);
35: static void blk_exp(MACRO_PROT_ARGS);
36: static void blk_imp(MACRO_PROT_ARGS);
37: static void in_line_eoln(MACRO_PROT_ARGS);
1.67 schwarze 38: static int man_args(struct roff_man *, int,
1.29 schwarze 39: int *, char *, char **);
1.78 schwarze 40: static void rew_scope(struct roff_man *, enum roff_tok);
1.6 schwarze 41:
1.89 schwarze 42: static const struct man_macro man_macros[MAN_MAX - MAN_TH] = {
1.95 schwarze 43: { in_line_eoln, MAN_XSCOPE }, /* TH */
44: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */
45: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */
46: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */
47: { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */
48: { blk_imp, MAN_XSCOPE }, /* LP */
49: { blk_imp, MAN_XSCOPE }, /* PP */
50: { blk_imp, MAN_XSCOPE }, /* P */
51: { blk_imp, MAN_XSCOPE }, /* IP */
52: { blk_imp, MAN_XSCOPE }, /* HP */
53: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */
54: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SB */
1.6 schwarze 55: { in_line_eoln, 0 }, /* BI */
56: { in_line_eoln, 0 }, /* IB */
57: { in_line_eoln, 0 }, /* BR */
58: { in_line_eoln, 0 }, /* RB */
1.95 schwarze 59: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */
60: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */
61: { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* I */
1.6 schwarze 62: { in_line_eoln, 0 }, /* IR */
63: { in_line_eoln, 0 }, /* RI */
1.72 schwarze 64: { in_line_eoln, MAN_NSCOPED }, /* nf */
65: { in_line_eoln, MAN_NSCOPED }, /* fi */
1.95 schwarze 66: { blk_close, MAN_XSCOPE }, /* RE */
67: { blk_exp, MAN_XSCOPE }, /* RS */
1.7 schwarze 68: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 69: { in_line_eoln, 0 }, /* UC */
1.62 schwarze 70: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.18 schwarze 71: { in_line_eoln, 0 }, /* AT */
1.84 schwarze 72: { in_line_eoln, MAN_NSCOPED }, /* in */
1.95 schwarze 73: { blk_imp, MAN_XSCOPE }, /* SY */
74: { blk_close, MAN_XSCOPE }, /* YS */
1.34 schwarze 75: { in_line_eoln, 0 }, /* OP */
1.95 schwarze 76: { in_line_eoln, MAN_XSCOPE }, /* EX */
77: { in_line_eoln, MAN_XSCOPE }, /* EE */
78: { blk_exp, MAN_XSCOPE }, /* UR */
79: { blk_close, MAN_XSCOPE }, /* UE */
80: { blk_exp, MAN_XSCOPE }, /* MT */
81: { blk_close, MAN_XSCOPE }, /* ME */
1.6 schwarze 82: };
1.1 kristaps 83:
84:
1.89 schwarze 85: const struct man_macro *
86: man_macro(enum roff_tok tok)
87: {
88: assert(tok >= MAN_TH && tok <= MAN_MAX);
89: return man_macros + (tok - MAN_TH);
90: }
91:
1.53 schwarze 92: void
1.67 schwarze 93: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 94: {
1.64 schwarze 95: struct roff_node *n;
1.1 kristaps 96:
1.46 schwarze 97: to = to->parent;
98: n = man->last;
99: while (n != to) {
1.50 schwarze 100:
101: /* Reached the end of the document? */
102:
1.77 schwarze 103: if (to == NULL && ! (n->flags & NODE_VALID)) {
1.50 schwarze 104: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
1.95 schwarze 105: man_macro(n->tok)->flags &
106: (MAN_BSCOPED | MAN_NSCOPED)) {
1.97 ! schwarze 107: mandoc_msg(MANDOCERR_BLK_LINE,
! 108: n->line, n->pos,
1.78 schwarze 109: "EOF breaks %s", roff_name[n->tok]);
1.50 schwarze 110: if (man->flags & MAN_ELINE)
111: man->flags &= ~MAN_ELINE;
112: else {
1.63 schwarze 113: assert(n->type == ROFFT_HEAD);
1.50 schwarze 114: n = n->parent;
115: man->flags &= ~MAN_BLINE;
116: }
117: man->last = n;
118: n = n->parent;
1.68 schwarze 119: roff_node_delete(man, man->last);
1.50 schwarze 120: continue;
121: }
1.63 schwarze 122: if (n->type == ROFFT_BLOCK &&
1.89 schwarze 123: man_macro(n->tok)->fp == blk_exp)
1.50 schwarze 124: mandoc_msg(MANDOCERR_BLK_NOEND,
1.97 ! schwarze 125: n->line, n->pos, "%s",
1.78 schwarze 126: roff_name[n->tok]);
1.50 schwarze 127: }
128:
1.27 schwarze 129: /*
1.46 schwarze 130: * We might delete the man->last node
131: * in the post-validation phase.
132: * Save a pointer to the parent such that
133: * we know where to continue the iteration.
1.27 schwarze 134: */
1.51 schwarze 135:
1.46 schwarze 136: man->last = n;
137: n = n->parent;
1.77 schwarze 138: man->last->flags |= NODE_VALID;
1.6 schwarze 139: }
1.51 schwarze 140:
141: /*
142: * If we ended up at the parent of the node we were
143: * supposed to rewind to, that means the target node
144: * got deleted, so add the next node we parse as a child
145: * of the parent instead of as a sibling of the target.
146: */
147:
148: man->next = (man->last == to) ?
1.67 schwarze 149: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.6 schwarze 150: }
1.1 kristaps 151:
1.6 schwarze 152: /*
153: * Rewinding entails ascending the parse tree until a coherent point,
154: * for example, the `SH' macro will close out any intervening `SS'
155: * scopes. When a scope is closed, it must be validated and actioned.
156: */
1.53 schwarze 157: static void
1.78 schwarze 158: rew_scope(struct roff_man *man, enum roff_tok tok)
1.6 schwarze 159: {
1.64 schwarze 160: struct roff_node *n;
1.1 kristaps 161:
1.66 schwarze 162: /* Preserve empty paragraphs before RS. */
163:
164: n = man->last;
1.76 schwarze 165: if (tok == MAN_RS && n->child == NULL &&
1.66 schwarze 166: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
167: return;
168:
169: for (;;) {
170: if (n->type == ROFFT_ROOT)
171: return;
1.77 schwarze 172: if (n->flags & NODE_VALID) {
1.66 schwarze 173: n = n->parent;
174: continue;
175: }
176: if (n->type != ROFFT_BLOCK) {
177: if (n->parent->type == ROFFT_ROOT) {
178: man_unscope(man, n);
179: return;
180: } else {
181: n = n->parent;
182: continue;
183: }
184: }
185: if (tok != MAN_SH && (n->tok == MAN_SH ||
186: (tok != MAN_SS && (n->tok == MAN_SS ||
1.89 schwarze 187: man_macro(n->tok)->fp == blk_exp))))
1.53 schwarze 188: return;
1.66 schwarze 189: man_unscope(man, n);
190: n = man->last;
1.1 kristaps 191: }
1.6 schwarze 192: }
193:
1.1 kristaps 194:
1.12 schwarze 195: /*
196: * Close out a generic explicit macro.
197: */
1.53 schwarze 198: void
1.7 schwarze 199: blk_close(MACRO_PROT_ARGS)
200: {
1.86 schwarze 201: enum roff_tok ctok, ntok;
1.64 schwarze 202: const struct roff_node *nn;
1.55 schwarze 203: char *p;
1.86 schwarze 204: int cline, cpos, nrew, target;
1.7 schwarze 205:
1.55 schwarze 206: nrew = 1;
1.7 schwarze 207: switch (tok) {
1.45 schwarze 208: case MAN_RE:
1.7 schwarze 209: ntok = MAN_RS;
1.55 schwarze 210: if ( ! man_args(man, line, pos, buf, &p))
211: break;
212: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 213: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.55 schwarze 214: nrew++;
215: target = strtol(p, &p, 10);
216: if (*p != '\0')
1.97 ! schwarze 217: mandoc_msg(MANDOCERR_ARG_EXCESS, line,
! 218: (int)(p - buf), "RE ... %s", p);
1.55 schwarze 219: if (target == 0)
220: target = 1;
221: nrew -= target;
222: if (nrew < 1) {
1.97 ! schwarze 223: mandoc_msg(MANDOCERR_RE_NOTOPEN,
1.55 schwarze 224: line, ppos, "RE %d", target);
225: return;
226: }
1.90 schwarze 227: break;
228: case MAN_YS:
229: ntok = MAN_SY;
1.39 schwarze 230: break;
1.45 schwarze 231: case MAN_UE:
1.39 schwarze 232: ntok = MAN_UR;
1.85 bentley 233: break;
234: case MAN_ME:
235: ntok = MAN_MT;
1.7 schwarze 236: break;
237: default:
238: abort();
239: }
240:
1.38 schwarze 241: for (nn = man->last->parent; nn; nn = nn->parent)
1.63 schwarze 242: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.7 schwarze 243: break;
244:
1.53 schwarze 245: if (nn == NULL) {
1.97 ! schwarze 246: mandoc_msg(MANDOCERR_BLK_NOTOPEN,
! 247: line, ppos, "%s", roff_name[tok]);
1.66 schwarze 248: rew_scope(man, MAN_PP);
1.93 schwarze 249: if (tok == MAN_RE) {
250: roff_elem_alloc(man, line, ppos, ROFF_br);
251: man->last->flags |= NODE_LINE |
252: NODE_VALID | NODE_ENDED;
253: man->next = ROFF_NEXT_SIBLING;
254: }
1.86 schwarze 255: return;
256: }
257:
258: cline = man->last->line;
259: cpos = man->last->pos;
260: ctok = man->last->tok;
261: man_unscope(man, nn);
262:
263: if (tok == MAN_RE && nn->head->aux > 0)
264: roff_setreg(man->roff, "an-margin", nn->head->aux, '-');
265:
266: /* Trailing text. */
267:
268: if (buf[*pos] != '\0') {
269: roff_word_alloc(man, line, ppos, buf + *pos);
270: man->last->flags |= NODE_DELIMC;
1.92 schwarze 271: if (mandoc_eos(man->last->string, strlen(man->last->string)))
272: man->last->flags |= NODE_EOS;
1.86 schwarze 273: }
274:
275: /* Move a trailing paragraph behind the block. */
276:
277: if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) {
278: *pos = strlen(buf);
1.87 schwarze 279: blk_imp(man, ctok, cline, cpos, pos, buf);
1.91 schwarze 280: }
281:
282: /* Synopsis blocks need an explicit end marker for spacing. */
283:
284: if (tok == MAN_YS && man->last == nn) {
285: roff_elem_alloc(man, line, ppos, tok);
286: man_unscope(man, man->last);
1.57 schwarze 287: }
1.7 schwarze 288: }
289:
1.53 schwarze 290: void
1.12 schwarze 291: blk_exp(MACRO_PROT_ARGS)
292: {
1.64 schwarze 293: struct roff_node *head;
1.60 schwarze 294: char *p;
1.29 schwarze 295: int la;
1.12 schwarze 296:
1.94 schwarze 297: if (tok == MAN_RS)
298: rew_scope(man, tok);
1.70 schwarze 299: roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 300: head = roff_head_alloc(man, line, ppos, tok);
1.12 schwarze 301:
1.60 schwarze 302: la = *pos;
1.83 schwarze 303: if (man_args(man, line, pos, buf, &p)) {
1.69 schwarze 304: roff_word_alloc(man, line, la, p);
1.83 schwarze 305: if (tok == MAN_RS) {
306: if (roff_getreg(man->roff, "an-margin") == 0)
307: roff_setreg(man->roff, "an-margin",
308: 7 * 24, '=');
309: if ((head->aux = strtod(p, NULL) * 24.0) > 0)
310: roff_setreg(man->roff, "an-margin",
311: head->aux, '+');
312: }
313: }
1.12 schwarze 314:
1.60 schwarze 315: if (buf[*pos] != '\0')
1.97 ! schwarze 316: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
! 317: "%s ... %s", roff_name[tok], buf + *pos);
1.36 schwarze 318:
1.60 schwarze 319: man_unscope(man, head);
1.68 schwarze 320: roff_body_alloc(man, line, ppos, tok);
1.12 schwarze 321: }
322:
1.6 schwarze 323: /*
1.63 schwarze 324: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
325: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.6 schwarze 326: * scopes, such as `SH' closing out an `SS', are defined in the rew
327: * routines.
328: */
1.53 schwarze 329: void
1.6 schwarze 330: blk_imp(MACRO_PROT_ARGS)
331: {
1.29 schwarze 332: int la;
1.6 schwarze 333: char *p;
1.64 schwarze 334: struct roff_node *n;
1.6 schwarze 335:
1.66 schwarze 336: rew_scope(man, tok);
1.70 schwarze 337: n = roff_block_alloc(man, line, ppos, tok);
1.68 schwarze 338: if (n->tok == MAN_SH || n->tok == MAN_SS)
339: man->flags &= ~MAN_LITERAL;
340: n = roff_head_alloc(man, line, ppos, tok);
1.7 schwarze 341:
1.6 schwarze 342: /* Add line arguments. */
1.1 kristaps 343:
1.6 schwarze 344: for (;;) {
345: la = *pos;
1.38 schwarze 346: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 347: break;
1.69 schwarze 348: roff_word_alloc(man, line, la, p);
1.1 kristaps 349: }
350:
1.61 schwarze 351: /*
352: * For macros having optional next-line scope,
353: * keep the head open if there were no arguments.
1.95 schwarze 354: * For `TP' and `TQ', always keep the head open.
1.61 schwarze 355: */
1.6 schwarze 356:
1.95 schwarze 357: if (man_macro(tok)->flags & MAN_BSCOPED &&
1.88 schwarze 358: (tok == MAN_TP || tok == MAN_TQ || n == man->last)) {
1.61 schwarze 359: man->flags |= MAN_BLINE;
360: return;
1.7 schwarze 361: }
1.61 schwarze 362:
363: /* Close out the head and open the body. */
364:
1.65 schwarze 365: man_unscope(man, n);
1.68 schwarze 366: roff_body_alloc(man, line, ppos, tok);
1.1 kristaps 367: }
368:
1.53 schwarze 369: void
1.6 schwarze 370: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 371: {
1.29 schwarze 372: int la;
1.6 schwarze 373: char *p;
1.64 schwarze 374: struct roff_node *n;
1.1 kristaps 375:
1.70 schwarze 376: roff_elem_alloc(man, line, ppos, tok);
1.38 schwarze 377: n = man->last;
1.1 kristaps 378:
1.6 schwarze 379: for (;;) {
1.79 schwarze 380: if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
1.97 ! schwarze 381: mandoc_msg(MANDOCERR_ARG_SKIP, line, *pos,
! 382: "%s %s", roff_name[tok], buf + *pos);
1.59 schwarze 383: break;
384: }
1.82 schwarze 385: if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) {
1.97 ! schwarze 386: mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos,
! 387: "%s ... %s", roff_name[tok], buf + *pos);
1.58 schwarze 388: break;
389: }
1.6 schwarze 390: la = *pos;
1.38 schwarze 391: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 392: break;
1.89 schwarze 393: if (man_macro(tok)->flags & MAN_JOIN &&
1.63 schwarze 394: man->last->type == ROFFT_TEXT)
1.69 schwarze 395: roff_word_append(man, p);
1.53 schwarze 396: else
1.69 schwarze 397: roff_word_alloc(man, line, la, p);
1.6 schwarze 398: }
1.41 schwarze 399:
400: /*
1.77 schwarze 401: * Append NODE_EOS in case the last snipped argument
1.41 schwarze 402: * ends with a dot, e.g. `.IR syslog (3).'
403: */
404:
405: if (n != man->last &&
1.43 schwarze 406: mandoc_eos(man->last->string, strlen(man->last->string)))
1.77 schwarze 407: man->last->flags |= NODE_EOS;
1.1 kristaps 408:
1.11 schwarze 409: /*
1.95 schwarze 410: * If no arguments are specified and this is MAN_ESCOPED (i.e.,
1.11 schwarze 411: * next-line scoped), then set our mode to indicate that we're
412: * waiting for terms to load into our context.
413: */
414:
1.95 schwarze 415: if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) {
1.38 schwarze 416: man->flags |= MAN_ELINE;
1.53 schwarze 417: return;
1.11 schwarze 418: }
1.31 schwarze 419:
1.63 schwarze 420: assert(man->last->type != ROFFT_ROOT);
1.67 schwarze 421: man->next = ROFF_NEXT_SIBLING;
1.45 schwarze 422:
1.75 schwarze 423: /* Rewind our element scope. */
1.1 kristaps 424:
1.38 schwarze 425: for ( ; man->last; man->last = man->last->parent) {
1.75 schwarze 426: man_state(man, man->last);
1.38 schwarze 427: if (man->last == n)
1.6 schwarze 428: break;
429: }
1.95 schwarze 430:
431: /* Rewind next-line scoped ancestors, if any. */
432:
433: if (man_macro(tok)->flags & MAN_ESCOPED)
434: man_descope(man, line, ppos, NULL);
1.6 schwarze 435: }
1.1 kristaps 436:
1.53 schwarze 437: void
1.71 schwarze 438: man_endparse(struct roff_man *man)
1.6 schwarze 439: {
1.1 kristaps 440:
1.53 schwarze 441: man_unscope(man, man->first);
1.75 schwarze 442: man->flags &= ~MAN_LITERAL;
1.6 schwarze 443: }
1.1 kristaps 444:
1.29 schwarze 445: static int
1.67 schwarze 446: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 447: {
448: char *start;
449:
450: assert(*pos);
451: *v = start = buf + *pos;
452: assert(' ' != *start);
453:
454: if ('\0' == *start)
1.74 schwarze 455: return 0;
1.29 schwarze 456:
1.38 schwarze 457: *v = mandoc_getarg(man->parse, v, line, pos);
1.74 schwarze 458: return 1;
1.29 schwarze 459: }
![[BACK]](/icons/back.gif){kind=icon}
Return to man_macro.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc