diff options
Diffstat (limited to 'gdbsupport/remote-args.h')
-rw-r--r-- | gdbsupport/remote-args.h | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/gdbsupport/remote-args.h b/gdbsupport/remote-args.h new file mode 100644 index 0000000..93dbdc6 --- /dev/null +++ b/gdbsupport/remote-args.h @@ -0,0 +1,55 @@ +/* Functions to help when passing arguments between GDB and gdbserver. + + Copyright (C) 2023-2025 Free Software Foundation, Inc. + + This file is part of GDB. + + 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/>. */ + +/* The functions declared here are used when passing inferior arguments + from GDB to gdbserver. + + The remote protocol requires that arguments are passed as a vector of + separate argument while GDB stores the arguments as a single string, and + gdbserver also requires the arguments be a single string. + + These functions then provide a mechanism to split up an argument string + and recombine it within gdbserver while preserving escaping of special + characters within the argument string. */ + +namespace gdb +{ + +namespace remote_args +{ + +/* ARGS is an inferior argument string. This function splits ARGS into + individual arguments and returns a vector containing each argument. */ + +extern std::vector<std::string> split (const std::string &args); + +/* Join together the separate arguments in ARGS and build a single + inferior argument string. The string returned by this function will be + equivalent, but not necessarily identical to the string passed to + ::split, for example passing the string '"a b"' (without the single + quotes, but including the double quotes) to ::split, will return an + argument of 'a b' (without the single quotes). When this argument is + passed through ::join we will get back the string 'a\ b' (without the + single quotes), that is, we choose to escape the white space, rather + than wrap the argument in quotes. */ +extern std::string join (const std::vector<char *> &args); + +} /* namespace remote_args */ + +} /* namespac gdb */ |