# Copyright (c) 2015-2026 Vector 35 Inc

#

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to

# deal in the Software without restriction, including without limitation the

# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

# sell copies of the Software, and to permit persons to whom the Software is

# furnished to do so, subject to the following conditions:

#

# The above copyright notice and this permission notice shall be included in

# all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

# IN THE SOFTWARE.

import ctypes

import typing

from typing import Generator, List, Union, Tuple, Optional, Iterable, Dict, Generic, TypeVar, Callable, overload

from dataclasses import dataclass

import uuid

# Binary Ninja components

from . import _binaryninjacore as core

from .enums import (

InlineDuringAnalysis, StructureVariant, SymbolType, SymbolBinding, TypeClass, NamedTypeReferenceClass,

ReferenceType, VariableSourceType,

TypeReferenceType, MemberAccess, MemberScope, TypeDefinitionLineType,

TokenEscapingType,

NameType, PointerSuffix, PointerBaseType

)

from . import callingconvention

from . import function as _function

from . import variable

from . import architecture

from . import binaryview

from . import platform as _platform

from . import typecontainer

from . import typelibrary

from . import typeparser

QualifiedNameType = Union[Iterable[Union[str, bytes]], str, 'QualifiedName']

BoolWithConfidenceType = Union[bool, 'BoolWithConfidence']

OffsetWithConfidenceType = Union[int, 'OffsetWithConfidence']

ParamsType = Union[List['Type'], List['FunctionParameter'], List[Tuple[str, 'Type']]]

MembersType = Union[List['StructureMember'], List['Type'], List[Tuple['Type', str]]]

EnumMembersType = Union[List[Tuple[str, int]], List[str], List['EnumerationMember']]

SomeType = Union['TypeBuilder', 'Type']

TypeContainerType = Union['binaryview.BinaryView', 'typelibrary.TypeLibrary']

NameSpaceType = Optional[Union[str, List[str], 'NameSpace']]

TypeParserResult = typeparser.TypeParserResult

BasicTypeParserResult = typeparser.BasicTypeParserResult

ResolveMemberCallback = Callable[['NamedTypeReferenceType', 'StructureType', int, int, int, 'StructureMember'], None]

# The following are needed to prevent the type checker from getting

# confused as we have member functions in `Type` named the same thing

_int = int

_bool = bool

MemberName = str

MemberIndex = int

MemberOffset = int

TB = TypeVar('TB', bound='TypeBuilder')

def convert_integer(value: ctypes.c_uint64, signed: bool, width: int) -> int:

if width not in [1, 2, 4, 8]:

raise ValueError("Width must be 1, 2, 4, or 8 bytes")

func = {

True: {

1: ctypes.c_int8,

2: ctypes.c_int16,

4: ctypes.c_int32,

8: ctypes.c_int64

},

False: {

1: ctypes.c_uint8,

2: ctypes.c_uint16,

4: ctypes.c_uint32,

8: ctypes.c_uint64

}

}

return func[bool(signed)][width](value).value

class QualifiedName:

def __init__(self, name: Optional[QualifiedNameType] = None, join: str = "::"):

self._name: List[str] = []

if isinstance(name, str):

self._name = [name]

elif isinstance(name, bytes):

self._name = [name.decode("utf-8")]

elif isinstance(name, self.__class__):

self._name = name._name

elif isinstance(name, (list, tuple)):

for i in name:

if isinstance(i, bytes):

self._name.append(i.decode("utf-8"))

else:

self._name.append(str(i))

self._join = join

def __str__(self):

return self.join.join(self.name)

def __repr__(self):

return repr(str(self))

def __len__(self):

return len(self.name)

def __eq__(self, other):

if isinstance(other, str):

return str(self) == other

elif isinstance(other, list):

return self.name == other

elif isinstance(other, self.__class__):

return self.name == other.name and self.join == other.join

return NotImplemented

def __ne__(self, other):

if isinstance(other, str):

return str(self) != other

elif isinstance(other, list):

return self.name != other

elif isinstance(other, self.__class__):

return self.name != other.name

return NotImplemented

def __lt__(self, other):

if isinstance(other, self.__class__):

return self.name < other.name

return NotImplemented

def __le__(self, other):

if isinstance(other, self.__class__):

return self.name <= other.name

return NotImplemented

def __gt__(self, other):

if isinstance(other, self.__class__):

return self.name > other.name

return NotImplemented

def __ge__(self, other):

if isinstance(other, self.__class__):

return self.name >= other.name

return NotImplemented

def __hash__(self):

return hash(str(self))

def __getitem__(self, key):

return self.name[key]

def __iter__(self):

return iter(self.name)

def _to_core_struct(self) -> core.BNQualifiedName:

result = core.BNQualifiedName()

name_list = (ctypes.c_char_p * len(self.name))()

for i in range(0, len(self.name)):

name_list[i] = self.name[i].encode("utf-8")

result.name = name_list

result.nameCount = len(self.name)

result.join = self.join

return result

@staticmethod

def _from_core_struct(name):

result = []

for i in range(0, name.nameCount):

result.append(name.name[i].decode("utf-8"))

return QualifiedName(result, name.join)

@property

def name(self) -> List[str]:

return self._name

@name.setter

def name(self, value: List[str]) -> None:

self._name = value

@property

def join(self) -> str:

return self._join

@join.setter

def join(self, value: str) -> None:

self._join = value

@staticmethod

def escape(name: QualifiedNameType, escaping: TokenEscapingType) -> str:

return core.BNEscapeTypeName(str(QualifiedName(name)), escaping)

@staticmethod

def unescape(name: QualifiedNameType, escaping: TokenEscapingType) -> str:

return core.BNUnescapeTypeName(str(QualifiedName(name)), escaping)

@dataclass(frozen=True)

class TypeReferenceSource:

name: QualifiedName

offset: int

ref_type: TypeReferenceType

def __repr__(self):

if self.ref_type == TypeReferenceType.DirectTypeReferenceType:

s = 'direct'

elif self.ref_type == TypeReferenceType.IndirectTypeReferenceType:

s = 'indirect'

else:

s = 'unknown'

return '<type %s, offset 0x%x, %s>' % (self.name, self.offset, s)

class NameSpace(QualifiedName):

def _to_core_struct(self) -> core.BNNameSpace:

result = core.BNNameSpace()

name_list = (ctypes.c_char_p * len(self.name))()

for i in range(0, len(self.name)):

name_list[i] = self.name[i].encode('utf-8')

result.name = name_list

result.nameCount = len(self.name)

result.join = self.join

return result

@staticmethod

def _from_core_struct(name: core.BNNameSpace) -> 'NameSpace':

result = []

for i in range(0, name.nameCount):

result.append(name.name[i].decode("utf-8"))

return NameSpace(result, name.join)

@staticmethod

def get_core_struct(name: Optional[Union[str, List[str], 'NameSpace']]) -> Optional[core.BNNameSpace]:

if name is None:

return None

if isinstance(name, NameSpace):

return name._to_core_struct()

else:

return NameSpace(name)._to_core_struct()

@dataclass(frozen=True)

class TypeDefinitionLine:

line_type: TypeDefinitionLineType

tokens: List['_function.InstructionTextToken']

type: 'Type'

parent_type: 'Type'

root_type: 'Type'

root_type_name: str

base_type: Optional['NamedTypeReferenceType']

base_offset: int

offset: int

field_index: int

def __str__(self):

return "".join(map(str, self.tokens))

def __repr__(self):

return f"<typeDefinitionLine {self.type}: {self}>"

@staticmethod

def _from_core_struct(struct: core.BNTypeDefinitionLine, platform: Optional[_platform.Platform] = None):

tokens = _function.InstructionTextToken._from_core_struct(struct.tokens, struct.count)

type_ = Type.create(handle=core.BNNewTypeReference(struct.type), platform=platform)

parent_type = Type.create(handle=core.BNNewTypeReference(struct.parentType), platform=platform)

root_type = Type.create(handle=core.BNNewTypeReference(struct.rootType), platform=platform)

root_type_name = core.pyNativeStr(struct.rootTypeName)

if struct.baseType:

const_conf = BoolWithConfidence.get_core_struct(False, 0)

volatile_conf = BoolWithConfidence.get_core_struct(False, 0)

handle = core.BNCreateNamedTypeReference(struct.baseType, 0, 1, const_conf, volatile_conf)

base_type = NamedTypeReferenceType(handle, platform)

else:

base_type = None

return TypeDefinitionLine(struct.lineType, tokens, type_, parent_type, root_type, root_type_name, base_type,

struct.baseOffset, struct.offset, struct.fieldIndex)

def _to_core_struct(self):

struct = core.BNTypeDefinitionLine()

struct.lineType = self.line_type

struct.tokens = _function.InstructionTextToken._get_core_struct(self.tokens)

struct.count = len(self.tokens)

struct.type = core.BNNewTypeReference(self.type.handle)

struct.parentType = core.BNNewTypeReference(self.parent_type.handle)

struct.rootType = core.BNNewTypeReference(self.root_type.handle)

struct.rootTypeName = self.root_type_name

if self.base_type is None:

struct.baseType = None

else:

struct.baseType = core.BNNewNamedTypeReference(self.base_type.ntr_handle)

struct.baseOffset = self.base_offset

struct.offset = self.offset

struct.fieldIndex = self.field_index

return struct

class CoreSymbol:

def __init__(self, handle: core.BNSymbolHandle):

self._handle = handle

def __del__(self):

if core is not None:

core.BNFreeSymbol(self._handle)

def __repr__(self):

try:

return f"<{self.type.name}: \"{self.full_name}\" @ {self.address:#x}>"

except UnicodeDecodeError:

return f"<{self.type.name}: \"{self.raw_bytes}\" @ {self.address:#x}>"

def __eq__(self, other):

if not isinstance(other, self.__class__):

return NotImplemented

return ctypes.addressof(self._handle.contents) == ctypes.addressof(other._handle.contents)

def __ne__(self, other):

if not isinstance(other, self.__class__):

return NotImplemented

return not (self == other)

def __hash__(self):

return hash(ctypes.addressof(self._handle.contents))

@property

def type(self) -> SymbolType:

"""Symbol type (read-only)"""

return SymbolType(core.BNGetSymbolType(self._handle))

@property

def binding(self) -> SymbolBinding:

"""Symbol binding (read-only)"""

return SymbolBinding(core.BNGetSymbolBinding(self._handle))

@property

def namespace(self) -> 'NameSpace':

"""Symbol namespace (read-only)"""

ns = core.BNGetSymbolNameSpace(self._handle)

result = NameSpace._from_core_struct(ns)

core.BNFreeNameSpace(ns)

return result

@property

def name(self) -> str:

"""Symbol name (read-only)"""

return core.BNGetSymbolRawName(self._handle)

@property

def short_name(self) -> str:

"""Symbol short name (read-only)"""

return core.BNGetSymbolShortName(self._handle)

@property

def full_name(self) -> str:

"""Symbol full name (read-only)"""

return core.BNGetSymbolFullName(self._handle)

@property

def raw_name(self) -> str:

"""Symbol raw name (read-only)"""

return core.BNGetSymbolRawName(self._handle)

@property

def raw_bytes(self) -> bytes:

"""Bytes of the raw symbol (read-only)"""

count = ctypes.c_ulonglong()

result = core.BNGetSymbolRawBytes(self._handle, count)

assert result is not None, "core.BNGetSymbolRawBytes returned None"

buf = ctypes.create_string_buffer(count.value)

ctypes.memmove(buf, result, count.value)

core.BNFreeSymbolRawBytes(result)

return buf.raw

@property

def address(self) -> int:

"""Symbol address (read-only)"""

return core.BNGetSymbolAddress(self._handle)

@property

def ordinal(self) -> int:

"""Symbol ordinal (read-only)"""

return core.BNGetSymbolOrdinal(self._handle)

@property

def auto(self) -> bool:

"""Whether the symbol was auto-defined"""

return core.BNIsSymbolAutoDefined(self._handle)

@property

def handle(self):

return self._handle

def imported_function_from_import_address_symbol(self, addr: int) -> Optional['CoreSymbol']:

sym = core.BNImportedFunctionFromImportAddressSymbol(self._handle, addr)

if sym is None:

return None

return CoreSymbol(sym)

class Symbol(CoreSymbol):

"""

Symbols are defined as one of the following types:

=========================== =================================================================

SymbolType Description

=========================== =================================================================

FunctionSymbol Symbol for function that exists in the current binary

ImportAddressSymbol Symbol defined in the Import Address Table

ImportedFunctionSymbol Symbol for a function that is not defined in the current binary

DataSymbol Symbol for data in the current binary

ImportedDataSymbol Symbol for data that is not defined in the current binary

ExternalSymbol Symbols for data and code that reside outside the BinaryView

LibraryFunctionSymbol Symbols for functions identified as belonging to a shared library

SymbolicFunctionSymbol Symbols for functions without a concrete implementation or which have been abstractly represented

LocalLabelSymbol Symbol for a local label in the current binary

=========================== =================================================================

"""

def __init__(

self, sym_type, addr, short_name, full_name=None, raw_name=None, binding=None, namespace=None, ordinal=0

):

if isinstance(sym_type, str):

sym_type = SymbolType[sym_type]

if full_name is None:

full_name = short_name

if raw_name is None:

raw_name = full_name

if binding is None:

binding = SymbolBinding.NoBinding

_namespace = NameSpace.get_core_struct(namespace)

_handle = core.BNCreateSymbol(sym_type, short_name, full_name, raw_name, addr, binding, _namespace, ordinal)

assert _handle is not None, "core.BNCreateSymbol return None"

super(Symbol, self).__init__(_handle)

@dataclass

class FunctionParameter:

type: SomeType

name: str = ""

location: Optional['variable.VariableNameAndType'] = None

def __repr__(self):

ic = self.type.immutable_copy()

if (self.location is not None) and (self.location.name != self.name):

return f"{ic.get_string_before_name()} {self.name}{ic.get_string_after_name()} @ {self.location.name}"

return f"{ic.get_string_before_name()} {self.name}{ic.get_string_after_name()}"

def immutable_copy(self) -> 'FunctionParameter':

return FunctionParameter(self.type.immutable_copy(), self.name, self.location)

def mutable_copy(self) -> 'FunctionParameter':

return FunctionParameter(self.type.mutable_copy(), self.name, self.location)

@dataclass(frozen=True)

class OffsetWithConfidence:

value: int

confidence: int = core.max_confidence

def __int__(self):

return self.value

def __eq__(self, other):

if not isinstance(other, self.__class__):

return self.value == int(other)

else:

return (self.value, self.confidence) == (other.value, other.confidence)

def __ne__(self, other):

return not (self == other)

def __gt__(self, other):

return self.value > int(other)

def __le__(self, other):

return self.value <= int(other)

def __ge__(self, other):

return self.value >= int(other)

def __lt__(self, other):

return self.value < int(other)

def _to_core_struct(self) -> core.BNOffsetWithConfidence:

result = core.BNOffsetWithConfidence()

result.value = self.value

result.confidence = self.confidence

return result

@classmethod

def from_core_struct(cls, core_struct: core.BNOffsetWithConfidence) -> 'OffsetWithConfidence':

return cls(core_struct.value, core_struct.confidence)

@staticmethod

def get_core_struct(value: OffsetWithConfidenceType, confidence: int = core.max_confidence) -> core.BNOffsetWithConfidence:

if isinstance(value, OffsetWithConfidence):

return value._to_core_struct()

else:

return OffsetWithConfidence(value, confidence)._to_core_struct()

@dataclass(frozen=True)

class BoolWithConfidence:

value: bool

confidence: int = core.max_confidence

def __eq__(self, other):

if not isinstance(other, self.__class__):

return self.value == bool(other)

else:

return (self.value, self.confidence) == (other.value, other.confidence)

def __ne__(self, other):

return not (self == other)

def __bool__(self):

return self.value

def _to_core_struct(self) -> core.BNBoolWithConfidence:

result = core.BNBoolWithConfidence()

result.value = self.value

result.confidence = self.confidence

return result

@classmethod

def from_core_struct(cls, core_struct: core.BNBoolWithConfidence) -> 'BoolWithConfidence':

return cls(core_struct.value, core_struct.confidence)

@staticmethod

def get_core_struct(value: Union[BoolWithConfidenceType, bool], confidence: int = core.max_confidence) -> core.BNBoolWithConfidence:

if isinstance(value, BoolWithConfidence):

return value._to_core_struct()

else:

return BoolWithConfidence(value, confidence)._to_core_struct()

@dataclass(frozen=True)

class InlineDuringAnalysisWithConfidence:

"""Represents an InlineDuringAnalysis value with an associated confidence level."""

value: InlineDuringAnalysis

confidence: int = core.max_confidence

def __eq__(self, other):

if not isinstance(other, self.__class__):

# For backward compatibility, allow comparison with bool

if isinstance(other, bool):

return bool(self.value) == other

# Allow comparison with enum value directly

return self.value == other

else:

return (self.value, self.confidence) == (other.value, other.confidence)

def __ne__(self, other):

return not (self == other)

def __bool__(self):

return bool(self.value)

def _to_core_struct(self) -> core.BNInlineDuringAnalysisWithConfidence:

result = core.BNInlineDuringAnalysisWithConfidence()

result.value = self.value

result.confidence = self.confidence

return result

@classmethod

def from_core_struct(cls, core_struct: core.BNInlineDuringAnalysisWithConfidence) -> 'InlineDuringAnalysisWithConfidence':

return cls(InlineDuringAnalysis(core_struct.value), core_struct.confidence)

@dataclass

class MutableTypeBuilder(Generic[TB]):

type: TB

container: TypeContainerType

name: QualifiedName

platform: Optional['_platform.Platform']

confidence: int

user: bool = True

def __enter__(self) -> TB:

return self.type

def __exit__(self, type, value, traceback):

if isinstance(self.container, binaryview.BinaryView):

if self.user:

self.container.define_user_type(self.name, self.type.immutable_copy())

else:

type_id = Type.generate_auto_type_id(str(uuid.uuid4()), str(self.name))

self.container.define_type(type_id, self.name, self.type.immutable_copy())

else:

self.container.add_named_type(self.name, self.type.immutable_copy())

class TypeBuilderAttributes(dict):

def __init__(self, builder: 'TypeBuilder', *args):

super(TypeBuilderAttributes, self).__init__(*args)

self._builder = builder

def __setitem__(self, key: str, value: str):

if not isinstance(key, str):

raise TypeError("Type attribute key must be a string")

if not isinstance(value, str):

raise TypeError("Type attribute value must be a string")

core.BNSetTypeBuilderAttribute(self._builder._handle, key, value)

super(TypeBuilderAttributes, self).__setitem__(key, value)

def __delitem__(self, key: str):

if not isinstance(key, str):

raise TypeError("Type attribute key must be a string")

core.BNRemoveTypeBuilderAttribute(self._builder._handle, key)

super(TypeBuilderAttributes, self).__delitem__(key)

class TypeBuilder:

"""

All TypeBuilder objects should not be instantiated directly but created via ``.create`` APIs.

"""

def __init__(

self, handle: core.BNTypeBuilderHandle, platform: Optional['_platform.Platform'] = None,

confidence: int = core.max_confidence

):

assert isinstance(handle, core.BNTypeBuilderHandle), "handle isn't an instance of BNTypeBuilderHandle"

self._handle = handle

self.platform = platform

self.confidence = confidence

def __del__(self):

if core is not None:

core.BNFreeTypeBuilder(self._handle)

def __eq__(self, other: 'TypeBuilder') -> bool:

if not isinstance(other, TypeBuilder):

raise ValueError(f"Unable compare equality of TypeBuilder and {type(other)}")

return self.immutable_copy() == other.immutable_copy()

def __ne__(self, other: 'TypeBuilder') -> bool:

return not self.__eq__(other)

def __repr__(self):

return f"<type: mutable:{self.type_class.name} '{self}'>"

def __str__(self):

return str(self.immutable_copy())

def __hash__(self):

return hash(ctypes.addressof(self._handle.contents))

def immutable_copy(self):

Types = {

TypeClass.VoidTypeClass: VoidType, TypeClass.BoolTypeClass: BoolType,

TypeClass.IntegerTypeClass: IntegerType, TypeClass.FloatTypeClass: FloatType,

TypeClass.PointerTypeClass: PointerType, TypeClass.ArrayTypeClass: ArrayType,

TypeClass.FunctionTypeClass: FunctionType, TypeClass.WideCharTypeClass: WideCharType,

TypeClass.StructureTypeClass: StructureType,

TypeClass.EnumerationTypeClass: EnumerationType,

TypeClass.NamedTypeReferenceClass: NamedTypeReferenceType,

}

return Types[self.type_class](self._finalized, self.platform, self.confidence)

def mutable_copy(self) -> 'TypeBuilder':

return self

@classmethod

def create(cls):

_ = cls

return NotImplemented

@classmethod

def builder(

cls: typing.Type[TB], container: TypeContainerType, name: 'QualifiedName', user: bool = True, platform: Optional['_platform.Platform'] = None,

confidence: int = core.max_confidence

) -> 'MutableTypeBuilder[TB]':

return MutableTypeBuilder(cls.create(), container, name, platform, confidence, user)

@staticmethod

def void() -> 'VoidBuilder':

return VoidBuilder.create()

@staticmethod

def bool() -> 'BoolBuilder':

return BoolBuilder.create()

@staticmethod

def char(alternate_name: str = "") -> 'CharBuilder':

return CharBuilder.create(alternate_name)

@staticmethod

def int(

width: _int, sign: BoolWithConfidenceType = BoolWithConfidence(True), altname: str = ""

) -> 'IntegerBuilder':

"""

``int`` class method for creating an int Type.

:param int width: width of the integer in bytes

:param bool sign: optional variable representing signedness

:param str altname: alternate name for type

"""

return IntegerBuilder.create(width, sign, altname)

@staticmethod

def float(width: _int, altname: str = "") -> 'FloatBuilder':

"""

``float`` class method for creating floating point Types.

:param int width: width of the floating point number in bytes

:param str altname: alternate name for type

"""

return FloatBuilder.create(width, altname)

@staticmethod

def wide_char(width: _int, altname: str = "") -> 'WideCharBuilder':

"""

``wide_char`` class method for creating wide char Types.

:param int width: width of the wide character in bytes

:param str altname: alternate name for type

"""

return WideCharBuilder.create(width, altname)

@staticmethod

def named_type_from_type(

name: QualifiedNameType, type_class: Optional[NamedTypeReferenceClass] = None

) -> 'NamedTypeReferenceBuilder':

return NamedTypeReferenceBuilder.named_type_from_type(name, type_class)

@staticmethod

def named_type_from_type_and_id(

type_id: str, name: QualifiedNameType, type: Optional[SomeType] = None

) -> 'NamedTypeReferenceBuilder':

return NamedTypeReferenceBuilder.named_type_from_type_and_id(type_id, name, type)

@staticmethod

def named_type_from_registered_type(

view: 'binaryview.BinaryView', name: QualifiedName

) -> 'NamedTypeReferenceBuilder':

return NamedTypeReferenceBuilder.named_type_from_registered_type(view, name)

@staticmethod

def pointer(

arch: 'architecture.Architecture', type: SomeType, const: BoolWithConfidenceType = BoolWithConfidence(False),

volatile: BoolWithConfidenceType = BoolWithConfidence(False),

ref_type: ReferenceType = ReferenceType.PointerReferenceType

) -> 'PointerBuilder':

return PointerBuilder.create(type, arch.address_size, arch, const, volatile, ref_type)

@staticmethod

def pointer_of_width(

width: _int, type: SomeType, const: BoolWithConfidenceType = BoolWithConfidence(False),

volatile: BoolWithConfidenceType = BoolWithConfidence(False),

ref_type: ReferenceType = ReferenceType.PointerReferenceType

) -> 'PointerBuilder':

return PointerBuilder.create(type, width, None, const, volatile, ref_type)

@staticmethod

def array(type: SomeType, count: _int) -> 'ArrayBuilder':

return ArrayBuilder.create(type, count)

@staticmethod

def function(

ret: Optional[SomeType] = None, params: Optional[ParamsType] = None,

calling_convention: Optional['callingconvention.CallingConvention'] = None,

variable_arguments: Optional[BoolWithConfidenceType] = None,

stack_adjust: Optional[OffsetWithConfidenceType] = None

) -> 'FunctionBuilder':

"""

``function`` class method for creating a function Type.

:param Type ret: return Type of the function

:param params: list of parameter Types

:type params: list(Type)

:param CallingConvention calling_convention: optional argument for the function calling convention

:param bool variable_arguments: optional boolean, true if the function has a variable number of arguments

"""

return FunctionBuilder.create(ret, calling_convention, params, variable_arguments, stack_adjust)

@staticmethod

def structure(

members: Optional[MembersType] = None, packed: _bool = False,

type: StructureVariant = StructureVariant.StructStructureType

) -> 'StructureBuilder':

return StructureBuilder.create(members, type=type, packed=packed)

@staticmethod

def union(members: Optional[MembersType] = None, packed: _bool = False) -> 'StructureBuilder':

return StructureBuilder.create(members, type=StructureVariant.UnionStructureType, packed=packed)

@staticmethod

def class_type(members: Optional[MembersType] = None, packed: _bool = False) -> 'StructureBuilder':

return StructureBuilder.create(members, type=StructureVariant.ClassStructureType, packed=packed)

@staticmethod

def enumeration(

arch: Optional['architecture.Architecture'] = None, members: Optional[EnumMembersType] = None,

width: Optional[_int] = None, sign: BoolWithConfidenceType = BoolWithConfidence(False)

) -> 'EnumerationBuilder':

return EnumerationBuilder.create(members, width, arch, sign)

@staticmethod

def named_type_reference(

type_class: NamedTypeReferenceClass, name: QualifiedName, type_id: Optional[str] = None, alignment: _int = 1,

width: _int = 0, const: BoolWithConfidenceType = BoolWithConfidence(False),

volatile: BoolWithConfidenceType = BoolWithConfidence(False)

) -> 'NamedTypeReferenceBuilder':

return NamedTypeReferenceBuilder.create(

type_class, type_id, name, width, alignment, None, core.max_confidence, const, volatile

)

@property

def width(self) -> _int:

return core.BNGetTypeBuilderWidth(self._handle)

@width.setter

def width(self, value: _int):

core.BNTypeBuilderSetWidth(self._handle, value)

def __len__(self):

return self.width

@property

def _finalized(self):

type_handle = core.BNFinalizeTypeBuilder(self._handle)

assert type_handle is not None, "core.BNFinalizeTypeBuilder returned None"

return type_handle

@property

def const(self) -> BoolWithConfidence:

"""Whether type is const (read/write)"""

result = core.BNIsTypeBuilderConst(self._handle)

return BoolWithConfidence(result.value, confidence=result.confidence)

@const.setter

def const(

self, value: BoolWithConfidenceType

) -> None: # We explicitly allow 'set' type to be different than 'get' type

core.BNTypeBuilderSetConst(self._handle, BoolWithConfidence.get_core_struct(value))

@property

def volatile(self) -> BoolWithConfidence:

"""Whether type is volatile (read/write)"""

result = core.BNIsTypeBuilderVolatile(self._handle)

return BoolWithConfidence(result.value, confidence=result.confidence)

@volatile.setter

def volatile(

self, value: BoolWithConfidenceType

) -> None: # We explicitly allow 'set' type to be different than 'get' type

core.BNTypeBuilderSetVolatile(self._handle, BoolWithConfidence.get_core_struct(value))

@property

def alignment(self) -> _int:

return core.BNGetTypeBuilderAlignment(self._handle)

@alignment.setter

def alignment(self, alignment: _int):

core.BNTypeBuilderSetAlignment(self._handle, alignment)

@property

def child(self) -> 'Type':

type_conf = core.BNGetTypeBuilderChildType(self._handle)

assert type_conf is not None, "core.BNGetTypeBuilderChildType returned None"

return Type.create(type_conf.type, self.platform, type_conf.confidence)

@child.setter

def child(self, value: SomeType) -> None:

ic = value.immutable_copy()

core.BNTypeBuilderSetChildType(self._handle, ic._to_core_struct())

@property

def alternate_name(self) -> Optional[str]:

return core.BNGetTypeBuilderAlternateName(self._handle)

@alternate_name.setter

def alternate_name(self, name: str) -> None:

core.BNTypeBuilderSetAlternateName(self._handle, name)

@property

def system_call_number(self) -> Optional[_int]:

"""Gets/Sets the system call number for a FunctionType object if one exists otherwise None"""

if not core.BNTypeBuilderIsSystemCall(self._handle):

return None

return core.BNTypeBuilderGetSystemCallNumber(self._handle)

@system_call_number.setter

def system_call_number(self, value: _int) -> None:

core.BNTypeBuilderSetSystemCallNumber(self._handle, True, value)

def clear_system_call(self) -> None:

core.BNTypeBuilderSetSystemCallNumber(self._handle, False, 0)

@property

def type_class(self) -> TypeClass:

return TypeClass(core.BNGetTypeBuilderClass(self._handle))

@property

def signed(self) -> BoolWithConfidence:

return BoolWithConfidence.from_core_struct(core.BNIsTypeBuilderSigned(self._handle))

@signed.setter

def signed(self, value: BoolWithConfidenceType) -> None:

_value = BoolWithConfidence.get_core_struct(value)

core.BNTypeBuilderSetSigned(self._handle, _value)

@property

def children(self) -> List['TypeBuilder']:

return []

@property

def attributes(self) -> Dict[str, str]:

"""Attribute names and their values"""

count = ctypes.c_ulonglong()

attributes = core.BNGetTypeBuilderAttributes(self._handle, count)

result = dict()

for i in range(count.value):

result[attributes[i].name] = attributes[i].value

core.BNFreeTypeAttributeList(attributes, count.value)

return TypeBuilderAttributes(self, result)

@attributes.setter

def attributes(self, values: Dict[str, str]) -> None:

if not isinstance(values, dict):

raise TypeError("Attributes must be a dictionary")

attributes = (core.BNTypeAttribute * len(values))()

i = 0

for name, value in values.items():

if not isinstance(name, str):

raise TypeError("Attribute names must be strings")

if not isinstance(value, str):

raise TypeError("Attribute values must be strings")

attributes[i].name = name

attributes[i].value = value

i += 1

core.BNSetTypeBuilderAttributeList(self._handle, attributes, len(values))

class VoidBuilder(TypeBuilder):

@classmethod

def create(cls, platform: Optional['_platform.Platform'] = None, confidence: int = core.max_confidence) -> 'VoidBuilder':

handle = core.BNCreateVoidTypeBuilder()

assert handle is not None, "core.BNCreateVoidTypeBuilder returned None"

return cls(handle, platform, confidence)

class BoolBuilder(TypeBuilder):

@classmethod

def create(cls, platform: Optional['_platform.Platform'] = None, confidence: int = core.max_confidence) -> 'BoolBuilder':

handle = core.BNCreateBoolTypeBuilder()

assert handle is not None, "core.BNCreateBoolTypeBuilder returned None"

return cls(handle, platform, confidence)

class IntegerBuilder(TypeBuilder):

@classmethod

def create(

cls, width: int, sign: BoolWithConfidenceType = True, alternate_name: str = "",

platform: Optional['_platform.Platform'] = None, confidence: int = core.max_confidence

) -> 'IntegerBuilder':

_sign = BoolWithConfidence.get_core_struct(sign)

handle = core.BNCreateIntegerTypeBuilder(width, _sign, alternate_name)

assert handle is not None, "core.BNCreateIntegerTypeBuilder returned None"

return cls(handle, platform, confidence)

class CharBuilder(IntegerBuilder):

@classmethod

def create(

cls, alternate_name: str = "", platform: Optional['_platform.Platform'] = None, confidence: int = core.max_confidence

) -> 'CharBuilder':

handle = core.BNCreateIntegerTypeBuilder(1, BoolWithConfidence.get_core_struct(False), alternate_name)

assert handle is not None, "BNCreateIntegerTypeBuilder returned None"

return cls(handle, platform, confidence)

class FloatBuilder(TypeBuilder):

@classmethod

def create(

cls, width: int, alternate_name: str = "", platform: Optional['_platform.Platform'] = None,

confidence: int = core.max_confidence

) -> 'FloatBuilder':

handle = core.BNCreateFloatTypeBuilder(width, alternate_name)

assert handle is not None, "core.BNCreateFloatTypeBuilder returned None"

return cls(handle, platform, confidence)

class WideCharBuilder(TypeBuilder):

@classmethod

def create(

cls, width: int, alternate_name: str = "", platform: Optional['_platform.Platform'] = None,

confidence: int = core.max_confidence

) -> 'WideCharBuilder':

handle = core.BNCreateWideCharTypeBuilder(width, alternate_name)

assert handle is not None, "core.BNCreateWideCharTypeBuilder returned None"

return cls(handle, platform, confidence)

class PointerBuilder(TypeBuilder):

@classmethod

def create(

cls, type: SomeType, width: int = 4, arch: Optional['architecture.Architecture'] = None,

const: BoolWithConfidenceType = False, volatile: BoolWithConfidenceType = False,