Annotation of mandoc/man_macro.c, Revision 1.104
1.104 ! schwarze 1: /* $Id: man_macro.c,v 1.103 2015/04/03 17:00:52 schwarze Exp $ */
1.1 kristaps 2: /*
1.65 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.93 schwarze 4: * Copyright (c) 2012, 2013, 2014, 2015 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.1 kristaps 32: #include "libman.h"
33:
1.91 schwarze 34: static void blk_close(MACRO_PROT_ARGS);
35: static void blk_exp(MACRO_PROT_ARGS);
36: static void blk_imp(MACRO_PROT_ARGS);
37: static void in_line_eoln(MACRO_PROT_ARGS);
1.82 schwarze 38: static int man_args(struct man *, int,
1.60 kristaps 39: int *, char *, char **);
1.104 ! schwarze 40: static void rew_scope(struct man *, int);
1.19 kristaps 41:
42: const struct man_macro __man_macros[MAN_MAX] = {
1.31 kristaps 43: { in_line_eoln, MAN_NSCOPED }, /* br */
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.66 schwarze 65: { in_line_eoln, MAN_BSCOPE }, /* nf */
66: { in_line_eoln, MAN_BSCOPE }, /* 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.53 kristaps 74: { in_line_eoln, 0 }, /* ft */
1.71 kristaps 75: { in_line_eoln, 0 }, /* OP */
1.72 schwarze 76: { in_line_eoln, MAN_BSCOPE }, /* EX */
77: { in_line_eoln, MAN_BSCOPE }, /* EE */
1.99 schwarze 78: { blk_exp, MAN_BSCOPE }, /* UR */
1.92 schwarze 79: { blk_close, MAN_BSCOPE }, /* UE */
1.81 schwarze 80: { in_line_eoln, 0 }, /* ll */
1.19 kristaps 81: };
1.9 kristaps 82:
1.19 kristaps 83: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 84:
85:
1.91 schwarze 86: void
1.102 schwarze 87: man_unscope(struct man *man, const struct roff_node *to)
1.1 kristaps 88: {
1.102 schwarze 89: struct roff_node *n;
1.1 kristaps 90:
1.83 schwarze 91: to = to->parent;
92: n = man->last;
93: while (n != to) {
1.87 schwarze 94:
95: /* Reached the end of the document? */
96:
97: if (to == NULL && ! (n->flags & MAN_VALID)) {
98: if (man->flags & (MAN_BLINE | MAN_ELINE) &&
99: man_macros[n->tok].flags & MAN_SCOPED) {
100: mandoc_vmsg(MANDOCERR_BLK_LINE,
101: man->parse, n->line, n->pos,
102: "EOF breaks %s",
103: man_macronames[n->tok]);
104: if (man->flags & MAN_ELINE)
105: man->flags &= ~MAN_ELINE;
106: else {
1.101 schwarze 107: assert(n->type == ROFFT_HEAD);
1.87 schwarze 108: n = n->parent;
109: man->flags &= ~MAN_BLINE;
110: }
111: man->last = n;
112: n = n->parent;
113: man_node_delete(man, man->last);
114: continue;
115: }
1.101 schwarze 116: if (n->type == ROFFT_BLOCK &&
1.99 schwarze 117: man_macros[n->tok].fp == blk_exp)
1.87 schwarze 118: mandoc_msg(MANDOCERR_BLK_NOEND,
119: man->parse, n->line, n->pos,
120: man_macronames[n->tok]);
121: }
122:
1.55 kristaps 123: /*
1.83 schwarze 124: * We might delete the man->last node
125: * in the post-validation phase.
126: * Save a pointer to the parent such that
127: * we know where to continue the iteration.
1.55 kristaps 128: */
1.89 schwarze 129:
1.83 schwarze 130: man->last = n;
131: n = n->parent;
1.91 schwarze 132: man_valid_post(man);
1.19 kristaps 133: }
1.89 schwarze 134:
135: /*
136: * If we ended up at the parent of the node we were
137: * supposed to rewind to, that means the target node
138: * got deleted, so add the next node we parse as a child
139: * of the parent instead of as a sibling of the target.
140: */
141:
142: man->next = (man->last == to) ?
143: MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
1.19 kristaps 144: }
1.1 kristaps 145:
1.19 kristaps 146: /*
147: * Rewinding entails ascending the parse tree until a coherent point,
148: * for example, the `SH' macro will close out any intervening `SS'
149: * scopes. When a scope is closed, it must be validated and actioned.
150: */
1.91 schwarze 151: static void
1.104 ! schwarze 152: rew_scope(struct man *man, int tok)
1.19 kristaps 153: {
1.102 schwarze 154: struct roff_node *n;
1.7 kristaps 155:
1.104 ! schwarze 156: /* Preserve empty paragraphs before RS. */
! 157:
! 158: n = man->last;
! 159: if (tok == MAN_RS && n->nchild == 0 &&
! 160: (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP))
! 161: return;
! 162:
! 163: for (;;) {
! 164: if (n->type == ROFFT_ROOT)
! 165: return;
! 166: if (n->flags & MAN_VALID) {
! 167: n = n->parent;
! 168: continue;
! 169: }
! 170: if (n->type != ROFFT_BLOCK) {
! 171: if (n->parent->type == ROFFT_ROOT) {
! 172: man_unscope(man, n);
! 173: return;
! 174: } else {
! 175: n = n->parent;
! 176: continue;
! 177: }
! 178: }
! 179: if (tok != MAN_SH && (n->tok == MAN_SH ||
! 180: (tok != MAN_SS && (n->tok == MAN_SS ||
! 181: man_macros[n->tok].fp == blk_exp))))
1.91 schwarze 182: return;
1.104 ! schwarze 183: man_unscope(man, n);
! 184: n = man->last;
1.6 kristaps 185: }
1.19 kristaps 186: }
187:
1.6 kristaps 188:
1.36 kristaps 189: /*
190: * Close out a generic explicit macro.
191: */
1.91 schwarze 192: void
1.21 kristaps 193: blk_close(MACRO_PROT_ARGS)
194: {
1.102 schwarze 195: int ntok;
196: const struct roff_node *nn;
1.93 schwarze 197: char *p;
198: int nrew, target;
1.21 kristaps 199:
1.93 schwarze 200: nrew = 1;
1.21 kristaps 201: switch (tok) {
1.82 schwarze 202: case MAN_RE:
1.21 kristaps 203: ntok = MAN_RS;
1.93 schwarze 204: if ( ! man_args(man, line, pos, buf, &p))
205: break;
206: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 207: if (nn->tok == ntok && nn->type == ROFFT_BLOCK)
1.93 schwarze 208: nrew++;
209: target = strtol(p, &p, 10);
210: if (*p != '\0')
211: mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
212: line, p - buf, "RE ... %s", p);
213: if (target == 0)
214: target = 1;
215: nrew -= target;
216: if (nrew < 1) {
217: mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse,
218: line, ppos, "RE %d", target);
219: return;
220: }
1.76 schwarze 221: break;
1.82 schwarze 222: case MAN_UE:
1.76 schwarze 223: ntok = MAN_UR;
1.21 kristaps 224: break;
225: default:
226: abort();
227: /* NOTREACHED */
228: }
229:
1.75 schwarze 230: for (nn = man->last->parent; nn; nn = nn->parent)
1.101 schwarze 231: if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
1.21 kristaps 232: break;
233:
1.91 schwarze 234: if (nn == NULL) {
1.84 schwarze 235: mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
236: line, ppos, man_macronames[tok]);
1.104 ! schwarze 237: rew_scope(man, MAN_PP);
1.95 schwarze 238: } else {
239: line = man->last->line;
240: ppos = man->last->pos;
241: ntok = man->last->tok;
1.83 schwarze 242: man_unscope(man, nn);
1.95 schwarze 243:
244: /* Move a trailing paragraph behind the block. */
245:
246: if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) {
247: *pos = strlen(buf);
248: blk_imp(man, ntok, line, ppos, pos, buf);
249: }
250: }
1.21 kristaps 251: }
252:
1.91 schwarze 253: void
1.35 kristaps 254: blk_exp(MACRO_PROT_ARGS)
255: {
1.102 schwarze 256: struct roff_node *head;
1.98 schwarze 257: char *p;
1.59 kristaps 258: int la;
1.35 kristaps 259:
1.104 ! schwarze 260: rew_scope(man, tok);
1.91 schwarze 261: man_block_alloc(man, line, ppos, tok);
262: man_head_alloc(man, line, ppos, tok);
1.98 schwarze 263: head = man->last;
1.35 kristaps 264:
1.98 schwarze 265: la = *pos;
266: if (man_args(man, line, pos, buf, &p))
1.91 schwarze 267: man_word_alloc(man, line, la, p);
1.35 kristaps 268:
1.98 schwarze 269: if (buf[*pos] != '\0')
270: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
271: man->parse, line, *pos, "%s ... %s",
272: man_macronames[tok], buf + *pos);
1.73 schwarze 273:
1.98 schwarze 274: man_unscope(man, head);
1.91 schwarze 275: man_body_alloc(man, line, ppos, tok);
1.35 kristaps 276: }
277:
1.19 kristaps 278: /*
1.101 schwarze 279: * Parse an implicit-block macro. These contain a ROFFT_HEAD and a
280: * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other
1.19 kristaps 281: * scopes, such as `SH' closing out an `SS', are defined in the rew
282: * routines.
283: */
1.91 schwarze 284: void
1.19 kristaps 285: blk_imp(MACRO_PROT_ARGS)
286: {
1.59 kristaps 287: int la;
1.19 kristaps 288: char *p;
1.102 schwarze 289: struct roff_node *n;
1.19 kristaps 290:
1.104 ! schwarze 291: rew_scope(man, tok);
1.91 schwarze 292: man_block_alloc(man, line, ppos, tok);
293: man_head_alloc(man, line, ppos, tok);
1.75 schwarze 294: n = man->last;
1.25 kristaps 295:
1.19 kristaps 296: /* Add line arguments. */
1.3 kristaps 297:
1.19 kristaps 298: for (;;) {
299: la = *pos;
1.75 schwarze 300: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 301: break;
1.91 schwarze 302: man_word_alloc(man, line, la, p);
1.6 kristaps 303: }
304:
1.99 schwarze 305: /*
306: * For macros having optional next-line scope,
307: * keep the head open if there were no arguments.
308: * For `TP', always keep the head open.
309: */
1.19 kristaps 310:
1.99 schwarze 311: if (man_macros[tok].flags & MAN_SCOPED &&
312: (tok == MAN_TP || n == man->last)) {
313: man->flags |= MAN_BLINE;
314: return;
1.27 kristaps 315: }
1.99 schwarze 316:
317: /* Close out the head and open the body. */
318:
1.103 schwarze 319: man_unscope(man, n);
1.91 schwarze 320: man_body_alloc(man, line, ppos, tok);
1.4 kristaps 321: }
322:
1.91 schwarze 323: void
1.19 kristaps 324: in_line_eoln(MACRO_PROT_ARGS)
1.3 kristaps 325: {
1.59 kristaps 326: int la;
1.19 kristaps 327: char *p;
1.102 schwarze 328: struct roff_node *n;
1.3 kristaps 329:
1.91 schwarze 330: man_elem_alloc(man, line, ppos, tok);
1.75 schwarze 331: n = man->last;
1.3 kristaps 332:
1.19 kristaps 333: for (;;) {
1.96 schwarze 334: if (buf[*pos] != '\0' && (tok == MAN_br ||
335: tok == MAN_fi || tok == MAN_nf)) {
336: mandoc_vmsg(MANDOCERR_ARG_SKIP,
337: man->parse, line, *pos, "%s %s",
1.97 schwarze 338: man_macronames[tok], buf + *pos);
339: break;
340: }
341: if (buf[*pos] != '\0' && man->last != n &&
342: (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) {
343: mandoc_vmsg(MANDOCERR_ARG_EXCESS,
344: man->parse, line, *pos, "%s ... %s",
1.96 schwarze 345: man_macronames[tok], buf + *pos);
346: break;
347: }
1.19 kristaps 348: la = *pos;
1.75 schwarze 349: if ( ! man_args(man, line, pos, buf, &p))
1.19 kristaps 350: break;
1.90 schwarze 351: if (man_macros[tok].flags & MAN_JOIN &&
1.101 schwarze 352: man->last->type == ROFFT_TEXT)
1.90 schwarze 353: man_word_append(man, p);
1.91 schwarze 354: else
355: man_word_alloc(man, line, la, p);
1.19 kristaps 356: }
1.78 schwarze 357:
358: /*
359: * Append MAN_EOS in case the last snipped argument
360: * ends with a dot, e.g. `.IR syslog (3).'
361: */
362:
363: if (n != man->last &&
1.80 schwarze 364: mandoc_eos(man->last->string, strlen(man->last->string)))
1.78 schwarze 365: man->last->flags |= MAN_EOS;
1.3 kristaps 366:
1.31 kristaps 367: /*
368: * If no arguments are specified and this is MAN_SCOPED (i.e.,
369: * next-line scoped), then set our mode to indicate that we're
370: * waiting for terms to load into our context.
371: */
372:
1.91 schwarze 373: if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
374: assert( ! (man_macros[tok].flags & MAN_NSCOPED));
1.75 schwarze 375: man->flags |= MAN_ELINE;
1.91 schwarze 376: return;
1.31 kristaps 377: }
1.64 kristaps 378:
1.101 schwarze 379: assert(man->last->type != ROFFT_ROOT);
1.75 schwarze 380: man->next = MAN_NEXT_SIBLING;
1.82 schwarze 381:
1.19 kristaps 382: /*
1.31 kristaps 383: * Rewind our element scope. Note that when TH is pruned, we'll
384: * be back at the root, so make sure that we don't clobber as
385: * its sibling.
1.19 kristaps 386: */
1.3 kristaps 387:
1.75 schwarze 388: for ( ; man->last; man->last = man->last->parent) {
389: if (man->last == n)
1.19 kristaps 390: break;
1.101 schwarze 391: if (man->last->type == ROFFT_ROOT)
1.19 kristaps 392: break;
1.91 schwarze 393: man_valid_post(man);
1.19 kristaps 394: }
1.3 kristaps 395:
1.75 schwarze 396: assert(man->last);
1.3 kristaps 397:
398: /*
1.82 schwarze 399: * Same here regarding whether we're back at the root.
1.3 kristaps 400: */
401:
1.101 schwarze 402: if (man->last->type != ROFFT_ROOT)
1.91 schwarze 403: man_valid_post(man);
1.19 kristaps 404: }
1.3 kristaps 405:
406:
1.91 schwarze 407: void
1.75 schwarze 408: man_macroend(struct man *man)
1.19 kristaps 409: {
1.22 kristaps 410:
1.91 schwarze 411: man_unscope(man, man->first);
1.19 kristaps 412: }
1.3 kristaps 413:
1.60 kristaps 414: static int
1.75 schwarze 415: man_args(struct man *man, int line, int *pos, char *buf, char **v)
1.60 kristaps 416: {
417: char *start;
418:
419: assert(*pos);
420: *v = start = buf + *pos;
421: assert(' ' != *start);
422:
423: if ('\0' == *start)
424: return(0);
425:
1.75 schwarze 426: *v = mandoc_getarg(man->parse, v, line, pos);
1.60 kristaps 427: return(1);
428: }
CVSweb