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