]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.139 2010/12/09 10:32:22 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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.
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.
22 #include <sys/utsname.h>
25 #include <sys/types.h>
37 #include "libmandoc.h"
39 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
41 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
42 #define POST_ARGS struct mdoc *mdoc
59 typedef int (*v_pre
)(PRE_ARGS
);
60 typedef int (*v_post
)(POST_ARGS
);
67 static int check_count(struct mdoc
*, enum mdoc_type
,
68 enum check_lvl
, enum check_ineq
, int);
69 static int check_parent(PRE_ARGS
, enum mdoct
, enum mdoc_type
);
70 static void check_text(struct mdoc
*, int, int, char *);
71 static void check_argv(struct mdoc
*,
72 struct mdoc_node
*, struct mdoc_argv
*);
73 static void check_args(struct mdoc
*, struct mdoc_node
*);
75 static int concat(struct mdoc
*, char *,
76 const struct mdoc_node
*, size_t);
78 static int ebool(POST_ARGS
);
79 static int berr_ge1(POST_ARGS
);
80 static int bwarn_ge1(POST_ARGS
);
81 static int eerr_eq0(POST_ARGS
);
82 static int eerr_eq1(POST_ARGS
);
83 static int eerr_ge1(POST_ARGS
);
84 static int eerr_le1(POST_ARGS
);
85 static int ewarn_eq0(POST_ARGS
);
86 static int ewarn_ge1(POST_ARGS
);
87 static int herr_eq0(POST_ARGS
);
88 static int herr_ge1(POST_ARGS
);
89 static int hwarn_eq0(POST_ARGS
);
90 static int hwarn_eq1(POST_ARGS
);
91 static int hwarn_le1(POST_ARGS
);
93 static int post_an(POST_ARGS
);
94 static int post_at(POST_ARGS
);
95 static int post_bf(POST_ARGS
);
96 static int post_bl(POST_ARGS
);
97 static int post_bl_block(POST_ARGS
);
98 static int post_bl_block_width(POST_ARGS
);
99 static int post_bl_block_tag(POST_ARGS
);
100 static int post_bl_head(POST_ARGS
);
101 static int post_dd(POST_ARGS
);
102 static int post_dt(POST_ARGS
);
103 static int post_defaults(POST_ARGS
);
104 static int post_literal(POST_ARGS
);
105 static int post_eoln(POST_ARGS
);
106 static int post_it(POST_ARGS
);
107 static int post_lb(POST_ARGS
);
108 static int post_nm(POST_ARGS
);
109 static int post_os(POST_ARGS
);
110 static int post_prol(POST_ARGS
);
111 static int post_root(POST_ARGS
);
112 static int post_rs(POST_ARGS
);
113 static int post_sh(POST_ARGS
);
114 static int post_sh_body(POST_ARGS
);
115 static int post_sh_head(POST_ARGS
);
116 static int post_st(POST_ARGS
);
117 static int post_std(POST_ARGS
);
118 static int post_vt(POST_ARGS
);
119 static int pre_an(PRE_ARGS
);
120 static int pre_bd(PRE_ARGS
);
121 static int pre_bl(PRE_ARGS
);
122 static int pre_dd(PRE_ARGS
);
123 static int pre_display(PRE_ARGS
);
124 static int pre_dt(PRE_ARGS
);
125 static int pre_it(PRE_ARGS
);
126 static int pre_literal(PRE_ARGS
);
127 static int pre_os(PRE_ARGS
);
128 static int pre_par(PRE_ARGS
);
129 static int pre_sh(PRE_ARGS
);
130 static int pre_ss(PRE_ARGS
);
131 static int pre_std(PRE_ARGS
);
133 static v_post posts_an
[] = { post_an
, NULL
};
134 static v_post posts_at
[] = { post_at
, post_defaults
, NULL
};
135 static v_post posts_bd
[] = { post_literal
, hwarn_eq0
, bwarn_ge1
, NULL
};
136 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
137 static v_post posts_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
138 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
139 static v_post posts_bool
[] = { eerr_eq1
, ebool
, NULL
};
140 static v_post posts_eoln
[] = { post_eoln
, NULL
};
141 static v_post posts_defaults
[] = { post_defaults
, NULL
};
142 static v_post posts_dd
[] = { ewarn_ge1
, post_dd
, post_prol
, NULL
};
143 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, herr_eq0
, NULL
};
144 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
145 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
146 static v_post posts_it
[] = { post_it
, NULL
};
147 static v_post posts_lb
[] = { eerr_eq1
, post_lb
, NULL
};
148 static v_post posts_nd
[] = { berr_ge1
, NULL
};
149 static v_post posts_nm
[] = { post_nm
, NULL
};
150 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
151 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
152 static v_post posts_rs
[] = { berr_ge1
, herr_eq0
, post_rs
, NULL
};
153 static v_post posts_sh
[] = { herr_ge1
, bwarn_ge1
, post_sh
, NULL
};
154 static v_post posts_sp
[] = { eerr_le1
, NULL
};
155 static v_post posts_ss
[] = { herr_ge1
, NULL
};
156 static v_post posts_st
[] = { eerr_eq1
, post_st
, NULL
};
157 static v_post posts_std
[] = { post_std
, NULL
};
158 static v_post posts_text
[] = { eerr_ge1
, NULL
};
159 static v_post posts_text1
[] = { eerr_eq1
, NULL
};
160 static v_post posts_vt
[] = { post_vt
, NULL
};
161 static v_post posts_wline
[] = { bwarn_ge1
, herr_eq0
, NULL
};
162 static v_post posts_wtext
[] = { ewarn_ge1
, NULL
};
163 static v_pre pres_an
[] = { pre_an
, NULL
};
164 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
165 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
166 static v_pre pres_d1
[] = { pre_display
, NULL
};
167 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
168 static v_pre pres_dd
[] = { pre_dd
, NULL
};
169 static v_pre pres_dt
[] = { pre_dt
, NULL
};
170 static v_pre pres_er
[] = { NULL
, NULL
};
171 static v_pre pres_fd
[] = { NULL
, NULL
};
172 static v_pre pres_it
[] = { pre_it
, NULL
};
173 static v_pre pres_os
[] = { pre_os
, NULL
};
174 static v_pre pres_pp
[] = { pre_par
, NULL
};
175 static v_pre pres_sh
[] = { pre_sh
, NULL
};
176 static v_pre pres_ss
[] = { pre_ss
, NULL
};
177 static v_pre pres_std
[] = { pre_std
, NULL
};
179 const struct valids mdoc_valids
[MDOC_MAX
] = {
180 { NULL
, NULL
}, /* Ap */
181 { pres_dd
, posts_dd
}, /* Dd */
182 { pres_dt
, posts_dt
}, /* Dt */
183 { pres_os
, posts_os
}, /* Os */
184 { pres_sh
, posts_sh
}, /* Sh */
185 { pres_ss
, posts_ss
}, /* Ss */
186 { pres_pp
, posts_notext
}, /* Pp */
187 { pres_d1
, posts_wline
}, /* D1 */
188 { pres_dl
, posts_dl
}, /* Dl */
189 { pres_bd
, posts_bd
}, /* Bd */
190 { NULL
, NULL
}, /* Ed */
191 { pres_bl
, posts_bl
}, /* Bl */
192 { NULL
, NULL
}, /* El */
193 { pres_it
, posts_it
}, /* It */
194 { NULL
, posts_text
}, /* Ad */
195 { pres_an
, posts_an
}, /* An */
196 { NULL
, posts_defaults
}, /* Ar */
197 { NULL
, posts_text
}, /* Cd */
198 { NULL
, NULL
}, /* Cm */
199 { NULL
, NULL
}, /* Dv */
200 { pres_er
, posts_text
}, /* Er */
201 { NULL
, NULL
}, /* Ev */
202 { pres_std
, posts_std
}, /* Ex */
203 { NULL
, NULL
}, /* Fa */
204 { pres_fd
, posts_wtext
}, /* Fd */
205 { NULL
, NULL
}, /* Fl */
206 { NULL
, posts_text
}, /* Fn */
207 { NULL
, posts_wtext
}, /* Ft */
208 { NULL
, posts_text
}, /* Ic */
209 { NULL
, posts_text1
}, /* In */
210 { NULL
, posts_defaults
}, /* Li */
211 { NULL
, posts_nd
}, /* Nd */
212 { NULL
, posts_nm
}, /* Nm */
213 { NULL
, NULL
}, /* Op */
214 { NULL
, NULL
}, /* Ot */
215 { NULL
, posts_defaults
}, /* Pa */
216 { pres_std
, posts_std
}, /* Rv */
217 { NULL
, posts_st
}, /* St */
218 { NULL
, NULL
}, /* Va */
219 { NULL
, posts_vt
}, /* Vt */
220 { NULL
, posts_wtext
}, /* Xr */
221 { NULL
, posts_text
}, /* %A */
222 { NULL
, posts_text
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
223 { NULL
, posts_text
}, /* %D */ /* FIXME: check date with mandoc_a2time(). */
224 { NULL
, posts_text
}, /* %I */
225 { NULL
, posts_text
}, /* %J */
226 { NULL
, posts_text
}, /* %N */
227 { NULL
, posts_text
}, /* %O */
228 { NULL
, posts_text
}, /* %P */
229 { NULL
, posts_text
}, /* %R */
230 { NULL
, posts_text
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
231 { NULL
, posts_text
}, /* %V */
232 { NULL
, NULL
}, /* Ac */
233 { NULL
, NULL
}, /* Ao */
234 { NULL
, NULL
}, /* Aq */
235 { NULL
, posts_at
}, /* At */
236 { NULL
, NULL
}, /* Bc */
237 { NULL
, posts_bf
}, /* Bf */
238 { NULL
, NULL
}, /* Bo */
239 { NULL
, NULL
}, /* Bq */
240 { NULL
, NULL
}, /* Bsx */
241 { NULL
, NULL
}, /* Bx */
242 { NULL
, posts_bool
}, /* Db */
243 { NULL
, NULL
}, /* Dc */
244 { NULL
, NULL
}, /* Do */
245 { NULL
, NULL
}, /* Dq */
246 { NULL
, NULL
}, /* Ec */
247 { NULL
, NULL
}, /* Ef */
248 { NULL
, NULL
}, /* Em */
249 { NULL
, NULL
}, /* Eo */
250 { NULL
, NULL
}, /* Fx */
251 { NULL
, posts_text
}, /* Ms */
252 { NULL
, posts_notext
}, /* No */
253 { NULL
, posts_notext
}, /* Ns */
254 { NULL
, NULL
}, /* Nx */
255 { NULL
, NULL
}, /* Ox */
256 { NULL
, NULL
}, /* Pc */
257 { NULL
, posts_text1
}, /* Pf */
258 { NULL
, NULL
}, /* Po */
259 { NULL
, NULL
}, /* Pq */
260 { NULL
, NULL
}, /* Qc */
261 { NULL
, NULL
}, /* Ql */
262 { NULL
, NULL
}, /* Qo */
263 { NULL
, NULL
}, /* Qq */
264 { NULL
, NULL
}, /* Re */
265 { NULL
, posts_rs
}, /* Rs */
266 { NULL
, NULL
}, /* Sc */
267 { NULL
, NULL
}, /* So */
268 { NULL
, NULL
}, /* Sq */
269 { NULL
, posts_bool
}, /* Sm */
270 { NULL
, posts_text
}, /* Sx */
271 { NULL
, posts_text
}, /* Sy */
272 { NULL
, posts_text
}, /* Tn */
273 { NULL
, NULL
}, /* Ux */
274 { NULL
, NULL
}, /* Xc */
275 { NULL
, NULL
}, /* Xo */
276 { NULL
, posts_fo
}, /* Fo */
277 { NULL
, NULL
}, /* Fc */
278 { NULL
, NULL
}, /* Oo */
279 { NULL
, NULL
}, /* Oc */
280 { NULL
, posts_bk
}, /* Bk */
281 { NULL
, NULL
}, /* Ek */
282 { NULL
, posts_eoln
}, /* Bt */
283 { NULL
, NULL
}, /* Hf */
284 { NULL
, NULL
}, /* Fr */
285 { NULL
, posts_eoln
}, /* Ud */
286 { NULL
, posts_lb
}, /* Lb */
287 { NULL
, posts_notext
}, /* Lp */
288 { NULL
, posts_text
}, /* Lk */
289 { NULL
, posts_defaults
}, /* Mt */
290 { NULL
, NULL
}, /* Brq */
291 { NULL
, NULL
}, /* Bro */
292 { NULL
, NULL
}, /* Brc */
293 { NULL
, posts_text
}, /* %C */
294 { NULL
, NULL
}, /* Es */
295 { NULL
, NULL
}, /* En */
296 { NULL
, NULL
}, /* Dx */
297 { NULL
, posts_text
}, /* %Q */
298 { NULL
, posts_notext
}, /* br */
299 { pres_pp
, posts_sp
}, /* sp */
300 { NULL
, posts_text1
}, /* %U */
301 { NULL
, NULL
}, /* Ta */
304 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
306 static const enum mdoct rsord
[RSORD_MAX
] = {
325 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
331 if (MDOC_TEXT
== n
->type
) {
335 check_text(mdoc
, line
, pos
, tp
);
341 if (NULL
== mdoc_valids
[n
->tok
].pre
)
343 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
344 if ( ! (*p
)(mdoc
, n
))
351 mdoc_valid_post(struct mdoc
*mdoc
)
355 if (MDOC_VALID
& mdoc
->last
->flags
)
357 mdoc
->last
->flags
|= MDOC_VALID
;
359 if (MDOC_TEXT
== mdoc
->last
->type
)
361 if (MDOC_ROOT
== mdoc
->last
->type
)
362 return(post_root(mdoc
));
364 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
366 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
374 check_count(struct mdoc
*m
, enum mdoc_type type
,
375 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
379 if (m
->last
->type
!= type
)
385 if (m
->last
->nchild
< val
)
390 if (m
->last
->nchild
> val
)
395 if (val
== m
->last
->nchild
)
403 if (CHECK_WARN
== lvl
) {
404 return(mdoc_vmsg(m
, MANDOCERR_ARGCOUNT
,
405 m
->last
->line
, m
->last
->pos
,
406 "want %s%d children (have %d)",
407 p
, val
, m
->last
->nchild
));
410 /* FIXME: THIS IS THE SAME AS THE ABOVE. */
412 return(mdoc_vmsg(m
, MANDOCERR_ARGCOUNT
,
413 m
->last
->line
, m
->last
->pos
,
414 "require %s%d children (have %d)",
415 p
, val
, m
->last
->nchild
));
422 return(check_count(mdoc
, MDOC_BODY
, CHECK_FATAL
, CHECK_GT
, 0));
428 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
434 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_EQ
, 0));
440 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_EQ
, 1));
446 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_GT
, 0));
452 return(check_count(mdoc
, MDOC_ELEM
, CHECK_FATAL
, CHECK_LT
, 2));
458 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
464 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
470 return(check_count(mdoc
, MDOC_HEAD
, CHECK_FATAL
, CHECK_EQ
, 0));
476 return(check_count(mdoc
, MDOC_HEAD
, CHECK_FATAL
, CHECK_GT
, 0));
482 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
488 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
494 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
498 check_args(struct mdoc
*m
, struct mdoc_node
*n
)
505 assert(n
->args
->argc
);
506 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
507 check_argv(m
, n
, &n
->args
->argv
[i
]);
511 check_argv(struct mdoc
*m
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
515 for (i
= 0; i
< (int)v
->sz
; i
++)
516 check_text(m
, v
->line
, v
->pos
, v
->value
[i
]);
518 /* FIXME: move to post_std(). */
520 if (MDOC_Std
== v
->arg
)
521 if ( ! (v
->sz
|| m
->meta
.name
))
522 mdoc_nmsg(m
, n
, MANDOCERR_NONAME
);
526 check_text(struct mdoc
*m
, int ln
, int pos
, char *p
)
531 for ( ; *p
; p
++, pos
++) {
532 sz
= strcspn(p
, "\t\\");
541 if ( ! (MDOC_LITERAL
& m
->flags
))
542 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADTAB
);
546 if (0 == (c
= mandoc_special(p
))) {
547 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADESCAPE
);
557 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
561 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
562 (t
== n
->parent
->type
))
565 mdoc_vmsg(mdoc
, MANDOCERR_SYNTCHILD
,
566 n
->line
, n
->pos
, "want parent %s",
567 MDOC_ROOT
== t
? "<root>" :
568 mdoc_macronames
[tok
]);
574 pre_display(PRE_ARGS
)
576 struct mdoc_node
*node
;
578 if (MDOC_BLOCK
!= n
->type
)
581 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
582 if (MDOC_BLOCK
== node
->type
)
583 if (MDOC_Bd
== node
->tok
)
587 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
597 const char *offs
, *width
;
599 struct mdoc_node
*np
;
601 if (MDOC_BLOCK
!= n
->type
) {
602 if (ENDBODY_NOT
!= n
->end
) {
604 np
= n
->pending
->parent
;
609 assert(MDOC_BLOCK
== np
->type
);
610 assert(MDOC_Bl
== np
->tok
);
612 n
->data
.Bl
= np
->data
.Bl
;
617 * First figure out which kind of list to use: bind ourselves to
618 * the first mentioned list type and warn about any remaining
619 * ones. If we find no list type, we default to LIST_item.
622 assert(NULL
== n
->data
.Bl
);
623 n
->data
.Bl
= mandoc_calloc(1, sizeof(struct mdoc_bl
));
626 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
630 switch (n
->args
->argv
[i
].arg
) {
631 /* Set list types. */
665 /* Set list arguments. */
667 dup
= n
->data
.Bl
->comp
;
671 dup
= (NULL
!= n
->data
.Bl
->width
);
672 width
= n
->args
->argv
[i
].value
[0];
675 /* NB: this can be empty! */
676 if (n
->args
->argv
[i
].sz
) {
677 offs
= n
->args
->argv
[i
].value
[0];
678 dup
= (NULL
!= n
->data
.Bl
->offs
);
681 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
687 /* Check: duplicate auxiliary arguments. */
690 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
693 n
->data
.Bl
->comp
= comp
;
695 n
->data
.Bl
->offs
= offs
;
697 n
->data
.Bl
->width
= width
;
699 /* Check: multiple list types. */
701 if (LIST__NONE
!= lt
&& n
->data
.Bl
->type
!= LIST__NONE
)
702 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
704 /* Assign list type. */
706 if (LIST__NONE
!= lt
&& n
->data
.Bl
->type
== LIST__NONE
) {
707 n
->data
.Bl
->type
= lt
;
708 /* Set column information, too. */
709 if (LIST_column
== lt
) {
712 n
->data
.Bl
->cols
= (const char **)
713 n
->args
->argv
[i
].value
;
717 /* The list type should come first. */
719 if (n
->data
.Bl
->type
== LIST__NONE
)
720 if (n
->data
.Bl
->width
||
723 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
728 /* Allow lists to default to LIST_item. */
730 if (LIST__NONE
== n
->data
.Bl
->type
) {
731 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
732 n
->data
.Bl
->type
= LIST_item
;
736 * Validate the width field. Some list types don't need width
737 * types and should be warned about them. Others should have it
738 * and must also be warned.
741 switch (n
->data
.Bl
->type
) {
743 if (n
->data
.Bl
->width
)
745 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
756 if (n
->data
.Bl
->width
)
757 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
773 struct mdoc_node
*np
;
775 if (MDOC_BLOCK
!= n
->type
) {
776 if (ENDBODY_NOT
!= n
->end
) {
778 np
= n
->pending
->parent
;
783 assert(MDOC_BLOCK
== np
->type
);
784 assert(MDOC_Bd
== np
->tok
);
786 n
->data
.Bd
= np
->data
.Bd
;
790 assert(NULL
== n
->data
.Bd
);
791 n
->data
.Bd
= mandoc_calloc(1, sizeof(struct mdoc_bd
));
794 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
799 switch (n
->args
->argv
[i
].arg
) {
806 case (MDOC_Unfilled
):
816 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
819 /* NB: this can be empty! */
820 if (n
->args
->argv
[i
].sz
) {
821 offs
= n
->args
->argv
[i
].value
[0];
822 dup
= (NULL
!= n
->data
.Bd
->offs
);
825 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
829 dup
= n
->data
.Bd
->comp
;
836 /* Check whether we have duplicates. */
839 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
841 /* Make our auxiliary assignments. */
844 n
->data
.Bd
->offs
= offs
;
846 n
->data
.Bd
->comp
= comp
;
848 /* Check whether a type has already been assigned. */
850 if (DISP__NONE
!= dt
&& n
->data
.Bd
->type
!= DISP__NONE
)
851 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
853 /* Make our type assignment. */
855 if (DISP__NONE
!= dt
&& n
->data
.Bd
->type
== DISP__NONE
)
856 n
->data
.Bd
->type
= dt
;
859 if (DISP__NONE
== n
->data
.Bd
->type
) {
860 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
861 n
->data
.Bd
->type
= DISP_ragged
;
872 if (MDOC_BLOCK
!= n
->type
)
874 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
882 if (MDOC_BLOCK
!= n
->type
)
885 mdoc
->regs
->regs
[(int)REG_nS
].set
= 0;
886 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
894 if (MDOC_BLOCK
!= n
->type
)
898 * FIXME: this can probably be lifted if we make the It into
899 * something else on-the-fly?
901 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
913 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
914 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
915 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
917 if (MDOC_Split
== n
->args
->argv
[0].arg
)
918 n
->data
.An
.auth
= AUTH_split
;
919 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
920 n
->data
.An
.auth
= AUTH_nosplit
;
931 if (n
->args
&& 1 == n
->args
->argc
)
932 if (MDOC_Std
== n
->args
->argv
[0].arg
)
935 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
943 if (0 == mdoc
->meta
.date
|| mdoc
->meta
.os
)
944 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
946 if (mdoc
->meta
.title
)
947 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
956 if (NULL
== mdoc
->meta
.title
|| 0 == mdoc
->meta
.date
)
957 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
960 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
969 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
970 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
973 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
982 struct mdoc_node
*np
;
986 * Unlike other data pointers, these are "housed" by the HEAD
987 * element, which contains the goods.
990 if (MDOC_HEAD
!= mdoc
->last
->type
) {
991 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
992 assert(mdoc
->last
->pending
);
993 np
= mdoc
->last
->pending
->parent
->head
;
994 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
995 np
= mdoc
->last
->parent
->head
;
997 np
= mdoc
->last
->head
;
1000 assert(MDOC_HEAD
== np
->type
);
1001 assert(MDOC_Bf
== np
->tok
);
1002 assert(np
->data
.Bf
);
1003 mdoc
->last
->data
.Bf
= np
->data
.Bf
;
1008 assert(MDOC_BLOCK
== np
->parent
->type
);
1009 assert(MDOC_Bf
== np
->parent
->tok
);
1010 np
->data
.Bf
= mandoc_calloc(1, sizeof(struct mdoc_bf
));
1013 * Cannot have both argument and parameter.
1014 * If neither is specified, let it through with a warning.
1017 if (np
->parent
->args
&& np
->child
) {
1018 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
1020 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
1021 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1025 /* Extract argument into data. */
1027 if (np
->parent
->args
) {
1028 arg
= np
->parent
->args
->argv
[0].arg
;
1029 if (MDOC_Emphasis
== arg
)
1030 np
->data
.Bf
->font
= FONT_Em
;
1031 else if (MDOC_Literal
== arg
)
1032 np
->data
.Bf
->font
= FONT_Li
;
1033 else if (MDOC_Symbolic
== arg
)
1034 np
->data
.Bf
->font
= FONT_Sy
;
1040 /* Extract parameter into data. */
1042 if (0 == strcmp(np
->child
->string
, "Em"))
1043 np
->data
.Bf
->font
= FONT_Em
;
1044 else if (0 == strcmp(np
->child
->string
, "Li"))
1045 np
->data
.Bf
->font
= FONT_Li
;
1046 else if (0 == strcmp(np
->child
->string
, "Sy"))
1047 np
->data
.Bf
->font
= FONT_Sy
;
1049 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1061 assert(mdoc
->last
->child
);
1062 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1064 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1066 /* If lookup ok, replace with table value. */
1069 free(mdoc
->last
->child
->string
);
1070 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1074 /* If not, use "library ``xxxx''. */
1076 sz
= strlen(mdoc
->last
->child
->string
) +
1077 2 + strlen("\\(lqlibrary\\(rq");
1078 buf
= mandoc_malloc(sz
);
1079 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1080 mdoc
->last
->child
->string
);
1081 free(mdoc
->last
->child
->string
);
1082 mdoc
->last
->child
->string
= buf
;
1087 post_eoln(POST_ARGS
)
1090 if (mdoc
->last
->child
)
1091 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1099 const struct mdoc_node
*n
;
1102 * The Vt macro comes in both ELEM and BLOCK form, both of which
1103 * have different syntaxes (yet more context-sensitive
1104 * behaviour). ELEM types must have a child; BLOCK types,
1105 * specifically the BODY, should only have TEXT children.
1108 if (MDOC_ELEM
== mdoc
->last
->type
)
1109 return(eerr_ge1(mdoc
));
1110 if (MDOC_BODY
!= mdoc
->last
->type
)
1113 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1114 if (MDOC_TEXT
!= n
->type
)
1115 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1126 /* If no child specified, make sure we have the meta name. */
1128 if (NULL
== mdoc
->last
->child
&& NULL
== mdoc
->meta
.name
) {
1129 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1131 } else if (mdoc
->meta
.name
)
1134 /* If no meta name, set it from the child. */
1136 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1139 mdoc
->meta
.name
= mandoc_strdup(buf
);
1145 post_literal(POST_ARGS
)
1149 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1150 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1151 * this in literal mode, but it doesn't hurt to just switch it
1152 * off in general since displays can't be nested.
1155 if (MDOC_BODY
== mdoc
->last
->type
)
1156 mdoc
->flags
&= ~MDOC_LITERAL
;
1162 post_defaults(POST_ARGS
)
1164 struct mdoc_node
*nn
;
1167 * The `Ar' defaults to "file ..." if no value is provided as an
1168 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1169 * gets an empty string.
1172 if (mdoc
->last
->child
)
1176 mdoc
->next
= MDOC_NEXT_CHILD
;
1180 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1182 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1186 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1188 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1192 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1198 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1218 * If we have a child, look it up in the standard keys. If a
1219 * key exist, use that instead of the child; if it doesn't,
1220 * prefix "AT&T UNIX " to the existing data.
1223 if (NULL
== mdoc
->last
->child
)
1226 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1227 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1230 free(mdoc
->last
->child
->string
);
1231 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1233 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1235 q
= mdoc
->last
->child
->string
;
1236 sz
= strlen(p
) + strlen(q
) + 1;
1237 buf
= mandoc_malloc(sz
);
1238 strlcpy(buf
, p
, sz
);
1239 strlcat(buf
, q
, sz
);
1240 free(mdoc
->last
->child
->string
);
1241 mdoc
->last
->child
->string
= buf
;
1250 struct mdoc_node
*np
;
1253 if (AUTH__NONE
!= np
->data
.An
.auth
&& np
->child
)
1254 return(eerr_eq0(mdoc
));
1257 * FIXME: make this ewarn and make sure that the front-ends
1258 * don't print the arguments.
1260 if (AUTH__NONE
!= np
->data
.An
.auth
|| np
->child
)
1263 mdoc_nmsg(mdoc
, np
, MANDOCERR_NOARGS
);
1273 struct mdoc_node
*n
, *c
;
1276 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1279 n
= mdoc
->last
->parent
->parent
;
1281 lt
= n
->data
.Bl
->type
;
1283 if (LIST__NONE
== lt
) {
1284 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1290 if (mdoc
->last
->head
->child
)
1292 /* FIXME: give this a dummy value. */
1293 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1302 if (NULL
== mdoc
->last
->head
->child
)
1303 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1312 if (NULL
== mdoc
->last
->body
->child
)
1313 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1316 if (mdoc
->last
->head
->child
)
1317 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1320 cols
= (int)n
->data
.Bl
->ncols
;
1322 assert(NULL
== mdoc
->last
->head
->child
);
1324 if (NULL
== mdoc
->last
->body
->child
)
1325 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1327 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1328 if (MDOC_BODY
== c
->type
)
1332 er
= MANDOCERR_ARGCOUNT
;
1333 else if (i
== cols
|| i
== cols
+ 1)
1336 er
= MANDOCERR_SYNTARGCOUNT
;
1338 rc
= mdoc_vmsg(mdoc
, er
,
1339 mdoc
->last
->line
, mdoc
->last
->pos
,
1340 "columns == %d (have %d)", cols
, i
);
1350 post_bl_block(POST_ARGS
)
1352 struct mdoc_node
*n
;
1355 * These are fairly complicated, so we've broken them into two
1356 * functions. post_bl_block_tag() is called when a -tag is
1357 * specified, but no -width (it must be guessed). The second
1358 * when a -width is specified (macro indicators must be
1359 * rewritten into real lengths).
1364 if (LIST_tag
== n
->data
.Bl
->type
&&
1365 NULL
== n
->data
.Bl
->width
) {
1366 if ( ! post_bl_block_tag(mdoc
))
1368 } else if (NULL
!= n
->data
.Bl
->width
) {
1369 if ( ! post_bl_block_width(mdoc
))
1374 assert(n
->data
.Bl
->width
);
1379 post_bl_block_width(POST_ARGS
)
1384 struct mdoc_node
*n
;
1390 * Calculate the real width of a list from the -width string,
1391 * which may contain a macro (with a known default width), a
1392 * literal string, or a scaling width.
1394 * If the value to -width is a macro, then we re-write it to be
1395 * the macro's width as set in share/tmac/mdoc/doc-common.
1398 if (0 == strcmp(n
->data
.Bl
->width
, "Ds"))
1400 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->data
.Bl
->width
)))
1402 else if (0 == (width
= mdoc_macro2len(tok
))) {
1403 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1407 /* The value already exists: free and reallocate it. */
1411 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1412 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1415 assert(i
< (int)n
->args
->argc
);
1417 snprintf(buf
, NUMSIZ
, "%zun", width
);
1418 free(n
->args
->argv
[i
].value
[0]);
1419 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1421 /* Set our width! */
1422 n
->data
.Bl
->width
= n
->args
->argv
[i
].value
[0];
1427 post_bl_block_tag(POST_ARGS
)
1429 struct mdoc_node
*n
, *nn
;
1435 * Calculate the -width for a `Bl -tag' list if it hasn't been
1436 * provided. Uses the first head macro. NOTE AGAIN: this is
1437 * ONLY if the -width argument has NOT been provided. See
1438 * post_bl_block_width() for converting the -width string.
1444 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1445 if (MDOC_It
!= nn
->tok
)
1448 assert(MDOC_BLOCK
== nn
->type
);
1449 nn
= nn
->head
->child
;
1454 if (MDOC_TEXT
== nn
->type
) {
1455 sz
= strlen(nn
->string
) + 1;
1459 if (0 != (ssz
= mdoc_macro2len(nn
->tok
)))
1465 /* Defaults to ten ens. */
1467 snprintf(buf
, NUMSIZ
, "%zun", sz
);
1470 * We have to dynamically add this to the macro's argument list.
1471 * We're guaranteed that a MDOC_Width doesn't already exist.
1475 i
= (int)(n
->args
->argc
)++;
1477 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1478 n
->args
->argc
* sizeof(struct mdoc_argv
));
1480 n
->args
->argv
[i
].arg
= MDOC_Width
;
1481 n
->args
->argv
[i
].line
= n
->line
;
1482 n
->args
->argv
[i
].pos
= n
->pos
;
1483 n
->args
->argv
[i
].sz
= 1;
1484 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1485 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1487 /* Set our width! */
1488 n
->data
.Bl
->width
= n
->args
->argv
[i
].value
[0];
1494 post_bl_head(POST_ARGS
)
1496 struct mdoc_node
*np
, *nn
, *nnp
;
1499 if (LIST_column
!= mdoc
->last
->data
.Bl
->type
)
1500 /* FIXME: this should be ERROR class... */
1501 return(hwarn_eq0(mdoc
));
1504 * Convert old-style lists, where the column width specifiers
1505 * trail as macro parameters, to the new-style ("normal-form")
1506 * lists where they're argument values following -column.
1509 /* First, disallow both types and allow normal-form. */
1512 * TODO: technically, we can accept both and just merge the two
1513 * lists, but I'll leave that for another day.
1516 if (mdoc
->last
->data
.Bl
->ncols
&& mdoc
->last
->nchild
) {
1517 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1519 } else if (NULL
== mdoc
->last
->child
)
1522 np
= mdoc
->last
->parent
;
1525 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1526 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1529 assert(j
< (int)np
->args
->argc
);
1530 assert(0 == np
->args
->argv
[j
].sz
);
1533 * Accomodate for new-style groff column syntax. Shuffle the
1534 * child nodes, all of which must be TEXT, as arguments for the
1535 * column field. Then, delete the head children.
1538 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1539 np
->args
->argv
[j
].value
= mandoc_malloc
1540 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1542 mdoc
->last
->data
.Bl
->ncols
= np
->args
->argv
[j
].sz
;
1543 mdoc
->last
->data
.Bl
->cols
= (const char **)np
->args
->argv
[j
].value
;
1545 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1546 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1550 mdoc_node_delete(NULL
, nnp
);
1553 mdoc
->last
->nchild
= 0;
1554 mdoc
->last
->child
= NULL
;
1562 struct mdoc_node
*n
;
1564 if (MDOC_HEAD
== mdoc
->last
->type
)
1565 return(post_bl_head(mdoc
));
1566 if (MDOC_BLOCK
== mdoc
->last
->type
)
1567 return(post_bl_block(mdoc
));
1568 if (MDOC_BODY
!= mdoc
->last
->type
)
1570 if (NULL
== mdoc
->last
->child
)
1574 * We only allow certain children of `Bl'. This is usually on
1575 * `It', but apparently `Sm' occurs here and there, so we let
1576 * that one through, too.
1580 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1581 if (MDOC_BLOCK
== n
->type
&& MDOC_It
== n
->tok
)
1583 if (MDOC_Sm
== n
->tok
)
1585 mdoc_nmsg(mdoc
, n
, MANDOCERR_SYNTCHILD
);
1593 ebool(struct mdoc
*mdoc
)
1596 if (NULL
== mdoc
->last
->child
)
1599 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1601 if (0 == strcmp(mdoc
->last
->child
->string
, "on"))
1603 if (0 == strcmp(mdoc
->last
->child
->string
, "off"))
1606 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1611 post_root(POST_ARGS
)
1614 struct mdoc_node
*n
;
1618 /* Check that we have a finished prologue. */
1620 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1622 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1628 /* Check that we begin with a proper `Sh'. */
1630 if (NULL
== n
->child
) {
1632 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1633 } else if (MDOC_BLOCK
!= n
->child
->type
||
1634 MDOC_Sh
!= n
->child
->tok
) {
1636 /* Can this be lifted? See rxdebug.1 for example. */
1637 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1640 return(erc
? 0 : 1);
1648 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1650 p
= mdoc_a2st(mdoc
->last
->child
->string
);
1653 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1654 mdoc_node_delete(mdoc
, mdoc
->last
);
1656 free(mdoc
->last
->child
->string
);
1657 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1666 struct mdoc_node
*nn
, *next
, *prev
;
1669 if (MDOC_BODY
!= mdoc
->last
->type
)
1673 * Make sure only certain types of nodes are allowed within the
1674 * the `Rs' body. Delete offending nodes and raise a warning.
1675 * Do this before re-ordering for the sake of clarity.
1679 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1680 for (i
= 0; i
< RSORD_MAX
; i
++)
1681 if (nn
->tok
== rsord
[i
])
1684 if (i
< RSORD_MAX
) {
1690 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1691 mdoc_node_delete(mdoc
, nn
);
1695 * The full `Rs' block needs special handling to order the
1696 * sub-elements according to `rsord'. Pick through each element
1697 * and correctly order it. This is a insertion sort.
1701 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1702 /* Determine order of `nn'. */
1703 for (i
= 0; i
< RSORD_MAX
; i
++)
1704 if (rsord
[i
] == nn
->tok
)
1708 * Remove `nn' from the chain. This somewhat
1709 * repeats mdoc_node_unlink(), but since we're
1710 * just re-ordering, there's no need for the
1711 * full unlink process.
1714 if (NULL
!= (next
= nn
->next
))
1715 next
->prev
= nn
->prev
;
1717 if (NULL
!= (prev
= nn
->prev
))
1718 prev
->next
= nn
->next
;
1720 nn
->prev
= nn
->next
= NULL
;
1723 * Scan back until we reach a node that's
1724 * ordered before `nn'.
1727 for ( ; prev
; prev
= prev
->prev
) {
1728 /* Determine order of `prev'. */
1729 for (j
= 0; j
< RSORD_MAX
; j
++)
1730 if (rsord
[j
] == prev
->tok
)
1738 * Set `nn' back into its correct place in front
1739 * of the `prev' node.
1746 prev
->next
->prev
= nn
;
1747 nn
->next
= prev
->next
;
1750 mdoc
->last
->child
->prev
= nn
;
1751 nn
->next
= mdoc
->last
->child
;
1752 mdoc
->last
->child
= nn
;
1763 if (MDOC_HEAD
== mdoc
->last
->type
)
1764 return(post_sh_head(mdoc
));
1765 if (MDOC_BODY
== mdoc
->last
->type
)
1766 return(post_sh_body(mdoc
));
1772 post_sh_body(POST_ARGS
)
1774 struct mdoc_node
*n
;
1776 if (SEC_NAME
!= mdoc
->lastsec
)
1780 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1781 * macros (can have multiple `Nm' and one `Nd'). Note that the
1782 * children of the BODY declaration can also be "text".
1785 if (NULL
== (n
= mdoc
->last
->child
)) {
1786 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1790 for ( ; n
&& n
->next
; n
= n
->next
) {
1791 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1793 if (MDOC_TEXT
== n
->type
)
1795 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1799 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1802 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1807 post_sh_head(POST_ARGS
)
1813 * Process a new section. Sections are either "named" or
1814 * "custom". Custom sections are user-defined, while named ones
1815 * follow a conventional order and may only appear in certain
1819 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1822 sec
= mdoc_str2sec(buf
);
1824 /* The NAME should be first. */
1826 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1827 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1829 /* The SYNOPSIS gets special attention in other areas. */
1831 if (SEC_SYNOPSIS
== sec
)
1832 mdoc
->flags
|= MDOC_SYNOPSIS
;
1834 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
1836 /* Mark our last section. */
1838 mdoc
->lastsec
= sec
;
1840 /* We don't care about custom sections after this. */
1842 if (SEC_CUSTOM
== sec
)
1846 * Check whether our non-custom section is being repeated or is
1850 if (sec
== mdoc
->lastnamed
)
1851 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
1853 if (sec
< mdoc
->lastnamed
)
1854 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
1856 /* Mark the last named section. */
1858 mdoc
->lastnamed
= sec
;
1860 /* Check particular section/manual conventions. */
1862 assert(mdoc
->meta
.msec
);
1865 case (SEC_RETURN_VALUES
):
1870 if (*mdoc
->meta
.msec
== '2')
1872 if (*mdoc
->meta
.msec
== '3')
1874 if (*mdoc
->meta
.msec
== '9')
1876 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECMSEC
);
1889 if (NULL
== mdoc
->last
)
1893 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1894 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1897 if (MDOC_Pp
!= mdoc
->last
->tok
&& MDOC_Lp
!= mdoc
->last
->tok
)
1900 if (MDOC_Bl
== n
->tok
&& n
->data
.Bl
->comp
)
1902 if (MDOC_Bd
== n
->tok
&& n
->data
.Bd
->comp
)
1905 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
1906 mdoc_node_delete(mdoc
, mdoc
->last
);
1911 pre_literal(PRE_ARGS
)
1914 if (MDOC_BODY
!= n
->type
)
1918 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1919 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1924 mdoc
->flags
|= MDOC_LITERAL
;
1928 if (DISP_literal
== n
->data
.Bd
->type
)
1929 mdoc
->flags
|= MDOC_LITERAL
;
1930 if (DISP_unfilled
== n
->data
.Bd
->type
)
1931 mdoc
->flags
|= MDOC_LITERAL
;
1945 struct mdoc_node
*n
;
1949 if (NULL
== n
->child
) {
1950 mdoc
->meta
.date
= time(NULL
);
1954 if ( ! concat(mdoc
, buf
, n
->child
, DATESIZE
))
1957 mdoc
->meta
.date
= mandoc_a2time
1958 (MTIME_MDOCDATE
| MTIME_CANONICAL
, buf
);
1960 if (0 == mdoc
->meta
.date
) {
1961 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDATE
);
1962 mdoc
->meta
.date
= time(NULL
);
1971 struct mdoc_node
*nn
, *n
;
1977 if (mdoc
->meta
.title
)
1978 free(mdoc
->meta
.title
);
1980 free(mdoc
->meta
.vol
);
1981 if (mdoc
->meta
.arch
)
1982 free(mdoc
->meta
.arch
);
1984 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
1986 /* First make all characters uppercase. */
1988 if (NULL
!= (nn
= n
->child
))
1989 for (p
= nn
->string
; *p
; p
++) {
1990 if (toupper((u_char
)*p
) == *p
)
1994 * FIXME: don't be lazy: have this make all
1995 * characters be uppercase and just warn once.
1997 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2002 * --> title = unknown, volume = local, msec = 0, arch = NULL
2005 if (NULL
== (nn
= n
->child
)) {
2006 /* XXX: make these macro values. */
2007 /* FIXME: warn about missing values. */
2008 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2009 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2010 mdoc
->meta
.msec
= mandoc_strdup("1");
2014 /* Handles: `.Dt TITLE'
2015 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2018 mdoc
->meta
.title
= mandoc_strdup
2019 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2021 if (NULL
== (nn
= nn
->next
)) {
2022 /* FIXME: warn about missing msec. */
2023 /* XXX: make this a macro value. */
2024 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2025 mdoc
->meta
.msec
= mandoc_strdup("1");
2029 /* Handles: `.Dt TITLE SEC'
2030 * --> title = TITLE, volume = SEC is msec ?
2031 * format(msec) : SEC,
2032 * msec = SEC is msec ? atoi(msec) : 0,
2036 cp
= mdoc_a2msec(nn
->string
);
2038 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2039 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2041 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2042 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2043 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2046 if (NULL
== (nn
= nn
->next
))
2049 /* Handles: `.Dt TITLE SEC VOL'
2050 * --> title = TITLE, volume = VOL is vol ?
2052 * VOL is arch ? format(arch) :
2056 cp
= mdoc_a2vol(nn
->string
);
2058 free(mdoc
->meta
.vol
);
2059 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2061 /* FIXME: warn about bad arch. */
2062 cp
= mdoc_a2arch(nn
->string
);
2064 free(mdoc
->meta
.vol
);
2065 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2067 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2070 /* Ignore any subsequent parameters... */
2071 /* FIXME: warn about subsequent parameters. */
2077 post_prol(POST_ARGS
)
2080 * Remove prologue macros from the document after they're
2081 * processed. The final document uses mdoc_meta for these
2082 * values and discards the originals.
2085 mdoc_node_delete(mdoc
, mdoc
->last
);
2086 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2087 mdoc
->flags
|= MDOC_PBODY
;
2095 struct mdoc_node
*n
;
2098 struct utsname utsname
;
2104 * Set the operating system by way of the `Os' macro. Note that
2105 * if an argument isn't provided and -DOSNAME="\"foo\"" is
2106 * provided during compilation, this value will be used instead
2107 * of filling in "sysname release" from uname().
2111 free(mdoc
->meta
.os
);
2113 if ( ! concat(mdoc
, buf
, n
->child
, BUFSIZ
))
2116 /* XXX: yes, these can all be dynamically-adjusted buffers, but
2117 * it's really not worth the extra hackery.
2120 if ('\0' == buf
[0]) {
2122 if (strlcat(buf
, OSNAME
, BUFSIZ
) >= BUFSIZ
) {
2123 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2127 if (uname(&utsname
)) {
2128 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2129 mdoc
->meta
.os
= mandoc_strdup("UNKNOWN");
2130 return(post_prol(mdoc
));
2133 if (strlcat(buf
, utsname
.sysname
, BUFSIZ
) >= BUFSIZ
) {
2134 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2137 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
2138 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2141 if (strlcat(buf
, utsname
.release
, BUFSIZ
) >= BUFSIZ
) {
2142 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2148 mdoc
->meta
.os
= mandoc_strdup(buf
);
2155 struct mdoc_node
*nn
, *n
;
2160 * Macros accepting `-std' as an argument have the name of the
2161 * current document (`Nm') filled in as the argument if it's not
2168 if (NULL
== mdoc
->meta
.name
)
2172 mdoc
->next
= MDOC_NEXT_CHILD
;
2174 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2182 concat(struct mdoc
*m
, char *p
, const struct mdoc_node
*n
, size_t sz
)
2188 * Concatenate sibling nodes together. All siblings must be of
2189 * type MDOC_TEXT or an assertion is raised. Concatenation is
2190 * separated by a single whitespace. Returns 0 on fatal (string
2194 for ( ; n
; n
= n
->next
) {
2195 assert(MDOC_TEXT
== n
->type
);
2197 if (strlcat(p
, n
->string
, sz
) >= sz
) {
2198 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);
2202 if (NULL
== n
->next
)
2205 if (strlcat(p
, " ", sz
) >= sz
) {
2206 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);