aboutsummaryrefslogtreecommitdiff
path: root/gdb/testsuite/gdb.base/style.exp
blob: aec1d0f42ed4a9d850f80e0768117c440b1ad6a8 (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
# Copyright 2018-2021 Free Software Foundation, Inc.

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

# Test CLI output styling.

standard_testfile

save_vars { env(TERM) } {
    # We need an ANSI-capable terminal to get the output.
    setenv TERM ansi

    set test_macros 0
    set options debug
    get_compiler_info
    if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
	lappend options additional_flags=-g3
	set test_macros 1
    }

    if {[prepare_for_testing "failed to prepare" $testfile $srcfile \
	     $options]} {
	return -1
    }

    set readnow [readnow]

    if {![runto_main]} {
	fail "style tests failed"
	return
    }

    # Check that the source highlighter has not stripped away the leading
    # newlines.
    set main_line [gdb_get_line_number "break here"]
    gdb_test "list $main_line,$main_line" "return.*some_called_function.*"

    gdb_test_no_output "set style enabled off"

    set argv ""
    gdb_test_multiple "frame" "frame without styling" {
	-re -wrap "main \\(argc=.*, (argv=$hex)\\).*style\\.c:\[0-9\].*" {
	    set argv $expect_out(1,string)
	    pass $gdb_test_name
	}
    }

    gdb_test_no_output "set style enabled on"

    set main_expr [style main function]
    set base_file_expr [style ".*style\\.c" file]
    set file_expr "$base_file_expr:\[0-9\]"
    set arg_expr [style "arg." variable]

    gdb_test "frame" \
	"$main_expr.*$arg_expr.*$arg_expr.*$file_expr.*"
    gdb_test "info breakpoints" "$main_expr at $file_expr.*"

    gdb_test_no_output "set style sources off"
    gdb_test "frame" \
	"\r\n\[^\033\]*break here.*" \
	"frame without sources styling"
    gdb_test_no_output "set style sources on"

    gdb_test "break -q main" "file $base_file_expr.*"

    gdb_test "print &main" " = .* [style $hex address] <$main_expr>"

    # Regression test for a bug where line-wrapping would occur at the
    # wrong spot with styling.  There were different bugs at different
    # widths, so try two.
    foreach width {20 30} {
	set argv_len [string length $argv]
	if { $argv_len == 0 } {
	    continue
	}

	# There was also a bug where the styling could be wrong in the
	# line listing; this is why the words from the source code are
	# spelled out in the final result line of the test.
	set re1_styled \
	    [multi_line \
		 "#0 *$main_expr.*$arg_expr.*" \
		 ".*$arg_expr.*" \
		 ".* at .*$file_expr.*" \
		 "\[0-9\]+.*return.* break here .*"]
	set re2_styled \
	    [multi_line \
		 "#0 *$main_expr.*$arg_expr.*" \
		 ".*$arg_expr.* at .*$file_expr.*" \
		 "\[0-9\]+.*return.* break here .*"]

	# The length of the line containing argv containing:
	# - 4 leading spaces
	# - argv string
	# - closing parenthesis
	set line_len [expr 4 + $argv_len + 1]

	if { $line_len > $width } {
	    # At on the next line.
	    set re_styled $re1_styled
	} else {
	    # At on the same line as argv.
	    set re_styled $re2_styled
	}

	gdb_test_no_output "set width $width"
	gdb_test "frame" $re_styled "frame when width=$width"
    }

    # Reset width back to 0.
    gdb_test_no_output "set width 0"

    if {$test_macros} {
	set macro_line [gdb_get_line_number "\#define SOME_MACRO"]
	gdb_test "info macro SOME_MACRO" \
	    "Defined at $base_file_expr:$macro_line\r\n#define SOME_MACRO 23"
    }

    set main [style main function]
    set func [style some_called_function function]
    # Somewhere should see the call to the function.
    gdb_test "disassemble main" \
	[concat "Dump of assembler code for function $main:.*" \
	     "[style $hex address].*$func.*"]

    set ifield [style int_field variable]
    set sfield [style string_field variable]
    set efield [style e_field variable]
    set evalue [style VALUE_TWO variable]
    gdb_test "print struct_value" \
	"\{$ifield = 23,.*$sfield = .*,.*$efield = $evalue.*"

    gdb_exit
    gdb_spawn

    set vers [style "GNU gdb.*" "35;1"]
    gdb_test "" "${vers}.*" \
	"version is styled"

    set address_style_expr [style ".*\".*address.*\".*style.*" address]
    gdb_test "show style address foreground" \
	"The ${address_style_expr} foreground color is: blue" \
	"style name and style word styled using its own style in show style"

    set aliases_expr [style ".*aliases.*" title]
    set breakpoints_expr [style ".*breakpoints.*" title]
    gdb_test "help" \
	[multi_line \
	     "List of classes of commands:" \
	     "" \
	     "${aliases_expr} -- User-defined aliases of other commands\." \
	     "${breakpoints_expr} -- Making program stop at certain points\." \
	     ".*" \
	    ] \
	"help classes of commands styled with title"

    set taas_expr  [style ".*taas.*" title]
    set tfaas_expr  [style ".*tfaas.*" title]
    set cut_for_thre_expr [style "cut for 'thre" highlight]
    gdb_test "apropos -v cut for 'thre" \
	[multi_line \
	     "" \
	     "${taas_expr}" \
	     "Apply a command to all .*" \
	     "Usage:.*" \
	     "short${cut_for_thre_expr}ad apply.*" \
	     "" \
	     "${tfaas_expr}" \
	     "Apply a command to all .*" \
	     "Usage:.*" \
	     "short${cut_for_thre_expr}ad apply.*" \
	    ]

    set quoted [string_to_regexp $binfile]
    set pass_re "Reading symbols from [style $quoted file]\.\.\."
    if { $readnow } {
	set pass_re \
	    [multi_line \
		 $pass_re \
		 "Expanding full symbols from [style $quoted file]\.\.\."]
    }
    gdb_test "file $binfile" \
	$pass_re \
	"filename is styled when loading symbol file"

    gdb_test "pwd" "Working directory [style .*? file].*"

    gdb_test_no_output "set print repeat 3"
    gdb_test "print {0,0,0,0,0,0,0,0}" \
	" = \\{0 [style {<repeats.*8.*times>} metadata]\\}"

    gdb_test "show logging file" \
	"The current logfile is \"[style .*? file]\"\\..*"

    # Check warnings are styled by setting a rubbish data directory.
    gdb_test "set data-directory Makefile" \
	"warning: [style .*? file] is not a directory\\..*"
    gdb_test "show data-directory" \
	"GDB's data directory is \"[style .*? file]\"\\..*"

    # Check that deprecation styles command names.
    gdb_test_no_output "maintenance deprecate p \"new_p\"" \
	"maintenance deprecate p \"new_p\" /1/"
    gdb_test "p 5" \
	"Warning: '[style p title]', an alias for the command '[style print title]', is deprecated.*Use '[style new_p title]'.*" \
	"p deprecated warning, with replacement"
}