gdb.types (Debugging with GDB)

23.3.4.2 gdb.types

This module provides a collection of utilities for working with gdb.Type objects.

get_basic_type (type)

Return type with const and volatile qualifiers stripped, and with typedefs and C++ references converted to the underlying type.

C++ example:

typedef const int const_int;
const_int foo (3);
const_int& foo_ref (foo);
int main () { return 0; }

Then in gdb:

(gdb) start
(gdb) python import gdb.types
(gdb) python foo_ref = gdb.parse_and_eval("foo_ref")
(gdb) python print gdb.types.get_basic_type(foo_ref.type)
int

has_field (type, field)

Return True if type, assumed to be a type with fields (e.g., a structure or union), has field field.

make_enum_dict (enum_type)

Return a Python dictionary type produced from enum_type.

deep_items (type)

Returns a Python iterator similar to the standard gdb.Type.iteritems method, except that the iterator returned by deep_items will recursively traverse anonymous struct or union fields. For example:

struct A
{
    int a;
    union {
        int b0;
        int b1;
    };
};

Then in GDB:

(gdb) python import gdb.types
(gdb) python struct_a = gdb.lookup_type("struct A")
(gdb) python print struct_a.keys ()
{['a', '']}
(gdb) python print [k for k,v in gdb.types.deep_items(struct_a)]
{['a', 'b0', 'b1']}

get_type_recognizers ()

Return a list of the enabled type recognizers for the current context. This is called by GDB during the type-printing process (see Type Printing API).

apply_type_recognizers (recognizers, type_obj)

Apply the type recognizers, recognizers, to the type object type_obj. If any recognizer returns a string, return that string. Otherwise, return None. This is called by GDB during the type-printing process (see Type Printing API).

register_type_printer (locus, printer)

This is a convenience function to register a type printer printer. The printer must implement the type printer protocol. The locus argument is either a gdb.Objfile, in which case the printer is registered with that objfile; a gdb.Progspace, in which case the printer is registered with that progspace; or None, in which case the printer is registered globally.

TypePrinter

This is a base class that implements the type printer protocol. Type printers are encouraged, but not required, to derive from this class. It defines a constructor:

Method on TypePrinter: __init__ (self, name): Initialize the type printer with the given name. The new printer starts in the enabled state.