Class DebugInfoParser

python/debuginfo.py:152–248

:py:class:`DebugInfoParser` represents the registered parsers and providers of debug information for Binary Ninja. The debug information is used by Binary Ninja as ground-truth information about the attributes of functions, types, and variables that Binary Ninja's analysis pipeline would otherw

class DebugInfoParser(object, metaclass=_DebugInfoParserMetaClass):
	"""
	:py:class:`DebugInfoParser` represents the registered parsers and providers of debug information for Binary Ninja.

	The debug information is used by Binary Ninja as ground-truth information about the attributes of functions,
	types, and variables that Binary Ninja's analysis pipeline would otherwise work to deduce. By providing
	debug info, Binary Ninja's output can be generated quicker, more accurately, and more completely.

	A DebugInfoParser consists of:

	1. A name
	2. An ``is_valid`` function which takes a :py:class:`binaryview.BinaryView` and returns a bool.
	3. A ``parse`` function which takes a :py:class:`DebugInfo` object and uses the member functions :py:meth:`DebugInfo.add_type`, :py:meth:`DebugInfo.add_function`, and :py:meth:`DebugInfo.add_data_variable` to populate all the info it can.

	And finally calling :py:meth:`DebugInfoParser.register` to register it with the core.

	A working example::

		import binaryninja as bn

		def is_valid(bv: bn.binaryview.BinaryView) -> bool:
			return bv.view_type == "Raw"

		def parse_info(debug_info: bn.debuginfo.DebugInfo, bv: bn.binaryview.BinaryView, debug_file: bn.binaryview.BinaryView, progress: Callable[[int, int], bool]) -> None:
			debug_info.add_type("name", bn.types.Type.int(4, True))
			debug_info.add_data_variable(0x1234, bn.types.Type.int(4, True), "name")
			function_info = bn.debuginfo.DebugFunctionInfo(0xadd6355, "short_name", "full_name", "raw_name", bn.types.Type.function(bn.types.Type.int(4, False), None), components=["some", "namespaces"])
			debug_info.add_function(function_info)

		bn.debuginfo.DebugInfoParser.register("debug info parser", is_valid, parse_info)

	:py:class:`DebugInfo` will then be automatically applied to binary views that contain debug information (via the setting `analysis.debugInfo.internal`), binary views that provide valid external debug info files (`analysis.debugInfo.external`), or manually fetched/applied as below::

		valid_parsers = bn.debuginfo.DebugInfoParser.get_parsers_for_view(bv)
		parser = valid_parsers[0]
		debug_info = parser.parse_debug_info(bv, bv)  # See docs for why BV is here twice
		bv.apply_debug_info(debug_info)

	Multiple debug-info parsers can manually contribute debug info for a binary view by simply calling ``parse_debug_info`` with the
	``DebugInfo`` object just returned. This is automatic when opening a binary view with multiple valid debug info parsers. If you
	wish to set the debug info for a binary view without applying it as well, you can call ``'binaryview.BinaryView'.set_debug_info``.
	"""
	def __init__(self, handle: core.BNDebugInfoParser) -> None:
		self.handle = core.handle_of_type(handle, core.BNDebugInfoParser)

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

	def __repr__(self) -> str:
		return f"<debug-info parser: '{self.name}'>"

	def __eq__(self, other: "DebugInfoParser") -> bool:
		if not isinstance(other, self.__class__):
			return NotImplemented
		return ctypes.addressof(self.handle.contents) == ctypes.addressof(other.handle.contents)

	def __ne__(self, other: "DebugInfoParser") -> bool:
		if not isinstance(other, self.__class__):