1*4d131170SRobert Mustacchi /* $Id: roff_validate.c,v 1.20 2020/06/22 19:20:40 schwarze Exp $ */
2c66b8046SYuri Pankov /*
3*4d131170SRobert Mustacchi * Copyright (c) 2010, 2017, 2018, 2020 Ingo Schwarze <schwarze@openbsd.org>
4c66b8046SYuri Pankov *
5c66b8046SYuri Pankov * Permission to use, copy, modify, and distribute this software for any
6c66b8046SYuri Pankov * purpose with or without fee is hereby granted, provided that the above
7c66b8046SYuri Pankov * copyright notice and this permission notice appear in all copies.
8c66b8046SYuri Pankov *
9c66b8046SYuri Pankov * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10c66b8046SYuri Pankov * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11c66b8046SYuri Pankov * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12c66b8046SYuri Pankov * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13c66b8046SYuri Pankov * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14c66b8046SYuri Pankov * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15c66b8046SYuri Pankov * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16c66b8046SYuri Pankov */
17*4d131170SRobert Mustacchi #include "config.h"
18*4d131170SRobert Mustacchi
19c66b8046SYuri Pankov #include <sys/types.h>
20c66b8046SYuri Pankov
21c66b8046SYuri Pankov #include <assert.h>
22cec8643bSMichal Nowak #include <stdio.h>
23cec8643bSMichal Nowak #include <string.h>
24c66b8046SYuri Pankov
25c66b8046SYuri Pankov #include "mandoc.h"
26c66b8046SYuri Pankov #include "roff.h"
27c66b8046SYuri Pankov #include "libmandoc.h"
28c66b8046SYuri Pankov #include "roff_int.h"
29c66b8046SYuri Pankov
30c66b8046SYuri Pankov #define ROFF_VALID_ARGS struct roff_man *man, struct roff_node *n
31c66b8046SYuri Pankov
32c66b8046SYuri Pankov typedef void (*roff_valid_fp)(ROFF_VALID_ARGS);
33c66b8046SYuri Pankov
34cec8643bSMichal Nowak static void roff_valid_br(ROFF_VALID_ARGS);
35cec8643bSMichal Nowak static void roff_valid_fi(ROFF_VALID_ARGS);
36c66b8046SYuri Pankov static void roff_valid_ft(ROFF_VALID_ARGS);
37cec8643bSMichal Nowak static void roff_valid_nf(ROFF_VALID_ARGS);
38cec8643bSMichal Nowak static void roff_valid_sp(ROFF_VALID_ARGS);
39c66b8046SYuri Pankov
40c66b8046SYuri Pankov static const roff_valid_fp roff_valids[ROFF_MAX] = {
41cec8643bSMichal Nowak roff_valid_br, /* br */
42c66b8046SYuri Pankov NULL, /* ce */
43cec8643bSMichal Nowak roff_valid_fi, /* fi */
44c66b8046SYuri Pankov roff_valid_ft, /* ft */
45c66b8046SYuri Pankov NULL, /* ll */
46c66b8046SYuri Pankov NULL, /* mc */
47cec8643bSMichal Nowak roff_valid_nf, /* nf */
48c66b8046SYuri Pankov NULL, /* po */
49c66b8046SYuri Pankov NULL, /* rj */
50cec8643bSMichal Nowak roff_valid_sp, /* sp */
51c66b8046SYuri Pankov NULL, /* ta */
52c66b8046SYuri Pankov NULL, /* ti */
53c66b8046SYuri Pankov };
54c66b8046SYuri Pankov
55c66b8046SYuri Pankov
56c66b8046SYuri Pankov void
roff_validate(struct roff_man * man)57c66b8046SYuri Pankov roff_validate(struct roff_man *man)
58c66b8046SYuri Pankov {
59c66b8046SYuri Pankov struct roff_node *n;
60c66b8046SYuri Pankov
61c66b8046SYuri Pankov n = man->last;
62c66b8046SYuri Pankov assert(n->tok < ROFF_MAX);
63c66b8046SYuri Pankov if (roff_valids[n->tok] != NULL)
64c66b8046SYuri Pankov (*roff_valids[n->tok])(man, n);
65c66b8046SYuri Pankov }
66c66b8046SYuri Pankov
67cec8643bSMichal Nowak static void
roff_valid_br(ROFF_VALID_ARGS)68cec8643bSMichal Nowak roff_valid_br(ROFF_VALID_ARGS)
69cec8643bSMichal Nowak {
70cec8643bSMichal Nowak struct roff_node *np;
71cec8643bSMichal Nowak
72cec8643bSMichal Nowak if (n->next != NULL && n->next->type == ROFFT_TEXT &&
73cec8643bSMichal Nowak *n->next->string == ' ') {
74cec8643bSMichal Nowak mandoc_msg(MANDOCERR_PAR_SKIP, n->line, n->pos,
75cec8643bSMichal Nowak "br before text line with leading blank");
76cec8643bSMichal Nowak roff_node_delete(man, n);
77cec8643bSMichal Nowak return;
78cec8643bSMichal Nowak }
79cec8643bSMichal Nowak
80*4d131170SRobert Mustacchi if ((np = roff_node_prev(n)) == NULL)
81cec8643bSMichal Nowak return;
82cec8643bSMichal Nowak
83cec8643bSMichal Nowak switch (np->tok) {
84cec8643bSMichal Nowak case ROFF_br:
85cec8643bSMichal Nowak case ROFF_sp:
86cec8643bSMichal Nowak case MDOC_Pp:
87cec8643bSMichal Nowak mandoc_msg(MANDOCERR_PAR_SKIP,
88cec8643bSMichal Nowak n->line, n->pos, "br after %s", roff_name[np->tok]);
89cec8643bSMichal Nowak roff_node_delete(man, n);
90cec8643bSMichal Nowak break;
91cec8643bSMichal Nowak default:
92cec8643bSMichal Nowak break;
93cec8643bSMichal Nowak }
94cec8643bSMichal Nowak }
95cec8643bSMichal Nowak
96cec8643bSMichal Nowak static void
roff_valid_fi(ROFF_VALID_ARGS)97cec8643bSMichal Nowak roff_valid_fi(ROFF_VALID_ARGS)
98cec8643bSMichal Nowak {
99cec8643bSMichal Nowak if ((n->flags & NODE_NOFILL) == 0)
100cec8643bSMichal Nowak mandoc_msg(MANDOCERR_FI_SKIP, n->line, n->pos, "fi");
101cec8643bSMichal Nowak }
102cec8643bSMichal Nowak
103c66b8046SYuri Pankov static void
roff_valid_ft(ROFF_VALID_ARGS)104c66b8046SYuri Pankov roff_valid_ft(ROFF_VALID_ARGS)
105c66b8046SYuri Pankov {
106cec8643bSMichal Nowak const char *cp;
107c66b8046SYuri Pankov
108c66b8046SYuri Pankov if (n->child == NULL) {
109c66b8046SYuri Pankov man->next = ROFF_NEXT_CHILD;
110c66b8046SYuri Pankov roff_word_alloc(man, n->line, n->pos, "P");
111c66b8046SYuri Pankov man->last = n;
112c66b8046SYuri Pankov return;
113c66b8046SYuri Pankov }
114c66b8046SYuri Pankov
115c66b8046SYuri Pankov cp = n->child->string;
116cec8643bSMichal Nowak if (mandoc_font(cp, (int)strlen(cp)) != ESCAPE_ERROR)
117cec8643bSMichal Nowak return;
118cec8643bSMichal Nowak mandoc_msg(MANDOCERR_FT_BAD, n->line, n->pos, "ft %s", cp);
119cec8643bSMichal Nowak roff_node_delete(man, n);
120cec8643bSMichal Nowak }
121cec8643bSMichal Nowak
122cec8643bSMichal Nowak static void
roff_valid_nf(ROFF_VALID_ARGS)123cec8643bSMichal Nowak roff_valid_nf(ROFF_VALID_ARGS)
124cec8643bSMichal Nowak {
125cec8643bSMichal Nowak if (n->flags & NODE_NOFILL)
126cec8643bSMichal Nowak mandoc_msg(MANDOCERR_NF_SKIP, n->line, n->pos, "nf");
127cec8643bSMichal Nowak }
128cec8643bSMichal Nowak
129cec8643bSMichal Nowak static void
roff_valid_sp(ROFF_VALID_ARGS)130cec8643bSMichal Nowak roff_valid_sp(ROFF_VALID_ARGS)
131cec8643bSMichal Nowak {
132cec8643bSMichal Nowak struct roff_node *np;
133cec8643bSMichal Nowak
134*4d131170SRobert Mustacchi if ((np = roff_node_prev(n)) == NULL)
135cec8643bSMichal Nowak return;
136cec8643bSMichal Nowak
137cec8643bSMichal Nowak switch (np->tok) {
138cec8643bSMichal Nowak case ROFF_br:
139cec8643bSMichal Nowak mandoc_msg(MANDOCERR_PAR_SKIP,
140cec8643bSMichal Nowak np->line, np->pos, "br before sp");
141cec8643bSMichal Nowak roff_node_delete(man, np);
142c66b8046SYuri Pankov break;
143cec8643bSMichal Nowak case MDOC_Pp:
144cec8643bSMichal Nowak mandoc_msg(MANDOCERR_PAR_SKIP,
145cec8643bSMichal Nowak n->line, n->pos, "sp after Pp");
146cec8643bSMichal Nowak roff_node_delete(man, n);
147c66b8046SYuri Pankov break;
148c66b8046SYuri Pankov default:
149c66b8046SYuri Pankov break;
150c66b8046SYuri Pankov }
151c66b8046SYuri Pankov }
152