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