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