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