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