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