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