roff_validate.c

   1 /*      $Id: roff_validate.c,v 1.11 2018/12/04 02:53:51 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2010, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
   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 <sys/types.h>
  18
  19 #include <assert.h>
  20 #include <stddef.h>
  21 #include <string.h>
  22
  23 #include "mandoc.h"
  24 #include "roff.h"
  25 #include "libmandoc.h"
  26 #include "roff_int.h"
  27
  28 #define ROFF_VALID_ARGS struct roff_man *man, struct roff_node *n
  29
  30 typedef void    (*roff_valid_fp)(ROFF_VALID_ARGS);
  31
  32 static  void      roff_valid_br(ROFF_VALID_ARGS);
  33 static  void      roff_valid_ft(ROFF_VALID_ARGS);
  34 static  void      roff_valid_sp(ROFF_VALID_ARGS);
  35
  36 static  const roff_valid_fp roff_valids[ROFF_MAX] = {
  37         roff_valid_br,  /* br */
  38         NULL,  /* ce */
  39         roff_valid_ft,  /* ft */
  40         NULL,  /* ll */
  41         NULL,  /* mc */
  42         NULL,  /* po */
  43         NULL,  /* rj */
  44         roff_valid_sp,  /* sp */
  45         NULL,  /* ta */
  46         NULL,  /* ti */
  47 };
  48
  49
  50 void
  51 roff_validate(struct roff_man *man)
  52 {
  53         struct roff_node        *n;
  54
  55         n = man->last;
  56         assert(n->tok < ROFF_MAX);
  57         if (roff_valids[n->tok] != NULL)
  58                 (*roff_valids[n->tok])(man, n);
  59 }
  60
  61 static void
  62 roff_valid_br(ROFF_VALID_ARGS)
  63 {
  64         struct roff_node        *np;
  65
  66         if (n->child != NULL)
  67                 mandoc_vmsg(MANDOCERR_ARG_SKIP, man->parse,
  68                     n->line, n->pos, "br %s", n->child->string);
  69
  70         if ((np = n->prev) == NULL)
  71                 return;
  72
  73         switch (np->tok) {
  74         case ROFF_br:
  75         case ROFF_sp:
  76         case MDOC_Pp:
  77                 mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse,
  78                     n->line, n->pos, "br after %s", roff_name[np->tok]);
  79                 roff_node_delete(man, n);
  80                 break;
  81         default:
  82                 break;
  83         }
  84 }
  85
  86 static void
  87 roff_valid_ft(ROFF_VALID_ARGS)
  88 {
  89         const char              *cp;
  90
  91         if (n->child == NULL) {
  92                 man->next = ROFF_NEXT_CHILD;
  93                 roff_word_alloc(man, n->line, n->pos, "P");
  94                 man->last = n;
  95                 return;
  96         }
  97
  98         cp = n->child->string;
  99         switch (*cp) {
 100         case '1':
 101         case '2':
 102         case '3':
 103         case '4':
 104         case 'I':
 105         case 'P':
 106         case 'R':
 107                 if (cp[1] == '\0')
 108                         return;
 109                 break;
 110         case 'B':
 111                 if (cp[1] == '\0' || (cp[1] == 'I' && cp[2] == '\0'))
 112                         return;
 113                 break;
 114         case 'C':
 115                 if (cp[1] != '\0' && cp[2] == '\0' &&
 116                     strchr("BIRW", cp[1]) != NULL)
 117                         return;
 118                 break;
 119         default:
 120                 break;
 121         }
 122
 123         mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
 124             n->line, n->pos, "ft %s", cp);
 125         roff_node_delete(man, n);
 126 }
 127
 128 static void
 129 roff_valid_sp(ROFF_VALID_ARGS)
 130 {
 131         struct roff_node        *np;
 132
 133         if (n->child != NULL && n->child->next != NULL)
 134                 mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
 135                     n->child->next->line, n->child->next->pos,
 136                     "sp ... %s", n->child->next->string);
 137
 138         if ((np = n->prev) == NULL)
 139                 return;
 140
 141         switch (np->tok) {
 142         case ROFF_br:
 143                 mandoc_msg(MANDOCERR_PAR_SKIP, man->parse,
 144                     np->line, np->pos, "br before sp");
 145                 roff_node_delete(man, np);
 146                 break;
 147         case MDOC_Pp:
 148                 mandoc_msg(MANDOCERR_PAR_SKIP, man->parse,
 149                     n->line, n->pos, "sp after Pp");
 150                 roff_node_delete(man, n);
 151                 break;
 152         default:
 153                 break;
 154         }
 155 }