Annotation of mandoc/mdoc_action.c, Revision 1.69
1.69 ! kristaps 1: /* $Id: mdoc_action.c,v 1.68 2010/06/12 12:38:01 kristaps Exp $ */
1.1 kristaps 2: /*
1.9 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.8 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.8 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: */
1.50 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.44 kristaps 21: #ifndef OSNAME
1.1 kristaps 22: #include <sys/utsname.h>
1.44 kristaps 23: #endif
1.1 kristaps 24:
25: #include <assert.h>
26: #include <stdio.h>
27: #include <stdlib.h>
28: #include <string.h>
1.44 kristaps 29: #include <time.h>
1.1 kristaps 30:
1.59 kristaps 31: #include "mandoc.h"
1.1 kristaps 32: #include "libmdoc.h"
1.46 kristaps 33: #include "libmandoc.h"
1.1 kristaps 34:
1.35 kristaps 35: #define POST_ARGS struct mdoc *m, struct mdoc_node *n
1.60 kristaps 36: #define PRE_ARGS struct mdoc *m, struct mdoc_node *n
1.1 kristaps 37:
1.46 kristaps 38: #define NUMSIZ 32
39: #define DATESIZ 32
40:
1.1 kristaps 41: struct actions {
42: int (*pre)(PRE_ARGS);
43: int (*post)(POST_ARGS);
44: };
45:
1.46 kristaps 46: static int concat(struct mdoc *, char *,
47: const struct mdoc_node *, size_t);
1.54 kristaps 48: static inline int order_rs(enum mdoct);
1.39 kristaps 49:
1.1 kristaps 50: static int post_ar(POST_ARGS);
1.25 kristaps 51: static int post_at(POST_ARGS);
1.1 kristaps 52: static int post_bl(POST_ARGS);
1.14 kristaps 53: static int post_bl_head(POST_ARGS);
1.25 kristaps 54: static int post_bl_tagwidth(POST_ARGS);
1.69 ! kristaps 55: static int post_bl_width(struct mdoc *,
! 56: struct mdoc_node *, int);
1.1 kristaps 57: static int post_dd(POST_ARGS);
58: static int post_display(POST_ARGS);
59: static int post_dt(POST_ARGS);
1.27 kristaps 60: static int post_lb(POST_ARGS);
1.62 kristaps 61: static int post_li(POST_ARGS);
1.1 kristaps 62: static int post_nm(POST_ARGS);
63: static int post_os(POST_ARGS);
1.46 kristaps 64: static int post_pa(POST_ARGS);
1.1 kristaps 65: static int post_prol(POST_ARGS);
1.39 kristaps 66: static int post_rs(POST_ARGS);
1.1 kristaps 67: static int post_sh(POST_ARGS);
1.26 kristaps 68: static int post_st(POST_ARGS);
1.1 kristaps 69: static int post_std(POST_ARGS);
70:
71: static int pre_bd(PRE_ARGS);
72: static int pre_dl(PRE_ARGS);
73:
1.37 kristaps 74: static const struct actions mdoc_actions[MDOC_MAX] = {
1.12 kristaps 75: { NULL, NULL }, /* Ap */
1.1 kristaps 76: { NULL, post_dd }, /* Dd */
77: { NULL, post_dt }, /* Dt */
78: { NULL, post_os }, /* Os */
79: { NULL, post_sh }, /* Sh */
80: { NULL, NULL }, /* Ss */
81: { NULL, NULL }, /* Pp */
82: { NULL, NULL }, /* D1 */
83: { pre_dl, post_display }, /* Dl */
84: { pre_bd, post_display }, /* Bd */
85: { NULL, NULL }, /* Ed */
1.68 kristaps 86: { NULL, post_bl }, /* Bl */
1.1 kristaps 87: { NULL, NULL }, /* El */
88: { NULL, NULL }, /* It */
89: { NULL, NULL }, /* Ad */
90: { NULL, NULL }, /* An */
91: { NULL, post_ar }, /* Ar */
1.35 kristaps 92: { NULL, NULL }, /* Cd */
1.1 kristaps 93: { NULL, NULL }, /* Cm */
94: { NULL, NULL }, /* Dv */
95: { NULL, NULL }, /* Er */
96: { NULL, NULL }, /* Ev */
97: { NULL, post_std }, /* Ex */
98: { NULL, NULL }, /* Fa */
99: { NULL, NULL }, /* Fd */
100: { NULL, NULL }, /* Fl */
101: { NULL, NULL }, /* Fn */
102: { NULL, NULL }, /* Ft */
103: { NULL, NULL }, /* Ic */
104: { NULL, NULL }, /* In */
1.62 kristaps 105: { NULL, post_li }, /* Li */
1.1 kristaps 106: { NULL, NULL }, /* Nd */
107: { NULL, post_nm }, /* Nm */
108: { NULL, NULL }, /* Op */
109: { NULL, NULL }, /* Ot */
1.46 kristaps 110: { NULL, post_pa }, /* Pa */
1.1 kristaps 111: { NULL, post_std }, /* Rv */
1.26 kristaps 112: { NULL, post_st }, /* St */
1.1 kristaps 113: { NULL, NULL }, /* Va */
114: { NULL, NULL }, /* Vt */
115: { NULL, NULL }, /* Xr */
116: { NULL, NULL }, /* %A */
117: { NULL, NULL }, /* %B */
118: { NULL, NULL }, /* %D */
119: { NULL, NULL }, /* %I */
120: { NULL, NULL }, /* %J */
121: { NULL, NULL }, /* %N */
122: { NULL, NULL }, /* %O */
123: { NULL, NULL }, /* %P */
124: { NULL, NULL }, /* %R */
125: { NULL, NULL }, /* %T */
126: { NULL, NULL }, /* %V */
127: { NULL, NULL }, /* Ac */
128: { NULL, NULL }, /* Ao */
129: { NULL, NULL }, /* Aq */
1.25 kristaps 130: { NULL, post_at }, /* At */
1.1 kristaps 131: { NULL, NULL }, /* Bc */
132: { NULL, NULL }, /* Bf */
133: { NULL, NULL }, /* Bo */
134: { NULL, NULL }, /* Bq */
135: { NULL, NULL }, /* Bsx */
136: { NULL, NULL }, /* Bx */
137: { NULL, NULL }, /* Db */
138: { NULL, NULL }, /* Dc */
139: { NULL, NULL }, /* Do */
140: { NULL, NULL }, /* Dq */
141: { NULL, NULL }, /* Ec */
142: { NULL, NULL }, /* Ef */
143: { NULL, NULL }, /* Em */
144: { NULL, NULL }, /* Eo */
145: { NULL, NULL }, /* Fx */
146: { NULL, NULL }, /* Ms */
147: { NULL, NULL }, /* No */
148: { NULL, NULL }, /* Ns */
149: { NULL, NULL }, /* Nx */
150: { NULL, NULL }, /* Ox */
151: { NULL, NULL }, /* Pc */
152: { NULL, NULL }, /* Pf */
153: { NULL, NULL }, /* Po */
154: { NULL, NULL }, /* Pq */
155: { NULL, NULL }, /* Qc */
156: { NULL, NULL }, /* Ql */
157: { NULL, NULL }, /* Qo */
158: { NULL, NULL }, /* Qq */
159: { NULL, NULL }, /* Re */
1.39 kristaps 160: { NULL, post_rs }, /* Rs */
1.1 kristaps 161: { NULL, NULL }, /* Sc */
162: { NULL, NULL }, /* So */
163: { NULL, NULL }, /* Sq */
164: { NULL, NULL }, /* Sm */
165: { NULL, NULL }, /* Sx */
166: { NULL, NULL }, /* Sy */
167: { NULL, NULL }, /* Tn */
168: { NULL, NULL }, /* Ux */
169: { NULL, NULL }, /* Xc */
170: { NULL, NULL }, /* Xo */
171: { NULL, NULL }, /* Fo */
172: { NULL, NULL }, /* Fc */
173: { NULL, NULL }, /* Oo */
174: { NULL, NULL }, /* Oc */
175: { NULL, NULL }, /* Bk */
176: { NULL, NULL }, /* Ek */
177: { NULL, NULL }, /* Bt */
178: { NULL, NULL }, /* Hf */
179: { NULL, NULL }, /* Fr */
180: { NULL, NULL }, /* Ud */
1.27 kristaps 181: { NULL, post_lb }, /* Lb */
1.1 kristaps 182: { NULL, NULL }, /* Lp */
1.44 kristaps 183: { NULL, NULL }, /* Lk */
1.1 kristaps 184: { NULL, NULL }, /* Mt */
185: { NULL, NULL }, /* Brq */
186: { NULL, NULL }, /* Bro */
187: { NULL, NULL }, /* Brc */
188: { NULL, NULL }, /* %C */
189: { NULL, NULL }, /* Es */
190: { NULL, NULL }, /* En */
191: { NULL, NULL }, /* Dx */
192: { NULL, NULL }, /* %Q */
1.30 kristaps 193: { NULL, NULL }, /* br */
194: { NULL, NULL }, /* sp */
1.43 kristaps 195: { NULL, NULL }, /* %U */
1.64 kristaps 196: { NULL, NULL }, /* Ta */
1.1 kristaps 197: };
198:
1.45 kristaps 199: #define RSORD_MAX 14
1.1 kristaps 200:
1.54 kristaps 201: static const enum mdoct rsord[RSORD_MAX] = {
1.39 kristaps 202: MDOC__A,
203: MDOC__T,
204: MDOC__B,
205: MDOC__I,
206: MDOC__J,
207: MDOC__R,
208: MDOC__N,
209: MDOC__V,
210: MDOC__P,
211: MDOC__Q,
212: MDOC__D,
213: MDOC__O,
1.45 kristaps 214: MDOC__C,
215: MDOC__U
1.39 kristaps 216: };
1.2 kristaps 217:
218:
1.1 kristaps 219: int
1.60 kristaps 220: mdoc_action_pre(struct mdoc *m, struct mdoc_node *n)
1.1 kristaps 221: {
222:
223: switch (n->type) {
224: case (MDOC_ROOT):
1.2 kristaps 225: /* FALLTHROUGH */
1.1 kristaps 226: case (MDOC_TEXT):
1.2 kristaps 227: return(1);
228: default:
1.1 kristaps 229: break;
230: }
1.2 kristaps 231:
1.6 kristaps 232: if (NULL == mdoc_actions[n->tok].pre)
1.2 kristaps 233: return(1);
1.6 kristaps 234: return((*mdoc_actions[n->tok].pre)(m, n));
1.1 kristaps 235: }
236:
237:
238: int
239: mdoc_action_post(struct mdoc *m)
240: {
241:
242: if (MDOC_ACTED & m->last->flags)
243: return(1);
244: m->last->flags |= MDOC_ACTED;
245:
246: switch (m->last->type) {
247: case (MDOC_TEXT):
1.2 kristaps 248: /* FALLTHROUGH */
1.1 kristaps 249: case (MDOC_ROOT):
1.2 kristaps 250: return(1);
251: default:
1.1 kristaps 252: break;
253: }
1.2 kristaps 254:
255: if (NULL == mdoc_actions[m->last->tok].post)
256: return(1);
1.35 kristaps 257: return((*mdoc_actions[m->last->tok].post)(m, m->last));
1.2 kristaps 258: }
259:
260:
1.46 kristaps 261: /*
262: * Concatenate sibling nodes together. All siblings must be of type
263: * MDOC_TEXT or an assertion is raised. Concatenation is separated by a
264: * single whitespace.
265: */
1.2 kristaps 266: static int
1.46 kristaps 267: concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz)
1.2 kristaps 268: {
269:
1.46 kristaps 270: assert(sz);
271: p[0] = '\0';
1.2 kristaps 272: for ( ; n; n = n->next) {
273: assert(MDOC_TEXT == n->type);
1.59 kristaps 274: /*
275: * XXX: yes, these can technically be resized, but it's
276: * highly unlikely that we're going to get here, so let
277: * it slip for now.
278: */
279: if (strlcat(p, n->string, sz) >= sz) {
280: mdoc_nmsg(m, n, MANDOCERR_MEM);
281: return(0);
282: }
1.2 kristaps 283: if (NULL == n->next)
284: continue;
1.59 kristaps 285: if (strlcat(p, " ", sz) >= sz) {
286: mdoc_nmsg(m, n, MANDOCERR_MEM);
287: return(0);
288: }
1.2 kristaps 289: }
290:
1.1 kristaps 291: return(1);
292: }
293:
294:
1.46 kristaps 295: /*
296: * Macros accepting `-std' as an argument have the name of the current
297: * document (`Nm') filled in as the argument if it's not provided.
298: */
1.1 kristaps 299: static int
300: post_std(POST_ARGS)
301: {
1.59 kristaps 302: struct mdoc_node *nn;
1.1 kristaps 303:
1.35 kristaps 304: if (n->child)
1.1 kristaps 305: return(1);
1.59 kristaps 306: if (NULL == m->meta.name)
307: return(1);
1.35 kristaps 308:
309: nn = n;
310: m->next = MDOC_NEXT_CHILD;
1.59 kristaps 311:
1.35 kristaps 312: if ( ! mdoc_word_alloc(m, n->line, n->pos, m->meta.name))
313: return(0);
314: m->last = nn;
1.1 kristaps 315: return(1);
316: }
317:
318:
1.46 kristaps 319: /*
320: * The `Nm' macro's first use sets the name of the document. See also
321: * post_std(), etc.
322: */
1.1 kristaps 323: static int
324: post_nm(POST_ARGS)
325: {
1.46 kristaps 326: char buf[BUFSIZ];
1.1 kristaps 327:
328: if (m->meta.name)
329: return(1);
1.46 kristaps 330: if ( ! concat(m, buf, n->child, BUFSIZ))
1.2 kristaps 331: return(0);
1.46 kristaps 332: m->meta.name = mandoc_strdup(buf);
1.1 kristaps 333: return(1);
334: }
335:
336:
1.46 kristaps 337: /*
338: * Look up the value of `Lb' for matching predefined strings. If it has
339: * one, then substitute the current value for the formatted value. Note
340: * that the lookup may fail (we can provide arbitrary strings).
341: */
342: /* ARGSUSED */
1.1 kristaps 343: static int
1.27 kristaps 344: post_lb(POST_ARGS)
345: {
346: const char *p;
347: char *buf;
348: size_t sz;
349:
1.35 kristaps 350: assert(MDOC_TEXT == n->child->type);
351: p = mdoc_a2lib(n->child->string);
1.46 kristaps 352:
353: if (p) {
1.35 kristaps 354: free(n->child->string);
1.46 kristaps 355: n->child->string = mandoc_strdup(p);
1.27 kristaps 356: return(1);
357: }
358:
1.46 kristaps 359: sz = strlen(n->child->string) +
360: 2 + strlen("\\(lqlibrary\\(rq");
361: buf = mandoc_malloc(sz);
362: snprintf(buf, sz, "library \\(lq%s\\(rq", n->child->string);
1.35 kristaps 363: free(n->child->string);
1.46 kristaps 364: n->child->string = buf;
1.27 kristaps 365: return(1);
366: }
367:
368:
1.46 kristaps 369: /*
370: * Substitute the value of `St' for the corresponding formatted string.
371: * We're guaranteed that this exists (it's been verified during the
372: * validation phase).
373: */
374: /* ARGSUSED */
1.27 kristaps 375: static int
1.26 kristaps 376: post_st(POST_ARGS)
377: {
378: const char *p;
379:
1.35 kristaps 380: assert(MDOC_TEXT == n->child->type);
381: p = mdoc_a2st(n->child->string);
1.56 kristaps 382: if (p != NULL) {
383: free(n->child->string);
384: n->child->string = mandoc_strdup(p);
385: }
1.26 kristaps 386: return(1);
387: }
388:
389:
1.46 kristaps 390: /*
391: * Look up the standard string in a table. We know that it exists from
392: * the validation phase, so assert on failure. If a standard key wasn't
393: * supplied, supply the default ``AT&T UNIX''.
394: */
1.26 kristaps 395: static int
1.25 kristaps 396: post_at(POST_ARGS)
397: {
1.57 kristaps 398: struct mdoc_node *nn;
399: const char *p, *q;
400: char *buf;
401: size_t sz;
1.25 kristaps 402:
1.35 kristaps 403: if (n->child) {
404: assert(MDOC_TEXT == n->child->type);
405: p = mdoc_a2att(n->child->string);
1.57 kristaps 406: if (p) {
407: free(n->child->string);
408: n->child->string = mandoc_strdup(p);
409: } else {
410: p = "AT&T UNIX ";
411: q = n->child->string;
412: sz = strlen(p) + strlen(q) + 1;
413: buf = mandoc_malloc(sz);
414: strlcpy(buf, p, sz);
415: strlcat(buf, q, sz);
416: free(n->child->string);
417: n->child->string = buf;
418: }
1.25 kristaps 419: return(1);
420: }
421:
1.35 kristaps 422: nn = n;
1.25 kristaps 423: m->next = MDOC_NEXT_CHILD;
1.35 kristaps 424: if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
1.25 kristaps 425: return(0);
1.35 kristaps 426: m->last = nn;
1.25 kristaps 427: return(1);
428: }
429:
430:
1.46 kristaps 431: /*
432: * Mark the current section. The ``named'' section (lastnamed) is set
433: * whenever the current section isn't a custom section--we use this to
434: * keep track of section ordering. Also check that the section is
435: * allowed within the document's manual section.
436: */
1.25 kristaps 437: static int
1.1 kristaps 438: post_sh(POST_ARGS)
439: {
440: enum mdoc_sec sec;
1.46 kristaps 441: char buf[BUFSIZ];
1.1 kristaps 442:
1.35 kristaps 443: if (MDOC_HEAD != n->type)
1.1 kristaps 444: return(1);
1.5 kristaps 445:
1.46 kristaps 446: if ( ! concat(m, buf, n->child, BUFSIZ))
1.2 kristaps 447: return(0);
1.55 kristaps 448: sec = mdoc_str2sec(buf);
1.52 kristaps 449: /*
450: * The first section should always make us move into a non-new
451: * state.
452: */
453: if (SEC_NONE == m->lastnamed || SEC_CUSTOM != sec)
1.1 kristaps 454: m->lastnamed = sec;
455:
1.46 kristaps 456: /* Some sections only live in certain manual sections. */
457:
1.1 kristaps 458: switch ((m->lastsec = sec)) {
459: case (SEC_RETURN_VALUES):
460: /* FALLTHROUGH */
461: case (SEC_ERRORS):
1.58 kristaps 462: assert(m->meta.msec);
463: if (*m->meta.msec == '2')
1.1 kristaps 464: break;
1.58 kristaps 465: if (*m->meta.msec == '3')
466: break;
467: if (*m->meta.msec == '9')
468: break;
1.59 kristaps 469: return(mdoc_nmsg(m, n, MANDOCERR_SECMSEC));
1.1 kristaps 470: default:
471: break;
472: }
473: return(1);
474: }
475:
476:
1.46 kristaps 477: /*
478: * Parse out the contents of `Dt'. See in-line documentation for how we
479: * handle the various fields of this macro.
480: */
1.1 kristaps 481: static int
482: post_dt(POST_ARGS)
483: {
1.35 kristaps 484: struct mdoc_node *nn;
1.1 kristaps 485: const char *cp;
486:
487: if (m->meta.title)
488: free(m->meta.title);
489: if (m->meta.vol)
490: free(m->meta.vol);
491: if (m->meta.arch)
492: free(m->meta.arch);
493:
494: m->meta.title = m->meta.vol = m->meta.arch = NULL;
495: /* Handles: `.Dt'
496: * --> title = unknown, volume = local, msec = 0, arch = NULL
497: */
498:
1.35 kristaps 499: if (NULL == (nn = n->child)) {
1.46 kristaps 500: /* XXX: make these macro values. */
1.58 kristaps 501: /* FIXME: warn about missing values. */
1.63 kristaps 502: m->meta.title = mandoc_strdup("UNKNOWN");
503: m->meta.vol = mandoc_strdup("LOCAL");
1.58 kristaps 504: m->meta.msec = mandoc_strdup("1");
1.35 kristaps 505: return(post_prol(m, n));
1.1 kristaps 506: }
507:
508: /* Handles: `.Dt TITLE'
509: * --> title = TITLE, volume = local, msec = 0, arch = NULL
510: */
511:
1.63 kristaps 512: m->meta.title = mandoc_strdup
513: ('\0' == nn->string[0] ? "UNKNOWN" : nn->string);
1.1 kristaps 514:
1.35 kristaps 515: if (NULL == (nn = nn->next)) {
1.58 kristaps 516: /* FIXME: warn about missing msec. */
1.46 kristaps 517: /* XXX: make this a macro value. */
1.63 kristaps 518: m->meta.vol = mandoc_strdup("LOCAL");
1.58 kristaps 519: m->meta.msec = mandoc_strdup("1");
1.35 kristaps 520: return(post_prol(m, n));
1.1 kristaps 521: }
522:
523: /* Handles: `.Dt TITLE SEC'
524: * --> title = TITLE, volume = SEC is msec ?
525: * format(msec) : SEC,
526: * msec = SEC is msec ? atoi(msec) : 0,
527: * arch = NULL
528: */
529:
1.35 kristaps 530: cp = mdoc_a2msec(nn->string);
1.1 kristaps 531: if (cp) {
1.46 kristaps 532: m->meta.vol = mandoc_strdup(cp);
1.58 kristaps 533: m->meta.msec = mandoc_strdup(nn->string);
1.59 kristaps 534: } else if (mdoc_nmsg(m, n, MANDOCERR_BADMSEC)) {
1.46 kristaps 535: m->meta.vol = mandoc_strdup(nn->string);
1.58 kristaps 536: m->meta.msec = mandoc_strdup(nn->string);
537: } else
538: return(0);
1.1 kristaps 539:
1.35 kristaps 540: if (NULL == (nn = nn->next))
541: return(post_prol(m, n));
1.1 kristaps 542:
543: /* Handles: `.Dt TITLE SEC VOL'
544: * --> title = TITLE, volume = VOL is vol ?
545: * format(VOL) :
546: * VOL is arch ? format(arch) :
547: * VOL
548: */
549:
1.35 kristaps 550: cp = mdoc_a2vol(nn->string);
1.1 kristaps 551: if (cp) {
552: free(m->meta.vol);
1.46 kristaps 553: m->meta.vol = mandoc_strdup(cp);
1.1 kristaps 554: } else {
1.58 kristaps 555: /* FIXME: warn about bad arch. */
1.35 kristaps 556: cp = mdoc_a2arch(nn->string);
1.1 kristaps 557: if (NULL == cp) {
558: free(m->meta.vol);
1.46 kristaps 559: m->meta.vol = mandoc_strdup(nn->string);
560: } else
561: m->meta.arch = mandoc_strdup(cp);
1.1 kristaps 562: }
563:
564: /* Ignore any subsequent parameters... */
1.46 kristaps 565: /* FIXME: warn about subsequent parameters. */
1.1 kristaps 566:
1.35 kristaps 567: return(post_prol(m, n));
1.1 kristaps 568: }
569:
570:
1.46 kristaps 571: /*
572: * Set the operating system by way of the `Os' macro. Note that if an
573: * argument isn't provided and -DOSNAME="\"foo\"" is provided during
574: * compilation, this value will be used instead of filling in "sysname
575: * release" from uname().
576: */
1.1 kristaps 577: static int
578: post_os(POST_ARGS)
579: {
1.46 kristaps 580: char buf[BUFSIZ];
581: #ifndef OSNAME
1.1 kristaps 582: struct utsname utsname;
1.42 kristaps 583: #endif
584:
1.1 kristaps 585: if (m->meta.os)
586: free(m->meta.os);
1.4 kristaps 587:
1.46 kristaps 588: if ( ! concat(m, buf, n->child, BUFSIZ))
1.2 kristaps 589: return(0);
1.1 kristaps 590:
1.59 kristaps 591: /* XXX: yes, these can all be dynamically-adjusted buffers, but
592: * it's really not worth the extra hackery.
593: */
594:
1.46 kristaps 595: if ('\0' == buf[0]) {
596: #ifdef OSNAME
1.59 kristaps 597: if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ) {
598: mdoc_nmsg(m, n, MANDOCERR_MEM);
599: return(0);
600: }
1.46 kristaps 601: #else /*!OSNAME */
1.1 kristaps 602: if (-1 == uname(&utsname))
1.59 kristaps 603: return(mdoc_nmsg(m, n, MANDOCERR_UTSNAME));
604:
605: if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) {
606: mdoc_nmsg(m, n, MANDOCERR_MEM);
607: return(0);
608: }
609: if (strlcat(buf, " ", 64) >= BUFSIZ) {
610: mdoc_nmsg(m, n, MANDOCERR_MEM);
611: return(0);
612: }
613: if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) {
614: mdoc_nmsg(m, n, MANDOCERR_MEM);
615: return(0);
616: }
1.46 kristaps 617: #endif /*!OSNAME*/
1.1 kristaps 618: }
619:
1.46 kristaps 620: m->meta.os = mandoc_strdup(buf);
1.35 kristaps 621: return(post_prol(m, n));
1.1 kristaps 622: }
623:
624:
625: /*
626: * Calculate the -width for a `Bl -tag' list if it hasn't been provided.
1.46 kristaps 627: * Uses the first head macro. NOTE AGAIN: this is ONLY if the -width
628: * argument has NOT been provided. See post_bl_width() for converting
629: * the -width string.
1.1 kristaps 630: */
631: static int
1.35 kristaps 632: post_bl_tagwidth(POST_ARGS)
1.1 kristaps 633: {
1.46 kristaps 634: struct mdoc_node *nn;
1.69 ! kristaps 635: size_t sz, ssz;
1.46 kristaps 636: int i;
637: char buf[NUMSIZ];
1.1 kristaps 638:
1.69 ! kristaps 639: sz = 10;
1.61 joerg 640:
641: for (nn = n->body->child; nn; nn = nn->next) {
1.69 ! kristaps 642: if (MDOC_It != nn->tok)
! 643: continue;
1.46 kristaps 644:
1.35 kristaps 645: assert(MDOC_BLOCK == nn->type);
646: nn = nn->head->child;
1.69 ! kristaps 647:
! 648: if (MDOC_TEXT == nn->type) {
1.46 kristaps 649: sz = strlen(nn->string) + 1;
1.69 ! kristaps 650: break;
! 651: }
! 652:
! 653: if (0 != (ssz = mdoc_macro2len(nn->tok)))
! 654: sz = ssz;
! 655: else if ( ! mdoc_nmsg(m, n, MANDOCERR_NOWIDTHARG))
! 656: return(0);
! 657:
! 658: break;
1.1 kristaps 659: }
660:
1.69 ! kristaps 661: /* Defaults to ten ens. */
! 662:
1.46 kristaps 663: snprintf(buf, NUMSIZ, "%zun", sz);
1.1 kristaps 664:
665: /*
666: * We have to dynamically add this to the macro's argument list.
667: * We're guaranteed that a MDOC_Width doesn't already exist.
668: */
669:
1.35 kristaps 670: nn = n;
671: assert(nn->args);
1.46 kristaps 672: i = (int)(nn->args->argc)++;
1.1 kristaps 673:
1.46 kristaps 674: nn->args->argv = mandoc_realloc(nn->args->argv,
1.35 kristaps 675: nn->args->argc * sizeof(struct mdoc_argv));
1.1 kristaps 676:
1.46 kristaps 677: nn->args->argv[i].arg = MDOC_Width;
678: nn->args->argv[i].line = n->line;
679: nn->args->argv[i].pos = n->pos;
680: nn->args->argv[i].sz = 1;
681: nn->args->argv[i].value = mandoc_malloc(sizeof(char *));
682: nn->args->argv[i].value[0] = mandoc_strdup(buf);
1.1 kristaps 683: return(1);
684: }
685:
686:
1.46 kristaps 687: /*
688: * Calculate the real width of a list from the -width string, which may
689: * contain a macro (with a known default width), a literal string, or a
690: * scaling width.
691: */
1.1 kristaps 692: static int
1.69 ! kristaps 693: post_bl_width(struct mdoc *m, struct mdoc_node *n, int pos)
1.1 kristaps 694: {
695: size_t width;
1.51 kristaps 696: enum mdoct tok;
1.46 kristaps 697: char buf[NUMSIZ];
1.1 kristaps 698: char *p;
699:
1.69 ! kristaps 700: assert(n->args);
! 701: p = n->args->argv[pos].value[0];
1.1 kristaps 702:
703: /*
704: * If the value to -width is a macro, then we re-write it to be
705: * the macro's width as set in share/tmac/mdoc/doc-common.
706: */
707:
1.2 kristaps 708: if (0 == strcmp(p, "Ds"))
1.18 kristaps 709: width = 6;
1.36 kristaps 710: else if (MDOC_MAX == (tok = mdoc_hash_find(p)))
1.1 kristaps 711: return(1);
712: else if (0 == (width = mdoc_macro2len(tok)))
1.59 kristaps 713: return(mdoc_nmsg(m, n, MANDOCERR_BADWIDTH));
1.1 kristaps 714:
715: /* The value already exists: free and reallocate it. */
716:
1.46 kristaps 717: snprintf(buf, NUMSIZ, "%zun", width);
1.69 ! kristaps 718: free(n->args->argv[pos].value[0]);
! 719: n->args->argv[pos].value[0] = mandoc_strdup(buf);
1.1 kristaps 720: return(1);
721: }
722:
723:
1.46 kristaps 724: /*
725: * Do processing for -column lists, which can have two distinct styles
726: * of invocation. Merge this two styles into a consistent form.
727: */
1.35 kristaps 728: /* ARGSUSED */
1.1 kristaps 729: static int
1.14 kristaps 730: post_bl_head(POST_ARGS)
731: {
732: int i, c;
1.35 kristaps 733: struct mdoc_node *np, *nn, *nnp;
1.14 kristaps 734:
1.69 ! kristaps 735: if (LIST_column != n->data.Bl.type)
! 736: return(1);
! 737: else if (NULL == n->child)
1.14 kristaps 738: return(1);
739:
1.35 kristaps 740: np = n->parent;
741: assert(np->args);
1.14 kristaps 742:
1.35 kristaps 743: for (c = 0; c < (int)np->args->argc; c++)
744: if (MDOC_Column == np->args->argv[c].arg)
1.14 kristaps 745: break;
746:
1.69 ! kristaps 747: assert(c < (int)np->args->argc);
1.35 kristaps 748: assert(0 == np->args->argv[c].sz);
1.14 kristaps 749:
750: /*
751: * Accomodate for new-style groff column syntax. Shuffle the
752: * child nodes, all of which must be TEXT, as arguments for the
753: * column field. Then, delete the head children.
754: */
755:
1.35 kristaps 756: np->args->argv[c].sz = (size_t)n->nchild;
1.46 kristaps 757: np->args->argv[c].value = mandoc_malloc
1.35 kristaps 758: ((size_t)n->nchild * sizeof(char *));
1.14 kristaps 759:
1.35 kristaps 760: for (i = 0, nn = n->child; nn; i++) {
761: np->args->argv[c].value[i] = nn->string;
1.14 kristaps 762: nn->string = NULL;
763: nnp = nn;
764: nn = nn->next;
1.53 kristaps 765: mdoc_node_delete(NULL, nnp);
1.14 kristaps 766: }
767:
1.35 kristaps 768: n->nchild = 0;
769: n->child = NULL;
1.14 kristaps 770: return(1);
771: }
772:
773:
774: static int
1.1 kristaps 775: post_bl(POST_ARGS)
776: {
1.69 ! kristaps 777: int i, r, len, width;
1.1 kristaps 778:
1.35 kristaps 779: if (MDOC_HEAD == n->type)
780: return(post_bl_head(m, n));
781: if (MDOC_BLOCK != n->type)
1.1 kristaps 782: return(1);
783:
784: /*
785: * These are fairly complicated, so we've broken them into two
786: * functions. post_bl_tagwidth() is called when a -tag is
787: * specified, but no -width (it must be guessed). The second
788: * when a -width is specified (macro indicators must be
789: * rewritten into real lengths).
790: */
791:
1.35 kristaps 792: len = (int)(n->args ? n->args->argc : 0);
1.1 kristaps 793:
1.69 ! kristaps 794: width = -1;
! 795:
1.1 kristaps 796: for (r = i = 0; i < len; i++) {
1.35 kristaps 797: if (MDOC_Tag == n->args->argv[i].arg)
1.1 kristaps 798: r |= 1 << 0;
1.69 ! kristaps 799: if (MDOC_Width == n->args->argv[i].arg) {
! 800: width = i;
1.1 kristaps 801: r |= 1 << 1;
1.69 ! kristaps 802: }
1.1 kristaps 803: }
804:
805: if (r & (1 << 0) && ! (r & (1 << 1))) {
1.35 kristaps 806: if ( ! post_bl_tagwidth(m, n))
1.1 kristaps 807: return(0);
808: } else if (r & (1 << 1))
1.69 ! kristaps 809: if ( ! post_bl_width(m, n, width))
1.1 kristaps 810: return(0);
811:
812: return(1);
813: }
814:
815:
1.46 kristaps 816: /*
817: * The `Pa' macro defaults to a tilde if no value is provided as an
818: * argument.
819: */
1.1 kristaps 820: static int
1.46 kristaps 821: post_pa(POST_ARGS)
1.10 kristaps 822: {
1.35 kristaps 823: struct mdoc_node *np;
1.10 kristaps 824:
1.35 kristaps 825: if (n->child)
1.10 kristaps 826: return(1);
827:
1.35 kristaps 828: np = n;
1.10 kristaps 829: m->next = MDOC_NEXT_CHILD;
1.46 kristaps 830: /* XXX: make into macro value. */
1.35 kristaps 831: if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
1.62 kristaps 832: return(0);
833: m->last = np;
834: return(1);
835: }
836:
837:
838: /*
839: * Empty `Li' macros get an empty string to make front-ends add an extra
840: * space.
841: */
842: static int
843: post_li(POST_ARGS)
844: {
845: struct mdoc_node *np;
846:
847: if (n->child)
848: return(1);
849:
850: np = n;
851: m->next = MDOC_NEXT_CHILD;
852: if ( ! mdoc_word_alloc(m, n->line, n->pos, ""))
1.10 kristaps 853: return(0);
1.35 kristaps 854: m->last = np;
1.10 kristaps 855: return(1);
856: }
857:
858:
1.46 kristaps 859: /*
860: * The `Ar' macro defaults to two strings "file ..." if no value is
861: * provided as an argument.
862: */
1.10 kristaps 863: static int
1.1 kristaps 864: post_ar(POST_ARGS)
865: {
1.35 kristaps 866: struct mdoc_node *np;
1.1 kristaps 867:
1.35 kristaps 868: if (n->child)
1.1 kristaps 869: return(1);
870:
1.35 kristaps 871: np = n;
1.1 kristaps 872: m->next = MDOC_NEXT_CHILD;
1.46 kristaps 873: /* XXX: make into macro values. */
1.35 kristaps 874: if ( ! mdoc_word_alloc(m, n->line, n->pos, "file"))
1.1 kristaps 875: return(0);
1.35 kristaps 876: if ( ! mdoc_word_alloc(m, n->line, n->pos, "..."))
1.1 kristaps 877: return(0);
1.35 kristaps 878: m->last = np;
1.1 kristaps 879: return(1);
880: }
881:
882:
1.46 kristaps 883: /*
1.49 kristaps 884: * Parse the date field in `Dd'.
1.46 kristaps 885: */
1.1 kristaps 886: static int
887: post_dd(POST_ARGS)
888: {
1.46 kristaps 889: char buf[DATESIZ];
1.1 kristaps 890:
1.46 kristaps 891: if ( ! concat(m, buf, n->child, DATESIZ))
1.2 kristaps 892: return(0);
1.1 kristaps 893:
1.49 kristaps 894: m->meta.date = mandoc_a2time
895: (MTIME_MDOCDATE | MTIME_CANONICAL, buf);
896:
1.46 kristaps 897: if (0 == m->meta.date) {
1.59 kristaps 898: if ( ! mdoc_nmsg(m, n, MANDOCERR_BADDATE))
1.1 kristaps 899: return(0);
900: m->meta.date = time(NULL);
901: }
902:
1.35 kristaps 903: return(post_prol(m, n));
1.1 kristaps 904: }
905:
906:
1.46 kristaps 907: /*
908: * Remove prologue macros from the document after they're processed.
909: * The final document uses mdoc_meta for these values and discards the
910: * originals.
911: */
1.1 kristaps 912: static int
913: post_prol(POST_ARGS)
914: {
1.34 kristaps 915:
1.53 kristaps 916: mdoc_node_delete(m, n);
1.34 kristaps 917: if (m->meta.title && m->meta.date && m->meta.os)
918: m->flags |= MDOC_PBODY;
1.1 kristaps 919: return(1);
920: }
921:
922:
1.46 kristaps 923: /*
924: * Trigger a literal context.
925: */
1.1 kristaps 926: static int
927: pre_dl(PRE_ARGS)
928: {
929:
1.16 kristaps 930: if (MDOC_BODY == n->type)
931: m->flags |= MDOC_LITERAL;
1.65 kristaps 932: return(1);
1.38 kristaps 933: }
934:
935:
936: static int
1.1 kristaps 937: pre_bd(PRE_ARGS)
938: {
939:
940: if (MDOC_BODY != n->type)
941: return(1);
942:
1.67 kristaps 943: if (DISP_literal == n->data.Bd.type)
1.66 kristaps 944: m->flags |= MDOC_LITERAL;
1.67 kristaps 945: if (DISP_unfilled == n->data.Bd.type)
1.66 kristaps 946: m->flags |= MDOC_LITERAL;
1.1 kristaps 947:
948: return(1);
949: }
950:
951:
952: static int
953: post_display(POST_ARGS)
954: {
955:
1.35 kristaps 956: if (MDOC_BODY == n->type)
1.1 kristaps 957: m->flags &= ~MDOC_LITERAL;
958: return(1);
959: }
960:
961:
1.39 kristaps 962: static inline int
1.54 kristaps 963: order_rs(enum mdoct t)
1.39 kristaps 964: {
965: int i;
966:
1.54 kristaps 967: for (i = 0; i < (int)RSORD_MAX; i++)
1.39 kristaps 968: if (rsord[i] == t)
969: return(i);
970:
971: abort();
972: /* NOTREACHED */
973: }
974:
975:
1.41 kristaps 976: /* ARGSUSED */
1.39 kristaps 977: static int
978: post_rs(POST_ARGS)
979: {
980: struct mdoc_node *nn, *next, *prev;
981: int o;
982:
983: if (MDOC_BLOCK != n->type)
984: return(1);
985:
1.40 kristaps 986: assert(n->body->child);
1.39 kristaps 987: for (next = NULL, nn = n->body->child->next; nn; nn = next) {
988: o = order_rs(nn->tok);
989:
990: /* Remove `nn' from the chain. */
991: next = nn->next;
992: if (next)
993: next->prev = nn->prev;
994:
995: prev = nn->prev;
996: if (prev)
997: prev->next = nn->next;
998:
999: nn->prev = nn->next = NULL;
1000:
1001: /*
1002: * Scan back until we reach a node that's ordered before
1003: * us, then set ourselves as being the next.
1004: */
1005: for ( ; prev; prev = prev->prev)
1006: if (order_rs(prev->tok) <= o)
1007: break;
1008:
1009: nn->prev = prev;
1010: if (prev) {
1011: if (prev->next)
1012: prev->next->prev = nn;
1013: nn->next = prev->next;
1014: prev->next = nn;
1015: continue;
1016: }
1017:
1018: n->body->child->prev = nn;
1019: nn->next = n->body->child;
1020: n->body->child = nn;
1021: }
1022: return(1);
1023: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc_action.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc