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