]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.159 2011/03/15 16: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>
38 #include "libmandoc.h"
40 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
42 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
43 #define POST_ARGS struct mdoc *mdoc
59 typedef int (*v_pre
)(PRE_ARGS
);
60 typedef int (*v_post
)(POST_ARGS
);
67 static int check_count(struct mdoc
*, enum mdoc_type
,
68 enum check_lvl
, enum check_ineq
, int);
69 static int check_parent(PRE_ARGS
, enum mdoct
, enum mdoc_type
);
70 static void check_text(struct mdoc
*, int, int, char *);
71 static void check_argv(struct mdoc
*,
72 struct mdoc_node
*, struct mdoc_argv
*);
73 static void check_args(struct mdoc
*, struct mdoc_node
*);
75 static int concat(struct mdoc
*, char *,
76 const struct mdoc_node
*, size_t);
78 static int ebool(POST_ARGS
);
79 static int berr_ge1(POST_ARGS
);
80 static int bwarn_ge1(POST_ARGS
);
81 static int ewarn_eq0(POST_ARGS
);
82 static int ewarn_eq1(POST_ARGS
);
83 static int ewarn_ge1(POST_ARGS
);
84 static int ewarn_le1(POST_ARGS
);
85 static int hwarn_eq0(POST_ARGS
);
86 static int hwarn_eq1(POST_ARGS
);
87 static int hwarn_ge1(POST_ARGS
);
88 static int hwarn_le1(POST_ARGS
);
90 static int post_an(POST_ARGS
);
91 static int post_at(POST_ARGS
);
92 static int post_bf(POST_ARGS
);
93 static int post_bl(POST_ARGS
);
94 static int post_bl_block(POST_ARGS
);
95 static int post_bl_block_width(POST_ARGS
);
96 static int post_bl_block_tag(POST_ARGS
);
97 static int post_bl_head(POST_ARGS
);
98 static int post_bx(POST_ARGS
);
99 static int post_dd(POST_ARGS
);
100 static int post_dt(POST_ARGS
);
101 static int post_defaults(POST_ARGS
);
102 static int post_literal(POST_ARGS
);
103 static int post_eoln(POST_ARGS
);
104 static int post_it(POST_ARGS
);
105 static int post_lb(POST_ARGS
);
106 static int post_nm(POST_ARGS
);
107 static int post_ns(POST_ARGS
);
108 static int post_os(POST_ARGS
);
109 static int post_ignpar(POST_ARGS
);
110 static int post_prol(POST_ARGS
);
111 static int post_root(POST_ARGS
);
112 static int post_rs(POST_ARGS
);
113 static int post_sh(POST_ARGS
);
114 static int post_sh_body(POST_ARGS
);
115 static int post_sh_head(POST_ARGS
);
116 static int post_st(POST_ARGS
);
117 static int post_std(POST_ARGS
);
118 static int post_vt(POST_ARGS
);
119 static int pre_an(PRE_ARGS
);
120 static int pre_bd(PRE_ARGS
);
121 static int pre_bl(PRE_ARGS
);
122 static int pre_dd(PRE_ARGS
);
123 static int pre_display(PRE_ARGS
);
124 static int pre_dt(PRE_ARGS
);
125 static int pre_it(PRE_ARGS
);
126 static int pre_literal(PRE_ARGS
);
127 static int pre_os(PRE_ARGS
);
128 static int pre_par(PRE_ARGS
);
129 static int pre_sh(PRE_ARGS
);
130 static int pre_ss(PRE_ARGS
);
131 static int pre_std(PRE_ARGS
);
133 static v_post posts_an
[] = { post_an
, NULL
};
134 static v_post posts_at
[] = { post_at
, post_defaults
, NULL
};
135 static v_post posts_bd
[] = { post_literal
, hwarn_eq0
, bwarn_ge1
, NULL
};
136 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
137 static v_post posts_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
138 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
139 static v_post posts_bx
[] = { post_bx
, NULL
};
140 static v_post posts_bool
[] = { ebool
, NULL
};
141 static v_post posts_eoln
[] = { post_eoln
, NULL
};
142 static v_post posts_defaults
[] = { post_defaults
, NULL
};
143 static v_post posts_dd
[] = { post_dd
, post_prol
, NULL
};
144 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, NULL
};
145 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
146 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
147 static v_post posts_it
[] = { post_it
, NULL
};
148 static v_post posts_lb
[] = { post_lb
, NULL
};
149 static v_post posts_nd
[] = { berr_ge1
, NULL
};
150 static v_post posts_nm
[] = { post_nm
, NULL
};
151 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
152 static v_post posts_ns
[] = { post_ns
, NULL
};
153 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
154 static v_post posts_rs
[] = { post_rs
, NULL
};
155 static v_post posts_sh
[] = { post_ignpar
, hwarn_ge1
, bwarn_ge1
, post_sh
, NULL
};
156 static v_post posts_sp
[] = { ewarn_le1
, NULL
};
157 static v_post posts_ss
[] = { post_ignpar
, hwarn_ge1
, bwarn_ge1
, NULL
};
158 static v_post posts_st
[] = { post_st
, NULL
};
159 static v_post posts_std
[] = { post_std
, NULL
};
160 static v_post posts_text
[] = { ewarn_ge1
, NULL
};
161 static v_post posts_text1
[] = { ewarn_eq1
, NULL
};
162 static v_post posts_vt
[] = { post_vt
, NULL
};
163 static v_post posts_wline
[] = { bwarn_ge1
, NULL
};
164 static v_pre pres_an
[] = { pre_an
, NULL
};
165 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
166 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
167 static v_pre pres_d1
[] = { pre_display
, NULL
};
168 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
169 static v_pre pres_dd
[] = { pre_dd
, NULL
};
170 static v_pre pres_dt
[] = { pre_dt
, NULL
};
171 static v_pre pres_er
[] = { NULL
, NULL
};
172 static v_pre pres_fd
[] = { NULL
, NULL
};
173 static v_pre pres_it
[] = { pre_it
, pre_par
, NULL
};
174 static v_pre pres_os
[] = { pre_os
, NULL
};
175 static v_pre pres_pp
[] = { pre_par
, NULL
};
176 static v_pre pres_sh
[] = { pre_sh
, NULL
};
177 static v_pre pres_ss
[] = { pre_ss
, NULL
};
178 static v_pre pres_std
[] = { pre_std
, NULL
};
180 const struct valids mdoc_valids
[MDOC_MAX
] = {
181 { NULL
, NULL
}, /* Ap */
182 { pres_dd
, posts_dd
}, /* Dd */
183 { pres_dt
, posts_dt
}, /* Dt */
184 { pres_os
, posts_os
}, /* Os */
185 { pres_sh
, posts_sh
}, /* Sh */
186 { pres_ss
, posts_ss
}, /* Ss */
187 { pres_pp
, posts_notext
}, /* Pp */
188 { pres_d1
, posts_wline
}, /* D1 */
189 { pres_dl
, posts_dl
}, /* Dl */
190 { pres_bd
, posts_bd
}, /* Bd */
191 { NULL
, NULL
}, /* Ed */
192 { pres_bl
, posts_bl
}, /* Bl */
193 { NULL
, NULL
}, /* El */
194 { pres_it
, posts_it
}, /* It */
195 { NULL
, NULL
}, /* Ad */
196 { pres_an
, posts_an
}, /* An */
197 { NULL
, posts_defaults
}, /* Ar */
198 { NULL
, NULL
}, /* Cd */
199 { NULL
, NULL
}, /* Cm */
200 { NULL
, NULL
}, /* Dv */
201 { pres_er
, NULL
}, /* Er */
202 { NULL
, NULL
}, /* Ev */
203 { pres_std
, posts_std
}, /* Ex */
204 { NULL
, NULL
}, /* Fa */
205 { pres_fd
, posts_text
}, /* Fd */
206 { NULL
, NULL
}, /* Fl */
207 { NULL
, NULL
}, /* Fn */
208 { NULL
, NULL
}, /* Ft */
209 { NULL
, NULL
}, /* Ic */
210 { NULL
, posts_text1
}, /* In */
211 { NULL
, posts_defaults
}, /* Li */
212 { NULL
, posts_nd
}, /* Nd */
213 { NULL
, posts_nm
}, /* Nm */
214 { NULL
, NULL
}, /* Op */
215 { NULL
, NULL
}, /* Ot */
216 { NULL
, posts_defaults
}, /* Pa */
217 { pres_std
, posts_std
}, /* Rv */
218 { NULL
, posts_st
}, /* St */
219 { NULL
, NULL
}, /* Va */
220 { NULL
, posts_vt
}, /* Vt */
221 { NULL
, posts_text
}, /* Xr */
222 { NULL
, posts_text
}, /* %A */
223 { NULL
, posts_text
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
224 { NULL
, posts_text
}, /* %D */
225 { NULL
, posts_text
}, /* %I */
226 { NULL
, posts_text
}, /* %J */
227 { NULL
, posts_text
}, /* %N */
228 { NULL
, posts_text
}, /* %O */
229 { NULL
, posts_text
}, /* %P */
230 { NULL
, posts_text
}, /* %R */
231 { NULL
, posts_text
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
232 { NULL
, posts_text
}, /* %V */
233 { NULL
, NULL
}, /* Ac */
234 { NULL
, NULL
}, /* Ao */
235 { NULL
, NULL
}, /* Aq */
236 { NULL
, posts_at
}, /* At */
237 { NULL
, NULL
}, /* Bc */
238 { NULL
, posts_bf
}, /* Bf */
239 { NULL
, NULL
}, /* Bo */
240 { NULL
, NULL
}, /* Bq */
241 { NULL
, NULL
}, /* Bsx */
242 { NULL
, posts_bx
}, /* Bx */
243 { NULL
, posts_bool
}, /* Db */
244 { NULL
, NULL
}, /* Dc */
245 { NULL
, NULL
}, /* Do */
246 { NULL
, NULL
}, /* Dq */
247 { NULL
, NULL
}, /* Ec */
248 { NULL
, NULL
}, /* Ef */
249 { NULL
, NULL
}, /* Em */
250 { NULL
, NULL
}, /* Eo */
251 { NULL
, NULL
}, /* Fx */
252 { NULL
, NULL
}, /* Ms */
253 { NULL
, posts_notext
}, /* No */
254 { NULL
, posts_ns
}, /* Ns */
255 { NULL
, NULL
}, /* Nx */
256 { NULL
, NULL
}, /* Ox */
257 { NULL
, NULL
}, /* Pc */
258 { NULL
, posts_text1
}, /* Pf */
259 { NULL
, NULL
}, /* Po */
260 { NULL
, NULL
}, /* Pq */
261 { NULL
, NULL
}, /* Qc */
262 { NULL
, NULL
}, /* Ql */
263 { NULL
, NULL
}, /* Qo */
264 { NULL
, NULL
}, /* Qq */
265 { NULL
, NULL
}, /* Re */
266 { NULL
, posts_rs
}, /* Rs */
267 { NULL
, NULL
}, /* Sc */
268 { NULL
, NULL
}, /* So */
269 { NULL
, NULL
}, /* Sq */
270 { NULL
, posts_bool
}, /* Sm */
271 { NULL
, NULL
}, /* Sx */
272 { NULL
, NULL
}, /* Sy */
273 { NULL
, NULL
}, /* Tn */
274 { NULL
, NULL
}, /* Ux */
275 { NULL
, NULL
}, /* Xc */
276 { NULL
, NULL
}, /* Xo */
277 { NULL
, posts_fo
}, /* Fo */
278 { NULL
, NULL
}, /* Fc */
279 { NULL
, NULL
}, /* Oo */
280 { NULL
, NULL
}, /* Oc */
281 { NULL
, posts_bk
}, /* Bk */
282 { NULL
, NULL
}, /* Ek */
283 { NULL
, posts_eoln
}, /* Bt */
284 { NULL
, NULL
}, /* Hf */
285 { NULL
, NULL
}, /* Fr */
286 { NULL
, posts_eoln
}, /* Ud */
287 { NULL
, posts_lb
}, /* Lb */
288 { NULL
, posts_notext
}, /* Lp */
289 { NULL
, NULL
}, /* Lk */
290 { NULL
, posts_defaults
}, /* Mt */
291 { NULL
, NULL
}, /* Brq */
292 { NULL
, NULL
}, /* Bro */
293 { NULL
, NULL
}, /* Brc */
294 { NULL
, posts_text
}, /* %C */
295 { NULL
, NULL
}, /* Es */
296 { NULL
, NULL
}, /* En */
297 { NULL
, NULL
}, /* Dx */
298 { NULL
, posts_text
}, /* %Q */
299 { NULL
, posts_notext
}, /* br */
300 { pres_pp
, posts_sp
}, /* sp */
301 { NULL
, posts_text1
}, /* %U */
302 { NULL
, NULL
}, /* Ta */
305 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
307 static const enum mdoct rsord
[RSORD_MAX
] = {
326 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
337 check_text(mdoc
, line
, pos
, tp
);
351 if (NULL
== mdoc_valids
[n
->tok
].pre
)
353 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
354 if ( ! (*p
)(mdoc
, n
))
361 mdoc_valid_post(struct mdoc
*mdoc
)
365 if (MDOC_VALID
& mdoc
->last
->flags
)
367 mdoc
->last
->flags
|= MDOC_VALID
;
369 switch (mdoc
->last
->type
) {
377 return(post_root(mdoc
));
382 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
384 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
392 check_count(struct mdoc
*m
, enum mdoc_type type
,
393 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
398 if (m
->last
->type
!= type
)
404 if (m
->last
->nchild
< val
)
409 if (m
->last
->nchild
> val
)
414 if (val
== m
->last
->nchild
)
422 t
= lvl
== CHECK_WARN
? MANDOCERR_ARGCWARN
: MANDOCERR_ARGCOUNT
;
424 return(mdoc_vmsg(m
, t
, m
->last
->line
, m
->last
->pos
,
425 "want %s%d children (have %d)",
426 p
, val
, m
->last
->nchild
));
433 return(check_count(mdoc
, MDOC_BODY
, CHECK_ERROR
, CHECK_GT
, 0));
439 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
445 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
451 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1));
457 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
463 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_LT
, 2));
469 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
475 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
481 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_GT
, 0));
487 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
491 check_args(struct mdoc
*m
, struct mdoc_node
*n
)
498 assert(n
->args
->argc
);
499 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
500 check_argv(m
, n
, &n
->args
->argv
[i
]);
504 check_argv(struct mdoc
*m
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
508 for (i
= 0; i
< (int)v
->sz
; i
++)
509 check_text(m
, v
->line
, v
->pos
, v
->value
[i
]);
511 /* FIXME: move to post_std(). */
513 if (MDOC_Std
== v
->arg
)
514 if ( ! (v
->sz
|| m
->meta
.name
))
515 mdoc_nmsg(m
, n
, MANDOCERR_NONAME
);
519 check_text(struct mdoc
*m
, int ln
, int pos
, char *p
)
524 for ( ; *p
; p
++, pos
++) {
525 sz
= strcspn(p
, "\t\\");
534 if ( ! (MDOC_LITERAL
& m
->flags
))
535 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADTAB
);
539 if (0 == (c
= mandoc_special(p
))) {
540 mdoc_pmsg(m
, ln
, pos
, MANDOCERR_BADESCAPE
);
550 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
554 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
555 (t
== n
->parent
->type
))
558 mdoc_vmsg(mdoc
, MANDOCERR_SYNTCHILD
,
559 n
->line
, n
->pos
, "want parent %s",
560 MDOC_ROOT
== t
? "<root>" :
561 mdoc_macronames
[tok
]);
567 pre_display(PRE_ARGS
)
569 struct mdoc_node
*node
;
571 if (MDOC_BLOCK
!= n
->type
)
574 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
575 if (MDOC_BLOCK
== node
->type
)
576 if (MDOC_Bd
== node
->tok
)
580 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
590 const char *offs
, *width
;
592 struct mdoc_node
*np
;
594 if (MDOC_BLOCK
!= n
->type
) {
595 if (ENDBODY_NOT
!= n
->end
) {
597 np
= n
->pending
->parent
;
602 assert(MDOC_BLOCK
== np
->type
);
603 assert(MDOC_Bl
== np
->tok
);
608 * First figure out which kind of list to use: bind ourselves to
609 * the first mentioned list type and warn about any remaining
610 * ones. If we find no list type, we default to LIST_item.
614 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
618 switch (n
->args
->argv
[i
].arg
) {
619 /* Set list types. */
653 /* Set list arguments. */
655 dup
= n
->norm
->Bl
.comp
;
659 dup
= (NULL
!= n
->norm
->Bl
.width
);
660 width
= n
->args
->argv
[i
].value
[0];
663 /* NB: this can be empty! */
664 if (n
->args
->argv
[i
].sz
) {
665 offs
= n
->args
->argv
[i
].value
[0];
666 dup
= (NULL
!= n
->norm
->Bl
.offs
);
669 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
675 /* Check: duplicate auxiliary arguments. */
678 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
681 n
->norm
->Bl
.comp
= comp
;
683 n
->norm
->Bl
.offs
= offs
;
685 n
->norm
->Bl
.width
= width
;
687 /* Check: multiple list types. */
689 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
!= LIST__NONE
)
690 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
692 /* Assign list type. */
694 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
== LIST__NONE
) {
695 n
->norm
->Bl
.type
= lt
;
696 /* Set column information, too. */
697 if (LIST_column
== lt
) {
700 n
->norm
->Bl
.cols
= (const char **)
701 n
->args
->argv
[i
].value
;
705 /* The list type should come first. */
707 if (n
->norm
->Bl
.type
== LIST__NONE
)
708 if (n
->norm
->Bl
.width
||
711 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
716 /* Allow lists to default to LIST_item. */
718 if (LIST__NONE
== n
->norm
->Bl
.type
) {
719 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
720 n
->norm
->Bl
.type
= LIST_item
;
724 * Validate the width field. Some list types don't need width
725 * types and should be warned about them. Others should have it
726 * and must also be warned.
729 switch (n
->norm
->Bl
.type
) {
731 if (n
->norm
->Bl
.width
)
733 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
744 if (n
->norm
->Bl
.width
)
745 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
761 struct mdoc_node
*np
;
763 if (MDOC_BLOCK
!= n
->type
) {
764 if (ENDBODY_NOT
!= n
->end
) {
766 np
= n
->pending
->parent
;
771 assert(MDOC_BLOCK
== np
->type
);
772 assert(MDOC_Bd
== np
->tok
);
777 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
782 switch (n
->args
->argv
[i
].arg
) {
789 case (MDOC_Unfilled
):
799 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
802 /* NB: this can be empty! */
803 if (n
->args
->argv
[i
].sz
) {
804 offs
= n
->args
->argv
[i
].value
[0];
805 dup
= (NULL
!= n
->norm
->Bd
.offs
);
808 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
812 dup
= n
->norm
->Bd
.comp
;
819 /* Check whether we have duplicates. */
822 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
824 /* Make our auxiliary assignments. */
827 n
->norm
->Bd
.offs
= offs
;
829 n
->norm
->Bd
.comp
= comp
;
831 /* Check whether a type has already been assigned. */
833 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
!= DISP__NONE
)
834 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
836 /* Make our type assignment. */
838 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
== DISP__NONE
)
839 n
->norm
->Bd
.type
= dt
;
842 if (DISP__NONE
== n
->norm
->Bd
.type
) {
843 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
844 n
->norm
->Bd
.type
= DISP_ragged
;
855 if (MDOC_BLOCK
!= n
->type
)
857 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
865 if (MDOC_BLOCK
!= n
->type
)
868 mdoc
->regs
->regs
[(int)REG_nS
].set
= 0;
869 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
877 if (MDOC_BLOCK
!= n
->type
)
880 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
892 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
893 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
894 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
896 if (MDOC_Split
== n
->args
->argv
[0].arg
)
897 n
->norm
->An
.auth
= AUTH_split
;
898 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
899 n
->norm
->An
.auth
= AUTH_nosplit
;
910 if (n
->args
&& 1 == n
->args
->argc
)
911 if (MDOC_Std
== n
->args
->argv
[0].arg
)
914 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
922 if (NULL
== mdoc
->meta
.date
|| mdoc
->meta
.os
)
923 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
925 if (mdoc
->meta
.title
)
926 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
935 if (NULL
== mdoc
->meta
.title
|| NULL
== mdoc
->meta
.date
)
936 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
939 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
948 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
949 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
952 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
961 struct mdoc_node
*np
;
965 * Unlike other data pointers, these are "housed" by the HEAD
966 * element, which contains the goods.
969 if (MDOC_HEAD
!= mdoc
->last
->type
) {
970 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
971 assert(mdoc
->last
->pending
);
972 np
= mdoc
->last
->pending
->parent
->head
;
973 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
974 np
= mdoc
->last
->parent
->head
;
976 np
= mdoc
->last
->head
;
979 assert(MDOC_HEAD
== np
->type
);
980 assert(MDOC_Bf
== np
->tok
);
985 assert(MDOC_BLOCK
== np
->parent
->type
);
986 assert(MDOC_Bf
== np
->parent
->tok
);
989 * Cannot have both argument and parameter.
990 * If neither is specified, let it through with a warning.
993 if (np
->parent
->args
&& np
->child
) {
994 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
996 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
997 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1001 /* Extract argument into data. */
1003 if (np
->parent
->args
) {
1004 arg
= np
->parent
->args
->argv
[0].arg
;
1005 if (MDOC_Emphasis
== arg
)
1006 np
->norm
->Bf
.font
= FONT_Em
;
1007 else if (MDOC_Literal
== arg
)
1008 np
->norm
->Bf
.font
= FONT_Li
;
1009 else if (MDOC_Symbolic
== arg
)
1010 np
->norm
->Bf
.font
= FONT_Sy
;
1016 /* Extract parameter into data. */
1018 if (0 == strcmp(np
->child
->string
, "Em"))
1019 np
->norm
->Bf
.font
= FONT_Em
;
1020 else if (0 == strcmp(np
->child
->string
, "Li"))
1021 np
->norm
->Bf
.font
= FONT_Li
;
1022 else if (0 == strcmp(np
->child
->string
, "Sy"))
1023 np
->norm
->Bf
.font
= FONT_Sy
;
1025 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1037 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1039 assert(mdoc
->last
->child
);
1040 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1042 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1044 /* If lookup ok, replace with table value. */
1047 free(mdoc
->last
->child
->string
);
1048 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1052 /* If not, use "library ``xxxx''. */
1054 sz
= strlen(mdoc
->last
->child
->string
) +
1055 2 + strlen("\\(lqlibrary\\(rq");
1056 buf
= mandoc_malloc(sz
);
1057 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1058 mdoc
->last
->child
->string
);
1059 free(mdoc
->last
->child
->string
);
1060 mdoc
->last
->child
->string
= buf
;
1065 post_eoln(POST_ARGS
)
1068 if (mdoc
->last
->child
)
1069 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1077 const struct mdoc_node
*n
;
1080 * The Vt macro comes in both ELEM and BLOCK form, both of which
1081 * have different syntaxes (yet more context-sensitive
1082 * behaviour). ELEM types must have a child, which is already
1083 * guaranteed by the in_line parsing routine; BLOCK types,
1084 * specifically the BODY, should only have TEXT children.
1087 if (MDOC_BODY
!= mdoc
->last
->type
)
1090 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1091 if (MDOC_TEXT
!= n
->type
)
1092 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1103 /* If no child specified, make sure we have the meta name. */
1105 if (NULL
== mdoc
->last
->child
&& NULL
== mdoc
->meta
.name
) {
1106 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1108 } else if (mdoc
->meta
.name
)
1111 /* If no meta name, set it from the child. */
1113 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1116 mdoc
->meta
.name
= mandoc_strdup(buf
);
1122 post_literal(POST_ARGS
)
1126 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1127 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1128 * this in literal mode, but it doesn't hurt to just switch it
1129 * off in general since displays can't be nested.
1132 if (MDOC_BODY
== mdoc
->last
->type
)
1133 mdoc
->flags
&= ~MDOC_LITERAL
;
1139 post_defaults(POST_ARGS
)
1141 struct mdoc_node
*nn
;
1144 * The `Ar' defaults to "file ..." if no value is provided as an
1145 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1146 * gets an empty string.
1149 if (mdoc
->last
->child
)
1153 mdoc
->next
= MDOC_NEXT_CHILD
;
1157 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1159 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1163 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1165 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1169 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1175 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1195 * If we have a child, look it up in the standard keys. If a
1196 * key exist, use that instead of the child; if it doesn't,
1197 * prefix "AT&T UNIX " to the existing data.
1200 if (NULL
== mdoc
->last
->child
)
1203 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1204 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1207 free(mdoc
->last
->child
->string
);
1208 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1210 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1212 q
= mdoc
->last
->child
->string
;
1213 sz
= strlen(p
) + strlen(q
) + 1;
1214 buf
= mandoc_malloc(sz
);
1215 strlcpy(buf
, p
, sz
);
1216 strlcat(buf
, q
, sz
);
1217 free(mdoc
->last
->child
->string
);
1218 mdoc
->last
->child
->string
= buf
;
1227 struct mdoc_node
*np
;
1230 if (AUTH__NONE
== np
->norm
->An
.auth
) {
1232 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0);
1233 } else if (np
->child
)
1234 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0);
1245 struct mdoc_node
*n
, *c
;
1248 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1251 n
= mdoc
->last
->parent
->parent
;
1252 lt
= n
->norm
->Bl
.type
;
1254 if (LIST__NONE
== lt
) {
1255 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1261 if (mdoc
->last
->head
->child
)
1263 /* FIXME: give this a dummy value. */
1264 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1273 if (NULL
== mdoc
->last
->head
->child
)
1274 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1283 if (NULL
== mdoc
->last
->body
->child
)
1284 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1287 if (mdoc
->last
->head
->child
)
1288 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1291 cols
= (int)n
->norm
->Bl
.ncols
;
1293 assert(NULL
== mdoc
->last
->head
->child
);
1295 if (NULL
== mdoc
->last
->body
->child
)
1296 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1298 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1299 if (MDOC_BODY
== c
->type
)
1303 er
= MANDOCERR_ARGCOUNT
;
1304 else if (i
== cols
|| i
== cols
+ 1)
1307 er
= MANDOCERR_SYNTARGCOUNT
;
1309 rc
= mdoc_vmsg(mdoc
, er
,
1310 mdoc
->last
->line
, mdoc
->last
->pos
,
1311 "columns == %d (have %d)", cols
, i
);
1321 post_bl_block(POST_ARGS
)
1323 struct mdoc_node
*n
;
1326 * These are fairly complicated, so we've broken them into two
1327 * functions. post_bl_block_tag() is called when a -tag is
1328 * specified, but no -width (it must be guessed). The second
1329 * when a -width is specified (macro indicators must be
1330 * rewritten into real lengths).
1335 if (LIST_tag
== n
->norm
->Bl
.type
&&
1336 NULL
== n
->norm
->Bl
.width
) {
1337 if ( ! post_bl_block_tag(mdoc
))
1339 } else if (NULL
!= n
->norm
->Bl
.width
) {
1340 if ( ! post_bl_block_width(mdoc
))
1345 assert(n
->norm
->Bl
.width
);
1350 post_bl_block_width(POST_ARGS
)
1355 struct mdoc_node
*n
;
1361 * Calculate the real width of a list from the -width string,
1362 * which may contain a macro (with a known default width), a
1363 * literal string, or a scaling width.
1365 * If the value to -width is a macro, then we re-write it to be
1366 * the macro's width as set in share/tmac/mdoc/doc-common.
1369 if (0 == strcmp(n
->norm
->Bl
.width
, "Ds"))
1371 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->norm
->Bl
.width
)))
1373 else if (0 == (width
= mdoc_macro2len(tok
))) {
1374 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1378 /* The value already exists: free and reallocate it. */
1382 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1383 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1386 assert(i
< (int)n
->args
->argc
);
1388 snprintf(buf
, NUMSIZ
, "%zun", width
);
1389 free(n
->args
->argv
[i
].value
[0]);
1390 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1392 /* Set our width! */
1393 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1398 post_bl_block_tag(POST_ARGS
)
1400 struct mdoc_node
*n
, *nn
;
1406 * Calculate the -width for a `Bl -tag' list if it hasn't been
1407 * provided. Uses the first head macro. NOTE AGAIN: this is
1408 * ONLY if the -width argument has NOT been provided. See
1409 * post_bl_block_width() for converting the -width string.
1415 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1416 if (MDOC_It
!= nn
->tok
)
1419 assert(MDOC_BLOCK
== nn
->type
);
1420 nn
= nn
->head
->child
;
1425 if (MDOC_TEXT
== nn
->type
) {
1426 sz
= strlen(nn
->string
) + 1;
1430 if (0 != (ssz
= mdoc_macro2len(nn
->tok
)))
1436 /* Defaults to ten ens. */
1438 snprintf(buf
, NUMSIZ
, "%zun", sz
);
1441 * We have to dynamically add this to the macro's argument list.
1442 * We're guaranteed that a MDOC_Width doesn't already exist.
1446 i
= (int)(n
->args
->argc
)++;
1448 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1449 n
->args
->argc
* sizeof(struct mdoc_argv
));
1451 n
->args
->argv
[i
].arg
= MDOC_Width
;
1452 n
->args
->argv
[i
].line
= n
->line
;
1453 n
->args
->argv
[i
].pos
= n
->pos
;
1454 n
->args
->argv
[i
].sz
= 1;
1455 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1456 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1458 /* Set our width! */
1459 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1465 post_bl_head(POST_ARGS
)
1467 struct mdoc_node
*np
, *nn
, *nnp
;
1470 if (LIST_column
!= mdoc
->last
->norm
->Bl
.type
)
1471 /* FIXME: this should be ERROR class... */
1472 return(hwarn_eq0(mdoc
));
1475 * Convert old-style lists, where the column width specifiers
1476 * trail as macro parameters, to the new-style ("normal-form")
1477 * lists where they're argument values following -column.
1480 /* First, disallow both types and allow normal-form. */
1483 * TODO: technically, we can accept both and just merge the two
1484 * lists, but I'll leave that for another day.
1487 if (mdoc
->last
->norm
->Bl
.ncols
&& mdoc
->last
->nchild
) {
1488 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1490 } else if (NULL
== mdoc
->last
->child
)
1493 np
= mdoc
->last
->parent
;
1496 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1497 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1500 assert(j
< (int)np
->args
->argc
);
1501 assert(0 == np
->args
->argv
[j
].sz
);
1504 * Accomodate for new-style groff column syntax. Shuffle the
1505 * child nodes, all of which must be TEXT, as arguments for the
1506 * column field. Then, delete the head children.
1509 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1510 np
->args
->argv
[j
].value
= mandoc_malloc
1511 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1513 mdoc
->last
->norm
->Bl
.ncols
= np
->args
->argv
[j
].sz
;
1514 mdoc
->last
->norm
->Bl
.cols
= (const char **)np
->args
->argv
[j
].value
;
1516 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1517 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1521 mdoc_node_delete(NULL
, nnp
);
1524 mdoc
->last
->nchild
= 0;
1525 mdoc
->last
->child
= NULL
;
1533 struct mdoc_node
*n
;
1535 if (MDOC_HEAD
== mdoc
->last
->type
)
1536 return(post_bl_head(mdoc
));
1537 if (MDOC_BLOCK
== mdoc
->last
->type
)
1538 return(post_bl_block(mdoc
));
1539 if (MDOC_BODY
!= mdoc
->last
->type
)
1542 for (n
= mdoc
->last
->child
; n
; n
= n
->next
) {
1547 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1557 mdoc_nmsg(mdoc
, n
, MANDOCERR_SYNTCHILD
);
1565 ebool(struct mdoc
*mdoc
)
1568 if (NULL
== mdoc
->last
->child
) {
1569 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1570 mdoc_node_delete(mdoc
, mdoc
->last
);
1573 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1575 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1577 if (0 == strcmp(mdoc
->last
->child
->string
, "on"))
1579 if (0 == strcmp(mdoc
->last
->child
->string
, "off"))
1582 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1587 post_root(POST_ARGS
)
1590 struct mdoc_node
*n
;
1594 /* Check that we have a finished prologue. */
1596 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1598 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1604 /* Check that we begin with a proper `Sh'. */
1606 if (NULL
== n
->child
) {
1608 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1609 } else if (MDOC_BLOCK
!= n
->child
->type
||
1610 MDOC_Sh
!= n
->child
->tok
) {
1612 /* Can this be lifted? See rxdebug.1 for example. */
1613 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1616 return(erc
? 0 : 1);
1622 struct mdoc_node
*ch
;
1625 if (NULL
== (ch
= mdoc
->last
->child
)) {
1626 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1627 mdoc_node_delete(mdoc
, mdoc
->last
);
1631 assert(MDOC_TEXT
== ch
->type
);
1633 if (NULL
== (p
= mdoc_a2st(ch
->string
))) {
1634 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1635 mdoc_node_delete(mdoc
, mdoc
->last
);
1638 ch
->string
= mandoc_strdup(p
);
1647 struct mdoc_node
*nn
, *next
, *prev
;
1650 switch (mdoc
->last
->type
) {
1652 check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0);
1655 if (mdoc
->last
->child
)
1657 check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0);
1664 * Make sure only certain types of nodes are allowed within the
1665 * the `Rs' body. Delete offending nodes and raise a warning.
1666 * Do this before re-ordering for the sake of clarity.
1670 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1671 for (i
= 0; i
< RSORD_MAX
; i
++)
1672 if (nn
->tok
== rsord
[i
])
1675 if (i
< RSORD_MAX
) {
1676 if (MDOC__J
== rsord
[i
] || MDOC__B
== rsord
[i
])
1677 mdoc
->last
->norm
->Rs
.quote_T
++;
1683 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1684 mdoc_node_delete(mdoc
, nn
);
1688 * The full `Rs' block needs special handling to order the
1689 * sub-elements according to `rsord'. Pick through each element
1690 * and correctly order it. This is a insertion sort.
1694 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1695 /* Determine order of `nn'. */
1696 for (i
= 0; i
< RSORD_MAX
; i
++)
1697 if (rsord
[i
] == nn
->tok
)
1701 * Remove `nn' from the chain. This somewhat
1702 * repeats mdoc_node_unlink(), but since we're
1703 * just re-ordering, there's no need for the
1704 * full unlink process.
1707 if (NULL
!= (next
= nn
->next
))
1708 next
->prev
= nn
->prev
;
1710 if (NULL
!= (prev
= nn
->prev
))
1711 prev
->next
= nn
->next
;
1713 nn
->prev
= nn
->next
= NULL
;
1716 * Scan back until we reach a node that's
1717 * ordered before `nn'.
1720 for ( ; prev
; prev
= prev
->prev
) {
1721 /* Determine order of `prev'. */
1722 for (j
= 0; j
< RSORD_MAX
; j
++)
1723 if (rsord
[j
] == prev
->tok
)
1731 * Set `nn' back into its correct place in front
1732 * of the `prev' node.
1739 prev
->next
->prev
= nn
;
1740 nn
->next
= prev
->next
;
1743 mdoc
->last
->child
->prev
= nn
;
1744 nn
->next
= mdoc
->last
->child
;
1745 mdoc
->last
->child
= nn
;
1756 if (MDOC_LINE
& mdoc
->last
->flags
)
1757 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNNS
);
1765 if (MDOC_HEAD
== mdoc
->last
->type
)
1766 return(post_sh_head(mdoc
));
1767 if (MDOC_BODY
== mdoc
->last
->type
)
1768 return(post_sh_body(mdoc
));
1774 post_sh_body(POST_ARGS
)
1776 struct mdoc_node
*n
;
1778 if (SEC_NAME
!= mdoc
->lastsec
)
1782 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1783 * macros (can have multiple `Nm' and one `Nd'). Note that the
1784 * children of the BODY declaration can also be "text".
1787 if (NULL
== (n
= mdoc
->last
->child
)) {
1788 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1792 for ( ; n
&& n
->next
; n
= n
->next
) {
1793 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1795 if (MDOC_TEXT
== n
->type
)
1797 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1801 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1804 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1809 post_sh_head(POST_ARGS
)
1815 * Process a new section. Sections are either "named" or
1816 * "custom". Custom sections are user-defined, while named ones
1817 * follow a conventional order and may only appear in certain
1821 if ( ! concat(mdoc
, buf
, mdoc
->last
->child
, BUFSIZ
))
1824 sec
= mdoc_str2sec(buf
);
1826 /* The NAME should be first. */
1828 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1829 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1831 /* The SYNOPSIS gets special attention in other areas. */
1833 if (SEC_SYNOPSIS
== sec
)
1834 mdoc
->flags
|= MDOC_SYNOPSIS
;
1836 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
1838 /* Mark our last section. */
1840 mdoc
->lastsec
= sec
;
1842 /* We don't care about custom sections after this. */
1844 if (SEC_CUSTOM
== sec
)
1848 * Check whether our non-custom section is being repeated or is
1852 if (sec
== mdoc
->lastnamed
)
1853 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
1855 if (sec
< mdoc
->lastnamed
)
1856 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
1858 /* Mark the last named section. */
1860 mdoc
->lastnamed
= sec
;
1862 /* Check particular section/manual conventions. */
1864 assert(mdoc
->meta
.msec
);
1867 case (SEC_RETURN_VALUES
):
1872 if (*mdoc
->meta
.msec
== '2')
1874 if (*mdoc
->meta
.msec
== '3')
1876 if (*mdoc
->meta
.msec
== '9')
1878 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECMSEC
);
1888 post_ignpar(POST_ARGS
)
1890 struct mdoc_node
*np
;
1892 if (MDOC_BODY
!= mdoc
->last
->type
)
1895 if (NULL
!= (np
= mdoc
->last
->child
))
1896 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1897 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1898 mdoc_node_delete(mdoc
, np
);
1901 if (NULL
!= (np
= mdoc
->last
->last
))
1902 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
1903 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
1904 mdoc_node_delete(mdoc
, np
);
1914 if (NULL
== mdoc
->last
)
1916 if (MDOC_ELEM
!= n
->type
&& MDOC_BLOCK
!= n
->type
)
1920 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1921 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1924 if (MDOC_Pp
!= mdoc
->last
->tok
&& MDOC_Lp
!= mdoc
->last
->tok
)
1926 if (MDOC_Bl
== n
->tok
&& n
->norm
->Bl
.comp
)
1928 if (MDOC_Bd
== n
->tok
&& n
->norm
->Bd
.comp
)
1930 if (MDOC_It
== n
->tok
&& n
->parent
->norm
->Bl
.comp
)
1933 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
1934 mdoc_node_delete(mdoc
, mdoc
->last
);
1939 pre_literal(PRE_ARGS
)
1942 if (MDOC_BODY
!= n
->type
)
1946 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1947 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1952 mdoc
->flags
|= MDOC_LITERAL
;
1955 if (DISP_literal
== n
->norm
->Bd
.type
)
1956 mdoc
->flags
|= MDOC_LITERAL
;
1957 if (DISP_unfilled
== n
->norm
->Bd
.type
)
1958 mdoc
->flags
|= MDOC_LITERAL
;
1972 struct mdoc_node
*n
;
1974 if (mdoc
->meta
.date
)
1975 free(mdoc
->meta
.date
);
1978 if (NULL
== n
->child
|| '\0' == n
->child
->string
[0]) {
1979 mdoc
->meta
.date
= mandoc_normdate(NULL
,
1980 mdoc
->msg
, mdoc
->data
, n
->line
, n
->pos
);
1984 if ( ! concat(mdoc
, buf
, n
->child
, DATESIZE
))
1987 mdoc
->meta
.date
= mandoc_normdate(buf
,
1988 mdoc
->msg
, mdoc
->data
, n
->line
, n
->pos
);
1996 struct mdoc_node
*nn
, *n
;
2002 if (mdoc
->meta
.title
)
2003 free(mdoc
->meta
.title
);
2005 free(mdoc
->meta
.vol
);
2006 if (mdoc
->meta
.arch
)
2007 free(mdoc
->meta
.arch
);
2009 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
2011 /* First make all characters uppercase. */
2013 if (NULL
!= (nn
= n
->child
))
2014 for (p
= nn
->string
; *p
; p
++) {
2015 if (toupper((u_char
)*p
) == *p
)
2019 * FIXME: don't be lazy: have this make all
2020 * characters be uppercase and just warn once.
2022 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2027 * --> title = unknown, volume = local, msec = 0, arch = NULL
2030 if (NULL
== (nn
= n
->child
)) {
2031 /* XXX: make these macro values. */
2032 /* FIXME: warn about missing values. */
2033 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2034 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2035 mdoc
->meta
.msec
= mandoc_strdup("1");
2039 /* Handles: `.Dt TITLE'
2040 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2043 mdoc
->meta
.title
= mandoc_strdup
2044 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2046 if (NULL
== (nn
= nn
->next
)) {
2047 /* FIXME: warn about missing msec. */
2048 /* XXX: make this a macro value. */
2049 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2050 mdoc
->meta
.msec
= mandoc_strdup("1");
2054 /* Handles: `.Dt TITLE SEC'
2055 * --> title = TITLE, volume = SEC is msec ?
2056 * format(msec) : SEC,
2057 * msec = SEC is msec ? atoi(msec) : 0,
2061 cp
= mdoc_a2msec(nn
->string
);
2063 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2064 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2066 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2067 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2068 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2071 if (NULL
== (nn
= nn
->next
))
2074 /* Handles: `.Dt TITLE SEC VOL'
2075 * --> title = TITLE, volume = VOL is vol ?
2077 * VOL is arch ? format(arch) :
2081 cp
= mdoc_a2vol(nn
->string
);
2083 free(mdoc
->meta
.vol
);
2084 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2086 /* FIXME: warn about bad arch. */
2087 cp
= mdoc_a2arch(nn
->string
);
2089 free(mdoc
->meta
.vol
);
2090 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2092 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2095 /* Ignore any subsequent parameters... */
2096 /* FIXME: warn about subsequent parameters. */
2102 post_prol(POST_ARGS
)
2105 * Remove prologue macros from the document after they're
2106 * processed. The final document uses mdoc_meta for these
2107 * values and discards the originals.
2110 mdoc_node_delete(mdoc
, mdoc
->last
);
2111 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2112 mdoc
->flags
|= MDOC_PBODY
;
2120 struct mdoc_node
*n
;
2123 * Make `Bx's second argument always start with an uppercase
2124 * letter. Groff checks if it's an "accepted" term, but we just
2125 * uppercase blindly.
2128 n
= mdoc
->last
->child
;
2129 if (n
&& NULL
!= (n
= n
->next
))
2130 *n
->string
= (char)toupper
2131 ((unsigned char)*n
->string
);
2139 struct mdoc_node
*n
;
2142 struct utsname utsname
;
2148 * Set the operating system by way of the `Os' macro. Note that
2149 * if an argument isn't provided and -DOSNAME="\"foo\"" is
2150 * provided during compilation, this value will be used instead
2151 * of filling in "sysname release" from uname().
2155 free(mdoc
->meta
.os
);
2157 if ( ! concat(mdoc
, buf
, n
->child
, BUFSIZ
))
2160 /* XXX: yes, these can all be dynamically-adjusted buffers, but
2161 * it's really not worth the extra hackery.
2164 if ('\0' == buf
[0]) {
2166 if (strlcat(buf
, OSNAME
, BUFSIZ
) >= BUFSIZ
) {
2167 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2171 if (uname(&utsname
)) {
2172 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2173 mdoc
->meta
.os
= mandoc_strdup("UNKNOWN");
2174 return(post_prol(mdoc
));
2177 if (strlcat(buf
, utsname
.sysname
, BUFSIZ
) >= BUFSIZ
) {
2178 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2181 if (strlcat(buf
, " ", BUFSIZ
) >= BUFSIZ
) {
2182 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2185 if (strlcat(buf
, utsname
.release
, BUFSIZ
) >= BUFSIZ
) {
2186 mdoc_nmsg(mdoc
, n
, MANDOCERR_MEM
);
2192 mdoc
->meta
.os
= mandoc_strdup(buf
);
2199 struct mdoc_node
*nn
, *n
;
2204 * Macros accepting `-std' as an argument have the name of the
2205 * current document (`Nm') filled in as the argument if it's not
2212 if (NULL
== mdoc
->meta
.name
)
2216 mdoc
->next
= MDOC_NEXT_CHILD
;
2218 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2226 concat(struct mdoc
*m
, char *p
, const struct mdoc_node
*n
, size_t sz
)
2232 * Concatenate sibling nodes together. All siblings must be of
2233 * type MDOC_TEXT or an assertion is raised. Concatenation is
2234 * separated by a single whitespace. Returns 0 on fatal (string
2238 for ( ; n
; n
= n
->next
) {
2239 assert(MDOC_TEXT
== n
->type
);
2241 if (strlcat(p
, n
->string
, sz
) >= sz
) {
2242 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);
2246 if (NULL
== n
->next
)
2249 if (strlcat(p
, " ", sz
) >= sz
) {
2250 mdoc_nmsg(m
, n
, MANDOCERR_MEM
);