Annotation of mandoc/validate.c, Revision 1.20
1.20 ! kristaps 1: /* $Id: validate.c,v 1.19 2009/01/08 15:05:50 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 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
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #include <assert.h>
1.8 kristaps 20: #include <stdlib.h>
1.1 kristaps 21:
22: #include "private.h"
23:
1.2 kristaps 24:
1.18 kristaps 25: typedef int (*v_pre)(struct mdoc *, struct mdoc_node *);
26: typedef int (*v_post)(struct mdoc *);
1.14 kristaps 27:
28:
29: struct valids {
1.17 kristaps 30: v_pre pre;
31: v_post *post;
1.14 kristaps 32: };
1.1 kristaps 33:
1.11 kristaps 34:
1.18 kristaps 35: static int pre_sh(struct mdoc *, struct mdoc_node *);
1.20 ! kristaps 36: static int pre_prologue(struct mdoc *, struct mdoc_node *);
! 37: static int pre_prologue(struct mdoc *, struct mdoc_node *);
! 38: static int pre_prologue(struct mdoc *, struct mdoc_node *);
1.18 kristaps 39: static int post_headchild_err_ge1(struct mdoc *);
40: static int post_headchild_err_le8(struct mdoc *);
41: static int post_bodychild_warn_ge1(struct mdoc *);
1.17 kristaps 42:
43: static v_post posts_sh[] = { post_headchild_err_ge1,
44: post_bodychild_warn_ge1,
45: post_headchild_err_le8, NULL };
1.9 kristaps 46:
1.12 kristaps 47:
1.9 kristaps 48: const struct valids mdoc_valids[MDOC_MAX] = {
1.17 kristaps 49: { NULL, NULL }, /* \" */
1.20 ! kristaps 50: { pre_prologue, NULL }, /* Dd */ /* TODO: pre: ordering, repetition */
! 51: { pre_prologue, NULL }, /* Dt */ /* TODO ... */
! 52: { pre_prologue, NULL }, /* Os */ /* TODO ... */
1.17 kristaps 53: { pre_sh, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */
54: { NULL, NULL }, /* Ss */ /* FIXME: preceding Pp. */
55: { NULL, NULL }, /* Pp */
56: { NULL, NULL }, /* D1 */
57: { NULL, NULL }, /* Dl */
58: { NULL, NULL }, /* Bd */ /* FIXME: preceding Pp. */
59: { NULL, NULL }, /* Ed */
60: { NULL, NULL }, /* Bl */ /* FIXME: preceding Pp. */
61: { NULL, NULL }, /* El */
62: { NULL, NULL }, /* It */
63: { NULL, NULL }, /* Ad */
64: { NULL, NULL }, /* An */
65: { NULL, NULL }, /* Ar */
66: { NULL, NULL }, /* Cd */
67: { NULL, NULL }, /* Cm */
68: { NULL, NULL }, /* Dv */
69: { NULL, NULL }, /* Er */
70: { NULL, NULL }, /* Ev */
71: { NULL, NULL }, /* Ex */
72: { NULL, NULL }, /* Fa */
73: { NULL, NULL }, /* Fd */
74: { NULL, NULL }, /* Fl */
75: { NULL, NULL }, /* Fn */
76: { NULL, NULL }, /* Ft */
77: { NULL, NULL }, /* Ic */
78: { NULL, NULL }, /* In */
79: { NULL, NULL }, /* Li */
80: { NULL, NULL }, /* Nd */
81: { NULL, NULL }, /* Nm */
82: { NULL, NULL }, /* Op */
83: { NULL, NULL }, /* Ot */
84: { NULL, NULL }, /* Pa */
85: { NULL, NULL }, /* Rv */
86: { NULL, NULL }, /* St */
87: { NULL, NULL }, /* Va */
88: { NULL, NULL }, /* Vt */
89: { NULL, NULL }, /* Xr */
90: { NULL, NULL }, /* %A */
91: { NULL, NULL }, /* %B */
92: { NULL, NULL }, /* %D */
93: { NULL, NULL }, /* %I */
94: { NULL, NULL }, /* %J */
95: { NULL, NULL }, /* %N */
96: { NULL, NULL }, /* %O */
97: { NULL, NULL }, /* %P */
98: { NULL, NULL }, /* %R */
99: { NULL, NULL }, /* %T */
100: { NULL, NULL }, /* %V */
101: { NULL, NULL }, /* Ac */
102: { NULL, NULL }, /* Ao */
103: { NULL, NULL }, /* Aq */
104: { NULL, NULL }, /* At */ /* FIXME */
105: { NULL, NULL }, /* Bc */
106: { NULL, NULL }, /* Bf */
107: { NULL, NULL }, /* Bo */
108: { NULL, NULL }, /* Bq */
109: { NULL, NULL }, /* Bsx */
110: { NULL, NULL }, /* Bx */
111: { NULL, NULL }, /* Db */
112: { NULL, NULL }, /* Dc */
113: { NULL, NULL }, /* Do */
114: { NULL, NULL }, /* Dq */
115: { NULL, NULL }, /* Ec */
116: { NULL, NULL }, /* Ef */ /* -symbolic, etc. */
117: { NULL, NULL }, /* Em */
118: { NULL, NULL }, /* Eo */
119: { NULL, NULL }, /* Fx */
120: { NULL, NULL }, /* Ms */
121: { NULL, NULL }, /* No */
122: { NULL, NULL }, /* Ns */
123: { NULL, NULL }, /* Nx */
124: { NULL, NULL }, /* Ox */
125: { NULL, NULL }, /* Pc */
126: { NULL, NULL }, /* Pf */ /* 2 or more arguments */
127: { NULL, NULL }, /* Po */
128: { NULL, NULL }, /* Pq */ /* FIXME: ignore following Sh/Ss */
129: { NULL, NULL }, /* Qc */
130: { NULL, NULL }, /* Ql */
131: { NULL, NULL }, /* Qo */
132: { NULL, NULL }, /* Qq */
133: { NULL, NULL }, /* Re */
134: { NULL, NULL }, /* Rs */
135: { NULL, NULL }, /* Sc */
136: { NULL, NULL }, /* So */
137: { NULL, NULL }, /* Sq */
138: { NULL, NULL }, /* Sm */
139: { NULL, NULL }, /* Sx */
140: { NULL, NULL }, /* Sy */
141: { NULL, NULL }, /* Tn */
142: { NULL, NULL }, /* Ux */
143: { NULL, NULL }, /* Xc */
144: { NULL, NULL }, /* Xo */
145: { NULL, NULL }, /* Fo */
146: { NULL, NULL }, /* Fc */
147: { NULL, NULL }, /* Oo */
148: { NULL, NULL }, /* Oc */
149: { NULL, NULL }, /* Bk */
150: { NULL, NULL }, /* Ek */
151: { NULL, NULL }, /* Bt */
152: { NULL, NULL }, /* Hf */
153: { NULL, NULL }, /* Fr */
154: { NULL, NULL }, /* Ud */
1.9 kristaps 155: };
1.6 kristaps 156:
157:
158: static int
1.18 kristaps 159: post_bodychild_warn_ge1(struct mdoc *mdoc)
1.6 kristaps 160: {
161:
1.17 kristaps 162: if (MDOC_BODY != mdoc->last->type)
1.8 kristaps 163: return(1);
1.17 kristaps 164: if (mdoc->last->child)
1.9 kristaps 165: return(1);
1.1 kristaps 166:
1.18 kristaps 167: return(mdoc_warn(mdoc, WARN_ARGS_GE1));
1.8 kristaps 168: }
1.1 kristaps 169:
170:
1.8 kristaps 171: static int
1.18 kristaps 172: post_headchild_err_ge1(struct mdoc *mdoc)
1.8 kristaps 173: {
1.1 kristaps 174:
1.17 kristaps 175: if (MDOC_HEAD != mdoc->last->type)
1.9 kristaps 176: return(1);
1.17 kristaps 177: if (mdoc->last->child)
1.9 kristaps 178: return(1);
1.18 kristaps 179: return(mdoc_err(mdoc, ERR_ARGS_GE1));
1.1 kristaps 180: }
181:
182:
1.9 kristaps 183: static int
1.18 kristaps 184: post_headchild_err_le8(struct mdoc *mdoc)
1.14 kristaps 185: {
1.17 kristaps 186: int i;
1.14 kristaps 187: struct mdoc_node *n;
188:
1.17 kristaps 189: if (MDOC_HEAD != mdoc->last->type)
1.14 kristaps 190: return(1);
1.17 kristaps 191: for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
192: /* Do nothing. */ ;
193: if (i <= 8)
1.11 kristaps 194: return(1);
1.18 kristaps 195: return(mdoc_err(mdoc, ERR_ARGS_LE8));
1.14 kristaps 196: }
197:
198:
199: static int
1.20 ! kristaps 200: pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
! 201: {
! 202:
! 203: if (SEC_PROLOGUE != mdoc->sec_lastn)
! 204: return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE));
! 205: assert(MDOC_ELEM == node->type);
! 206:
! 207: /* Check for ordering. */
! 208:
! 209: switch (node->data.elem.tok) {
! 210: case (MDOC_Os):
! 211: if (mdoc->meta.title[0] && mdoc->meta.date)
! 212: break;
! 213: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
! 214: case (MDOC_Dt):
! 215: if (0 == mdoc->meta.title[0] && mdoc->meta.date)
! 216: break;
! 217: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
! 218: case (MDOC_Dd):
! 219: if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)
! 220: break;
! 221: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
! 222: default:
! 223: abort();
! 224: /* NOTREACHED */
! 225: }
! 226:
! 227: /* Check for repetition. */
! 228:
! 229: switch (node->data.elem.tok) {
! 230: case (MDOC_Os):
! 231: if (0 == mdoc->meta.os[0])
! 232: return(1);
! 233: break;
! 234: case (MDOC_Dd):
! 235: if (0 == mdoc->meta.date)
! 236: return(1);
! 237: break;
! 238: case (MDOC_Dt):
! 239: if (0 == mdoc->meta.title[0])
! 240: return(1);
! 241: break;
! 242: default:
! 243: abort();
! 244: /* NOTREACHED */
! 245: }
! 246:
! 247: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP));
! 248: }
! 249:
! 250:
! 251: static int
1.18 kristaps 252: pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
1.14 kristaps 253: {
254:
255: return(1);
1.11 kristaps 256: }
257:
258:
1.17 kristaps 259: int
1.18 kristaps 260: mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
1.11 kristaps 261: {
1.18 kristaps 262: int t;
263:
264: switch (node->type) {
265: case (MDOC_BODY):
1.20 ! kristaps 266: t = node->data.body.tok;
1.18 kristaps 267: break;
268: case (MDOC_ELEM):
1.20 ! kristaps 269: t = node->data.elem.tok;
1.18 kristaps 270: break;
271: case (MDOC_BLOCK):
1.20 ! kristaps 272: t = node->data.block.tok;
1.18 kristaps 273: break;
274: case (MDOC_HEAD):
1.20 ! kristaps 275: t = node->data.head.tok;
1.18 kristaps 276: break;
277: default:
278: return(1);
279: }
1.11 kristaps 280:
1.18 kristaps 281: if (NULL == mdoc_valids[t].pre)
1.11 kristaps 282: return(1);
1.18 kristaps 283: return((*mdoc_valids[t].pre)(mdoc, node));
1.11 kristaps 284: }
285:
286:
1.17 kristaps 287: int
1.18 kristaps 288: mdoc_valid_post(struct mdoc *mdoc)
1.11 kristaps 289: {
1.17 kristaps 290: v_post *p;
291: int t;
1.11 kristaps 292:
1.17 kristaps 293: switch (mdoc->last->type) {
294: case (MDOC_BODY):
295: t = mdoc->last->data.body.tok;
296: break;
297: case (MDOC_ELEM):
298: t = mdoc->last->data.elem.tok;
299: break;
300: case (MDOC_BLOCK):
301: t = mdoc->last->data.block.tok;
302: break;
303: case (MDOC_HEAD):
304: t = mdoc->last->data.head.tok;
305: break;
306: default:
1.8 kristaps 307: return(1);
308: }
1.14 kristaps 309:
1.17 kristaps 310: if (NULL == mdoc_valids[t].post)
1.9 kristaps 311: return(1);
1.8 kristaps 312:
1.17 kristaps 313: for (p = mdoc_valids[t].post; *p; p++)
1.18 kristaps 314: if ( ! (*p)(mdoc))
1.17 kristaps 315: return(0);
1.11 kristaps 316:
1.14 kristaps 317: return(1);
1.11 kristaps 318: }
1.14 kristaps 319:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to validate.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc