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