]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.170 2011/07/18 07:46:41 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
*);
76 static int concat(struct mdoc
*, char *,
77 const struct mdoc_node
*, size_t);
78 static enum mdoc_sec
a2sec(const char *);
79 static size_t macro2len(enum mdoct
);
81 static int ebool(POST_ARGS
);
82 static int berr_ge1(POST_ARGS
);
83 static int bwarn_ge1(POST_ARGS
);
84 static int ewarn_eq0(POST_ARGS
);
85 static int ewarn_eq1(POST_ARGS
);
86 static int ewarn_ge1(POST_ARGS
);
87 static int ewarn_le1(POST_ARGS
);
88 static int hwarn_eq0(POST_ARGS
);
89 static int hwarn_eq1(POST_ARGS
);
90 static int hwarn_ge1(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_bx(POST_ARGS
);
102 static int post_dd(POST_ARGS
);
103 static int post_dt(POST_ARGS
);
104 static int post_defaults(POST_ARGS
);
105 static int post_literal(POST_ARGS
);
106 static int post_eoln(POST_ARGS
);
107 static int post_it(POST_ARGS
);
108 static int post_lb(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_ignpar(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_dd
[] = { post_dd
, post_prol
, NULL
};
147 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, NULL
};
148 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
149 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
150 static v_post posts_it
[] = { post_it
, NULL
};
151 static v_post posts_lb
[] = { post_lb
, NULL
};
152 static v_post posts_nd
[] = { berr_ge1
, NULL
};
153 static v_post posts_nm
[] = { post_nm
, NULL
};
154 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
155 static v_post posts_ns
[] = { post_ns
, NULL
};
156 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
157 static v_post posts_rs
[] = { post_rs
, NULL
};
158 static v_post posts_sh
[] = { post_ignpar
, hwarn_ge1
, post_sh
, NULL
};
159 static v_post posts_sp
[] = { ewarn_le1
, NULL
};
160 static v_post posts_ss
[] = { post_ignpar
, hwarn_ge1
, NULL
};
161 static v_post posts_st
[] = { post_st
, NULL
};
162 static v_post posts_std
[] = { post_std
, NULL
};
163 static v_post posts_text
[] = { ewarn_ge1
, NULL
};
164 static v_post posts_text1
[] = { ewarn_eq1
, NULL
};
165 static v_post posts_vt
[] = { post_vt
, NULL
};
166 static v_post posts_wline
[] = { bwarn_ge1
, NULL
};
167 static v_pre pres_an
[] = { pre_an
, NULL
};
168 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
169 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
170 static v_pre pres_d1
[] = { pre_display
, NULL
};
171 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
172 static v_pre pres_dd
[] = { pre_dd
, NULL
};
173 static v_pre pres_dt
[] = { pre_dt
, NULL
};
174 static v_pre pres_er
[] = { NULL
, NULL
};
175 static v_pre pres_fd
[] = { NULL
, NULL
};
176 static v_pre pres_it
[] = { pre_it
, pre_par
, NULL
};
177 static v_pre pres_os
[] = { pre_os
, NULL
};
178 static v_pre pres_pp
[] = { pre_par
, NULL
};
179 static v_pre pres_sh
[] = { pre_sh
, NULL
};
180 static v_pre pres_ss
[] = { pre_ss
, NULL
};
181 static v_pre pres_std
[] = { pre_std
, NULL
};
183 static const struct valids mdoc_valids
[MDOC_MAX
] = {
184 { NULL
, NULL
}, /* Ap */
185 { pres_dd
, posts_dd
}, /* Dd */
186 { pres_dt
, posts_dt
}, /* Dt */
187 { pres_os
, posts_os
}, /* Os */
188 { pres_sh
, posts_sh
}, /* Sh */
189 { pres_ss
, posts_ss
}, /* Ss */
190 { pres_pp
, posts_notext
}, /* Pp */
191 { pres_d1
, posts_wline
}, /* D1 */
192 { pres_dl
, posts_dl
}, /* Dl */
193 { pres_bd
, posts_bd
}, /* Bd */
194 { NULL
, NULL
}, /* Ed */
195 { pres_bl
, posts_bl
}, /* Bl */
196 { NULL
, NULL
}, /* El */
197 { pres_it
, posts_it
}, /* It */
198 { NULL
, NULL
}, /* Ad */
199 { pres_an
, posts_an
}, /* An */
200 { NULL
, posts_defaults
}, /* Ar */
201 { NULL
, NULL
}, /* Cd */
202 { NULL
, NULL
}, /* Cm */
203 { NULL
, NULL
}, /* Dv */
204 { pres_er
, NULL
}, /* Er */
205 { NULL
, NULL
}, /* Ev */
206 { pres_std
, posts_std
}, /* Ex */
207 { NULL
, NULL
}, /* Fa */
208 { pres_fd
, posts_text
}, /* Fd */
209 { NULL
, NULL
}, /* Fl */
210 { NULL
, NULL
}, /* Fn */
211 { NULL
, NULL
}, /* Ft */
212 { NULL
, NULL
}, /* Ic */
213 { NULL
, posts_text1
}, /* In */
214 { NULL
, posts_defaults
}, /* Li */
215 { NULL
, posts_nd
}, /* Nd */
216 { NULL
, posts_nm
}, /* Nm */
217 { NULL
, NULL
}, /* Op */
218 { NULL
, NULL
}, /* Ot */
219 { NULL
, posts_defaults
}, /* Pa */
220 { pres_std
, posts_std
}, /* Rv */
221 { NULL
, posts_st
}, /* St */
222 { NULL
, NULL
}, /* Va */
223 { NULL
, posts_vt
}, /* Vt */
224 { NULL
, posts_text
}, /* Xr */
225 { NULL
, posts_text
}, /* %A */
226 { NULL
, posts_text
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
227 { NULL
, posts_text
}, /* %D */
228 { NULL
, posts_text
}, /* %I */
229 { NULL
, posts_text
}, /* %J */
230 { NULL
, posts_text
}, /* %N */
231 { NULL
, posts_text
}, /* %O */
232 { NULL
, posts_text
}, /* %P */
233 { NULL
, posts_text
}, /* %R */
234 { NULL
, posts_text
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
235 { NULL
, posts_text
}, /* %V */
236 { NULL
, NULL
}, /* Ac */
237 { NULL
, NULL
}, /* Ao */
238 { NULL
, NULL
}, /* Aq */
239 { NULL
, posts_at
}, /* At */
240 { NULL
, NULL
}, /* Bc */
241 { NULL
, posts_bf
}, /* Bf */
242 { NULL
, NULL
}, /* Bo */
243 { NULL
, NULL
}, /* Bq */
244 { NULL
, NULL
}, /* Bsx */
245 { NULL
, posts_bx
}, /* Bx */
246 { NULL
, posts_bool
}, /* Db */
247 { NULL
, NULL
}, /* Dc */
248 { NULL
, NULL
}, /* Do */
249 { NULL
, NULL
}, /* Dq */
250 { NULL
, NULL
}, /* Ec */
251 { NULL
, NULL
}, /* Ef */
252 { NULL
, NULL
}, /* Em */
253 { NULL
, NULL
}, /* Eo */
254 { NULL
, NULL
}, /* Fx */
255 { NULL
, NULL
}, /* Ms */
256 { NULL
, posts_notext
}, /* No */
257 { NULL
, posts_ns
}, /* Ns */
258 { NULL
, NULL
}, /* Nx */
259 { NULL
, NULL
}, /* Ox */
260 { NULL
, NULL
}, /* Pc */
261 { NULL
, posts_text1
}, /* Pf */
262 { NULL
, NULL
}, /* Po */
263 { NULL
, NULL
}, /* Pq */
264 { NULL
, NULL
}, /* Qc */
265 { NULL
, NULL
}, /* Ql */
266 { NULL
, NULL
}, /* Qo */
267 { NULL
, NULL
}, /* Qq */
268 { NULL
, NULL
}, /* Re */
269 { NULL
, posts_rs
}, /* Rs */
270 { NULL
, NULL
}, /* Sc */
271 { NULL
, NULL
}, /* So */
272 { NULL
, NULL
}, /* Sq */
273 { NULL
, posts_bool
}, /* Sm */
274 { NULL
, NULL
}, /* Sx */
275 { NULL
, NULL
}, /* Sy */
276 { NULL
, NULL
}, /* Tn */
277 { NULL
, NULL
}, /* Ux */
278 { NULL
, NULL
}, /* Xc */
279 { NULL
, NULL
}, /* Xo */
280 { NULL
, posts_fo
}, /* Fo */
281 { NULL
, NULL
}, /* Fc */
282 { NULL
, NULL
}, /* Oo */
283 { NULL
, NULL
}, /* Oc */
284 { NULL
, posts_bk
}, /* Bk */
285 { NULL
, NULL
}, /* Ek */
286 { NULL
, posts_eoln
}, /* Bt */
287 { NULL
, NULL
}, /* Hf */
288 { NULL
, NULL
}, /* Fr */
289 { NULL
, posts_eoln
}, /* Ud */
290 { NULL
, posts_lb
}, /* Lb */
291 { NULL
, posts_notext
}, /* Lp */
292 { NULL
, NULL
}, /* Lk */
293 { NULL
, posts_defaults
}, /* Mt */
294 { NULL
, NULL
}, /* Brq */
295 { NULL
, NULL
}, /* Bro */
296 { NULL
, NULL
}, /* Brc */
297 { NULL
, posts_text
}, /* %C */
298 { NULL
, NULL
}, /* Es */
299 { NULL
, NULL
}, /* En */
300 { NULL
, NULL
}, /* Dx */
301 { NULL
, posts_text
}, /* %Q */
302 { NULL
, posts_notext
}, /* br */
303 { pres_pp
, posts_sp
}, /* sp */
304 { NULL
, posts_text1
}, /* %U */
305 { NULL
, NULL
}, /* Ta */
308 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
310 static const enum mdoct rsord
[RSORD_MAX
] = {
327 static const char * const secnames
[SEC__MAX
] = {
333 "IMPLEMENTATION NOTES",
348 "SECURITY CONSIDERATIONS",
353 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
364 check_text(mdoc
, line
, pos
, tp
);
378 if (NULL
== mdoc_valids
[n
->tok
].pre
)
380 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
381 if ( ! (*p
)(mdoc
, n
))
388 mdoc_valid_post(struct mdoc
*mdoc
)
392 if (MDOC_VALID
& mdoc
->last
->flags
)
394 mdoc
->last
->flags
|= MDOC_VALID
;
396 switch (mdoc
->last
->type
) {
404 return(post_root(mdoc
));
409 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
411 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
419 check_count(struct mdoc
*m
, enum mdoc_type type
,
420 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
425 if (m
->last
->type
!= type
)
431 if (m
->last
->nchild
< val
)
436 if (m
->last
->nchild
> val
)
441 if (val
== m
->last
->nchild
)
449 t
= lvl
== CHECK_WARN
? MANDOCERR_ARGCWARN
: MANDOCERR_ARGCOUNT
;
450 mandoc_vmsg(t
, m
->parse
, m
->last
->line
, m
->last
->pos
,
451 "want %s%d children (have %d)",
452 p
, val
, m
->last
->nchild
);
460 return(check_count(mdoc
, MDOC_BODY
, CHECK_ERROR
, CHECK_GT
, 0));
466 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
472 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
478 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1));
484 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
490 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_LT
, 2));
496 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
502 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
508 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_GT
, 0));
514 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
518 check_args(struct mdoc
*m
, struct mdoc_node
*n
)
525 assert(n
->args
->argc
);
526 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
527 check_argv(m
, n
, &n
->args
->argv
[i
]);
531 check_argv(struct mdoc
*m
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
535 for (i
= 0; i
< (int)v
->sz
; i
++)
536 check_text(m
, v
->line
, v
->pos
, v
->value
[i
]);
538 /* FIXME: move to post_std(). */
540 if (MDOC_Std
== v
->arg
)
541 if ( ! (v
->sz
|| m
->meta
.name
))
542 mdoc_nmsg(m
, n
, MANDOCERR_NONAME
);
546 check_text(struct mdoc
*m
, int ln
, int pos
, char *p
)
552 sz
= strcspn(p
, "\t\\");
558 if ( ! (MDOC_LITERAL
& m
->flags
))
559 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADTAB
);
563 } else if ('\0' == *p
)
569 if (ESCAPE_ERROR
== mandoc_escape
570 ((const char **)&pp
, NULL
, NULL
)) {
571 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADESCAPE
);
576 while (NULL
!= (cpp
= memchr(cpp
, ASCII_HYPH
, pp
- cpp
)))
585 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
589 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
590 (t
== n
->parent
->type
))
593 mandoc_vmsg(MANDOCERR_SYNTCHILD
, mdoc
->parse
, n
->line
,
594 n
->pos
, "want parent %s", MDOC_ROOT
== t
?
595 "<root>" : mdoc_macronames
[tok
]);
601 pre_display(PRE_ARGS
)
603 struct mdoc_node
*node
;
605 if (MDOC_BLOCK
!= n
->type
)
608 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
609 if (MDOC_BLOCK
== node
->type
)
610 if (MDOC_Bd
== node
->tok
)
614 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
624 const char *offs
, *width
;
626 struct mdoc_node
*np
;
628 if (MDOC_BLOCK
!= n
->type
) {
629 if (ENDBODY_NOT
!= n
->end
) {
631 np
= n
->pending
->parent
;
636 assert(MDOC_BLOCK
== np
->type
);
637 assert(MDOC_Bl
== np
->tok
);
642 * First figure out which kind of list to use: bind ourselves to
643 * the first mentioned list type and warn about any remaining
644 * ones. If we find no list type, we default to LIST_item.
648 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
652 switch (n
->args
->argv
[i
].arg
) {
653 /* Set list types. */
687 /* Set list arguments. */
689 dup
= n
->norm
->Bl
.comp
;
693 dup
= (NULL
!= n
->norm
->Bl
.width
);
694 width
= n
->args
->argv
[i
].value
[0];
697 /* NB: this can be empty! */
698 if (n
->args
->argv
[i
].sz
) {
699 offs
= n
->args
->argv
[i
].value
[0];
700 dup
= (NULL
!= n
->norm
->Bl
.offs
);
703 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
709 /* Check: duplicate auxiliary arguments. */
712 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
715 n
->norm
->Bl
.comp
= comp
;
717 n
->norm
->Bl
.offs
= offs
;
719 n
->norm
->Bl
.width
= width
;
721 /* Check: multiple list types. */
723 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
!= LIST__NONE
)
724 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
726 /* Assign list type. */
728 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
== LIST__NONE
) {
729 n
->norm
->Bl
.type
= lt
;
730 /* Set column information, too. */
731 if (LIST_column
== lt
) {
734 n
->norm
->Bl
.cols
= (const char **)
735 n
->args
->argv
[i
].value
;
739 /* The list type should come first. */
741 if (n
->norm
->Bl
.type
== LIST__NONE
)
742 if (n
->norm
->Bl
.width
||
745 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
750 /* Allow lists to default to LIST_item. */
752 if (LIST__NONE
== n
->norm
->Bl
.type
) {
753 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
754 n
->norm
->Bl
.type
= LIST_item
;
758 * Validate the width field. Some list types don't need width
759 * types and should be warned about them. Others should have it
760 * and must also be warned.
763 switch (n
->norm
->Bl
.type
) {
765 if (n
->norm
->Bl
.width
)
767 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
778 if (n
->norm
->Bl
.width
)
779 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
795 struct mdoc_node
*np
;
797 if (MDOC_BLOCK
!= n
->type
) {
798 if (ENDBODY_NOT
!= n
->end
) {
800 np
= n
->pending
->parent
;
805 assert(MDOC_BLOCK
== np
->type
);
806 assert(MDOC_Bd
== np
->tok
);
811 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
816 switch (n
->args
->argv
[i
].arg
) {
823 case (MDOC_Unfilled
):
833 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
836 /* NB: this can be empty! */
837 if (n
->args
->argv
[i
].sz
) {
838 offs
= n
->args
->argv
[i
].value
[0];
839 dup
= (NULL
!= n
->norm
->Bd
.offs
);
842 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
846 dup
= n
->norm
->Bd
.comp
;
853 /* Check whether we have duplicates. */
856 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
858 /* Make our auxiliary assignments. */
861 n
->norm
->Bd
.offs
= offs
;
863 n
->norm
->Bd
.comp
= comp
;
865 /* Check whether a type has already been assigned. */
867 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
!= DISP__NONE
)
868 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
870 /* Make our type assignment. */
872 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
== DISP__NONE
)
873 n
->norm
->Bd
.type
= dt
;
876 if (DISP__NONE
== n
->norm
->Bd
.type
) {
877 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
878 n
->norm
->Bd
.type
= DISP_ragged
;
889 if (MDOC_BLOCK
!= n
->type
)
891 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
899 if (MDOC_BLOCK
!= n
->type
)
902 roff_regunset(mdoc
->roff
, REG_nS
);
903 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
911 if (MDOC_BLOCK
!= n
->type
)
914 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
926 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
927 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
928 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
930 if (MDOC_Split
== n
->args
->argv
[0].arg
)
931 n
->norm
->An
.auth
= AUTH_split
;
932 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
933 n
->norm
->An
.auth
= AUTH_nosplit
;
944 if (n
->args
&& 1 == n
->args
->argc
)
945 if (MDOC_Std
== n
->args
->argv
[0].arg
)
948 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
956 if (NULL
== mdoc
->meta
.date
|| mdoc
->meta
.os
)
957 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
959 if (mdoc
->meta
.title
)
960 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
969 if (NULL
== mdoc
->meta
.title
|| NULL
== mdoc
->meta
.date
)
970 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
973 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
982 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
983 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
986 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
995 struct mdoc_node
*np
;
999 * Unlike other data pointers, these are "housed" by the HEAD
1000 * element, which contains the goods.
1003 if (MDOC_HEAD
!= mdoc
->last
->type
) {
1004 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
1005 assert(mdoc
->last
->pending
);
1006 np
= mdoc
->last
->pending
->parent
->head
;
1007 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
1008 np
= mdoc
->last
->parent
->head
;
1010 np
= mdoc
->last
->head
;
1013 assert(MDOC_HEAD
== np
->type
);
1014 assert(MDOC_Bf
== np
->tok
);
1019 assert(MDOC_BLOCK
== np
->parent
->type
);
1020 assert(MDOC_Bf
== np
->parent
->tok
);
1023 * Cannot have both argument and parameter.
1024 * If neither is specified, let it through with a warning.
1027 if (np
->parent
->args
&& np
->child
) {
1028 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
1030 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
1031 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1035 /* Extract argument into data. */
1037 if (np
->parent
->args
) {
1038 arg
= np
->parent
->args
->argv
[0].arg
;
1039 if (MDOC_Emphasis
== arg
)
1040 np
->norm
->Bf
.font
= FONT_Em
;
1041 else if (MDOC_Literal
== arg
)
1042 np
->norm
->Bf
.font
= FONT_Li
;
1043 else if (MDOC_Symbolic
== arg
)
1044 np
->norm
->Bf
.font
= FONT_Sy
;
1050 /* Extract parameter into data. */
1052 if (0 == strcmp(np
->child
->string
, "Em"))
1053 np
->norm
->Bf
.font
= FONT_Em
;
1054 else if (0 == strcmp(np
->child
->string
, "Li"))
1055 np
->norm
->Bf
.font
= FONT_Li
;
1056 else if (0 == strcmp(np
->child
->string
, "Sy"))
1057 np
->norm
->Bf
.font
= FONT_Sy
;
1059 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1071 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1073 assert(mdoc
->last
->child
);
1074 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1076 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1078 /* If lookup ok, replace with table value. */
1081 free(mdoc
->last
->child
->string
);
1082 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1086 /* If not, use "library ``xxxx''. */
1088 sz
= strlen(mdoc
->last
->child
->string
) +
1089 2 + strlen("\\(lqlibrary\\(rq");
1090 buf
= mandoc_malloc(sz
);
1091 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1092 mdoc
->last
->child
->string
);
1093 free(mdoc
->last
->child
->string
);
1094 mdoc
->last
->child
->string
= buf
;
1099 post_eoln(POST_ARGS
)
1102 if (mdoc
->last
->child
)
1103 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1111 const struct mdoc_node
*n
;
1114 * The Vt macro comes in both ELEM and BLOCK form, both of which
1115 * have different syntaxes (yet more context-sensitive
1116 * behaviour). ELEM types must have a child, which is already
1117 * guaranteed by the in_line parsing routine; BLOCK types,
1118 * specifically the BODY, should only have TEXT children.
1121 if (MDOC_BODY
!= mdoc
->last
->type
)
1124 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1125 if (MDOC_TEXT
!= n
->type
)
1126 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1137 /* If no child specified, make sure we have the meta name. */
1139 if (NULL
== mdoc
->last
->child
&& NULL
== mdoc
->meta
.name
) {
1140 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1142 } else if (mdoc
->meta
.name
)
1145 /* If no meta name, set it from the child. */
1147 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1150 mdoc
->meta
.name
= mandoc_strdup(buf
);
1156 post_literal(POST_ARGS
)
1160 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1161 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1162 * this in literal mode, but it doesn't hurt to just switch it
1163 * off in general since displays can't be nested.
1166 if (MDOC_BODY
== mdoc
->last
->type
)
1167 mdoc
->flags
&= ~MDOC_LITERAL
;
1173 post_defaults(POST_ARGS
)
1175 struct mdoc_node
*nn
;
1178 * The `Ar' defaults to "file ..." if no value is provided as an
1179 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1180 * gets an empty string.
1183 if (mdoc
->last
->child
)
1187 mdoc
->next
= MDOC_NEXT_CHILD
;
1191 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1193 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1197 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1199 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1203 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1209 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1229 * If we have a child, look it up in the standard keys. If a
1230 * key exist, use that instead of the child; if it doesn't,
1231 * prefix "AT&T UNIX " to the existing data.
1234 if (NULL
== mdoc
->last
->child
)
1237 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1238 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1241 free(mdoc
->last
->child
->string
);
1242 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1244 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1246 q
= mdoc
->last
->child
->string
;
1247 sz
= strlen(p
) + strlen(q
) + 1;
1248 buf
= mandoc_malloc(sz
);
1249 strlcpy(buf
, p
, sz
);
1250 strlcat(buf
, q
, sz
);
1251 free(mdoc
->last
->child
->string
);
1252 mdoc
->last
->child
->string
= buf
;
1261 struct mdoc_node
*np
;
1264 if (AUTH__NONE
== np
->norm
->An
.auth
) {
1266 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0);
1267 } else if (np
->child
)
1268 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0);
1279 struct mdoc_node
*n
, *c
;
1282 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1285 n
= mdoc
->last
->parent
->parent
;
1286 lt
= n
->norm
->Bl
.type
;
1288 if (LIST__NONE
== lt
) {
1289 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1295 if (mdoc
->last
->head
->child
)
1297 /* FIXME: give this a dummy value. */
1298 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1307 if (NULL
== mdoc
->last
->head
->child
)
1308 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1317 if (NULL
== mdoc
->last
->body
->child
)
1318 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1321 if (mdoc
->last
->head
->child
)
1322 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1325 cols
= (int)n
->norm
->Bl
.ncols
;
1327 assert(NULL
== mdoc
->last
->head
->child
);
1329 if (NULL
== mdoc
->last
->body
->child
)
1330 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1332 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1333 if (MDOC_BODY
== c
->type
)
1337 er
= MANDOCERR_ARGCOUNT
;
1338 else if (i
== cols
|| i
== cols
+ 1)
1341 er
= MANDOCERR_SYNTARGCOUNT
;
1343 mandoc_vmsg(er
, mdoc
->parse
, mdoc
->last
->line
,
1345 "columns == %d (have %d)", cols
, i
);
1346 return(MANDOCERR_ARGCOUNT
== er
);
1355 post_bl_block(POST_ARGS
)
1357 struct mdoc_node
*n
;
1360 * These are fairly complicated, so we've broken them into two
1361 * functions. post_bl_block_tag() is called when a -tag is
1362 * specified, but no -width (it must be guessed). The second
1363 * when a -width is specified (macro indicators must be
1364 * rewritten into real lengths).
1369 if (LIST_tag
== n
->norm
->Bl
.type
&&
1370 NULL
== n
->norm
->Bl
.width
) {
1371 if ( ! post_bl_block_tag(mdoc
))
1373 } else if (NULL
!= n
->norm
->Bl
.width
) {
1374 if ( ! post_bl_block_width(mdoc
))
1379 assert(n
->norm
->Bl
.width
);
1384 post_bl_block_width(POST_ARGS
)
1389 struct mdoc_node
*n
;
1395 * Calculate the real width of a list from the -width string,
1396 * which may contain a macro (with a known default width), a
1397 * literal string, or a scaling width.
1399 * If the value to -width is a macro, then we re-write it to be
1400 * the macro's width as set in share/tmac/mdoc/doc-common.
1403 if (0 == strcmp(n
->norm
->Bl
.width
, "Ds"))
1405 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->norm
->Bl
.width
)))
1407 else if (0 == (width
= macro2len(tok
))) {
1408 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1412 /* The value already exists: free and reallocate it. */
1416 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1417 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1420 assert(i
< (int)n
->args
->argc
);
1422 snprintf(buf
, NUMSIZ
, "%zun", width
);
1423 free(n
->args
->argv
[i
].value
[0]);
1424 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1426 /* Set our width! */
1427 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1432 post_bl_block_tag(POST_ARGS
)
1434 struct mdoc_node
*n
, *nn
;
1440 * Calculate the -width for a `Bl -tag' list if it hasn't been
1441 * provided. Uses the first head macro. NOTE AGAIN: this is
1442 * ONLY if the -width argument has NOT been provided. See
1443 * post_bl_block_width() for converting the -width string.
1449 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1450 if (MDOC_It
!= nn
->tok
)
1453 assert(MDOC_BLOCK
== nn
->type
);
1454 nn
= nn
->head
->child
;
1459 if (MDOC_TEXT
== nn
->type
) {
1460 sz
= strlen(nn
->string
) + 1;
1464 if (0 != (ssz
= macro2len(nn
->tok
)))
1470 /* Defaults to ten ens. */
1472 snprintf(buf
, NUMSIZ
, "%zun", sz
);
1475 * We have to dynamically add this to the macro's argument list.
1476 * We're guaranteed that a MDOC_Width doesn't already exist.
1480 i
= (int)(n
->args
->argc
)++;
1482 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1483 n
->args
->argc
* sizeof(struct mdoc_argv
));
1485 n
->args
->argv
[i
].arg
= MDOC_Width
;
1486 n
->args
->argv
[i
].line
= n
->line
;
1487 n
->args
->argv
[i
].pos
= n
->pos
;
1488 n
->args
->argv
[i
].sz
= 1;
1489 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1490 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1492 /* Set our width! */
1493 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1499 post_bl_head(POST_ARGS
)
1501 struct mdoc_node
*np
, *nn
, *nnp
;
1504 if (LIST_column
!= mdoc
->last
->norm
->Bl
.type
)
1505 /* FIXME: this should be ERROR class... */
1506 return(hwarn_eq0(mdoc
));
1509 * Convert old-style lists, where the column width specifiers
1510 * trail as macro parameters, to the new-style ("normal-form")
1511 * lists where they're argument values following -column.
1514 /* First, disallow both types and allow normal-form. */
1517 * TODO: technically, we can accept both and just merge the two
1518 * lists, but I'll leave that for another day.
1521 if (mdoc
->last
->norm
->Bl
.ncols
&& mdoc
->last
->nchild
) {
1522 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1524 } else if (NULL
== mdoc
->last
->child
)
1527 np
= mdoc
->last
->parent
;
1530 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1531 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1534 assert(j
< (int)np
->args
->argc
);
1535 assert(0 == np
->args
->argv
[j
].sz
);
1538 * Accommodate for new-style groff column syntax. Shuffle the
1539 * child nodes, all of which must be TEXT, as arguments for the
1540 * column field. Then, delete the head children.
1543 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1544 np
->args
->argv
[j
].value
= mandoc_malloc
1545 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1547 mdoc
->last
->norm
->Bl
.ncols
= np
->args
->argv
[j
].sz
;
1548 mdoc
->last
->norm
->Bl
.cols
= (const char **)np
->args
->argv
[j
].value
;
1550 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1551 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1555 mdoc_node_delete(NULL
, nnp
);
1558 mdoc
->last
->nchild
= 0;
1559 mdoc
->last
->child
= NULL
;
1567 struct mdoc_node
*n
;
1569 if (MDOC_HEAD
== mdoc
->last
->type
)
1570 return(post_bl_head(mdoc
));
1571 if (MDOC_BLOCK
== mdoc
->last
->type
)
1572 return(post_bl_block(mdoc
));
1573 if (MDOC_BODY
!= mdoc
->last
->type
)
1576 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1581 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1591 mdoc_nmsg(mdoc
, n
, MANDOCERR_SYNTCHILD
);
1599 ebool(struct mdoc
*mdoc
)
1602 if (NULL
== mdoc
->last
->child
) {
1603 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1604 mdoc_node_delete(mdoc
, mdoc
->last
);
1607 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1609 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1611 if (0 == strcmp(mdoc
->last
->child
->string
, "on"))
1613 if (0 == strcmp(mdoc
->last
->child
->string
, "off"))
1616 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1621 post_root(POST_ARGS
)
1624 struct mdoc_node
*n
;
1628 /* Check that we have a finished prologue. */
1630 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1632 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1638 /* Check that we begin with a proper `Sh'. */
1640 if (NULL
== n
->child
) {
1642 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1643 } else if (MDOC_BLOCK
!= n
->child
->type
||
1644 MDOC_Sh
!= n
->child
->tok
) {
1646 /* Can this be lifted? See rxdebug.1 for example. */
1647 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1650 return(erc
? 0 : 1);
1656 struct mdoc_node
*ch
;
1659 if (NULL
== (ch
= mdoc
->last
->child
)) {
1660 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1661 mdoc_node_delete(mdoc
, mdoc
->last
);
1665 assert(MDOC_TEXT
== ch
->type
);
1667 if (NULL
== (p
= mdoc_a2st(ch
->string
))) {
1668 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1669 mdoc_node_delete(mdoc
, mdoc
->last
);
1672 ch
->string
= mandoc_strdup(p
);
1681 struct mdoc_node
*nn
, *next
, *prev
;
1684 switch (mdoc
->last
->type
) {
1686 check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0);
1689 if (mdoc
->last
->child
)
1691 check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0);
1698 * Make sure only certain types of nodes are allowed within the
1699 * the `Rs' body. Delete offending nodes and raise a warning.
1700 * Do this before re-ordering for the sake of clarity.
1704 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1705 for (i
= 0; i
< RSORD_MAX
; i
++)
1706 if (nn
->tok
== rsord
[i
])
1709 if (i
< RSORD_MAX
) {
1710 if (MDOC__J
== rsord
[i
] || MDOC__B
== rsord
[i
])
1711 mdoc
->last
->norm
->Rs
.quote_T
++;
1717 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1718 mdoc_node_delete(mdoc
, nn
);
1722 * The full `Rs' block needs special handling to order the
1723 * sub-elements according to `rsord'. Pick through each element
1724 * and correctly order it. This is a insertion sort.
1728 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1729 /* Determine order of `nn'. */
1730 for (i
= 0; i
< RSORD_MAX
; i
++)
1731 if (rsord
[i
] == nn
->tok
)
1735 * Remove `nn' from the chain. This somewhat
1736 * repeats mdoc_node_unlink(), but since we're
1737 * just re-ordering, there's no need for the
1738 * full unlink process.
1741 if (NULL
!= (next
= nn
->next
))
1742 next
->prev
= nn
->prev
;
1744 if (NULL
!= (prev
= nn
->prev
))
1745 prev
->next
= nn
->next
;
1747 nn
->prev
= nn
->next
= NULL
;
1750 * Scan back until we reach a node that's
1751 * ordered before `nn'.
1754 for ( ; prev
; prev
= prev
->prev
) {
1755 /* Determine order of `prev'. */
1756 for (j
= 0; j
< RSORD_MAX
; j
++)
1757 if (rsord
[j
] == prev
->tok
)
1765 * Set `nn' back into its correct place in front
1766 * of the `prev' node.
1773 prev
->next
->prev
= nn
;
1774 nn
->next
= prev
->next
;
1777 mdoc
->last
->child
->prev
= nn
;
1778 nn
->next
= mdoc
->last
->child
;
1779 mdoc
->last
->child
= nn
;
1790 if (MDOC_LINE
& mdoc
->last
->flags
)
1791 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNNS
);
1799 if (MDOC_HEAD
== mdoc
->last
->type
)
1800 return(post_sh_head(mdoc
));
1801 if (MDOC_BODY
== mdoc
->last
->type
)
1802 return(post_sh_body(mdoc
));
1808 post_sh_body(POST_ARGS
)
1810 struct mdoc_node
*n
;
1812 if (SEC_NAME
!= mdoc
->lastsec
)
1816 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1817 * macros (can have multiple `Nm' and one `Nd'). Note that the
1818 * children of the BODY declaration can also be "text".
1821 if (NULL
== (n
= mdoc
->last
->child
)) {
1822 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1826 for ( ; n
&& n
->next
; n
= n
->next
) {
1827 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1829 if (MDOC_TEXT
== n
->type
)
1831 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1835 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1838 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1843 post_sh_head(POST_ARGS
)
1849 * Process a new section. Sections are either "named" or
1850 * "custom". Custom sections are user-defined, while named ones
1851 * follow a conventional order and may only appear in certain
1855 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1860 /* The NAME should be first. */
1862 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1863 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1865 /* The SYNOPSIS gets special attention in other areas. */
1867 if (SEC_SYNOPSIS
== sec
)
1868 mdoc
->flags
|= MDOC_SYNOPSIS
;
1870 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
1872 /* Mark our last section. */
1874 mdoc
->lastsec
= sec
;
1876 /* We don't care about custom sections after this. */
1878 if (SEC_CUSTOM
== sec
)
1882 * Check whether our non-custom section is being repeated or is
1886 if (sec
== mdoc
->lastnamed
)
1887 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
1889 if (sec
< mdoc
->lastnamed
)
1890 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
1892 /* Mark the last named section. */
1894 mdoc
->lastnamed
= sec
;
1896 /* Check particular section/manual conventions. */
1898 assert(mdoc
->meta
.msec
);
1901 case (SEC_RETURN_VALUES
):
1906 if (*mdoc
->meta
.msec
== '2')
1908 if (*mdoc
->meta
.msec
== '3')
1910 if (*mdoc
->meta
.msec
== '9')
1912 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECMSEC
);
1922 post_ignpar(POST_ARGS
)
1924 struct mdoc_node
*np
;
1926 if (MDOC_BODY
!= mdoc
->last
->type
)
1929 if (NULL
!= (np
= mdoc
->last
->child
))
1930 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1931 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1932 mdoc_node_delete(mdoc
, np
);
1935 if (NULL
!= (np
= mdoc
->last
->last
))
1936 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1937 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1938 mdoc_node_delete(mdoc
, np
);
1948 if (NULL
== mdoc
->last
)
1950 if (MDOC_ELEM
!= n
->type
&& MDOC_BLOCK
!= n
->type
)
1954 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1955 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1958 if (MDOC_Pp
!= mdoc
->last
->tok
&& MDOC_Lp
!= mdoc
->last
->tok
)
1960 if (MDOC_Bl
== n
->tok
&& n
->norm
->Bl
.comp
)
1962 if (MDOC_Bd
== n
->tok
&& n
->norm
->Bd
.comp
)
1964 if (MDOC_It
== n
->tok
&& n
->parent
->norm
->Bl
.comp
)
1967 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
1968 mdoc_node_delete(mdoc
, mdoc
->last
);
1973 pre_literal(PRE_ARGS
)
1976 if (MDOC_BODY
!= n
->type
)
1980 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1981 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1986 mdoc
->flags
|= MDOC_LITERAL
;
1989 if (DISP_literal
== n
->norm
->Bd
.type
)
1990 mdoc
->flags
|= MDOC_LITERAL
;
1991 if (DISP_unfilled
== n
->norm
->Bd
.type
)
1992 mdoc
->flags
|= MDOC_LITERAL
;
2006 struct mdoc_node
*n
;
2008 if (mdoc
->meta
.date
)
2009 free(mdoc
->meta
.date
);
2012 if (NULL
== n
->child
|| '\0' == n
->child
->string
[0]) {
2013 mdoc
->meta
.date
= mandoc_normdate
2014 (mdoc
->parse
, NULL
, n
->line
, n
->pos
);
2018 if ( ! concat(mdoc
, buf
, n
->child
, DATESIZE
))
2021 mdoc
->meta
.date
= mandoc_normdate
2022 (mdoc
->parse
, buf
, n
->line
, n
->pos
);
2030 struct mdoc_node
*nn
, *n
;
2036 if (mdoc
->meta
.title
)
2037 free(mdoc
->meta
.title
);
2039 free(mdoc
->meta
.vol
);
2040 if (mdoc
->meta
.arch
)
2041 free(mdoc
->meta
.arch
);
2043 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
2045 /* First make all characters uppercase. */
2047 if (NULL
!= (nn
= n
->child
))
2048 for (p
= nn
->string
; *p
; p
++) {
2049 if (toupper((u_char
)*p
) == *p
)
2053 * FIXME: don't be lazy: have this make all
2054 * characters be uppercase and just warn once.
2056 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2061 * --> title = unknown, volume = local, msec = 0, arch = NULL
2064 if (NULL
== (nn
= n
->child
)) {
2065 /* XXX: make these macro values. */
2066 /* FIXME: warn about missing values. */
2067 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2068 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2069 mdoc
->meta
.msec
= mandoc_strdup("1");
2073 /* Handles: `.Dt TITLE'
2074 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2077 mdoc
->meta
.title
= mandoc_strdup
2078 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2080 if (NULL
== (nn
= nn
->next
)) {
2081 /* FIXME: warn about missing msec. */
2082 /* XXX: make this a macro value. */
2083 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2084 mdoc
->meta
.msec
= mandoc_strdup("1");
2088 /* Handles: `.Dt TITLE SEC'
2089 * --> title = TITLE, volume = SEC is msec ?
2090 * format(msec) : SEC,
2091 * msec = SEC is msec ? atoi(msec) : 0,
2095 cp
= mdoc_a2msec(nn
->string
);
2097 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2098 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2100 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2101 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2102 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2105 if (NULL
== (nn
= nn
->next
))
2108 /* Handles: `.Dt TITLE SEC VOL'
2109 * --> title = TITLE, volume = VOL is vol ?
2111 * VOL is arch ? format(arch) :
2115 cp
= mdoc_a2vol(nn
->string
);
2117 free(mdoc
->meta
.vol
);
2118 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2120 /* FIXME: warn about bad arch. */
2121 cp
= mdoc_a2arch(nn
->string
);
2123 free(mdoc
->meta
.vol
);
2124 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2126 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2129 /* Ignore any subsequent parameters... */
2130 /* FIXME: warn about subsequent parameters. */
2136 post_prol(POST_ARGS
)
2139 * Remove prologue macros from the document after they're
2140 * processed. The final document uses mdoc_meta for these
2141 * values and discards the originals.
2144 mdoc_node_delete(mdoc
, mdoc
->last
);
2145 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2146 mdoc
->flags
|= MDOC_PBODY
;
2154 struct mdoc_node
*n
;
2157 * Make `Bx's second argument always start with an uppercase
2158 * letter. Groff checks if it's an "accepted" term, but we just
2159 * uppercase blindly.
2162 n
= mdoc
->last
->child
;
2163 if (n
&& NULL
!= (n
= n
->next
))
2164 *n
->string
= (char)toupper
2165 ((unsigned char)*n
->string
);
2173 struct mdoc_node
*n
;
2176 struct utsname utsname
;
2182 * Set the operating system by way of the `Os' macro. Note that
2183 * if an argument isn't provided and -DOSNAME="\"foo\"" is
2184 * provided during compilation, this value will be used instead
2185 * of filling in "sysname release" from uname().
2189 free(mdoc
->meta
.os
);
2191 if ( ! concat(mdoc
, buf
, n
->child
, BUFSIZ
))
2194 /* XXX: yes, these can all be dynamically-adjusted buffers, but
2195 * it's really not worth the extra hackery.
2198 if ('\0' == buf
[0]) {
2200 if (strlcat(buf
, OSNAME
, BUFSIZ
) >= BUFSIZ
) {
2201 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2205 if (-1 == uname(&utsname
)) {
2206 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2207 mdoc
->meta
.os
= mandoc_strdup("UNKNOWN");
2208 return(post_prol(mdoc
));
2211 if (strlcat(buf
, utsname
.sysname
, BUFSIZ
) >= BUFSIZ
) {
2212 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2215 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
2216 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2219 if (strlcat(buf
, utsname
.release
, BUFSIZ
) >= BUFSIZ
) {
2220 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2226 mdoc
->meta
.os
= mandoc_strdup(buf
);
2233 struct mdoc_node
*nn
, *n
;
2238 * Macros accepting `-std' as an argument have the name of the
2239 * current document (`Nm') filled in as the argument if it's not
2246 if (NULL
== mdoc
->meta
.name
)
2250 mdoc
->next
= MDOC_NEXT_CHILD
;
2252 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2260 concat(struct mdoc
*m
, char *p
, const struct mdoc_node
*n
, size_t sz
)
2266 * Concatenate sibling nodes together. All siblings must be of
2267 * type MDOC_TEXT or an assertion is raised. Concatenation is
2268 * separated by a single whitespace. Returns 0 on fatal (string
2272 for ( ; n
; n
= n
->next
) {
2273 assert(MDOC_TEXT
== n
->type
);
2275 if (strlcat(p
, n
->string
, sz
) >= sz
) {
2276 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);
2280 if (NULL
== n
->next
)
2283 if (strlcat(p
, " ", sz
) >= sz
) {
2284 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);
2292 static enum mdoc_sec
2293 a2sec(const char *p
)
2297 for (i
= 0; i
< (int)SEC__MAX
; i
++)
2298 if (secnames
[i
] && 0 == strcmp(p
, secnames
[i
]))
2299 return((enum mdoc_sec
)i
);
2305 macro2len(enum mdoct macro
)