mdoc_action.c

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