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