forked from Imagelibrary/binutils-gdb
7abc6ec0a6
I noticed that, from Python, I could register a new TUI window that
had whitespace in its name, like this:
gdb.register_window_type('my window', MyWindowType)
however, it is not possible to then use this window in a new TUI
layout, e.g.:
(gdb) tui new-layout foo my window 1 cmd 1
Unknown window "my"
(gdb) tui new-layout foo "my window" 1 cmd 1
Unknown window ""my"
(gdb) tui new-layout foo my\ window 1 cmd 1
Unknown window "my\"
GDB clearly uses the whitespace to split the incoming command line.
I could fix this by trying to add a mechanism by which we can use
whitespace within a window name, but it seems like an easier solution
if we just forbid whitespace within a window name. Not only is this
easier, but I think this is probably the better solution, identifier
names with spaces in would mean we'd need to audit all the places a
window name could be printed and ensure that the use of a space didn't
make the output ambiguous.
So, having decided to disallow whitespace, I then thought about other
special characters. We currently accept anything as a window name,
and I wondered if this was a good idea.
My concerns were about how special characters used in a window name
might cause confusion, for example, we allow '$' in window names,
which is maybe fine now, but what if one day we wanted to allow
variable expansion when creating new layouts? Or what about starting
a window name with '-'? We already support a '-horizontal' option,
what if we want to add more in the future? Or use of the special
character '{' which has special meaning within a new layout?
In the end I figured it might make sense to place some restrictive
rules in place, and then relax the rules later if/when users complain,
we can consider each relaxation as its requested.
So, I propose that window names should match this regular expression:
[a-zA-Z][-_.a-zA-Z0-9]*
There is a chance that there is user code in the wild which will break
with the addition of this change, but hopefully adapting to the new
restrictions shouldn't be too difficult.
85 lines
3.1 KiB
Plaintext
85 lines
3.1 KiB
Plaintext
# Copyright (C) 2022 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 that GDB rejects invalid TUI window names, and that valid names
|
|
# are allowed.
|
|
|
|
load_lib gdb-python.exp
|
|
|
|
tuiterm_env
|
|
|
|
clean_restart
|
|
|
|
if {[skip_tui_tests]} {
|
|
return
|
|
}
|
|
|
|
# Define a function we can use as a window constructor. If this ever
|
|
# gets called we'll throw an error, but that's OK, this test doesn't
|
|
# actually try to create any windows.
|
|
gdb_test_multiline "create a window constructor" \
|
|
"python" "" \
|
|
"def failwin(win):" "" \
|
|
" raise RuntimeError('failwin')" "" \
|
|
"end" ""
|
|
|
|
# Check for some of the characters that can't be used within a window
|
|
# name.
|
|
foreach c {$ * \{ \} ( ) @ #} {
|
|
set re [string_to_regexp "$c"]
|
|
gdb_test "python gdb.register_window_type('te${c}st', failwin)" \
|
|
[multi_line \
|
|
"gdb.error: invalid character '${re}' in window name" \
|
|
"Error while executing Python code\\." ]
|
|
|
|
gdb_test "python gdb.register_window_type('${c}test', failwin)" \
|
|
[multi_line \
|
|
"gdb.error: invalid character '${re}' in window name" \
|
|
"Error while executing Python code\\." ]
|
|
}
|
|
|
|
# Check that whitespace within a window name is rejected.
|
|
foreach c [list " " "\\t" "\\n" "\\r"] {
|
|
gdb_test "python gdb.register_window_type('te${c}st', failwin)" \
|
|
[multi_line \
|
|
"gdb.error: invalid whitespace character in window name" \
|
|
"Error while executing Python code\\." ]
|
|
}
|
|
|
|
# Check some of the characters which are allowed within a window name,
|
|
# but are not allowed to be used as the first character.
|
|
foreach c {1 _ - .} {
|
|
set re [string_to_regexp "$c"]
|
|
gdb_test "python gdb.register_window_type('${c}test', failwin)" \
|
|
[multi_line \
|
|
"gdb.error: window name must start with a letter, not '${re}'" \
|
|
"Error while executing Python code\\." ]
|
|
}
|
|
|
|
# Check different capitalisations.
|
|
gdb_test_no_output "python gdb.register_window_type('TEST', failwin)"
|
|
gdb_test_no_output "python gdb.register_window_type('test', failwin)"
|
|
gdb_test_no_output "python gdb.register_window_type('tEsT', failwin)"
|
|
gdb_test_no_output "python gdb.register_window_type('TeSt', failwin)"
|
|
|
|
# Check a set of characters that can appear within a name, just not
|
|
# necessarily as the first character. We check at both the end of the
|
|
# name, and within the name.
|
|
foreach c {1 _ - . A} {
|
|
set re [string_to_regexp "$c"]
|
|
gdb_test_no_output "python gdb.register_window_type('test${c}', failwin)"
|
|
gdb_test_no_output "python gdb.register_window_type('te${c}st', failwin)"
|
|
}
|