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