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