Class DebugInfo

python/debuginfo.py:280–545

``class DebugInfo`` provides an interface to both provide and query debug info. The DebugInfo object is used internally by the binary view to which it is applied to determine the attributes of functions, types, and variables that would otherwise be costly to deduce. DebugInfo objects themselve

class DebugInfo(object):
	"""
	``class DebugInfo`` provides an interface to both provide and query debug info. The DebugInfo object is used
	internally by the binary view to which it is applied to determine the attributes of functions, types, and variables
	that would otherwise be costly to deduce.

	DebugInfo objects themselves are independent of binary views; their data can be sourced from any arbitrary binary
	views and be applied to any other arbitrary binary view. A DebugInfo object can also contain debug info from multiple
	DebugInfoParsers. This makes it possible to gather debug info that may be distributed across several different
	formats and files.

	DebugInfo cannot be instantiated by the user, instead you must get it from either the binary view (see ``'binaryview.BinaryView'.debug_info``)
	or a debug-info parser (see ``debuginfo.DebugInfoParser.parse_debug_info``).

	.. note:: Please note that calling one of ``add_*`` functions will not work outside of a debuginfo plugin.
	"""
	def __init__(self, handle: core.BNDebugInfo) -> None:
		self.handle = core.handle_of_type(handle, core.BNDebugInfo)

	def __del__(self) -> None:
		core.BNFreeDebugInfoReference(self.handle)

	@property
	def parsers(self) -> Iterator[str]:
		count = ctypes.c_ulonglong()
		parsers = core.BNGetDebugParserNames(self.handle, count)
		try:
			assert parsers is not None, "core.BNGetDebugParserNames returned None"
			for i in range(0, count.value):
				yield parsers[i].decode("utf-8")
		finally:
			core.BNFreeStringList(parsers, count.value)

	def get_type_container(self, parser_name: str) -> 'typecontainer.TypeContainer':
		"""
		Type Container for all types in the DebugInfo that resulted from the parse of
		the given parser.

		:param parser_name: Name of parser
		:return: Type Container for types from that parser
		"""
		return typecontainer.TypeContainer(core.BNGetDebugInfoTypeContainer(self.handle, parser_name))

	def types_from_parser(self, name: Optional[str] = None) -> Iterator[Tuple[str, _types.Type]]:
		"""Returns a generator of all types provided by a named DebugInfoParser"""
		count = ctypes.c_ulonglong(0)
		name_and_types = core.BNGetDebugTypes(self.handle, name, count)
		try:
			assert name_and_types is not None, "core.BNGetDebugTypes returned None"
			for i in range(0, count.value):
				yield (name_and_types[i].name, _types.Type.create(core.BNNewTypeReference(name_and_types[i].type)))
		finally:
			core.BNFreeDebugTypes(name_and_types, count.value)

	@property
	def types(self) -> Iterator[Tuple[str, _types.Type]]:
		"""A generator of all types provided by DebugInfoParsers"""
		return self.types_from_parser()