Method register

python/plugin.py:384–417

r""" ``register`` Register a plugin :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder) :param str description: description of the plugin :param callback action: function to call with the :class:`~binaryview.BinaryView` as an argument :param c

(
	    cls, name: str, description: str, action: Callable[['binaryview.BinaryView'], None],
	    is_valid: Optional[Callable[['binaryview.BinaryView'], bool]] = None
	)

	@classmethod
	def register(
	    cls, name: str, description: str, action: Callable[['binaryview.BinaryView'], None],
	    is_valid: Optional[Callable[['binaryview.BinaryView'], bool]] = None
	):
		r"""
		``register`` Register a plugin

		:param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
		:param str description: description of the plugin
		:param callback action: function to call with the :class:`~binaryview.BinaryView` as an argument
		:param callback is_valid: optional argument of a function passed a :class:`~binaryview.BinaryView` to determine whether the plugin should be enabled for that view
		:rtype: None
		:Example:

			>>> def my_plugin(bv: BinaryView):
			>>> 	log_info(f"My plugin was called on bv: `{bv}`")
			>>> PluginCommand.register("My Plugin", "My plugin description (not used)", my_plugin)
			True
			>>> def is_valid(bv: BinaryView) -> bool:
			>>> 	return False
			>>> PluginCommand.register("My Plugin (With Valid Function)", "My plugin description (not used)", my_plugin, is_valid)
			True

		.. warning:: Calling ``register`` with the same function name will replace the existing function but will leak the memory of the original plugin.
		"""
		binaryninja._init_plugins()
		action_obj = ctypes.CFUNCTYPE(None, ctypes.c_void_p,
		                              ctypes.POINTER(core.BNBinaryView
		                                             ))(lambda ctxt, view: cls._default_action(view, action))
		is_valid_obj = ctypes.CFUNCTYPE(ctypes.c_bool, ctypes.c_void_p,
		                                ctypes.POINTER(core.BNBinaryView
		                                               ))(lambda ctxt, view: cls._default_is_valid(view, is_valid))
		cls._registered_commands.append((action_obj, is_valid_obj))
		core.BNRegisterPluginCommand(name, description, action_obj, is_valid_obj, None)

	@classmethod
	def register_for_address(