/* Data structures and API for event locations in GDB.
- Copyright (C) 2013-2017 Free Software Foundation, Inc.
+ Copyright (C) 2013-2020 Free Software Foundation, Inc.
This file is part of GDB.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
-#ifndef LOCATIONS_H
-#define LOCATIONS_H 1
+#ifndef LOCATION_H
+#define LOCATION_H
+
+#include "symtab.h"
struct language_defn;
struct event_location;
PROBE_LOCATION
};
+/* A traditional linespec. */
+
+struct linespec_location
+{
+ /* Whether the function name is fully-qualified or not. */
+ symbol_name_match_type match_type;
+
+ /* The linespec. */
+ char *spec_string;
+};
+
/* An explicit location. This structure is used to bypass the
parsing done on linespecs. It still has the same requirements
as linespecs, though. For example, source_filename requires
/* The function name. Malloc'd. */
char *function_name;
+ /* Whether the function name is fully-qualified or not. */
+ symbol_name_match_type func_name_match_type;
+
/* The name of a label. Malloc'd. */
char *label_name;
/* Return a string representation of the LOCATION.
This function may return NULL for unspecified linespecs,
- e.g, LOCATION_LINESPEC and addr_string is NULL.
+ e.g, LINESPEC_LOCATION and spec_string is NULL.
The result is cached in LOCATION. */
extern const char *
event_location_to_string (struct event_location *location);
-/* Create a new linespec location. The return result is malloc'd
- and should be freed with delete_event_location. */
+/* A deleter for a struct event_location. */
+
+struct event_location_deleter
+{
+ void operator() (event_location *location) const;
+};
+
+/* A unique pointer for event_location. */
+typedef std::unique_ptr<event_location, event_location_deleter>
+ event_location_up;
-extern struct event_location *
- new_linespec_location (char **linespec);
+/* Create a new linespec location. */
-/* Return the linespec location (a string) of the given event_location
- (which must be of type LINESPEC_LOCATION). */
+extern event_location_up new_linespec_location
+ (const char **linespec, symbol_name_match_type match_type);
-extern const char *
+/* Return the linespec location of the given event_location (which
+ must be of type LINESPEC_LOCATION). */
+
+extern const linespec_location *
get_linespec_location (const struct event_location *location);
/* Create a new address location.
ADDR_STRING, a string of ADDR_STRING_LEN characters, is
the expression that was parsed to determine the address ADDR. */
-extern struct event_location *
- new_address_location (CORE_ADDR addr, const char *addr_string,
- int addr_string_len);
+extern event_location_up new_address_location (CORE_ADDR addr,
+ const char *addr_string,
+ int addr_string_len);
/* Return the address location (a CORE_ADDR) of the given event_location
(which must be of type ADDRESS_LOCATION). */
extern const char *
get_address_string_location (const struct event_location *location);
-/* Create a new probe location. The return result is malloc'd
- and should be freed with delete_event_location. */
+/* Create a new probe location. */
-extern struct event_location *
- new_probe_location (const char *probe);
+extern event_location_up new_probe_location (const char *probe);
/* Return the probe location (a string) of the given event_location
(which must be of type PROBE_LOCATION). */
initialize_explicit_location (struct explicit_location *explicit_loc);
/* Create a new explicit location. If not NULL, EXPLICIT is checked for
- validity. If invalid, an exception is thrown.
-
- The return result is malloc'd and should be freed with
- delete_event_location. */
+ validity. If invalid, an exception is thrown. */
-extern struct event_location *
+extern event_location_up
new_explicit_location (const struct explicit_location *explicit_loc);
/* Return the explicit location of the given event_location
extern const struct explicit_location *
get_explicit_location_const (const struct event_location *location);
-/* Free an event location and any associated data. */
-
-extern void delete_event_location (struct event_location *location);
-
-/* Make a cleanup to free LOCATION. */
-
-extern struct cleanup *
- make_cleanup_delete_event_location (struct event_location *location);
-
/* Return a copy of the given SRC location. */
-extern struct event_location *
+extern event_location_up
copy_event_location (const struct event_location *src);
/* Attempt to convert the input string in *ARGP into an event_location.
but invalid, input, e.g., if it is called with missing argument parameters
or invalid options.
- The return result must be freed with delete_event_location.
-
This function is intended to be used by CLI commands and will parse
explicit locations in a CLI-centric way. Other interfaces should use
string_to_event_location_basic if they want to maintain support for
- legacy specifications of probe, address, and linespec locations. */
+ legacy specifications of probe, address, and linespec locations.
+
+ MATCH_TYPE should be either WILD or FULL. If -q/--qualified is specified
+ in the input string, it will take precedence over this parameter. */
+
+extern event_location_up string_to_event_location
+ (const char **argp, const struct language_defn *language,
+ symbol_name_match_type match_type = symbol_name_match_type::WILD);
-extern struct event_location *
- string_to_event_location (char **argp,
- const struct language_defn *langauge);
+/* Like string_to_event_location, but does not attempt to parse
+ explicit locations. MATCH_TYPE indicates how function names should
+ be matched. */
-/* Like string_to_event_location, but does not attempt to parse explicit
- locations. */
+extern event_location_up
+ string_to_event_location_basic (const char **argp,
+ const struct language_defn *language,
+ symbol_name_match_type match_type);
-extern struct event_location *
- string_to_event_location_basic (char **argp,
- const struct language_defn *language);
+/* Structure filled in by string_to_explicit_location to aid the
+ completer. */
+struct explicit_completion_info
+{
+ /* Pointer to the last option found. E.g., in "b -sou src.c -fun
+ func", LAST_OPTION is left pointing at "-fun func". */
+ const char *last_option = NULL;
+
+ /* These point to the start and end of a quoted argument, iff the
+ last argument was quoted. If parsing finds an incomplete quoted
+ string (e.g., "break -function 'fun"), then QUOTED_ARG_START is
+ set to point to the opening \', and QUOTED_ARG_END is left NULL.
+ If the last option is not quoted, then both are set to NULL. */
+ const char *quoted_arg_start = NULL;
+ const char *quoted_arg_end = NULL;
+
+ /* True if we saw an explicit location option, as opposed to only
+ flags that affect both explicit locations and linespecs, like
+ "-qualified". */
+ bool saw_explicit_location_option = false;
+};
/* Attempt to convert the input string in *ARGP into an explicit location.
ARGP is advanced past any processed input. Returns an event_location
(malloc'd) if an explicit location was successfully found in *ARGP,
NULL otherwise.
- IF !DONT_THROW, this function may call error() if *ARGP looks like
- properly formed input, e.g., if it is called with missing argument
- parameters or invalid options. If DONT_THROW is non-zero, this function
- will not throw any exceptions. */
+ If COMPLETION_INFO is NULL, this function may call error() if *ARGP
+ looks like improperly formed input, e.g., if it is called with
+ missing argument parameters or invalid options. If COMPLETION_INFO
+ is not NULL, this function will not throw any exceptions. */
-extern struct event_location *
+extern event_location_up
string_to_explicit_location (const char **argp,
- const struct language_defn *langauge,
- int dont_throw);
+ const struct language_defn *language,
+ explicit_completion_info *completion_info);
/* A convenience function for testing for unset locations. */
extern void
set_event_location_string (struct event_location *location,
const char *string);
-#endif /* LOCATIONS_H */
+
+#endif /* LOCATION_H */
projects / deliverable / binutils-gdb.git / blobdiff