man.c

   1 /*      $Id: man.c,v 1.36 2009/08/21 13:18:32 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 #include <assert.h>
  18 #include <ctype.h>
  19 #include <stdarg.h>
  20 #include <stdlib.h>
  21 #include <stdio.h>
  22 #include <string.h>
  23
  24 #include "libman.h"
  25
  26 const   char *const __man_merrnames[WERRMAX] = {
  27         "invalid character", /* WNPRINT */
  28         "system: malloc error", /* WNMEM */
  29         "invalid manual section", /* WMSEC */
  30         "invalid date format", /* WDATE */
  31         "scope of prior line violated", /* WLNSCOPE */
  32         "trailing whitespace", /* WTSPACE */
  33         "unterminated quoted parameter", /* WTQUOTE */
  34         "document has no body", /* WNODATA */
  35         "document has no title/section", /* WNOTITLE */
  36         "invalid escape sequence", /* WESCAPE */
  37         "invalid number format", /* WNUMFMT */
  38         "expected block head arguments", /* WHEADARGS */
  39         "expected block body arguments", /* WBODYARGS */
  40         "expected empty block head", /* WNHEADARGS */
  41         "unknown macro", /* WMACRO */
  42         "ill-formed macro", /* WMACROFORM */
  43         "scope open on exit", /* WEXITSCOPE */
  44         "no scope context", /* WNOSCOPE */
  45         "literal context already open", /* WOLITERAL */
  46         "no literal context open" /* WNLITERAL */
  47 };
  48
  49 const   char *const __man_macronames[MAN_MAX] = {
  50         "br",           "TH",           "SH",           "SS",
  51         "TP",           "LP",           "PP",           "P",
  52         "IP",           "HP",           "SM",           "SB",
  53         "BI",           "IB",           "BR",           "RB",
  54         "R",            "B",            "I",            "IR",
  55         "RI",           "na",           "i",            "sp",
  56         "nf",           "fi",           "r",            "RE",
  57         "RS",           "DT"
  58         };
  59
  60 const   char * const *man_macronames = __man_macronames;
  61
  62 static  struct man_node *man_node_alloc(int, int,
  63                                 enum man_type, int);
  64 static  int              man_node_append(struct man *,
  65                                 struct man_node *);
  66 static  int              man_ptext(struct man *, int, char *);
  67 static  int              man_pmacro(struct man *, int, char *);
  68 static  void             man_free1(struct man *);
  69 static  int              man_alloc1(struct man *);
  70 static  int              pstring(struct man *, int, int,
  71                                 const char *, size_t);
  72
  73 #ifdef __linux__
  74 extern  size_t            strlcpy(char *, const char *, size_t);
  75 #endif
  76
  77
  78 const struct man_node *
  79 man_node(const struct man *m)
  80 {
  81
  82         return(MAN_HALT & m->flags ? NULL : m->first);
  83 }
  84
  85
  86 const struct man_meta *
  87 man_meta(const struct man *m)
  88 {
  89
  90         return(MAN_HALT & m->flags ? NULL : &m->meta);
  91 }
  92
  93
  94 int
  95 man_reset(struct man *man)
  96 {
  97
  98         man_free1(man);
  99         return(man_alloc1(man));
 100 }
 101
 102
 103 void
 104 man_free(struct man *man)
 105 {
 106
 107         man_free1(man);
 108
 109         if (man->htab)
 110                 man_hash_free(man->htab);
 111         free(man);
 112 }
 113
 114
 115 struct man *
 116 man_alloc(void *data, int pflags, const struct man_cb *cb)
 117 {
 118         struct man      *p;
 119
 120         if (NULL == (p = calloc(1, sizeof(struct man))))
 121                 return(NULL);
 122
 123         if ( ! man_alloc1(p)) {
 124                 free(p);
 125                 return(NULL);
 126         }
 127
 128         p->data = data;
 129         p->pflags = pflags;
 130         (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
 131
 132         if (NULL == (p->htab = man_hash_alloc())) {
 133                 free(p);
 134                 return(NULL);
 135         }
 136         return(p);
 137 }
 138
 139
 140 int
 141 man_endparse(struct man *m)
 142 {
 143
 144         if (MAN_HALT & m->flags)
 145                 return(0);
 146         else if (man_macroend(m))
 147                 return(1);
 148         m->flags |= MAN_HALT;
 149         return(0);
 150 }
 151
 152
 153 int
 154 man_parseln(struct man *m, int ln, char *buf)
 155 {
 156
 157         return('.' == *buf ?
 158                         man_pmacro(m, ln, buf) :
 159                         man_ptext(m, ln, buf));
 160 }
 161
 162
 163 static void
 164 man_free1(struct man *man)
 165 {
 166
 167         if (man->first)
 168                 man_node_freelist(man->first);
 169         if (man->meta.title)
 170                 free(man->meta.title);
 171         if (man->meta.source)
 172                 free(man->meta.source);
 173         if (man->meta.vol)
 174                 free(man->meta.vol);
 175 }
 176
 177
 178 static int
 179 man_alloc1(struct man *m)
 180 {
 181
 182         bzero(&m->meta, sizeof(struct man_meta));
 183         m->flags = 0;
 184         m->last = calloc(1, sizeof(struct man_node));
 185         if (NULL == m->last)
 186                 return(0);
 187         m->first = m->last;
 188         m->last->type = MAN_ROOT;
 189         m->next = MAN_NEXT_CHILD;
 190         return(1);
 191 }
 192
 193
 194 static int
 195 man_node_append(struct man *man, struct man_node *p)
 196 {
 197
 198         assert(man->last);
 199         assert(man->first);
 200         assert(MAN_ROOT != p->type);
 201
 202         switch (man->next) {
 203         case (MAN_NEXT_SIBLING):
 204                 man->last->next = p;
 205                 p->prev = man->last;
 206                 p->parent = man->last->parent;
 207                 break;
 208         case (MAN_NEXT_CHILD):
 209                 man->last->child = p;
 210                 p->parent = man->last;
 211                 break;
 212         default:
 213                 abort();
 214                 /* NOTREACHED */
 215         }
 216
 217         p->parent->nchild++;
 218
 219         if ( ! man_valid_pre(man, p))
 220                 return(0);
 221
 222         switch (p->type) {
 223         case (MAN_HEAD):
 224                 assert(MAN_BLOCK == p->parent->type);
 225                 p->parent->head = p;
 226                 break;
 227         case (MAN_BODY):
 228                 assert(MAN_BLOCK == p->parent->type);
 229                 p->parent->body = p;
 230                 break;
 231         default:
 232                 break;
 233         }
 234
 235         man->last = p;
 236
 237         switch (p->type) {
 238         case (MAN_TEXT):
 239                 if ( ! man_valid_post(man))
 240                         return(0);
 241                 if ( ! man_action_post(man))
 242                         return(0);
 243                 break;
 244         default:
 245                 break;
 246         }
 247
 248         return(1);
 249 }
 250
 251
 252 static struct man_node *
 253 man_node_alloc(int line, int pos, enum man_type type, int tok)
 254 {
 255         struct man_node *p;
 256
 257         p = calloc(1, sizeof(struct man_node));
 258         if (NULL == p)
 259                 return(NULL);
 260
 261         p->line = line;
 262         p->pos = pos;
 263         p->type = type;
 264         p->tok = tok;
 265         return(p);
 266 }
 267
 268
 269 int
 270 man_elem_alloc(struct man *m, int line, int pos, int tok)
 271 {
 272         struct man_node *p;
 273
 274         p = man_node_alloc(line, pos, MAN_ELEM, tok);
 275         if (NULL == p)
 276                 return(0);
 277         if ( ! man_node_append(m, p))
 278                 return(0);
 279         m->next = MAN_NEXT_CHILD;
 280         return(1);
 281 }
 282
 283
 284 int
 285 man_head_alloc(struct man *m, int line, int pos, int tok)
 286 {
 287         struct man_node *p;
 288
 289         p = man_node_alloc(line, pos, MAN_HEAD, tok);
 290         if (NULL == p)
 291                 return(0);
 292         if ( ! man_node_append(m, p))
 293                 return(0);
 294         m->next = MAN_NEXT_CHILD;
 295         return(1);
 296 }
 297
 298
 299 int
 300 man_body_alloc(struct man *m, int line, int pos, int tok)
 301 {
 302         struct man_node *p;
 303
 304         p = man_node_alloc(line, pos, MAN_BODY, tok);
 305         if (NULL == p)
 306                 return(0);
 307         if ( ! man_node_append(m, p))
 308                 return(0);
 309         m->next = MAN_NEXT_CHILD;
 310         return(1);
 311 }
 312
 313
 314 int
 315 man_block_alloc(struct man *m, int line, int pos, int tok)
 316 {
 317         struct man_node *p;
 318
 319         p = man_node_alloc(line, pos, MAN_BLOCK, tok);
 320         if (NULL == p)
 321                 return(0);
 322         if ( ! man_node_append(m, p))
 323                 return(0);
 324         m->next = MAN_NEXT_CHILD;
 325         return(1);
 326 }
 327
 328
 329 static int
 330 pstring(struct man *m, int line, int pos,
 331                 const char *p, size_t len)
 332 {
 333         struct man_node *n;
 334         size_t           sv;
 335
 336         n = man_node_alloc(line, pos, MAN_TEXT, -1);
 337         if (NULL == n)
 338                 return(0);
 339
 340         n->string = malloc(len + 1);
 341         if (NULL == n->string) {
 342                 free(n);
 343                 return(0);
 344         }
 345
 346         sv = strlcpy(n->string, p, len + 1);
 347
 348         /* Prohibit truncation. */
 349         assert(sv < len + 1);
 350
 351         if ( ! man_node_append(m, n))
 352                 return(0);
 353         m->next = MAN_NEXT_SIBLING;
 354         return(1);
 355 }
 356
 357
 358 int
 359 man_word_alloc(struct man *m, int line, int pos, const char *word)
 360 {
 361
 362         return(pstring(m, line, pos, word, strlen(word)));
 363 }
 364
 365
 366 void
 367 man_node_free(struct man_node *p)
 368 {
 369
 370         if (p->string)
 371                 free(p->string);
 372         if (p->parent)
 373                 p->parent->nchild--;
 374         free(p);
 375 }
 376
 377
 378 void
 379 man_node_freelist(struct man_node *p)
 380 {
 381
 382         if (p->child)
 383                 man_node_freelist(p->child);
 384         if (p->next)
 385                 man_node_freelist(p->next);
 386
 387         assert(0 == p->nchild);
 388         man_node_free(p);
 389 }
 390
 391
 392 static int
 393 man_ptext(struct man *m, int line, char *buf)
 394 {
 395         int              i, j;
 396
 397         /* Literal free-form text whitespace is preserved. */
 398
 399         if (MAN_LITERAL & m->flags) {
 400                 if ( ! man_word_alloc(m, line, 0, buf))
 401                         return(0);
 402                 goto descope;
 403         }
 404
 405         /* First de-chunk and allocate words. */
 406
 407         for (i = 0; ' ' == buf[i]; i++)
 408                 /* Skip leading whitespace. */ ;
 409         if (0 == buf[i]) {
 410                 if ( ! pstring(m, line, 0, &buf[i], 0))
 411                         return(0);
 412                 goto descope;
 413         }
 414
 415         for (j = i; buf[i]; i++) {
 416                 if (' ' != buf[i])
 417                         continue;
 418
 419                 /* Escaped whitespace. */
 420                 if (i && ' ' == buf[i] && '\\' == buf[i - 1])
 421                         continue;
 422
 423                 buf[i++] = 0;
 424                 if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
 425                         return(0);
 426
 427                 for ( ; ' ' == buf[i]; i++)
 428                         /* Skip trailing whitespace. */ ;
 429
 430                 j = i;
 431                 if (0 == buf[i])
 432                         break;
 433         }
 434
 435         if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
 436                 return(0);
 437
 438 descope:
 439
 440         /*
 441          * Co-ordinate what happens with having a next-line scope open:
 442          * first close out the element scope (if applicable), then close
 443          * out the block scope (also if applicable).
 444          */
 445
 446         if (MAN_ELINE & m->flags) {
 447                 m->flags &= ~MAN_ELINE;
 448                 if ( ! man_unscope(m, m->last->parent))
 449                         return(0);
 450         }
 451
 452         if ( ! (MAN_BLINE & m->flags))
 453                 return(1);
 454         m->flags &= ~MAN_BLINE;
 455
 456         if ( ! man_unscope(m, m->last->parent))
 457                 return(0);
 458         return(man_body_alloc(m, line, 0, m->last->tok));
 459 }
 460
 461
 462 int
 463 man_pmacro(struct man *m, int ln, char *buf)
 464 {
 465         int              i, j, c, ppos, fl;
 466         char             mac[5];
 467         struct man_node *n;
 468
 469         /* Comments and empties are quickly ignored. */
 470
 471         fl = m->flags;
 472
 473         if (0 == buf[1])
 474                 goto out;
 475
 476         i = 1;
 477
 478         if (' ' == buf[i]) {
 479                 i++;
 480                 while (buf[i] && ' ' == buf[i])
 481                         i++;
 482                 if (0 == buf[i])
 483                         goto out;
 484         }
 485
 486         ppos = i;
 487
 488         /* Copy the first word into a nil-terminated buffer. */
 489
 490         for (j = 0; j < 4; j++, i++) {
 491                 if (0 == (mac[j] = buf[i]))
 492                         break;
 493                 else if (' ' == buf[i])
 494                         break;
 495         }
 496
 497         mac[j] = 0;
 498
 499         if (j == 4 || j < 1) {
 500                 if ( ! (MAN_IGN_MACRO & m->pflags)) {
 501                         (void)man_perr(m, ln, ppos, WMACROFORM);
 502                         goto err;
 503                 }
 504                 if ( ! man_pwarn(m, ln, ppos, WMACROFORM))
 505                         goto err;
 506                 return(1);
 507         }
 508
 509         if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {
 510                 if ( ! (MAN_IGN_MACRO & m->pflags)) {
 511                         (void)man_perr(m, ln, ppos, WMACRO);
 512                         goto err;
 513                 }
 514                 if ( ! man_pwarn(m, ln, ppos, WMACRO))
 515                         goto err;
 516                 return(1);
 517         }
 518
 519         /* The macro is sane.  Jump to the next word. */
 520
 521         while (buf[i] && ' ' == buf[i])
 522                 i++;
 523
 524         /* Remove prior ELINE macro, if applicable. */
 525
 526         if (m->flags & MAN_ELINE) {
 527                 n = m->last;
 528                 assert(NULL == n->child);
 529                 if ( ! man_nwarn(m, n, WLNSCOPE))
 530                         return(0);
 531
 532                 if (n->prev) {
 533                         assert(n != n->parent->child);
 534                         assert(n == n->prev->next);
 535                         n->prev->next = NULL;
 536                         m->last = n->prev;
 537                 } else {
 538                         assert(n == n->parent->child);
 539                         n->parent->child = NULL;
 540                         m->last = n->parent;
 541                 }
 542
 543                 man_node_free(n);
 544                 m->flags &= ~MAN_ELINE;
 545         }
 546
 547         /* Begin recursive parse sequence. */
 548
 549         assert(man_macros[c].fp);
 550
 551         if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf))
 552                 goto err;
 553
 554 out:
 555         if ( ! (MAN_BLINE & fl))
 556                 return(1);
 557
 558         /*
 559          * If we've opened a new next-line element scope, then return
 560          * now, as the next line will close out the block scope.
 561          */
 562
 563         if (MAN_ELINE & m->flags)
 564                 return(1);
 565
 566         /* Close out the block scope opened in the prior line.  */
 567
 568         assert(MAN_BLINE & m->flags);
 569         m->flags &= ~MAN_BLINE;
 570
 571         if ( ! man_unscope(m, m->last->parent))
 572                 return(0);
 573         return(man_body_alloc(m, ln, 0, m->last->tok));
 574
 575 err:    /* Error out. */
 576
 577         m->flags |= MAN_HALT;
 578         return(0);
 579 }
 580
 581
 582 int
 583 man_verr(struct man *man, int ln, int pos, const char *fmt, ...)
 584 {
 585         char             buf[256];
 586         va_list          ap;
 587
 588         if (NULL == man->cb.man_err)
 589                 return(0);
 590
 591         va_start(ap, fmt);
 592         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
 593         va_end(ap);
 594         return((*man->cb.man_err)(man->data, ln, pos, buf));
 595 }
 596
 597
 598 int
 599 man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...)
 600 {
 601         char             buf[256];
 602         va_list          ap;
 603
 604         if (NULL == man->cb.man_warn)
 605                 return(0);
 606
 607         va_start(ap, fmt);
 608         (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
 609         va_end(ap);
 610         return((*man->cb.man_warn)(man->data, ln, pos, buf));
 611 }
 612
 613
 614 int
 615 man_err(struct man *m, int line, int pos, int iserr, enum merr type)
 616 {
 617         const char       *p;
 618
 619         p = __man_merrnames[(int)type];
 620         assert(p);
 621
 622         if (iserr)
 623                 return(man_verr(m, line, pos, p));
 624
 625         return(man_vwarn(m, line, pos, p));
 626 }