Annotation of mandoc/man_macro.c, Revision 1.118
1.118 ! schwarze 1: /* $Id: man_macro.c,v 1.117 2017/05/04 17:48:28 schwarze Exp $ */
1.1 kristaps 2: /*
1.65 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.116 schwarze 4: * Copyright (c) 2012-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
1.79 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.14 kristaps 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.101 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.14 kristaps 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.101 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.14 kristaps 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.30 kristaps 19: #include "config.h"
1.88 schwarze 20:
21: #include <sys/types.h>
1.30 kristaps 22:
1.1 kristaps 23: #include <assert.h>
24: #include <ctype.h>
25: #include <stdlib.h>
26: #include <string.h>
27:
1.101 schwarze 28: #include "mandoc.h"
29: #include "roff.h"
1.58 kristaps 30: #include "man.h"
1.57 kristaps 31: #include "libmandoc.h"
1.106 schwarze 32: #include "roff_int.h"
1.1 kristaps 33: #include "libman.h"
34:
1.91 schwarze 35: static void blk_close(MACRO_PROT_ARGS);
36: static void blk_exp(MACRO_PROT_ARGS);
37: static void blk_imp(MACRO_PROT_ARGS);
38: static void in_line_eoln(MACRO_PROT_ARGS);
1.105 schwarze 39: static int man_args(struct roff_man *, int,
1.60 kristaps 40: int *, char *, char **);
1.116 schwarze 41: static void rew_scope(struct roff_man *, enum roff_tok);
1.19 kristaps 42:
1.116 schwarze 43: const struct man_macro __man_macros[MAN_MAX - MAN_TH] = {
1.66 schwarze 44: { in_line_eoln, MAN_BSCOPE }, /* TH */
45: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
46: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
1.99 schwarze 47: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* TP */
1.66 schwarze 48: { blk_imp, MAN_BSCOPE }, /* LP */
49: { blk_imp, MAN_BSCOPE }, /* PP */
50: { blk_imp, MAN_BSCOPE }, /* P */
51: { blk_imp, MAN_BSCOPE }, /* IP */
52: { blk_imp, MAN_BSCOPE }, /* HP */
1.90 schwarze 53: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
54: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
1.19 kristaps 55: { in_line_eoln, 0 }, /* BI */
56: { in_line_eoln, 0 }, /* IB */
57: { in_line_eoln, 0 }, /* BR */
58: { in_line_eoln, 0 }, /* RB */
1.90 schwarze 59: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
60: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
61: { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
1.19 kristaps 62: { in_line_eoln, 0 }, /* IR */
63: { in_line_eoln, 0 }, /* RI */
1.31 kristaps 64: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.110 schwarze 65: { in_line_eoln, MAN_NSCOPED }, /* nf */
66: { in_line_eoln, MAN_NSCOPED }, /* fi */
1.92 schwarze 67: { blk_close, MAN_BSCOPE }, /* RE */
1.99 schwarze 68: { blk_exp, MAN_BSCOPE }, /* RS */
1.23 kristaps 69: { in_line_eoln, 0 }, /* DT */
1.28 kristaps 70: { in_line_eoln, 0 }, /* UC */
1.100 schwarze 71: { in_line_eoln, MAN_NSCOPED }, /* PD */
1.45 joerg 72: { in_line_eoln, 0 }, /* AT */
1.49 kristaps 73: { in_line_eoln, 0 }, /* in */
1.71 kristaps 74: { in_line_eoln, 0 }, /* OP */
1.72 schwarze 75: { in_line_eoln, MAN_BSCOPE }, /* EX */
76: { in_line_eoln, MAN_BSCOPE }, /* EE */
1.99 schwarze 77: { blk_exp, MAN_BSCOPE }, /* UR */
1.92 schwarze 78: { blk_close, MAN_BSCOPE }, /* UE */
1.81 schwarze 79: { in_line_eoln, 0 }, /* ll */
1.19 kristaps 80: };
1.116 schwarze 81: const struct man_macro *const man_macros = __man_macros - MAN_TH;
1.1 kristaps 82:
83:
1.91 schwarze 84: void
1.105 schwarze 85: man_unscope(struct roff_man *man, const struct roff_node *to)
1.1 kristaps 86: {
1.102 schwarze 87: struct roff_node *n;
1.1 kristaps 88:
1.83 schwarze 89: to = to->parent;
90: n = man->last;
91: while (n != to) {
1.87 schwarze 92:
93: /* Reached the end of the document? */
94:
1.115 schwarze 95: if (to == NULL && ! (n->flags & NODE_VALID)) {
1.87 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.116 schwarze 100: "EOF breaks %s", roff_name[n->tok]);
1.87 schwarze 101: if (man->flags & MAN_ELINE)
102: man->flags &= ~MAN_ELINE;
103: else {
1.101 schwarze 104: assert(n->type == ROFFT_HEAD);
1.87 schwarze 105: n = n->parent;
106: man->flags &= ~MAN_BLINE;
107: }
108: man->last = n;
109: n = n->parent;
1.106 schwarze 110: roff_node_delete(man, man->last);
1.87 schwarze 111: continue;
112: }
1.101 schwarze 113: if (n->type == ROFFT_BLOCK &&
1.99 schwarze 114: man_macros[n->tok].fp == blk_exp)
1.87 schwarze 115: mandoc_msg(MANDOCERR_BLK_NOEND,
116: man->parse, n->line, n->pos,
1.116 schwarze 117: roff_name[n->tok]);
1.87 schwarze 118: }
119:
1.55 kristaps 120: /*
1.83 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.55 kristaps 125: */
1.89 schwarze 126:
1.83 schwarze 127: man->last = n;
128: n = n->parent;
1.115 schwarze 129: man->last->flags |= NODE_VALID;
1.19 kristaps 130: }
1.89 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.105 schwarze 140: ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING;
1.19 kristaps 141: }
1.1 kristaps 142:
1.19 kristaps 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.91 schwarze 148: static void
1.116 schwarze 149: rew_scope(struct roff_man *man, enum roff_tok tok)
1.19 kristaps 150: {
1.102 schwarze 151: struct roff_node *n;
1.7 kristaps 152:
1.104 schwarze 153: /* Preserve empty paragraphs before RS. */
154:
155: n = man->last;
1.114 schwarze 156: if (tok == MAN_RS && n->child == NULL &&
1.104 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.115 schwarze 163: if (n->flags & NODE_VALID) {
1.104 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.91 schwarze 179: return;
1.104 schwarze 180: man_unscope(man, n);
181: n = man->last;
1.6 kristaps 182: }
1.19 kristaps 183: }
184:
1.6 kristaps 185:
1.36 kristaps 186: /*
187: * Close out a generic explicit macro.
188: */
1.91 schwarze 189: void
1.21 kristaps 190: blk_close(MACRO_PROT_ARGS)
191: {
1.116 schwarze 192: enum roff_tok ntok;
1.102 schwarze 193: const struct roff_node *nn;
1.93 schwarze 194: char *p;
195: int nrew, target;
1.21 kristaps 196:
1.93 schwarze 197: nrew = 1;
1.21 kristaps 198: switch (tok) {
1.82 schwarze 199: case MAN_RE:
1.21 kristaps 200: ntok = MAN_RS;
1.93 schwarze 201: if ( ! man_args(man, line, pos, buf, &p))
202: break;
203: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 204: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.93 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.76 schwarze 218: break;
1.82 schwarze 219: case MAN_UE:
1.76 schwarze 220: ntok = MAN_UR;
1.21 kristaps 221: break;
222: default:
223: abort();
224: }
225:
1.75 schwarze 226: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 227: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.21 kristaps 228: break;
229:
1.91 schwarze 230: if (nn == NULL) {
1.84 schwarze 231: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
1.116 schwarze 232: line, ppos, roff_name[tok]);
1.104 schwarze 233: rew_scope(man, MAN_PP);
1.95 schwarze 234: } else {
235: line = man->last->line;
236: ppos = man->last->pos;
237: ntok = man->last->tok;
1.83 schwarze 238: man_unscope(man, nn);
1.95 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.21 kristaps 247: }
248:
1.91 schwarze 249: void
1.35 kristaps 250: blk_exp(MACRO_PROT_ARGS)
251: {
1.102 schwarze 252: struct roff_node *head;
1.98 schwarze 253: char *p;
1.59 kristaps 254: int la;
1.35 kristaps 255:
1.104 schwarze 256: rew_scope(man, tok);
1.108 schwarze 257: roff_block_alloc(man, line, ppos, tok);
1.106 schwarze 258: head = roff_head_alloc(man, line, ppos, tok);
1.35 kristaps 259:
1.98 schwarze 260: la = *pos;
261: if (man_args(man, line, pos, buf, &p))
1.107 schwarze 262: roff_word_alloc(man, line, la, p);
1.35 kristaps 263:
1.98 schwarze 264: if (buf[*pos] != '\0')
1.116 schwarze 265: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, line,
266: *pos, "%s ... %s", roff_name[tok], buf + *pos);
1.73 schwarze 267:
1.98 schwarze 268: man_unscope(man, head);
1.106 schwarze 269: roff_body_alloc(man, line, ppos, tok);
1.35 kristaps 270: }
271:
1.19 kristaps 272: /*
1.101 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.19 kristaps 275: * scopes, such as `SH' closing out an `SS', are defined in the rew
276: * routines.
277: */
1.91 schwarze 278: void
1.19 kristaps 279: blk_imp(MACRO_PROT_ARGS)
280: {
1.59 kristaps 281: int la;
1.19 kristaps 282: char *p;
1.102 schwarze 283: struct roff_node *n;
1.19 kristaps 284:
1.104 schwarze 285: rew_scope(man, tok);
1.108 schwarze 286: n = roff_block_alloc(man, line, ppos, tok);
1.106 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.25 kristaps 290:
1.19 kristaps 291: /* Add line arguments. */
1.3 kristaps 292:
1.19 kristaps 293: for (;;) {
294: la = *pos;
1.75 schwarze 295: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 296: break;
1.107 schwarze 297: roff_word_alloc(man, line, la, p);
1.6 kristaps 298: }
299:
1.99 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.19 kristaps 305:
1.99 schwarze 306: if (man_macros[tok].flags & MAN_SCOPED &&
307: (tok == MAN_TP || n == man->last)) {
308: man->flags |= MAN_BLINE;
309: return;
1.27 kristaps 310: }
1.99 schwarze 311:
312: /* Close out the head and open the body. */
313:
1.103 schwarze 314: man_unscope(man, n);
1.106 schwarze 315: roff_body_alloc(man, line, ppos, tok);
1.4 kristaps 316: }
317:
1.91 schwarze 318: void
1.19 kristaps 319: in_line_eoln(MACRO_PROT_ARGS)
1.3 kristaps 320: {
1.59 kristaps 321: int la;
1.19 kristaps 322: char *p;
1.102 schwarze 323: struct roff_node *n;
1.3 kristaps 324:
1.108 schwarze 325: roff_elem_alloc(man, line, ppos, tok);
1.75 schwarze 326: n = man->last;
1.3 kristaps 327:
1.19 kristaps 328: for (;;) {
1.117 schwarze 329: if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) {
1.96 schwarze 330: mandoc_vmsg(MANDOCERR_ARG_SKIP,
331: man->parse, line, *pos, "%s %s",
1.116 schwarze 332: roff_name[tok], buf + *pos);
1.97 schwarze 333: break;
334: }
335: if (buf[*pos] != '\0' && man->last != n &&
1.118 ! schwarze 336: (tok == MAN_PD || tok == MAN_sp)) {
1.97 schwarze 337: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
338: man->parse, line, *pos, "%s ... %s",
1.116 schwarze 339: roff_name[tok], buf + *pos);
1.96 schwarze 340: break;
341: }
1.19 kristaps 342: la = *pos;
1.75 schwarze 343: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 344: break;
1.90 schwarze 345: if (man_macros[tok].flags & MAN_JOIN &&
1.101 schwarze 346: man->last->type == ROFFT_TEXT)
1.107 schwarze 347: roff_word_append(man, p);
1.91 schwarze 348: else
1.107 schwarze 349: roff_word_alloc(man, line, la, p);
1.19 kristaps 350: }
1.78 schwarze 351:
352: /*
1.115 schwarze 353: * Append NODE_EOS in case the last snipped argument
1.78 schwarze 354: * ends with a dot, e.g. `.IR syslog (3).'
355: */
356:
357: if (n != man->last &&
1.80 schwarze 358: mandoc_eos(man->last->string, strlen(man->last->string)))
1.115 schwarze 359: man->last->flags |= NODE_EOS;
1.3 kristaps 360:
1.31 kristaps 361: /*
362: * If no arguments are specified and this is MAN_SCOPED (i.e.,
363: * next-line scoped), then set our mode to indicate that we're
364: * waiting for terms to load into our context.
365: */
366:
1.91 schwarze 367: if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
368: assert( ! (man_macros[tok].flags & MAN_NSCOPED));
1.75 schwarze 369: man->flags |= MAN_ELINE;
1.91 schwarze 370: return;
1.31 kristaps 371: }
1.64 kristaps 372:
1.101 schwarze 373: assert(man->last->type != ROFFT_ROOT);
1.105 schwarze 374: man->next = ROFF_NEXT_SIBLING;
1.82 schwarze 375:
1.113 schwarze 376: /* Rewind our element scope. */
1.3 kristaps 377:
1.75 schwarze 378: for ( ; man->last; man->last = man->last->parent) {
1.113 schwarze 379: man_state(man, man->last);
1.75 schwarze 380: if (man->last == n)
1.19 kristaps 381: break;
382: }
383: }
1.3 kristaps 384:
1.91 schwarze 385: void
1.109 schwarze 386: man_endparse(struct roff_man *man)
1.19 kristaps 387: {
1.22 kristaps 388:
1.91 schwarze 389: man_unscope(man, man->first);
1.113 schwarze 390: man->flags &= ~MAN_LITERAL;
1.19 kristaps 391: }
1.3 kristaps 392:
1.60 kristaps 393: static int
1.105 schwarze 394: man_args(struct roff_man *man, int line, int *pos, char *buf, char **v)
1.60 kristaps 395: {
396: char *start;
397:
398: assert(*pos);
399: *v = start = buf + *pos;
400: assert(' ' != *start);
401:
402: if ('\0' == *start)
1.112 schwarze 403: return 0;
1.60 kristaps 404:
1.75 schwarze 405: *v = mandoc_getarg(man->parse, v, line, pos);
1.112 schwarze 406: return 1;
1.60 kristaps 407: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to man_macro.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc