1 /* Id: mdoc_validate.c,v 1.198 2013/12/15 21:23:52 schwarze Exp */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 #include <sys/utsname.h>
26 #include <sys/types.h>
39 #include "libmandoc.h"
41 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
43 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
44 #define POST_ARGS struct mdoc *mdoc
60 typedef int (*v_pre
)(PRE_ARGS
);
61 typedef int (*v_post
)(POST_ARGS
);
68 static int check_count(struct mdoc
*, enum mdoc_type
,
69 enum check_lvl
, enum check_ineq
, int);
70 static int check_parent(PRE_ARGS
, enum mdoct
, enum mdoc_type
);
71 static void check_text(struct mdoc
*, int, int, char *);
72 static void check_argv(struct mdoc
*,
73 struct mdoc_node
*, struct mdoc_argv
*);
74 static void check_args(struct mdoc
*, struct mdoc_node
*);
75 static int concat(char *, const struct mdoc_node
*, size_t);
76 static enum mdoc_sec
a2sec(const char *);
77 static size_t macro2len(enum mdoct
);
79 static int ebool(POST_ARGS
);
80 static int berr_ge1(POST_ARGS
);
81 static int bwarn_ge1(POST_ARGS
);
82 static int ewarn_eq0(POST_ARGS
);
83 static int ewarn_eq1(POST_ARGS
);
84 static int ewarn_ge1(POST_ARGS
);
85 static int ewarn_le1(POST_ARGS
);
86 static int hwarn_eq0(POST_ARGS
);
87 static int hwarn_eq1(POST_ARGS
);
88 static int hwarn_ge1(POST_ARGS
);
89 static int hwarn_le1(POST_ARGS
);
91 static int post_an(POST_ARGS
);
92 static int post_at(POST_ARGS
);
93 static int post_bf(POST_ARGS
);
94 static int post_bl(POST_ARGS
);
95 static int post_bl_block(POST_ARGS
);
96 static int post_bl_block_width(POST_ARGS
);
97 static int post_bl_block_tag(POST_ARGS
);
98 static int post_bl_head(POST_ARGS
);
99 static int post_bx(POST_ARGS
);
100 static int post_defaults(POST_ARGS
);
101 static int post_dd(POST_ARGS
);
102 static int post_dt(POST_ARGS
);
103 static int post_eoln(POST_ARGS
);
104 static int post_hyph(POST_ARGS
);
105 static int post_ignpar(POST_ARGS
);
106 static int post_it(POST_ARGS
);
107 static int post_lb(POST_ARGS
);
108 static int post_literal(POST_ARGS
);
109 static int post_nm(POST_ARGS
);
110 static int post_ns(POST_ARGS
);
111 static int post_os(POST_ARGS
);
112 static int post_par(POST_ARGS
);
113 static int post_prol(POST_ARGS
);
114 static int post_root(POST_ARGS
);
115 static int post_rs(POST_ARGS
);
116 static int post_sh(POST_ARGS
);
117 static int post_sh_body(POST_ARGS
);
118 static int post_sh_head(POST_ARGS
);
119 static int post_st(POST_ARGS
);
120 static int post_std(POST_ARGS
);
121 static int post_vt(POST_ARGS
);
122 static int pre_an(PRE_ARGS
);
123 static int pre_bd(PRE_ARGS
);
124 static int pre_bl(PRE_ARGS
);
125 static int pre_dd(PRE_ARGS
);
126 static int pre_display(PRE_ARGS
);
127 static int pre_dt(PRE_ARGS
);
128 static int pre_it(PRE_ARGS
);
129 static int pre_literal(PRE_ARGS
);
130 static int pre_os(PRE_ARGS
);
131 static int pre_par(PRE_ARGS
);
132 static int pre_sh(PRE_ARGS
);
133 static int pre_ss(PRE_ARGS
);
134 static int pre_std(PRE_ARGS
);
136 static v_post posts_an
[] = { post_an
, NULL
};
137 static v_post posts_at
[] = { post_at
, post_defaults
, NULL
};
138 static v_post posts_bd
[] = { post_literal
, hwarn_eq0
, bwarn_ge1
, NULL
};
139 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
140 static v_post posts_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
141 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
142 static v_post posts_bx
[] = { post_bx
, NULL
};
143 static v_post posts_bool
[] = { ebool
, NULL
};
144 static v_post posts_eoln
[] = { post_eoln
, NULL
};
145 static v_post posts_defaults
[] = { post_defaults
, NULL
};
146 static v_post posts_d1
[] = { bwarn_ge1
, post_hyph
, NULL
};
147 static v_post posts_dd
[] = { post_dd
, post_prol
, NULL
};
148 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, NULL
};
149 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
150 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
151 static v_post posts_hyph
[] = { post_hyph
, NULL
};
152 static v_post posts_hyphtext
[] = { ewarn_ge1
, post_hyph
, NULL
};
153 static v_post posts_it
[] = { post_it
, NULL
};
154 static v_post posts_lb
[] = { post_lb
, NULL
};
155 static v_post posts_nd
[] = { berr_ge1
, post_hyph
, NULL
};
156 static v_post posts_nm
[] = { post_nm
, NULL
};
157 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
158 static v_post posts_ns
[] = { post_ns
, NULL
};
159 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
160 static v_post posts_pp
[] = { post_par
, ewarn_eq0
, NULL
};
161 static v_post posts_rs
[] = { post_rs
, NULL
};
162 static v_post posts_sh
[] = { post_ignpar
,hwarn_ge1
,post_sh
,post_hyph
,NULL
};
163 static v_post posts_sp
[] = { post_par
, ewarn_le1
, NULL
};
164 static v_post posts_ss
[] = { post_ignpar
, hwarn_ge1
, post_hyph
, NULL
};
165 static v_post posts_st
[] = { post_st
, NULL
};
166 static v_post posts_std
[] = { post_std
, NULL
};
167 static v_post posts_text
[] = { ewarn_ge1
, NULL
};
168 static v_post posts_text1
[] = { ewarn_eq1
, NULL
};
169 static v_post posts_vt
[] = { post_vt
, NULL
};
170 static v_pre pres_an
[] = { pre_an
, NULL
};
171 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
172 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
173 static v_pre pres_d1
[] = { pre_display
, NULL
};
174 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
175 static v_pre pres_dd
[] = { pre_dd
, NULL
};
176 static v_pre pres_dt
[] = { pre_dt
, NULL
};
177 static v_pre pres_it
[] = { pre_it
, pre_par
, NULL
};
178 static v_pre pres_os
[] = { pre_os
, NULL
};
179 static v_pre pres_pp
[] = { pre_par
, NULL
};
180 static v_pre pres_sh
[] = { pre_sh
, NULL
};
181 static v_pre pres_ss
[] = { pre_ss
, NULL
};
182 static v_pre pres_std
[] = { pre_std
, NULL
};
184 static const struct valids mdoc_valids
[MDOC_MAX
] = {
185 { NULL
, NULL
}, /* Ap */
186 { pres_dd
, posts_dd
}, /* Dd */
187 { pres_dt
, posts_dt
}, /* Dt */
188 { pres_os
, posts_os
}, /* Os */
189 { pres_sh
, posts_sh
}, /* Sh */
190 { pres_ss
, posts_ss
}, /* Ss */
191 { pres_pp
, posts_pp
}, /* Pp */
192 { pres_d1
, posts_d1
}, /* D1 */
193 { pres_dl
, posts_dl
}, /* Dl */
194 { pres_bd
, posts_bd
}, /* Bd */
195 { NULL
, NULL
}, /* Ed */
196 { pres_bl
, posts_bl
}, /* Bl */
197 { NULL
, NULL
}, /* El */
198 { pres_it
, posts_it
}, /* It */
199 { NULL
, NULL
}, /* Ad */
200 { pres_an
, posts_an
}, /* An */
201 { NULL
, posts_defaults
}, /* Ar */
202 { NULL
, NULL
}, /* Cd */
203 { NULL
, NULL
}, /* Cm */
204 { NULL
, NULL
}, /* Dv */
205 { NULL
, NULL
}, /* Er */
206 { NULL
, NULL
}, /* Ev */
207 { pres_std
, posts_std
}, /* Ex */
208 { NULL
, NULL
}, /* Fa */
209 { NULL
, posts_text
}, /* Fd */
210 { NULL
, NULL
}, /* Fl */
211 { NULL
, NULL
}, /* Fn */
212 { NULL
, NULL
}, /* Ft */
213 { NULL
, NULL
}, /* Ic */
214 { NULL
, posts_text1
}, /* In */
215 { NULL
, posts_defaults
}, /* Li */
216 { NULL
, posts_nd
}, /* Nd */
217 { NULL
, posts_nm
}, /* Nm */
218 { NULL
, NULL
}, /* Op */
219 { NULL
, NULL
}, /* Ot */
220 { NULL
, posts_defaults
}, /* Pa */
221 { pres_std
, posts_std
}, /* Rv */
222 { NULL
, posts_st
}, /* St */
223 { NULL
, NULL
}, /* Va */
224 { NULL
, posts_vt
}, /* Vt */
225 { NULL
, posts_text
}, /* Xr */
226 { NULL
, posts_text
}, /* %A */
227 { NULL
, posts_hyphtext
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
228 { NULL
, posts_text
}, /* %D */
229 { NULL
, posts_text
}, /* %I */
230 { NULL
, posts_text
}, /* %J */
231 { NULL
, posts_hyphtext
}, /* %N */
232 { NULL
, posts_hyphtext
}, /* %O */
233 { NULL
, posts_text
}, /* %P */
234 { NULL
, posts_hyphtext
}, /* %R */
235 { NULL
, posts_hyphtext
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
236 { NULL
, posts_text
}, /* %V */
237 { NULL
, NULL
}, /* Ac */
238 { NULL
, NULL
}, /* Ao */
239 { NULL
, NULL
}, /* Aq */
240 { NULL
, posts_at
}, /* At */
241 { NULL
, NULL
}, /* Bc */
242 { NULL
, posts_bf
}, /* Bf */
243 { NULL
, NULL
}, /* Bo */
244 { NULL
, NULL
}, /* Bq */
245 { NULL
, NULL
}, /* Bsx */
246 { NULL
, posts_bx
}, /* Bx */
247 { NULL
, posts_bool
}, /* Db */
248 { NULL
, NULL
}, /* Dc */
249 { NULL
, NULL
}, /* Do */
250 { NULL
, NULL
}, /* Dq */
251 { NULL
, NULL
}, /* Ec */
252 { NULL
, NULL
}, /* Ef */
253 { NULL
, NULL
}, /* Em */
254 { NULL
, NULL
}, /* Eo */
255 { NULL
, NULL
}, /* Fx */
256 { NULL
, NULL
}, /* Ms */
257 { NULL
, posts_notext
}, /* No */
258 { NULL
, posts_ns
}, /* Ns */
259 { NULL
, NULL
}, /* Nx */
260 { NULL
, NULL
}, /* Ox */
261 { NULL
, NULL
}, /* Pc */
262 { NULL
, posts_text1
}, /* Pf */
263 { NULL
, NULL
}, /* Po */
264 { NULL
, NULL
}, /* Pq */
265 { NULL
, NULL
}, /* Qc */
266 { NULL
, NULL
}, /* Ql */
267 { NULL
, NULL
}, /* Qo */
268 { NULL
, NULL
}, /* Qq */
269 { NULL
, NULL
}, /* Re */
270 { NULL
, posts_rs
}, /* Rs */
271 { NULL
, NULL
}, /* Sc */
272 { NULL
, NULL
}, /* So */
273 { NULL
, NULL
}, /* Sq */
274 { NULL
, posts_bool
}, /* Sm */
275 { NULL
, posts_hyph
}, /* Sx */
276 { NULL
, NULL
}, /* Sy */
277 { NULL
, NULL
}, /* Tn */
278 { NULL
, NULL
}, /* Ux */
279 { NULL
, NULL
}, /* Xc */
280 { NULL
, NULL
}, /* Xo */
281 { NULL
, posts_fo
}, /* Fo */
282 { NULL
, NULL
}, /* Fc */
283 { NULL
, NULL
}, /* Oo */
284 { NULL
, NULL
}, /* Oc */
285 { NULL
, posts_bk
}, /* Bk */
286 { NULL
, NULL
}, /* Ek */
287 { NULL
, posts_eoln
}, /* Bt */
288 { NULL
, NULL
}, /* Hf */
289 { NULL
, NULL
}, /* Fr */
290 { NULL
, posts_eoln
}, /* Ud */
291 { NULL
, posts_lb
}, /* Lb */
292 { pres_pp
, posts_pp
}, /* Lp */
293 { NULL
, NULL
}, /* Lk */
294 { NULL
, posts_defaults
}, /* Mt */
295 { NULL
, NULL
}, /* Brq */
296 { NULL
, NULL
}, /* Bro */
297 { NULL
, NULL
}, /* Brc */
298 { NULL
, posts_text
}, /* %C */
299 { NULL
, NULL
}, /* Es */
300 { NULL
, NULL
}, /* En */
301 { NULL
, NULL
}, /* Dx */
302 { NULL
, posts_text
}, /* %Q */
303 { NULL
, posts_pp
}, /* br */
304 { NULL
, posts_sp
}, /* sp */
305 { NULL
, posts_text1
}, /* %U */
306 { NULL
, NULL
}, /* Ta */
309 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
311 static const enum mdoct rsord
[RSORD_MAX
] = {
328 static const char * const secnames
[SEC__MAX
] = {
334 "IMPLEMENTATION NOTES",
349 "SECURITY CONSIDERATIONS",
354 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
365 check_text(mdoc
, line
, pos
, tp
);
379 if (NULL
== mdoc_valids
[n
->tok
].pre
)
381 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
382 if ( ! (*p
)(mdoc
, n
))
389 mdoc_valid_post(struct mdoc
*mdoc
)
393 if (MDOC_VALID
& mdoc
->last
->flags
)
395 mdoc
->last
->flags
|= MDOC_VALID
;
397 switch (mdoc
->last
->type
) {
405 return(post_root(mdoc
));
410 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
412 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
420 check_count(struct mdoc
*mdoc
, enum mdoc_type type
,
421 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
426 if (mdoc
->last
->type
!= type
)
432 if (mdoc
->last
->nchild
< val
)
437 if (mdoc
->last
->nchild
> val
)
442 if (val
== mdoc
->last
->nchild
)
450 t
= lvl
== CHECK_WARN
? MANDOCERR_ARGCWARN
: MANDOCERR_ARGCOUNT
;
451 mandoc_vmsg(t
, mdoc
->parse
, mdoc
->last
->line
, mdoc
->last
->pos
,
452 "want %s%d children (have %d)",
453 p
, val
, mdoc
->last
->nchild
);
461 return(check_count(mdoc
, MDOC_BODY
, CHECK_ERROR
, CHECK_GT
, 0));
467 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
473 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
479 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1));
485 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
491 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_LT
, 2));
497 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
503 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
509 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_GT
, 0));
515 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
519 check_args(struct mdoc
*mdoc
, struct mdoc_node
*n
)
526 assert(n
->args
->argc
);
527 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
528 check_argv(mdoc
, n
, &n
->args
->argv
[i
]);
532 check_argv(struct mdoc
*mdoc
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
536 for (i
= 0; i
< (int)v
->sz
; i
++)
537 check_text(mdoc
, v
->line
, v
->pos
, v
->value
[i
]);
539 /* FIXME: move to post_std(). */
541 if (MDOC_Std
== v
->arg
)
542 if ( ! (v
->sz
|| mdoc
->meta
.name
))
543 mdoc_nmsg(mdoc
, n
, MANDOCERR_NONAME
);
547 check_text(struct mdoc
*mdoc
, int ln
, int pos
, char *p
)
551 if (MDOC_LITERAL
& mdoc
->flags
)
554 for (cp
= p
; NULL
!= (p
= strchr(p
, '\t')); p
++)
555 mdoc_pmsg(mdoc
, ln
, pos
+ (int)(p
- cp
), MANDOCERR_BADTAB
);
559 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
563 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
564 (t
== n
->parent
->type
))
567 mandoc_vmsg(MANDOCERR_SYNTCHILD
, mdoc
->parse
, n
->line
,
568 n
->pos
, "want parent %s", MDOC_ROOT
== t
?
569 "<root>" : mdoc_macronames
[tok
]);
575 pre_display(PRE_ARGS
)
577 struct mdoc_node
*node
;
579 if (MDOC_BLOCK
!= n
->type
)
582 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
583 if (MDOC_BLOCK
== node
->type
)
584 if (MDOC_Bd
== node
->tok
)
588 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
598 const char *offs
, *width
;
600 #if !defined(NDEBUG) && defined(__minix)
601 struct mdoc_node
*np
;
602 #endif /* !defined(NDEBUG) && defined(__minix) */
604 if (MDOC_BLOCK
!= n
->type
) {
605 #if !defined(NDEBUG) && defined(__minix)
606 if (ENDBODY_NOT
!= n
->end
) {
608 np
= n
->pending
->parent
;
613 assert(MDOC_BLOCK
== np
->type
);
614 assert(MDOC_Bl
== np
->tok
);
615 #endif /* !defined(NDEBUG) && defined(__minix) */
620 * First figure out which kind of list to use: bind ourselves to
621 * the first mentioned list type and warn about any remaining
622 * ones. If we find no list type, we default to LIST_item.
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
->norm
->Bl
.comp
;
671 /* NB: this can be empty! */
672 if (n
->args
->argv
[i
].sz
) {
673 width
= n
->args
->argv
[i
].value
[0];
674 dup
= (NULL
!= n
->norm
->Bl
.width
);
677 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
680 /* NB: this can be empty! */
681 if (n
->args
->argv
[i
].sz
) {
682 offs
= n
->args
->argv
[i
].value
[0];
683 dup
= (NULL
!= n
->norm
->Bl
.offs
);
686 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
692 /* Check: duplicate auxiliary arguments. */
695 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
698 n
->norm
->Bl
.comp
= comp
;
700 n
->norm
->Bl
.offs
= offs
;
702 n
->norm
->Bl
.width
= width
;
704 /* Check: multiple list types. */
706 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
!= LIST__NONE
)
707 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
709 /* Assign list type. */
711 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
== LIST__NONE
) {
712 n
->norm
->Bl
.type
= lt
;
713 /* Set column information, too. */
714 if (LIST_column
== lt
) {
717 n
->norm
->Bl
.cols
= (void *)
718 n
->args
->argv
[i
].value
;
722 /* The list type should come first. */
724 if (n
->norm
->Bl
.type
== LIST__NONE
)
725 if (n
->norm
->Bl
.width
||
728 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
733 /* Allow lists to default to LIST_item. */
735 if (LIST__NONE
== n
->norm
->Bl
.type
) {
736 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
737 n
->norm
->Bl
.type
= LIST_item
;
741 * Validate the width field. Some list types don't need width
742 * types and should be warned about them. Others should have it
743 * and must also be warned. Yet others have a default and need
747 switch (n
->norm
->Bl
.type
) {
749 if (NULL
== n
->norm
->Bl
.width
)
750 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
761 if (n
->norm
->Bl
.width
)
762 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
769 if (NULL
== n
->norm
->Bl
.width
)
770 n
->norm
->Bl
.width
= "2n";
773 if (NULL
== n
->norm
->Bl
.width
)
774 n
->norm
->Bl
.width
= "3n";
790 #if !defined(NDEBUG) && defined(__minix)
791 struct mdoc_node
*np
;
792 #endif /* !defined(NDEBUG) && defined(__minix) */
794 if (MDOC_BLOCK
!= n
->type
) {
795 #if !defined(NDEBUG) && defined(__minix)
796 if (ENDBODY_NOT
!= n
->end
) {
798 np
= n
->pending
->parent
;
803 assert(MDOC_BLOCK
== np
->type
);
804 assert(MDOC_Bd
== np
->tok
);
805 #endif /* !defined(NDEBUG) && defined(__minix) */
810 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
815 switch (n
->args
->argv
[i
].arg
) {
822 case (MDOC_Unfilled
):
832 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
835 /* NB: this can be empty! */
836 if (n
->args
->argv
[i
].sz
) {
837 offs
= n
->args
->argv
[i
].value
[0];
838 dup
= (NULL
!= n
->norm
->Bd
.offs
);
841 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
845 dup
= n
->norm
->Bd
.comp
;
852 /* Check whether we have duplicates. */
855 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
857 /* Make our auxiliary assignments. */
860 n
->norm
->Bd
.offs
= offs
;
862 n
->norm
->Bd
.comp
= comp
;
864 /* Check whether a type has already been assigned. */
866 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
!= DISP__NONE
)
867 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
869 /* Make our type assignment. */
871 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
== DISP__NONE
)
872 n
->norm
->Bd
.type
= dt
;
875 if (DISP__NONE
== n
->norm
->Bd
.type
) {
876 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
877 n
->norm
->Bd
.type
= DISP_ragged
;
888 if (MDOC_BLOCK
!= n
->type
)
890 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
898 if (MDOC_BLOCK
!= n
->type
)
900 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
908 if (MDOC_BLOCK
!= n
->type
)
911 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
923 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
924 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
925 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
927 if (MDOC_Split
== n
->args
->argv
[0].arg
)
928 n
->norm
->An
.auth
= AUTH_split
;
929 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
930 n
->norm
->An
.auth
= AUTH_nosplit
;
941 if (n
->args
&& 1 == n
->args
->argc
)
942 if (MDOC_Std
== n
->args
->argv
[0].arg
)
945 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
953 if (NULL
== mdoc
->meta
.date
|| mdoc
->meta
.os
)
954 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
956 if (mdoc
->meta
.title
)
957 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
966 if (NULL
== mdoc
->meta
.title
|| NULL
== mdoc
->meta
.date
)
967 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
970 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
979 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
980 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
983 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
992 struct mdoc_node
*np
;
996 * Unlike other data pointers, these are "housed" by the HEAD
997 * element, which contains the goods.
1000 if (MDOC_HEAD
!= mdoc
->last
->type
) {
1001 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
1002 assert(mdoc
->last
->pending
);
1003 np
= mdoc
->last
->pending
->parent
->head
;
1004 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
1005 np
= mdoc
->last
->parent
->head
;
1007 np
= mdoc
->last
->head
;
1010 assert(MDOC_HEAD
== np
->type
);
1011 assert(MDOC_Bf
== np
->tok
);
1016 assert(MDOC_BLOCK
== np
->parent
->type
);
1017 assert(MDOC_Bf
== np
->parent
->tok
);
1020 * Cannot have both argument and parameter.
1021 * If neither is specified, let it through with a warning.
1024 if (np
->parent
->args
&& np
->child
) {
1025 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
1027 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
1028 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1032 /* Extract argument into data. */
1034 if (np
->parent
->args
) {
1035 arg
= np
->parent
->args
->argv
[0].arg
;
1036 if (MDOC_Emphasis
== arg
)
1037 np
->norm
->Bf
.font
= FONT_Em
;
1038 else if (MDOC_Literal
== arg
)
1039 np
->norm
->Bf
.font
= FONT_Li
;
1040 else if (MDOC_Symbolic
== arg
)
1041 np
->norm
->Bf
.font
= FONT_Sy
;
1047 /* Extract parameter into data. */
1049 if (0 == strcmp(np
->child
->string
, "Em"))
1050 np
->norm
->Bf
.font
= FONT_Em
;
1051 else if (0 == strcmp(np
->child
->string
, "Li"))
1052 np
->norm
->Bf
.font
= FONT_Li
;
1053 else if (0 == strcmp(np
->child
->string
, "Sy"))
1054 np
->norm
->Bf
.font
= FONT_Sy
;
1056 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1068 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1070 assert(mdoc
->last
->child
);
1071 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1073 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1075 /* If lookup ok, replace with table value. */
1078 free(mdoc
->last
->child
->string
);
1079 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1083 /* If not, use "library ``xxxx''. */
1085 sz
= strlen(mdoc
->last
->child
->string
) +
1086 2 + strlen("\\(lqlibrary\\(rq");
1087 buf
= mandoc_malloc(sz
);
1088 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1089 mdoc
->last
->child
->string
);
1090 free(mdoc
->last
->child
->string
);
1091 mdoc
->last
->child
->string
= buf
;
1096 post_eoln(POST_ARGS
)
1099 if (mdoc
->last
->child
)
1100 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1108 const struct mdoc_node
*n
;
1111 * The Vt macro comes in both ELEM and BLOCK form, both of which
1112 * have different syntaxes (yet more context-sensitive
1113 * behaviour). ELEM types must have a child, which is already
1114 * guaranteed by the in_line parsing routine; BLOCK types,
1115 * specifically the BODY, should only have TEXT children.
1118 if (MDOC_BODY
!= mdoc
->last
->type
)
1121 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1122 if (MDOC_TEXT
!= n
->type
)
1123 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1135 if (NULL
!= mdoc
->meta
.name
)
1138 /* Try to use our children for setting the meta name. */
1140 if (NULL
!= mdoc
->last
->child
) {
1142 c
= concat(buf
, mdoc
->last
->child
, BUFSIZ
);
1148 mdoc_nmsg(mdoc
, mdoc
->last
->child
, MANDOCERR_MEM
);
1151 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1152 mdoc
->meta
.name
= mandoc_strdup("UNKNOWN");
1155 mdoc
->meta
.name
= mandoc_strdup(buf
);
1162 post_literal(POST_ARGS
)
1166 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1167 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1168 * this in literal mode, but it doesn't hurt to just switch it
1169 * off in general since displays can't be nested.
1172 if (MDOC_BODY
== mdoc
->last
->type
)
1173 mdoc
->flags
&= ~MDOC_LITERAL
;
1179 post_defaults(POST_ARGS
)
1181 struct mdoc_node
*nn
;
1184 * The `Ar' defaults to "file ..." if no value is provided as an
1185 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1186 * gets an empty string.
1189 if (mdoc
->last
->child
)
1193 mdoc
->next
= MDOC_NEXT_CHILD
;
1197 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1199 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1203 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1205 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1209 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1215 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1235 * If we have a child, look it up in the standard keys. If a
1236 * key exist, use that instead of the child; if it doesn't,
1237 * prefix "AT&T UNIX " to the existing data.
1240 if (NULL
== mdoc
->last
->child
)
1243 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1244 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1247 free(mdoc
->last
->child
->string
);
1248 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1250 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1252 q
= mdoc
->last
->child
->string
;
1253 sz
= strlen(p
) + strlen(q
) + 1;
1254 buf
= mandoc_malloc(sz
);
1255 strlcpy(buf
, p
, sz
);
1256 strlcat(buf
, q
, sz
);
1257 free(mdoc
->last
->child
->string
);
1258 mdoc
->last
->child
->string
= buf
;
1267 struct mdoc_node
*np
;
1270 if (AUTH__NONE
== np
->norm
->An
.auth
) {
1272 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0);
1273 } else if (np
->child
)
1274 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0);
1285 struct mdoc_node
*n
, *c
;
1288 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1291 n
= mdoc
->last
->parent
->parent
;
1292 lt
= n
->norm
->Bl
.type
;
1294 if (LIST__NONE
== lt
) {
1295 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1301 if (mdoc
->last
->head
->child
)
1303 /* FIXME: give this a dummy value. */
1304 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1313 if (NULL
== mdoc
->last
->head
->child
)
1314 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1323 if (NULL
== mdoc
->last
->body
->child
)
1324 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1327 if (mdoc
->last
->head
->child
)
1328 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1331 cols
= (int)n
->norm
->Bl
.ncols
;
1333 assert(NULL
== mdoc
->last
->head
->child
);
1335 if (NULL
== mdoc
->last
->body
->child
)
1336 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1338 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1339 if (MDOC_BODY
== c
->type
)
1343 er
= MANDOCERR_ARGCOUNT
;
1344 else if (i
== cols
|| i
== cols
+ 1)
1347 er
= MANDOCERR_SYNTARGCOUNT
;
1349 mandoc_vmsg(er
, mdoc
->parse
, mdoc
->last
->line
,
1351 "columns == %d (have %d)", cols
, i
);
1352 return(MANDOCERR_ARGCOUNT
== er
);
1361 post_bl_block(POST_ARGS
)
1363 struct mdoc_node
*n
, *ni
, *nc
;
1366 * These are fairly complicated, so we've broken them into two
1367 * functions. post_bl_block_tag() is called when a -tag is
1368 * specified, but no -width (it must be guessed). The second
1369 * when a -width is specified (macro indicators must be
1370 * rewritten into real lengths).
1375 if (LIST_tag
== n
->norm
->Bl
.type
&&
1376 NULL
== n
->norm
->Bl
.width
) {
1377 if ( ! post_bl_block_tag(mdoc
))
1379 assert(n
->norm
->Bl
.width
);
1380 } else if (NULL
!= n
->norm
->Bl
.width
) {
1381 if ( ! post_bl_block_width(mdoc
))
1383 assert(n
->norm
->Bl
.width
);
1386 for (ni
= n
->body
->child
; ni
; ni
= ni
->next
) {
1387 if (NULL
== ni
->body
)
1389 nc
= ni
->body
->last
;
1390 while (NULL
!= nc
) {
1402 if (NULL
== ni
->next
) {
1403 mdoc_nmsg(mdoc
, nc
, MANDOCERR_MOVEPAR
);
1404 if ( ! mdoc_node_relink(mdoc
, nc
))
1406 } else if (0 == n
->norm
->Bl
.comp
&&
1407 LIST_column
!= n
->norm
->Bl
.type
) {
1408 mdoc_nmsg(mdoc
, nc
, MANDOCERR_IGNPAR
);
1409 mdoc_node_delete(mdoc
, nc
);
1412 nc
= ni
->body
->last
;
1419 post_bl_block_width(POST_ARGS
)
1424 struct mdoc_node
*n
;
1430 * Calculate the real width of a list from the -width string,
1431 * which may contain a macro (with a known default width), a
1432 * literal string, or a scaling width.
1434 * If the value to -width is a macro, then we re-write it to be
1435 * the macro's width as set in share/tmac/mdoc/doc-common.
1438 if (0 == strcmp(n
->norm
->Bl
.width
, "Ds"))
1440 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->norm
->Bl
.width
)))
1442 else if (0 == (width
= macro2len(tok
))) {
1443 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1447 /* The value already exists: free and reallocate it. */
1451 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1452 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1455 assert(i
< (int)n
->args
->argc
);
1457 snprintf(buf
, NUMSIZ
, "%un", (unsigned int)width
);
1458 free(n
->args
->argv
[i
].value
[0]);
1459 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1461 /* Set our width! */
1462 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1467 post_bl_block_tag(POST_ARGS
)
1469 struct mdoc_node
*n
, *nn
;
1475 * Calculate the -width for a `Bl -tag' list if it hasn't been
1476 * provided. Uses the first head macro. NOTE AGAIN: this is
1477 * ONLY if the -width argument has NOT been provided. See
1478 * post_bl_block_width() for converting the -width string.
1484 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1485 if (MDOC_It
!= nn
->tok
)
1488 assert(MDOC_BLOCK
== nn
->type
);
1489 nn
= nn
->head
->child
;
1494 if (MDOC_TEXT
== nn
->type
) {
1495 sz
= strlen(nn
->string
) + 1;
1499 if (0 != (ssz
= macro2len(nn
->tok
)))
1505 /* Defaults to ten ens. */
1507 snprintf(buf
, NUMSIZ
, "%un", (unsigned int)sz
);
1510 * We have to dynamically add this to the macro's argument list.
1511 * We're guaranteed that a MDOC_Width doesn't already exist.
1515 i
= (int)(n
->args
->argc
)++;
1517 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1518 n
->args
->argc
* sizeof(struct mdoc_argv
));
1520 n
->args
->argv
[i
].arg
= MDOC_Width
;
1521 n
->args
->argv
[i
].line
= n
->line
;
1522 n
->args
->argv
[i
].pos
= n
->pos
;
1523 n
->args
->argv
[i
].sz
= 1;
1524 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1525 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1527 /* Set our width! */
1528 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1534 post_bl_head(POST_ARGS
)
1536 struct mdoc_node
*np
, *nn
, *nnp
;
1539 if (LIST_column
!= mdoc
->last
->norm
->Bl
.type
)
1540 /* FIXME: this should be ERROR class... */
1541 return(hwarn_eq0(mdoc
));
1544 * Convert old-style lists, where the column width specifiers
1545 * trail as macro parameters, to the new-style ("normal-form")
1546 * lists where they're argument values following -column.
1549 /* First, disallow both types and allow normal-form. */
1552 * TODO: technically, we can accept both and just merge the two
1553 * lists, but I'll leave that for another day.
1556 if (mdoc
->last
->norm
->Bl
.ncols
&& mdoc
->last
->nchild
) {
1557 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1559 } else if (NULL
== mdoc
->last
->child
)
1562 np
= mdoc
->last
->parent
;
1565 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1566 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1569 assert(j
< (int)np
->args
->argc
);
1570 assert(0 == np
->args
->argv
[j
].sz
);
1573 * Accommodate for new-style groff column syntax. Shuffle the
1574 * child nodes, all of which must be TEXT, as arguments for the
1575 * column field. Then, delete the head children.
1578 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1579 np
->args
->argv
[j
].value
= mandoc_malloc
1580 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1582 mdoc
->last
->norm
->Bl
.ncols
= np
->args
->argv
[j
].sz
;
1583 mdoc
->last
->norm
->Bl
.cols
= (void *)np
->args
->argv
[j
].value
;
1585 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1586 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1590 mdoc_node_delete(NULL
, nnp
);
1593 mdoc
->last
->nchild
= 0;
1594 mdoc
->last
->child
= NULL
;
1602 struct mdoc_node
*nparent
, *nprev
; /* of the Bl block */
1603 struct mdoc_node
*nblock
, *nbody
; /* of the Bl */
1604 struct mdoc_node
*nchild
, *nnext
; /* of the Bl body */
1607 switch (nbody
->type
) {
1609 return(post_bl_block(mdoc
));
1611 return(post_bl_head(mdoc
));
1618 nchild
= nbody
->child
;
1619 while (NULL
!= nchild
) {
1620 if (MDOC_It
== nchild
->tok
|| MDOC_Sm
== nchild
->tok
) {
1621 nchild
= nchild
->next
;
1625 mdoc_nmsg(mdoc
, nchild
, MANDOCERR_CHILD
);
1628 * Move the node out of the Bl block.
1629 * First, collect all required node pointers.
1632 nblock
= nbody
->parent
;
1633 nprev
= nblock
->prev
;
1634 nparent
= nblock
->parent
;
1635 nnext
= nchild
->next
;
1638 * Unlink this child.
1641 assert(NULL
== nchild
->prev
);
1642 if (0 == --nbody
->nchild
) {
1643 nbody
->child
= NULL
;
1645 assert(NULL
== nnext
);
1647 nbody
->child
= nnext
;
1652 * Relink this child.
1655 nchild
->parent
= nparent
;
1656 nchild
->prev
= nprev
;
1657 nchild
->next
= nblock
;
1659 nblock
->prev
= nchild
;
1662 nparent
->child
= nchild
;
1664 nprev
->next
= nchild
;
1673 ebool(struct mdoc
*mdoc
)
1676 if (NULL
== mdoc
->last
->child
) {
1677 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1678 mdoc_node_delete(mdoc
, mdoc
->last
);
1681 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1683 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1685 if (0 == strcmp(mdoc
->last
->child
->string
, "on")) {
1686 if (MDOC_Sm
== mdoc
->last
->tok
)
1687 mdoc
->flags
&= ~MDOC_SMOFF
;
1690 if (0 == strcmp(mdoc
->last
->child
->string
, "off")) {
1691 if (MDOC_Sm
== mdoc
->last
->tok
)
1692 mdoc
->flags
|= MDOC_SMOFF
;
1696 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1701 post_root(POST_ARGS
)
1704 struct mdoc_node
*n
;
1708 /* Check that we have a finished prologue. */
1710 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1712 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1718 /* Check that we begin with a proper `Sh'. */
1720 if (NULL
== n
->child
) {
1722 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1723 } else if (MDOC_BLOCK
!= n
->child
->type
||
1724 MDOC_Sh
!= n
->child
->tok
) {
1726 /* Can this be lifted? See rxdebug.1 for example. */
1727 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1730 return(erc
? 0 : 1);
1736 struct mdoc_node
*ch
;
1739 if (NULL
== (ch
= mdoc
->last
->child
)) {
1740 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1741 mdoc_node_delete(mdoc
, mdoc
->last
);
1745 assert(MDOC_TEXT
== ch
->type
);
1747 if (NULL
== (p
= mdoc_a2st(ch
->string
))) {
1748 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1749 mdoc_node_delete(mdoc
, mdoc
->last
);
1752 ch
->string
= mandoc_strdup(p
);
1761 struct mdoc_node
*nn
, *next
, *prev
;
1764 switch (mdoc
->last
->type
) {
1766 check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0);
1769 if (mdoc
->last
->child
)
1771 check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0);
1778 * Make sure only certain types of nodes are allowed within the
1779 * the `Rs' body. Delete offending nodes and raise a warning.
1780 * Do this before re-ordering for the sake of clarity.
1784 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1785 for (i
= 0; i
< RSORD_MAX
; i
++)
1786 if (nn
->tok
== rsord
[i
])
1789 if (i
< RSORD_MAX
) {
1790 if (MDOC__J
== rsord
[i
] || MDOC__B
== rsord
[i
])
1791 mdoc
->last
->norm
->Rs
.quote_T
++;
1797 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1798 mdoc_node_delete(mdoc
, nn
);
1802 * Nothing to sort if only invalid nodes were found
1803 * inside the `Rs' body.
1806 if (NULL
== mdoc
->last
->child
)
1810 * The full `Rs' block needs special handling to order the
1811 * sub-elements according to `rsord'. Pick through each element
1812 * and correctly order it. This is a insertion sort.
1816 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1817 /* Determine order of `nn'. */
1818 for (i
= 0; i
< RSORD_MAX
; i
++)
1819 if (rsord
[i
] == nn
->tok
)
1823 * Remove `nn' from the chain. This somewhat
1824 * repeats mdoc_node_unlink(), but since we're
1825 * just re-ordering, there's no need for the
1826 * full unlink process.
1829 if (NULL
!= (next
= nn
->next
))
1830 next
->prev
= nn
->prev
;
1832 if (NULL
!= (prev
= nn
->prev
))
1833 prev
->next
= nn
->next
;
1835 nn
->prev
= nn
->next
= NULL
;
1838 * Scan back until we reach a node that's
1839 * ordered before `nn'.
1842 for ( ; prev
; prev
= prev
->prev
) {
1843 /* Determine order of `prev'. */
1844 for (j
= 0; j
< RSORD_MAX
; j
++)
1845 if (rsord
[j
] == prev
->tok
)
1853 * Set `nn' back into its correct place in front
1854 * of the `prev' node.
1861 prev
->next
->prev
= nn
;
1862 nn
->next
= prev
->next
;
1865 mdoc
->last
->child
->prev
= nn
;
1866 nn
->next
= mdoc
->last
->child
;
1867 mdoc
->last
->child
= nn
;
1875 * For some arguments of some macros,
1876 * convert all breakable hyphens into ASCII_HYPH.
1879 post_hyph(POST_ARGS
)
1881 struct mdoc_node
*n
, *nch
;
1887 if (MDOC_Sh
== n
->tok
|| MDOC_Ss
== n
->tok
)
1891 if (MDOC_D1
== n
->tok
|| MDOC_Nd
== n
->tok
)
1900 for (nch
= n
->child
; nch
; nch
= nch
->next
) {
1901 if (MDOC_TEXT
!= nch
->type
)
1904 if (3 > strnlen(cp
, 3))
1906 while ('\0' != *(++cp
))
1908 isalpha((unsigned char)cp
[-1]) &&
1909 isalpha((unsigned char)cp
[1]))
1919 if (MDOC_LINE
& mdoc
->last
->flags
)
1920 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNNS
);
1928 if (MDOC_HEAD
== mdoc
->last
->type
)
1929 return(post_sh_head(mdoc
));
1930 if (MDOC_BODY
== mdoc
->last
->type
)
1931 return(post_sh_body(mdoc
));
1937 post_sh_body(POST_ARGS
)
1939 struct mdoc_node
*n
;
1941 if (SEC_NAME
!= mdoc
->lastsec
)
1945 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1946 * macros (can have multiple `Nm' and one `Nd'). Note that the
1947 * children of the BODY declaration can also be "text".
1950 if (NULL
== (n
= mdoc
->last
->child
)) {
1951 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1955 for ( ; n
&& n
->next
; n
= n
->next
) {
1956 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1958 if (MDOC_TEXT
== n
->type
)
1960 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1964 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1967 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1972 post_sh_head(POST_ARGS
)
1975 struct mdoc_node
*n
;
1980 * Process a new section. Sections are either "named" or
1981 * "custom". Custom sections are user-defined, while named ones
1982 * follow a conventional order and may only appear in certain
1988 if (-1 == (c
= concat(buf
, mdoc
->last
->child
, BUFSIZ
))) {
1989 mdoc_nmsg(mdoc
, mdoc
->last
->child
, MANDOCERR_MEM
);
1994 /* The NAME should be first. */
1996 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1997 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1999 /* The SYNOPSIS gets special attention in other areas. */
2001 if (SEC_SYNOPSIS
== sec
) {
2002 roff_setreg(mdoc
->roff
, "nS", 1, '=');
2003 mdoc
->flags
|= MDOC_SYNOPSIS
;
2005 roff_setreg(mdoc
->roff
, "nS", 0, '=');
2006 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
2009 /* Mark our last section. */
2011 mdoc
->lastsec
= sec
;
2014 * Set the section attribute for the current HEAD, for its
2015 * parent BLOCK, and for the HEAD children; the latter can
2016 * only be TEXT nodes, so no recursion is needed.
2017 * For other blocks and elements, including .Sh BODY, this is
2018 * done when allocating the node data structures, but for .Sh
2019 * BLOCK and HEAD, the section is still unknown at that time.
2022 mdoc
->last
->parent
->sec
= sec
;
2023 mdoc
->last
->sec
= sec
;
2024 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
2027 /* We don't care about custom sections after this. */
2029 if (SEC_CUSTOM
== sec
)
2033 * Check whether our non-custom section is being repeated or is
2037 if (sec
== mdoc
->lastnamed
)
2038 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
2040 if (sec
< mdoc
->lastnamed
)
2041 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
2043 /* Mark the last named section. */
2045 mdoc
->lastnamed
= sec
;
2047 /* Check particular section/manual conventions. */
2049 assert(mdoc
->meta
.msec
);
2052 case (SEC_RETURN_VALUES
):
2057 if (*mdoc
->meta
.msec
== '2')
2059 if (*mdoc
->meta
.msec
== '3')
2061 if (*mdoc
->meta
.msec
== '9')
2063 mandoc_msg(MANDOCERR_SECMSEC
, mdoc
->parse
,
2064 mdoc
->last
->line
, mdoc
->last
->pos
, buf
);
2074 post_ignpar(POST_ARGS
)
2076 struct mdoc_node
*np
;
2078 if (MDOC_BODY
!= mdoc
->last
->type
)
2081 if (NULL
!= (np
= mdoc
->last
->child
))
2082 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
2083 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
2084 mdoc_node_delete(mdoc
, np
);
2087 if (NULL
!= (np
= mdoc
->last
->last
))
2088 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
2089 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
2090 mdoc_node_delete(mdoc
, np
);
2100 if (NULL
== mdoc
->last
)
2102 if (MDOC_ELEM
!= n
->type
&& MDOC_BLOCK
!= n
->type
)
2106 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
2107 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
2110 if (MDOC_Pp
!= mdoc
->last
->tok
&&
2111 MDOC_Lp
!= mdoc
->last
->tok
&&
2112 MDOC_br
!= mdoc
->last
->tok
)
2114 if (MDOC_Bl
== n
->tok
&& n
->norm
->Bl
.comp
)
2116 if (MDOC_Bd
== n
->tok
&& n
->norm
->Bd
.comp
)
2118 if (MDOC_It
== n
->tok
&& n
->parent
->norm
->Bl
.comp
)
2121 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
2122 mdoc_node_delete(mdoc
, mdoc
->last
);
2130 if (MDOC_ELEM
!= mdoc
->last
->type
&&
2131 MDOC_BLOCK
!= mdoc
->last
->type
)
2134 if (NULL
== mdoc
->last
->prev
) {
2135 if (MDOC_Sh
!= mdoc
->last
->parent
->tok
&&
2136 MDOC_Ss
!= mdoc
->last
->parent
->tok
)
2139 if (MDOC_Pp
!= mdoc
->last
->prev
->tok
&&
2140 MDOC_Lp
!= mdoc
->last
->prev
->tok
&&
2141 (MDOC_br
!= mdoc
->last
->tok
||
2142 (MDOC_sp
!= mdoc
->last
->prev
->tok
&&
2143 MDOC_br
!= mdoc
->last
->prev
->tok
)))
2147 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
2148 mdoc_node_delete(mdoc
, mdoc
->last
);
2153 pre_literal(PRE_ARGS
)
2156 if (MDOC_BODY
!= n
->type
)
2160 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
2161 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
2166 mdoc
->flags
|= MDOC_LITERAL
;
2169 if (DISP_literal
== n
->norm
->Bd
.type
)
2170 mdoc
->flags
|= MDOC_LITERAL
;
2171 if (DISP_unfilled
== n
->norm
->Bd
.type
)
2172 mdoc
->flags
|= MDOC_LITERAL
;
2186 struct mdoc_node
*n
;
2189 if (mdoc
->meta
.date
)
2190 free(mdoc
->meta
.date
);
2193 if (NULL
== n
->child
|| '\0' == n
->child
->string
[0]) {
2194 mdoc
->meta
.date
= mandoc_normdate
2195 (mdoc
->parse
, NULL
, n
->line
, n
->pos
);
2200 if (-1 == (c
= concat(buf
, n
->child
, DATESIZE
))) {
2201 mdoc_nmsg(mdoc
, n
->child
, MANDOCERR_MEM
);
2206 mdoc
->meta
.date
= mandoc_normdate
2207 (mdoc
->parse
, buf
, n
->line
, n
->pos
);
2215 struct mdoc_node
*nn
, *n
;
2221 if (mdoc
->meta
.title
)
2222 free(mdoc
->meta
.title
);
2224 free(mdoc
->meta
.vol
);
2225 if (mdoc
->meta
.arch
)
2226 free(mdoc
->meta
.arch
);
2228 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
2230 /* First make all characters uppercase. */
2232 if (NULL
!= (nn
= n
->child
))
2233 for (p
= nn
->string
; *p
; p
++) {
2234 if (toupper((unsigned char)*p
) == *p
)
2238 * FIXME: don't be lazy: have this make all
2239 * characters be uppercase and just warn once.
2241 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2246 * --> title = unknown, volume = local, msec = 0, arch = NULL
2249 if (NULL
== (nn
= n
->child
)) {
2250 /* XXX: make these macro values. */
2251 /* FIXME: warn about missing values. */
2252 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2253 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2254 mdoc
->meta
.msec
= mandoc_strdup("1");
2258 /* Handles: `.Dt TITLE'
2259 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2262 mdoc
->meta
.title
= mandoc_strdup
2263 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2265 if (NULL
== (nn
= nn
->next
)) {
2266 /* FIXME: warn about missing msec. */
2267 /* XXX: make this a macro value. */
2268 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2269 mdoc
->meta
.msec
= mandoc_strdup("1");
2273 /* Handles: `.Dt TITLE SEC'
2274 * --> title = TITLE, volume = SEC is msec ?
2275 * format(msec) : SEC,
2276 * msec = SEC is msec ? atoi(msec) : 0,
2280 cp
= mandoc_a2msec(nn
->string
);
2282 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2283 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2285 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2286 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2287 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2290 if (NULL
== (nn
= nn
->next
))
2293 /* Handles: `.Dt TITLE SEC VOL'
2294 * --> title = TITLE, volume = VOL is vol ?
2296 * VOL is arch ? format(arch) :
2300 cp
= mdoc_a2vol(nn
->string
);
2302 free(mdoc
->meta
.vol
);
2303 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2305 cp
= mdoc_a2arch(nn
->string
);
2307 mdoc_nmsg(mdoc
, nn
, MANDOCERR_BADVOLARCH
);
2308 free(mdoc
->meta
.vol
);
2309 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2311 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2314 /* Ignore any subsequent parameters... */
2315 /* FIXME: warn about subsequent parameters. */
2321 post_prol(POST_ARGS
)
2324 * Remove prologue macros from the document after they're
2325 * processed. The final document uses mdoc_meta for these
2326 * values and discards the originals.
2329 mdoc_node_delete(mdoc
, mdoc
->last
);
2330 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2331 mdoc
->flags
|= MDOC_PBODY
;
2339 struct mdoc_node
*n
;
2342 * Make `Bx's second argument always start with an uppercase
2343 * letter. Groff checks if it's an "accepted" term, but we just
2344 * uppercase blindly.
2347 n
= mdoc
->last
->child
;
2348 if (n
&& NULL
!= (n
= n
->next
))
2349 *n
->string
= (char)toupper
2350 ((unsigned char)*n
->string
);
2358 struct mdoc_node
*n
;
2362 struct utsname utsname
;
2368 * Set the operating system by way of the `Os' macro.
2369 * The order of precedence is:
2370 * 1. the argument of the `Os' macro, unless empty
2371 * 2. the -Ios=foo command line argument, if provided
2372 * 3. -DOSNAME="\"foo\"", if provided during compilation
2373 * 4. "sysname release" from uname(3)
2376 free(mdoc
->meta
.os
);
2379 if (-1 == (c
= concat(buf
, n
->child
, BUFSIZ
))) {
2380 mdoc_nmsg(mdoc
, n
->child
, MANDOCERR_MEM
);
2386 if ('\0' == buf
[0]) {
2388 mdoc
->meta
.os
= mandoc_strdup(mdoc
->defos
);
2392 if (strlcat(buf
, OSNAME
, BUFSIZ
) >= BUFSIZ
) {
2393 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2397 if (-1 == uname(&utsname
)) {
2398 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2399 mdoc
->meta
.os
= mandoc_strdup("UNKNOWN");
2400 return(post_prol(mdoc
));
2403 if (strlcat(buf
, utsname
.sysname
, BUFSIZ
) >= BUFSIZ
) {
2404 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2407 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
2408 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2411 if (strlcat(buf
, utsname
.release
, BUFSIZ
) >= BUFSIZ
) {
2412 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2418 mdoc
->meta
.os
= mandoc_strdup(buf
);
2425 struct mdoc_node
*nn
, *n
;
2430 * Macros accepting `-std' as an argument have the name of the
2431 * current document (`Nm') filled in as the argument if it's not
2438 if (NULL
== mdoc
->meta
.name
)
2442 mdoc
->next
= MDOC_NEXT_CHILD
;
2444 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2452 * Concatenate a node, stopping at the first non-text.
2453 * Concatenation is separated by a single whitespace.
2454 * Returns -1 on fatal (string overrun) error, 0 if child nodes were
2455 * encountered, 1 otherwise.
2458 concat(char *p
, const struct mdoc_node
*n
, size_t sz
)
2461 for ( ; NULL
!= n
; n
= n
->next
) {
2462 if (MDOC_TEXT
!= n
->type
)
2464 if ('\0' != p
[0] && strlcat(p
, " ", sz
) >= sz
)
2466 if (strlcat(p
, n
->string
, sz
) >= sz
)
2468 concat(p
, n
->child
, sz
);
2474 static enum mdoc_sec
2475 a2sec(const char *p
)
2479 for (i
= 0; i
< (int)SEC__MAX
; i
++)
2480 if (secnames
[i
] && 0 == strcmp(p
, secnames
[i
]))
2481 return((enum mdoc_sec
)i
);
2487 macro2len(enum mdoct macro
)