This documents the new Python and Guile constants introduced earlier
in this series.
Reviewed-By: Eli Zaretskii <eliz@gnu.org>
---
gdb/NEWS | 12 ++++++++++++
gdb/doc/guile.texi | 13 +++++++++++++
gdb/doc/python.texi | 30 +++++++++++++++++++++++++++---
3 files changed, 52 insertions(+), 3 deletions(-)
@@ -108,6 +108,11 @@ show remote thread-options-packet
object, these will be stored in the object's new
InferiorThread.__dict__ attribute.
+ ** New constants gdb.SYMBOL_TYPE_DOMAIN, gdb.SYMBOL_FUNCTION_DOMAIN,
+ and gdb.SEARCH_*_DOMAIN corresponding to all the existing symbol
+ domains. Symbol lookup can now search in multiple domains at
+ once, and can also narrowly search for just a type or function.
+
* Debugger Adapter Protocol changes
** GDB now emits the "process" event.
@@ -121,6 +126,13 @@ show remote thread-options-packet
** The "set debug dap-log-file" command is now documented. This
command was available in GDB 14 but not documented.
+* Guile API
+
+ ** New constants SYMBOL_TYPE_DOMAIN, SYMBOL_FUNCTION_DOMAIN, and
+ SEARCH_*_DOMAIN corresponding to all the existing symbol domains.
+ Symbol lookup can now search in multiple domains at once, and can
+ also narrowly search for just a type or function.
+
* New remote packets
New stop reason: clone
@@ -2802,6 +2802,14 @@ in the symbol information or in @value{GDBN}'s handling of symbols.
This domain contains variables, function names, typedef names and enum
type values.
+@item SYMBOL_FUNCTION_DOMAIN
+This domain contains functions.
+
+@item SYMBOL_TYPE_DOMAIN
+This domain contains types. In a C-like language, types using a tag
+will not appear here; in other languages, all types are in this
+domain.
+
@item SYMBOL_STRUCT_DOMAIN
This domain holds struct, union and enum type names.
@@ -2822,6 +2830,11 @@ This domain contains all types.
The available address class categories in @code{<gdb:symbol>} are represented
as constants in the @code{gdb} module:
+When searching for a symbol, the desired domain constant can be passed
+verbatim to the lookup function. For more complex searches, there is
+a corresponding set of constants using a @samp{SEARCH_} prefix. These
+may be or'd together to form a search constant.
+
@vtable @code
@item SYMBOL_LOC_UNDEF
If this is returned by address class, it indicates an error either in
@@ -6214,12 +6214,22 @@ in the symbol information or in @value{GDBN}'s handling of symbols.
@vindex SYMBOL_VAR_DOMAIN
@item gdb.SYMBOL_VAR_DOMAIN
-This domain contains variables, function names, typedef names and enum
-type values.
+This domain contains variables.
+
+@vindex SYMBOL_FUNCTION_DOMAIN
+@item gdb.SYMBOL_FUNCTION_DOMAIN
+This domain contains functions.
+
+@vindex SYMBOL_TYPE_DOMAIN
+@item gdb.SYMBOL_TYPE_DOMAIN
+This domain contains types. In a C-like language, types using a tag
+will not appear here; in other languages, all types are in this
+domain.
@vindex SYMBOL_STRUCT_DOMAIN
@item gdb.SYMBOL_STRUCT_DOMAIN
-This domain holds struct, union and enum type names.
+This domain holds struct, union and enum tag names. This domain is
+only used for C-like languages.
@vindex SYMBOL_LABEL_DOMAIN
@item gdb.SYMBOL_LABEL_DOMAIN
@@ -6234,6 +6244,20 @@ This domain contains names of Fortran module types.
This domain contains names of Fortran common blocks.
@end vtable
+When searching for a symbol, the desired domain constant can be passed
+verbatim to the lookup function. For example:
+@smallexample
+symbol = gdb.lookup_symbol ("name", domain=gdb.SYMBOL_VAR_DOMAIN)
+@end smallexample
+
+For more complex searches, there is a corresponding set of constants
+using a @samp{SEARCH_} prefix. These may be or'd together to form a
+search constant, e.g.:
+@smallexample
+symbol = gdb.lookup_symbol ("name",
+ domain=gdb.SEARCH_VAR_DOMAIN | gdb.SEARCH_TYPE_DOMAIN)
+@end smallexample
+
The available address class categories in @code{gdb.Symbol} are represented
as constants in the @code{gdb} module: