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