]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.174 2011/08/16 12:23:51 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011 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_dd(POST_ARGS
);
101 static int post_dt(POST_ARGS
);
102 static int post_defaults(POST_ARGS
);
103 static int post_literal(POST_ARGS
);
104 static int post_eoln(POST_ARGS
);
105 static int post_it(POST_ARGS
);
106 static int post_lb(POST_ARGS
);
107 static int post_nm(POST_ARGS
);
108 static int post_ns(POST_ARGS
);
109 static int post_os(POST_ARGS
);
110 static int post_ignpar(POST_ARGS
);
111 static int post_prol(POST_ARGS
);
112 static int post_root(POST_ARGS
);
113 static int post_rs(POST_ARGS
);
114 static int post_sh(POST_ARGS
);
115 static int post_sh_body(POST_ARGS
);
116 static int post_sh_head(POST_ARGS
);
117 static int post_st(POST_ARGS
);
118 static int post_std(POST_ARGS
);
119 static int post_vt(POST_ARGS
);
120 static int pre_an(PRE_ARGS
);
121 static int pre_bd(PRE_ARGS
);
122 static int pre_bl(PRE_ARGS
);
123 static int pre_dd(PRE_ARGS
);
124 static int pre_display(PRE_ARGS
);
125 static int pre_dt(PRE_ARGS
);
126 static int pre_it(PRE_ARGS
);
127 static int pre_literal(PRE_ARGS
);
128 static int pre_os(PRE_ARGS
);
129 static int pre_par(PRE_ARGS
);
130 static int pre_sh(PRE_ARGS
);
131 static int pre_ss(PRE_ARGS
);
132 static int pre_std(PRE_ARGS
);
134 static v_post posts_an
[] = { post_an
, NULL
};
135 static v_post posts_at
[] = { post_at
, post_defaults
, NULL
};
136 static v_post posts_bd
[] = { post_literal
, hwarn_eq0
, bwarn_ge1
, NULL
};
137 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
138 static v_post posts_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
139 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
140 static v_post posts_bx
[] = { post_bx
, NULL
};
141 static v_post posts_bool
[] = { ebool
, NULL
};
142 static v_post posts_eoln
[] = { post_eoln
, NULL
};
143 static v_post posts_defaults
[] = { post_defaults
, NULL
};
144 static v_post posts_dd
[] = { post_dd
, post_prol
, NULL
};
145 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, NULL
};
146 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
147 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
148 static v_post posts_it
[] = { post_it
, NULL
};
149 static v_post posts_lb
[] = { post_lb
, NULL
};
150 static v_post posts_nd
[] = { berr_ge1
, NULL
};
151 static v_post posts_nm
[] = { post_nm
, NULL
};
152 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
153 static v_post posts_ns
[] = { post_ns
, NULL
};
154 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
155 static v_post posts_rs
[] = { post_rs
, NULL
};
156 static v_post posts_sh
[] = { post_ignpar
, hwarn_ge1
, post_sh
, NULL
};
157 static v_post posts_sp
[] = { ewarn_le1
, NULL
};
158 static v_post posts_ss
[] = { post_ignpar
, hwarn_ge1
, NULL
};
159 static v_post posts_st
[] = { post_st
, NULL
};
160 static v_post posts_std
[] = { post_std
, NULL
};
161 static v_post posts_text
[] = { ewarn_ge1
, NULL
};
162 static v_post posts_text1
[] = { ewarn_eq1
, NULL
};
163 static v_post posts_vt
[] = { post_vt
, NULL
};
164 static v_post posts_wline
[] = { bwarn_ge1
, NULL
};
165 static v_pre pres_an
[] = { pre_an
, NULL
};
166 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
167 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
168 static v_pre pres_d1
[] = { pre_display
, NULL
};
169 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
170 static v_pre pres_dd
[] = { pre_dd
, NULL
};
171 static v_pre pres_dt
[] = { pre_dt
, NULL
};
172 static v_pre pres_er
[] = { NULL
, NULL
};
173 static v_pre pres_fd
[] = { NULL
, NULL
};
174 static v_pre pres_it
[] = { pre_it
, pre_par
, NULL
};
175 static v_pre pres_os
[] = { pre_os
, NULL
};
176 static v_pre pres_pp
[] = { pre_par
, NULL
};
177 static v_pre pres_sh
[] = { pre_sh
, NULL
};
178 static v_pre pres_ss
[] = { pre_ss
, NULL
};
179 static v_pre pres_std
[] = { pre_std
, NULL
};
181 static const struct valids mdoc_valids
[MDOC_MAX
] = {
182 { NULL
, NULL
}, /* Ap */
183 { pres_dd
, posts_dd
}, /* Dd */
184 { pres_dt
, posts_dt
}, /* Dt */
185 { pres_os
, posts_os
}, /* Os */
186 { pres_sh
, posts_sh
}, /* Sh */
187 { pres_ss
, posts_ss
}, /* Ss */
188 { pres_pp
, posts_notext
}, /* Pp */
189 { pres_d1
, posts_wline
}, /* D1 */
190 { pres_dl
, posts_dl
}, /* Dl */
191 { pres_bd
, posts_bd
}, /* Bd */
192 { NULL
, NULL
}, /* Ed */
193 { pres_bl
, posts_bl
}, /* Bl */
194 { NULL
, NULL
}, /* El */
195 { pres_it
, posts_it
}, /* It */
196 { NULL
, NULL
}, /* Ad */
197 { pres_an
, posts_an
}, /* An */
198 { NULL
, posts_defaults
}, /* Ar */
199 { NULL
, NULL
}, /* Cd */
200 { NULL
, NULL
}, /* Cm */
201 { NULL
, NULL
}, /* Dv */
202 { pres_er
, NULL
}, /* Er */
203 { NULL
, NULL
}, /* Ev */
204 { pres_std
, posts_std
}, /* Ex */
205 { NULL
, NULL
}, /* Fa */
206 { pres_fd
, posts_text
}, /* Fd */
207 { NULL
, NULL
}, /* Fl */
208 { NULL
, NULL
}, /* Fn */
209 { NULL
, NULL
}, /* Ft */
210 { NULL
, NULL
}, /* Ic */
211 { NULL
, posts_text1
}, /* In */
212 { NULL
, posts_defaults
}, /* Li */
213 { NULL
, posts_nd
}, /* Nd */
214 { NULL
, posts_nm
}, /* Nm */
215 { NULL
, NULL
}, /* Op */
216 { NULL
, NULL
}, /* Ot */
217 { NULL
, posts_defaults
}, /* Pa */
218 { pres_std
, posts_std
}, /* Rv */
219 { NULL
, posts_st
}, /* St */
220 { NULL
, NULL
}, /* Va */
221 { NULL
, posts_vt
}, /* Vt */
222 { NULL
, posts_text
}, /* Xr */
223 { NULL
, posts_text
}, /* %A */
224 { NULL
, posts_text
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
225 { NULL
, posts_text
}, /* %D */
226 { NULL
, posts_text
}, /* %I */
227 { NULL
, posts_text
}, /* %J */
228 { NULL
, posts_text
}, /* %N */
229 { NULL
, posts_text
}, /* %O */
230 { NULL
, posts_text
}, /* %P */
231 { NULL
, posts_text
}, /* %R */
232 { NULL
, posts_text
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
233 { NULL
, posts_text
}, /* %V */
234 { NULL
, NULL
}, /* Ac */
235 { NULL
, NULL
}, /* Ao */
236 { NULL
, NULL
}, /* Aq */
237 { NULL
, posts_at
}, /* At */
238 { NULL
, NULL
}, /* Bc */
239 { NULL
, posts_bf
}, /* Bf */
240 { NULL
, NULL
}, /* Bo */
241 { NULL
, NULL
}, /* Bq */
242 { NULL
, NULL
}, /* Bsx */
243 { NULL
, posts_bx
}, /* Bx */
244 { NULL
, posts_bool
}, /* Db */
245 { NULL
, NULL
}, /* Dc */
246 { NULL
, NULL
}, /* Do */
247 { NULL
, NULL
}, /* Dq */
248 { NULL
, NULL
}, /* Ec */
249 { NULL
, NULL
}, /* Ef */
250 { NULL
, NULL
}, /* Em */
251 { NULL
, NULL
}, /* Eo */
252 { NULL
, NULL
}, /* Fx */
253 { NULL
, NULL
}, /* Ms */
254 { NULL
, posts_notext
}, /* No */
255 { NULL
, posts_ns
}, /* Ns */
256 { NULL
, NULL
}, /* Nx */
257 { NULL
, NULL
}, /* Ox */
258 { NULL
, NULL
}, /* Pc */
259 { NULL
, posts_text1
}, /* Pf */
260 { NULL
, NULL
}, /* Po */
261 { NULL
, NULL
}, /* Pq */
262 { NULL
, NULL
}, /* Qc */
263 { NULL
, NULL
}, /* Ql */
264 { NULL
, NULL
}, /* Qo */
265 { NULL
, NULL
}, /* Qq */
266 { NULL
, NULL
}, /* Re */
267 { NULL
, posts_rs
}, /* Rs */
268 { NULL
, NULL
}, /* Sc */
269 { NULL
, NULL
}, /* So */
270 { NULL
, NULL
}, /* Sq */
271 { NULL
, posts_bool
}, /* Sm */
272 { NULL
, NULL
}, /* Sx */
273 { NULL
, NULL
}, /* Sy */
274 { NULL
, NULL
}, /* Tn */
275 { NULL
, NULL
}, /* Ux */
276 { NULL
, NULL
}, /* Xc */
277 { NULL
, NULL
}, /* Xo */
278 { NULL
, posts_fo
}, /* Fo */
279 { NULL
, NULL
}, /* Fc */
280 { NULL
, NULL
}, /* Oo */
281 { NULL
, NULL
}, /* Oc */
282 { NULL
, posts_bk
}, /* Bk */
283 { NULL
, NULL
}, /* Ek */
284 { NULL
, posts_eoln
}, /* Bt */
285 { NULL
, NULL
}, /* Hf */
286 { NULL
, NULL
}, /* Fr */
287 { NULL
, posts_eoln
}, /* Ud */
288 { NULL
, posts_lb
}, /* Lb */
289 { NULL
, posts_notext
}, /* Lp */
290 { NULL
, NULL
}, /* Lk */
291 { NULL
, posts_defaults
}, /* Mt */
292 { NULL
, NULL
}, /* Brq */
293 { NULL
, NULL
}, /* Bro */
294 { NULL
, NULL
}, /* Brc */
295 { NULL
, posts_text
}, /* %C */
296 { NULL
, NULL
}, /* Es */
297 { NULL
, NULL
}, /* En */
298 { NULL
, NULL
}, /* Dx */
299 { NULL
, posts_text
}, /* %Q */
300 { NULL
, posts_notext
}, /* br */
301 { pres_pp
, posts_sp
}, /* sp */
302 { NULL
, posts_text1
}, /* %U */
303 { NULL
, NULL
}, /* Ta */
306 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
308 static const enum mdoct rsord
[RSORD_MAX
] = {
325 static const char * const secnames
[SEC__MAX
] = {
331 "IMPLEMENTATION NOTES",
346 "SECURITY CONSIDERATIONS",
351 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
362 check_text(mdoc
, line
, pos
, tp
);
376 if (NULL
== mdoc_valids
[n
->tok
].pre
)
378 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
379 if ( ! (*p
)(mdoc
, n
))
386 mdoc_valid_post(struct mdoc
*mdoc
)
390 if (MDOC_VALID
& mdoc
->last
->flags
)
392 mdoc
->last
->flags
|= MDOC_VALID
;
394 switch (mdoc
->last
->type
) {
402 return(post_root(mdoc
));
407 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
409 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
417 check_count(struct mdoc
*m
, enum mdoc_type type
,
418 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
423 if (m
->last
->type
!= type
)
429 if (m
->last
->nchild
< val
)
434 if (m
->last
->nchild
> val
)
439 if (val
== m
->last
->nchild
)
447 t
= lvl
== CHECK_WARN
? MANDOCERR_ARGCWARN
: MANDOCERR_ARGCOUNT
;
448 mandoc_vmsg(t
, m
->parse
, m
->last
->line
, m
->last
->pos
,
449 "want %s%d children (have %d)",
450 p
, val
, m
->last
->nchild
);
458 return(check_count(mdoc
, MDOC_BODY
, CHECK_ERROR
, CHECK_GT
, 0));
464 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
470 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
476 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1));
482 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
488 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_LT
, 2));
494 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
500 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
506 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_GT
, 0));
512 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
516 check_args(struct mdoc
*m
, struct mdoc_node
*n
)
523 assert(n
->args
->argc
);
524 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
525 check_argv(m
, n
, &n
->args
->argv
[i
]);
529 check_argv(struct mdoc
*m
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
533 for (i
= 0; i
< (int)v
->sz
; i
++)
534 check_text(m
, v
->line
, v
->pos
, v
->value
[i
]);
536 /* FIXME: move to post_std(). */
538 if (MDOC_Std
== v
->arg
)
539 if ( ! (v
->sz
|| m
->meta
.name
))
540 mdoc_nmsg(m
, n
, MANDOCERR_NONAME
);
544 check_text(struct mdoc
*m
, int ln
, int pos
, char *p
)
549 for (cp
= p
; NULL
!= (p
= strchr(p
, '\t')); p
++) {
550 if (MDOC_LITERAL
& m
->flags
)
552 mdoc_pmsg(m
, ln
, (int)(p
- cp
), MANDOCERR_BADTAB
);
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 mandoc_vmsg(MANDOCERR_SYNTCHILD
, mdoc
->parse
, n
->line
,
566 n
->pos
, "want parent %s", MDOC_ROOT
== t
?
567 "<root>" : mdoc_macronames
[tok
]);
573 pre_display(PRE_ARGS
)
575 struct mdoc_node
*node
;
577 if (MDOC_BLOCK
!= n
->type
)
580 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
581 if (MDOC_BLOCK
== node
->type
)
582 if (MDOC_Bd
== node
->tok
)
586 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
596 const char *offs
, *width
;
598 struct mdoc_node
*np
;
600 if (MDOC_BLOCK
!= n
->type
) {
601 if (ENDBODY_NOT
!= n
->end
) {
603 np
= n
->pending
->parent
;
608 assert(MDOC_BLOCK
== np
->type
);
609 assert(MDOC_Bl
== np
->tok
);
614 * First figure out which kind of list to use: bind ourselves to
615 * the first mentioned list type and warn about any remaining
616 * ones. If we find no list type, we default to LIST_item.
620 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
624 switch (n
->args
->argv
[i
].arg
) {
625 /* Set list types. */
659 /* Set list arguments. */
661 dup
= n
->norm
->Bl
.comp
;
665 dup
= (NULL
!= n
->norm
->Bl
.width
);
666 width
= n
->args
->argv
[i
].value
[0];
669 /* NB: this can be empty! */
670 if (n
->args
->argv
[i
].sz
) {
671 offs
= n
->args
->argv
[i
].value
[0];
672 dup
= (NULL
!= n
->norm
->Bl
.offs
);
675 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
681 /* Check: duplicate auxiliary arguments. */
684 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
687 n
->norm
->Bl
.comp
= comp
;
689 n
->norm
->Bl
.offs
= offs
;
691 n
->norm
->Bl
.width
= width
;
693 /* Check: multiple list types. */
695 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
!= LIST__NONE
)
696 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
698 /* Assign list type. */
700 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
== LIST__NONE
) {
701 n
->norm
->Bl
.type
= lt
;
702 /* Set column information, too. */
703 if (LIST_column
== lt
) {
706 n
->norm
->Bl
.cols
= (const char **)
707 n
->args
->argv
[i
].value
;
711 /* The list type should come first. */
713 if (n
->norm
->Bl
.type
== LIST__NONE
)
714 if (n
->norm
->Bl
.width
||
717 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
722 /* Allow lists to default to LIST_item. */
724 if (LIST__NONE
== n
->norm
->Bl
.type
) {
725 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
726 n
->norm
->Bl
.type
= LIST_item
;
730 * Validate the width field. Some list types don't need width
731 * types and should be warned about them. Others should have it
732 * and must also be warned.
735 switch (n
->norm
->Bl
.type
) {
737 if (n
->norm
->Bl
.width
)
739 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
750 if (n
->norm
->Bl
.width
)
751 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
767 struct mdoc_node
*np
;
769 if (MDOC_BLOCK
!= n
->type
) {
770 if (ENDBODY_NOT
!= n
->end
) {
772 np
= n
->pending
->parent
;
777 assert(MDOC_BLOCK
== np
->type
);
778 assert(MDOC_Bd
== np
->tok
);
783 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
788 switch (n
->args
->argv
[i
].arg
) {
795 case (MDOC_Unfilled
):
805 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
808 /* NB: this can be empty! */
809 if (n
->args
->argv
[i
].sz
) {
810 offs
= n
->args
->argv
[i
].value
[0];
811 dup
= (NULL
!= n
->norm
->Bd
.offs
);
814 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
818 dup
= n
->norm
->Bd
.comp
;
825 /* Check whether we have duplicates. */
828 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
830 /* Make our auxiliary assignments. */
833 n
->norm
->Bd
.offs
= offs
;
835 n
->norm
->Bd
.comp
= comp
;
837 /* Check whether a type has already been assigned. */
839 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
!= DISP__NONE
)
840 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
842 /* Make our type assignment. */
844 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
== DISP__NONE
)
845 n
->norm
->Bd
.type
= dt
;
848 if (DISP__NONE
== n
->norm
->Bd
.type
) {
849 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
850 n
->norm
->Bd
.type
= DISP_ragged
;
861 if (MDOC_BLOCK
!= n
->type
)
863 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
871 if (MDOC_BLOCK
!= n
->type
)
874 roff_regunset(mdoc
->roff
, REG_nS
);
875 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
883 if (MDOC_BLOCK
!= n
->type
)
886 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
898 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
899 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
900 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
902 if (MDOC_Split
== n
->args
->argv
[0].arg
)
903 n
->norm
->An
.auth
= AUTH_split
;
904 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
905 n
->norm
->An
.auth
= AUTH_nosplit
;
916 if (n
->args
&& 1 == n
->args
->argc
)
917 if (MDOC_Std
== n
->args
->argv
[0].arg
)
920 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
928 if (NULL
== mdoc
->meta
.date
|| mdoc
->meta
.os
)
929 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
931 if (mdoc
->meta
.title
)
932 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
941 if (NULL
== mdoc
->meta
.title
|| NULL
== mdoc
->meta
.date
)
942 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
945 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
954 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
955 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
958 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
967 struct mdoc_node
*np
;
971 * Unlike other data pointers, these are "housed" by the HEAD
972 * element, which contains the goods.
975 if (MDOC_HEAD
!= mdoc
->last
->type
) {
976 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
977 assert(mdoc
->last
->pending
);
978 np
= mdoc
->last
->pending
->parent
->head
;
979 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
980 np
= mdoc
->last
->parent
->head
;
982 np
= mdoc
->last
->head
;
985 assert(MDOC_HEAD
== np
->type
);
986 assert(MDOC_Bf
== np
->tok
);
991 assert(MDOC_BLOCK
== np
->parent
->type
);
992 assert(MDOC_Bf
== np
->parent
->tok
);
995 * Cannot have both argument and parameter.
996 * If neither is specified, let it through with a warning.
999 if (np
->parent
->args
&& np
->child
) {
1000 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
1002 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
1003 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1007 /* Extract argument into data. */
1009 if (np
->parent
->args
) {
1010 arg
= np
->parent
->args
->argv
[0].arg
;
1011 if (MDOC_Emphasis
== arg
)
1012 np
->norm
->Bf
.font
= FONT_Em
;
1013 else if (MDOC_Literal
== arg
)
1014 np
->norm
->Bf
.font
= FONT_Li
;
1015 else if (MDOC_Symbolic
== arg
)
1016 np
->norm
->Bf
.font
= FONT_Sy
;
1022 /* Extract parameter into data. */
1024 if (0 == strcmp(np
->child
->string
, "Em"))
1025 np
->norm
->Bf
.font
= FONT_Em
;
1026 else if (0 == strcmp(np
->child
->string
, "Li"))
1027 np
->norm
->Bf
.font
= FONT_Li
;
1028 else if (0 == strcmp(np
->child
->string
, "Sy"))
1029 np
->norm
->Bf
.font
= FONT_Sy
;
1031 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1043 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1045 assert(mdoc
->last
->child
);
1046 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1048 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1050 /* If lookup ok, replace with table value. */
1053 free(mdoc
->last
->child
->string
);
1054 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1058 /* If not, use "library ``xxxx''. */
1060 sz
= strlen(mdoc
->last
->child
->string
) +
1061 2 + strlen("\\(lqlibrary\\(rq");
1062 buf
= mandoc_malloc(sz
);
1063 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1064 mdoc
->last
->child
->string
);
1065 free(mdoc
->last
->child
->string
);
1066 mdoc
->last
->child
->string
= buf
;
1071 post_eoln(POST_ARGS
)
1074 if (mdoc
->last
->child
)
1075 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1083 const struct mdoc_node
*n
;
1086 * The Vt macro comes in both ELEM and BLOCK form, both of which
1087 * have different syntaxes (yet more context-sensitive
1088 * behaviour). ELEM types must have a child, which is already
1089 * guaranteed by the in_line parsing routine; BLOCK types,
1090 * specifically the BODY, should only have TEXT children.
1093 if (MDOC_BODY
!= mdoc
->last
->type
)
1096 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1097 if (MDOC_TEXT
!= n
->type
)
1098 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1110 /* If no child specified, make sure we have the meta name. */
1112 if (NULL
== mdoc
->last
->child
&& NULL
== mdoc
->meta
.name
) {
1113 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1115 } else if (mdoc
->meta
.name
)
1118 /* If no meta name, set it from the child. */
1121 if (-1 == (c
= concat(buf
, mdoc
->last
->child
, BUFSIZ
))) {
1122 mdoc_nmsg(mdoc
, mdoc
->last
->child
, MANDOCERR_MEM
);
1127 mdoc
->meta
.name
= mandoc_strdup(buf
);
1132 post_literal(POST_ARGS
)
1136 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1137 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1138 * this in literal mode, but it doesn't hurt to just switch it
1139 * off in general since displays can't be nested.
1142 if (MDOC_BODY
== mdoc
->last
->type
)
1143 mdoc
->flags
&= ~MDOC_LITERAL
;
1149 post_defaults(POST_ARGS
)
1151 struct mdoc_node
*nn
;
1154 * The `Ar' defaults to "file ..." if no value is provided as an
1155 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1156 * gets an empty string.
1159 if (mdoc
->last
->child
)
1163 mdoc
->next
= MDOC_NEXT_CHILD
;
1167 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1169 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1173 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1175 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1179 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1185 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1205 * If we have a child, look it up in the standard keys. If a
1206 * key exist, use that instead of the child; if it doesn't,
1207 * prefix "AT&T UNIX " to the existing data.
1210 if (NULL
== mdoc
->last
->child
)
1213 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1214 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1217 free(mdoc
->last
->child
->string
);
1218 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1220 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1222 q
= mdoc
->last
->child
->string
;
1223 sz
= strlen(p
) + strlen(q
) + 1;
1224 buf
= mandoc_malloc(sz
);
1225 strlcpy(buf
, p
, sz
);
1226 strlcat(buf
, q
, sz
);
1227 free(mdoc
->last
->child
->string
);
1228 mdoc
->last
->child
->string
= buf
;
1237 struct mdoc_node
*np
;
1240 if (AUTH__NONE
== np
->norm
->An
.auth
) {
1242 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0);
1243 } else if (np
->child
)
1244 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0);
1255 struct mdoc_node
*n
, *c
;
1258 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1261 n
= mdoc
->last
->parent
->parent
;
1262 lt
= n
->norm
->Bl
.type
;
1264 if (LIST__NONE
== lt
) {
1265 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1271 if (mdoc
->last
->head
->child
)
1273 /* FIXME: give this a dummy value. */
1274 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1283 if (NULL
== mdoc
->last
->head
->child
)
1284 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1293 if (NULL
== mdoc
->last
->body
->child
)
1294 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1297 if (mdoc
->last
->head
->child
)
1298 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1301 cols
= (int)n
->norm
->Bl
.ncols
;
1303 assert(NULL
== mdoc
->last
->head
->child
);
1305 if (NULL
== mdoc
->last
->body
->child
)
1306 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1308 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1309 if (MDOC_BODY
== c
->type
)
1313 er
= MANDOCERR_ARGCOUNT
;
1314 else if (i
== cols
|| i
== cols
+ 1)
1317 er
= MANDOCERR_SYNTARGCOUNT
;
1319 mandoc_vmsg(er
, mdoc
->parse
, mdoc
->last
->line
,
1321 "columns == %d (have %d)", cols
, i
);
1322 return(MANDOCERR_ARGCOUNT
== er
);
1331 post_bl_block(POST_ARGS
)
1333 struct mdoc_node
*n
;
1336 * These are fairly complicated, so we've broken them into two
1337 * functions. post_bl_block_tag() is called when a -tag is
1338 * specified, but no -width (it must be guessed). The second
1339 * when a -width is specified (macro indicators must be
1340 * rewritten into real lengths).
1345 if (LIST_tag
== n
->norm
->Bl
.type
&&
1346 NULL
== n
->norm
->Bl
.width
) {
1347 if ( ! post_bl_block_tag(mdoc
))
1349 } else if (NULL
!= n
->norm
->Bl
.width
) {
1350 if ( ! post_bl_block_width(mdoc
))
1355 assert(n
->norm
->Bl
.width
);
1360 post_bl_block_width(POST_ARGS
)
1365 struct mdoc_node
*n
;
1371 * Calculate the real width of a list from the -width string,
1372 * which may contain a macro (with a known default width), a
1373 * literal string, or a scaling width.
1375 * If the value to -width is a macro, then we re-write it to be
1376 * the macro's width as set in share/tmac/mdoc/doc-common.
1379 if (0 == strcmp(n
->norm
->Bl
.width
, "Ds"))
1381 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->norm
->Bl
.width
)))
1383 else if (0 == (width
= macro2len(tok
))) {
1384 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1388 /* The value already exists: free and reallocate it. */
1392 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1393 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1396 assert(i
< (int)n
->args
->argc
);
1398 snprintf(buf
, NUMSIZ
, "%un", (unsigned int)width
);
1399 free(n
->args
->argv
[i
].value
[0]);
1400 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1402 /* Set our width! */
1403 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1408 post_bl_block_tag(POST_ARGS
)
1410 struct mdoc_node
*n
, *nn
;
1416 * Calculate the -width for a `Bl -tag' list if it hasn't been
1417 * provided. Uses the first head macro. NOTE AGAIN: this is
1418 * ONLY if the -width argument has NOT been provided. See
1419 * post_bl_block_width() for converting the -width string.
1425 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1426 if (MDOC_It
!= nn
->tok
)
1429 assert(MDOC_BLOCK
== nn
->type
);
1430 nn
= nn
->head
->child
;
1435 if (MDOC_TEXT
== nn
->type
) {
1436 sz
= strlen(nn
->string
) + 1;
1440 if (0 != (ssz
= macro2len(nn
->tok
)))
1446 /* Defaults to ten ens. */
1448 snprintf(buf
, NUMSIZ
, "%un", (unsigned int)sz
);
1451 * We have to dynamically add this to the macro's argument list.
1452 * We're guaranteed that a MDOC_Width doesn't already exist.
1456 i
= (int)(n
->args
->argc
)++;
1458 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1459 n
->args
->argc
* sizeof(struct mdoc_argv
));
1461 n
->args
->argv
[i
].arg
= MDOC_Width
;
1462 n
->args
->argv
[i
].line
= n
->line
;
1463 n
->args
->argv
[i
].pos
= n
->pos
;
1464 n
->args
->argv
[i
].sz
= 1;
1465 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1466 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1468 /* Set our width! */
1469 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1475 post_bl_head(POST_ARGS
)
1477 struct mdoc_node
*np
, *nn
, *nnp
;
1480 if (LIST_column
!= mdoc
->last
->norm
->Bl
.type
)
1481 /* FIXME: this should be ERROR class... */
1482 return(hwarn_eq0(mdoc
));
1485 * Convert old-style lists, where the column width specifiers
1486 * trail as macro parameters, to the new-style ("normal-form")
1487 * lists where they're argument values following -column.
1490 /* First, disallow both types and allow normal-form. */
1493 * TODO: technically, we can accept both and just merge the two
1494 * lists, but I'll leave that for another day.
1497 if (mdoc
->last
->norm
->Bl
.ncols
&& mdoc
->last
->nchild
) {
1498 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1500 } else if (NULL
== mdoc
->last
->child
)
1503 np
= mdoc
->last
->parent
;
1506 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1507 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1510 assert(j
< (int)np
->args
->argc
);
1511 assert(0 == np
->args
->argv
[j
].sz
);
1514 * Accommodate for new-style groff column syntax. Shuffle the
1515 * child nodes, all of which must be TEXT, as arguments for the
1516 * column field. Then, delete the head children.
1519 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1520 np
->args
->argv
[j
].value
= mandoc_malloc
1521 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1523 mdoc
->last
->norm
->Bl
.ncols
= np
->args
->argv
[j
].sz
;
1524 mdoc
->last
->norm
->Bl
.cols
= (const char **)np
->args
->argv
[j
].value
;
1526 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1527 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1531 mdoc_node_delete(NULL
, nnp
);
1534 mdoc
->last
->nchild
= 0;
1535 mdoc
->last
->child
= NULL
;
1543 struct mdoc_node
*n
;
1545 if (MDOC_HEAD
== mdoc
->last
->type
)
1546 return(post_bl_head(mdoc
));
1547 if (MDOC_BLOCK
== mdoc
->last
->type
)
1548 return(post_bl_block(mdoc
));
1549 if (MDOC_BODY
!= mdoc
->last
->type
)
1552 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1557 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1567 mdoc_nmsg(mdoc
, n
, MANDOCERR_SYNTCHILD
);
1575 ebool(struct mdoc
*mdoc
)
1578 if (NULL
== mdoc
->last
->child
) {
1579 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1580 mdoc_node_delete(mdoc
, mdoc
->last
);
1583 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1585 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1587 if (0 == strcmp(mdoc
->last
->child
->string
, "on"))
1589 if (0 == strcmp(mdoc
->last
->child
->string
, "off"))
1592 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1597 post_root(POST_ARGS
)
1600 struct mdoc_node
*n
;
1604 /* Check that we have a finished prologue. */
1606 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1608 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1614 /* Check that we begin with a proper `Sh'. */
1616 if (NULL
== n
->child
) {
1618 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1619 } else if (MDOC_BLOCK
!= n
->child
->type
||
1620 MDOC_Sh
!= n
->child
->tok
) {
1622 /* Can this be lifted? See rxdebug.1 for example. */
1623 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1626 return(erc
? 0 : 1);
1632 struct mdoc_node
*ch
;
1635 if (NULL
== (ch
= mdoc
->last
->child
)) {
1636 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1637 mdoc_node_delete(mdoc
, mdoc
->last
);
1641 assert(MDOC_TEXT
== ch
->type
);
1643 if (NULL
== (p
= mdoc_a2st(ch
->string
))) {
1644 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1645 mdoc_node_delete(mdoc
, mdoc
->last
);
1648 ch
->string
= mandoc_strdup(p
);
1657 struct mdoc_node
*nn
, *next
, *prev
;
1660 switch (mdoc
->last
->type
) {
1662 check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0);
1665 if (mdoc
->last
->child
)
1667 check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0);
1674 * Make sure only certain types of nodes are allowed within the
1675 * the `Rs' body. Delete offending nodes and raise a warning.
1676 * Do this before re-ordering for the sake of clarity.
1680 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1681 for (i
= 0; i
< RSORD_MAX
; i
++)
1682 if (nn
->tok
== rsord
[i
])
1685 if (i
< RSORD_MAX
) {
1686 if (MDOC__J
== rsord
[i
] || MDOC__B
== rsord
[i
])
1687 mdoc
->last
->norm
->Rs
.quote_T
++;
1693 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1694 mdoc_node_delete(mdoc
, nn
);
1698 * The full `Rs' block needs special handling to order the
1699 * sub-elements according to `rsord'. Pick through each element
1700 * and correctly order it. This is a insertion sort.
1704 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1705 /* Determine order of `nn'. */
1706 for (i
= 0; i
< RSORD_MAX
; i
++)
1707 if (rsord
[i
] == nn
->tok
)
1711 * Remove `nn' from the chain. This somewhat
1712 * repeats mdoc_node_unlink(), but since we're
1713 * just re-ordering, there's no need for the
1714 * full unlink process.
1717 if (NULL
!= (next
= nn
->next
))
1718 next
->prev
= nn
->prev
;
1720 if (NULL
!= (prev
= nn
->prev
))
1721 prev
->next
= nn
->next
;
1723 nn
->prev
= nn
->next
= NULL
;
1726 * Scan back until we reach a node that's
1727 * ordered before `nn'.
1730 for ( ; prev
; prev
= prev
->prev
) {
1731 /* Determine order of `prev'. */
1732 for (j
= 0; j
< RSORD_MAX
; j
++)
1733 if (rsord
[j
] == prev
->tok
)
1741 * Set `nn' back into its correct place in front
1742 * of the `prev' node.
1749 prev
->next
->prev
= nn
;
1750 nn
->next
= prev
->next
;
1753 mdoc
->last
->child
->prev
= nn
;
1754 nn
->next
= mdoc
->last
->child
;
1755 mdoc
->last
->child
= nn
;
1766 if (MDOC_LINE
& mdoc
->last
->flags
)
1767 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNNS
);
1775 if (MDOC_HEAD
== mdoc
->last
->type
)
1776 return(post_sh_head(mdoc
));
1777 if (MDOC_BODY
== mdoc
->last
->type
)
1778 return(post_sh_body(mdoc
));
1784 post_sh_body(POST_ARGS
)
1786 struct mdoc_node
*n
;
1788 if (SEC_NAME
!= mdoc
->lastsec
)
1792 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1793 * macros (can have multiple `Nm' and one `Nd'). Note that the
1794 * children of the BODY declaration can also be "text".
1797 if (NULL
== (n
= mdoc
->last
->child
)) {
1798 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1802 for ( ; n
&& n
->next
; n
= n
->next
) {
1803 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1805 if (MDOC_TEXT
== n
->type
)
1807 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1811 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1814 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1819 post_sh_head(POST_ARGS
)
1826 * Process a new section. Sections are either "named" or
1827 * "custom". Custom sections are user-defined, while named ones
1828 * follow a conventional order and may only appear in certain
1834 if (-1 == (c
= concat(buf
, mdoc
->last
->child
, BUFSIZ
))) {
1835 mdoc_nmsg(mdoc
, mdoc
->last
->child
, MANDOCERR_MEM
);
1840 /* The NAME should be first. */
1842 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1843 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1845 /* The SYNOPSIS gets special attention in other areas. */
1847 if (SEC_SYNOPSIS
== sec
)
1848 mdoc
->flags
|= MDOC_SYNOPSIS
;
1850 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
1852 /* Mark our last section. */
1854 mdoc
->lastsec
= sec
;
1856 /* We don't care about custom sections after this. */
1858 if (SEC_CUSTOM
== sec
)
1862 * Check whether our non-custom section is being repeated or is
1866 if (sec
== mdoc
->lastnamed
)
1867 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
1869 if (sec
< mdoc
->lastnamed
)
1870 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
1872 /* Mark the last named section. */
1874 mdoc
->lastnamed
= sec
;
1876 /* Check particular section/manual conventions. */
1878 assert(mdoc
->meta
.msec
);
1881 case (SEC_RETURN_VALUES
):
1886 if (*mdoc
->meta
.msec
== '2')
1888 if (*mdoc
->meta
.msec
== '3')
1890 if (*mdoc
->meta
.msec
== '9')
1892 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECMSEC
);
1902 post_ignpar(POST_ARGS
)
1904 struct mdoc_node
*np
;
1906 if (MDOC_BODY
!= mdoc
->last
->type
)
1909 if (NULL
!= (np
= mdoc
->last
->child
))
1910 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1911 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1912 mdoc_node_delete(mdoc
, np
);
1915 if (NULL
!= (np
= mdoc
->last
->last
))
1916 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1917 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1918 mdoc_node_delete(mdoc
, np
);
1928 if (NULL
== mdoc
->last
)
1930 if (MDOC_ELEM
!= n
->type
&& MDOC_BLOCK
!= n
->type
)
1934 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1935 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1938 if (MDOC_Pp
!= mdoc
->last
->tok
&& MDOC_Lp
!= mdoc
->last
->tok
)
1940 if (MDOC_Bl
== n
->tok
&& n
->norm
->Bl
.comp
)
1942 if (MDOC_Bd
== n
->tok
&& n
->norm
->Bd
.comp
)
1944 if (MDOC_It
== n
->tok
&& n
->parent
->norm
->Bl
.comp
)
1947 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
1948 mdoc_node_delete(mdoc
, mdoc
->last
);
1953 pre_literal(PRE_ARGS
)
1956 if (MDOC_BODY
!= n
->type
)
1960 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1961 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1966 mdoc
->flags
|= MDOC_LITERAL
;
1969 if (DISP_literal
== n
->norm
->Bd
.type
)
1970 mdoc
->flags
|= MDOC_LITERAL
;
1971 if (DISP_unfilled
== n
->norm
->Bd
.type
)
1972 mdoc
->flags
|= MDOC_LITERAL
;
1986 struct mdoc_node
*n
;
1989 if (mdoc
->meta
.date
)
1990 free(mdoc
->meta
.date
);
1993 if (NULL
== n
->child
|| '\0' == n
->child
->string
[0]) {
1994 mdoc
->meta
.date
= mandoc_normdate
1995 (mdoc
->parse
, NULL
, n
->line
, n
->pos
);
2000 if (-1 == (c
= concat(buf
, n
->child
, DATESIZE
))) {
2001 mdoc_nmsg(mdoc
, n
->child
, MANDOCERR_MEM
);
2006 mdoc
->meta
.date
= mandoc_normdate
2007 (mdoc
->parse
, buf
, n
->line
, n
->pos
);
2015 struct mdoc_node
*nn
, *n
;
2021 if (mdoc
->meta
.title
)
2022 free(mdoc
->meta
.title
);
2024 free(mdoc
->meta
.vol
);
2025 if (mdoc
->meta
.arch
)
2026 free(mdoc
->meta
.arch
);
2028 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
2030 /* First make all characters uppercase. */
2032 if (NULL
!= (nn
= n
->child
))
2033 for (p
= nn
->string
; *p
; p
++) {
2034 if (toupper((unsigned char)*p
) == *p
)
2038 * FIXME: don't be lazy: have this make all
2039 * characters be uppercase and just warn once.
2041 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2046 * --> title = unknown, volume = local, msec = 0, arch = NULL
2049 if (NULL
== (nn
= n
->child
)) {
2050 /* XXX: make these macro values. */
2051 /* FIXME: warn about missing values. */
2052 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2053 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2054 mdoc
->meta
.msec
= mandoc_strdup("1");
2058 /* Handles: `.Dt TITLE'
2059 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2062 mdoc
->meta
.title
= mandoc_strdup
2063 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2065 if (NULL
== (nn
= nn
->next
)) {
2066 /* FIXME: warn about missing msec. */
2067 /* XXX: make this a macro value. */
2068 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2069 mdoc
->meta
.msec
= mandoc_strdup("1");
2073 /* Handles: `.Dt TITLE SEC'
2074 * --> title = TITLE, volume = SEC is msec ?
2075 * format(msec) : SEC,
2076 * msec = SEC is msec ? atoi(msec) : 0,
2080 cp
= mdoc_a2msec(nn
->string
);
2082 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2083 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2085 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2086 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2087 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2090 if (NULL
== (nn
= nn
->next
))
2093 /* Handles: `.Dt TITLE SEC VOL'
2094 * --> title = TITLE, volume = VOL is vol ?
2096 * VOL is arch ? format(arch) :
2100 cp
= mdoc_a2vol(nn
->string
);
2102 free(mdoc
->meta
.vol
);
2103 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2105 /* FIXME: warn about bad arch. */
2106 cp
= mdoc_a2arch(nn
->string
);
2108 free(mdoc
->meta
.vol
);
2109 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2111 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2114 /* Ignore any subsequent parameters... */
2115 /* FIXME: warn about subsequent parameters. */
2121 post_prol(POST_ARGS
)
2124 * Remove prologue macros from the document after they're
2125 * processed. The final document uses mdoc_meta for these
2126 * values and discards the originals.
2129 mdoc_node_delete(mdoc
, mdoc
->last
);
2130 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2131 mdoc
->flags
|= MDOC_PBODY
;
2139 struct mdoc_node
*n
;
2142 * Make `Bx's second argument always start with an uppercase
2143 * letter. Groff checks if it's an "accepted" term, but we just
2144 * uppercase blindly.
2147 n
= mdoc
->last
->child
;
2148 if (n
&& NULL
!= (n
= n
->next
))
2149 *n
->string
= (char)toupper
2150 ((unsigned char)*n
->string
);
2158 struct mdoc_node
*n
;
2162 struct utsname utsname
;
2168 * Set the operating system by way of the `Os' macro. Note that
2169 * if an argument isn't provided and -DOSNAME="\"foo\"" is
2170 * provided during compilation, this value will be used instead
2171 * of filling in "sysname release" from uname().
2175 free(mdoc
->meta
.os
);
2178 if (-1 == (c
= concat(buf
, n
->child
, BUFSIZ
))) {
2179 mdoc_nmsg(mdoc
, n
->child
, MANDOCERR_MEM
);
2185 /* XXX: yes, these can all be dynamically-adjusted buffers, but
2186 * it's really not worth the extra hackery.
2189 if ('\0' == buf
[0]) {
2191 if (strlcat(buf
, OSNAME
, BUFSIZ
) >= BUFSIZ
) {
2192 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2196 if (-1 == uname(&utsname
)) {
2197 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2198 mdoc
->meta
.os
= mandoc_strdup("UNKNOWN");
2199 return(post_prol(mdoc
));
2202 if (strlcat(buf
, utsname
.sysname
, BUFSIZ
) >= BUFSIZ
) {
2203 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2206 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
2207 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2210 if (strlcat(buf
, utsname
.release
, BUFSIZ
) >= BUFSIZ
) {
2211 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2217 mdoc
->meta
.os
= mandoc_strdup(buf
);
2224 struct mdoc_node
*nn
, *n
;
2229 * Macros accepting `-std' as an argument have the name of the
2230 * current document (`Nm') filled in as the argument if it's not
2237 if (NULL
== mdoc
->meta
.name
)
2241 mdoc
->next
= MDOC_NEXT_CHILD
;
2243 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2251 * Concatenate a node, stopping at the first non-text.
2252 * Concatenation is separated by a single whitespace.
2253 * Returns -1 on fatal (string overrun) error, 0 if child nodes were
2254 * encountered, 1 otherwise.
2257 concat(char *p
, const struct mdoc_node
*n
, size_t sz
)
2260 for ( ; NULL
!= n
; n
= n
->next
) {
2261 if (MDOC_TEXT
!= n
->type
)
2263 if ('\0' != p
[0] && strlcat(p
, " ", sz
) >= sz
)
2265 if (strlcat(p
, n
->string
, sz
) >= sz
)
2267 concat(p
, n
->child
, sz
);
2273 static enum mdoc_sec
2274 a2sec(const char *p
)
2278 for (i
= 0; i
< (int)SEC__MAX
; i
++)
2279 if (secnames
[i
] && 0 == strcmp(p
, secnames
[i
]))
2280 return((enum mdoc_sec
)i
);
2286 macro2len(enum mdoct macro
)