SBType#

class lldb.SBType(*args)#

Represents a data type in lldb.

The actual characteristics of each type are defined by the semantics of the programming language and the specific language implementation that was used to compile the target program. See the language-specific notes in the documentation of each method.

SBType instances can be obtained by a variety of methods. SBTarget.FindFirstType and SBModule.FindFirstType can be used to create SBType representations of types in executables/libraries with debug information. For some languages such as C, C++ and Objective-C it is possible to create new types by evaluating expressions that define a new type.

Note that most SBType properties are computed independently of any runtime information so for dynamic languages the functionality can be very limited. SBValue can be used to represent runtime values which then can be more accurately queried for certain information such as byte size.

SBType supports the eq/ne operator. For example,:

//main.cpp:

class Task {
public:
    int id;
    Task *next;
    Task(int i, Task *n):
        id(i),
        next(n)
    {}
};

int main (int argc, char const *argv[])
{
    Task *task_head = new Task(-1, NULL);
    Task *task1 = new Task(1, NULL);
    Task *task2 = new Task(2, NULL);
    Task *task3 = new Task(3, NULL); // Orphaned.
    Task *task4 = new Task(4, NULL);
    Task *task5 = new Task(5, NULL);

    task_head->next = task1;
    task1->next = task2;
    task2->next = task4;
    task4->next = task5;

    int total = 0;
    Task *t = task_head;
    while (t != NULL) {
        if (t->id >= 0)
            ++total;
        t = t->next;
    }
    printf('We have a total number of %d tasks\n', total);

    // This corresponds to an empty task list.
    Task *empty_task_head = new Task(-1, NULL);

    return 0; // Break at this line
}

# find_type.py:

        # Get the type 'Task'.
        task_type = target.FindFirstType('Task')
        self.assertTrue(task_type)

        # Get the variable 'task_head'.
        frame0.FindVariable('task_head')
        task_head_type = task_head.GetType()
        self.assertTrue(task_head_type.IsPointerType())

        # task_head_type is 'Task *'.
        task_pointer_type = task_type.GetPointerType()
        self.assertTrue(task_head_type == task_pointer_type)

        # Get the child mmember 'id' from 'task_head'.
        id = task_head.GetChildMemberWithName('id')
        id_type = id.GetType()

        # SBType.GetBasicType() takes an enum 'BasicType' (lldb-enumerations.h).
        int_type = id_type.GetBasicType(lldb.eBasicTypeInt)
        # id_type and int_type should be the same type!
        self.assertTrue(id_type == int_type)

Attributes Summary

`bases`	A read only property that returns a list() of lldb.SBTypeMember objects that represent all of the direct base classes for this type.
`enum_members`	A read only property that returns a list() of all lldb.SBTypeEnumMember objects that represent the enum members for this type.
`fields`	A read only property that returns a list() of lldb.SBTypeMember objects that represent all of the fields for this type.
`is_complete`	A read only property that returns a boolean value that indicates if this type is a complete type (True) or a forward declaration (False).
`is_pointer`	A read only property that returns a boolean value that indicates if this type is a pointer type.
`is_reference`	A read only property that returns a boolean value that indicates if this type is a function type.
`members`	A read only property that returns a list() of all lldb.SBTypeMember objects that represent all of the base classes, virtual base classes and fields for this type in ascending bit offset order.
`module`	A read only property that returns the module in which type is defined.
`name`	A read only property that returns the name for this type as a string.
`num_bases`	A read only property that returns number of direct base classes in this type as an integer.
`num_fields`	A read only property that returns number of fields in this type as an integer.
`num_template_args`	A read only property that returns number of template arguments in this type as an integer.
`num_vbases`	A read only property that returns number of virtual base classes in this type as an integer.
`size`	A read only property that returns size in bytes for this type as an integer.
`template_args`	A read only property that returns a list() of lldb.SBType objects that represent all template arguments in this type.
`type`	A read only property that returns an lldb enumeration value (see enumerations that start with "lldb.eTypeClass") that represents a classification for this type.
`vbases`	A read only property that returns a list() of lldb.SBTypeMember objects that represent all of the virtual base classes for this type.

Methods Summary

`FindDirectNestedType`(SBType self, ...)	Searches for a directly nested type that has the provided name.
`GetArrayElementType`(SBType self)	Returns the array element type if this type is an array type.
`GetArrayType`(SBType self, uint64_t size)	Returns the array type with the given constant size.
`GetBasicType`(-> lldb)	Returns the BasicType value that is most appropriate to this type.
`GetByteSize`(SBType self)	Returns the number of bytes a variable with the given types occupies in memory.
`GetCanonicalType`(SBType self)
`GetDereferencedType`(SBType self)	Returns the underlying type of a reference type.
`GetDescription`(SBType self, ...)
`GetDirectBaseClassAtIndex`(SBType self, ...)	Returns the direct base class as indexed by `GetNumberOfDirectBaseClasses`.
`GetDisplayTypeName`()	Returns the name of this type in a user-friendly format.
`GetEnumMembers`(SBType self)
`GetEnumerationIntegerType`(SBType self)	Returns the underlying integer type if this is an enumeration type.
`GetFieldAtIndex`(SBType self, uint32_t idx)	Returns the field at the given index.
`GetFunctionArgumentTypes`(SBType self)	Returns the list of argument types if this type represents a function.
`GetFunctionReturnType`(SBType self)	Returns the return type if this type represents a function.
`GetMemberFunctionAtIndex`(SBType self, ...)	Returns the member function of this type with the given index.
`GetModule`(SBType self)	Returns the `SBModule` this `SBType` belongs to.
`GetName`()	Returns the name of this type.
`GetNumberOfDirectBaseClasses`(SBType self)	Returns the number of base/parent classes of this type.
`GetNumberOfFields`(SBType self)	Returns the number of fields of this type.
`GetNumberOfMemberFunctions`(SBType self)	Returns the number of member functions of this type.
`GetNumberOfTemplateArguments`(SBType self)	Returns the number of template arguments of this type.
`GetNumberOfVirtualBaseClasses`(SBType self)	Returns the number of virtual base/parent classes of this type
`GetPointeeType`(SBType self)	Returns the underlying pointee type.
`GetPointerType`(SBType self)	Returns a type that represents a pointer to this type.
`GetReferenceType`(SBType self)	Returns a type that represents a reference to this type.
`GetTemplateArgumentKind`(SBType self, ...)	Returns the kind of the template argument with the given index.
`GetTemplateArgumentType`(SBType self, ...)	Returns the type of the template argument with the given index.
`GetTypeClass`()	Returns the TypeClass for this type.
`GetTypeFlags`(SBType self)	Returns the TypeFlags values for this type.
`GetTypedefedType`(SBType self)	Returns the underlying type of a typedef.
`GetUnqualifiedType`(SBType self)	Returns the unqualified version of this type.
`GetVectorElementType`(SBType self)	Returns the vector element type if this type is a vector type.
`GetVirtualBaseClassAtIndex`(SBType self, ...)	Returns the virtual base class as indexed by `GetNumberOfVirtualBaseClasses`.
`IsAggregateType`(SBType self)	Returns true if this type is an aggregate type.
`IsAnonymousType`(SBType self)	Returns true if this type is an anonymous type.
`IsArrayType`(SBType self)	Returns true if this type is an array type.
`IsFunctionType`(SBType self)
`IsPointerType`(SBType self)	Returns true if this type is a pointer type.
`IsPolymorphicClass`(SBType self)	Returns true if this type is a polymorphic type.
`IsReferenceType`(SBType self)	Returns true if this type is a reference type.
`IsScopedEnumerationType`(SBType self)	Returns true if this type is a scoped enum.
`IsTypeComplete`(SBType self)	Returns true if the type is completely defined.
`IsTypedefType`(SBType self)	Returns true if this type is a typedef.
`IsValid`(SBType self)
`IsVectorType`(SBType self)	Returns true if this type is a vector type.
`get_bases_array`()	An accessor function that returns a list() that contains all direct base classes in a lldb.SBType object.
`get_enum_members_array`()	An accessor function that returns a list() that contains all enum members in an lldb.SBType object.
`get_fields_array`()	An accessor function that returns a list() that contains all fields in a lldb.SBType object.
`get_members_array`()	An accessor function that returns a list() that contains all members (base classes and fields) in a lldb.SBType object in ascending bit offset order.
`get_vbases_array`()	An accessor function that returns a list() that contains all fields in a lldb.SBType object.
`template_arg_array`()

Attributes Documentation

bases#: A read only property that returns a list() of lldb.SBTypeMember objects that represent all of the direct base classes for this type.

enum_members#: A read only property that returns a list() of all lldb.SBTypeEnumMember objects that represent the enum members for this type.

fields#: A read only property that returns a list() of lldb.SBTypeMember objects that represent all of the fields for this type.

is_complete#: A read only property that returns a boolean value that indicates if this type is a complete type (True) or a forward declaration (False).

is_pointer#: A read only property that returns a boolean value that indicates if this type is a pointer type.

is_reference#: A read only property that returns a boolean value that indicates if this type is a function type.

members#: A read only property that returns a list() of all lldb.SBTypeMember objects that represent all of the base classes, virtual base classes and fields for this type in ascending bit offset order.

module#: A read only property that returns the module in which type is defined.

name#: A read only property that returns the name for this type as a string.

num_bases#: A read only property that returns number of direct base classes in this type as an integer.

num_fields#: A read only property that returns number of fields in this type as an integer.

num_template_args#: A read only property that returns number of template arguments in this type as an integer.

num_vbases#: A read only property that returns number of virtual base classes in this type as an integer.

size#: A read only property that returns size in bytes for this type as an integer.

template_args#: A read only property that returns a list() of lldb.SBType objects that represent all template arguments in this type.

type#: A read only property that returns an lldb enumeration value (see enumerations that start with “lldb.eTypeClass”) that represents a classification for this type.

vbases#: A read only property that returns a list() of lldb.SBTypeMember objects that represent all of the virtual base classes for this type.

Methods Documentation

FindDirectNestedType(SBType self, char const * name) → SBType#

Searches for a directly nested type that has the provided name.

Returns the type if it was found. Returns invalid type if nothing was found.

GetArrayElementType(SBType self) → SBType#

Returns the array element type if this type is an array type.

Otherwise returns an invalid SBType if this type is invalid or not an array type.

Language-specific behaviour:

C: If this is an array type (see IsArrayType) such as T[], returns the element type.
C++: Same as in C.
Objective-C: Same as in C.