1 /* $Id: mdoc_validate.c,v 1.198 2013/12/15 21:23:52 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 #include <sys/utsname.h>
26 #include <sys/types.h>
39 #include "libmandoc.h"
41 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
43 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
44 #define POST_ARGS struct mdoc *mdoc
60 typedef int (*v_pre)(PRE_ARGS);
61 typedef int (*v_post)(POST_ARGS);
68 static int check_count(struct mdoc *, enum mdoc_type,
69 enum check_lvl, enum check_ineq, int);
70 static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
71 static void check_text(struct mdoc *, int, int, char *);
72 static void check_argv(struct mdoc *,
73 struct mdoc_node *, struct mdoc_argv *);
74 static void check_args(struct mdoc *, struct mdoc_node *);
75 static int concat(char *, const struct mdoc_node *, size_t);
76 static enum mdoc_sec a2sec(const char *);
77 static size_t macro2len(enum mdoct);
79 static int ebool(POST_ARGS);
80 static int berr_ge1(POST_ARGS);
81 static int bwarn_ge1(POST_ARGS);
82 static int ewarn_eq0(POST_ARGS);
83 static int ewarn_eq1(POST_ARGS);
84 static int ewarn_ge1(POST_ARGS);
85 static int ewarn_le1(POST_ARGS);
86 static int hwarn_eq0(POST_ARGS);
87 static int hwarn_eq1(POST_ARGS);
88 static int hwarn_ge1(POST_ARGS);
89 static int hwarn_le1(POST_ARGS);
91 static int post_an(POST_ARGS);
92 static int post_at(POST_ARGS);
93 static int post_bf(POST_ARGS);
94 static int post_bl(POST_ARGS);
95 static int post_bl_block(POST_ARGS);
96 static int post_bl_block_width(POST_ARGS);
97 static int post_bl_block_tag(POST_ARGS);
98 static int post_bl_head(POST_ARGS);
99 static int post_bx(POST_ARGS);
100 static int post_defaults(POST_ARGS);
101 static int post_dd(POST_ARGS);
102 static int post_dt(POST_ARGS);
103 static int post_eoln(POST_ARGS);
104 static int post_hyph(POST_ARGS);
105 static int post_ignpar(POST_ARGS);
106 static int post_it(POST_ARGS);
107 static int post_lb(POST_ARGS);
108 static int post_literal(POST_ARGS);
109 static int post_nm(POST_ARGS);
110 static int post_ns(POST_ARGS);
111 static int post_os(POST_ARGS);
112 static int post_par(POST_ARGS);
113 static int post_prol(POST_ARGS);
114 static int post_root(POST_ARGS);
115 static int post_rs(POST_ARGS);
116 static int post_sh(POST_ARGS);
117 static int post_sh_body(POST_ARGS);
118 static int post_sh_head(POST_ARGS);
119 static int post_st(POST_ARGS);
120 static int post_std(POST_ARGS);
121 static int post_vt(POST_ARGS);
122 static int pre_an(PRE_ARGS);
123 static int pre_bd(PRE_ARGS);
124 static int pre_bl(PRE_ARGS);
125 static int pre_dd(PRE_ARGS);
126 static int pre_display(PRE_ARGS);
127 static int pre_dt(PRE_ARGS);
128 static int pre_it(PRE_ARGS);
129 static int pre_literal(PRE_ARGS);
130 static int pre_os(PRE_ARGS);
131 static int pre_par(PRE_ARGS);
132 static int pre_sh(PRE_ARGS);
133 static int pre_ss(PRE_ARGS);
134 static int pre_std(PRE_ARGS);
136 static v_post posts_an[] = { post_an, NULL };
137 static v_post posts_at[] = { post_at, post_defaults, NULL };
138 static v_post posts_bd[] = { post_literal, hwarn_eq0, bwarn_ge1, NULL };
139 static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
140 static v_post posts_bk[] = { hwarn_eq0, bwarn_ge1, NULL };
141 static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
142 static v_post posts_bx[] = { post_bx, NULL };
143 static v_post posts_bool[] = { ebool, NULL };
144 static v_post posts_eoln[] = { post_eoln, NULL };
145 static v_post posts_defaults[] = { post_defaults, NULL };
146 static v_post posts_d1[] = { bwarn_ge1, post_hyph, NULL };
147 static v_post posts_dd[] = { post_dd, post_prol, NULL };
148 static v_post posts_dl[] = { post_literal, bwarn_ge1, NULL };
149 static v_post posts_dt[] = { post_dt, post_prol, NULL };
150 static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
151 static v_post posts_hyph[] = { post_hyph, NULL };
152 static v_post posts_hyphtext[] = { ewarn_ge1, post_hyph, NULL };
153 static v_post posts_it[] = { post_it, NULL };
154 static v_post posts_lb[] = { post_lb, NULL };
155 static v_post posts_nd[] = { berr_ge1, post_hyph, NULL };
156 static v_post posts_nm[] = { post_nm, NULL };
157 static v_post posts_notext[] = { ewarn_eq0, NULL };
158 static v_post posts_ns[] = { post_ns, NULL };
159 static v_post posts_os[] = { post_os, post_prol, NULL };
160 static v_post posts_pp[] = { post_par, ewarn_eq0, NULL };
161 static v_post posts_rs[] = { post_rs, NULL };
162 static v_post posts_sh[] = { post_ignpar,hwarn_ge1,post_sh,post_hyph,NULL };
163 static v_post posts_sp[] = { post_par, ewarn_le1, NULL };
164 static v_post posts_ss[] = { post_ignpar, hwarn_ge1, post_hyph, NULL };
165 static v_post posts_st[] = { post_st, NULL };
166 static v_post posts_std[] = { post_std, NULL };
167 static v_post posts_text[] = { ewarn_ge1, NULL };
168 static v_post posts_text1[] = { ewarn_eq1, NULL };
169 static v_post posts_vt[] = { post_vt, NULL };
170 static v_pre pres_an[] = { pre_an, NULL };
171 static v_pre pres_bd[] = { pre_display, pre_bd, pre_literal, pre_par, NULL };
172 static v_pre pres_bl[] = { pre_bl, pre_par, NULL };
173 static v_pre pres_d1[] = { pre_display, NULL };
174 static v_pre pres_dl[] = { pre_literal, pre_display, NULL };
175 static v_pre pres_dd[] = { pre_dd, NULL };
176 static v_pre pres_dt[] = { pre_dt, NULL };
177 static v_pre pres_it[] = { pre_it, pre_par, NULL };
178 static v_pre pres_os[] = { pre_os, NULL };
179 static v_pre pres_pp[] = { pre_par, NULL };
180 static v_pre pres_sh[] = { pre_sh, NULL };
181 static v_pre pres_ss[] = { pre_ss, NULL };
182 static v_pre pres_std[] = { pre_std, NULL };
184 static const struct valids mdoc_valids[MDOC_MAX] = {
185 { NULL, NULL }, /* Ap */
186 { pres_dd, posts_dd }, /* Dd */
187 { pres_dt, posts_dt }, /* Dt */
188 { pres_os, posts_os }, /* Os */
189 { pres_sh, posts_sh }, /* Sh */
190 { pres_ss, posts_ss }, /* Ss */
191 { pres_pp, posts_pp }, /* Pp */
192 { pres_d1, posts_d1 }, /* D1 */
193 { pres_dl, posts_dl }, /* Dl */
194 { pres_bd, posts_bd }, /* Bd */
195 { NULL, NULL }, /* Ed */
196 { pres_bl, posts_bl }, /* Bl */
197 { NULL, NULL }, /* El */
198 { pres_it, posts_it }, /* It */
199 { NULL, NULL }, /* Ad */
200 { pres_an, posts_an }, /* An */
201 { NULL, posts_defaults }, /* Ar */
202 { NULL, NULL }, /* Cd */
203 { NULL, NULL }, /* Cm */
204 { NULL, NULL }, /* Dv */
205 { NULL, NULL }, /* Er */
206 { NULL, NULL }, /* Ev */
207 { pres_std, posts_std }, /* Ex */
208 { NULL, NULL }, /* Fa */
209 { NULL, posts_text }, /* Fd */
210 { NULL, NULL }, /* Fl */
211 { NULL, NULL }, /* Fn */
212 { NULL, NULL }, /* Ft */
213 { NULL, NULL }, /* Ic */
214 { NULL, posts_text1 }, /* In */
215 { NULL, posts_defaults }, /* Li */
216 { NULL, posts_nd }, /* Nd */
217 { NULL, posts_nm }, /* Nm */
218 { NULL, NULL }, /* Op */
219 { NULL, NULL }, /* Ot */
220 { NULL, posts_defaults }, /* Pa */
221 { pres_std, posts_std }, /* Rv */
222 { NULL, posts_st }, /* St */
223 { NULL, NULL }, /* Va */
224 { NULL, posts_vt }, /* Vt */
225 { NULL, posts_text }, /* Xr */
226 { NULL, posts_text }, /* %A */
227 { NULL, posts_hyphtext }, /* %B */ /* FIXME: can be used outside Rs/Re. */
228 { NULL, posts_text }, /* %D */
229 { NULL, posts_text }, /* %I */
230 { NULL, posts_text }, /* %J */
231 { NULL, posts_hyphtext }, /* %N */
232 { NULL, posts_hyphtext }, /* %O */
233 { NULL, posts_text }, /* %P */
234 { NULL, posts_hyphtext }, /* %R */
235 { NULL, posts_hyphtext }, /* %T */ /* FIXME: can be used outside Rs/Re. */
236 { NULL, posts_text }, /* %V */
237 { NULL, NULL }, /* Ac */
238 { NULL, NULL }, /* Ao */
239 { NULL, NULL }, /* Aq */
240 { NULL, posts_at }, /* At */
241 { NULL, NULL }, /* Bc */
242 { NULL, posts_bf }, /* Bf */
243 { NULL, NULL }, /* Bo */
244 { NULL, NULL }, /* Bq */
245 { NULL, NULL }, /* Bsx */
246 { NULL, posts_bx }, /* Bx */
247 { NULL, posts_bool }, /* Db */
248 { NULL, NULL }, /* Dc */
249 { NULL, NULL }, /* Do */
250 { NULL, NULL }, /* Dq */
251 { NULL, NULL }, /* Ec */
252 { NULL, NULL }, /* Ef */
253 { NULL, NULL }, /* Em */
254 { NULL, NULL }, /* Eo */
255 { NULL, NULL }, /* Fx */
256 { NULL, NULL }, /* Ms */
257 { NULL, posts_notext }, /* No */
258 { NULL, posts_ns }, /* Ns */
259 { NULL, NULL }, /* Nx */
260 { NULL, NULL }, /* Ox */
261 { NULL, NULL }, /* Pc */
262 { NULL, posts_text1 }, /* Pf */
263 { NULL, NULL }, /* Po */
264 { NULL, NULL }, /* Pq */
265 { NULL, NULL }, /* Qc */
266 { NULL, NULL }, /* Ql */
267 { NULL, NULL }, /* Qo */
268 { NULL, NULL }, /* Qq */
269 { NULL, NULL }, /* Re */
270 { NULL, posts_rs }, /* Rs */
271 { NULL, NULL }, /* Sc */
272 { NULL, NULL }, /* So */
273 { NULL, NULL }, /* Sq */
274 { NULL, posts_bool }, /* Sm */
275 { NULL, posts_hyph }, /* Sx */
276 { NULL, NULL }, /* Sy */
277 { NULL, NULL }, /* Tn */
278 { NULL, NULL }, /* Ux */
279 { NULL, NULL }, /* Xc */
280 { NULL, NULL }, /* Xo */
281 { NULL, posts_fo }, /* Fo */
282 { NULL, NULL }, /* Fc */
283 { NULL, NULL }, /* Oo */
284 { NULL, NULL }, /* Oc */
285 { NULL, posts_bk }, /* Bk */
286 { NULL, NULL }, /* Ek */
287 { NULL, posts_eoln }, /* Bt */
288 { NULL, NULL }, /* Hf */
289 { NULL, NULL }, /* Fr */
290 { NULL, posts_eoln }, /* Ud */
291 { NULL, posts_lb }, /* Lb */
292 { pres_pp, posts_pp }, /* Lp */
293 { NULL, NULL }, /* Lk */
294 { NULL, posts_defaults }, /* Mt */
295 { NULL, NULL }, /* Brq */
296 { NULL, NULL }, /* Bro */
297 { NULL, NULL }, /* Brc */
298 { NULL, posts_text }, /* %C */
299 { NULL, NULL }, /* Es */
300 { NULL, NULL }, /* En */
301 { NULL, NULL }, /* Dx */
302 { NULL, posts_text }, /* %Q */
303 { NULL, posts_pp }, /* br */
304 { NULL, posts_sp }, /* sp */
305 { NULL, posts_text1 }, /* %U */
306 { NULL, NULL }, /* Ta */
309 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
311 static const enum mdoct rsord[RSORD_MAX] = {
328 static const char * const secnames[SEC__MAX] = {
334 "IMPLEMENTATION NOTES",
349 "SECURITY CONSIDERATIONS",
354 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
365 check_text(mdoc, line, pos, tp);
379 if (NULL == mdoc_valids[n->tok].pre)
381 for (p = mdoc_valids[n->tok].pre; *p; p++)
382 if ( ! (*p)(mdoc, n))
389 mdoc_valid_post(struct mdoc *mdoc)
393 if (MDOC_VALID & mdoc->last->flags)
395 mdoc->last->flags |= MDOC_VALID;
397 switch (mdoc->last->type) {
405 return(post_root(mdoc));
410 if (NULL == mdoc_valids[mdoc->last->tok].post)
412 for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
420 check_count(struct mdoc *mdoc, enum mdoc_type type,
421 enum check_lvl lvl, enum check_ineq ineq, int val)
426 if (mdoc->last->type != type)
432 if (mdoc->last->nchild < val)
437 if (mdoc->last->nchild > val)
442 if (val == mdoc->last->nchild)
450 t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT;
451 mandoc_vmsg(t, mdoc->parse, mdoc->last->line, mdoc->last->pos,
452 "want %s%d children (have %d)",
453 p, val, mdoc->last->nchild);
461 return(check_count(mdoc, MDOC_BODY, CHECK_ERROR, CHECK_GT, 0));
467 return(check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0));
473 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0));
479 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1));
485 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0));
491 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2));
497 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0));
503 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 1));
509 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_GT, 0));
515 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_LT, 2));
519 check_args(struct mdoc *mdoc, struct mdoc_node *n)
526 assert(n->args->argc);
527 for (i = 0; i < (int)n->args->argc; i++)
528 check_argv(mdoc, n, &n->args->argv[i]);
532 check_argv(struct mdoc *mdoc, struct mdoc_node *n, struct mdoc_argv *v)
536 for (i = 0; i < (int)v->sz; i++)
537 check_text(mdoc, v->line, v->pos, v->value[i]);
539 /* FIXME: move to post_std(). */
541 if (MDOC_Std == v->arg)
542 if ( ! (v->sz || mdoc->meta.name))
543 mdoc_nmsg(mdoc, n, MANDOCERR_NONAME);
547 check_text(struct mdoc *mdoc, int ln, int pos, char *p)
551 if (MDOC_LITERAL & mdoc->flags)
554 for (cp = p; NULL != (p = strchr(p, '\t')); p++)
555 mdoc_pmsg(mdoc, ln, pos + (int)(p - cp), MANDOCERR_BADTAB);
559 check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
563 if ((MDOC_ROOT == t || tok == n->parent->tok) &&
564 (t == n->parent->type))
567 mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse, n->line,
568 n->pos, "want parent %s", MDOC_ROOT == t ?
569 "<root>" : mdoc_macronames[tok]);
575 pre_display(PRE_ARGS)
577 struct mdoc_node *node;
579 if (MDOC_BLOCK != n->type)
582 for (node = mdoc->last->parent; node; node = node->parent)
583 if (MDOC_BLOCK == node->type)
584 if (MDOC_Bd == node->tok)
588 mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP);
598 const char *offs, *width;
600 struct mdoc_node *np;
602 if (MDOC_BLOCK != n->type) {
603 if (ENDBODY_NOT != n->end) {
605 np = n->pending->parent;
610 assert(MDOC_BLOCK == np->type);
611 assert(MDOC_Bl == np->tok);
616 * First figure out which kind of list to use: bind ourselves to
617 * the first mentioned list type and warn about any remaining
618 * ones. If we find no list type, we default to LIST_item.
622 for (i = 0; n->args && i < (int)n->args->argc; i++) {
626 switch (n->args->argv[i].arg) {
627 /* Set list types. */
661 /* Set list arguments. */
663 dup = n->norm->Bl.comp;
667 /* NB: this can be empty! */
668 if (n->args->argv[i].sz) {
669 width = n->args->argv[i].value[0];
670 dup = (NULL != n->norm->Bl.width);
673 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
676 /* NB: this can be empty! */
677 if (n->args->argv[i].sz) {
678 offs = n->args->argv[i].value[0];
679 dup = (NULL != n->norm->Bl.offs);
682 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
688 /* Check: duplicate auxiliary arguments. */
691 mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
694 n->norm->Bl.comp = comp;
696 n->norm->Bl.offs = offs;
698 n->norm->Bl.width = width;
700 /* Check: multiple list types. */
702 if (LIST__NONE != lt && n->norm->Bl.type != LIST__NONE)
703 mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP);
705 /* Assign list type. */
707 if (LIST__NONE != lt && n->norm->Bl.type == LIST__NONE) {
708 n->norm->Bl.type = lt;
709 /* Set column information, too. */
710 if (LIST_column == lt) {
713 n->norm->Bl.cols = (void *)
714 n->args->argv[i].value;
718 /* The list type should come first. */
720 if (n->norm->Bl.type == LIST__NONE)
721 if (n->norm->Bl.width ||
724 mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST);
729 /* Allow lists to default to LIST_item. */
731 if (LIST__NONE == n->norm->Bl.type) {
732 mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);
733 n->norm->Bl.type = LIST_item;
737 * Validate the width field. Some list types don't need width
738 * types and should be warned about them. Others should have it
739 * and must also be warned. Yet others have a default and need
743 switch (n->norm->Bl.type) {
745 if (NULL == n->norm->Bl.width)
746 mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG);
757 if (n->norm->Bl.width)
758 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
765 if (NULL == n->norm->Bl.width)
766 n->norm->Bl.width = "2n";
769 if (NULL == n->norm->Bl.width)
770 n->norm->Bl.width = "3n";
786 struct mdoc_node *np;
788 if (MDOC_BLOCK != n->type) {
789 if (ENDBODY_NOT != n->end) {
791 np = n->pending->parent;
796 assert(MDOC_BLOCK == np->type);
797 assert(MDOC_Bd == np->tok);
802 for (i = 0; n->args && i < (int)n->args->argc; i++) {
807 switch (n->args->argv[i].arg) {
814 case (MDOC_Unfilled):
824 mdoc_nmsg(mdoc, n, MANDOCERR_BADDISP);
827 /* NB: this can be empty! */
828 if (n->args->argv[i].sz) {
829 offs = n->args->argv[i].value[0];
830 dup = (NULL != n->norm->Bd.offs);
833 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
837 dup = n->norm->Bd.comp;
844 /* Check whether we have duplicates. */
847 mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
849 /* Make our auxiliary assignments. */
852 n->norm->Bd.offs = offs;
854 n->norm->Bd.comp = comp;
856 /* Check whether a type has already been assigned. */
858 if (DISP__NONE != dt && n->norm->Bd.type != DISP__NONE)
859 mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP);
861 /* Make our type assignment. */
863 if (DISP__NONE != dt && n->norm->Bd.type == DISP__NONE)
864 n->norm->Bd.type = dt;
867 if (DISP__NONE == n->norm->Bd.type) {
868 mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
869 n->norm->Bd.type = DISP_ragged;
880 if (MDOC_BLOCK != n->type)
882 return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
890 if (MDOC_BLOCK != n->type)
892 return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
900 if (MDOC_BLOCK != n->type)
903 return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
915 for (i = 1; i < (int)n->args->argc; i++)
916 mdoc_pmsg(mdoc, n->args->argv[i].line,
917 n->args->argv[i].pos, MANDOCERR_IGNARGV);
919 if (MDOC_Split == n->args->argv[0].arg)
920 n->norm->An.auth = AUTH_split;
921 else if (MDOC_Nosplit == n->args->argv[0].arg)
922 n->norm->An.auth = AUTH_nosplit;
933 if (n->args && 1 == n->args->argc)
934 if (MDOC_Std == n->args->argv[0].arg)
937 mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV);
945 if (NULL == mdoc->meta.date || mdoc->meta.os)
946 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
948 if (mdoc->meta.title)
949 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
958 if (NULL == mdoc->meta.title || NULL == mdoc->meta.date)
959 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
962 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
971 if (mdoc->meta.title || mdoc->meta.os)
972 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
975 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
984 struct mdoc_node *np;
988 * Unlike other data pointers, these are "housed" by the HEAD
989 * element, which contains the goods.
992 if (MDOC_HEAD != mdoc->last->type) {
993 if (ENDBODY_NOT != mdoc->last->end) {
994 assert(mdoc->last->pending);
995 np = mdoc->last->pending->parent->head;
996 } else if (MDOC_BLOCK != mdoc->last->type) {
997 np = mdoc->last->parent->head;
999 np = mdoc->last->head;
1002 assert(MDOC_HEAD == np->type);
1003 assert(MDOC_Bf == np->tok);
1008 assert(MDOC_BLOCK == np->parent->type);
1009 assert(MDOC_Bf == np->parent->tok);
1012 * Cannot have both argument and parameter.
1013 * If neither is specified, let it through with a warning.
1016 if (np->parent->args && np->child) {
1017 mdoc_nmsg(mdoc, np, MANDOCERR_SYNTARGVCOUNT);
1019 } else if (NULL == np->parent->args && NULL == np->child) {
1020 mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE);
1024 /* Extract argument into data. */
1026 if (np->parent->args) {
1027 arg = np->parent->args->argv[0].arg;
1028 if (MDOC_Emphasis == arg)
1029 np->norm->Bf.font = FONT_Em;
1030 else if (MDOC_Literal == arg)
1031 np->norm->Bf.font = FONT_Li;
1032 else if (MDOC_Symbolic == arg)
1033 np->norm->Bf.font = FONT_Sy;
1039 /* Extract parameter into data. */
1041 if (0 == strcmp(np->child->string, "Em"))
1042 np->norm->Bf.font = FONT_Em;
1043 else if (0 == strcmp(np->child->string, "Li"))
1044 np->norm->Bf.font = FONT_Li;
1045 else if (0 == strcmp(np->child->string, "Sy"))
1046 np->norm->Bf.font = FONT_Sy;
1048 mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE);
1060 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);
1062 assert(mdoc->last->child);
1063 assert(MDOC_TEXT == mdoc->last->child->type);
1065 p = mdoc_a2lib(mdoc->last->child->string);
1067 /* If lookup ok, replace with table value. */
1070 free(mdoc->last->child->string);
1071 mdoc->last->child->string = mandoc_strdup(p);
1075 /* If not, use "library ``xxxx''. */
1077 sz = strlen(mdoc->last->child->string) +
1078 2 + strlen("\\(lqlibrary\\(rq");
1079 buf = mandoc_malloc(sz);
1080 snprintf(buf, sz, "library \\(lq%s\\(rq",
1081 mdoc->last->child->string);
1082 free(mdoc->last->child->string);
1083 mdoc->last->child->string = buf;
1088 post_eoln(POST_ARGS)
1091 if (mdoc->last->child)
1092 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1100 const struct mdoc_node *n;
1103 * The Vt macro comes in both ELEM and BLOCK form, both of which
1104 * have different syntaxes (yet more context-sensitive
1105 * behaviour). ELEM types must have a child, which is already
1106 * guaranteed by the in_line parsing routine; BLOCK types,
1107 * specifically the BODY, should only have TEXT children.
1110 if (MDOC_BODY != mdoc->last->type)
1113 for (n = mdoc->last->child; n; n = n->next)
1114 if (MDOC_TEXT != n->type)
1115 mdoc_nmsg(mdoc, n, MANDOCERR_CHILD);
1127 if (NULL != mdoc->meta.name)
1130 /* Try to use our children for setting the meta name. */
1132 if (NULL != mdoc->last->child) {
1134 c = concat(buf, mdoc->last->child, BUFSIZ);
1140 mdoc_nmsg(mdoc, mdoc->last->child, MANDOCERR_MEM);
1143 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME);
1144 mdoc->meta.name = mandoc_strdup("UNKNOWN");
1147 mdoc->meta.name = mandoc_strdup(buf);
1154 post_literal(POST_ARGS)
1158 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1159 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1160 * this in literal mode, but it doesn't hurt to just switch it
1161 * off in general since displays can't be nested.
1164 if (MDOC_BODY == mdoc->last->type)
1165 mdoc->flags &= ~MDOC_LITERAL;
1171 post_defaults(POST_ARGS)
1173 struct mdoc_node *nn;
1176 * The `Ar' defaults to "file ..." if no value is provided as an
1177 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1178 * gets an empty string.
1181 if (mdoc->last->child)
1185 mdoc->next = MDOC_NEXT_CHILD;
1189 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "file"))
1191 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))
1195 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "AT&T"))
1197 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "UNIX"))
1201 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))
1207 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"))
1227 * If we have a child, look it up in the standard keys. If a
1228 * key exist, use that instead of the child; if it doesn't,
1229 * prefix "AT&T UNIX " to the existing data.
1232 if (NULL == mdoc->last->child)
1235 assert(MDOC_TEXT == mdoc->last->child->type);
1236 p = mdoc_a2att(mdoc->last->child->string);
1239 free(mdoc->last->child->string);
1240 mdoc->last->child->string = mandoc_strdup(p);
1242 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT);
1244 q = mdoc->last->child->string;
1245 sz = strlen(p) + strlen(q) + 1;
1246 buf = mandoc_malloc(sz);
1247 strlcpy(buf, p, sz);
1248 strlcat(buf, q, sz);
1249 free(mdoc->last->child->string);
1250 mdoc->last->child->string = buf;
1259 struct mdoc_node *np;
1262 if (AUTH__NONE == np->norm->An.auth) {
1264 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0);
1265 } else if (np->child)
1266 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0);
1277 struct mdoc_node *n, *c;
1280 if (MDOC_BLOCK != mdoc->last->type)
1283 n = mdoc->last->parent->parent;
1284 lt = n->norm->Bl.type;
1286 if (LIST__NONE == lt) {
1287 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
1293 if (mdoc->last->head->child)
1295 /* FIXME: give this a dummy value. */
1296 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1305 if (NULL == mdoc->last->head->child)
1306 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1315 if (NULL == mdoc->last->body->child)
1316 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1319 if (mdoc->last->head->child)
1320 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1323 cols = (int)n->norm->Bl.ncols;
1325 assert(NULL == mdoc->last->head->child);
1327 if (NULL == mdoc->last->body->child)
1328 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1330 for (i = 0, c = mdoc->last->child; c; c = c->next)
1331 if (MDOC_BODY == c->type)
1335 er = MANDOCERR_ARGCOUNT;
1336 else if (i == cols || i == cols + 1)
1339 er = MANDOCERR_SYNTARGCOUNT;
1341 mandoc_vmsg(er, mdoc->parse, mdoc->last->line,
1343 "columns == %d (have %d)", cols, i);
1344 return(MANDOCERR_ARGCOUNT == er);
1353 post_bl_block(POST_ARGS)
1355 struct mdoc_node *n, *ni, *nc;
1358 * These are fairly complicated, so we've broken them into two
1359 * functions. post_bl_block_tag() is called when a -tag is
1360 * specified, but no -width (it must be guessed). The second
1361 * when a -width is specified (macro indicators must be
1362 * rewritten into real lengths).
1367 if (LIST_tag == n->norm->Bl.type &&
1368 NULL == n->norm->Bl.width) {
1369 if ( ! post_bl_block_tag(mdoc))
1371 assert(n->norm->Bl.width);
1372 } else if (NULL != n->norm->Bl.width) {
1373 if ( ! post_bl_block_width(mdoc))
1375 assert(n->norm->Bl.width);
1378 for (ni = n->body->child; ni; ni = ni->next) {
1379 if (NULL == ni->body)
1381 nc = ni->body->last;
1382 while (NULL != nc) {
1394 if (NULL == ni->next) {
1395 mdoc_nmsg(mdoc, nc, MANDOCERR_MOVEPAR);
1396 if ( ! mdoc_node_relink(mdoc, nc))
1398 } else if (0 == n->norm->Bl.comp &&
1399 LIST_column != n->norm->Bl.type) {
1400 mdoc_nmsg(mdoc, nc, MANDOCERR_IGNPAR);
1401 mdoc_node_delete(mdoc, nc);
1404 nc = ni->body->last;
1411 post_bl_block_width(POST_ARGS)
1416 struct mdoc_node *n;
1422 * Calculate the real width of a list from the -width string,
1423 * which may contain a macro (with a known default width), a
1424 * literal string, or a scaling width.
1426 * If the value to -width is a macro, then we re-write it to be
1427 * the macro's width as set in share/tmac/mdoc/doc-common.
1430 if (0 == strcmp(n->norm->Bl.width, "Ds"))
1432 else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))
1434 else if (0 == (width = macro2len(tok))) {
1435 mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH);
1439 /* The value already exists: free and reallocate it. */
1443 for (i = 0; i < (int)n->args->argc; i++)
1444 if (MDOC_Width == n->args->argv[i].arg)
1447 assert(i < (int)n->args->argc);
1449 snprintf(buf, NUMSIZ, "%un", (unsigned int)width);
1450 free(n->args->argv[i].value[0]);
1451 n->args->argv[i].value[0] = mandoc_strdup(buf);
1453 /* Set our width! */
1454 n->norm->Bl.width = n->args->argv[i].value[0];
1459 post_bl_block_tag(POST_ARGS)
1461 struct mdoc_node *n, *nn;
1467 * Calculate the -width for a `Bl -tag' list if it hasn't been
1468 * provided. Uses the first head macro. NOTE AGAIN: this is
1469 * ONLY if the -width argument has NOT been provided. See
1470 * post_bl_block_width() for converting the -width string.
1476 for (nn = n->body->child; nn; nn = nn->next) {
1477 if (MDOC_It != nn->tok)
1480 assert(MDOC_BLOCK == nn->type);
1481 nn = nn->head->child;
1486 if (MDOC_TEXT == nn->type) {
1487 sz = strlen(nn->string) + 1;
1491 if (0 != (ssz = macro2len(nn->tok)))
1497 /* Defaults to ten ens. */
1499 snprintf(buf, NUMSIZ, "%un", (unsigned int)sz);
1502 * We have to dynamically add this to the macro's argument list.
1503 * We're guaranteed that a MDOC_Width doesn't already exist.
1507 i = (int)(n->args->argc)++;
1509 n->args->argv = mandoc_realloc(n->args->argv,
1510 n->args->argc * sizeof(struct mdoc_argv));
1512 n->args->argv[i].arg = MDOC_Width;
1513 n->args->argv[i].line = n->line;
1514 n->args->argv[i].pos = n->pos;
1515 n->args->argv[i].sz = 1;
1516 n->args->argv[i].value = mandoc_malloc(sizeof(char *));
1517 n->args->argv[i].value[0] = mandoc_strdup(buf);
1519 /* Set our width! */
1520 n->norm->Bl.width = n->args->argv[i].value[0];
1526 post_bl_head(POST_ARGS)
1528 struct mdoc_node *np, *nn, *nnp;
1531 if (LIST_column != mdoc->last->norm->Bl.type)
1532 /* FIXME: this should be ERROR class... */
1533 return(hwarn_eq0(mdoc));
1536 * Convert old-style lists, where the column width specifiers
1537 * trail as macro parameters, to the new-style ("normal-form")
1538 * lists where they're argument values following -column.
1541 /* First, disallow both types and allow normal-form. */
1544 * TODO: technically, we can accept both and just merge the two
1545 * lists, but I'll leave that for another day.
1548 if (mdoc->last->norm->Bl.ncols && mdoc->last->nchild) {
1549 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS);
1551 } else if (NULL == mdoc->last->child)
1554 np = mdoc->last->parent;
1557 for (j = 0; j < (int)np->args->argc; j++)
1558 if (MDOC_Column == np->args->argv[j].arg)
1561 assert(j < (int)np->args->argc);
1562 assert(0 == np->args->argv[j].sz);
1565 * Accommodate for new-style groff column syntax. Shuffle the
1566 * child nodes, all of which must be TEXT, as arguments for the
1567 * column field. Then, delete the head children.
1570 np->args->argv[j].sz = (size_t)mdoc->last->nchild;
1571 np->args->argv[j].value = mandoc_malloc
1572 ((size_t)mdoc->last->nchild * sizeof(char *));
1574 mdoc->last->norm->Bl.ncols = np->args->argv[j].sz;
1575 mdoc->last->norm->Bl.cols = (void *)np->args->argv[j].value;
1577 for (i = 0, nn = mdoc->last->child; nn; i++) {
1578 np->args->argv[j].value[i] = nn->string;
1582 mdoc_node_delete(NULL, nnp);
1585 mdoc->last->nchild = 0;
1586 mdoc->last->child = NULL;
1594 struct mdoc_node *nparent, *nprev; /* of the Bl block */
1595 struct mdoc_node *nblock, *nbody; /* of the Bl */
1596 struct mdoc_node *nchild, *nnext; /* of the Bl body */
1599 switch (nbody->type) {
1601 return(post_bl_block(mdoc));
1603 return(post_bl_head(mdoc));
1610 nchild = nbody->child;
1611 while (NULL != nchild) {
1612 if (MDOC_It == nchild->tok || MDOC_Sm == nchild->tok) {
1613 nchild = nchild->next;
1617 mdoc_nmsg(mdoc, nchild, MANDOCERR_CHILD);
1620 * Move the node out of the Bl block.
1621 * First, collect all required node pointers.
1624 nblock = nbody->parent;
1625 nprev = nblock->prev;
1626 nparent = nblock->parent;
1627 nnext = nchild->next;
1630 * Unlink this child.
1633 assert(NULL == nchild->prev);
1634 if (0 == --nbody->nchild) {
1635 nbody->child = NULL;
1637 assert(NULL == nnext);
1639 nbody->child = nnext;
1644 * Relink this child.
1647 nchild->parent = nparent;
1648 nchild->prev = nprev;
1649 nchild->next = nblock;
1651 nblock->prev = nchild;
1654 nparent->child = nchild;
1656 nprev->next = nchild;
1665 ebool(struct mdoc *mdoc)
1668 if (NULL == mdoc->last->child) {
1669 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY);
1670 mdoc_node_delete(mdoc, mdoc->last);
1673 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);
1675 assert(MDOC_TEXT == mdoc->last->child->type);
1677 if (0 == strcmp(mdoc->last->child->string, "on")) {
1678 if (MDOC_Sm == mdoc->last->tok)
1679 mdoc->flags &= ~MDOC_SMOFF;
1682 if (0 == strcmp(mdoc->last->child->string, "off")) {
1683 if (MDOC_Sm == mdoc->last->tok)
1684 mdoc->flags |= MDOC_SMOFF;
1688 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL);
1693 post_root(POST_ARGS)
1696 struct mdoc_node *n;
1700 /* Check that we have a finished prologue. */
1702 if ( ! (MDOC_PBODY & mdoc->flags)) {
1704 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1710 /* Check that we begin with a proper `Sh'. */
1712 if (NULL == n->child) {
1714 mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1715 } else if (MDOC_BLOCK != n->child->type ||
1716 MDOC_Sh != n->child->tok) {
1718 /* Can this be lifted? See rxdebug.1 for example. */
1719 mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1722 return(erc ? 0 : 1);
1728 struct mdoc_node *ch;
1731 if (NULL == (ch = mdoc->last->child)) {
1732 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY);
1733 mdoc_node_delete(mdoc, mdoc->last);
1737 assert(MDOC_TEXT == ch->type);
1739 if (NULL == (p = mdoc_a2st(ch->string))) {
1740 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD);
1741 mdoc_node_delete(mdoc, mdoc->last);
1744 ch->string = mandoc_strdup(p);
1753 struct mdoc_node *nn, *next, *prev;
1756 switch (mdoc->last->type) {
1758 check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0);
1761 if (mdoc->last->child)
1763 check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0);
1770 * Make sure only certain types of nodes are allowed within the
1771 * the `Rs' body. Delete offending nodes and raise a warning.
1772 * Do this before re-ordering for the sake of clarity.
1776 for (nn = mdoc->last->child; nn; nn = next) {
1777 for (i = 0; i < RSORD_MAX; i++)
1778 if (nn->tok == rsord[i])
1781 if (i < RSORD_MAX) {
1782 if (MDOC__J == rsord[i] || MDOC__B == rsord[i])
1783 mdoc->last->norm->Rs.quote_T++;
1789 mdoc_nmsg(mdoc, nn, MANDOCERR_CHILD);
1790 mdoc_node_delete(mdoc, nn);
1794 * Nothing to sort if only invalid nodes were found
1795 * inside the `Rs' body.
1798 if (NULL == mdoc->last->child)
1802 * The full `Rs' block needs special handling to order the
1803 * sub-elements according to `rsord'. Pick through each element
1804 * and correctly order it. This is a insertion sort.
1808 for (nn = mdoc->last->child->next; nn; nn = next) {
1809 /* Determine order of `nn'. */
1810 for (i = 0; i < RSORD_MAX; i++)
1811 if (rsord[i] == nn->tok)
1815 * Remove `nn' from the chain. This somewhat
1816 * repeats mdoc_node_unlink(), but since we're
1817 * just re-ordering, there's no need for the
1818 * full unlink process.
1821 if (NULL != (next = nn->next))
1822 next->prev = nn->prev;
1824 if (NULL != (prev = nn->prev))
1825 prev->next = nn->next;
1827 nn->prev = nn->next = NULL;
1830 * Scan back until we reach a node that's
1831 * ordered before `nn'.
1834 for ( ; prev ; prev = prev->prev) {
1835 /* Determine order of `prev'. */
1836 for (j = 0; j < RSORD_MAX; j++)
1837 if (rsord[j] == prev->tok)
1845 * Set `nn' back into its correct place in front
1846 * of the `prev' node.
1853 prev->next->prev = nn;
1854 nn->next = prev->next;
1857 mdoc->last->child->prev = nn;
1858 nn->next = mdoc->last->child;
1859 mdoc->last->child = nn;
1867 * For some arguments of some macros,
1868 * convert all breakable hyphens into ASCII_HYPH.
1871 post_hyph(POST_ARGS)
1873 struct mdoc_node *n, *nch;
1879 if (MDOC_Sh == n->tok || MDOC_Ss == n->tok)
1883 if (MDOC_D1 == n->tok || MDOC_Nd == n->tok)
1892 for (nch = n->child; nch; nch = nch->next) {
1893 if (MDOC_TEXT != nch->type)
1896 if (3 > strnlen(cp, 3))
1898 while ('\0' != *(++cp))
1900 isalpha((unsigned char)cp[-1]) &&
1901 isalpha((unsigned char)cp[1]))
1911 if (MDOC_LINE & mdoc->last->flags)
1912 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNNS);
1920 if (MDOC_HEAD == mdoc->last->type)
1921 return(post_sh_head(mdoc));
1922 if (MDOC_BODY == mdoc->last->type)
1923 return(post_sh_body(mdoc));
1929 post_sh_body(POST_ARGS)
1931 struct mdoc_node *n;
1933 if (SEC_NAME != mdoc->lastsec)
1937 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1938 * macros (can have multiple `Nm' and one `Nd'). Note that the
1939 * children of the BODY declaration can also be "text".
1942 if (NULL == (n = mdoc->last->child)) {
1943 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1947 for ( ; n && n->next; n = n->next) {
1948 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1950 if (MDOC_TEXT == n->type)
1952 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1956 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1959 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1964 post_sh_head(POST_ARGS)
1967 struct mdoc_node *n;
1972 * Process a new section. Sections are either "named" or
1973 * "custom". Custom sections are user-defined, while named ones
1974 * follow a conventional order and may only appear in certain
1980 if (-1 == (c = concat(buf, mdoc->last->child, BUFSIZ))) {
1981 mdoc_nmsg(mdoc, mdoc->last->child, MANDOCERR_MEM);
1986 /* The NAME should be first. */
1988 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1989 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST);
1991 /* The SYNOPSIS gets special attention in other areas. */
1993 if (SEC_SYNOPSIS == sec) {
1994 roff_setreg(mdoc->roff, "nS", 1, '=');
1995 mdoc->flags |= MDOC_SYNOPSIS;
1997 roff_setreg(mdoc->roff, "nS", 0, '=');
1998 mdoc->flags &= ~MDOC_SYNOPSIS;
2001 /* Mark our last section. */
2003 mdoc->lastsec = sec;
2006 * Set the section attribute for the current HEAD, for its
2007 * parent BLOCK, and for the HEAD children; the latter can
2008 * only be TEXT nodes, so no recursion is needed.
2009 * For other blocks and elements, including .Sh BODY, this is
2010 * done when allocating the node data structures, but for .Sh
2011 * BLOCK and HEAD, the section is still unknown at that time.
2014 mdoc->last->parent->sec = sec;
2015 mdoc->last->sec = sec;
2016 for (n = mdoc->last->child; n; n = n->next)
2019 /* We don't care about custom sections after this. */
2021 if (SEC_CUSTOM == sec)
2025 * Check whether our non-custom section is being repeated or is
2029 if (sec == mdoc->lastnamed)
2030 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP);
2032 if (sec < mdoc->lastnamed)
2033 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO);
2035 /* Mark the last named section. */
2037 mdoc->lastnamed = sec;
2039 /* Check particular section/manual conventions. */
2041 assert(mdoc->meta.msec);
2044 case (SEC_RETURN_VALUES):
2049 if (*mdoc->meta.msec == '2')
2051 if (*mdoc->meta.msec == '3')
2053 if (*mdoc->meta.msec == '9')
2055 mandoc_msg(MANDOCERR_SECMSEC, mdoc->parse,
2056 mdoc->last->line, mdoc->last->pos, buf);
2066 post_ignpar(POST_ARGS)
2068 struct mdoc_node *np;
2070 if (MDOC_BODY != mdoc->last->type)
2073 if (NULL != (np = mdoc->last->child))
2074 if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
2075 mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
2076 mdoc_node_delete(mdoc, np);
2079 if (NULL != (np = mdoc->last->last))
2080 if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
2081 mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
2082 mdoc_node_delete(mdoc, np);
2092 if (NULL == mdoc->last)
2094 if (MDOC_ELEM != n->type && MDOC_BLOCK != n->type)
2098 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
2099 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
2102 if (MDOC_Pp != mdoc->last->tok &&
2103 MDOC_Lp != mdoc->last->tok &&
2104 MDOC_br != mdoc->last->tok)
2106 if (MDOC_Bl == n->tok && n->norm->Bl.comp)
2108 if (MDOC_Bd == n->tok && n->norm->Bd.comp)
2110 if (MDOC_It == n->tok && n->parent->norm->Bl.comp)
2113 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR);
2114 mdoc_node_delete(mdoc, mdoc->last);
2122 if (MDOC_ELEM != mdoc->last->type &&
2123 MDOC_BLOCK != mdoc->last->type)
2126 if (NULL == mdoc->last->prev) {
2127 if (MDOC_Sh != mdoc->last->parent->tok &&
2128 MDOC_Ss != mdoc->last->parent->tok)
2131 if (MDOC_Pp != mdoc->last->prev->tok &&
2132 MDOC_Lp != mdoc->last->prev->tok &&
2133 (MDOC_br != mdoc->last->tok ||
2134 (MDOC_sp != mdoc->last->prev->tok &&
2135 MDOC_br != mdoc->last->prev->tok)))
2139 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR);
2140 mdoc_node_delete(mdoc, mdoc->last);
2145 pre_literal(PRE_ARGS)
2148 if (MDOC_BODY != n->type)
2152 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
2153 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
2158 mdoc->flags |= MDOC_LITERAL;
2161 if (DISP_literal == n->norm->Bd.type)
2162 mdoc->flags |= MDOC_LITERAL;
2163 if (DISP_unfilled == n->norm->Bd.type)
2164 mdoc->flags |= MDOC_LITERAL;
2178 struct mdoc_node *n;
2181 if (mdoc->meta.date)
2182 free(mdoc->meta.date);
2185 if (NULL == n->child || '\0' == n->child->string[0]) {
2186 mdoc->meta.date = mandoc_normdate
2187 (mdoc->parse, NULL, n->line, n->pos);
2192 if (-1 == (c = concat(buf, n->child, DATESIZE))) {
2193 mdoc_nmsg(mdoc, n->child, MANDOCERR_MEM);
2198 mdoc->meta.date = mandoc_normdate
2199 (mdoc->parse, buf, n->line, n->pos);
2207 struct mdoc_node *nn, *n;
2213 if (mdoc->meta.title)
2214 free(mdoc->meta.title);
2216 free(mdoc->meta.vol);
2217 if (mdoc->meta.arch)
2218 free(mdoc->meta.arch);
2220 mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL;
2222 /* First make all characters uppercase. */
2224 if (NULL != (nn = n->child))
2225 for (p = nn->string; *p; p++) {
2226 if (toupper((unsigned char)*p) == *p)
2230 * FIXME: don't be lazy: have this make all
2231 * characters be uppercase and just warn once.
2233 mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE);
2238 * --> title = unknown, volume = local, msec = 0, arch = NULL
2241 if (NULL == (nn = n->child)) {
2242 /* XXX: make these macro values. */
2243 /* FIXME: warn about missing values. */
2244 mdoc->meta.title = mandoc_strdup("UNKNOWN");
2245 mdoc->meta.vol = mandoc_strdup("LOCAL");
2246 mdoc->meta.msec = mandoc_strdup("1");
2250 /* Handles: `.Dt TITLE'
2251 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2254 mdoc->meta.title = mandoc_strdup
2255 ('\0' == nn->string[0] ? "UNKNOWN" : nn->string);
2257 if (NULL == (nn = nn->next)) {
2258 /* FIXME: warn about missing msec. */
2259 /* XXX: make this a macro value. */
2260 mdoc->meta.vol = mandoc_strdup("LOCAL");
2261 mdoc->meta.msec = mandoc_strdup("1");
2265 /* Handles: `.Dt TITLE SEC'
2266 * --> title = TITLE, volume = SEC is msec ?
2267 * format(msec) : SEC,
2268 * msec = SEC is msec ? atoi(msec) : 0,
2272 cp = mandoc_a2msec(nn->string);
2274 mdoc->meta.vol = mandoc_strdup(cp);
2275 mdoc->meta.msec = mandoc_strdup(nn->string);
2277 mdoc_nmsg(mdoc, n, MANDOCERR_BADMSEC);
2278 mdoc->meta.vol = mandoc_strdup(nn->string);
2279 mdoc->meta.msec = mandoc_strdup(nn->string);
2282 if (NULL == (nn = nn->next))
2285 /* Handles: `.Dt TITLE SEC VOL'
2286 * --> title = TITLE, volume = VOL is vol ?
2288 * VOL is arch ? format(arch) :
2292 cp = mdoc_a2vol(nn->string);
2294 free(mdoc->meta.vol);
2295 mdoc->meta.vol = mandoc_strdup(cp);
2297 cp = mdoc_a2arch(nn->string);
2299 mdoc_nmsg(mdoc, nn, MANDOCERR_BADVOLARCH);
2300 free(mdoc->meta.vol);
2301 mdoc->meta.vol = mandoc_strdup(nn->string);
2303 mdoc->meta.arch = mandoc_strdup(cp);
2306 /* Ignore any subsequent parameters... */
2307 /* FIXME: warn about subsequent parameters. */
2313 post_prol(POST_ARGS)
2316 * Remove prologue macros from the document after they're
2317 * processed. The final document uses mdoc_meta for these
2318 * values and discards the originals.
2321 mdoc_node_delete(mdoc, mdoc->last);
2322 if (mdoc->meta.title && mdoc->meta.date && mdoc->meta.os)
2323 mdoc->flags |= MDOC_PBODY;
2331 struct mdoc_node *n;
2334 * Make `Bx's second argument always start with an uppercase
2335 * letter. Groff checks if it's an "accepted" term, but we just
2336 * uppercase blindly.
2339 n = mdoc->last->child;
2340 if (n && NULL != (n = n->next))
2341 *n->string = (char)toupper
2342 ((unsigned char)*n->string);
2350 struct mdoc_node *n;
2354 struct utsname utsname;
2360 * Set the operating system by way of the `Os' macro.
2361 * The order of precedence is:
2362 * 1. the argument of the `Os' macro, unless empty
2363 * 2. the -Ios=foo command line argument, if provided
2364 * 3. -DOSNAME="\"foo\"", if provided during compilation
2365 * 4. "sysname release" from uname(3)
2368 free(mdoc->meta.os);
2371 if (-1 == (c = concat(buf, n->child, BUFSIZ))) {
2372 mdoc_nmsg(mdoc, n->child, MANDOCERR_MEM);
2378 if ('\0' == buf[0]) {
2380 mdoc->meta.os = mandoc_strdup(mdoc->defos);
2384 if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ) {
2385 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2389 if (-1 == uname(&utsname)) {
2390 mdoc_nmsg(mdoc, n, MANDOCERR_UNAME);
2391 mdoc->meta.os = mandoc_strdup("UNKNOWN");
2392 return(post_prol(mdoc));
2395 if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) {
2396 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2399 if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
2400 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2403 if (0 == strcmp(utsname.sysname, "FreeBSD"))
2404 strtok(utsname.release, "-");
2405 if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) {
2406 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2412 mdoc->meta.os = mandoc_strdup(buf);
2419 struct mdoc_node *nn, *n;
2424 * Macros accepting `-std' as an argument have the name of the
2425 * current document (`Nm') filled in as the argument if it's not
2432 if (NULL == mdoc->meta.name)
2436 mdoc->next = MDOC_NEXT_CHILD;
2438 if ( ! mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name))
2446 * Concatenate a node, stopping at the first non-text.
2447 * Concatenation is separated by a single whitespace.
2448 * Returns -1 on fatal (string overrun) error, 0 if child nodes were
2449 * encountered, 1 otherwise.
2452 concat(char *p, const struct mdoc_node *n, size_t sz)
2455 for ( ; NULL != n; n = n->next) {
2456 if (MDOC_TEXT != n->type)
2458 if ('\0' != p[0] && strlcat(p, " ", sz) >= sz)
2460 if (strlcat(p, n->string, sz) >= sz)
2462 concat(p, n->child, sz);
2468 static enum mdoc_sec
2469 a2sec(const char *p)
2473 for (i = 0; i < (int)SEC__MAX; i++)
2474 if (secnames[i] && 0 == strcmp(p, secnames[i]))
2475 return((enum mdoc_sec)i);
2481 macro2len(enum mdoct macro)