mdoc_action.c

   1 /*      $Id: mdoc_action.c,v 1.51 2010/03/31 07:13:53 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(int);
  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 int 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         assert(p);
 370         free(n->child->string);
 371         n->child->string = mandoc_strdup(p);
 372         return(1);
 373 }
 374
 375
 376 /*
 377  * Look up the standard string in a table.  We know that it exists from
 378  * the validation phase, so assert on failure.  If a standard key wasn't
 379  * supplied, supply the default ``AT&T UNIX''.
 380  */
 381 static int
 382 post_at(POST_ARGS)
 383 {
 384         struct mdoc_node        *nn;
 385         const char              *p;
 386
 387         if (n->child) {
 388                 assert(MDOC_TEXT == n->child->type);
 389                 p = mdoc_a2att(n->child->string);
 390                 assert(p);
 391                 free(n->child->string);
 392                 n->child->string = mandoc_strdup(p);
 393                 return(1);
 394         }
 395
 396         nn = n;
 397         m->next = MDOC_NEXT_CHILD;
 398         if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
 399                 return(0);
 400         m->last = nn;
 401         return(1);
 402 }
 403
 404
 405 /*
 406  * Mark the current section.  The ``named'' section (lastnamed) is set
 407  * whenever the current section isn't a custom section--we use this to
 408  * keep track of section ordering.  Also check that the section is
 409  * allowed within the document's manual section.
 410  */
 411 static int
 412 post_sh(POST_ARGS)
 413 {
 414         enum mdoc_sec    sec;
 415         char             buf[BUFSIZ];
 416
 417         if (MDOC_HEAD != n->type)
 418                 return(1);
 419
 420         if ( ! concat(m, buf, n->child, BUFSIZ))
 421                 return(0);
 422         sec = mdoc_atosec(buf);
 423         if (SEC_CUSTOM != sec)
 424                 m->lastnamed = sec;
 425
 426         /* Some sections only live in certain manual sections. */
 427
 428         switch ((m->lastsec = sec)) {
 429         case (SEC_RETURN_VALUES):
 430                 /* FALLTHROUGH */
 431         case (SEC_ERRORS):
 432                 switch (m->meta.msec) {
 433                 case (2):
 434                         /* FALLTHROUGH */
 435                 case (3):
 436                         /* FALLTHROUGH */
 437                 case (9):
 438                         break;
 439                 default:
 440                         return(mdoc_nwarn(m, n, EBADSEC));
 441                 }
 442                 break;
 443         default:
 444                 break;
 445         }
 446         return(1);
 447 }
 448
 449
 450 /*
 451  * Parse out the contents of `Dt'.  See in-line documentation for how we
 452  * handle the various fields of this macro.
 453  */
 454 static int
 455 post_dt(POST_ARGS)
 456 {
 457         struct mdoc_node *nn;
 458         const char       *cp;
 459         char             *ep;
 460         long              lval;
 461
 462         if (m->meta.title)
 463                 free(m->meta.title);
 464         if (m->meta.vol)
 465                 free(m->meta.vol);
 466         if (m->meta.arch)
 467                 free(m->meta.arch);
 468
 469         m->meta.title = m->meta.vol = m->meta.arch = NULL;
 470         m->meta.msec = 0;
 471
 472         /* Handles: `.Dt'
 473          *   --> title = unknown, volume = local, msec = 0, arch = NULL
 474          */
 475
 476         if (NULL == (nn = n->child)) {
 477                 /* XXX: make these macro values. */
 478                 m->meta.title = mandoc_strdup("unknown");
 479                 m->meta.vol = mandoc_strdup("local");
 480                 return(post_prol(m, n));
 481         }
 482
 483         /* Handles: `.Dt TITLE'
 484          *   --> title = TITLE, volume = local, msec = 0, arch = NULL
 485          */
 486
 487         m->meta.title = mandoc_strdup(nn->string);
 488
 489         if (NULL == (nn = nn->next)) {
 490                 /* XXX: make this a macro value. */
 491                 m->meta.vol = mandoc_strdup("local");
 492                 return(post_prol(m, n));
 493         }
 494
 495         /* Handles: `.Dt TITLE SEC'
 496          *   --> title = TITLE, volume = SEC is msec ?
 497          *           format(msec) : SEC,
 498          *       msec = SEC is msec ? atoi(msec) : 0,
 499          *       arch = NULL
 500          */
 501
 502         cp = mdoc_a2msec(nn->string);
 503         if (cp) {
 504                 /* FIXME: where is strtonum!? */
 505                 m->meta.vol = mandoc_strdup(cp);
 506                 lval = strtol(nn->string, &ep, 10);
 507                 if (nn->string[0] != '\0' && *ep == '\0')
 508                         m->meta.msec = (int)lval;
 509         } else
 510                 m->meta.vol = mandoc_strdup(nn->string);
 511
 512         if (NULL == (nn = nn->next))
 513                 return(post_prol(m, n));
 514
 515         /* Handles: `.Dt TITLE SEC VOL'
 516          *   --> title = TITLE, volume = VOL is vol ?
 517          *       format(VOL) :
 518          *           VOL is arch ? format(arch) :
 519          *               VOL
 520          */
 521
 522         cp = mdoc_a2vol(nn->string);
 523         if (cp) {
 524                 free(m->meta.vol);
 525                 m->meta.vol = mandoc_strdup(cp);
 526         } else {
 527                 cp = mdoc_a2arch(nn->string);
 528                 if (NULL == cp) {
 529                         free(m->meta.vol);
 530                         m->meta.vol = mandoc_strdup(nn->string);
 531                 } else
 532                         m->meta.arch = mandoc_strdup(cp);
 533         }
 534
 535         /* Ignore any subsequent parameters... */
 536         /* FIXME: warn about subsequent parameters. */
 537
 538         return(post_prol(m, n));
 539 }
 540
 541
 542 /*
 543  * Set the operating system by way of the `Os' macro.  Note that if an
 544  * argument isn't provided and -DOSNAME="\"foo\"" is provided during
 545  * compilation, this value will be used instead of filling in "sysname
 546  * release" from uname().
 547  */
 548 static int
 549 post_os(POST_ARGS)
 550 {
 551         char              buf[BUFSIZ];
 552 #ifndef OSNAME
 553         struct utsname    utsname;
 554 #endif
 555
 556         if (m->meta.os)
 557                 free(m->meta.os);
 558
 559         if ( ! concat(m, buf, n->child, BUFSIZ))
 560                 return(0);
 561
 562         if ('\0' == buf[0]) {
 563 #ifdef OSNAME
 564                 if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ)
 565                         return(mdoc_nerr(m, n, EUTSNAME));
 566 #else /*!OSNAME */
 567                 if (-1 == uname(&utsname))
 568                         return(mdoc_nerr(m, n, EUTSNAME));
 569                 if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ)
 570                         return(mdoc_nerr(m, n, ETOOLONG));
 571                 if (strlcat(buf, " ", 64) >= BUFSIZ)
 572                         return(mdoc_nerr(m, n, ETOOLONG));
 573                 if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ)
 574                         return(mdoc_nerr(m, n, ETOOLONG));
 575 #endif /*!OSNAME*/
 576         }
 577
 578         m->meta.os = mandoc_strdup(buf);
 579         return(post_prol(m, n));
 580 }
 581
 582
 583 /*
 584  * Calculate the -width for a `Bl -tag' list if it hasn't been provided.
 585  * Uses the first head macro.  NOTE AGAIN: this is ONLY if the -width
 586  * argument has NOT been provided.  See post_bl_width() for converting
 587  * the -width string.
 588  */
 589 static int
 590 post_bl_tagwidth(POST_ARGS)
 591 {
 592         struct mdoc_node *nn;
 593         size_t            sz;
 594         int               i;
 595         char              buf[NUMSIZ];
 596
 597         /* Defaults to ten ens. */
 598
 599         sz = 10; /* XXX: make this a macro value. */
 600         nn = n->body->child;
 601
 602         if (nn) {
 603                 assert(MDOC_BLOCK == nn->type);
 604                 assert(MDOC_It == nn->tok);
 605                 nn = nn->head->child;
 606                 if (MDOC_TEXT != nn->type) {
 607                         sz = mdoc_macro2len(nn->tok);
 608                         if (sz == 0) {
 609                                 if ( ! mdoc_nwarn(m, n, ENOWIDTH))
 610                                         return(0);
 611                                 sz = 10;
 612                         }
 613                 } else
 614                         sz = strlen(nn->string) + 1;
 615         }
 616
 617         snprintf(buf, NUMSIZ, "%zun", sz);
 618
 619         /*
 620          * We have to dynamically add this to the macro's argument list.
 621          * We're guaranteed that a MDOC_Width doesn't already exist.
 622          */
 623
 624         nn = n;
 625         assert(nn->args);
 626         i = (int)(nn->args->argc)++;
 627
 628         nn->args->argv = mandoc_realloc(nn->args->argv,
 629                         nn->args->argc * sizeof(struct mdoc_argv));
 630
 631         nn->args->argv[i].arg = MDOC_Width;
 632         nn->args->argv[i].line = n->line;
 633         nn->args->argv[i].pos = n->pos;
 634         nn->args->argv[i].sz = 1;
 635         nn->args->argv[i].value = mandoc_malloc(sizeof(char *));
 636         nn->args->argv[i].value[0] = mandoc_strdup(buf);
 637         return(1);
 638 }
 639
 640
 641 /*
 642  * Calculate the real width of a list from the -width string, which may
 643  * contain a macro (with a known default width), a literal string, or a
 644  * scaling width.
 645  */
 646 static int
 647 post_bl_width(POST_ARGS)
 648 {
 649         size_t            width;
 650         int               i;
 651         enum mdoct        tok;
 652         char              buf[NUMSIZ];
 653         char             *p;
 654
 655         if (NULL == n->args)
 656                 return(1);
 657
 658         for (i = 0; i < (int)n->args->argc; i++)
 659                 if (MDOC_Width == n->args->argv[i].arg)
 660                         break;
 661
 662         if (i == (int)n->args->argc)
 663                 return(1);
 664         p = n->args->argv[i].value[0];
 665
 666         /*
 667          * If the value to -width is a macro, then we re-write it to be
 668          * the macro's width as set in share/tmac/mdoc/doc-common.
 669          */
 670
 671         if (0 == strcmp(p, "Ds"))
 672                 /* XXX: make into a macro. */
 673                 width = 6;
 674         else if (MDOC_MAX == (tok = mdoc_hash_find(p)))
 675                 return(1);
 676         else if (0 == (width = mdoc_macro2len(tok)))
 677                 return(mdoc_nwarn(m, n, ENOWIDTH));
 678
 679         /* The value already exists: free and reallocate it. */
 680
 681         snprintf(buf, NUMSIZ, "%zun", width);
 682         free(n->args->argv[i].value[0]);
 683         n->args->argv[i].value[0] = mandoc_strdup(buf);
 684         return(1);
 685 }
 686
 687
 688 /*
 689  * Do processing for -column lists, which can have two distinct styles
 690  * of invocation.  Merge this two styles into a consistent form.
 691  */
 692 /* ARGSUSED */
 693 static int
 694 post_bl_head(POST_ARGS)
 695 {
 696         int                      i, c;
 697         struct mdoc_node        *np, *nn, *nnp;
 698
 699         if (NULL == n->child)
 700                 return(1);
 701
 702         np = n->parent;
 703         assert(np->args);
 704
 705         for (c = 0; c < (int)np->args->argc; c++)
 706                 if (MDOC_Column == np->args->argv[c].arg)
 707                         break;
 708
 709         if (c == (int)np->args->argc)
 710                 return(1);
 711         assert(0 == np->args->argv[c].sz);
 712
 713         /*
 714          * Accomodate for new-style groff column syntax.  Shuffle the
 715          * child nodes, all of which must be TEXT, as arguments for the
 716          * column field.  Then, delete the head children.
 717          */
 718
 719         np->args->argv[c].sz = (size_t)n->nchild;
 720         np->args->argv[c].value = mandoc_malloc
 721                 ((size_t)n->nchild * sizeof(char *));
 722
 723         for (i = 0, nn = n->child; nn; i++) {
 724                 np->args->argv[c].value[i] = nn->string;
 725                 nn->string = NULL;
 726                 nnp = nn;
 727                 nn = nn->next;
 728                 mdoc_node_free(nnp);
 729         }
 730
 731         n->nchild = 0;
 732         n->child = NULL;
 733         return(1);
 734 }
 735
 736
 737 static int
 738 post_bl(POST_ARGS)
 739 {
 740         int               i, r, len;
 741
 742         if (MDOC_HEAD == n->type)
 743                 return(post_bl_head(m, n));
 744         if (MDOC_BLOCK != n->type)
 745                 return(1);
 746
 747         /*
 748          * These are fairly complicated, so we've broken them into two
 749          * functions.  post_bl_tagwidth() is called when a -tag is
 750          * specified, but no -width (it must be guessed).  The second
 751          * when a -width is specified (macro indicators must be
 752          * rewritten into real lengths).
 753          */
 754
 755         len = (int)(n->args ? n->args->argc : 0);
 756
 757         for (r = i = 0; i < len; i++) {
 758                 if (MDOC_Tag == n->args->argv[i].arg)
 759                         r |= 1 << 0;
 760                 if (MDOC_Width == n->args->argv[i].arg)
 761                         r |= 1 << 1;
 762         }
 763
 764         if (r & (1 << 0) && ! (r & (1 << 1))) {
 765                 if ( ! post_bl_tagwidth(m, n))
 766                         return(0);
 767         } else if (r & (1 << 1))
 768                 if ( ! post_bl_width(m, n))
 769                         return(0);
 770
 771         return(1);
 772 }
 773
 774
 775 /*
 776  * The `Pa' macro defaults to a tilde if no value is provided as an
 777  * argument.
 778  */
 779 static int
 780 post_pa(POST_ARGS)
 781 {
 782         struct mdoc_node *np;
 783
 784         if (n->child)
 785                 return(1);
 786
 787         np = n;
 788         m->next = MDOC_NEXT_CHILD;
 789         /* XXX: make into macro value. */
 790         if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
 791                 return(0);
 792         m->last = np;
 793         return(1);
 794 }
 795
 796
 797 /*
 798  * The `Ar' macro defaults to two strings "file ..." if no value is
 799  * provided as an argument.
 800  */
 801 static int
 802 post_ar(POST_ARGS)
 803 {
 804         struct mdoc_node *np;
 805
 806         if (n->child)
 807                 return(1);
 808
 809         np = n;
 810         m->next = MDOC_NEXT_CHILD;
 811         /* XXX: make into macro values. */
 812         if ( ! mdoc_word_alloc(m, n->line, n->pos, "file"))
 813                 return(0);
 814         if ( ! mdoc_word_alloc(m, n->line, n->pos, "..."))
 815                 return(0);
 816         m->last = np;
 817         return(1);
 818 }
 819
 820
 821 /*
 822  * Parse the date field in `Dd'.
 823  */
 824 static int
 825 post_dd(POST_ARGS)
 826 {
 827         char            buf[DATESIZ];
 828
 829         if ( ! concat(m, buf, n->child, DATESIZ))
 830                 return(0);
 831
 832         m->meta.date = mandoc_a2time
 833                 (MTIME_MDOCDATE | MTIME_CANONICAL, buf);
 834
 835         if (0 == m->meta.date) {
 836                 if ( ! mdoc_nwarn(m, n, EBADDATE))
 837                         return(0);
 838                 m->meta.date = time(NULL);
 839         }
 840
 841         return(post_prol(m, n));
 842 }
 843
 844
 845 /*
 846  * Remove prologue macros from the document after they're processed.
 847  * The final document uses mdoc_meta for these values and discards the
 848  * originals.
 849  */
 850 static int
 851 post_prol(POST_ARGS)
 852 {
 853         struct mdoc_node *np;
 854
 855         if (n->parent->child == n)
 856                 n->parent->child = n->prev;
 857         if (n->prev)
 858                 n->prev->next = NULL;
 859
 860         np = n;
 861         assert(NULL == n->next);
 862
 863         if (n->prev) {
 864                 m->last = n->prev;
 865                 m->next = MDOC_NEXT_SIBLING;
 866         } else {
 867                 m->last = n->parent;
 868                 m->next = MDOC_NEXT_CHILD;
 869         }
 870
 871         mdoc_node_freelist(np);
 872
 873         if (m->meta.title && m->meta.date && m->meta.os)
 874                 m->flags |= MDOC_PBODY;
 875
 876         return(1);
 877 }
 878
 879
 880 /*
 881  * Trigger a literal context.
 882  */
 883 static int
 884 pre_dl(PRE_ARGS)
 885 {
 886
 887         if (MDOC_BODY == n->type)
 888                 m->flags |= MDOC_LITERAL;
 889         return(1);
 890 }
 891
 892
 893 /* ARGSUSED */
 894 static int
 895 pre_offset(PRE_ARGS)
 896 {
 897         int              i;
 898
 899         /*
 900          * Make sure that an empty offset produces an 8n length space as
 901          * stipulated by mdoc.samples.
 902          */
 903
 904         assert(n->args);
 905         for (i = 0; i < (int)n->args->argc; i++) {
 906                 if (MDOC_Offset != n->args->argv[i].arg)
 907                         continue;
 908                 if (n->args->argv[i].sz)
 909                         break;
 910                 assert(1 == n->args->refcnt);
 911                 /* If no value set, length of <string>. */
 912                 n->args->argv[i].sz++;
 913                 n->args->argv[i].value = mandoc_malloc(sizeof(char *));
 914                 n->args->argv[i].value[0] = mandoc_strdup("8n");
 915                 break;
 916         }
 917
 918         return(1);
 919 }
 920
 921
 922 static int
 923 pre_bl(PRE_ARGS)
 924 {
 925
 926         return(MDOC_BLOCK == n->type ? pre_offset(m, n) : 1);
 927 }
 928
 929
 930 static int
 931 pre_bd(PRE_ARGS)
 932 {
 933         int              i;
 934
 935         if (MDOC_BLOCK == n->type)
 936                 return(pre_offset(m, n));
 937         if (MDOC_BODY != n->type)
 938                 return(1);
 939
 940         /* Enter literal context if `Bd -literal' or `-unfilled'. */
 941
 942         for (n = n->parent, i = 0; i < (int)n->args->argc; i++)
 943                 if (MDOC_Literal == n->args->argv[i].arg)
 944                         m->flags |= MDOC_LITERAL;
 945                 else if (MDOC_Unfilled == n->args->argv[i].arg)
 946                         m->flags |= MDOC_LITERAL;
 947
 948         return(1);
 949 }
 950
 951
 952 static int
 953 post_display(POST_ARGS)
 954 {
 955
 956         if (MDOC_BODY == n->type)
 957                 m->flags &= ~MDOC_LITERAL;
 958         return(1);
 959 }
 960
 961
 962 static inline int
 963 order_rs(int t)
 964 {
 965         int             i;
 966
 967         for (i = 0; i < RSORD_MAX; i++)
 968                 if (rsord[i] == t)
 969                         return(i);
 970
 971         abort();
 972         /* NOTREACHED */
 973 }
 974
 975
 976 /* ARGSUSED */
 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
 986         assert(n->body->child);
 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 }