Annotation of mandoc/validate.c, Revision 1.21
1.21 ! kristaps 1: /* $Id: validate.c,v 1.20 2009/01/08 15:59:58 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.20 kristaps 35: static int pre_prologue(struct mdoc *, struct mdoc_node *);
36: static int pre_prologue(struct mdoc *, struct mdoc_node *);
37: static int pre_prologue(struct mdoc *, struct mdoc_node *);
1.18 kristaps 38: static int post_headchild_err_ge1(struct mdoc *);
1.21 ! kristaps 39: static int post_elemchild_err_ge1(struct mdoc *);
1.18 kristaps 40: static int post_bodychild_warn_ge1(struct mdoc *);
1.21 ! kristaps 41: static int post_sh(struct mdoc *);
1.17 kristaps 42:
1.21 ! kristaps 43: static v_post posts_sh[] = { post_headchild_err_ge1,
! 44: post_bodychild_warn_ge1, post_sh, NULL };
! 45: static v_post posts_dd[] = { post_elemchild_err_ge1, 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.21 ! kristaps 50: { pre_prologue, posts_dd }, /* Dd */
! 51: { pre_prologue, NULL }, /* Dt */
! 52: { pre_prologue, NULL }, /* Os */
! 53: { NULL, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */
1.17 kristaps 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.21 ! kristaps 172: post_elemchild_err_ge1(struct mdoc *mdoc)
1.8 kristaps 173: {
1.1 kristaps 174:
1.21 ! kristaps 175: assert(MDOC_ELEM == mdoc->last->type);
1.17 kristaps 176: if (mdoc->last->child)
1.9 kristaps 177: return(1);
1.18 kristaps 178: return(mdoc_err(mdoc, ERR_ARGS_GE1));
1.1 kristaps 179: }
180:
181:
1.9 kristaps 182: static int
1.21 ! kristaps 183: post_headchild_err_ge1(struct mdoc *mdoc)
1.14 kristaps 184: {
185:
1.17 kristaps 186: if (MDOC_HEAD != mdoc->last->type)
1.14 kristaps 187: return(1);
1.21 ! kristaps 188: if (mdoc->last->child)
1.11 kristaps 189: return(1);
1.21 ! kristaps 190: return(mdoc_err(mdoc, ERR_ARGS_GE1));
1.14 kristaps 191: }
192:
193:
194: static int
1.20 kristaps 195: pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
196: {
197:
198: if (SEC_PROLOGUE != mdoc->sec_lastn)
199: return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE));
200: assert(MDOC_ELEM == node->type);
201:
202: /* Check for ordering. */
203:
204: switch (node->data.elem.tok) {
205: case (MDOC_Os):
206: if (mdoc->meta.title[0] && mdoc->meta.date)
207: break;
208: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
209: case (MDOC_Dt):
210: if (0 == mdoc->meta.title[0] && mdoc->meta.date)
211: break;
212: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
213: case (MDOC_Dd):
214: if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)
215: break;
216: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
217: default:
218: abort();
219: /* NOTREACHED */
220: }
221:
222: /* Check for repetition. */
223:
224: switch (node->data.elem.tok) {
225: case (MDOC_Os):
226: if (0 == mdoc->meta.os[0])
227: return(1);
228: break;
229: case (MDOC_Dd):
230: if (0 == mdoc->meta.date)
231: return(1);
232: break;
233: case (MDOC_Dt):
234: if (0 == mdoc->meta.title[0])
235: return(1);
236: break;
237: default:
238: abort();
239: /* NOTREACHED */
240: }
241:
242: return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP));
243: }
244:
245:
1.21 ! kristaps 246: /*
! 247: * Warn if sections (those that are with a known title, such as NAME,
! 248: * DESCRIPTION, and so forth) are out of the conventional order.
! 249: */
1.20 kristaps 250: static int
1.21 ! kristaps 251: post_sh(struct mdoc *mdoc)
1.14 kristaps 252: {
1.21 ! kristaps 253: enum mdoc_sec sec;
! 254: int i;
! 255: struct mdoc_node *n;
! 256: char *args[MDOC_LINEARG_MAX];
! 257:
! 258: if (MDOC_HEAD != mdoc->last->type)
! 259: return(1);
! 260:
! 261: assert(MDOC_Sh == mdoc->last->data.head.tok);
! 262:
! 263: n = mdoc->last->child;
! 264: assert(n);
1.14 kristaps 265:
1.21 ! kristaps 266: for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) {
! 267: assert(MDOC_TEXT == n->type);
! 268: assert(NULL == n->child);
! 269: assert(n->data.text.string);
! 270: args[i] = n->data.text.string;
! 271: }
! 272:
! 273: sec = mdoc_atosec((size_t)i, (const char **)args);
! 274: if (SEC_CUSTOM == sec)
! 275: return(1);
! 276: if (sec > mdoc->sec_lastn)
! 277: return(1);
! 278:
! 279: if (sec == mdoc->sec_lastn)
! 280: return(mdoc_warn(mdoc, WARN_SEC_REP));
! 281: return(mdoc_warn(mdoc, WARN_SEC_OO));
1.11 kristaps 282: }
283:
284:
1.17 kristaps 285: int
1.18 kristaps 286: mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
1.11 kristaps 287: {
1.18 kristaps 288: int t;
289:
290: switch (node->type) {
291: case (MDOC_BODY):
1.20 kristaps 292: t = node->data.body.tok;
1.18 kristaps 293: break;
294: case (MDOC_ELEM):
1.20 kristaps 295: t = node->data.elem.tok;
1.18 kristaps 296: break;
297: case (MDOC_BLOCK):
1.20 kristaps 298: t = node->data.block.tok;
1.18 kristaps 299: break;
300: case (MDOC_HEAD):
1.20 kristaps 301: t = node->data.head.tok;
1.18 kristaps 302: break;
303: default:
304: return(1);
305: }
1.11 kristaps 306:
1.18 kristaps 307: if (NULL == mdoc_valids[t].pre)
1.11 kristaps 308: return(1);
1.18 kristaps 309: return((*mdoc_valids[t].pre)(mdoc, node));
1.11 kristaps 310: }
311:
312:
1.17 kristaps 313: int
1.18 kristaps 314: mdoc_valid_post(struct mdoc *mdoc)
1.11 kristaps 315: {
1.17 kristaps 316: v_post *p;
317: int t;
1.11 kristaps 318:
1.17 kristaps 319: switch (mdoc->last->type) {
320: case (MDOC_BODY):
321: t = mdoc->last->data.body.tok;
322: break;
323: case (MDOC_ELEM):
324: t = mdoc->last->data.elem.tok;
325: break;
326: case (MDOC_BLOCK):
327: t = mdoc->last->data.block.tok;
328: break;
329: case (MDOC_HEAD):
330: t = mdoc->last->data.head.tok;
331: break;
332: default:
1.8 kristaps 333: return(1);
334: }
1.14 kristaps 335:
1.17 kristaps 336: if (NULL == mdoc_valids[t].post)
1.9 kristaps 337: return(1);
1.8 kristaps 338:
1.17 kristaps 339: for (p = mdoc_valids[t].post; *p; p++)
1.18 kristaps 340: if ( ! (*p)(mdoc))
1.17 kristaps 341: return(0);
1.11 kristaps 342:
1.14 kristaps 343: return(1);
1.11 kristaps 344: }
1.14 kristaps 345:
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