Annotation of mandoc/mdoc.c, Revision 1.206
1.206 ! schwarze 1: /* $Id: mdoc.c,v 1.205 2013/10/21 23:47:58 schwarze Exp $ */
1.1 kristaps 2: /*
1.182 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.205 schwarze 4: * Copyright (c) 2010, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.75 kristaps 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.75 kristaps 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: */
1.114 kristaps 18: #ifdef HAVE_CONFIG_H
19: #include "config.h"
20: #endif
21:
1.106 kristaps 22: #include <sys/types.h>
23:
1.1 kristaps 24: #include <assert.h>
25: #include <stdarg.h>
1.73 kristaps 26: #include <stdio.h>
1.1 kristaps 27: #include <stdlib.h>
28: #include <string.h>
1.120 kristaps 29: #include <time.h>
1.1 kristaps 30:
1.187 kristaps 31: #include "mdoc.h"
1.136 kristaps 32: #include "mandoc.h"
1.70 kristaps 33: #include "libmdoc.h"
1.113 kristaps 34: #include "libmandoc.h"
1.1 kristaps 35:
36: const char *const __mdoc_macronames[MDOC_MAX] = {
1.82 kristaps 37: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 38: "Sh", "Ss", "Pp", "D1",
39: "Dl", "Bd", "Ed", "Bl",
40: "El", "It", "Ad", "An",
41: "Ar", "Cd", "Cm", "Dv",
42: "Er", "Ev", "Ex", "Fa",
43: "Fd", "Fl", "Fn", "Ft",
44: "Ic", "In", "Li", "Nd",
45: "Nm", "Op", "Ot", "Pa",
46: "Rv", "St", "Va", "Vt",
47: /* LINTED */
1.114 kristaps 48: "Xr", "%A", "%B", "%D",
1.1 kristaps 49: /* LINTED */
1.114 kristaps 50: "%I", "%J", "%N", "%O",
1.1 kristaps 51: /* LINTED */
1.114 kristaps 52: "%P", "%R", "%T", "%V",
1.1 kristaps 53: "Ac", "Ao", "Aq", "At",
54: "Bc", "Bf", "Bo", "Bq",
55: "Bsx", "Bx", "Db", "Dc",
56: "Do", "Dq", "Ec", "Ef",
57: "Em", "Eo", "Fx", "Ms",
58: "No", "Ns", "Nx", "Ox",
59: "Pc", "Pf", "Po", "Pq",
60: "Qc", "Ql", "Qo", "Qq",
61: "Re", "Rs", "Sc", "So",
62: "Sq", "Sm", "Sx", "Sy",
63: "Tn", "Ux", "Xc", "Xo",
64: "Fo", "Fc", "Oo", "Oc",
65: "Bk", "Ek", "Bt", "Hf",
1.82 kristaps 66: "Fr", "Ud", "Lb", "Lp",
67: "Lk", "Mt", "Brq", "Bro",
1.64 kristaps 68: /* LINTED */
1.114 kristaps 69: "Brc", "%C", "Es", "En",
1.69 kristaps 70: /* LINTED */
1.114 kristaps 71: "Dx", "%Q", "br", "sp",
1.110 kristaps 72: /* LINTED */
1.141 kristaps 73: "%U", "Ta"
1.1 kristaps 74: };
75:
76: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
77: "split", "nosplit", "ragged",
78: "unfilled", "literal", "file",
79: "offset", "bullet", "dash",
80: "hyphen", "item", "enum",
81: "tag", "diag", "hang",
82: "ohang", "inset", "column",
83: "width", "compact", "std",
1.52 kristaps 84: "filled", "words", "emphasis",
1.108 kristaps 85: "symbolic", "nested", "centered"
1.1 kristaps 86: };
87:
88: const char * const *mdoc_macronames = __mdoc_macronames;
89: const char * const *mdoc_argnames = __mdoc_argnames;
90:
1.121 kristaps 91: static void mdoc_node_free(struct mdoc_node *);
92: static void mdoc_node_unlink(struct mdoc *,
93: struct mdoc_node *);
1.73 kristaps 94: static void mdoc_free1(struct mdoc *);
1.113 kristaps 95: static void mdoc_alloc1(struct mdoc *);
1.73 kristaps 96: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
1.117 kristaps 97: enum mdoct, enum mdoc_type);
1.73 kristaps 98: static int node_append(struct mdoc *,
1.71 kristaps 99: struct mdoc_node *);
1.193 kristaps 100: #if 0
1.191 kristaps 101: static int mdoc_preptext(struct mdoc *, int, char *, int);
1.193 kristaps 102: #endif
1.149 kristaps 103: static int mdoc_ptext(struct mdoc *, int, char *, int);
104: static int mdoc_pmacro(struct mdoc *, int, char *, int);
1.88 kristaps 105:
1.1 kristaps 106: const struct mdoc_node *
1.203 schwarze 107: mdoc_node(const struct mdoc *mdoc)
1.1 kristaps 108: {
109:
1.203 schwarze 110: assert( ! (MDOC_HALT & mdoc->flags));
111: return(mdoc->first);
1.1 kristaps 112: }
113:
114:
1.37 kristaps 115: const struct mdoc_meta *
1.203 schwarze 116: mdoc_meta(const struct mdoc *mdoc)
1.37 kristaps 117: {
118:
1.203 schwarze 119: assert( ! (MDOC_HALT & mdoc->flags));
120: return(&mdoc->meta);
1.37 kristaps 121: }
122:
123:
1.85 kristaps 124: /*
125: * Frees volatile resources (parse tree, meta-data, fields).
126: */
1.73 kristaps 127: static void
128: mdoc_free1(struct mdoc *mdoc)
1.67 kristaps 129: {
130:
131: if (mdoc->first)
1.121 kristaps 132: mdoc_node_delete(mdoc, mdoc->first);
1.67 kristaps 133: if (mdoc->meta.title)
134: free(mdoc->meta.title);
135: if (mdoc->meta.os)
136: free(mdoc->meta.os);
137: if (mdoc->meta.name)
138: free(mdoc->meta.name);
139: if (mdoc->meta.arch)
140: free(mdoc->meta.arch);
141: if (mdoc->meta.vol)
142: free(mdoc->meta.vol);
1.133 kristaps 143: if (mdoc->meta.msec)
144: free(mdoc->meta.msec);
1.183 kristaps 145: if (mdoc->meta.date)
146: free(mdoc->meta.date);
1.73 kristaps 147: }
148:
149:
1.85 kristaps 150: /*
151: * Allocate all volatile resources (parse tree, meta-data, fields).
152: */
1.113 kristaps 153: static void
1.73 kristaps 154: mdoc_alloc1(struct mdoc *mdoc)
155: {
1.67 kristaps 156:
1.112 kristaps 157: memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.67 kristaps 158: mdoc->flags = 0;
1.85 kristaps 159: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.113 kristaps 160: mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.70 kristaps 161: mdoc->first = mdoc->last;
1.67 kristaps 162: mdoc->last->type = MDOC_ROOT;
1.196 schwarze 163: mdoc->last->tok = MDOC_MAX;
1.67 kristaps 164: mdoc->next = MDOC_NEXT_CHILD;
1.73 kristaps 165: }
166:
167:
168: /*
1.85 kristaps 169: * Free up volatile resources (see mdoc_free1()) then re-initialises the
170: * data with mdoc_alloc1(). After invocation, parse data has been reset
171: * and the parser is ready for re-invocation on a new tree; however,
172: * cross-parse non-volatile data is kept intact.
1.73 kristaps 173: */
1.113 kristaps 174: void
1.73 kristaps 175: mdoc_reset(struct mdoc *mdoc)
176: {
177:
178: mdoc_free1(mdoc);
1.113 kristaps 179: mdoc_alloc1(mdoc);
1.67 kristaps 180: }
181:
182:
1.68 kristaps 183: /*
1.85 kristaps 184: * Completely free up all volatile and non-volatile parse resources.
185: * After invocation, the pointer is no longer usable.
1.68 kristaps 186: */
1.67 kristaps 187: void
1.38 kristaps 188: mdoc_free(struct mdoc *mdoc)
1.34 kristaps 189: {
190:
1.73 kristaps 191: mdoc_free1(mdoc);
1.1 kristaps 192: free(mdoc);
193: }
194:
195:
1.85 kristaps 196: /*
197: * Allocate volatile and non-volatile parse resources.
198: */
1.1 kristaps 199: struct mdoc *
1.197 schwarze 200: mdoc_alloc(struct roff *roff, struct mparse *parse, char *defos)
1.1 kristaps 201: {
202: struct mdoc *p;
203:
1.113 kristaps 204: p = mandoc_calloc(1, sizeof(struct mdoc));
205:
1.185 kristaps 206: p->parse = parse;
1.197 schwarze 207: p->defos = defos;
1.189 kristaps 208: p->roff = roff;
1.73 kristaps 209:
1.113 kristaps 210: mdoc_hash_init();
211: mdoc_alloc1(p);
212: return(p);
1.1 kristaps 213: }
214:
215:
1.68 kristaps 216: /*
217: * Climb back up the parse tree, validating open scopes. Mostly calls
1.85 kristaps 218: * through to macro_end() in macro.c.
1.68 kristaps 219: */
1.1 kristaps 220: int
1.203 schwarze 221: mdoc_endparse(struct mdoc *mdoc)
1.20 kristaps 222: {
223:
1.203 schwarze 224: assert( ! (MDOC_HALT & mdoc->flags));
225: if (mdoc_macroend(mdoc))
1.20 kristaps 226: return(1);
1.203 schwarze 227: mdoc->flags |= MDOC_HALT;
1.72 kristaps 228: return(0);
1.181 kristaps 229: }
230:
231: int
1.203 schwarze 232: mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
1.181 kristaps 233: {
234: struct mdoc_node *n;
235:
1.203 schwarze 236: assert( ! (MDOC_HALT & mdoc->flags));
1.181 kristaps 237:
238: /* No text before an initial macro. */
239:
1.203 schwarze 240: if (SEC_NONE == mdoc->lastnamed) {
241: mdoc_pmsg(mdoc, ep->ln, ep->pos, MANDOCERR_NOTEXT);
1.181 kristaps 242: return(1);
243: }
244:
1.203 schwarze 245: n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
1.181 kristaps 246: n->eqn = ep;
247:
1.203 schwarze 248: if ( ! node_append(mdoc, n))
1.181 kristaps 249: return(0);
250:
1.203 schwarze 251: mdoc->next = MDOC_NEXT_SIBLING;
1.181 kristaps 252: return(1);
1.20 kristaps 253: }
254:
1.175 kristaps 255: int
1.203 schwarze 256: mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
1.175 kristaps 257: {
1.180 kristaps 258: struct mdoc_node *n;
1.175 kristaps 259:
1.203 schwarze 260: assert( ! (MDOC_HALT & mdoc->flags));
1.175 kristaps 261:
262: /* No text before an initial macro. */
263:
1.203 schwarze 264: if (SEC_NONE == mdoc->lastnamed) {
265: mdoc_pmsg(mdoc, sp->line, 0, MANDOCERR_NOTEXT);
1.175 kristaps 266: return(1);
267: }
268:
1.203 schwarze 269: n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
1.180 kristaps 270: n->span = sp;
271:
1.203 schwarze 272: if ( ! node_append(mdoc, n))
1.180 kristaps 273: return(0);
274:
1.203 schwarze 275: mdoc->next = MDOC_NEXT_SIBLING;
1.180 kristaps 276: return(1);
1.175 kristaps 277: }
278:
1.20 kristaps 279:
1.50 kristaps 280: /*
1.53 kristaps 281: * Main parse routine. Parses a single line -- really just hands off to
1.123 kristaps 282: * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.50 kristaps 283: */
1.20 kristaps 284: int
1.203 schwarze 285: mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 286: {
287:
1.203 schwarze 288: assert( ! (MDOC_HALT & mdoc->flags));
1.50 kristaps 289:
1.203 schwarze 290: mdoc->flags |= MDOC_NEWLINE;
1.153 schwarze 291:
292: /*
293: * Let the roff nS register switch SYNOPSIS mode early,
294: * such that the parser knows at all times
295: * whether this mode is on or off.
296: * Note that this mode is also switched by the Sh macro.
297: */
1.204 schwarze 298: if (roff_getreg(mdoc->roff, "nS"))
299: mdoc->flags |= MDOC_SYNOPSIS;
300: else
301: mdoc->flags &= ~MDOC_SYNOPSIS;
1.153 schwarze 302:
1.203 schwarze 303: return(roff_getcontrol(mdoc->roff, buf, &offs) ?
304: mdoc_pmacro(mdoc, ln, buf, offs) :
305: mdoc_ptext(mdoc, ln, buf, offs));
1.1 kristaps 306: }
307:
1.88 kristaps 308: int
1.148 kristaps 309: mdoc_macro(MACRO_PROT_ARGS)
1.88 kristaps 310: {
1.122 kristaps 311: assert(tok < MDOC_MAX);
312:
313: /* If we're in the body, deny prologue calls. */
1.117 kristaps 314:
1.88 kristaps 315: if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.203 schwarze 316: MDOC_PBODY & mdoc->flags) {
317: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADBODY);
1.174 kristaps 318: return(1);
319: }
1.122 kristaps 320:
321: /* If we're in the prologue, deny "body" macros. */
322:
323: if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
1.203 schwarze 324: ! (MDOC_PBODY & mdoc->flags)) {
325: mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADPROLOG);
326: if (NULL == mdoc->meta.msec)
327: mdoc->meta.msec = mandoc_strdup("1");
328: if (NULL == mdoc->meta.title)
329: mdoc->meta.title = mandoc_strdup("UNKNOWN");
330: if (NULL == mdoc->meta.vol)
331: mdoc->meta.vol = mandoc_strdup("LOCAL");
332: if (NULL == mdoc->meta.os)
333: mdoc->meta.os = mandoc_strdup("LOCAL");
334: if (NULL == mdoc->meta.date)
335: mdoc->meta.date = mandoc_normdate
336: (mdoc->parse, NULL, line, ppos);
337: mdoc->flags |= MDOC_PBODY;
1.120 kristaps 338: }
1.88 kristaps 339:
1.203 schwarze 340: return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf));
1.73 kristaps 341: }
342:
343:
344: static int
345: node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 346: {
347:
1.25 kristaps 348: assert(mdoc->last);
349: assert(mdoc->first);
350: assert(MDOC_ROOT != p->type);
1.1 kristaps 351:
1.13 kristaps 352: switch (mdoc->next) {
353: case (MDOC_NEXT_SIBLING):
1.6 kristaps 354: mdoc->last->next = p;
355: p->prev = mdoc->last;
1.13 kristaps 356: p->parent = mdoc->last->parent;
1.1 kristaps 357: break;
1.13 kristaps 358: case (MDOC_NEXT_CHILD):
359: mdoc->last->child = p;
1.1 kristaps 360: p->parent = mdoc->last;
361: break;
362: default:
1.13 kristaps 363: abort();
364: /* NOTREACHED */
1.1 kristaps 365: }
366:
1.86 kristaps 367: p->parent->nchild++;
368:
1.172 kristaps 369: /*
370: * Copy over the normalised-data pointer of our parent. Not
371: * everybody has one, but copying a null pointer is fine.
372: */
373:
374: switch (p->type) {
375: case (MDOC_BODY):
1.202 schwarze 376: if (ENDBODY_NOT != p->end)
377: break;
1.172 kristaps 378: /* FALLTHROUGH */
379: case (MDOC_TAIL):
380: /* FALLTHROUGH */
381: case (MDOC_HEAD):
382: p->norm = p->parent->norm;
383: break;
384: default:
385: break;
386: }
387:
1.23 kristaps 388: if ( ! mdoc_valid_pre(mdoc, p))
389: return(0);
1.27 kristaps 390:
391: switch (p->type) {
392: case (MDOC_HEAD):
393: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 394: p->parent->head = p;
1.27 kristaps 395: break;
396: case (MDOC_TAIL):
397: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 398: p->parent->tail = p;
1.27 kristaps 399: break;
400: case (MDOC_BODY):
1.152 schwarze 401: if (p->end)
402: break;
1.27 kristaps 403: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 404: p->parent->body = p;
1.27 kristaps 405: break;
406: default:
407: break;
408: }
409:
1.1 kristaps 410: mdoc->last = p;
1.71 kristaps 411:
412: switch (p->type) {
1.176 kristaps 413: case (MDOC_TBL):
414: /* FALLTHROUGH */
1.71 kristaps 415: case (MDOC_TEXT):
416: if ( ! mdoc_valid_post(mdoc))
417: return(0);
418: break;
419: default:
420: break;
421: }
422:
1.23 kristaps 423: return(1);
1.1 kristaps 424: }
425:
426:
1.45 kristaps 427: static struct mdoc_node *
1.203 schwarze 428: node_alloc(struct mdoc *mdoc, int line, int pos,
1.117 kristaps 429: enum mdoct tok, enum mdoc_type type)
1.45 kristaps 430: {
1.46 kristaps 431: struct mdoc_node *p;
432:
1.113 kristaps 433: p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.203 schwarze 434: p->sec = mdoc->lastsec;
1.73 kristaps 435: p->line = line;
436: p->pos = pos;
1.206 ! schwarze 437: p->lastline = line;
1.73 kristaps 438: p->tok = tok;
1.118 kristaps 439: p->type = type;
1.150 kristaps 440:
441: /* Flag analysis. */
442:
1.203 schwarze 443: if (MDOC_SYNOPSIS & mdoc->flags)
1.153 schwarze 444: p->flags |= MDOC_SYNPRETTY;
445: else
446: p->flags &= ~MDOC_SYNPRETTY;
1.203 schwarze 447: if (MDOC_NEWLINE & mdoc->flags)
1.130 kristaps 448: p->flags |= MDOC_LINE;
1.203 schwarze 449: mdoc->flags &= ~MDOC_NEWLINE;
1.150 kristaps 450:
1.46 kristaps 451: return(p);
1.45 kristaps 452: }
453:
454:
1.23 kristaps 455: int
1.203 schwarze 456: mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.17 kristaps 457: {
458: struct mdoc_node *p;
459:
1.203 schwarze 460: p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
461: if ( ! node_append(mdoc, p))
1.102 kristaps 462: return(0);
1.203 schwarze 463: mdoc->next = MDOC_NEXT_CHILD;
1.102 kristaps 464: return(1);
1.17 kristaps 465: }
466:
467:
1.23 kristaps 468: int
1.203 schwarze 469: mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 470: {
471: struct mdoc_node *p;
472:
1.203 schwarze 473: assert(mdoc->first);
474: assert(mdoc->last);
1.1 kristaps 475:
1.203 schwarze 476: p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
477: if ( ! node_append(mdoc, p))
1.102 kristaps 478: return(0);
1.203 schwarze 479: mdoc->next = MDOC_NEXT_CHILD;
1.102 kristaps 480: return(1);
1.1 kristaps 481: }
482:
483:
1.23 kristaps 484: int
1.203 schwarze 485: mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 486: {
487: struct mdoc_node *p;
488:
1.203 schwarze 489: p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
490: if ( ! node_append(mdoc, p))
1.102 kristaps 491: return(0);
1.203 schwarze 492: mdoc->next = MDOC_NEXT_CHILD;
1.152 schwarze 493: return(1);
494: }
495:
496:
497: int
1.203 schwarze 498: mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok,
1.152 schwarze 499: struct mdoc_node *body, enum mdoc_endbody end)
500: {
501: struct mdoc_node *p;
502:
1.203 schwarze 503: p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
1.152 schwarze 504: p->pending = body;
1.202 schwarze 505: p->norm = body->norm;
1.152 schwarze 506: p->end = end;
1.203 schwarze 507: if ( ! node_append(mdoc, p))
1.152 schwarze 508: return(0);
1.203 schwarze 509: mdoc->next = MDOC_NEXT_SIBLING;
1.102 kristaps 510: return(1);
1.1 kristaps 511: }
512:
513:
1.23 kristaps 514: int
1.203 schwarze 515: mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
1.117 kristaps 516: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 517: {
518: struct mdoc_node *p;
519:
1.203 schwarze 520: p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
1.77 kristaps 521: p->args = args;
522: if (p->args)
1.53 kristaps 523: (args->refcnt)++;
1.172 kristaps 524:
525: switch (tok) {
526: case (MDOC_Bd):
527: /* FALLTHROUGH */
528: case (MDOC_Bf):
529: /* FALLTHROUGH */
530: case (MDOC_Bl):
1.173 kristaps 531: /* FALLTHROUGH */
532: case (MDOC_Rs):
1.172 kristaps 533: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
534: break;
535: default:
536: break;
537: }
538:
1.203 schwarze 539: if ( ! node_append(mdoc, p))
1.102 kristaps 540: return(0);
1.203 schwarze 541: mdoc->next = MDOC_NEXT_CHILD;
1.102 kristaps 542: return(1);
1.1 kristaps 543: }
544:
545:
1.23 kristaps 546: int
1.203 schwarze 547: mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
1.117 kristaps 548: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 549: {
550: struct mdoc_node *p;
551:
1.203 schwarze 552: p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
1.77 kristaps 553: p->args = args;
554: if (p->args)
1.53 kristaps 555: (args->refcnt)++;
1.172 kristaps 556:
557: switch (tok) {
558: case (MDOC_An):
559: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
560: break;
561: default:
562: break;
563: }
564:
1.203 schwarze 565: if ( ! node_append(mdoc, p))
1.102 kristaps 566: return(0);
1.203 schwarze 567: mdoc->next = MDOC_NEXT_CHILD;
1.175 kristaps 568: return(1);
569: }
1.1 kristaps 570:
1.124 kristaps 571: int
1.203 schwarze 572: mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
1.1 kristaps 573: {
1.91 kristaps 574: struct mdoc_node *n;
1.1 kristaps 575:
1.203 schwarze 576: n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
577: n->string = roff_strdup(mdoc->roff, p);
1.91 kristaps 578:
1.203 schwarze 579: if ( ! node_append(mdoc, n))
1.101 kristaps 580: return(0);
1.124 kristaps 581:
1.203 schwarze 582: mdoc->next = MDOC_NEXT_SIBLING;
1.101 kristaps 583: return(1);
1.91 kristaps 584: }
585:
1.205 schwarze 586: void
587: mdoc_word_append(struct mdoc *mdoc, const char *p)
588: {
589: struct mdoc_node *n;
590: char *addstr, *newstr;
591:
592: n = mdoc->last;
593: addstr = roff_strdup(mdoc->roff, p);
594: if (-1 == asprintf(&newstr, "%s %s", n->string, addstr)) {
595: perror(NULL);
596: exit((int)MANDOCLEVEL_SYSERR);
597: }
598: free(addstr);
599: free(n->string);
600: n->string = newstr;
601: mdoc->next = MDOC_NEXT_SIBLING;
602: }
1.91 kristaps 603:
1.155 kristaps 604: static void
1.53 kristaps 605: mdoc_node_free(struct mdoc_node *p)
1.1 kristaps 606: {
607:
1.172 kristaps 608: if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
1.171 kristaps 609: free(p->norm);
1.53 kristaps 610: if (p->string)
611: free(p->string);
612: if (p->args)
613: mdoc_argv_free(p->args);
1.1 kristaps 614: free(p);
615: }
616:
617:
1.121 kristaps 618: static void
1.203 schwarze 619: mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
1.121 kristaps 620: {
621:
622: /* Adjust siblings. */
623:
624: if (n->prev)
625: n->prev->next = n->next;
626: if (n->next)
627: n->next->prev = n->prev;
628:
629: /* Adjust parent. */
630:
631: if (n->parent) {
632: n->parent->nchild--;
633: if (n->parent->child == n)
634: n->parent->child = n->prev ? n->prev : n->next;
1.169 kristaps 635: if (n->parent->last == n)
636: n->parent->last = n->prev ? n->prev : NULL;
1.121 kristaps 637: }
638:
639: /* Adjust parse point, if applicable. */
640:
1.203 schwarze 641: if (mdoc && mdoc->last == n) {
1.121 kristaps 642: if (n->prev) {
1.203 schwarze 643: mdoc->last = n->prev;
644: mdoc->next = MDOC_NEXT_SIBLING;
1.121 kristaps 645: } else {
1.203 schwarze 646: mdoc->last = n->parent;
647: mdoc->next = MDOC_NEXT_CHILD;
1.121 kristaps 648: }
649: }
650:
1.203 schwarze 651: if (mdoc && mdoc->first == n)
652: mdoc->first = NULL;
1.121 kristaps 653: }
654:
655:
1.53 kristaps 656: void
1.203 schwarze 657: mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 658: {
659:
1.121 kristaps 660: while (p->child) {
661: assert(p->nchild);
1.203 schwarze 662: mdoc_node_delete(mdoc, p->child);
1.121 kristaps 663: }
664: assert(0 == p->nchild);
1.1 kristaps 665:
1.203 schwarze 666: mdoc_node_unlink(mdoc, p);
1.53 kristaps 667: mdoc_node_free(p);
1.201 schwarze 668: }
669:
670: int
1.203 schwarze 671: mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
1.201 schwarze 672: {
673:
1.203 schwarze 674: mdoc_node_unlink(mdoc, p);
675: return(node_append(mdoc, p));
1.1 kristaps 676: }
677:
1.193 kristaps 678: #if 0
1.191 kristaps 679: /*
680: * Pre-treat a text line.
681: * Text lines can consist of equations, which must be handled apart from
682: * the regular text.
683: * Thus, use this function to step through a line checking if it has any
684: * equations embedded in it.
685: * This must handle multiple equations AND equations that do not end at
686: * the end-of-line, i.e., will re-enter in the next roff parse.
687: */
688: static int
1.203 schwarze 689: mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.191 kristaps 690: {
691: char *start, *end;
692: char delim;
693:
694: while ('\0' != buf[offs]) {
695: /* Mark starting position if eqn is set. */
696: start = NULL;
1.203 schwarze 697: if ('\0' != (delim = roff_eqndelim(mdoc->roff)))
1.191 kristaps 698: if (NULL != (start = strchr(buf + offs, delim)))
699: *start++ = '\0';
700:
701: /* Parse text as normal. */
1.203 schwarze 702: if ( ! mdoc_ptext(mdoc, line, buf, offs))
1.191 kristaps 703: return(0);
704:
705: /* Continue only if an equation exists. */
706: if (NULL == start)
707: break;
708:
709: /* Read past the end of the equation. */
710: offs += start - (buf + offs);
711: assert(start == &buf[offs]);
712: if (NULL != (end = strchr(buf + offs, delim))) {
713: *end++ = '\0';
714: while (' ' == *end)
715: end++;
716: }
717:
718: /* Parse the equation itself. */
1.203 schwarze 719: roff_openeqn(mdoc->roff, NULL, line, offs, buf);
1.191 kristaps 720:
721: /* Process a finished equation? */
1.203 schwarze 722: if (roff_closeeqn(mdoc->roff))
723: if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff)))
1.191 kristaps 724: return(0);
725: offs += (end - (buf + offs));
726: }
727:
728: return(1);
729: }
1.193 kristaps 730: #endif
1.1 kristaps 731:
1.53 kristaps 732: /*
733: * Parse free-form text, that is, a line that does not begin with the
734: * control character.
735: */
736: static int
1.203 schwarze 737: mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.1 kristaps 738: {
1.142 kristaps 739: char *c, *ws, *end;
740: struct mdoc_node *n;
1.1 kristaps 741:
1.124 kristaps 742: /* No text before an initial macro. */
743:
1.203 schwarze 744: if (SEC_NONE == mdoc->lastnamed) {
745: mdoc_pmsg(mdoc, line, offs, MANDOCERR_NOTEXT);
1.174 kristaps 746: return(1);
747: }
1.142 kristaps 748:
1.203 schwarze 749: assert(mdoc->last);
750: n = mdoc->last;
1.142 kristaps 751:
752: /*
1.144 kristaps 753: * Divert directly to list processing if we're encountering a
1.142 kristaps 754: * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
1.144 kristaps 755: * (a MDOC_BODY means it's already open, in which case we should
756: * process within its context in the normal way).
1.142 kristaps 757: */
758:
1.143 kristaps 759: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.172 kristaps 760: LIST_column == n->norm->Bl.type) {
1.144 kristaps 761: /* `Bl' is open without any children. */
1.203 schwarze 762: mdoc->flags |= MDOC_FREECOL;
763: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.142 kristaps 764: }
765:
766: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
767: NULL != n->parent &&
768: MDOC_Bl == n->parent->tok &&
1.172 kristaps 769: LIST_column == n->parent->norm->Bl.type) {
1.144 kristaps 770: /* `Bl' has block-level `It' children. */
1.203 schwarze 771: mdoc->flags |= MDOC_FREECOL;
772: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.142 kristaps 773: }
1.124 kristaps 774:
1.137 schwarze 775: /*
776: * Search for the beginning of unescaped trailing whitespace (ws)
777: * and for the first character not to be output (end).
778: */
1.139 kristaps 779:
780: /* FIXME: replace with strcspn(). */
1.137 schwarze 781: ws = NULL;
782: for (c = end = buf + offs; *c; c++) {
783: switch (*c) {
784: case ' ':
785: if (NULL == ws)
786: ws = c;
787: continue;
788: case '\t':
789: /*
790: * Always warn about trailing tabs,
791: * even outside literal context,
792: * where they should be put on the next line.
793: */
794: if (NULL == ws)
795: ws = c;
796: /*
797: * Strip trailing tabs in literal context only;
798: * outside, they affect the next line.
799: */
1.203 schwarze 800: if (MDOC_LITERAL & mdoc->flags)
1.137 schwarze 801: continue;
802: break;
803: case '\\':
804: /* Skip the escaped character, too, if any. */
805: if (c[1])
806: c++;
807: /* FALLTHROUGH */
808: default:
809: ws = NULL;
810: break;
811: }
812: end = c + 1;
813: }
814: *end = '\0';
1.91 kristaps 815:
1.137 schwarze 816: if (ws)
1.203 schwarze 817: mdoc_pmsg(mdoc, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
1.115 kristaps 818:
1.203 schwarze 819: if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
820: mdoc_pmsg(mdoc, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
1.124 kristaps 821:
1.119 kristaps 822: /*
1.165 schwarze 823: * Insert a `sp' in the case of a blank line. Technically,
1.124 kristaps 824: * blank lines aren't allowed, but enough manuals assume this
825: * behaviour that we want to work around it.
1.119 kristaps 826: */
1.203 schwarze 827: if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL))
1.119 kristaps 828: return(0);
1.124 kristaps 829:
1.203 schwarze 830: mdoc->next = MDOC_NEXT_SIBLING;
1.199 schwarze 831:
1.203 schwarze 832: return(mdoc_valid_post(mdoc));
1.119 kristaps 833: }
1.68 kristaps 834:
1.203 schwarze 835: if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
1.137 schwarze 836: return(0);
1.91 kristaps 837:
1.203 schwarze 838: if (MDOC_LITERAL & mdoc->flags)
1.137 schwarze 839: return(1);
1.128 kristaps 840:
841: /*
842: * End-of-sentence check. If the last character is an unescaped
843: * EOS character, then flag the node as being the end of a
844: * sentence. The front-end will know how to interpret this.
845: */
1.132 kristaps 846:
1.137 schwarze 847: assert(buf < end);
848:
1.159 schwarze 849: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
1.203 schwarze 850: mdoc->last->flags |= MDOC_EOS;
1.128 kristaps 851:
852: return(1);
1.1 kristaps 853: }
854:
855:
1.53 kristaps 856: /*
857: * Parse a macro line, that is, a line beginning with the control
858: * character.
859: */
1.155 kristaps 860: static int
1.203 schwarze 861: mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 862: {
1.144 kristaps 863: enum mdoct tok;
1.188 kristaps 864: int i, sv;
1.144 kristaps 865: char mac[5];
866: struct mdoc_node *n;
1.1 kristaps 867:
1.188 kristaps 868: /* Empty post-control lines are ignored. */
1.63 kristaps 869:
1.188 kristaps 870: if ('"' == buf[offs]) {
1.203 schwarze 871: mdoc_pmsg(mdoc, ln, offs, MANDOCERR_BADCOMMENT);
1.188 kristaps 872: return(1);
873: } else if ('\0' == buf[offs])
1.63 kristaps 874: return(1);
875:
1.188 kristaps 876: sv = offs;
1.130 kristaps 877:
1.160 kristaps 878: /*
1.162 schwarze 879: * Copy the first word into a nil-terminated buffer.
1.165 schwarze 880: * Stop copying when a tab, space, or eoln is encountered.
1.160 kristaps 881: */
1.1 kristaps 882:
1.188 kristaps 883: i = 0;
884: while (i < 4 && '\0' != buf[offs] &&
885: ' ' != buf[offs] && '\t' != buf[offs])
886: mac[i++] = buf[offs++];
887:
888: mac[i] = '\0';
889:
890: tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
1.1 kristaps 891:
1.163 schwarze 892: if (MDOC_MAX == tok) {
1.203 schwarze 893: mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse,
1.185 kristaps 894: ln, sv, "%s", buf + sv - 1);
1.58 kristaps 895: return(1);
1.53 kristaps 896: }
1.1 kristaps 897:
1.160 kristaps 898: /* Disregard the first trailing tab, if applicable. */
899:
1.188 kristaps 900: if ('\t' == buf[offs])
901: offs++;
1.160 kristaps 902:
903: /* Jump to the next non-whitespace word. */
1.1 kristaps 904:
1.188 kristaps 905: while (buf[offs] && ' ' == buf[offs])
906: offs++;
1.1 kristaps 907:
1.125 kristaps 908: /*
909: * Trailing whitespace. Note that tabs are allowed to be passed
910: * into the parser as "text", so we only warn about spaces here.
911: */
1.115 kristaps 912:
1.188 kristaps 913: if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.203 schwarze 914: mdoc_pmsg(mdoc, ln, offs - 1, MANDOCERR_EOLNSPACE);
1.115 kristaps 915:
1.144 kristaps 916: /*
917: * If an initial macro or a list invocation, divert directly
918: * into macro processing.
919: */
920:
1.203 schwarze 921: if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
922: if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
1.144 kristaps 923: goto err;
924: return(1);
925: }
926:
1.203 schwarze 927: n = mdoc->last;
928: assert(mdoc->last);
1.144 kristaps 929:
930: /*
931: * If the first macro of a `Bl -column', open an `It' block
932: * context around the parsed macro.
933: */
934:
935: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.172 kristaps 936: LIST_column == n->norm->Bl.type) {
1.203 schwarze 937: mdoc->flags |= MDOC_FREECOL;
938: if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
1.144 kristaps 939: goto err;
940: return(1);
941: }
942:
943: /*
944: * If we're following a block-level `It' within a `Bl -column'
945: * context (perhaps opened in the above block or in ptext()),
946: * then open an `It' block context around the parsed macro.
1.98 kristaps 947: */
1.144 kristaps 948:
949: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
950: NULL != n->parent &&
951: MDOC_Bl == n->parent->tok &&
1.172 kristaps 952: LIST_column == n->parent->norm->Bl.type) {
1.203 schwarze 953: mdoc->flags |= MDOC_FREECOL;
954: if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
1.144 kristaps 955: goto err;
956: return(1);
957: }
958:
959: /* Normal processing of a macro. */
960:
1.203 schwarze 961: if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
1.53 kristaps 962: goto err;
1.1 kristaps 963:
1.53 kristaps 964: return(1);
1.1 kristaps 965:
1.53 kristaps 966: err: /* Error out. */
1.1 kristaps 967:
1.203 schwarze 968: mdoc->flags |= MDOC_HALT;
1.53 kristaps 969: return(0);
1.1 kristaps 970: }
1.100 kristaps 971:
1.186 kristaps 972: enum mdelim
973: mdoc_isdelim(const char *p)
974: {
975:
976: if ('\0' == p[0])
977: return(DELIM_NONE);
978:
979: if ('\0' == p[1])
980: switch (p[0]) {
981: case('('):
982: /* FALLTHROUGH */
983: case('['):
984: return(DELIM_OPEN);
985: case('|'):
986: return(DELIM_MIDDLE);
987: case('.'):
988: /* FALLTHROUGH */
989: case(','):
990: /* FALLTHROUGH */
991: case(';'):
992: /* FALLTHROUGH */
993: case(':'):
994: /* FALLTHROUGH */
995: case('?'):
996: /* FALLTHROUGH */
997: case('!'):
998: /* FALLTHROUGH */
999: case(')'):
1000: /* FALLTHROUGH */
1001: case(']'):
1002: return(DELIM_CLOSE);
1003: default:
1004: return(DELIM_NONE);
1005: }
1006:
1007: if ('\\' != p[0])
1008: return(DELIM_NONE);
1.100 kristaps 1009:
1.186 kristaps 1010: if (0 == strcmp(p + 1, "."))
1011: return(DELIM_CLOSE);
1.200 schwarze 1012: if (0 == strcmp(p + 1, "fR|\\fP"))
1.186 kristaps 1013: return(DELIM_MIDDLE);
1014:
1015: return(DELIM_NONE);
1016: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc