Annotation of src/usr.bin/mandoc/man_macro.c, Revision 1.41
1.41 ! schwarze 1: /* $Id: man_macro.c,v 1.40 2013/11/11 00:35:51 schwarze Exp $ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.40 schwarze 4: * Copyright (c) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.2 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18: #include <assert.h>
19: #include <ctype.h>
20: #include <stdlib.h>
21: #include <string.h>
22:
1.29 schwarze 23: #include "man.h"
1.19 schwarze 24: #include "mandoc.h"
1.29 schwarze 25: #include "libmandoc.h"
1.1 kristaps 26: #include "libman.h"
27:
1.12 schwarze 28: enum rew {
29: REW_REWIND,
30: REW_NOHALT,
1.13 schwarze 31: REW_HALT
1.12 schwarze 32: };
1.6 schwarze 33:
1.12 schwarze 34: static int blk_close(MACRO_PROT_ARGS);
35: static int blk_exp(MACRO_PROT_ARGS);
36: static int blk_imp(MACRO_PROT_ARGS);
1.6 schwarze 37: static int in_line_eoln(MACRO_PROT_ARGS);
1.29 schwarze 38: static int man_args(struct man *, int,
39: int *, char *, char **);
1.6 schwarze 40:
1.12 schwarze 41: static int rew_scope(enum man_type,
42: struct man *, enum mant);
43: static enum rew rew_dohalt(enum mant, enum man_type,
1.6 schwarze 44: const struct man_node *);
1.12 schwarze 45: static enum rew rew_block(enum mant, enum man_type,
1.7 schwarze 46: const struct man_node *);
1.28 schwarze 47: static void rew_warn(struct man *,
1.19 schwarze 48: struct man_node *, enum mandocerr);
1.6 schwarze 49:
50: const struct man_macro __man_macros[MAN_MAX] = {
1.11 schwarze 51: { in_line_eoln, MAN_NSCOPED }, /* br */
1.32 schwarze 52: { in_line_eoln, MAN_BSCOPE }, /* TH */
53: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */
54: { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */
55: { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */
56: { blk_imp, MAN_BSCOPE }, /* LP */
57: { blk_imp, MAN_BSCOPE }, /* PP */
58: { blk_imp, MAN_BSCOPE }, /* P */
59: { blk_imp, MAN_BSCOPE }, /* IP */
60: { blk_imp, MAN_BSCOPE }, /* HP */
1.6 schwarze 61: { in_line_eoln, MAN_SCOPED }, /* SM */
62: { in_line_eoln, MAN_SCOPED }, /* SB */
63: { in_line_eoln, 0 }, /* BI */
64: { in_line_eoln, 0 }, /* IB */
65: { in_line_eoln, 0 }, /* BR */
66: { in_line_eoln, 0 }, /* RB */
67: { in_line_eoln, MAN_SCOPED }, /* R */
68: { in_line_eoln, MAN_SCOPED }, /* B */
69: { in_line_eoln, MAN_SCOPED }, /* I */
70: { in_line_eoln, 0 }, /* IR */
71: { in_line_eoln, 0 }, /* RI */
1.11 schwarze 72: { in_line_eoln, MAN_NSCOPED }, /* na */
73: { in_line_eoln, MAN_NSCOPED }, /* sp */
1.32 schwarze 74: { in_line_eoln, MAN_BSCOPE }, /* nf */
75: { in_line_eoln, MAN_BSCOPE }, /* fi */
1.7 schwarze 76: { blk_close, 0 }, /* RE */
1.37 schwarze 77: { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */
1.7 schwarze 78: { in_line_eoln, 0 }, /* DT */
1.8 schwarze 79: { in_line_eoln, 0 }, /* UC */
1.9 schwarze 80: { in_line_eoln, 0 }, /* PD */
1.18 schwarze 81: { in_line_eoln, 0 }, /* AT */
1.20 schwarze 82: { in_line_eoln, 0 }, /* in */
1.22 schwarze 83: { in_line_eoln, 0 }, /* ft */
1.34 schwarze 84: { in_line_eoln, 0 }, /* OP */
1.35 schwarze 85: { in_line_eoln, MAN_BSCOPE }, /* EX */
86: { in_line_eoln, MAN_BSCOPE }, /* EE */
1.39 schwarze 87: { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */
88: { blk_close, 0 }, /* UE */
1.6 schwarze 89: };
1.1 kristaps 90:
1.6 schwarze 91: const struct man_macro * const man_macros = __man_macros;
1.1 kristaps 92:
93:
1.13 schwarze 94: /*
95: * Warn when "n" is an explicit non-roff macro.
96: */
1.28 schwarze 97: static void
1.38 schwarze 98: rew_warn(struct man *man, struct man_node *n, enum mandocerr er)
1.13 schwarze 99: {
100:
1.19 schwarze 101: if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
1.28 schwarze 102: return;
1.13 schwarze 103: if (MAN_VALID & n->flags)
1.28 schwarze 104: return;
1.13 schwarze 105: if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
1.28 schwarze 106: return;
107:
108: assert(er < MANDOCERR_FATAL);
1.38 schwarze 109: man_nmsg(man, n, er);
1.13 schwarze 110: }
111:
112:
113: /*
1.19 schwarze 114: * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
115: * will be used if an explicit block scope is being closed out.
1.13 schwarze 116: */
1.1 kristaps 117: int
1.38 schwarze 118: man_unscope(struct man *man, const struct man_node *to,
1.19 schwarze 119: enum mandocerr er)
1.1 kristaps 120: {
1.27 schwarze 121: struct man_node *n;
1.1 kristaps 122:
1.27 schwarze 123: assert(to);
1.6 schwarze 124:
1.38 schwarze 125: man->next = MAN_NEXT_SIBLING;
1.31 schwarze 126:
1.6 schwarze 127: /* LINTED */
1.38 schwarze 128: while (man->last != to) {
1.27 schwarze 129: /*
130: * Save the parent here, because we may delete the
1.38 schwarze 131: * man->last node in the post-validation phase and reset
132: * it to man->last->parent, causing a step in the closing
1.27 schwarze 133: * out to be lost.
134: */
1.38 schwarze 135: n = man->last->parent;
136: rew_warn(man, man->last, er);
137: if ( ! man_valid_post(man))
1.6 schwarze 138: return(0);
1.38 schwarze 139: man->last = n;
140: assert(man->last);
1.6 schwarze 141: }
142:
1.38 schwarze 143: rew_warn(man, man->last, er);
144: if ( ! man_valid_post(man))
1.1 kristaps 145: return(0);
1.12 schwarze 146:
147: return(1);
1.6 schwarze 148: }
1.1 kristaps 149:
150:
1.12 schwarze 151: static enum rew
152: rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
1.7 schwarze 153: {
154:
155: if (MAN_BLOCK == type && ntok == n->parent->tok &&
156: MAN_BODY == n->parent->type)
157: return(REW_REWIND);
158: return(ntok == n->tok ? REW_HALT : REW_NOHALT);
159: }
160:
161:
1.6 schwarze 162: /*
163: * There are three scope levels: scoped to the root (all), scoped to the
164: * section (all less sections), and scoped to subsections (all less
165: * sections and subsections).
166: */
1.12 schwarze 167: static enum rew
168: rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
1.6 schwarze 169: {
1.12 schwarze 170: enum rew c;
1.1 kristaps 171:
1.13 schwarze 172: /* We cannot progress beyond the root ever. */
1.6 schwarze 173: if (MAN_ROOT == n->type)
174: return(REW_HALT);
1.13 schwarze 175:
1.6 schwarze 176: assert(n->parent);
1.13 schwarze 177:
178: /* Normal nodes shouldn't go to the level of the root. */
1.6 schwarze 179: if (MAN_ROOT == n->parent->type)
180: return(REW_REWIND);
1.13 schwarze 181:
182: /* Already-validated nodes should be closed out. */
1.6 schwarze 183: if (MAN_VALID & n->flags)
184: return(REW_NOHALT);
185:
1.13 schwarze 186: /* First: rewind to ourselves. */
1.36 schwarze 187: if (type == n->type && tok == n->tok) {
188: if (MAN_EXPLICIT & man_macros[n->tok].flags)
189: return(REW_HALT);
190: else
191: return(REW_REWIND);
192: }
1.7 schwarze 193:
1.13 schwarze 194: /*
195: * Next follow the implicit scope-smashings as defined by man.7:
196: * section, sub-section, etc.
197: */
198:
1.6 schwarze 199: switch (tok) {
200: case (MAN_SH):
201: break;
202: case (MAN_SS):
203: /* Rewind to a section, if a block. */
1.7 schwarze 204: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
205: return(c);
206: break;
207: case (MAN_RS):
1.36 schwarze 208: /* Preserve empty paragraphs before RS. */
209: if (0 == n->nchild && (MAN_P == n->tok ||
210: MAN_PP == n->tok || MAN_LP == n->tok))
211: return(REW_HALT);
1.7 schwarze 212: /* Rewind to a subsection, if a block. */
213: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
214: return(c);
215: /* Rewind to a section, if a block. */
216: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
217: return(c);
1.6 schwarze 218: break;
219: default:
1.7 schwarze 220: /* Rewind to an offsetter, if a block. */
221: if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
222: return(c);
1.6 schwarze 223: /* Rewind to a subsection, if a block. */
1.7 schwarze 224: if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
225: return(c);
1.6 schwarze 226: /* Rewind to a section, if a block. */
1.7 schwarze 227: if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
228: return(c);
1.6 schwarze 229: break;
1.1 kristaps 230: }
231:
1.6 schwarze 232: return(REW_NOHALT);
233: }
1.1 kristaps 234:
235:
1.6 schwarze 236: /*
237: * Rewinding entails ascending the parse tree until a coherent point,
238: * for example, the `SH' macro will close out any intervening `SS'
239: * scopes. When a scope is closed, it must be validated and actioned.
240: */
241: static int
1.38 schwarze 242: rew_scope(enum man_type type, struct man *man, enum mant tok)
1.6 schwarze 243: {
244: struct man_node *n;
1.12 schwarze 245: enum rew c;
1.1 kristaps 246:
1.6 schwarze 247: /* LINTED */
1.38 schwarze 248: for (n = man->last; n; n = n->parent) {
1.6 schwarze 249: /*
250: * Whether we should stop immediately (REW_HALT), stop
251: * and rewind until this point (REW_REWIND), or keep
252: * rewinding (REW_NOHALT).
253: */
254: c = rew_dohalt(tok, type, n);
255: if (REW_HALT == c)
256: return(1);
257: if (REW_REWIND == c)
1.1 kristaps 258: break;
259: }
260:
1.13 schwarze 261: /*
262: * Rewind until the current point. Warn if we're a roff
263: * instruction that's mowing over explicit scopes.
264: */
265: assert(n);
1.6 schwarze 266:
1.38 schwarze 267: return(man_unscope(man, n, MANDOCERR_MAX));
1.6 schwarze 268: }
269:
1.1 kristaps 270:
1.12 schwarze 271: /*
272: * Close out a generic explicit macro.
273: */
1.7 schwarze 274: /* ARGSUSED */
275: int
276: blk_close(MACRO_PROT_ARGS)
277: {
1.12 schwarze 278: enum mant ntok;
1.7 schwarze 279: const struct man_node *nn;
280:
281: switch (tok) {
282: case (MAN_RE):
283: ntok = MAN_RS;
1.39 schwarze 284: break;
285: case (MAN_UE):
286: ntok = MAN_UR;
1.7 schwarze 287: break;
288: default:
289: abort();
290: /* NOTREACHED */
291: }
292:
1.38 schwarze 293: for (nn = man->last->parent; nn; nn = nn->parent)
1.36 schwarze 294: if (ntok == nn->tok && MAN_BLOCK == nn->type)
1.7 schwarze 295: break;
296:
1.40 schwarze 297: if (NULL == nn) {
298: man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
299: if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
300: return(0);
301: } else
1.38 schwarze 302: man_unscope(man, nn, MANDOCERR_MAX);
1.7 schwarze 303:
304: return(1);
305: }
306:
307:
1.20 schwarze 308: /* ARGSUSED */
1.12 schwarze 309: int
310: blk_exp(MACRO_PROT_ARGS)
311: {
1.36 schwarze 312: struct man_node *n;
1.29 schwarze 313: int la;
1.12 schwarze 314: char *p;
315:
1.36 schwarze 316: /* Close out prior implicit scopes. */
317:
1.38 schwarze 318: if ( ! rew_scope(MAN_BLOCK, man, tok))
1.36 schwarze 319: return(0);
1.12 schwarze 320:
1.38 schwarze 321: if ( ! man_block_alloc(man, line, ppos, tok))
1.12 schwarze 322: return(0);
1.38 schwarze 323: if ( ! man_head_alloc(man, line, ppos, tok))
1.12 schwarze 324: return(0);
325:
326: for (;;) {
327: la = *pos;
1.38 schwarze 328: if ( ! man_args(man, line, pos, buf, &p))
1.12 schwarze 329: break;
1.38 schwarze 330: if ( ! man_word_alloc(man, line, la, p))
1.12 schwarze 331: return(0);
332: }
333:
1.38 schwarze 334: assert(man);
1.12 schwarze 335: assert(tok != MAN_MAX);
336:
1.38 schwarze 337: for (n = man->last; n; n = n->parent) {
1.36 schwarze 338: if (n->tok != tok)
339: continue;
340: assert(MAN_HEAD == n->type);
1.38 schwarze 341: man_unscope(man, n, MANDOCERR_MAX);
1.36 schwarze 342: break;
343: }
344:
1.38 schwarze 345: return(man_body_alloc(man, line, ppos, tok));
1.12 schwarze 346: }
347:
348:
349:
1.6 schwarze 350: /*
351: * Parse an implicit-block macro. These contain a MAN_HEAD and a
352: * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other
353: * scopes, such as `SH' closing out an `SS', are defined in the rew
354: * routines.
355: */
1.20 schwarze 356: /* ARGSUSED */
1.6 schwarze 357: int
358: blk_imp(MACRO_PROT_ARGS)
359: {
1.29 schwarze 360: int la;
1.6 schwarze 361: char *p;
1.7 schwarze 362: struct man_node *n;
1.6 schwarze 363:
364: /* Close out prior scopes. */
1.1 kristaps 365:
1.38 schwarze 366: if ( ! rew_scope(MAN_BODY, man, tok))
1.1 kristaps 367: return(0);
1.38 schwarze 368: if ( ! rew_scope(MAN_BLOCK, man, tok))
1.1 kristaps 369: return(0);
370:
1.6 schwarze 371: /* Allocate new block & head scope. */
372:
1.38 schwarze 373: if ( ! man_block_alloc(man, line, ppos, tok))
1.6 schwarze 374: return(0);
1.38 schwarze 375: if ( ! man_head_alloc(man, line, ppos, tok))
1.6 schwarze 376: return(0);
1.1 kristaps 377:
1.38 schwarze 378: n = man->last;
1.7 schwarze 379:
1.6 schwarze 380: /* Add line arguments. */
1.1 kristaps 381:
1.6 schwarze 382: for (;;) {
383: la = *pos;
1.38 schwarze 384: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 385: break;
1.38 schwarze 386: if ( ! man_word_alloc(man, line, la, p))
1.1 kristaps 387: return(0);
388: }
389:
1.6 schwarze 390: /* Close out head and open body (unless MAN_SCOPE). */
391:
392: if (MAN_SCOPED & man_macros[tok].flags) {
1.7 schwarze 393: /* If we're forcing scope (`TP'), keep it open. */
394: if (MAN_FSCOPED & man_macros[tok].flags) {
1.38 schwarze 395: man->flags |= MAN_BLINE;
1.7 schwarze 396: return(1);
1.38 schwarze 397: } else if (n == man->last) {
398: man->flags |= MAN_BLINE;
1.7 schwarze 399: return(1);
400: }
401: }
402:
1.38 schwarze 403: if ( ! rew_scope(MAN_HEAD, man, tok))
1.1 kristaps 404: return(0);
1.38 schwarze 405: return(man_body_alloc(man, line, ppos, tok));
1.1 kristaps 406: }
407:
408:
1.20 schwarze 409: /* ARGSUSED */
1.6 schwarze 410: int
411: in_line_eoln(MACRO_PROT_ARGS)
1.1 kristaps 412: {
1.29 schwarze 413: int la;
1.6 schwarze 414: char *p;
415: struct man_node *n;
1.1 kristaps 416:
1.38 schwarze 417: if ( ! man_elem_alloc(man, line, ppos, tok))
1.1 kristaps 418: return(0);
419:
1.38 schwarze 420: n = man->last;
1.1 kristaps 421:
1.6 schwarze 422: for (;;) {
423: la = *pos;
1.38 schwarze 424: if ( ! man_args(man, line, pos, buf, &p))
1.6 schwarze 425: break;
1.38 schwarze 426: if ( ! man_word_alloc(man, line, la, p))
1.6 schwarze 427: return(0);
428: }
1.41 ! schwarze 429:
! 430: /*
! 431: * Append MAN_EOS in case the last snipped argument
! 432: * ends with a dot, e.g. `.IR syslog (3).'
! 433: */
! 434:
! 435: if (n != man->last &&
! 436: mandoc_eos(man->last->string, strlen(man->last->string), 0))
! 437: man->last->flags |= MAN_EOS;
1.1 kristaps 438:
1.11 schwarze 439: /*
440: * If no arguments are specified and this is MAN_SCOPED (i.e.,
441: * next-line scoped), then set our mode to indicate that we're
442: * waiting for terms to load into our context.
443: */
444:
1.38 schwarze 445: if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
1.11 schwarze 446: assert( ! (MAN_NSCOPED & man_macros[tok].flags));
1.38 schwarze 447: man->flags |= MAN_ELINE;
1.6 schwarze 448: return(1);
449: }
1.1 kristaps 450:
1.11 schwarze 451: /* Set ignorable context, if applicable. */
452:
453: if (MAN_NSCOPED & man_macros[tok].flags) {
454: assert( ! (MAN_SCOPED & man_macros[tok].flags));
1.38 schwarze 455: man->flags |= MAN_ILINE;
1.11 schwarze 456: }
1.31 schwarze 457:
1.38 schwarze 458: assert(MAN_ROOT != man->last->type);
459: man->next = MAN_NEXT_SIBLING;
1.11 schwarze 460:
1.6 schwarze 461: /*
1.11 schwarze 462: * Rewind our element scope. Note that when TH is pruned, we'll
463: * be back at the root, so make sure that we don't clobber as
464: * its sibling.
1.6 schwarze 465: */
1.1 kristaps 466:
1.38 schwarze 467: for ( ; man->last; man->last = man->last->parent) {
468: if (man->last == n)
1.6 schwarze 469: break;
1.38 schwarze 470: if (man->last->type == MAN_ROOT)
1.6 schwarze 471: break;
1.38 schwarze 472: if ( ! man_valid_post(man))
1.6 schwarze 473: return(0);
474: }
1.1 kristaps 475:
1.38 schwarze 476: assert(man->last);
1.1 kristaps 477:
478: /*
1.6 schwarze 479: * Same here regarding whether we're back at the root.
1.1 kristaps 480: */
481:
1.38 schwarze 482: if (man->last->type != MAN_ROOT && ! man_valid_post(man))
1.6 schwarze 483: return(0);
1.1 kristaps 484:
1.6 schwarze 485: return(1);
486: }
1.1 kristaps 487:
488:
1.6 schwarze 489: int
1.38 schwarze 490: man_macroend(struct man *man)
1.6 schwarze 491: {
1.1 kristaps 492:
1.38 schwarze 493: return(man_unscope(man, man->first, MANDOCERR_SCOPEEXIT));
1.6 schwarze 494: }
1.1 kristaps 495:
1.29 schwarze 496: static int
1.38 schwarze 497: man_args(struct man *man, int line, int *pos, char *buf, char **v)
1.29 schwarze 498: {
499: char *start;
500:
501: assert(*pos);
502: *v = start = buf + *pos;
503: assert(' ' != *start);
504:
505: if ('\0' == *start)
506: return(0);
507:
1.38 schwarze 508: *v = mandoc_getarg(man->parse, v, line, pos);
1.29 schwarze 509: return(1);
510: }
![[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