1 /* $Id: mdoc_validate.c,v 1.166 2011/04/03 09:53:50 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 #include <sys/utsname.h>
26 #include <sys/types.h>
39 #include "libmandoc.h"
41 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
43 #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
44 #define POST_ARGS struct mdoc *mdoc
60 typedef int (*v_pre)(PRE_ARGS);
61 typedef int (*v_post)(POST_ARGS);
68 static int check_count(struct mdoc *, enum mdoc_type,
69 enum check_lvl, enum check_ineq, int);
70 static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
71 static void check_text(struct mdoc *, int, int, char *);
72 static void check_argv(struct mdoc *,
73 struct mdoc_node *, struct mdoc_argv *);
74 static void check_args(struct mdoc *, struct mdoc_node *);
76 static int concat(struct mdoc *, char *,
77 const struct mdoc_node *, size_t);
78 static enum mdoc_sec a2sec(const char *);
79 static size_t macro2len(enum mdoct);
81 static int ebool(POST_ARGS);
82 static int berr_ge1(POST_ARGS);
83 static int bwarn_ge1(POST_ARGS);
84 static int ewarn_eq0(POST_ARGS);
85 static int ewarn_eq1(POST_ARGS);
86 static int ewarn_ge1(POST_ARGS);
87 static int ewarn_le1(POST_ARGS);
88 static int hwarn_eq0(POST_ARGS);
89 static int hwarn_eq1(POST_ARGS);
90 static int hwarn_ge1(POST_ARGS);
91 static int hwarn_le1(POST_ARGS);
93 static int post_an(POST_ARGS);
94 static int post_at(POST_ARGS);
95 static int post_bf(POST_ARGS);
96 static int post_bl(POST_ARGS);
97 static int post_bl_block(POST_ARGS);
98 static int post_bl_block_width(POST_ARGS);
99 static int post_bl_block_tag(POST_ARGS);
100 static int post_bl_head(POST_ARGS);
101 static int post_bx(POST_ARGS);
102 static int post_dd(POST_ARGS);
103 static int post_dt(POST_ARGS);
104 static int post_defaults(POST_ARGS);
105 static int post_literal(POST_ARGS);
106 static int post_eoln(POST_ARGS);
107 static int post_it(POST_ARGS);
108 static int post_lb(POST_ARGS);
109 static int post_nm(POST_ARGS);
110 static int post_ns(POST_ARGS);
111 static int post_os(POST_ARGS);
112 static int post_ignpar(POST_ARGS);
113 static int post_prol(POST_ARGS);
114 static int post_root(POST_ARGS);
115 static int post_rs(POST_ARGS);
116 static int post_sh(POST_ARGS);
117 static int post_sh_body(POST_ARGS);
118 static int post_sh_head(POST_ARGS);
119 static int post_st(POST_ARGS);
120 static int post_std(POST_ARGS);
121 static int post_vt(POST_ARGS);
122 static int pre_an(PRE_ARGS);
123 static int pre_bd(PRE_ARGS);
124 static int pre_bl(PRE_ARGS);
125 static int pre_dd(PRE_ARGS);
126 static int pre_display(PRE_ARGS);
127 static int pre_dt(PRE_ARGS);
128 static int pre_it(PRE_ARGS);
129 static int pre_literal(PRE_ARGS);
130 static int pre_os(PRE_ARGS);
131 static int pre_par(PRE_ARGS);
132 static int pre_sh(PRE_ARGS);
133 static int pre_ss(PRE_ARGS);
134 static int pre_std(PRE_ARGS);
136 static v_post posts_an[] = { post_an, NULL };
137 static v_post posts_at[] = { post_at, post_defaults, NULL };
138 static v_post posts_bd[] = { post_literal, hwarn_eq0, bwarn_ge1, NULL };
139 static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
140 static v_post posts_bk[] = { hwarn_eq0, bwarn_ge1, NULL };
141 static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
142 static v_post posts_bx[] = { post_bx, NULL };
143 static v_post posts_bool[] = { ebool, NULL };
144 static v_post posts_eoln[] = { post_eoln, NULL };
145 static v_post posts_defaults[] = { post_defaults, NULL };
146 static v_post posts_dd[] = { post_dd, post_prol, NULL };
147 static v_post posts_dl[] = { post_literal, bwarn_ge1, NULL };
148 static v_post posts_dt[] = { post_dt, post_prol, NULL };
149 static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
150 static v_post posts_it[] = { post_it, NULL };
151 static v_post posts_lb[] = { post_lb, NULL };
152 static v_post posts_nd[] = { berr_ge1, NULL };
153 static v_post posts_nm[] = { post_nm, NULL };
154 static v_post posts_notext[] = { ewarn_eq0, NULL };
155 static v_post posts_ns[] = { post_ns, NULL };
156 static v_post posts_os[] = { post_os, post_prol, NULL };
157 static v_post posts_rs[] = { post_rs, NULL };
158 static v_post posts_sh[] = { post_ignpar, hwarn_ge1, bwarn_ge1, post_sh, NULL };
159 static v_post posts_sp[] = { ewarn_le1, NULL };
160 static v_post posts_ss[] = { post_ignpar, hwarn_ge1, bwarn_ge1, NULL };
161 static v_post posts_st[] = { post_st, NULL };
162 static v_post posts_std[] = { post_std, NULL };
163 static v_post posts_text[] = { ewarn_ge1, NULL };
164 static v_post posts_text1[] = { ewarn_eq1, NULL };
165 static v_post posts_vt[] = { post_vt, NULL };
166 static v_post posts_wline[] = { bwarn_ge1, NULL };
167 static v_pre pres_an[] = { pre_an, NULL };
168 static v_pre pres_bd[] = { pre_display, pre_bd, pre_literal, pre_par, NULL };
169 static v_pre pres_bl[] = { pre_bl, pre_par, NULL };
170 static v_pre pres_d1[] = { pre_display, NULL };
171 static v_pre pres_dl[] = { pre_literal, pre_display, NULL };
172 static v_pre pres_dd[] = { pre_dd, NULL };
173 static v_pre pres_dt[] = { pre_dt, NULL };
174 static v_pre pres_er[] = { NULL, NULL };
175 static v_pre pres_fd[] = { NULL, NULL };
176 static v_pre pres_it[] = { pre_it, pre_par, NULL };
177 static v_pre pres_os[] = { pre_os, NULL };
178 static v_pre pres_pp[] = { pre_par, NULL };
179 static v_pre pres_sh[] = { pre_sh, NULL };
180 static v_pre pres_ss[] = { pre_ss, NULL };
181 static v_pre pres_std[] = { pre_std, NULL };
183 static const struct valids mdoc_valids[MDOC_MAX] = {
184 { NULL, NULL }, /* Ap */
185 { pres_dd, posts_dd }, /* Dd */
186 { pres_dt, posts_dt }, /* Dt */
187 { pres_os, posts_os }, /* Os */
188 { pres_sh, posts_sh }, /* Sh */
189 { pres_ss, posts_ss }, /* Ss */
190 { pres_pp, posts_notext }, /* Pp */
191 { pres_d1, posts_wline }, /* D1 */
192 { pres_dl, posts_dl }, /* Dl */
193 { pres_bd, posts_bd }, /* Bd */
194 { NULL, NULL }, /* Ed */
195 { pres_bl, posts_bl }, /* Bl */
196 { NULL, NULL }, /* El */
197 { pres_it, posts_it }, /* It */
198 { NULL, NULL }, /* Ad */
199 { pres_an, posts_an }, /* An */
200 { NULL, posts_defaults }, /* Ar */
201 { NULL, NULL }, /* Cd */
202 { NULL, NULL }, /* Cm */
203 { NULL, NULL }, /* Dv */
204 { pres_er, NULL }, /* Er */
205 { NULL, NULL }, /* Ev */
206 { pres_std, posts_std }, /* Ex */
207 { NULL, NULL }, /* Fa */
208 { pres_fd, posts_text }, /* Fd */
209 { NULL, NULL }, /* Fl */
210 { NULL, NULL }, /* Fn */
211 { NULL, NULL }, /* Ft */
212 { NULL, NULL }, /* Ic */
213 { NULL, posts_text1 }, /* In */
214 { NULL, posts_defaults }, /* Li */
215 { NULL, posts_nd }, /* Nd */
216 { NULL, posts_nm }, /* Nm */
217 { NULL, NULL }, /* Op */
218 { NULL, NULL }, /* Ot */
219 { NULL, posts_defaults }, /* Pa */
220 { pres_std, posts_std }, /* Rv */
221 { NULL, posts_st }, /* St */
222 { NULL, NULL }, /* Va */
223 { NULL, posts_vt }, /* Vt */
224 { NULL, posts_text }, /* Xr */
225 { NULL, posts_text }, /* %A */
226 { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
227 { NULL, posts_text }, /* %D */
228 { NULL, posts_text }, /* %I */
229 { NULL, posts_text }, /* %J */
230 { NULL, posts_text }, /* %N */
231 { NULL, posts_text }, /* %O */
232 { NULL, posts_text }, /* %P */
233 { NULL, posts_text }, /* %R */
234 { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
235 { NULL, posts_text }, /* %V */
236 { NULL, NULL }, /* Ac */
237 { NULL, NULL }, /* Ao */
238 { NULL, NULL }, /* Aq */
239 { NULL, posts_at }, /* At */
240 { NULL, NULL }, /* Bc */
241 { NULL, posts_bf }, /* Bf */
242 { NULL, NULL }, /* Bo */
243 { NULL, NULL }, /* Bq */
244 { NULL, NULL }, /* Bsx */
245 { NULL, posts_bx }, /* Bx */
246 { NULL, posts_bool }, /* Db */
247 { NULL, NULL }, /* Dc */
248 { NULL, NULL }, /* Do */
249 { NULL, NULL }, /* Dq */
250 { NULL, NULL }, /* Ec */
251 { NULL, NULL }, /* Ef */
252 { NULL, NULL }, /* Em */
253 { NULL, NULL }, /* Eo */
254 { NULL, NULL }, /* Fx */
255 { NULL, NULL }, /* Ms */
256 { NULL, posts_notext }, /* No */
257 { NULL, posts_ns }, /* Ns */
258 { NULL, NULL }, /* Nx */
259 { NULL, NULL }, /* Ox */
260 { NULL, NULL }, /* Pc */
261 { NULL, posts_text1 }, /* Pf */
262 { NULL, NULL }, /* Po */
263 { NULL, NULL }, /* Pq */
264 { NULL, NULL }, /* Qc */
265 { NULL, NULL }, /* Ql */
266 { NULL, NULL }, /* Qo */
267 { NULL, NULL }, /* Qq */
268 { NULL, NULL }, /* Re */
269 { NULL, posts_rs }, /* Rs */
270 { NULL, NULL }, /* Sc */
271 { NULL, NULL }, /* So */
272 { NULL, NULL }, /* Sq */
273 { NULL, posts_bool }, /* Sm */
274 { NULL, NULL }, /* Sx */
275 { NULL, NULL }, /* Sy */
276 { NULL, NULL }, /* Tn */
277 { NULL, NULL }, /* Ux */
278 { NULL, NULL }, /* Xc */
279 { NULL, NULL }, /* Xo */
280 { NULL, posts_fo }, /* Fo */
281 { NULL, NULL }, /* Fc */
282 { NULL, NULL }, /* Oo */
283 { NULL, NULL }, /* Oc */
284 { NULL, posts_bk }, /* Bk */
285 { NULL, NULL }, /* Ek */
286 { NULL, posts_eoln }, /* Bt */
287 { NULL, NULL }, /* Hf */
288 { NULL, NULL }, /* Fr */
289 { NULL, posts_eoln }, /* Ud */
290 { NULL, posts_lb }, /* Lb */
291 { NULL, posts_notext }, /* Lp */
292 { NULL, NULL }, /* Lk */
293 { NULL, posts_defaults }, /* Mt */
294 { NULL, NULL }, /* Brq */
295 { NULL, NULL }, /* Bro */
296 { NULL, NULL }, /* Brc */
297 { NULL, posts_text }, /* %C */
298 { NULL, NULL }, /* Es */
299 { NULL, NULL }, /* En */
300 { NULL, NULL }, /* Dx */
301 { NULL, posts_text }, /* %Q */
302 { NULL, posts_notext }, /* br */
303 { pres_pp, posts_sp }, /* sp */
304 { NULL, posts_text1 }, /* %U */
305 { NULL, NULL }, /* Ta */
308 #define RSORD_MAX 14 /* Number of `Rs' blocks. */
310 static const enum mdoct rsord[RSORD_MAX] = {
327 static const char * const secnames[SEC__MAX] = {
333 "IMPLEMENTATION NOTES",
348 "SECURITY CONSIDERATIONS",
353 mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
364 check_text(mdoc, line, pos, tp);
378 if (NULL == mdoc_valids[n->tok].pre)
380 for (p = mdoc_valids[n->tok].pre; *p; p++)
381 if ( ! (*p)(mdoc, n))
388 mdoc_valid_post(struct mdoc *mdoc)
392 if (MDOC_VALID & mdoc->last->flags)
394 mdoc->last->flags |= MDOC_VALID;
396 switch (mdoc->last->type) {
404 return(post_root(mdoc));
409 if (NULL == mdoc_valids[mdoc->last->tok].post)
411 for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
419 check_count(struct mdoc *m, enum mdoc_type type,
420 enum check_lvl lvl, enum check_ineq ineq, int val)
425 if (m->last->type != type)
431 if (m->last->nchild < val)
436 if (m->last->nchild > val)
441 if (val == m->last->nchild)
449 t = lvl == CHECK_WARN ? MANDOCERR_ARGCWARN : MANDOCERR_ARGCOUNT;
450 mandoc_vmsg(t, m->parse, m->last->line, m->last->pos,
451 "want %s%d children (have %d)",
452 p, val, m->last->nchild);
460 return(check_count(mdoc, MDOC_BODY, CHECK_ERROR, CHECK_GT, 0));
466 return(check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0));
472 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0));
478 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1));
484 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0));
490 return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_LT, 2));
496 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0));
502 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 1));
508 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_GT, 0));
514 return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_LT, 2));
518 check_args(struct mdoc *m, struct mdoc_node *n)
525 assert(n->args->argc);
526 for (i = 0; i < (int)n->args->argc; i++)
527 check_argv(m, n, &n->args->argv[i]);
531 check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v)
535 for (i = 0; i < (int)v->sz; i++)
536 check_text(m, v->line, v->pos, v->value[i]);
538 /* FIXME: move to post_std(). */
540 if (MDOC_Std == v->arg)
541 if ( ! (v->sz || m->meta.name))
542 mdoc_nmsg(m, n, MANDOCERR_NONAME);
546 check_text(struct mdoc *m, int ln, int pos, char *p)
551 for ( ; *p; p++, pos++) {
552 sz = strcspn(p, "\t\\");
561 if ( ! (MDOC_LITERAL & m->flags))
562 mdoc_pmsg(m, ln, pos, MANDOCERR_BADTAB);
566 if (0 == (c = mandoc_special(p))) {
567 mdoc_pmsg(m, ln, pos, MANDOCERR_BADESCAPE);
577 check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
581 if ((MDOC_ROOT == t || tok == n->parent->tok) &&
582 (t == n->parent->type))
585 mandoc_vmsg(MANDOCERR_SYNTCHILD, mdoc->parse, n->line,
586 n->pos, "want parent %s", MDOC_ROOT == t ?
587 "<root>" : mdoc_macronames[tok]);
593 pre_display(PRE_ARGS)
595 struct mdoc_node *node;
597 if (MDOC_BLOCK != n->type)
600 for (node = mdoc->last->parent; node; node = node->parent)
601 if (MDOC_BLOCK == node->type)
602 if (MDOC_Bd == node->tok)
606 mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP);
616 const char *offs, *width;
618 struct mdoc_node *np;
620 if (MDOC_BLOCK != n->type) {
621 if (ENDBODY_NOT != n->end) {
623 np = n->pending->parent;
628 assert(MDOC_BLOCK == np->type);
629 assert(MDOC_Bl == np->tok);
634 * First figure out which kind of list to use: bind ourselves to
635 * the first mentioned list type and warn about any remaining
636 * ones. If we find no list type, we default to LIST_item.
640 for (i = 0; n->args && i < (int)n->args->argc; i++) {
644 switch (n->args->argv[i].arg) {
645 /* Set list types. */
679 /* Set list arguments. */
681 dup = n->norm->Bl.comp;
685 dup = (NULL != n->norm->Bl.width);
686 width = n->args->argv[i].value[0];
689 /* NB: this can be empty! */
690 if (n->args->argv[i].sz) {
691 offs = n->args->argv[i].value[0];
692 dup = (NULL != n->norm->Bl.offs);
695 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
701 /* Check: duplicate auxiliary arguments. */
704 mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
707 n->norm->Bl.comp = comp;
709 n->norm->Bl.offs = offs;
711 n->norm->Bl.width = width;
713 /* Check: multiple list types. */
715 if (LIST__NONE != lt && n->norm->Bl.type != LIST__NONE)
716 mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP);
718 /* Assign list type. */
720 if (LIST__NONE != lt && n->norm->Bl.type == LIST__NONE) {
721 n->norm->Bl.type = lt;
722 /* Set column information, too. */
723 if (LIST_column == lt) {
726 n->norm->Bl.cols = (const char **)
727 n->args->argv[i].value;
731 /* The list type should come first. */
733 if (n->norm->Bl.type == LIST__NONE)
734 if (n->norm->Bl.width ||
737 mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST);
742 /* Allow lists to default to LIST_item. */
744 if (LIST__NONE == n->norm->Bl.type) {
745 mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);
746 n->norm->Bl.type = LIST_item;
750 * Validate the width field. Some list types don't need width
751 * types and should be warned about them. Others should have it
752 * and must also be warned.
755 switch (n->norm->Bl.type) {
757 if (n->norm->Bl.width)
759 mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG);
770 if (n->norm->Bl.width)
771 mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
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)
894 mdoc->regs->regs[(int)REG_nS].set = 0;
895 return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
903 if (MDOC_BLOCK != n->type)
906 return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
918 for (i = 1; i < (int)n->args->argc; i++)
919 mdoc_pmsg(mdoc, n->args->argv[i].line,
920 n->args->argv[i].pos, MANDOCERR_IGNARGV);
922 if (MDOC_Split == n->args->argv[0].arg)
923 n->norm->An.auth = AUTH_split;
924 else if (MDOC_Nosplit == n->args->argv[0].arg)
925 n->norm->An.auth = AUTH_nosplit;
936 if (n->args && 1 == n->args->argc)
937 if (MDOC_Std == n->args->argv[0].arg)
940 mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV);
948 if (NULL == mdoc->meta.date || mdoc->meta.os)
949 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
951 if (mdoc->meta.title)
952 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
961 if (NULL == mdoc->meta.title || NULL == mdoc->meta.date)
962 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
965 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
974 if (mdoc->meta.title || mdoc->meta.os)
975 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
978 mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
987 struct mdoc_node *np;
991 * Unlike other data pointers, these are "housed" by the HEAD
992 * element, which contains the goods.
995 if (MDOC_HEAD != mdoc->last->type) {
996 if (ENDBODY_NOT != mdoc->last->end) {
997 assert(mdoc->last->pending);
998 np = mdoc->last->pending->parent->head;
999 } else if (MDOC_BLOCK != mdoc->last->type) {
1000 np = mdoc->last->parent->head;
1002 np = mdoc->last->head;
1005 assert(MDOC_HEAD == np->type);
1006 assert(MDOC_Bf == np->tok);
1011 assert(MDOC_BLOCK == np->parent->type);
1012 assert(MDOC_Bf == np->parent->tok);
1015 * Cannot have both argument and parameter.
1016 * If neither is specified, let it through with a warning.
1019 if (np->parent->args && np->child) {
1020 mdoc_nmsg(mdoc, np, MANDOCERR_SYNTARGVCOUNT);
1022 } else if (NULL == np->parent->args && NULL == np->child) {
1023 mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE);
1027 /* Extract argument into data. */
1029 if (np->parent->args) {
1030 arg = np->parent->args->argv[0].arg;
1031 if (MDOC_Emphasis == arg)
1032 np->norm->Bf.font = FONT_Em;
1033 else if (MDOC_Literal == arg)
1034 np->norm->Bf.font = FONT_Li;
1035 else if (MDOC_Symbolic == arg)
1036 np->norm->Bf.font = FONT_Sy;
1042 /* Extract parameter into data. */
1044 if (0 == strcmp(np->child->string, "Em"))
1045 np->norm->Bf.font = FONT_Em;
1046 else if (0 == strcmp(np->child->string, "Li"))
1047 np->norm->Bf.font = FONT_Li;
1048 else if (0 == strcmp(np->child->string, "Sy"))
1049 np->norm->Bf.font = FONT_Sy;
1051 mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE);
1063 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);
1065 assert(mdoc->last->child);
1066 assert(MDOC_TEXT == mdoc->last->child->type);
1068 p = mdoc_a2lib(mdoc->last->child->string);
1070 /* If lookup ok, replace with table value. */
1073 free(mdoc->last->child->string);
1074 mdoc->last->child->string = mandoc_strdup(p);
1078 /* If not, use "library ``xxxx''. */
1080 sz = strlen(mdoc->last->child->string) +
1081 2 + strlen("\\(lqlibrary\\(rq");
1082 buf = mandoc_malloc(sz);
1083 snprintf(buf, sz, "library \\(lq%s\\(rq",
1084 mdoc->last->child->string);
1085 free(mdoc->last->child->string);
1086 mdoc->last->child->string = buf;
1091 post_eoln(POST_ARGS)
1094 if (mdoc->last->child)
1095 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1103 const struct mdoc_node *n;
1106 * The Vt macro comes in both ELEM and BLOCK form, both of which
1107 * have different syntaxes (yet more context-sensitive
1108 * behaviour). ELEM types must have a child, which is already
1109 * guaranteed by the in_line parsing routine; BLOCK types,
1110 * specifically the BODY, should only have TEXT children.
1113 if (MDOC_BODY != mdoc->last->type)
1116 for (n = mdoc->last->child; n; n = n->next)
1117 if (MDOC_TEXT != n->type)
1118 mdoc_nmsg(mdoc, n, MANDOCERR_CHILD);
1129 /* If no child specified, make sure we have the meta name. */
1131 if (NULL == mdoc->last->child && NULL == mdoc->meta.name) {
1132 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME);
1134 } else if (mdoc->meta.name)
1137 /* If no meta name, set it from the child. */
1139 if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ))
1142 mdoc->meta.name = mandoc_strdup(buf);
1148 post_literal(POST_ARGS)
1152 * The `Dl' (note "el" not "one") and `Bd' macros unset the
1153 * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1154 * this in literal mode, but it doesn't hurt to just switch it
1155 * off in general since displays can't be nested.
1158 if (MDOC_BODY == mdoc->last->type)
1159 mdoc->flags &= ~MDOC_LITERAL;
1165 post_defaults(POST_ARGS)
1167 struct mdoc_node *nn;
1170 * The `Ar' defaults to "file ..." if no value is provided as an
1171 * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1172 * gets an empty string.
1175 if (mdoc->last->child)
1179 mdoc->next = MDOC_NEXT_CHILD;
1183 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "file"))
1185 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))
1189 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "AT&T"))
1191 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "UNIX"))
1195 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))
1201 if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"))
1221 * If we have a child, look it up in the standard keys. If a
1222 * key exist, use that instead of the child; if it doesn't,
1223 * prefix "AT&T UNIX " to the existing data.
1226 if (NULL == mdoc->last->child)
1229 assert(MDOC_TEXT == mdoc->last->child->type);
1230 p = mdoc_a2att(mdoc->last->child->string);
1233 free(mdoc->last->child->string);
1234 mdoc->last->child->string = mandoc_strdup(p);
1236 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT);
1238 q = mdoc->last->child->string;
1239 sz = strlen(p) + strlen(q) + 1;
1240 buf = mandoc_malloc(sz);
1241 strlcpy(buf, p, sz);
1242 strlcat(buf, q, sz);
1243 free(mdoc->last->child->string);
1244 mdoc->last->child->string = buf;
1253 struct mdoc_node *np;
1256 if (AUTH__NONE == np->norm->An.auth) {
1258 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0);
1259 } else if (np->child)
1260 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0);
1271 struct mdoc_node *n, *c;
1274 if (MDOC_BLOCK != mdoc->last->type)
1277 n = mdoc->last->parent->parent;
1278 lt = n->norm->Bl.type;
1280 if (LIST__NONE == lt) {
1281 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
1287 if (mdoc->last->head->child)
1289 /* FIXME: give this a dummy value. */
1290 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1299 if (NULL == mdoc->last->head->child)
1300 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1309 if (NULL == mdoc->last->body->child)
1310 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1313 if (mdoc->last->head->child)
1314 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1317 cols = (int)n->norm->Bl.ncols;
1319 assert(NULL == mdoc->last->head->child);
1321 if (NULL == mdoc->last->body->child)
1322 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1324 for (i = 0, c = mdoc->last->child; c; c = c->next)
1325 if (MDOC_BODY == c->type)
1329 er = MANDOCERR_ARGCOUNT;
1330 else if (i == cols || i == cols + 1)
1333 er = MANDOCERR_SYNTARGCOUNT;
1335 mandoc_vmsg(er, mdoc->parse, mdoc->last->line,
1337 "columns == %d (have %d)", cols, i);
1338 return(MANDOCERR_ARGCOUNT == er);
1347 post_bl_block(POST_ARGS)
1349 struct mdoc_node *n;
1352 * These are fairly complicated, so we've broken them into two
1353 * functions. post_bl_block_tag() is called when a -tag is
1354 * specified, but no -width (it must be guessed). The second
1355 * when a -width is specified (macro indicators must be
1356 * rewritten into real lengths).
1361 if (LIST_tag == n->norm->Bl.type &&
1362 NULL == n->norm->Bl.width) {
1363 if ( ! post_bl_block_tag(mdoc))
1365 } else if (NULL != n->norm->Bl.width) {
1366 if ( ! post_bl_block_width(mdoc))
1371 assert(n->norm->Bl.width);
1376 post_bl_block_width(POST_ARGS)
1381 struct mdoc_node *n;
1387 * Calculate the real width of a list from the -width string,
1388 * which may contain a macro (with a known default width), a
1389 * literal string, or a scaling width.
1391 * If the value to -width is a macro, then we re-write it to be
1392 * the macro's width as set in share/tmac/mdoc/doc-common.
1395 if (0 == strcmp(n->norm->Bl.width, "Ds"))
1397 else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))
1399 else if (0 == (width = macro2len(tok))) {
1400 mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH);
1404 /* The value already exists: free and reallocate it. */
1408 for (i = 0; i < (int)n->args->argc; i++)
1409 if (MDOC_Width == n->args->argv[i].arg)
1412 assert(i < (int)n->args->argc);
1414 snprintf(buf, NUMSIZ, "%zun", width);
1415 free(n->args->argv[i].value[0]);
1416 n->args->argv[i].value[0] = mandoc_strdup(buf);
1418 /* Set our width! */
1419 n->norm->Bl.width = n->args->argv[i].value[0];
1424 post_bl_block_tag(POST_ARGS)
1426 struct mdoc_node *n, *nn;
1432 * Calculate the -width for a `Bl -tag' list if it hasn't been
1433 * provided. Uses the first head macro. NOTE AGAIN: this is
1434 * ONLY if the -width argument has NOT been provided. See
1435 * post_bl_block_width() for converting the -width string.
1441 for (nn = n->body->child; nn; nn = nn->next) {
1442 if (MDOC_It != nn->tok)
1445 assert(MDOC_BLOCK == nn->type);
1446 nn = nn->head->child;
1451 if (MDOC_TEXT == nn->type) {
1452 sz = strlen(nn->string) + 1;
1456 if (0 != (ssz = macro2len(nn->tok)))
1462 /* Defaults to ten ens. */
1464 snprintf(buf, NUMSIZ, "%zun", sz);
1467 * We have to dynamically add this to the macro's argument list.
1468 * We're guaranteed that a MDOC_Width doesn't already exist.
1472 i = (int)(n->args->argc)++;
1474 n->args->argv = mandoc_realloc(n->args->argv,
1475 n->args->argc * sizeof(struct mdoc_argv));
1477 n->args->argv[i].arg = MDOC_Width;
1478 n->args->argv[i].line = n->line;
1479 n->args->argv[i].pos = n->pos;
1480 n->args->argv[i].sz = 1;
1481 n->args->argv[i].value = mandoc_malloc(sizeof(char *));
1482 n->args->argv[i].value[0] = mandoc_strdup(buf);
1484 /* Set our width! */
1485 n->norm->Bl.width = n->args->argv[i].value[0];
1491 post_bl_head(POST_ARGS)
1493 struct mdoc_node *np, *nn, *nnp;
1496 if (LIST_column != mdoc->last->norm->Bl.type)
1497 /* FIXME: this should be ERROR class... */
1498 return(hwarn_eq0(mdoc));
1501 * Convert old-style lists, where the column width specifiers
1502 * trail as macro parameters, to the new-style ("normal-form")
1503 * lists where they're argument values following -column.
1506 /* First, disallow both types and allow normal-form. */
1509 * TODO: technically, we can accept both and just merge the two
1510 * lists, but I'll leave that for another day.
1513 if (mdoc->last->norm->Bl.ncols && mdoc->last->nchild) {
1514 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS);
1516 } else if (NULL == mdoc->last->child)
1519 np = mdoc->last->parent;
1522 for (j = 0; j < (int)np->args->argc; j++)
1523 if (MDOC_Column == np->args->argv[j].arg)
1526 assert(j < (int)np->args->argc);
1527 assert(0 == np->args->argv[j].sz);
1530 * Accomodate for new-style groff column syntax. Shuffle the
1531 * child nodes, all of which must be TEXT, as arguments for the
1532 * column field. Then, delete the head children.
1535 np->args->argv[j].sz = (size_t)mdoc->last->nchild;
1536 np->args->argv[j].value = mandoc_malloc
1537 ((size_t)mdoc->last->nchild * sizeof(char *));
1539 mdoc->last->norm->Bl.ncols = np->args->argv[j].sz;
1540 mdoc->last->norm->Bl.cols = (const char **)np->args->argv[j].value;
1542 for (i = 0, nn = mdoc->last->child; nn; i++) {
1543 np->args->argv[j].value[i] = nn->string;
1547 mdoc_node_delete(NULL, nnp);
1550 mdoc->last->nchild = 0;
1551 mdoc->last->child = NULL;
1559 struct mdoc_node *n;
1561 if (MDOC_HEAD == mdoc->last->type)
1562 return(post_bl_head(mdoc));
1563 if (MDOC_BLOCK == mdoc->last->type)
1564 return(post_bl_block(mdoc));
1565 if (MDOC_BODY != mdoc->last->type)
1568 for (n = mdoc->last->child; n; n = n->next) {
1573 mdoc_nmsg(mdoc, n, MANDOCERR_CHILD);
1583 mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD);
1591 ebool(struct mdoc *mdoc)
1594 if (NULL == mdoc->last->child) {
1595 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY);
1596 mdoc_node_delete(mdoc, mdoc->last);
1599 check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 1);
1601 assert(MDOC_TEXT == mdoc->last->child->type);
1603 if (0 == strcmp(mdoc->last->child->string, "on"))
1605 if (0 == strcmp(mdoc->last->child->string, "off"))
1608 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL);
1613 post_root(POST_ARGS)
1616 struct mdoc_node *n;
1620 /* Check that we have a finished prologue. */
1622 if ( ! (MDOC_PBODY & mdoc->flags)) {
1624 mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1630 /* Check that we begin with a proper `Sh'. */
1632 if (NULL == n->child) {
1634 mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1635 } else if (MDOC_BLOCK != n->child->type ||
1636 MDOC_Sh != n->child->tok) {
1638 /* Can this be lifted? See rxdebug.1 for example. */
1639 mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1642 return(erc ? 0 : 1);
1648 struct mdoc_node *ch;
1651 if (NULL == (ch = mdoc->last->child)) {
1652 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_MACROEMPTY);
1653 mdoc_node_delete(mdoc, mdoc->last);
1657 assert(MDOC_TEXT == ch->type);
1659 if (NULL == (p = mdoc_a2st(ch->string))) {
1660 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD);
1661 mdoc_node_delete(mdoc, mdoc->last);
1664 ch->string = mandoc_strdup(p);
1673 struct mdoc_node *nn, *next, *prev;
1676 switch (mdoc->last->type) {
1678 check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0);
1681 if (mdoc->last->child)
1683 check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0);
1690 * Make sure only certain types of nodes are allowed within the
1691 * the `Rs' body. Delete offending nodes and raise a warning.
1692 * Do this before re-ordering for the sake of clarity.
1696 for (nn = mdoc->last->child; nn; nn = next) {
1697 for (i = 0; i < RSORD_MAX; i++)
1698 if (nn->tok == rsord[i])
1701 if (i < RSORD_MAX) {
1702 if (MDOC__J == rsord[i] || MDOC__B == rsord[i])
1703 mdoc->last->norm->Rs.quote_T++;
1709 mdoc_nmsg(mdoc, nn, MANDOCERR_CHILD);
1710 mdoc_node_delete(mdoc, nn);
1714 * The full `Rs' block needs special handling to order the
1715 * sub-elements according to `rsord'. Pick through each element
1716 * and correctly order it. This is a insertion sort.
1720 for (nn = mdoc->last->child->next; nn; nn = next) {
1721 /* Determine order of `nn'. */
1722 for (i = 0; i < RSORD_MAX; i++)
1723 if (rsord[i] == nn->tok)
1727 * Remove `nn' from the chain. This somewhat
1728 * repeats mdoc_node_unlink(), but since we're
1729 * just re-ordering, there's no need for the
1730 * full unlink process.
1733 if (NULL != (next = nn->next))
1734 next->prev = nn->prev;
1736 if (NULL != (prev = nn->prev))
1737 prev->next = nn->next;
1739 nn->prev = nn->next = NULL;
1742 * Scan back until we reach a node that's
1743 * ordered before `nn'.
1746 for ( ; prev ; prev = prev->prev) {
1747 /* Determine order of `prev'. */
1748 for (j = 0; j < RSORD_MAX; j++)
1749 if (rsord[j] == prev->tok)
1757 * Set `nn' back into its correct place in front
1758 * of the `prev' node.
1765 prev->next->prev = nn;
1766 nn->next = prev->next;
1769 mdoc->last->child->prev = nn;
1770 nn->next = mdoc->last->child;
1771 mdoc->last->child = nn;
1782 if (MDOC_LINE & mdoc->last->flags)
1783 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNNS);
1791 if (MDOC_HEAD == mdoc->last->type)
1792 return(post_sh_head(mdoc));
1793 if (MDOC_BODY == mdoc->last->type)
1794 return(post_sh_body(mdoc));
1800 post_sh_body(POST_ARGS)
1802 struct mdoc_node *n;
1804 if (SEC_NAME != mdoc->lastsec)
1808 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1809 * macros (can have multiple `Nm' and one `Nd'). Note that the
1810 * children of the BODY declaration can also be "text".
1813 if (NULL == (n = mdoc->last->child)) {
1814 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1818 for ( ; n && n->next; n = n->next) {
1819 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1821 if (MDOC_TEXT == n->type)
1823 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1827 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1830 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1835 post_sh_head(POST_ARGS)
1841 * Process a new section. Sections are either "named" or
1842 * "custom". Custom sections are user-defined, while named ones
1843 * follow a conventional order and may only appear in certain
1847 if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ))
1852 /* The NAME should be first. */
1854 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1855 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST);
1857 /* The SYNOPSIS gets special attention in other areas. */
1859 if (SEC_SYNOPSIS == sec)
1860 mdoc->flags |= MDOC_SYNOPSIS;
1862 mdoc->flags &= ~MDOC_SYNOPSIS;
1864 /* Mark our last section. */
1866 mdoc->lastsec = sec;
1868 /* We don't care about custom sections after this. */
1870 if (SEC_CUSTOM == sec)
1874 * Check whether our non-custom section is being repeated or is
1878 if (sec == mdoc->lastnamed)
1879 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP);
1881 if (sec < mdoc->lastnamed)
1882 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO);
1884 /* Mark the last named section. */
1886 mdoc->lastnamed = sec;
1888 /* Check particular section/manual conventions. */
1890 assert(mdoc->meta.msec);
1893 case (SEC_RETURN_VALUES):
1898 if (*mdoc->meta.msec == '2')
1900 if (*mdoc->meta.msec == '3')
1902 if (*mdoc->meta.msec == '9')
1904 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC);
1914 post_ignpar(POST_ARGS)
1916 struct mdoc_node *np;
1918 if (MDOC_BODY != mdoc->last->type)
1921 if (NULL != (np = mdoc->last->child))
1922 if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
1923 mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
1924 mdoc_node_delete(mdoc, np);
1927 if (NULL != (np = mdoc->last->last))
1928 if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
1929 mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
1930 mdoc_node_delete(mdoc, np);
1940 if (NULL == mdoc->last)
1942 if (MDOC_ELEM != n->type && MDOC_BLOCK != n->type)
1946 * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1947 * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1950 if (MDOC_Pp != mdoc->last->tok && MDOC_Lp != mdoc->last->tok)
1952 if (MDOC_Bl == n->tok && n->norm->Bl.comp)
1954 if (MDOC_Bd == n->tok && n->norm->Bd.comp)
1956 if (MDOC_It == n->tok && n->parent->norm->Bl.comp)
1959 mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR);
1960 mdoc_node_delete(mdoc, mdoc->last);
1965 pre_literal(PRE_ARGS)
1968 if (MDOC_BODY != n->type)
1972 * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1973 * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1978 mdoc->flags |= MDOC_LITERAL;
1981 if (DISP_literal == n->norm->Bd.type)
1982 mdoc->flags |= MDOC_LITERAL;
1983 if (DISP_unfilled == n->norm->Bd.type)
1984 mdoc->flags |= MDOC_LITERAL;
1998 struct mdoc_node *n;
2000 if (mdoc->meta.date)
2001 free(mdoc->meta.date);
2004 if (NULL == n->child || '\0' == n->child->string[0]) {
2005 mdoc->meta.date = mandoc_normdate
2006 (mdoc->parse, NULL, n->line, n->pos);
2010 if ( ! concat(mdoc, buf, n->child, DATESIZE))
2013 mdoc->meta.date = mandoc_normdate
2014 (mdoc->parse, buf, n->line, n->pos);
2022 struct mdoc_node *nn, *n;
2028 if (mdoc->meta.title)
2029 free(mdoc->meta.title);
2031 free(mdoc->meta.vol);
2032 if (mdoc->meta.arch)
2033 free(mdoc->meta.arch);
2035 mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL;
2037 /* First make all characters uppercase. */
2039 if (NULL != (nn = n->child))
2040 for (p = nn->string; *p; p++) {
2041 if (toupper((u_char)*p) == *p)
2045 * FIXME: don't be lazy: have this make all
2046 * characters be uppercase and just warn once.
2048 mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE);
2053 * --> title = unknown, volume = local, msec = 0, arch = NULL
2056 if (NULL == (nn = n->child)) {
2057 /* XXX: make these macro values. */
2058 /* FIXME: warn about missing values. */
2059 mdoc->meta.title = mandoc_strdup("UNKNOWN");
2060 mdoc->meta.vol = mandoc_strdup("LOCAL");
2061 mdoc->meta.msec = mandoc_strdup("1");
2065 /* Handles: `.Dt TITLE'
2066 * --> title = TITLE, volume = local, msec = 0, arch = NULL
2069 mdoc->meta.title = mandoc_strdup
2070 ('\0' == nn->string[0] ? "UNKNOWN" : nn->string);
2072 if (NULL == (nn = nn->next)) {
2073 /* FIXME: warn about missing msec. */
2074 /* XXX: make this a macro value. */
2075 mdoc->meta.vol = mandoc_strdup("LOCAL");
2076 mdoc->meta.msec = mandoc_strdup("1");
2080 /* Handles: `.Dt TITLE SEC'
2081 * --> title = TITLE, volume = SEC is msec ?
2082 * format(msec) : SEC,
2083 * msec = SEC is msec ? atoi(msec) : 0,
2087 cp = mdoc_a2msec(nn->string);
2089 mdoc->meta.vol = mandoc_strdup(cp);
2090 mdoc->meta.msec = mandoc_strdup(nn->string);
2092 mdoc_nmsg(mdoc, n, MANDOCERR_BADMSEC);
2093 mdoc->meta.vol = mandoc_strdup(nn->string);
2094 mdoc->meta.msec = mandoc_strdup(nn->string);
2097 if (NULL == (nn = nn->next))
2100 /* Handles: `.Dt TITLE SEC VOL'
2101 * --> title = TITLE, volume = VOL is vol ?
2103 * VOL is arch ? format(arch) :
2107 cp = mdoc_a2vol(nn->string);
2109 free(mdoc->meta.vol);
2110 mdoc->meta.vol = mandoc_strdup(cp);
2112 /* FIXME: warn about bad arch. */
2113 cp = mdoc_a2arch(nn->string);
2115 free(mdoc->meta.vol);
2116 mdoc->meta.vol = mandoc_strdup(nn->string);
2118 mdoc->meta.arch = mandoc_strdup(cp);
2121 /* Ignore any subsequent parameters... */
2122 /* FIXME: warn about subsequent parameters. */
2128 post_prol(POST_ARGS)
2131 * Remove prologue macros from the document after they're
2132 * processed. The final document uses mdoc_meta for these
2133 * values and discards the originals.
2136 mdoc_node_delete(mdoc, mdoc->last);
2137 if (mdoc->meta.title && mdoc->meta.date && mdoc->meta.os)
2138 mdoc->flags |= MDOC_PBODY;
2146 struct mdoc_node *n;
2149 * Make `Bx's second argument always start with an uppercase
2150 * letter. Groff checks if it's an "accepted" term, but we just
2151 * uppercase blindly.
2154 n = mdoc->last->child;
2155 if (n && NULL != (n = n->next))
2156 *n->string = (char)toupper
2157 ((unsigned char)*n->string);
2165 struct mdoc_node *n;
2168 struct utsname utsname;
2174 * Set the operating system by way of the `Os' macro. Note that
2175 * if an argument isn't provided and -DOSNAME="\"foo\"" is
2176 * provided during compilation, this value will be used instead
2177 * of filling in "sysname release" from uname().
2181 free(mdoc->meta.os);
2183 if ( ! concat(mdoc, buf, n->child, BUFSIZ))
2186 /* XXX: yes, these can all be dynamically-adjusted buffers, but
2187 * it's really not worth the extra hackery.
2190 if ('\0' == buf[0]) {
2192 if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ) {
2193 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2197 if (-1 == uname(&utsname)) {
2198 mdoc_nmsg(mdoc, n, MANDOCERR_UNAME);
2199 mdoc->meta.os = mandoc_strdup("UNKNOWN");
2200 return(post_prol(mdoc));
2203 if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) {
2204 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2207 if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
2208 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2211 if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) {
2212 mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2218 mdoc->meta.os = mandoc_strdup(buf);
2225 struct mdoc_node *nn, *n;
2230 * Macros accepting `-std' as an argument have the name of the
2231 * current document (`Nm') filled in as the argument if it's not
2238 if (NULL == mdoc->meta.name)
2242 mdoc->next = MDOC_NEXT_CHILD;
2244 if ( ! mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name))
2252 concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz)
2258 * Concatenate sibling nodes together. All siblings must be of
2259 * type MDOC_TEXT or an assertion is raised. Concatenation is
2260 * separated by a single whitespace. Returns 0 on fatal (string
2264 for ( ; n; n = n->next) {
2265 assert(MDOC_TEXT == n->type);
2267 if (strlcat(p, n->string, sz) >= sz) {
2268 mdoc_nmsg(m, n, MANDOCERR_MEM);
2272 if (NULL == n->next)
2275 if (strlcat(p, " ", sz) >= sz) {
2276 mdoc_nmsg(m, n, MANDOCERR_MEM);
2284 static enum mdoc_sec
2285 a2sec(const char *p)
2289 for (i = 0; i < (int)SEC__MAX; i++)
2290 if (secnames[i] && 0 == strcmp(p, secnames[i]))
2291 return((enum mdoc_sec)i);
2297 macro2len(enum mdoct macro)