summaryrefslogtreecommitdiff
path: root/tests/usr.bin/indent/t_options.awk
blob: 502614c53d47894a9096b6956c04a58437cf6882 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# $NetBSD: t_options.awk,v 1.7 2021/11/20 13:14:34 rillig Exp $
#
# Copyright (c) 2021 The NetBSD Foundation, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# $FreeBSD$

# Test driver for indent that focuses on comparing the effects of the various
# command line options.
#
# The test files contain the input to be formatted, the formatting options
# and the output, all as close together as possible. The test files use the
# following directives:
#
#	#indent input [description]
#		Specifies the input to be formatted.
#	#indent run [options]
#		Runs indent on the input, using the given options.
#	#indent end [description]
#		Finishes an '#indent input' or '#indent run' section.
#	#indent run-equals-input [options]
#		Runs indent on the input, expecting unmodified output.
#	#indent run-equals-prev-output [options]
#		Runs indent on the input, expecting the same output as from
#		the previous run.
#
# All text outside these directives is not passed to indent.
#
# The actual output from running indent is written to stdout, the expected
# test output is written to 'expected.out'.

BEGIN {
	warned = 0
	died = 0

	prev_empty_lines = 0	# the finished "block" of empty lines
	curr_empty_lines = 0	# the ongoing "block" of empty lines
	seen_input_section = 0	# the first input section is not checked

	section = ""		# "", "input" or "run"
	section_excl_comm = ""	# without dollar comments
	section_incl_comm = ""	# with dollar comments

	input_excl_comm = ""	# stdin for indent
	input_incl_comm = ""	# used for duplicate checks
	unused_input_lineno = 0

	output_excl_comm = ""	# expected output
	output_incl_comm = ""	# used for duplicate checks
	output_lineno = 0
}

function die(lineno, msg)
{
	if (!died) {
		died = 1	# suppress further actions in END block
		print FILENAME ":" lineno ": error: " msg > "/dev/stderr"
		exit(1)
	}
}

function warn(lineno, msg)
{
	print FILENAME ":" lineno ": warning: " msg > "/dev/stderr"
	warned = 1
}

function quote(s)
{
	return "'" s "'"
}

function check_unused_input()
{
	if (unused_input_lineno != 0)
		warn(unused_input_lineno, "input is not used")
}

function run_indent(inp,   i, cmd)
{
	cmd = ENVIRON["INDENT"]
	if (cmd == "")
		cmd = "indent"
	for (i = 3; i <= NF; i++)
		cmd = cmd " " $i
	printf("%s", inp) | cmd
	close(cmd)
}

section == "" {
	if (NF == 0)
		curr_empty_lines++
	else {
		if (curr_empty_lines > 0) {
			if (prev_empty_lines > 1)
				warn(NR - curr_empty_lines - 1,
				    prev_empty_lines " empty lines a few " \
				    "lines above, should be only 1")
			prev_empty_lines = curr_empty_lines
		}
		curr_empty_lines = 0
	}
}

# Hide comments starting with dollar from indent; they are used for marking
# bugs and adding other remarks directly in the input or output sections.
/^[[:space:]]*\/[*][[:space:]]*[$].*[*]\/$/ ||
/^[[:space:]]*\/\/[[:space:]]*[$]/ {
	if (section != "")
		section_incl_comm = section_incl_comm $0 "\n"
	next
}

/^#/ && $1 == "#indent" {
	print $0
	print $0 > "expected.out"

	if ($2 == "input") {
		if (prev_empty_lines != 2 && seen_input_section)
			warn(NR, "input section needs 2 empty lines above, " \
			    "not " prev_empty_lines)
		check_unused_input()
		section = "input"
		section_excl_comm = ""
		section_incl_comm = ""
		unused_input_lineno = NR
		seen_input_section = 1

	} else if ($2 == "run") {
		if (section != "")
			warn(NR, "unfinished section " quote(section))
		if (prev_empty_lines != 1)
			warn(NR, "run section needs 1 empty line above, " \
			    "not " prev_empty_lines)
		section = "run"
		output_lineno = NR
		section_excl_comm = ""
		section_incl_comm = ""

		run_indent(input_excl_comm)
		unused_input_lineno = 0

	} else if ($2 == "run-equals-input") {
		run_indent(input_excl_comm)
		printf("%s", input_excl_comm) > "expected.out"
		unused_input_lineno = 0

	} else if ($2 == "run-equals-prev-output") {
		run_indent(input_excl_comm)
		printf("%s", output_excl_comm) > "expected.out"

	} else if ($2 == "end" && section == "input") {
		if (section_incl_comm == input_incl_comm)
			warn(NR, "duplicate input; remove this section")

		input_excl_comm = section_excl_comm
		input_incl_comm = section_incl_comm
		section = ""

	} else if ($2 == "end" && section == "run") {
		if (section_incl_comm == input_incl_comm)
			warn(output_lineno,
			    "output == input; use run-equals-input")
		if (section_incl_comm == output_incl_comm)
			warn(output_lineno,
			    "duplicate output; use run-equals-prev-output")

		output_excl_comm = section_excl_comm
		output_incl_comm = section_incl_comm
		section = ""

	} else if ($2 == "end") {
		warn(NR, "misplaced " quote("#indent end"))

	} else {
		die(NR, "invalid line " quote($0))
	}

	prev_empty_lines = 0
	curr_empty_lines = 0
	next
}

section == "input" || section == "run" {
	section_excl_comm = section_excl_comm $0 "\n"
	section_incl_comm = section_incl_comm $0 "\n"
}

section == "run" {
	print $0 > "expected.out"
}

section == "" && !/^$/ && !/^#/ && !/^\// && !/^ \*/ {
	warn(NR, "non-comment line outside 'input' or 'run' section")
}

END {
	if (section != "")
		die(NR, "still in section " quote(section))
	check_unused_input()
	if (warned)
		exit(1)
}