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