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