mdoc.c

   1 /*      $Id: mdoc.c,v 1.269 2018/08/17 20:33:37 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2010, 2012-2018 Ingo Schwarze <schwarze@openbsd.org>
   5  *
   6  * Permission to use, copy, modify, and distribute this software for any
   7  * purpose with or without fee is hereby granted, provided that the above
   8  * copyright notice and this permission notice appear in all copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  */
  18 #include "config.h"
  19
  20 #include <sys/types.h>
  21
  22 #include <assert.h>
  23 #include <ctype.h>
  24 #include <stdarg.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <time.h>
  29
  30 #include "mandoc_aux.h"
  31 #include "mandoc.h"
  32 #include "roff.h"
  33 #include "mdoc.h"
  34 #include "libmandoc.h"
  35 #include "roff_int.h"
  36 #include "libmdoc.h"
  37
  38 const   char *const __mdoc_argnames[MDOC_ARG_MAX] = {
  39         "split",                "nosplit",              "ragged",
  40         "unfilled",             "literal",              "file",
  41         "offset",               "bullet",               "dash",
  42         "hyphen",               "item",                 "enum",
  43         "tag",                  "diag",                 "hang",
  44         "ohang",                "inset",                "column",
  45         "width",                "compact",              "std",
  46         "filled",               "words",                "emphasis",
  47         "symbolic",             "nested",               "centered"
  48 };
  49 const   char * const *mdoc_argnames = __mdoc_argnames;
  50
  51 static  int               mdoc_ptext(struct roff_man *, int, char *, int);
  52 static  int               mdoc_pmacro(struct roff_man *, int, char *, int);
  53
  54
  55 /*
  56  * Main parse routine.  Parses a single line -- really just hands off to
  57  * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
  58  */
  59 int
  60 mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs)
  61 {
  62
  63         if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
  64                 mdoc->flags |= MDOC_NEWLINE;
  65
  66         /*
  67          * Let the roff nS register switch SYNOPSIS mode early,
  68          * such that the parser knows at all times
  69          * whether this mode is on or off.
  70          * Note that this mode is also switched by the Sh macro.
  71          */
  72         if (roff_getreg(mdoc->roff, "nS"))
  73                 mdoc->flags |= MDOC_SYNOPSIS;
  74         else
  75                 mdoc->flags &= ~MDOC_SYNOPSIS;
  76
  77         return roff_getcontrol(mdoc->roff, buf, &offs) ?
  78             mdoc_pmacro(mdoc, ln, buf, offs) :
  79             mdoc_ptext(mdoc, ln, buf, offs);
  80 }
  81
  82 void
  83 mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, enum roff_tok tok)
  84 {
  85         struct roff_node *p;
  86
  87         p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
  88         roff_node_append(mdoc, p);
  89         mdoc->next = ROFF_NEXT_CHILD;
  90 }
  91
  92 struct roff_node *
  93 mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos,
  94     enum roff_tok tok, struct roff_node *body)
  95 {
  96         struct roff_node *p;
  97
  98         body->flags |= NODE_ENDED;
  99         body->parent->flags |= NODE_ENDED;
 100         p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
 101         p->body = body;
 102         p->norm = body->norm;
 103         p->end = ENDBODY_SPACE;
 104         roff_node_append(mdoc, p);
 105         mdoc->next = ROFF_NEXT_SIBLING;
 106         return p;
 107 }
 108
 109 struct roff_node *
 110 mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
 111     enum roff_tok tok, struct mdoc_arg *args)
 112 {
 113         struct roff_node *p;
 114
 115         p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
 116         p->args = args;
 117         if (p->args)
 118                 (args->refcnt)++;
 119
 120         switch (tok) {
 121         case MDOC_Bd:
 122         case MDOC_Bf:
 123         case MDOC_Bl:
 124         case MDOC_En:
 125         case MDOC_Rs:
 126                 p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
 127                 break;
 128         default:
 129                 break;
 130         }
 131         roff_node_append(mdoc, p);
 132         mdoc->next = ROFF_NEXT_CHILD;
 133         return p;
 134 }
 135
 136 void
 137 mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
 138      enum roff_tok tok, struct mdoc_arg *args)
 139 {
 140         struct roff_node *p;
 141
 142         p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
 143         p->args = args;
 144         if (p->args)
 145                 (args->refcnt)++;
 146
 147         switch (tok) {
 148         case MDOC_An:
 149                 p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
 150                 break;
 151         default:
 152                 break;
 153         }
 154         roff_node_append(mdoc, p);
 155         mdoc->next = ROFF_NEXT_CHILD;
 156 }
 157
 158 void
 159 mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)
 160 {
 161
 162         roff_node_unlink(mdoc, p);
 163         p->prev = p->next = NULL;
 164         roff_node_append(mdoc, p);
 165 }
 166
 167 /*
 168  * Parse free-form text, that is, a line that does not begin with the
 169  * control character.
 170  */
 171 static int
 172 mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
 173 {
 174         struct roff_node *n;
 175         const char       *cp, *sp;
 176         char             *c, *ws, *end;
 177
 178         n = mdoc->last;
 179
 180         /*
 181          * If a column list contains plain text, assume an implicit item
 182          * macro.  This can happen one or more times at the beginning
 183          * of such a list, intermixed with non-It mdoc macros and with
 184          * nodes generated on the roff level, for example by tbl.
 185          */
 186
 187         if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
 188              n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
 189             (n->parent != NULL && n->parent->tok == MDOC_Bl &&
 190              n->parent->norm->Bl.type == LIST_column)) {
 191                 mdoc->flags |= MDOC_FREECOL;
 192                 (*mdoc_macro(MDOC_It)->fp)(mdoc, MDOC_It,
 193                     line, offs, &offs, buf);
 194                 return 1;
 195         }
 196
 197         /*
 198          * Search for the beginning of unescaped trailing whitespace (ws)
 199          * and for the first character not to be output (end).
 200          */
 201
 202         /* FIXME: replace with strcspn(). */
 203         ws = NULL;
 204         for (c = end = buf + offs; *c; c++) {
 205                 switch (*c) {
 206                 case ' ':
 207                         if (NULL == ws)
 208                                 ws = c;
 209                         continue;
 210                 case '\t':
 211                         /*
 212                          * Always warn about trailing tabs,
 213                          * even outside literal context,
 214                          * where they should be put on the next line.
 215                          */
 216                         if (NULL == ws)
 217                                 ws = c;
 218                         /*
 219                          * Strip trailing tabs in literal context only;
 220                          * outside, they affect the next line.
 221                          */
 222                         if (MDOC_LITERAL & mdoc->flags)
 223                                 continue;
 224                         break;
 225                 case '\\':
 226                         /* Skip the escaped character, too, if any. */
 227                         if (c[1])
 228                                 c++;
 229                         /* FALLTHROUGH */
 230                 default:
 231                         ws = NULL;
 232                         break;
 233                 }
 234                 end = c + 1;
 235         }
 236         *end = '\0';
 237
 238         if (ws)
 239                 mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
 240                     line, (int)(ws-buf), NULL);
 241
 242         /*
 243          * Blank lines are allowed in no-fill mode
 244          * and cancel preceding \c,
 245          * but add a single vertical space elsewhere.
 246          */
 247
 248         if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
 249                 switch (mdoc->last->type) {
 250                 case ROFFT_TEXT:
 251                         sp = mdoc->last->string;
 252                         cp = end = strchr(sp, '\0') - 2;
 253                         if (cp < sp || cp[0] != '\\' || cp[1] != 'c')
 254                                 break;
 255                         while (cp > sp && cp[-1] == '\\')
 256                                 cp--;
 257                         if ((end - cp) % 2)
 258                                 break;
 259                         *end = '\0';
 260                         return 1;
 261                 default:
 262                         break;
 263                 }
 264                 mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
 265                     line, (int)(c - buf), NULL);
 266                 roff_elem_alloc(mdoc, line, offs, ROFF_sp);
 267                 mdoc->last->flags |= NODE_VALID | NODE_ENDED;
 268                 mdoc->next = ROFF_NEXT_SIBLING;
 269                 return 1;
 270         }
 271
 272         roff_word_alloc(mdoc, line, offs, buf+offs);
 273
 274         if (mdoc->flags & MDOC_LITERAL)
 275                 return 1;
 276
 277         /*
 278          * End-of-sentence check.  If the last character is an unescaped
 279          * EOS character, then flag the node as being the end of a
 280          * sentence.  The front-end will know how to interpret this.
 281          */
 282
 283         assert(buf < end);
 284
 285         if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
 286                 mdoc->last->flags |= NODE_EOS;
 287
 288         for (c = buf + offs; c != NULL; c = strchr(c + 1, '.')) {
 289                 if (c - buf < offs + 2)
 290                         continue;
 291                 if (end - c < 3)
 292                         break;
 293                 if (c[1] != ' ' ||
 294                     isalnum((unsigned char)c[-2]) == 0 ||
 295                     isalnum((unsigned char)c[-1]) == 0 ||
 296                     (c[-2] == 'n' && c[-1] == 'c') ||
 297                     (c[-2] == 'v' && c[-1] == 's'))
 298                         continue;
 299                 c += 2;
 300                 if (*c == ' ')
 301                         c++;
 302                 if (*c == ' ')
 303                         c++;
 304                 if (isupper((unsigned char)(*c)))
 305                         mandoc_msg(MANDOCERR_EOS, mdoc->parse,
 306                             line, (int)(c - buf), NULL);
 307         }
 308
 309         return 1;
 310 }
 311
 312 /*
 313  * Parse a macro line, that is, a line beginning with the control
 314  * character.
 315  */
 316 static int
 317 mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)
 318 {
 319         struct roff_node *n;
 320         const char       *cp;
 321         size_t            sz;
 322         enum roff_tok     tok;
 323         int               sv;
 324
 325         /* Determine the line macro. */
 326
 327         sv = offs;
 328         tok = TOKEN_NONE;
 329         for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
 330                 offs++;
 331         if (sz == 2 || sz == 3)
 332                 tok = roffhash_find(mdoc->mdocmac, buf + sv, sz);
 333         if (tok == TOKEN_NONE) {
 334                 mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
 335                     ln, sv, buf + sv - 1);
 336                 return 1;
 337         }
 338
 339         /* Skip a leading escape sequence or tab. */
 340
 341         switch (buf[offs]) {
 342         case '\\':
 343                 cp = buf + offs + 1;
 344                 mandoc_escape(&cp, NULL, NULL);
 345                 offs = cp - buf;
 346                 break;
 347         case '\t':
 348                 offs++;
 349                 break;
 350         default:
 351                 break;
 352         }
 353
 354         /* Jump to the next non-whitespace word. */
 355
 356         while (buf[offs] == ' ')
 357                 offs++;
 358
 359         /*
 360          * Trailing whitespace.  Note that tabs are allowed to be passed
 361          * into the parser as "text", so we only warn about spaces here.
 362          */
 363
 364         if ('\0' == buf[offs] && ' ' == buf[offs - 1])
 365                 mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
 366                     ln, offs - 1, NULL);
 367
 368         /*
 369          * If an initial macro or a list invocation, divert directly
 370          * into macro processing.
 371          */
 372
 373         n = mdoc->last;
 374         if (n == NULL || tok == MDOC_It || tok == MDOC_El) {
 375                 (*mdoc_macro(tok)->fp)(mdoc, tok, ln, sv, &offs, buf);
 376                 return 1;
 377         }
 378
 379         /*
 380          * If a column list contains a non-It macro, assume an implicit
 381          * item macro.  This can happen one or more times at the
 382          * beginning of such a list, intermixed with text lines and
 383          * with nodes generated on the roff level, for example by tbl.
 384          */
 385
 386         if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
 387              n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
 388             (n->parent != NULL && n->parent->tok == MDOC_Bl &&
 389              n->parent->norm->Bl.type == LIST_column)) {
 390                 mdoc->flags |= MDOC_FREECOL;
 391                 (*mdoc_macro(MDOC_It)->fp)(mdoc, MDOC_It, ln, sv, &sv, buf);
 392                 return 1;
 393         }
 394
 395         /* Normal processing of a macro. */
 396
 397         (*mdoc_macro(tok)->fp)(mdoc, tok, ln, sv, &offs, buf);
 398
 399         /* In quick mode (for mandocdb), abort after the NAME section. */
 400
 401         if (mdoc->quick && MDOC_Sh == tok &&
 402             SEC_NAME != mdoc->last->sec)
 403                 return 2;
 404
 405         return 1;
 406 }
 407
 408 enum mdelim
 409 mdoc_isdelim(const char *p)
 410 {
 411
 412         if ('\0' == p[0])
 413                 return DELIM_NONE;
 414
 415         if ('\0' == p[1])
 416                 switch (p[0]) {
 417                 case '(':
 418                 case '[':
 419                         return DELIM_OPEN;
 420                 case '|':
 421                         return DELIM_MIDDLE;
 422                 case '.':
 423                 case ',':
 424                 case ';':
 425                 case ':':
 426                 case '?':
 427                 case '!':
 428                 case ')':
 429                 case ']':
 430                         return DELIM_CLOSE;
 431                 default:
 432                         return DELIM_NONE;
 433                 }
 434
 435         if ('\\' != p[0])
 436                 return DELIM_NONE;
 437
 438         if (0 == strcmp(p + 1, "."))
 439                 return DELIM_CLOSE;
 440         if (0 == strcmp(p + 1, "fR|\\fP"))
 441                 return DELIM_MIDDLE;
 442
 443         return DELIM_NONE;
 444 }
 445
 446 void
 447 mdoc_validate(struct roff_man *mdoc)
 448 {
 449
 450         mdoc->last = mdoc->first;
 451         mdoc_node_validate(mdoc);
 452         mdoc_state_reset(mdoc);
 453 }