]>
git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.207 2014/03/30 23:28:06 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
5 * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
24 #include <sys/utsname.h>
27 #include <sys/types.h>
39 #include "mandoc_aux.h"
41 #include "libmandoc.h"
43 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
45 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
46 #define POST_ARGS struct mdoc *mdoc
61 typedef int (*v_pre
)(PRE_ARGS
);
62 typedef int (*v_post
)(POST_ARGS
);
69 static int check_count(struct mdoc
*, enum mdoc_type
,
70 enum check_lvl
, enum check_ineq
, int);
71 static int check_parent(PRE_ARGS
, enum mdoct
, enum mdoc_type
);
72 static void check_text(struct mdoc
*, int, int, char *);
73 static void check_argv(struct mdoc
*,
74 struct mdoc_node
*, struct mdoc_argv
*);
75 static void check_args(struct mdoc
*, struct mdoc_node
*);
76 static enum mdoc_sec
a2sec(const char *);
77 static size_t macro2len(enum mdoct
);
79 static int ebool(POST_ARGS
);
80 static int berr_ge1(POST_ARGS
);
81 static int bwarn_ge1(POST_ARGS
);
82 static int ewarn_eq0(POST_ARGS
);
83 static int ewarn_eq1(POST_ARGS
);
84 static int ewarn_ge1(POST_ARGS
);
85 static int ewarn_le1(POST_ARGS
);
86 static int hwarn_eq0(POST_ARGS
);
87 static int hwarn_eq1(POST_ARGS
);
88 static int hwarn_ge1(POST_ARGS
);
89 static int hwarn_le1(POST_ARGS
);
91 static int post_an(POST_ARGS
);
92 static int post_at(POST_ARGS
);
93 static int post_bf(POST_ARGS
);
94 static int post_bl(POST_ARGS
);
95 static int post_bl_block(POST_ARGS
);
96 static int post_bl_block_width(POST_ARGS
);
97 static int post_bl_block_tag(POST_ARGS
);
98 static int post_bl_head(POST_ARGS
);
99 static int post_bx(POST_ARGS
);
100 static int post_defaults(POST_ARGS
);
101 static int post_dd(POST_ARGS
);
102 static int post_dt(POST_ARGS
);
103 static int post_eoln(POST_ARGS
);
104 static int post_hyph(POST_ARGS
);
105 static int post_ignpar(POST_ARGS
);
106 static int post_it(POST_ARGS
);
107 static int post_lb(POST_ARGS
);
108 static int post_literal(POST_ARGS
);
109 static int post_nm(POST_ARGS
);
110 static int post_ns(POST_ARGS
);
111 static int post_os(POST_ARGS
);
112 static int post_par(POST_ARGS
);
113 static int post_prol(POST_ARGS
);
114 static int post_root(POST_ARGS
);
115 static int post_rs(POST_ARGS
);
116 static int post_sh(POST_ARGS
);
117 static int post_sh_body(POST_ARGS
);
118 static int post_sh_head(POST_ARGS
);
119 static int post_st(POST_ARGS
);
120 static int post_std(POST_ARGS
);
121 static int post_vt(POST_ARGS
);
122 static int pre_an(PRE_ARGS
);
123 static int pre_bd(PRE_ARGS
);
124 static int pre_bl(PRE_ARGS
);
125 static int pre_dd(PRE_ARGS
);
126 static int pre_display(PRE_ARGS
);
127 static int pre_dt(PRE_ARGS
);
128 static int pre_it(PRE_ARGS
);
129 static int pre_literal(PRE_ARGS
);
130 static int pre_os(PRE_ARGS
);
131 static int pre_par(PRE_ARGS
);
132 static int pre_sh(PRE_ARGS
);
133 static int pre_ss(PRE_ARGS
);
134 static int pre_std(PRE_ARGS
);
136 static v_post posts_an
[] = { post_an
, NULL
};
137 static v_post posts_at
[] = { post_at
, post_defaults
, NULL
};
138 static v_post posts_bd
[] = { post_literal
, hwarn_eq0
, bwarn_ge1
, NULL
};
139 static v_post posts_bf
[] = { hwarn_le1
, post_bf
, NULL
};
140 static v_post posts_bk
[] = { hwarn_eq0
, bwarn_ge1
, NULL
};
141 static v_post posts_bl
[] = { bwarn_ge1
, post_bl
, NULL
};
142 static v_post posts_bx
[] = { post_bx
, NULL
};
143 static v_post posts_bool
[] = { ebool
, NULL
};
144 static v_post posts_eoln
[] = { post_eoln
, NULL
};
145 static v_post posts_defaults
[] = { post_defaults
, NULL
};
146 static v_post posts_d1
[] = { bwarn_ge1
, post_hyph
, NULL
};
147 static v_post posts_dd
[] = { post_dd
, post_prol
, NULL
};
148 static v_post posts_dl
[] = { post_literal
, bwarn_ge1
, NULL
};
149 static v_post posts_dt
[] = { post_dt
, post_prol
, NULL
};
150 static v_post posts_fo
[] = { hwarn_eq1
, bwarn_ge1
, NULL
};
151 static v_post posts_hyph
[] = { post_hyph
, NULL
};
152 static v_post posts_hyphtext
[] = { ewarn_ge1
, post_hyph
, NULL
};
153 static v_post posts_it
[] = { post_it
, NULL
};
154 static v_post posts_lb
[] = { post_lb
, NULL
};
155 static v_post posts_nd
[] = { berr_ge1
, post_hyph
, NULL
};
156 static v_post posts_nm
[] = { post_nm
, NULL
};
157 static v_post posts_notext
[] = { ewarn_eq0
, NULL
};
158 static v_post posts_ns
[] = { post_ns
, NULL
};
159 static v_post posts_os
[] = { post_os
, post_prol
, NULL
};
160 static v_post posts_pp
[] = { post_par
, ewarn_eq0
, NULL
};
161 static v_post posts_rs
[] = { post_rs
, NULL
};
162 static v_post posts_sh
[] = { post_ignpar
,hwarn_ge1
,post_sh
,post_hyph
,NULL
};
163 static v_post posts_sp
[] = { post_par
, ewarn_le1
, NULL
};
164 static v_post posts_ss
[] = { post_ignpar
, hwarn_ge1
, post_hyph
, NULL
};
165 static v_post posts_st
[] = { post_st
, NULL
};
166 static v_post posts_std
[] = { post_std
, NULL
};
167 static v_post posts_text
[] = { ewarn_ge1
, NULL
};
168 static v_post posts_text1
[] = { ewarn_eq1
, NULL
};
169 static v_post posts_vt
[] = { post_vt
, NULL
};
170 static v_pre pres_an
[] = { pre_an
, NULL
};
171 static v_pre pres_bd
[] = { pre_display
, pre_bd
, pre_literal
, pre_par
, NULL
};
172 static v_pre pres_bl
[] = { pre_bl
, pre_par
, NULL
};
173 static v_pre pres_d1
[] = { pre_display
, NULL
};
174 static v_pre pres_dl
[] = { pre_literal
, pre_display
, NULL
};
175 static v_pre pres_dd
[] = { pre_dd
, NULL
};
176 static v_pre pres_dt
[] = { pre_dt
, NULL
};
177 static v_pre pres_it
[] = { pre_it
, pre_par
, NULL
};
178 static v_pre pres_os
[] = { pre_os
, NULL
};
179 static v_pre pres_pp
[] = { pre_par
, NULL
};
180 static v_pre pres_sh
[] = { pre_sh
, NULL
};
181 static v_pre pres_ss
[] = { pre_ss
, NULL
};
182 static v_pre pres_std
[] = { pre_std
, NULL
};
184 static const struct valids mdoc_valids
[MDOC_MAX
] = {
185 { NULL
, NULL
}, /* Ap */
186 { pres_dd
, posts_dd
}, /* Dd */
187 { pres_dt
, posts_dt
}, /* Dt */
188 { pres_os
, posts_os
}, /* Os */
189 { pres_sh
, posts_sh
}, /* Sh */
190 { pres_ss
, posts_ss
}, /* Ss */
191 { pres_pp
, posts_pp
}, /* Pp */
192 { pres_d1
, posts_d1
}, /* D1 */
193 { pres_dl
, posts_dl
}, /* Dl */
194 { pres_bd
, posts_bd
}, /* Bd */
195 { NULL
, NULL
}, /* Ed */
196 { pres_bl
, posts_bl
}, /* Bl */
197 { NULL
, NULL
}, /* El */
198 { pres_it
, posts_it
}, /* It */
199 { NULL
, NULL
}, /* Ad */
200 { pres_an
, posts_an
}, /* An */
201 { NULL
, posts_defaults
}, /* Ar */
202 { NULL
, NULL
}, /* Cd */
203 { NULL
, NULL
}, /* Cm */
204 { NULL
, NULL
}, /* Dv */
205 { NULL
, NULL
}, /* Er */
206 { NULL
, NULL
}, /* Ev */
207 { pres_std
, posts_std
}, /* Ex */
208 { NULL
, NULL
}, /* Fa */
209 { NULL
, posts_text
}, /* Fd */
210 { NULL
, NULL
}, /* Fl */
211 { NULL
, NULL
}, /* Fn */
212 { NULL
, NULL
}, /* Ft */
213 { NULL
, NULL
}, /* Ic */
214 { NULL
, posts_text1
}, /* In */
215 { NULL
, posts_defaults
}, /* Li */
216 { NULL
, posts_nd
}, /* Nd */
217 { NULL
, posts_nm
}, /* Nm */
218 { NULL
, NULL
}, /* Op */
219 { NULL
, NULL
}, /* Ot */
220 { NULL
, posts_defaults
}, /* Pa */
221 { pres_std
, posts_std
}, /* Rv */
222 { NULL
, posts_st
}, /* St */
223 { NULL
, NULL
}, /* Va */
224 { NULL
, posts_vt
}, /* Vt */
225 { NULL
, posts_text
}, /* Xr */
226 { NULL
, posts_text
}, /* %A */
227 { NULL
, posts_hyphtext
}, /* %B */ /* FIXME: can be used outside Rs/Re. */
228 { NULL
, posts_text
}, /* %D */
229 { NULL
, posts_text
}, /* %I */
230 { NULL
, posts_text
}, /* %J */
231 { NULL
, posts_hyphtext
}, /* %N */
232 { NULL
, posts_hyphtext
}, /* %O */
233 { NULL
, posts_text
}, /* %P */
234 { NULL
, posts_hyphtext
}, /* %R */
235 { NULL
, posts_hyphtext
}, /* %T */ /* FIXME: can be used outside Rs/Re. */
236 { NULL
, posts_text
}, /* %V */
237 { NULL
, NULL
}, /* Ac */
238 { NULL
, NULL
}, /* Ao */
239 { NULL
, NULL
}, /* Aq */
240 { NULL
, posts_at
}, /* At */
241 { NULL
, NULL
}, /* Bc */
242 { NULL
, posts_bf
}, /* Bf */
243 { NULL
, NULL
}, /* Bo */
244 { NULL
, NULL
}, /* Bq */
245 { NULL
, NULL
}, /* Bsx */
246 { NULL
, posts_bx
}, /* Bx */
247 { NULL
, posts_bool
}, /* Db */
248 { NULL
, NULL
}, /* Dc */
249 { NULL
, NULL
}, /* Do */
250 { NULL
, NULL
}, /* Dq */
251 { NULL
, NULL
}, /* Ec */
252 { NULL
, NULL
}, /* Ef */
253 { NULL
, NULL
}, /* Em */
254 { NULL
, NULL
}, /* Eo */
255 { NULL
, NULL
}, /* Fx */
256 { NULL
, NULL
}, /* Ms */
257 { NULL
, posts_notext
}, /* No */
258 { NULL
, posts_ns
}, /* Ns */
259 { NULL
, NULL
}, /* Nx */
260 { NULL
, NULL
}, /* Ox */
261 { NULL
, NULL
}, /* Pc */
262 { NULL
, posts_text1
}, /* Pf */
263 { NULL
, NULL
}, /* Po */
264 { NULL
, NULL
}, /* Pq */
265 { NULL
, NULL
}, /* Qc */
266 { NULL
, NULL
}, /* Ql */
267 { NULL
, NULL
}, /* Qo */
268 { NULL
, NULL
}, /* Qq */
269 { NULL
, NULL
}, /* Re */
270 { NULL
, posts_rs
}, /* Rs */
271 { NULL
, NULL
}, /* Sc */
272 { NULL
, NULL
}, /* So */
273 { NULL
, NULL
}, /* Sq */
274 { NULL
, posts_bool
}, /* Sm */
275 { NULL
, posts_hyph
}, /* Sx */
276 { NULL
, NULL
}, /* Sy */
277 { NULL
, NULL
}, /* Tn */
278 { NULL
, NULL
}, /* Ux */
279 { NULL
, NULL
}, /* Xc */
280 { NULL
, NULL
}, /* Xo */
281 { NULL
, posts_fo
}, /* Fo */
282 { NULL
, NULL
}, /* Fc */
283 { NULL
, NULL
}, /* Oo */
284 { NULL
, NULL
}, /* Oc */
285 { NULL
, posts_bk
}, /* Bk */
286 { NULL
, NULL
}, /* Ek */
287 { NULL
, posts_eoln
}, /* Bt */
288 { NULL
, NULL
}, /* Hf */
289 { NULL
, NULL
}, /* Fr */
290 { NULL
, posts_eoln
}, /* Ud */
291 { NULL
, posts_lb
}, /* Lb */
292 { pres_pp
, posts_pp
}, /* Lp */
293 { NULL
, NULL
}, /* Lk */
294 { NULL
, posts_defaults
}, /* Mt */
295 { NULL
, NULL
}, /* Brq */
296 { NULL
, NULL
}, /* Bro */
297 { NULL
, NULL
}, /* Brc */
298 { NULL
, posts_text
}, /* %C */
299 { NULL
, NULL
}, /* Es */
300 { NULL
, NULL
}, /* En */
301 { NULL
, NULL
}, /* Dx */
302 { NULL
, posts_text
}, /* %Q */
303 { NULL
, posts_pp
}, /* br */
304 { NULL
, posts_sp
}, /* sp */
305 { NULL
, posts_text1
}, /* %U */
306 { NULL
, NULL
}, /* Ta */
307 { NULL
, NULL
}, /* ll */
310 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
312 static const enum mdoct rsord
[RSORD_MAX
] = {
329 static const char * const secnames
[SEC__MAX
] = {
335 "IMPLEMENTATION NOTES",
350 "SECURITY CONSIDERATIONS",
355 mdoc_valid_pre(struct mdoc
*mdoc
, struct mdoc_node
*n
)
366 check_text(mdoc
, line
, pos
, tp
);
380 if (NULL
== mdoc_valids
[n
->tok
].pre
)
382 for (p
= mdoc_valids
[n
->tok
].pre
; *p
; p
++)
383 if ( ! (*p
)(mdoc
, n
))
390 mdoc_valid_post(struct mdoc
*mdoc
)
394 if (MDOC_VALID
& mdoc
->last
->flags
)
396 mdoc
->last
->flags
|= MDOC_VALID
;
398 switch (mdoc
->last
->type
) {
406 return(post_root(mdoc
));
411 if (NULL
== mdoc_valids
[mdoc
->last
->tok
].post
)
413 for (p
= mdoc_valids
[mdoc
->last
->tok
].post
; *p
; p
++)
421 check_count(struct mdoc
*mdoc
, enum mdoc_type type
,
422 enum check_lvl lvl
, enum check_ineq ineq
, int val
)
427 if (mdoc
->last
->type
!= type
)
433 if (mdoc
->last
->nchild
< val
)
438 if (mdoc
->last
->nchild
> val
)
443 if (val
== mdoc
->last
->nchild
)
451 t
= lvl
== CHECK_WARN
? MANDOCERR_ARGCWARN
: MANDOCERR_ARGCOUNT
;
452 mandoc_vmsg(t
, mdoc
->parse
, mdoc
->last
->line
, mdoc
->last
->pos
,
453 "want %s%d children (have %d)",
454 p
, val
, mdoc
->last
->nchild
);
462 return(check_count(mdoc
, MDOC_BODY
, CHECK_ERROR
, CHECK_GT
, 0));
468 return(check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0));
474 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0));
480 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1));
486 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0));
492 return(check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_LT
, 2));
498 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0));
504 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 1));
510 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_GT
, 0));
516 return(check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_LT
, 2));
520 check_args(struct mdoc
*mdoc
, struct mdoc_node
*n
)
527 assert(n
->args
->argc
);
528 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
529 check_argv(mdoc
, n
, &n
->args
->argv
[i
]);
533 check_argv(struct mdoc
*mdoc
, struct mdoc_node
*n
, struct mdoc_argv
*v
)
537 for (i
= 0; i
< (int)v
->sz
; i
++)
538 check_text(mdoc
, v
->line
, v
->pos
, v
->value
[i
]);
540 /* FIXME: move to post_std(). */
542 if (MDOC_Std
== v
->arg
)
543 if ( ! (v
->sz
|| mdoc
->meta
.name
))
544 mdoc_nmsg(mdoc
, n
, MANDOCERR_NONAME
);
548 check_text(struct mdoc
*mdoc
, int ln
, int pos
, char *p
)
552 if (MDOC_LITERAL
& mdoc
->flags
)
555 for (cp
= p
; NULL
!= (p
= strchr(p
, '\t')); p
++)
556 mdoc_pmsg(mdoc
, ln
, pos
+ (int)(p
- cp
), MANDOCERR_BADTAB
);
560 check_parent(PRE_ARGS
, enum mdoct tok
, enum mdoc_type t
)
564 if ((MDOC_ROOT
== t
|| tok
== n
->parent
->tok
) &&
565 (t
== n
->parent
->type
))
568 mandoc_vmsg(MANDOCERR_SYNTCHILD
, mdoc
->parse
, n
->line
,
569 n
->pos
, "want parent %s", MDOC_ROOT
== t
?
570 "<root>" : mdoc_macronames
[tok
]);
576 pre_display(PRE_ARGS
)
578 struct mdoc_node
*node
;
580 if (MDOC_BLOCK
!= n
->type
)
583 for (node
= mdoc
->last
->parent
; node
; node
= node
->parent
)
584 if (MDOC_BLOCK
== node
->type
)
585 if (MDOC_Bd
== node
->tok
)
589 mdoc_nmsg(mdoc
, n
, MANDOCERR_NESTEDDISP
);
599 const char *offs
, *width
;
601 struct mdoc_node
*np
;
603 if (MDOC_BLOCK
!= n
->type
) {
604 if (ENDBODY_NOT
!= n
->end
) {
606 np
= n
->pending
->parent
;
611 assert(MDOC_BLOCK
== np
->type
);
612 assert(MDOC_Bl
== np
->tok
);
617 * First figure out which kind of list to use: bind ourselves to
618 * the first mentioned list type and warn about any remaining
619 * ones. If we find no list type, we default to LIST_item.
623 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
627 switch (n
->args
->argv
[i
].arg
) {
628 /* Set list types. */
662 /* Set list arguments. */
664 dup
= n
->norm
->Bl
.comp
;
668 /* NB: this can be empty! */
669 if (n
->args
->argv
[i
].sz
) {
670 width
= n
->args
->argv
[i
].value
[0];
671 dup
= (NULL
!= n
->norm
->Bl
.width
);
674 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
677 /* NB: this can be empty! */
678 if (n
->args
->argv
[i
].sz
) {
679 offs
= n
->args
->argv
[i
].value
[0];
680 dup
= (NULL
!= n
->norm
->Bl
.offs
);
683 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
689 /* Check: duplicate auxiliary arguments. */
692 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
695 n
->norm
->Bl
.comp
= comp
;
697 n
->norm
->Bl
.offs
= offs
;
699 n
->norm
->Bl
.width
= width
;
701 /* Check: multiple list types. */
703 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
!= LIST__NONE
)
704 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTREP
);
706 /* Assign list type. */
708 if (LIST__NONE
!= lt
&& n
->norm
->Bl
.type
== LIST__NONE
) {
709 n
->norm
->Bl
.type
= lt
;
710 /* Set column information, too. */
711 if (LIST_column
== lt
) {
714 n
->norm
->Bl
.cols
= (void *)
715 n
->args
->argv
[i
].value
;
719 /* The list type should come first. */
721 if (n
->norm
->Bl
.type
== LIST__NONE
)
722 if (n
->norm
->Bl
.width
||
725 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTFIRST
);
730 /* Allow lists to default to LIST_item. */
732 if (LIST__NONE
== n
->norm
->Bl
.type
) {
733 mdoc_nmsg(mdoc
, n
, MANDOCERR_LISTTYPE
);
734 n
->norm
->Bl
.type
= LIST_item
;
738 * Validate the width field. Some list types don't need width
739 * types and should be warned about them. Others should have it
740 * and must also be warned. Yet others have a default and need
744 switch (n
->norm
->Bl
.type
) {
746 if (NULL
== n
->norm
->Bl
.width
)
747 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOWIDTHARG
);
758 if (n
->norm
->Bl
.width
)
759 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
766 if (NULL
== n
->norm
->Bl
.width
)
767 n
->norm
->Bl
.width
= "2n";
770 if (NULL
== n
->norm
->Bl
.width
)
771 n
->norm
->Bl
.width
= "3n";
787 struct mdoc_node
*np
;
789 if (MDOC_BLOCK
!= n
->type
) {
790 if (ENDBODY_NOT
!= n
->end
) {
792 np
= n
->pending
->parent
;
797 assert(MDOC_BLOCK
== np
->type
);
798 assert(MDOC_Bd
== np
->tok
);
803 for (i
= 0; n
->args
&& i
< (int)n
->args
->argc
; i
++) {
808 switch (n
->args
->argv
[i
].arg
) {
815 case (MDOC_Unfilled
):
825 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADDISP
);
828 /* NB: this can be empty! */
829 if (n
->args
->argv
[i
].sz
) {
830 offs
= n
->args
->argv
[i
].value
[0];
831 dup
= (NULL
!= n
->norm
->Bd
.offs
);
834 mdoc_nmsg(mdoc
, n
, MANDOCERR_IGNARGV
);
838 dup
= n
->norm
->Bd
.comp
;
845 /* Check whether we have duplicates. */
848 mdoc_nmsg(mdoc
, n
, MANDOCERR_ARGVREP
);
850 /* Make our auxiliary assignments. */
853 n
->norm
->Bd
.offs
= offs
;
855 n
->norm
->Bd
.comp
= comp
;
857 /* Check whether a type has already been assigned. */
859 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
!= DISP__NONE
)
860 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPREP
);
862 /* Make our type assignment. */
864 if (DISP__NONE
!= dt
&& n
->norm
->Bd
.type
== DISP__NONE
)
865 n
->norm
->Bd
.type
= dt
;
868 if (DISP__NONE
== n
->norm
->Bd
.type
) {
869 mdoc_nmsg(mdoc
, n
, MANDOCERR_DISPTYPE
);
870 n
->norm
->Bd
.type
= DISP_ragged
;
881 if (MDOC_BLOCK
!= n
->type
)
883 return(check_parent(mdoc
, n
, MDOC_Sh
, MDOC_BODY
));
891 if (MDOC_BLOCK
!= n
->type
)
893 return(check_parent(mdoc
, n
, MDOC_MAX
, MDOC_ROOT
));
901 if (MDOC_BLOCK
!= n
->type
)
904 return(check_parent(mdoc
, n
, MDOC_Bl
, MDOC_BODY
));
916 for (i
= 1; i
< (int)n
->args
->argc
; i
++)
917 mdoc_pmsg(mdoc
, n
->args
->argv
[i
].line
,
918 n
->args
->argv
[i
].pos
, MANDOCERR_IGNARGV
);
920 if (MDOC_Split
== n
->args
->argv
[0].arg
)
921 n
->norm
->An
.auth
= AUTH_split
;
922 else if (MDOC_Nosplit
== n
->args
->argv
[0].arg
)
923 n
->norm
->An
.auth
= AUTH_nosplit
;
934 if (n
->args
&& 1 == n
->args
->argc
)
935 if (MDOC_Std
== n
->args
->argv
[0].arg
)
938 mdoc_nmsg(mdoc
, n
, MANDOCERR_NOARGV
);
946 if (NULL
== mdoc
->meta
.date
|| mdoc
->meta
.os
)
947 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
949 if (mdoc
->meta
.title
)
950 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
959 if (NULL
== mdoc
->meta
.title
|| NULL
== mdoc
->meta
.date
)
960 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
963 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
972 if (mdoc
->meta
.title
|| mdoc
->meta
.os
)
973 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGOOO
);
976 mdoc_nmsg(mdoc
, n
, MANDOCERR_PROLOGREP
);
985 struct mdoc_node
*np
;
989 * Unlike other data pointers, these are "housed" by the HEAD
990 * element, which contains the goods.
993 if (MDOC_HEAD
!= mdoc
->last
->type
) {
994 if (ENDBODY_NOT
!= mdoc
->last
->end
) {
995 assert(mdoc
->last
->pending
);
996 np
= mdoc
->last
->pending
->parent
->head
;
997 } else if (MDOC_BLOCK
!= mdoc
->last
->type
) {
998 np
= mdoc
->last
->parent
->head
;
1000 np
= mdoc
->last
->head
;
1003 assert(MDOC_HEAD
== np
->type
);
1004 assert(MDOC_Bf
== np
->tok
);
1009 assert(MDOC_BLOCK
== np
->parent
->type
);
1010 assert(MDOC_Bf
== np
->parent
->tok
);
1013 * Cannot have both argument and parameter.
1014 * If neither is specified, let it through with a warning.
1017 if (np
->parent
->args
&& np
->child
) {
1018 mdoc_nmsg(mdoc
, np
, MANDOCERR_SYNTARGVCOUNT
);
1020 } else if (NULL
== np
->parent
->args
&& NULL
== np
->child
) {
1021 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1025 /* Extract argument into data. */
1027 if (np
->parent
->args
) {
1028 arg
= np
->parent
->args
->argv
[0].arg
;
1029 if (MDOC_Emphasis
== arg
)
1030 np
->norm
->Bf
.font
= FONT_Em
;
1031 else if (MDOC_Literal
== arg
)
1032 np
->norm
->Bf
.font
= FONT_Li
;
1033 else if (MDOC_Symbolic
== arg
)
1034 np
->norm
->Bf
.font
= FONT_Sy
;
1040 /* Extract parameter into data. */
1042 if (0 == strcmp(np
->child
->string
, "Em"))
1043 np
->norm
->Bf
.font
= FONT_Em
;
1044 else if (0 == strcmp(np
->child
->string
, "Li"))
1045 np
->norm
->Bf
.font
= FONT_Li
;
1046 else if (0 == strcmp(np
->child
->string
, "Sy"))
1047 np
->norm
->Bf
.font
= FONT_Sy
;
1049 mdoc_nmsg(mdoc
, np
, MANDOCERR_FONTTYPE
);
1061 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1063 assert(mdoc
->last
->child
);
1064 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1066 p
= mdoc_a2lib(mdoc
->last
->child
->string
);
1068 /* If lookup ok, replace with table value. */
1071 free(mdoc
->last
->child
->string
);
1072 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1076 /* If not, use "library ``xxxx''. */
1078 sz
= strlen(mdoc
->last
->child
->string
) +
1079 2 + strlen("\\(lqlibrary\\(rq");
1080 buf
= mandoc_malloc(sz
);
1081 snprintf(buf
, sz
, "library \\(lq%s\\(rq",
1082 mdoc
->last
->child
->string
);
1083 free(mdoc
->last
->child
->string
);
1084 mdoc
->last
->child
->string
= buf
;
1089 post_eoln(POST_ARGS
)
1092 if (mdoc
->last
->child
)
1093 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1101 const struct mdoc_node
*n
;
1104 * The Vt macro comes in both ELEM and BLOCK form, both of which
1105 * have different syntaxes (yet more context-sensitive
1106 * behaviour). ELEM types must have a child, which is already
1107 * guaranteed by the in_line parsing routine; BLOCK types,
1108 * specifically the BODY, should only have TEXT children.
1111 if (MDOC_BODY
!= mdoc
->last
->type
)
1114 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
1115 if (MDOC_TEXT
!= n
->type
)
1116 mdoc_nmsg(mdoc
, n
, MANDOCERR_CHILD
);
1126 if (NULL
!= mdoc
->meta
.name
)
1129 mdoc_deroff(&mdoc
->meta
.name
, mdoc
->last
);
1131 if (NULL
== mdoc
->meta
.name
) {
1132 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NONAME
);
1133 mdoc
->meta
.name
= mandoc_strdup("UNKNOWN");
1139 post_literal(POST_ARGS
)
1143 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1144 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1145 * this in literal mode, but it doesn't hurt to just switch it
1146 * off in general since displays can't be nested.
1149 if (MDOC_BODY
== mdoc
->last
->type
)
1150 mdoc
->flags
&= ~MDOC_LITERAL
;
1156 post_defaults(POST_ARGS
)
1158 struct mdoc_node
*nn
;
1161 * The `Ar' defaults to "file ..." if no value is provided as an
1162 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1163 * gets an empty string.
1166 if (mdoc
->last
->child
)
1170 mdoc
->next
= MDOC_NEXT_CHILD
;
1174 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "file"))
1176 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "..."))
1180 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "AT&T"))
1182 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "UNIX"))
1186 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, ""))
1192 if ( ! mdoc_word_alloc(mdoc
, nn
->line
, nn
->pos
, "~"))
1212 * If we have a child, look it up in the standard keys. If a
1213 * key exist, use that instead of the child; if it doesn't,
1214 * prefix "AT&T UNIX " to the existing data.
1217 if (NULL
== mdoc
->last
->child
)
1220 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1221 p
= mdoc_a2att(mdoc
->last
->child
->string
);
1224 free(mdoc
->last
->child
->string
);
1225 mdoc
->last
->child
->string
= mandoc_strdup(p
);
1227 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADATT
);
1229 q
= mdoc
->last
->child
->string
;
1230 sz
= strlen(p
) + strlen(q
) + 1;
1231 buf
= mandoc_malloc(sz
);
1232 strlcpy(buf
, p
, sz
);
1233 strlcat(buf
, q
, sz
);
1234 free(mdoc
->last
->child
->string
);
1235 mdoc
->last
->child
->string
= buf
;
1244 struct mdoc_node
*np
;
1247 if (AUTH__NONE
== np
->norm
->An
.auth
) {
1249 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_GT
, 0);
1250 } else if (np
->child
)
1251 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 0);
1262 struct mdoc_node
*n
, *c
;
1265 if (MDOC_BLOCK
!= mdoc
->last
->type
)
1268 n
= mdoc
->last
->parent
->parent
;
1269 lt
= n
->norm
->Bl
.type
;
1271 if (LIST__NONE
== lt
) {
1272 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_LISTTYPE
);
1278 if (mdoc
->last
->head
->child
)
1280 /* FIXME: give this a dummy value. */
1281 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1290 if (NULL
== mdoc
->last
->head
->child
)
1291 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOARGS
);
1300 if (NULL
== mdoc
->last
->body
->child
)
1301 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1304 if (mdoc
->last
->head
->child
)
1305 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_ARGSLOST
);
1308 cols
= (int)n
->norm
->Bl
.ncols
;
1310 assert(NULL
== mdoc
->last
->head
->child
);
1312 if (NULL
== mdoc
->last
->body
->child
)
1313 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NOBODY
);
1315 for (i
= 0, c
= mdoc
->last
->child
; c
; c
= c
->next
)
1316 if (MDOC_BODY
== c
->type
)
1320 er
= MANDOCERR_ARGCOUNT
;
1321 else if (i
== cols
|| i
== cols
+ 1)
1324 er
= MANDOCERR_SYNTARGCOUNT
;
1326 mandoc_vmsg(er
, mdoc
->parse
, mdoc
->last
->line
,
1328 "columns == %d (have %d)", cols
, i
);
1329 return(MANDOCERR_ARGCOUNT
== er
);
1338 post_bl_block(POST_ARGS
)
1340 struct mdoc_node
*n
, *ni
, *nc
;
1343 * These are fairly complicated, so we've broken them into two
1344 * functions. post_bl_block_tag() is called when a -tag is
1345 * specified, but no -width (it must be guessed). The second
1346 * when a -width is specified (macro indicators must be
1347 * rewritten into real lengths).
1352 if (LIST_tag
== n
->norm
->Bl
.type
&&
1353 NULL
== n
->norm
->Bl
.width
) {
1354 if ( ! post_bl_block_tag(mdoc
))
1356 assert(n
->norm
->Bl
.width
);
1357 } else if (NULL
!= n
->norm
->Bl
.width
) {
1358 if ( ! post_bl_block_width(mdoc
))
1360 assert(n
->norm
->Bl
.width
);
1363 for (ni
= n
->body
->child
; ni
; ni
= ni
->next
) {
1364 if (NULL
== ni
->body
)
1366 nc
= ni
->body
->last
;
1367 while (NULL
!= nc
) {
1379 if (NULL
== ni
->next
) {
1380 mdoc_nmsg(mdoc
, nc
, MANDOCERR_MOVEPAR
);
1381 if ( ! mdoc_node_relink(mdoc
, nc
))
1383 } else if (0 == n
->norm
->Bl
.comp
&&
1384 LIST_column
!= n
->norm
->Bl
.type
) {
1385 mdoc_nmsg(mdoc
, nc
, MANDOCERR_IGNPAR
);
1386 mdoc_node_delete(mdoc
, nc
);
1389 nc
= ni
->body
->last
;
1396 post_bl_block_width(POST_ARGS
)
1401 struct mdoc_node
*n
;
1407 * Calculate the real width of a list from the -width string,
1408 * which may contain a macro (with a known default width), a
1409 * literal string, or a scaling width.
1411 * If the value to -width is a macro, then we re-write it to be
1412 * the macro's width as set in share/tmac/mdoc/doc-common.
1415 if (0 == strcmp(n
->norm
->Bl
.width
, "Ds"))
1417 else if (MDOC_MAX
== (tok
= mdoc_hash_find(n
->norm
->Bl
.width
)))
1419 else if (0 == (width
= macro2len(tok
))) {
1420 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADWIDTH
);
1424 /* The value already exists: free and reallocate it. */
1428 for (i
= 0; i
< (int)n
->args
->argc
; i
++)
1429 if (MDOC_Width
== n
->args
->argv
[i
].arg
)
1432 assert(i
< (int)n
->args
->argc
);
1434 snprintf(buf
, NUMSIZ
, "%un", (unsigned int)width
);
1435 free(n
->args
->argv
[i
].value
[0]);
1436 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1438 /* Set our width! */
1439 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1444 post_bl_block_tag(POST_ARGS
)
1446 struct mdoc_node
*n
, *nn
;
1452 * Calculate the -width for a `Bl -tag' list if it hasn't been
1453 * provided. Uses the first head macro. NOTE AGAIN: this is
1454 * ONLY if the -width argument has NOT been provided. See
1455 * post_bl_block_width() for converting the -width string.
1461 for (nn
= n
->body
->child
; nn
; nn
= nn
->next
) {
1462 if (MDOC_It
!= nn
->tok
)
1465 assert(MDOC_BLOCK
== nn
->type
);
1466 nn
= nn
->head
->child
;
1471 if (MDOC_TEXT
== nn
->type
) {
1472 sz
= strlen(nn
->string
) + 1;
1476 if (0 != (ssz
= macro2len(nn
->tok
)))
1482 /* Defaults to ten ens. */
1484 snprintf(buf
, NUMSIZ
, "%un", (unsigned int)sz
);
1487 * We have to dynamically add this to the macro's argument list.
1488 * We're guaranteed that a MDOC_Width doesn't already exist.
1492 i
= (int)(n
->args
->argc
)++;
1494 n
->args
->argv
= mandoc_realloc(n
->args
->argv
,
1495 n
->args
->argc
* sizeof(struct mdoc_argv
));
1497 n
->args
->argv
[i
].arg
= MDOC_Width
;
1498 n
->args
->argv
[i
].line
= n
->line
;
1499 n
->args
->argv
[i
].pos
= n
->pos
;
1500 n
->args
->argv
[i
].sz
= 1;
1501 n
->args
->argv
[i
].value
= mandoc_malloc(sizeof(char *));
1502 n
->args
->argv
[i
].value
[0] = mandoc_strdup(buf
);
1504 /* Set our width! */
1505 n
->norm
->Bl
.width
= n
->args
->argv
[i
].value
[0];
1511 post_bl_head(POST_ARGS
)
1513 struct mdoc_node
*np
, *nn
, *nnp
;
1516 if (LIST_column
!= mdoc
->last
->norm
->Bl
.type
)
1517 /* FIXME: this should be ERROR class... */
1518 return(hwarn_eq0(mdoc
));
1521 * Convert old-style lists, where the column width specifiers
1522 * trail as macro parameters, to the new-style ("normal-form")
1523 * lists where they're argument values following -column.
1526 /* First, disallow both types and allow normal-form. */
1529 * TODO: technically, we can accept both and just merge the two
1530 * lists, but I'll leave that for another day.
1533 if (mdoc
->last
->norm
->Bl
.ncols
&& mdoc
->last
->nchild
) {
1534 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_COLUMNS
);
1536 } else if (NULL
== mdoc
->last
->child
)
1539 np
= mdoc
->last
->parent
;
1542 for (j
= 0; j
< (int)np
->args
->argc
; j
++)
1543 if (MDOC_Column
== np
->args
->argv
[j
].arg
)
1546 assert(j
< (int)np
->args
->argc
);
1547 assert(0 == np
->args
->argv
[j
].sz
);
1550 * Accommodate for new-style groff column syntax. Shuffle the
1551 * child nodes, all of which must be TEXT, as arguments for the
1552 * column field. Then, delete the head children.
1555 np
->args
->argv
[j
].sz
= (size_t)mdoc
->last
->nchild
;
1556 np
->args
->argv
[j
].value
= mandoc_malloc
1557 ((size_t)mdoc
->last
->nchild
* sizeof(char *));
1559 mdoc
->last
->norm
->Bl
.ncols
= np
->args
->argv
[j
].sz
;
1560 mdoc
->last
->norm
->Bl
.cols
= (void *)np
->args
->argv
[j
].value
;
1562 for (i
= 0, nn
= mdoc
->last
->child
; nn
; i
++) {
1563 np
->args
->argv
[j
].value
[i
] = nn
->string
;
1567 mdoc_node_delete(NULL
, nnp
);
1570 mdoc
->last
->nchild
= 0;
1571 mdoc
->last
->child
= NULL
;
1579 struct mdoc_node
*nparent
, *nprev
; /* of the Bl block */
1580 struct mdoc_node
*nblock
, *nbody
; /* of the Bl */
1581 struct mdoc_node
*nchild
, *nnext
; /* of the Bl body */
1584 switch (nbody
->type
) {
1586 return(post_bl_block(mdoc
));
1588 return(post_bl_head(mdoc
));
1595 nchild
= nbody
->child
;
1596 while (NULL
!= nchild
) {
1597 if (MDOC_It
== nchild
->tok
|| MDOC_Sm
== nchild
->tok
) {
1598 nchild
= nchild
->next
;
1602 mdoc_nmsg(mdoc
, nchild
, MANDOCERR_CHILD
);
1605 * Move the node out of the Bl block.
1606 * First, collect all required node pointers.
1609 nblock
= nbody
->parent
;
1610 nprev
= nblock
->prev
;
1611 nparent
= nblock
->parent
;
1612 nnext
= nchild
->next
;
1615 * Unlink this child.
1618 assert(NULL
== nchild
->prev
);
1619 if (0 == --nbody
->nchild
) {
1620 nbody
->child
= NULL
;
1622 assert(NULL
== nnext
);
1624 nbody
->child
= nnext
;
1629 * Relink this child.
1632 nchild
->parent
= nparent
;
1633 nchild
->prev
= nprev
;
1634 nchild
->next
= nblock
;
1636 nblock
->prev
= nchild
;
1639 nparent
->child
= nchild
;
1641 nprev
->next
= nchild
;
1650 ebool(struct mdoc
*mdoc
)
1653 if (NULL
== mdoc
->last
->child
) {
1654 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1655 mdoc_node_delete(mdoc
, mdoc
->last
);
1658 check_count(mdoc
, MDOC_ELEM
, CHECK_WARN
, CHECK_EQ
, 1);
1660 assert(MDOC_TEXT
== mdoc
->last
->child
->type
);
1662 if (0 == strcmp(mdoc
->last
->child
->string
, "on")) {
1663 if (MDOC_Sm
== mdoc
->last
->tok
)
1664 mdoc
->flags
&= ~MDOC_SMOFF
;
1667 if (0 == strcmp(mdoc
->last
->child
->string
, "off")) {
1668 if (MDOC_Sm
== mdoc
->last
->tok
)
1669 mdoc
->flags
|= MDOC_SMOFF
;
1673 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADBOOL
);
1678 post_root(POST_ARGS
)
1681 struct mdoc_node
*n
;
1685 /* Check that we have a finished prologue. */
1687 if ( ! (MDOC_PBODY
& mdoc
->flags
)) {
1689 mdoc_nmsg(mdoc
, mdoc
->first
, MANDOCERR_NODOCPROLOG
);
1695 /* Check that we begin with a proper `Sh'. */
1697 if (NULL
== n
->child
) {
1699 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1700 } else if (MDOC_BLOCK
!= n
->child
->type
||
1701 MDOC_Sh
!= n
->child
->tok
) {
1703 /* Can this be lifted? See rxdebug.1 for example. */
1704 mdoc_nmsg(mdoc
, n
, MANDOCERR_NODOCBODY
);
1707 return(erc
? 0 : 1);
1713 struct mdoc_node
*ch
;
1716 if (NULL
== (ch
= mdoc
->last
->child
)) {
1717 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_MACROEMPTY
);
1718 mdoc_node_delete(mdoc
, mdoc
->last
);
1722 assert(MDOC_TEXT
== ch
->type
);
1724 if (NULL
== (p
= mdoc_a2st(ch
->string
))) {
1725 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADSTANDARD
);
1726 mdoc_node_delete(mdoc
, mdoc
->last
);
1729 ch
->string
= mandoc_strdup(p
);
1738 struct mdoc_node
*nn
, *next
, *prev
;
1741 switch (mdoc
->last
->type
) {
1743 check_count(mdoc
, MDOC_HEAD
, CHECK_WARN
, CHECK_EQ
, 0);
1746 if (mdoc
->last
->child
)
1748 check_count(mdoc
, MDOC_BODY
, CHECK_WARN
, CHECK_GT
, 0);
1755 * Make sure only certain types of nodes are allowed within the
1756 * the `Rs' body. Delete offending nodes and raise a warning.
1757 * Do this before re-ordering for the sake of clarity.
1761 for (nn
= mdoc
->last
->child
; nn
; nn
= next
) {
1762 for (i
= 0; i
< RSORD_MAX
; i
++)
1763 if (nn
->tok
== rsord
[i
])
1766 if (i
< RSORD_MAX
) {
1767 if (MDOC__J
== rsord
[i
] || MDOC__B
== rsord
[i
])
1768 mdoc
->last
->norm
->Rs
.quote_T
++;
1774 mdoc_nmsg(mdoc
, nn
, MANDOCERR_CHILD
);
1775 mdoc_node_delete(mdoc
, nn
);
1779 * Nothing to sort if only invalid nodes were found
1780 * inside the `Rs' body.
1783 if (NULL
== mdoc
->last
->child
)
1787 * The full `Rs' block needs special handling to order the
1788 * sub-elements according to `rsord'. Pick through each element
1789 * and correctly order it. This is a insertion sort.
1793 for (nn
= mdoc
->last
->child
->next
; nn
; nn
= next
) {
1794 /* Determine order of `nn'. */
1795 for (i
= 0; i
< RSORD_MAX
; i
++)
1796 if (rsord
[i
] == nn
->tok
)
1800 * Remove `nn' from the chain. This somewhat
1801 * repeats mdoc_node_unlink(), but since we're
1802 * just re-ordering, there's no need for the
1803 * full unlink process.
1806 if (NULL
!= (next
= nn
->next
))
1807 next
->prev
= nn
->prev
;
1809 if (NULL
!= (prev
= nn
->prev
))
1810 prev
->next
= nn
->next
;
1812 nn
->prev
= nn
->next
= NULL
;
1815 * Scan back until we reach a node that's
1816 * ordered before `nn'.
1819 for ( ; prev
; prev
= prev
->prev
) {
1820 /* Determine order of `prev'. */
1821 for (j
= 0; j
< RSORD_MAX
; j
++)
1822 if (rsord
[j
] == prev
->tok
)
1830 * Set `nn' back into its correct place in front
1831 * of the `prev' node.
1838 prev
->next
->prev
= nn
;
1839 nn
->next
= prev
->next
;
1842 mdoc
->last
->child
->prev
= nn
;
1843 nn
->next
= mdoc
->last
->child
;
1844 mdoc
->last
->child
= nn
;
1852 * For some arguments of some macros,
1853 * convert all breakable hyphens into ASCII_HYPH.
1856 post_hyph(POST_ARGS
)
1858 struct mdoc_node
*n
, *nch
;
1864 if (MDOC_Sh
== n
->tok
|| MDOC_Ss
== n
->tok
)
1868 if (MDOC_D1
== n
->tok
|| MDOC_Nd
== n
->tok
)
1877 for (nch
= n
->child
; nch
; nch
= nch
->next
) {
1878 if (MDOC_TEXT
!= nch
->type
)
1883 while ('\0' != *(++cp
))
1885 isalpha((unsigned char)cp
[-1]) &&
1886 isalpha((unsigned char)cp
[1]))
1896 if (MDOC_LINE
& mdoc
->last
->flags
)
1897 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNNS
);
1905 if (MDOC_HEAD
== mdoc
->last
->type
)
1906 return(post_sh_head(mdoc
));
1907 if (MDOC_BODY
== mdoc
->last
->type
)
1908 return(post_sh_body(mdoc
));
1914 post_sh_body(POST_ARGS
)
1916 struct mdoc_node
*n
;
1918 if (SEC_NAME
!= mdoc
->lastsec
)
1922 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1923 * macros (can have multiple `Nm' and one `Nd'). Note that the
1924 * children of the BODY declaration can also be "text".
1927 if (NULL
== (n
= mdoc
->last
->child
)) {
1928 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1932 for ( ; n
&& n
->next
; n
= n
->next
) {
1933 if (MDOC_ELEM
== n
->type
&& MDOC_Nm
== n
->tok
)
1935 if (MDOC_TEXT
== n
->type
)
1937 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1941 if (MDOC_BLOCK
== n
->type
&& MDOC_Nd
== n
->tok
)
1944 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_BADNAMESEC
);
1949 post_sh_head(POST_ARGS
)
1951 struct mdoc_node
*n
;
1952 const char *secname
;
1956 * Process a new section. Sections are either "named" or
1957 * "custom". Custom sections are user-defined, while named ones
1958 * follow a conventional order and may only appear in certain
1966 assert(1 == n
->nchild
);
1969 assert(MDOC_TEXT
== n
->type
);
1970 secname
= n
->string
;
1971 sec
= a2sec(secname
);
1974 /* The NAME should be first. */
1976 if (SEC_NAME
!= sec
&& SEC_NONE
== mdoc
->lastnamed
)
1977 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_NAMESECFIRST
);
1979 /* The SYNOPSIS gets special attention in other areas. */
1981 if (SEC_SYNOPSIS
== sec
) {
1982 roff_setreg(mdoc
->roff
, "nS", 1, '=');
1983 mdoc
->flags
|= MDOC_SYNOPSIS
;
1985 roff_setreg(mdoc
->roff
, "nS", 0, '=');
1986 mdoc
->flags
&= ~MDOC_SYNOPSIS
;
1989 /* Mark our last section. */
1991 mdoc
->lastsec
= sec
;
1994 * Set the section attribute for the current HEAD, for its
1995 * parent BLOCK, and for the HEAD children; the latter can
1996 * only be TEXT nodes, so no recursion is needed.
1997 * For other blocks and elements, including .Sh BODY, this is
1998 * done when allocating the node data structures, but for .Sh
1999 * BLOCK and HEAD, the section is still unknown at that time.
2002 mdoc
->last
->parent
->sec
= sec
;
2003 mdoc
->last
->sec
= sec
;
2004 for (n
= mdoc
->last
->child
; n
; n
= n
->next
)
2007 /* We don't care about custom sections after this. */
2009 if (SEC_CUSTOM
== sec
)
2013 * Check whether our non-custom section is being repeated or is
2017 if (sec
== mdoc
->lastnamed
)
2018 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECREP
);
2020 if (sec
< mdoc
->lastnamed
)
2021 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_SECOOO
);
2023 /* Mark the last named section. */
2025 mdoc
->lastnamed
= sec
;
2027 /* Check particular section/manual conventions. */
2029 assert(mdoc
->meta
.msec
);
2033 if (*mdoc
->meta
.msec
== '4')
2036 case (SEC_RETURN_VALUES
):
2039 if (*mdoc
->meta
.msec
== '2')
2041 if (*mdoc
->meta
.msec
== '3')
2043 if (*mdoc
->meta
.msec
== '9')
2045 mandoc_msg(MANDOCERR_SECMSEC
, mdoc
->parse
,
2046 mdoc
->last
->line
, mdoc
->last
->pos
, secname
);
2056 post_ignpar(POST_ARGS
)
2058 struct mdoc_node
*np
;
2060 if (MDOC_BODY
!= mdoc
->last
->type
)
2063 if (NULL
!= (np
= mdoc
->last
->child
))
2064 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
2065 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
2066 mdoc_node_delete(mdoc
, np
);
2069 if (NULL
!= (np
= mdoc
->last
->last
))
2070 if (MDOC_Pp
== np
->tok
|| MDOC_Lp
== np
->tok
) {
2071 mdoc_nmsg(mdoc
, np
, MANDOCERR_IGNPAR
);
2072 mdoc_node_delete(mdoc
, np
);
2082 if (NULL
== mdoc
->last
)
2084 if (MDOC_ELEM
!= n
->type
&& MDOC_BLOCK
!= n
->type
)
2088 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
2089 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
2092 if (MDOC_Pp
!= mdoc
->last
->tok
&&
2093 MDOC_Lp
!= mdoc
->last
->tok
&&
2094 MDOC_br
!= mdoc
->last
->tok
)
2096 if (MDOC_Bl
== n
->tok
&& n
->norm
->Bl
.comp
)
2098 if (MDOC_Bd
== n
->tok
&& n
->norm
->Bd
.comp
)
2100 if (MDOC_It
== n
->tok
&& n
->parent
->norm
->Bl
.comp
)
2103 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
2104 mdoc_node_delete(mdoc
, mdoc
->last
);
2112 if (MDOC_ELEM
!= mdoc
->last
->type
&&
2113 MDOC_BLOCK
!= mdoc
->last
->type
)
2116 if (NULL
== mdoc
->last
->prev
) {
2117 if (MDOC_Sh
!= mdoc
->last
->parent
->tok
&&
2118 MDOC_Ss
!= mdoc
->last
->parent
->tok
)
2121 if (MDOC_Pp
!= mdoc
->last
->prev
->tok
&&
2122 MDOC_Lp
!= mdoc
->last
->prev
->tok
&&
2123 (MDOC_br
!= mdoc
->last
->tok
||
2124 (MDOC_sp
!= mdoc
->last
->prev
->tok
&&
2125 MDOC_br
!= mdoc
->last
->prev
->tok
)))
2129 mdoc_nmsg(mdoc
, mdoc
->last
, MANDOCERR_IGNPAR
);
2130 mdoc_node_delete(mdoc
, mdoc
->last
);
2135 pre_literal(PRE_ARGS
)
2138 if (MDOC_BODY
!= n
->type
)
2142 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
2143 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
2148 mdoc
->flags
|= MDOC_LITERAL
;
2151 if (DISP_literal
== n
->norm
->Bd
.type
)
2152 mdoc
->flags
|= MDOC_LITERAL
;
2153 if (DISP_unfilled
== n
->norm
->Bd
.type
)
2154 mdoc
->flags
|= MDOC_LITERAL
;
2167 struct mdoc_node
*n
;
2170 if (mdoc
->meta
.date
)
2171 free(mdoc
->meta
.date
);
2174 if (NULL
== n
->child
|| '\0' == n
->child
->string
[0]) {
2175 mdoc
->meta
.date
= mdoc
->quick
? mandoc_strdup("") :
2176 mandoc_normdate(mdoc
->parse
, NULL
, n
->line
, n
->pos
);
2181 mdoc_deroff(&datestr
, n
);
2183 mdoc
->meta
.date
= datestr
;
2185 mdoc
->meta
.date
= mandoc_normdate(mdoc
->parse
,
2186 datestr
, n
->line
, n
->pos
);
2195 struct mdoc_node
*nn
, *n
;
2201 if (mdoc
->meta
.title
)
2202 free(mdoc
->meta
.title
);
2204 free(mdoc
->meta
.vol
);
2205 if (mdoc
->meta
.arch
)
2206 free(mdoc
->meta
.arch
);
2208 mdoc
->meta
.title
= mdoc
->meta
.vol
= mdoc
->meta
.arch
= NULL
;
2210 /* First make all characters uppercase. */
2212 if (NULL
!= (nn
= n
->child
))
2213 for (p
= nn
->string
; *p
; p
++) {
2214 if (toupper((unsigned char)*p
) == *p
)
2218 * FIXME: don't be lazy: have this make all
2219 * characters be uppercase and just warn once.
2221 mdoc_nmsg(mdoc
, nn
, MANDOCERR_UPPERCASE
);
2226 * --> title = unknown, volume = local, msec = 0, arch = NULL
2229 if (NULL
== (nn
= n
->child
)) {
2230 /* XXX: make these macro values. */
2231 /* FIXME: warn about missing values. */
2232 mdoc
->meta
.title
= mandoc_strdup("UNKNOWN");
2233 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2234 mdoc
->meta
.msec
= mandoc_strdup("1");
2238 /* Handles: `.Dt TITLE'
2239 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2242 mdoc
->meta
.title
= mandoc_strdup
2243 ('\0' == nn
->string
[0] ? "UNKNOWN" : nn
->string
);
2245 if (NULL
== (nn
= nn
->next
)) {
2246 /* FIXME: warn about missing msec. */
2247 /* XXX: make this a macro value. */
2248 mdoc
->meta
.vol
= mandoc_strdup("LOCAL");
2249 mdoc
->meta
.msec
= mandoc_strdup("1");
2253 /* Handles: `.Dt TITLE SEC'
2254 * --> title = TITLE, volume = SEC is msec ?
2255 * format(msec) : SEC,
2256 * msec = SEC is msec ? atoi(msec) : 0,
2260 cp
= mandoc_a2msec(nn
->string
);
2262 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2263 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2265 mdoc_nmsg(mdoc
, n
, MANDOCERR_BADMSEC
);
2266 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2267 mdoc
->meta
.msec
= mandoc_strdup(nn
->string
);
2270 if (NULL
== (nn
= nn
->next
))
2273 /* Handles: `.Dt TITLE SEC VOL'
2274 * --> title = TITLE, volume = VOL is vol ?
2276 * VOL is arch ? format(arch) :
2280 cp
= mdoc_a2vol(nn
->string
);
2282 free(mdoc
->meta
.vol
);
2283 mdoc
->meta
.vol
= mandoc_strdup(cp
);
2285 cp
= mdoc_a2arch(nn
->string
);
2287 mdoc_nmsg(mdoc
, nn
, MANDOCERR_BADVOLARCH
);
2288 free(mdoc
->meta
.vol
);
2289 mdoc
->meta
.vol
= mandoc_strdup(nn
->string
);
2291 mdoc
->meta
.arch
= mandoc_strdup(cp
);
2294 /* Ignore any subsequent parameters... */
2295 /* FIXME: warn about subsequent parameters. */
2301 post_prol(POST_ARGS
)
2304 * Remove prologue macros from the document after they're
2305 * processed. The final document uses mdoc_meta for these
2306 * values and discards the originals.
2309 mdoc_node_delete(mdoc
, mdoc
->last
);
2310 if (mdoc
->meta
.title
&& mdoc
->meta
.date
&& mdoc
->meta
.os
)
2311 mdoc
->flags
|= MDOC_PBODY
;
2319 struct mdoc_node
*n
;
2322 * Make `Bx's second argument always start with an uppercase
2323 * letter. Groff checks if it's an "accepted" term, but we just
2324 * uppercase blindly.
2327 n
= mdoc
->last
->child
;
2328 if (n
&& NULL
!= (n
= n
->next
))
2329 *n
->string
= (char)toupper
2330 ((unsigned char)*n
->string
);
2339 struct utsname utsname
;
2340 static char *defbuf
;
2342 struct mdoc_node
*n
;
2347 * Set the operating system by way of the `Os' macro.
2348 * The order of precedence is:
2349 * 1. the argument of the `Os' macro, unless empty
2350 * 2. the -Ios=foo command line argument, if provided
2351 * 3. -DOSNAME="\"foo\"", if provided during compilation
2352 * 4. "sysname release" from uname(3)
2355 free(mdoc
->meta
.os
);
2356 mdoc
->meta
.os
= NULL
;
2357 mdoc_deroff(&mdoc
->meta
.os
, n
);
2362 mdoc
->meta
.os
= mandoc_strdup(mdoc
->defos
);
2367 mdoc
->meta
.os
= mandoc_strdup(OSNAME
);
2369 if (NULL
== defbuf
) {
2370 if (-1 == uname(&utsname
)) {
2371 mdoc_nmsg(mdoc
, n
, MANDOCERR_UNAME
);
2372 defbuf
= mandoc_strdup("UNKNOWN");
2374 mandoc_asprintf(&defbuf
, "%s %s",
2375 utsname
.sysname
, utsname
.release
);
2377 mdoc
->meta
.os
= mandoc_strdup(defbuf
);
2385 struct mdoc_node
*nn
, *n
;
2390 * Macros accepting `-std' as an argument have the name of the
2391 * current document (`Nm') filled in as the argument if it's not
2398 if (NULL
== mdoc
->meta
.name
)
2402 mdoc
->next
= MDOC_NEXT_CHILD
;
2404 if ( ! mdoc_word_alloc(mdoc
, n
->line
, n
->pos
, mdoc
->meta
.name
))
2411 static enum mdoc_sec
2412 a2sec(const char *p
)
2416 for (i
= 0; i
< (int)SEC__MAX
; i
++)
2417 if (secnames
[i
] && 0 == strcmp(p
, secnames
[i
]))
2418 return((enum mdoc_sec
)i
);
2424 macro2len(enum mdoct macro
)