man_validate.c

   1 /*      $Id: man_validate.c,v 1.38 2010/05/15 20:51:40 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 #include <sys/types.h>
  22
  23 #include <assert.h>
  24 #include <ctype.h>
  25 #include <errno.h>
  26 #include <limits.h>
  27 #include <stdarg.h>
  28 #include <stdlib.h>
  29
  30 #include "libman.h"
  31 #include "libmandoc.h"
  32
  33 #define CHKARGS   struct man *m, const struct man_node *n
  34
  35 typedef int     (*v_check)(CHKARGS);
  36
  37 struct  man_valid {
  38         v_check  *pres;
  39         v_check  *posts;
  40 };
  41
  42 static  int       check_bline(CHKARGS);
  43 static  int       check_eq0(CHKARGS);
  44 static  int       check_le1(CHKARGS);
  45 static  int       check_ge2(CHKARGS);
  46 static  int       check_le5(CHKARGS);
  47 static  int       check_par(CHKARGS);
  48 static  int       check_part(CHKARGS);
  49 static  int       check_roff(CHKARGS);
  50 static  int       check_root(CHKARGS);
  51 static  int       check_sec(CHKARGS);
  52 static  int       check_text(CHKARGS);
  53 static  int       check_title(CHKARGS);
  54
  55 static  v_check   posts_eq0[] = { check_eq0, NULL };
  56 static  v_check   posts_th[] = { check_ge2, check_le5, check_title, NULL };
  57 static  v_check   posts_par[] = { check_par, NULL };
  58 static  v_check   posts_part[] = { check_part, NULL };
  59 static  v_check   posts_sec[] = { check_sec, NULL };
  60 static  v_check   posts_le1[] = { check_le1, NULL };
  61 static  v_check   pres_bline[] = { check_bline, NULL };
  62 static  v_check   pres_roff[] = { check_roff, NULL };
  63
  64 static  const struct man_valid man_valids[MAN_MAX] = {
  65         { NULL, posts_eq0 }, /* br */
  66         { pres_bline, posts_th }, /* TH */
  67         { pres_bline, posts_sec }, /* SH */
  68         { pres_bline, posts_sec }, /* SS */
  69         { pres_bline, posts_par }, /* TP */
  70         { pres_bline, posts_par }, /* LP */
  71         { pres_bline, posts_par }, /* PP */
  72         { pres_bline, posts_par }, /* P */
  73         { pres_bline, posts_par }, /* IP */
  74         { pres_bline, posts_par }, /* HP */
  75         { NULL, NULL }, /* SM */
  76         { NULL, NULL }, /* SB */
  77         { NULL, NULL }, /* BI */
  78         { NULL, NULL }, /* IB */
  79         { NULL, NULL }, /* BR */
  80         { NULL, NULL }, /* RB */
  81         { NULL, NULL }, /* R */
  82         { NULL, NULL }, /* B */
  83         { NULL, NULL }, /* I */
  84         { NULL, NULL }, /* IR */
  85         { NULL, NULL }, /* RI */
  86         { NULL, posts_eq0 }, /* na */
  87         { NULL, NULL }, /* i */
  88         { NULL, posts_le1 }, /* sp */
  89         { pres_bline, posts_eq0 }, /* nf */
  90         { pres_bline, posts_eq0 }, /* fi */
  91         { NULL, NULL }, /* r */
  92         { NULL, NULL }, /* RE */
  93         { NULL, posts_part }, /* RS */
  94         { NULL, NULL }, /* DT */
  95         { NULL, NULL }, /* UC */
  96         { NULL, NULL }, /* PD */
  97         { NULL, posts_le1 }, /* Sp */
  98         { pres_bline, posts_le1 }, /* Vb */
  99         { pres_bline, posts_eq0 }, /* Ve */
 100         { pres_roff, NULL }, /* de */
 101         { pres_roff, NULL }, /* dei */
 102         { pres_roff, NULL }, /* am */
 103         { pres_roff, NULL }, /* ami */
 104         { NULL, NULL }, /* . */
 105 };
 106
 107
 108 int
 109 man_valid_pre(struct man *m, const struct man_node *n)
 110 {
 111         v_check         *cp;
 112
 113         if (MAN_TEXT == n->type)
 114                 return(1);
 115         if (MAN_ROOT == n->type)
 116                 return(1);
 117
 118         if (NULL == (cp = man_valids[n->tok].pres))
 119                 return(1);
 120         for ( ; *cp; cp++)
 121                 if ( ! (*cp)(m, n))
 122                         return(0);
 123         return(1);
 124 }
 125
 126
 127 int
 128 man_valid_post(struct man *m)
 129 {
 130         v_check         *cp;
 131
 132         if (MAN_VALID & m->last->flags)
 133                 return(1);
 134         m->last->flags |= MAN_VALID;
 135
 136         switch (m->last->type) {
 137         case (MAN_TEXT):
 138                 return(check_text(m, m->last));
 139         case (MAN_ROOT):
 140                 return(check_root(m, m->last));
 141         default:
 142                 break;
 143         }
 144
 145         if (NULL == (cp = man_valids[m->last->tok].posts))
 146                 return(1);
 147         for ( ; *cp; cp++)
 148                 if ( ! (*cp)(m, m->last))
 149                         return(0);
 150
 151         return(1);
 152 }
 153
 154
 155 static int
 156 check_root(CHKARGS)
 157 {
 158
 159         if (MAN_BLINE & m->flags)
 160                 return(man_nwarn(m, n, WEXITSCOPE));
 161         if (MAN_ELINE & m->flags)
 162                 return(man_nwarn(m, n, WEXITSCOPE));
 163
 164         m->flags &= ~MAN_BLINE;
 165         m->flags &= ~MAN_ELINE;
 166
 167         if (NULL == m->first->child)
 168                 return(man_nerr(m, n, WNODATA));
 169         if (NULL == m->meta.title) {
 170                 if ( ! man_nwarn(m, n, WNOTITLE))
 171                         return(0);
 172                 /*
 173                  * If a title hasn't been set, do so now (by
 174                  * implication, date and section also aren't set).
 175                  *
 176                  * FIXME: this should be in man_action.c.
 177                  */
 178                 m->meta.title = mandoc_strdup("unknown");
 179                 m->meta.date = time(NULL);
 180                 m->meta.msec = mandoc_strdup("1");
 181         }
 182
 183         return(1);
 184 }
 185
 186
 187 static int
 188 check_title(CHKARGS)
 189 {
 190         const char      *p;
 191
 192         assert(n->child);
 193         if ('\0' == *n->child->string)
 194                 return(man_nerr(m, n, WNOTITLE));
 195
 196         for (p = n->child->string; '\0' != *p; p++)
 197                 if (isalpha((u_char)*p) && ! isupper((u_char)*p))
 198                         if ( ! man_nwarn(m, n, WTITLECASE))
 199                                 return(0);
 200
 201         return(1);
 202 }
 203
 204
 205 static int
 206 check_text(CHKARGS)
 207 {
 208         const char      *p;
 209         int              pos, c;
 210
 211         assert(n->string);
 212
 213         for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
 214                 if ('\\' == *p) {
 215                         c = mandoc_special(p);
 216                         if (c) {
 217                                 p += c - 1;
 218                                 pos += c - 1;
 219                                 continue;
 220                         }
 221                         if ( ! (MAN_IGN_ESCAPE & m->pflags))
 222                                 return(man_perr(m, n->line, pos, WESCAPE));
 223                         if ( ! man_pwarn(m, n->line, pos, WESCAPE))
 224                                 return(0);
 225                         continue;
 226                 }
 227
 228                 if ('\t' == *p || isprint((u_char)*p))
 229                         continue;
 230
 231                 return(man_pwarn(m, n->line, pos, WNPRINT));
 232         }
 233
 234         return(1);
 235 }
 236
 237
 238 #define INEQ_DEFINE(x, ineq, name) \
 239 static int \
 240 check_##name(CHKARGS) \
 241 { \
 242         if (n->nchild ineq (x)) \
 243                 return(1); \
 244         return(man_verr(m, n->line, n->pos, \
 245                         "expected line arguments %s %d, have %d", \
 246                         #ineq, (x), n->nchild)); \
 247 }
 248
 249 INEQ_DEFINE(0, ==, eq0)
 250 INEQ_DEFINE(1, <=, le1)
 251 INEQ_DEFINE(2, >=, ge2)
 252 INEQ_DEFINE(5, <=, le5)
 253
 254
 255 static int
 256 check_sec(CHKARGS)
 257 {
 258
 259         if (MAN_BODY == n->type && 0 == n->nchild)
 260                 return(man_nwarn(m, n, WBODYARGS));
 261         if (MAN_HEAD == n->type && 0 == n->nchild)
 262                 return(man_nerr(m, n, WHEADARGS));
 263         return(1);
 264 }
 265
 266
 267 static int
 268 check_part(CHKARGS)
 269 {
 270
 271         if (MAN_BODY == n->type && 0 == n->nchild)
 272                 return(man_nwarn(m, n, WBODYARGS));
 273         return(1);
 274 }
 275
 276
 277 static int
 278 check_par(CHKARGS)
 279 {
 280
 281         if (MAN_BODY == n->type)
 282                 switch (n->tok) {
 283                 case (MAN_IP):
 284                         /* FALLTHROUGH */
 285                 case (MAN_HP):
 286                         /* FALLTHROUGH */
 287                 case (MAN_TP):
 288                         /* Body-less lists are ok. */
 289                         break;
 290                 default:
 291                         if (n->nchild)
 292                                 break;
 293                         return(man_nwarn(m, n, WBODYARGS));
 294                 }
 295         if (MAN_HEAD == n->type)
 296                 switch (n->tok) {
 297                 case (MAN_PP):
 298                         /* FALLTHROUGH */
 299                 case (MAN_P):
 300                         /* FALLTHROUGH */
 301                 case (MAN_LP):
 302                         if (0 == n->nchild)
 303                                 break;
 304                         return(man_nwarn(m, n, WNHEADARGS));
 305                 default:
 306                         if (n->nchild)
 307                                 break;
 308                         return(man_nwarn(m, n, WHEADARGS));
 309                 }
 310
 311         return(1);
 312 }
 313
 314
 315 static int
 316 check_bline(CHKARGS)
 317 {
 318
 319         assert( ! (MAN_ELINE & m->flags));
 320         if (MAN_BLINE & m->flags)
 321                 return(man_nerr(m, n, WLNSCOPE));
 322
 323         return(1);
 324 }
 325
 326
 327 static int
 328 check_roff(CHKARGS)
 329 {
 330
 331         if (MAN_BLOCK != n->type)
 332                 return(1);
 333
 334         for (n = n->parent; n; n = n->parent)
 335                 if (MAN_de == n->tok || MAN_dei == n->tok ||
 336                                 MAN_am == n->tok ||
 337                                 MAN_ami == n->tok)
 338                         return(man_nerr(m, n, WROFFNEST));
 339
 340         return(1);
 341 }