1 /* $Id: mdoc_validate.c,v 1.193 2013/09/16 00:25:07 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 #include <sys/utsname.h>
26 #include <sys/types.h>
39 #include "libmandoc.h"
41 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
43 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
44 #define POST_ARGS struct mdoc *mdoc
60 typedef int (*v_pre)(PRE_ARGS);
61 typedef int (*v_post)(POST_ARGS);
68 static int check_count(struct mdoc *, enum mdoc_type,
69 enum check_lvl, enum check_ineq, int);
70 static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
71 static void check_text(struct mdoc *, int, int, char *);
72 static void check_argv(struct mdoc *,
73 struct mdoc_node *, struct mdoc_argv *);
74 static void check_args(struct mdoc *, struct mdoc_node *);
75 static int concat(char *, const struct mdoc_node *, size_t);
76 static enum mdoc_sec a2sec(const char *);
77 static size_t macro2len(enum mdoct);
79 static int ebool(POST_ARGS);
80 static int berr_ge1(POST_ARGS);
81 static int bwarn_ge1(POST_ARGS);
82 static int ewarn_eq0(POST_ARGS);
83 static int ewarn_eq1(POST_ARGS);
84 static int ewarn_ge1(POST_ARGS);
85 static int ewarn_le1(POST_ARGS);
86 static int hwarn_eq0(POST_ARGS);
87 static int hwarn_eq1(POST_ARGS);
88 static int hwarn_ge1(POST_ARGS);
89 static int hwarn_le1(POST_ARGS);
91 static int post_an(POST_ARGS);
92 static int post_at(POST_ARGS);
93 static int post_bf(POST_ARGS);
94 static int post_bl(POST_ARGS);
95 static int post_bl_block(POST_ARGS);
96 static int post_bl_block_width(POST_ARGS);
97 static int post_bl_block_tag(POST_ARGS);
98 static int post_bl_head(POST_ARGS);
99 static int post_bx(POST_ARGS);
100 static int post_dd(POST_ARGS);
101 static int post_dt(POST_ARGS);
102 static int post_defaults(POST_ARGS);
103 static int post_literal(POST_ARGS);
104 static int post_eoln(POST_ARGS);
105 static int post_it(POST_ARGS);
106 static int post_lb(POST_ARGS);
107 static int post_nm(POST_ARGS);
108 static int post_ns(POST_ARGS);
109 static int post_os(POST_ARGS);
110 static int post_par(POST_ARGS);
111 static int post_ignpar(POST_ARGS);
112 static int post_prol(POST_ARGS);
113 static int post_root(POST_ARGS);
114 static int post_rs(POST_ARGS);
115 static int post_sh(POST_ARGS);
116 static int post_sh_body(POST_ARGS);
117 static int post_sh_head(POST_ARGS);
118 static int post_st(POST_ARGS);
119 static int post_std(POST_ARGS);
120 static int post_vt(POST_ARGS);
121 static int pre_an(PRE_ARGS);
122 static int pre_bd(PRE_ARGS);
123 static int pre_bl(PRE_ARGS);
124 static int pre_dd(PRE_ARGS);
125 static int pre_display(PRE_ARGS);
126 static int pre_dt(PRE_ARGS);
127 static int pre_it(PRE_ARGS);
128 static int pre_literal(PRE_ARGS);
129 static int pre_os(PRE_ARGS);
130 static int pre_par(PRE_ARGS);
131 static int pre_sh(PRE_ARGS);
132 static int pre_ss(PRE_ARGS);
133 static int pre_std(PRE_ARGS);
135 static v_post posts_an[] = { post_an, NULL };
136 static v_post posts_at[] = { post_at, post_defaults, NULL };
137 static v_post posts_bd[] = { post_literal, hwarn_eq0, bwarn_ge1, NULL };
138 static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
139 static v_post posts_bk[] = { hwarn_eq0, bwarn_ge1, NULL };
140 static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
141 static v_post posts_bx[] = { post_bx, NULL };
142 static v_post posts_bool[] = { ebool, NULL };
143 static v_post posts_eoln[] = { post_eoln, NULL };
144 static v_post posts_defaults[] = { post_defaults, NULL };
145 static v_post posts_dd[] = { post_dd, post_prol, NULL };
146 static v_post posts_dl[] = { post_literal, bwarn_ge1, NULL };
147 static v_post posts_dt[] = { post_dt, post_prol, NULL };
148 static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
149 static v_post posts_it[] = { post_it, NULL };
150 static v_post posts_lb[] = { post_lb, NULL };
151 static v_post posts_nd[] = { berr_ge1, NULL };
152 static v_post posts_nm[] = { post_nm, NULL };
153 static v_post posts_notext[] = { ewarn_eq0, NULL };
154 static v_post posts_ns[] = { post_ns, NULL };
155 static v_post posts_os[] = { post_os, post_prol, NULL };
156 static v_post posts_pp[] = { post_par, ewarn_eq0, NULL };
157 static v_post posts_rs[] = { post_rs, NULL };
158 static v_post posts_sh[] = { post_ignpar, hwarn_ge1, post_sh, NULL };
159 static v_post posts_sp[] = { post_par, ewarn_le1, NULL };
160 static v_post posts_ss[] = { post_ignpar, hwarn_ge1, NULL };
161 static v_post posts_st[] = { post_st, NULL };
162 static v_post posts_std[] = { post_std, NULL };
163 static v_post posts_text[] = { ewarn_ge1, NULL };
164 static v_post posts_text1[] = { ewarn_eq1, NULL };
165 static v_post posts_vt[] = { post_vt, NULL };
166 static v_post posts_wline[] = { bwarn_ge1, NULL };
167 static v_pre pres_an[] = { pre_an, NULL };
168 static v_pre pres_bd[] = { pre_display, pre_bd, pre_literal, pre_par, NULL };
169 static v_pre pres_bl[] = { pre_bl, pre_par, NULL };
170 static v_pre pres_d1[] = { pre_display, NULL };
171 static v_pre pres_dl[] = { pre_literal, pre_display, NULL };
172 static v_pre pres_dd[] = { pre_dd, NULL };
173 static v_pre pres_dt[] = { pre_dt, NULL };
174 static v_pre pres_er[] = { NULL, NULL };
175 static v_pre pres_fd[] = { NULL, NULL };
176 static v_pre pres_it[] = { pre_it, pre_par, NULL };
177 static v_pre pres_os[] = { pre_os, NULL };
178 static v_pre pres_pp[] = { pre_par, NULL };
179 static v_pre pres_sh[] = { pre_sh, NULL };
180 static v_pre pres_ss[] = { pre_ss, NULL };
181 static v_pre pres_std[] = { pre_std, NULL };
183 static const struct valids mdoc_valids[MDOC_MAX] = {
184 { NULL, NULL }, /* Ap */
185 { pres_dd, posts_dd }, /* Dd */
186 { pres_dt, posts_dt }, /* Dt */
187 { pres_os, posts_os }, /* Os */
188 { pres_sh, posts_sh }, /* Sh */
189 { pres_ss, posts_ss }, /* Ss */
190 { pres_pp, posts_pp }, /* Pp */
191 { pres_d1, posts_wline }, /* D1 */
192 { pres_dl, posts_dl }, /* Dl */
193 { pres_bd, posts_bd }, /* Bd */
194 { NULL, NULL }, /* Ed */
195 { pres_bl, posts_bl }, /* Bl */
196 { NULL, NULL }, /* El */
197 { pres_it, posts_it }, /* It */
198 { NULL, NULL }, /* Ad */
199 { pres_an, posts_an }, /* An */
200 { NULL, posts_defaults }, /* Ar */
201 { NULL, NULL }, /* Cd */
202 { NULL, NULL }, /* Cm */
203 { NULL, NULL }, /* Dv */
204 { pres_er, NULL }, /* Er */
205 { NULL, NULL }, /* Ev */
206 { pres_std, posts_std }, /* Ex */
207 { NULL, NULL }, /* Fa */
208 { pres_fd, posts_text }, /* Fd */
209 { NULL, NULL }, /* Fl */
210 { NULL, NULL }, /* Fn */
211 { NULL, NULL }, /* Ft */
212 { NULL, NULL }, /* Ic */
213 { NULL, posts_text1 }, /* In */
214 { NULL, posts_defaults }, /* Li */
215 { NULL, posts_nd }, /* Nd */
216 { NULL, posts_nm }, /* Nm */
217 { NULL, NULL }, /* Op */
218 { NULL, NULL }, /* Ot */
219 { NULL, posts_defaults }, /* Pa */
220 { pres_std, posts_std }, /* Rv */
221 { NULL, posts_st }, /* St */
222 { NULL, NULL }, /* Va */
223 { NULL, posts_vt }, /* Vt */
224 { NULL, posts_text }, /* Xr */
225 { NULL, posts_text }, /* %A */
226 { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
227 { NULL, posts_text }, /* %D */
228 { NULL, posts_text }, /* %I */
229 { NULL, posts_text }, /* %J */
230 { NULL, posts_text }, /* %N */
231 { NULL, posts_text }, /* %O */
232 { NULL, posts_text }, /* %P */
233 { NULL, posts_text }, /* %R */
234 { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
235 { NULL, posts_text }, /* %V */
236 { NULL, NULL }, /* Ac */
237 { NULL, NULL }, /* Ao */
238 { NULL, NULL }, /* Aq */
239 { NULL, posts_at }, /* At */
240 { NULL, NULL }, /* Bc */
241 { NULL, posts_bf }, /* Bf */
242 { NULL, NULL }, /* Bo */
243 { NULL, NULL }, /* Bq */
244 { NULL, NULL }, /* Bsx */
245 { NULL, posts_bx }, /* Bx */
246 { NULL, posts_bool }, /* Db */
247 { NULL, NULL }, /* Dc */
248 { NULL, NULL }, /* Do */
249 { NULL, NULL }, /* Dq */
250 { NULL, NULL }, /* Ec */
251 { NULL, NULL }, /* Ef */
252 { NULL, NULL }, /* Em */
253 { NULL, NULL }, /* Eo */
254 { NULL, NULL }, /* Fx */
255 { NULL, NULL }, /* Ms */
256 { NULL, posts_notext }, /* No */
257 { NULL, posts_ns }, /* Ns */
258 { NULL, NULL }, /* Nx */
259 { NULL, NULL }, /* Ox */
260 { NULL, NULL }, /* Pc */
261 { NULL, posts_text1 }, /* Pf */
262 { NULL, NULL }, /* Po */
263 { NULL, NULL }, /* Pq */
264 { NULL, NULL }, /* Qc */
265 { NULL, NULL }, /* Ql */
266 { NULL, NULL }, /* Qo */
267 { NULL, NULL }, /* Qq */
268 { NULL, NULL }, /* Re */
269 { NULL, posts_rs }, /* Rs */
270 { NULL, NULL }, /* Sc */
271 { NULL, NULL }, /* So */
272 { NULL, NULL }, /* Sq */
273 { NULL, posts_bool }, /* Sm */
274 { NULL, NULL }, /* Sx */
275 { NULL, NULL }, /* Sy */
276 { NULL, NULL }, /* Tn */
277 { NULL, NULL }, /* Ux */
278 { NULL, NULL }, /* Xc */
279 { NULL, NULL }, /* Xo */
280 { NULL, posts_fo }, /* Fo */
281 { NULL, NULL }, /* Fc */
282 { NULL, NULL }, /* Oo */
283 { NULL, NULL }, /* Oc */
284 { NULL, posts_bk }, /* Bk */
285 { NULL, NULL }, /* Ek */
286 { NULL, posts_eoln }, /* Bt */
287 { NULL, NULL }, /* Hf */
288 { NULL, NULL }, /* Fr */
289 { NULL, posts_eoln }, /* Ud */
290 { NULL, posts_lb }, /* Lb */
291 { pres_pp, posts_pp }, /* Lp */
292 { NULL, NULL }, /* Lk */
293 { NULL, posts_defaults }, /* Mt */
294 { NULL, NULL }, /* Brq */
295 { NULL, NULL }, /* Bro */
296 { NULL, NULL }, /* Brc */
297 { NULL, posts_text }, /* %C */
298 { NULL, NULL }, /* Es */
299 { NULL, NULL }, /* En */
300 { NULL, NULL }, /* Dx */
301 { NULL, posts_text }, /* %Q */
302 { NULL, posts_pp }, /* br */
303 { NULL, posts_sp }, /* sp */
304 { NULL, posts_text1 }, /* %U */
305 { NULL, NULL }, /* Ta */
308 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
310 static const enum mdoct rsord[RSORD_MAX] = {
327 static const char * const secnames[SEC__MAX] = {
333 "IMPLEMENTATION NOTES",
348 "SECURITY CONSIDERATIONS",
353 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
364 check_text(mdoc, line, pos, tp);
378 if (NULL == mdoc_valids[n->tok].pre)
380 for (p = mdoc_valids[n->tok].pre; *p; p++)
381 if ( ! (*p)(mdoc, n))
388 mdoc_valid_post(struct mdoc *mdoc)
392 if (MDOC_VALID & mdoc->last->flags)
394 mdoc->last->flags |= MDOC_VALID;
396 switch (mdoc->last->type) {
404 return(post_root(mdoc));
409 if (NULL == mdoc_valids[mdoc->last->tok].post)
411 for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
419 check_count(struct mdoc *mdoc, enum mdoc_type type,
420 enum check_lvl lvl, enum check_ineq ineq, int val)
425 if (mdoc->last->type != type)
431 if (mdoc->last->nchild < val)
436 if (mdoc->last->nchild > val)
441 if (val == mdoc->last->nchild)
449 t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT;
450 mandoc_vmsg(t, mdoc->parse, mdoc->last->line, mdoc->last->pos,
451 "want %s%d children (have %d)",
452 p, val, mdoc->last->nchild);
460 return(check_count(mdoc, MDOC_BODY, CHECK_ERROR, CHECK_GT, 0));
466 return(check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0));
472 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0));
478 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1));
484 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0));
490 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2));
496 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0));
502 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 1));
508 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_GT, 0));
514 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_LT, 2));
518 check_args(struct mdoc *mdoc, struct mdoc_node *n)
525 assert(n->args->argc);
526 for (i = 0; i < (int)n->args->argc; i++)
527 check_argv(mdoc, n, &n->args->argv[i]);
531 check_argv(struct mdoc *mdoc, struct mdoc_node *n, struct mdoc_argv *v)
535 for (i = 0; i < (int)v->sz; i++)
536 check_text(mdoc, v->line, v->pos, v->value[i]);
538 /* FIXME: move to post_std(). */
540 if (MDOC_Std == v->arg)
541 if ( ! (v->sz || mdoc->meta.name))
542 mdoc_nmsg(mdoc, n, MANDOCERR_NONAME);
546 check_text(struct mdoc *mdoc, int ln, int pos, char *p)
550 if (MDOC_LITERAL & mdoc->flags)
553 for (cp = p; NULL != (p = strchr(p, '\t')); p++)
554 mdoc_pmsg(mdoc, ln, pos + (int)(p - cp), MANDOCERR_BADTAB);
558 check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
562 if ((MDOC_ROOT == t || tok == n->parent->tok) &&
563 (t == n->parent->type))
566 mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse, n->line,
567 n->pos, "want parent %s", MDOC_ROOT == t ?
568 "<root>" : mdoc_macronames[tok]);
574 pre_display(PRE_ARGS)
576 struct mdoc_node *node;
578 if (MDOC_BLOCK != n->type)
581 for (node = mdoc->last->parent; node; node = node->parent)
582 if (MDOC_BLOCK == node->type)
583 if (MDOC_Bd == node->tok)
587 mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP);
597 const char *offs, *width;
599 struct mdoc_node *np;
601 if (MDOC_BLOCK != n->type) {
602 if (ENDBODY_NOT != n->end) {
604 np = n->pending->parent;
609 assert(MDOC_BLOCK == np->type);
610 assert(MDOC_Bl == np->tok);
615 * First figure out which kind of list to use: bind ourselves to
616 * the first mentioned list type and warn about any remaining
617 * ones. If we find no list type, we default to LIST_item.
621 for (i = 0; n->args && i < (int)n->args->argc; i++) {
625 switch (n->args->argv[i].arg) {
626 /* Set list types. */
660 /* Set list arguments. */
662 dup = n->norm->Bl.comp;
666 /* NB: this can be empty! */
667 if (n->args->argv[i].sz) {
668 width = n->args->argv[i].value[0];
669 dup = (NULL != n->norm->Bl.width);
672 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
675 /* NB: this can be empty! */
676 if (n->args->argv[i].sz) {
677 offs = n->args->argv[i].value[0];
678 dup = (NULL != n->norm->Bl.offs);
681 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
687 /* Check: duplicate auxiliary arguments. */
690 mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
693 n->norm->Bl.comp = comp;
695 n->norm->Bl.offs = offs;
697 n->norm->Bl.width = width;
699 /* Check: multiple list types. */
701 if (LIST__NONE != lt && n->norm->Bl.type != LIST__NONE)
702 mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP);
704 /* Assign list type. */
706 if (LIST__NONE != lt && n->norm->Bl.type == LIST__NONE) {
707 n->norm->Bl.type = lt;
708 /* Set column information, too. */
709 if (LIST_column == lt) {
712 n->norm->Bl.cols = (void *)
713 n->args->argv[i].value;
717 /* The list type should come first. */
719 if (n->norm->Bl.type == LIST__NONE)
720 if (n->norm->Bl.width ||
723 mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST);
728 /* Allow lists to default to LIST_item. */
730 if (LIST__NONE == n->norm->Bl.type) {
731 mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);
732 n->norm->Bl.type = LIST_item;
736 * Validate the width field. Some list types don't need width
737 * types and should be warned about them. Others should have it
738 * and must also be warned. Yet others have a default and need
742 switch (n->norm->Bl.type) {
744 if (NULL == n->norm->Bl.width)
745 mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG);
756 if (n->norm->Bl.width)
757 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
764 if (NULL == n->norm->Bl.width)
765 n->norm->Bl.width = "2n";
768 if (NULL == n->norm->Bl.width)
769 n->norm->Bl.width = "3n";
785 struct mdoc_node *np;
787 if (MDOC_BLOCK != n->type) {
788 if (ENDBODY_NOT != n->end) {
790 np = n->pending->parent;
795 assert(MDOC_BLOCK == np->type);
796 assert(MDOC_Bd == np->tok);
801 for (i = 0; n->args && i < (int)n->args->argc; i++) {
806 switch (n->args->argv[i].arg) {
813 case (MDOC_Unfilled):
823 mdoc_nmsg(mdoc, n, MANDOCERR_BADDISP);
826 /* NB: this can be empty! */
827 if (n->args->argv[i].sz) {
828 offs = n->args->argv[i].value[0];
829 dup = (NULL != n->norm->Bd.offs);
832 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
836 dup = n->norm->Bd.comp;
843 /* Check whether we have duplicates. */
846 mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
848 /* Make our auxiliary assignments. */
851 n->norm->Bd.offs = offs;
853 n->norm->Bd.comp = comp;
855 /* Check whether a type has already been assigned. */
857 if (DISP__NONE != dt && n->norm->Bd.type != DISP__NONE)
858 mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP);
860 /* Make our type assignment. */
862 if (DISP__NONE != dt && n->norm->Bd.type == DISP__NONE)
863 n->norm->Bd.type = dt;
866 if (DISP__NONE == n->norm->Bd.type) {
867 mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
868 n->norm->Bd.type = DISP_ragged;
879 if (MDOC_BLOCK != n->type)
881 return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
889 if (MDOC_BLOCK != n->type)
892 roff_regunset(mdoc->roff, REG_nS);
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);
1128 if (NULL != mdoc->meta.name)
1131 /* Try to use our children for setting the meta name. */
1133 if (NULL != mdoc->last->child) {
1135 c = concat(buf, mdoc->last->child, BUFSIZ);
1141 mdoc_nmsg(mdoc, mdoc->last->child, MANDOCERR_MEM);
1144 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME);
1145 mdoc->meta.name = mandoc_strdup("UNKNOWN");
1148 mdoc->meta.name = mandoc_strdup(buf);
1155 post_literal(POST_ARGS)
1159 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1160 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1161 * this in literal mode, but it doesn't hurt to just switch it
1162 * off in general since displays can't be nested.
1165 if (MDOC_BODY == mdoc->last->type)
1166 mdoc->flags &= ~MDOC_LITERAL;
1172 post_defaults(POST_ARGS)
1174 struct mdoc_node *nn;
1177 * The `Ar' defaults to "file ..." if no value is provided as an
1178 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1179 * gets an empty string.
1182 if (mdoc->last->child)
1186 mdoc->next = MDOC_NEXT_CHILD;
1190 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "file"))
1192 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))
1196 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "AT&T"))
1198 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "UNIX"))
1202 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))
1208 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"))
1228 * If we have a child, look it up in the standard keys. If a
1229 * key exist, use that instead of the child; if it doesn't,
1230 * prefix "AT&T UNIX " to the existing data.
1233 if (NULL == mdoc->last->child)
1236 assert(MDOC_TEXT == mdoc->last->child->type);
1237 p = mdoc_a2att(mdoc->last->child->string);
1240 free(mdoc->last->child->string);
1241 mdoc->last->child->string = mandoc_strdup(p);
1243 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT);
1245 q = mdoc->last->child->string;
1246 sz = strlen(p) + strlen(q) + 1;
1247 buf = mandoc_malloc(sz);
1248 strlcpy(buf, p, sz);
1249 strlcat(buf, q, sz);
1250 free(mdoc->last->child->string);
1251 mdoc->last->child->string = buf;
1260 struct mdoc_node *np;
1263 if (AUTH__NONE == np->norm->An.auth) {
1265 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0);
1266 } else if (np->child)
1267 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0);
1278 struct mdoc_node *n, *c;
1281 if (MDOC_BLOCK != mdoc->last->type)
1284 n = mdoc->last->parent->parent;
1285 lt = n->norm->Bl.type;
1287 if (LIST__NONE == lt) {
1288 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
1294 if (mdoc->last->head->child)
1296 /* FIXME: give this a dummy value. */
1297 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1306 if (NULL == mdoc->last->head->child)
1307 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1316 if (NULL == mdoc->last->body->child)
1317 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1320 if (mdoc->last->head->child)
1321 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1324 cols = (int)n->norm->Bl.ncols;
1326 assert(NULL == mdoc->last->head->child);
1328 if (NULL == mdoc->last->body->child)
1329 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1331 for (i = 0, c = mdoc->last->child; c; c = c->next)
1332 if (MDOC_BODY == c->type)
1336 er = MANDOCERR_ARGCOUNT;
1337 else if (i == cols || i == cols + 1)
1340 er = MANDOCERR_SYNTARGCOUNT;
1342 mandoc_vmsg(er, mdoc->parse, mdoc->last->line,
1344 "columns == %d (have %d)", cols, i);
1345 return(MANDOCERR_ARGCOUNT == er);
1354 post_bl_block(POST_ARGS)
1356 struct mdoc_node *n, *ni, *nc;
1359 * These are fairly complicated, so we've broken them into two
1360 * functions. post_bl_block_tag() is called when a -tag is
1361 * specified, but no -width (it must be guessed). The second
1362 * when a -width is specified (macro indicators must be
1363 * rewritten into real lengths).
1368 if (LIST_tag == n->norm->Bl.type &&
1369 NULL == n->norm->Bl.width) {
1370 if ( ! post_bl_block_tag(mdoc))
1372 assert(n->norm->Bl.width);
1373 } else if (NULL != n->norm->Bl.width) {
1374 if ( ! post_bl_block_width(mdoc))
1376 assert(n->norm->Bl.width);
1379 for (ni = n->body->child; ni; ni = ni->next) {
1380 if (NULL == ni->body)
1382 nc = ni->body->last;
1383 while (NULL != nc) {
1395 if (NULL == ni->next) {
1396 mdoc_nmsg(mdoc, nc, MANDOCERR_MOVEPAR);
1397 if ( ! mdoc_node_relink(mdoc, nc))
1399 } else if (0 == n->norm->Bl.comp &&
1400 LIST_column != n->norm->Bl.type) {
1401 mdoc_nmsg(mdoc, nc, MANDOCERR_IGNPAR);
1402 mdoc_node_delete(mdoc, nc);
1405 nc = ni->body->last;
1412 post_bl_block_width(POST_ARGS)
1417 struct mdoc_node *n;
1423 * Calculate the real width of a list from the -width string,
1424 * which may contain a macro (with a known default width), a
1425 * literal string, or a scaling width.
1427 * If the value to -width is a macro, then we re-write it to be
1428 * the macro's width as set in share/tmac/mdoc/doc-common.
1431 if (0 == strcmp(n->norm->Bl.width, "Ds"))
1433 else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))
1435 else if (0 == (width = macro2len(tok))) {
1436 mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH);
1440 /* The value already exists: free and reallocate it. */
1444 for (i = 0; i < (int)n->args->argc; i++)
1445 if (MDOC_Width == n->args->argv[i].arg)
1448 assert(i < (int)n->args->argc);
1450 snprintf(buf, NUMSIZ, "%un", (unsigned int)width);
1451 free(n->args->argv[i].value[0]);
1452 n->args->argv[i].value[0] = mandoc_strdup(buf);
1454 /* Set our width! */
1455 n->norm->Bl.width = n->args->argv[i].value[0];
1460 post_bl_block_tag(POST_ARGS)
1462 struct mdoc_node *n, *nn;
1468 * Calculate the -width for a `Bl -tag' list if it hasn't been
1469 * provided. Uses the first head macro. NOTE AGAIN: this is
1470 * ONLY if the -width argument has NOT been provided. See
1471 * post_bl_block_width() for converting the -width string.
1477 for (nn = n->body->child; nn; nn = nn->next) {
1478 if (MDOC_It != nn->tok)
1481 assert(MDOC_BLOCK == nn->type);
1482 nn = nn->head->child;
1487 if (MDOC_TEXT == nn->type) {
1488 sz = strlen(nn->string) + 1;
1492 if (0 != (ssz = macro2len(nn->tok)))
1498 /* Defaults to ten ens. */
1500 snprintf(buf, NUMSIZ, "%un", (unsigned int)sz);
1503 * We have to dynamically add this to the macro's argument list.
1504 * We're guaranteed that a MDOC_Width doesn't already exist.
1508 i = (int)(n->args->argc)++;
1510 n->args->argv = mandoc_realloc(n->args->argv,
1511 n->args->argc * sizeof(struct mdoc_argv));
1513 n->args->argv[i].arg = MDOC_Width;
1514 n->args->argv[i].line = n->line;
1515 n->args->argv[i].pos = n->pos;
1516 n->args->argv[i].sz = 1;
1517 n->args->argv[i].value = mandoc_malloc(sizeof(char *));
1518 n->args->argv[i].value[0] = mandoc_strdup(buf);
1520 /* Set our width! */
1521 n->norm->Bl.width = n->args->argv[i].value[0];
1527 post_bl_head(POST_ARGS)
1529 struct mdoc_node *np, *nn, *nnp;
1532 if (LIST_column != mdoc->last->norm->Bl.type)
1533 /* FIXME: this should be ERROR class... */
1534 return(hwarn_eq0(mdoc));
1537 * Convert old-style lists, where the column width specifiers
1538 * trail as macro parameters, to the new-style ("normal-form")
1539 * lists where they're argument values following -column.
1542 /* First, disallow both types and allow normal-form. */
1545 * TODO: technically, we can accept both and just merge the two
1546 * lists, but I'll leave that for another day.
1549 if (mdoc->last->norm->Bl.ncols && mdoc->last->nchild) {
1550 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS);
1552 } else if (NULL == mdoc->last->child)
1555 np = mdoc->last->parent;
1558 for (j = 0; j < (int)np->args->argc; j++)
1559 if (MDOC_Column == np->args->argv[j].arg)
1562 assert(j < (int)np->args->argc);
1563 assert(0 == np->args->argv[j].sz);
1566 * Accommodate for new-style groff column syntax. Shuffle the
1567 * child nodes, all of which must be TEXT, as arguments for the
1568 * column field. Then, delete the head children.
1571 np->args->argv[j].sz = (size_t)mdoc->last->nchild;
1572 np->args->argv[j].value = mandoc_malloc
1573 ((size_t)mdoc->last->nchild * sizeof(char *));
1575 mdoc->last->norm->Bl.ncols = np->args->argv[j].sz;
1576 mdoc->last->norm->Bl.cols = (void *)np->args->argv[j].value;
1578 for (i = 0, nn = mdoc->last->child; nn; i++) {
1579 np->args->argv[j].value[i] = nn->string;
1583 mdoc_node_delete(NULL, nnp);
1586 mdoc->last->nchild = 0;
1587 mdoc->last->child = NULL;
1595 struct mdoc_node *n;
1597 if (MDOC_HEAD == mdoc->last->type)
1598 return(post_bl_head(mdoc));
1599 if (MDOC_BLOCK == mdoc->last->type)
1600 return(post_bl_block(mdoc));
1601 if (MDOC_BODY != mdoc->last->type)
1604 for (n = mdoc->last->child; n; n = n->next) {
1609 mdoc_nmsg(mdoc, n, MANDOCERR_CHILD);
1619 mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD);
1627 ebool(struct mdoc *mdoc)
1630 if (NULL == mdoc->last->child) {
1631 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY);
1632 mdoc_node_delete(mdoc, mdoc->last);
1635 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);
1637 assert(MDOC_TEXT == mdoc->last->child->type);
1639 if (0 == strcmp(mdoc->last->child->string, "on"))
1641 if (0 == strcmp(mdoc->last->child->string, "off"))
1644 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL);
1649 post_root(POST_ARGS)
1652 struct mdoc_node *n;
1656 /* Check that we have a finished prologue. */
1658 if ( ! (MDOC_PBODY & mdoc->flags)) {
1660 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1666 /* Check that we begin with a proper `Sh'. */
1668 if (NULL == n->child) {
1670 mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1671 } else if (MDOC_BLOCK != n->child->type ||
1672 MDOC_Sh != n->child->tok) {
1674 /* Can this be lifted? See rxdebug.1 for example. */
1675 mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1678 return(erc ? 0 : 1);
1684 struct mdoc_node *ch;
1687 if (NULL == (ch = mdoc->last->child)) {
1688 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY);
1689 mdoc_node_delete(mdoc, mdoc->last);
1693 assert(MDOC_TEXT == ch->type);
1695 if (NULL == (p = mdoc_a2st(ch->string))) {
1696 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD);
1697 mdoc_node_delete(mdoc, mdoc->last);
1700 ch->string = mandoc_strdup(p);
1709 struct mdoc_node *nn, *next, *prev;
1712 switch (mdoc->last->type) {
1714 check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0);
1717 if (mdoc->last->child)
1719 check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0);
1726 * Make sure only certain types of nodes are allowed within the
1727 * the `Rs' body. Delete offending nodes and raise a warning.
1728 * Do this before re-ordering for the sake of clarity.
1732 for (nn = mdoc->last->child; nn; nn = next) {
1733 for (i = 0; i < RSORD_MAX; i++)
1734 if (nn->tok == rsord[i])
1737 if (i < RSORD_MAX) {
1738 if (MDOC__J == rsord[i] || MDOC__B == rsord[i])
1739 mdoc->last->norm->Rs.quote_T++;
1745 mdoc_nmsg(mdoc, nn, MANDOCERR_CHILD);
1746 mdoc_node_delete(mdoc, nn);
1750 * Nothing to sort if only invalid nodes were found
1751 * inside the `Rs' body.
1754 if (NULL == mdoc->last->child)
1758 * The full `Rs' block needs special handling to order the
1759 * sub-elements according to `rsord'. Pick through each element
1760 * and correctly order it. This is a insertion sort.
1764 for (nn = mdoc->last->child->next; nn; nn = next) {
1765 /* Determine order of `nn'. */
1766 for (i = 0; i < RSORD_MAX; i++)
1767 if (rsord[i] == nn->tok)
1771 * Remove `nn' from the chain. This somewhat
1772 * repeats mdoc_node_unlink(), but since we're
1773 * just re-ordering, there's no need for the
1774 * full unlink process.
1777 if (NULL != (next = nn->next))
1778 next->prev = nn->prev;
1780 if (NULL != (prev = nn->prev))
1781 prev->next = nn->next;
1783 nn->prev = nn->next = NULL;
1786 * Scan back until we reach a node that's
1787 * ordered before `nn'.
1790 for ( ; prev ; prev = prev->prev) {
1791 /* Determine order of `prev'. */
1792 for (j = 0; j < RSORD_MAX; j++)
1793 if (rsord[j] == prev->tok)
1801 * Set `nn' back into its correct place in front
1802 * of the `prev' node.
1809 prev->next->prev = nn;
1810 nn->next = prev->next;
1813 mdoc->last->child->prev = nn;
1814 nn->next = mdoc->last->child;
1815 mdoc->last->child = nn;
1826 if (MDOC_LINE & mdoc->last->flags)
1827 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNNS);
1835 if (MDOC_HEAD == mdoc->last->type)
1836 return(post_sh_head(mdoc));
1837 if (MDOC_BODY == mdoc->last->type)
1838 return(post_sh_body(mdoc));
1844 post_sh_body(POST_ARGS)
1846 struct mdoc_node *n;
1848 if (SEC_NAME != mdoc->lastsec)
1852 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1853 * macros (can have multiple `Nm' and one `Nd'). Note that the
1854 * children of the BODY declaration can also be "text".
1857 if (NULL == (n = mdoc->last->child)) {
1858 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1862 for ( ; n && n->next; n = n->next) {
1863 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1865 if (MDOC_TEXT == n->type)
1867 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1871 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1874 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1879 post_sh_head(POST_ARGS)
1882 struct mdoc_node *n;
1887 * Process a new section. Sections are either "named" or
1888 * "custom". Custom sections are user-defined, while named ones
1889 * follow a conventional order and may only appear in certain
1895 if (-1 == (c = concat(buf, mdoc->last->child, BUFSIZ))) {
1896 mdoc_nmsg(mdoc, mdoc->last->child, MANDOCERR_MEM);
1901 /* The NAME should be first. */
1903 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1904 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST);
1906 /* The SYNOPSIS gets special attention in other areas. */
1908 if (SEC_SYNOPSIS == sec)
1909 mdoc->flags |= MDOC_SYNOPSIS;
1911 mdoc->flags &= ~MDOC_SYNOPSIS;
1913 /* Mark our last section. */
1915 mdoc->lastsec = sec;
1918 * Set the section attribute for the current HEAD, for its
1919 * parent BLOCK, and for the HEAD children; the latter can
1920 * only be TEXT nodes, so no recursion is needed.
1921 * For other blocks and elements, including .Sh BODY, this is
1922 * done when allocating the node data structures, but for .Sh
1923 * BLOCK and HEAD, the section is still unknown at that time.
1926 mdoc->last->parent->sec = sec;
1927 mdoc->last->sec = sec;
1928 for (n = mdoc->last->child; n; n = n->next)
1931 /* We don't care about custom sections after this. */
1933 if (SEC_CUSTOM == sec)
1937 * Check whether our non-custom section is being repeated or is
1941 if (sec == mdoc->lastnamed)
1942 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP);
1944 if (sec < mdoc->lastnamed)
1945 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO);
1947 /* Mark the last named section. */
1949 mdoc->lastnamed = sec;
1951 /* Check particular section/manual conventions. */
1953 assert(mdoc->meta.msec);
1956 case (SEC_RETURN_VALUES):
1961 if (*mdoc->meta.msec == '2')
1963 if (*mdoc->meta.msec == '3')
1965 if (*mdoc->meta.msec == '9')
1967 mandoc_msg(MANDOCERR_SECMSEC, mdoc->parse,
1968 mdoc->last->line, mdoc->last->pos, buf);
1978 post_ignpar(POST_ARGS)
1980 struct mdoc_node *np;
1982 if (MDOC_BODY != mdoc->last->type)
1985 if (NULL != (np = mdoc->last->child))
1986 if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
1987 mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
1988 mdoc_node_delete(mdoc, np);
1991 if (NULL != (np = mdoc->last->last))
1992 if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
1993 mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
1994 mdoc_node_delete(mdoc, np);
2004 if (NULL == mdoc->last)
2006 if (MDOC_ELEM != n->type && MDOC_BLOCK != n->type)
2010 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
2011 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
2014 if (MDOC_Pp != mdoc->last->tok &&
2015 MDOC_Lp != mdoc->last->tok &&
2016 MDOC_br != mdoc->last->tok)
2018 if (MDOC_Bl == n->tok && n->norm->Bl.comp)
2020 if (MDOC_Bd == n->tok && n->norm->Bd.comp)
2022 if (MDOC_It == n->tok && n->parent->norm->Bl.comp)
2025 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR);
2026 mdoc_node_delete(mdoc, mdoc->last);
2034 if (MDOC_ELEM != mdoc->last->type &&
2035 MDOC_BLOCK != mdoc->last->type)
2038 if (NULL == mdoc->last->prev) {
2039 if (MDOC_Sh != mdoc->last->parent->tok &&
2040 MDOC_Ss != mdoc->last->parent->tok)
2043 if (MDOC_Pp != mdoc->last->prev->tok &&
2044 MDOC_Lp != mdoc->last->prev->tok &&
2045 (MDOC_br != mdoc->last->tok ||
2046 (MDOC_sp != mdoc->last->prev->tok &&
2047 MDOC_br != mdoc->last->prev->tok)))
2051 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR);
2052 mdoc_node_delete(mdoc, mdoc->last);
2057 pre_literal(PRE_ARGS)
2060 if (MDOC_BODY != n->type)
2064 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
2065 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
2070 mdoc->flags |= MDOC_LITERAL;
2073 if (DISP_literal == n->norm->Bd.type)
2074 mdoc->flags |= MDOC_LITERAL;
2075 if (DISP_unfilled == n->norm->Bd.type)
2076 mdoc->flags |= MDOC_LITERAL;
2090 struct mdoc_node *n;
2093 if (mdoc->meta.date)
2094 free(mdoc->meta.date);
2097 if (NULL == n->child || '\0' == n->child->string[0]) {
2098 mdoc->meta.date = mandoc_normdate
2099 (mdoc->parse, NULL, n->line, n->pos);
2104 if (-1 == (c = concat(buf, n->child, DATESIZE))) {
2105 mdoc_nmsg(mdoc, n->child, MANDOCERR_MEM);
2110 mdoc->meta.date = mandoc_normdate
2111 (mdoc->parse, buf, n->line, n->pos);
2119 struct mdoc_node *nn, *n;
2125 if (mdoc->meta.title)
2126 free(mdoc->meta.title);
2128 free(mdoc->meta.vol);
2129 if (mdoc->meta.arch)
2130 free(mdoc->meta.arch);
2132 mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL;
2134 /* First make all characters uppercase. */
2136 if (NULL != (nn = n->child))
2137 for (p = nn->string; *p; p++) {
2138 if (toupper((unsigned char)*p) == *p)
2142 * FIXME: don't be lazy: have this make all
2143 * characters be uppercase and just warn once.
2145 mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE);
2150 * --> title = unknown, volume = local, msec = 0, arch = NULL
2153 if (NULL == (nn = n->child)) {
2154 /* XXX: make these macro values. */
2155 /* FIXME: warn about missing values. */
2156 mdoc->meta.title = mandoc_strdup("UNKNOWN");
2157 mdoc->meta.vol = mandoc_strdup("LOCAL");
2158 mdoc->meta.msec = mandoc_strdup("1");
2162 /* Handles: `.Dt TITLE'
2163 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2166 mdoc->meta.title = mandoc_strdup
2167 ('\0' == nn->string[0] ? "UNKNOWN" : nn->string);
2169 if (NULL == (nn = nn->next)) {
2170 /* FIXME: warn about missing msec. */
2171 /* XXX: make this a macro value. */
2172 mdoc->meta.vol = mandoc_strdup("LOCAL");
2173 mdoc->meta.msec = mandoc_strdup("1");
2177 /* Handles: `.Dt TITLE SEC'
2178 * --> title = TITLE, volume = SEC is msec ?
2179 * format(msec) : SEC,
2180 * msec = SEC is msec ? atoi(msec) : 0,
2184 cp = mandoc_a2msec(nn->string);
2186 mdoc->meta.vol = mandoc_strdup(cp);
2187 mdoc->meta.msec = mandoc_strdup(nn->string);
2189 mdoc_nmsg(mdoc, n, MANDOCERR_BADMSEC);
2190 mdoc->meta.vol = mandoc_strdup(nn->string);
2191 mdoc->meta.msec = mandoc_strdup(nn->string);
2194 if (NULL == (nn = nn->next))
2197 /* Handles: `.Dt TITLE SEC VOL'
2198 * --> title = TITLE, volume = VOL is vol ?
2200 * VOL is arch ? format(arch) :
2204 cp = mdoc_a2vol(nn->string);
2206 free(mdoc->meta.vol);
2207 mdoc->meta.vol = mandoc_strdup(cp);
2209 cp = mdoc_a2arch(nn->string);
2211 mdoc_nmsg(mdoc, nn, MANDOCERR_BADVOLARCH);
2212 free(mdoc->meta.vol);
2213 mdoc->meta.vol = mandoc_strdup(nn->string);
2215 mdoc->meta.arch = mandoc_strdup(cp);
2218 /* Ignore any subsequent parameters... */
2219 /* FIXME: warn about subsequent parameters. */
2225 post_prol(POST_ARGS)
2228 * Remove prologue macros from the document after they're
2229 * processed. The final document uses mdoc_meta for these
2230 * values and discards the originals.
2233 mdoc_node_delete(mdoc, mdoc->last);
2234 if (mdoc->meta.title && mdoc->meta.date && mdoc->meta.os)
2235 mdoc->flags |= MDOC_PBODY;
2243 struct mdoc_node *n;
2246 * Make `Bx's second argument always start with an uppercase
2247 * letter. Groff checks if it's an "accepted" term, but we just
2248 * uppercase blindly.
2251 n = mdoc->last->child;
2252 if (n && NULL != (n = n->next))
2253 *n->string = (char)toupper
2254 ((unsigned char)*n->string);
2262 struct mdoc_node *n;
2266 struct utsname utsname;
2272 * Set the operating system by way of the `Os' macro.
2273 * The order of precedence is:
2274 * 1. the argument of the `Os' macro, unless empty
2275 * 2. the -Ios=foo command line argument, if provided
2276 * 3. -DOSNAME="\"foo\"", if provided during compilation
2277 * 4. "sysname release" from uname(3)
2280 free(mdoc->meta.os);
2283 if (-1 == (c = concat(buf, n->child, BUFSIZ))) {
2284 mdoc_nmsg(mdoc, n->child, MANDOCERR_MEM);
2290 if ('\0' == buf[0]) {
2292 mdoc->meta.os = mandoc_strdup(mdoc->defos);
2296 if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ) {
2297 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2301 if (-1 == uname(&utsname)) {
2302 mdoc_nmsg(mdoc, n, MANDOCERR_UNAME);
2303 mdoc->meta.os = mandoc_strdup("UNKNOWN");
2304 return(post_prol(mdoc));
2307 if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) {
2308 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2311 if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
2312 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2315 if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) {
2316 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2322 mdoc->meta.os = mandoc_strdup(buf);
2329 struct mdoc_node *nn, *n;
2334 * Macros accepting `-std' as an argument have the name of the
2335 * current document (`Nm') filled in as the argument if it's not
2342 if (NULL == mdoc->meta.name)
2346 mdoc->next = MDOC_NEXT_CHILD;
2348 if ( ! mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name))
2356 * Concatenate a node, stopping at the first non-text.
2357 * Concatenation is separated by a single whitespace.
2358 * Returns -1 on fatal (string overrun) error, 0 if child nodes were
2359 * encountered, 1 otherwise.
2362 concat(char *p, const struct mdoc_node *n, size_t sz)
2365 for ( ; NULL != n; n = n->next) {
2366 if (MDOC_TEXT != n->type)
2368 if ('\0' != p[0] && strlcat(p, " ", sz) >= sz)
2370 if (strlcat(p, n->string, sz) >= sz)
2372 concat(p, n->child, sz);
2378 static enum mdoc_sec
2379 a2sec(const char *p)
2383 for (i = 0; i < (int)SEC__MAX; i++)
2384 if (secnames[i] && 0 == strcmp(p, secnames[i]))
2385 return((enum mdoc_sec)i);
2391 macro2len(enum mdoct macro)