diff options
Diffstat (limited to 'python')
| -rw-r--r-- | python/architecture.py | 42 | ||||
| -rw-r--r-- | python/binaryview.py | 42 | ||||
| -rw-r--r-- | python/flowgraph.py | 10 | ||||
| -rw-r--r-- | python/lowlevelil.py | 4 | ||||
| -rw-r--r-- | python/mediumlevelil.py | 2 | ||||
| -rw-r--r-- | python/plugin.py | 32 |
6 files changed, 66 insertions, 66 deletions
diff --git a/python/architecture.py b/python/architecture.py index e0ccfeeb..1f1422cb 100644 --- a/python/architecture.py +++ b/python/architecture.py @@ -1189,14 +1189,14 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): def perform_get_associated_arch_by_address(self, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_associated_arch_by_address``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_associated_arch_by_address`. """ return self, addr @abc.abstractmethod def perform_get_instruction_info(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_instruction_info``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_instruction_info`. :param str data: bytes to decode :param int addr: virtual address of the byte to be decoded @@ -1208,7 +1208,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_get_instruction_text(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_instruction_text``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_instruction_text`. :param str data: bytes to decode :param int addr: virtual address of the byte to be decoded @@ -1220,7 +1220,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_get_instruction_low_level_il(self, data, addr, il): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_instruction_low_level_il``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_instruction_low_level_il`. :param str data: bytes to be interpreted as low-level IL instructions :param int addr: virtual address of start of ``data`` @@ -1232,7 +1232,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_get_flag_write_low_level_il(self, op, size, write_type, flag, operands, il): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_flag_write_low_level_il``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_flag_write_low_level_il`. :param LowLevelILOperation op: :param int size: @@ -1250,7 +1250,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_get_flag_condition_low_level_il(self, cond, sem_class, il): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_flag_condition_low_level_il``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_flag_condition_low_level_il`. :param LowLevelILFlagCondition cond: Flag condition to be computed :param str sem_class: Semantic class to be used (None for default semantics) @@ -1262,7 +1262,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_get_semantic_flag_group_low_level_il(self, sem_group, il): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_semantic_flag_group_low_level_il``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_semantic_flag_group_low_level_il`. :param str sem_group: Semantic group to be computed :param LowLevelILFunction il: LowLevelILFunction object to append LowLevelILExpr objects to @@ -1273,7 +1273,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_assemble(self, code, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``assemble``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`assemble`. :param str code: string representation of the instructions to be assembled :param int addr: virtual address that the instructions will be loaded at @@ -1285,7 +1285,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_is_never_branch_patch_available(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``is_never_branch_patch_available``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`is_never_branch_patch_available`. .. note:: Architecture subclasses should implement this method. .. warning:: This method should never be called directly. @@ -1300,7 +1300,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_is_always_branch_patch_available(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``is_always_branch_patch_available``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`is_always_branch_patch_available`. :param str data: bytes to be checked :param int addr: the virtual address of the instruction to be patched @@ -1312,7 +1312,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_is_invert_branch_patch_available(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``is_invert_branch_patch_available``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`is_invert_branch_patch_available`. :param int addr: the virtual address of the instruction to be patched :return: True if the instruction can be patched, False otherwise @@ -1323,7 +1323,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_is_skip_and_return_zero_patch_available(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``is_skip_and_return_zero_patch_available``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`is_skip_and_return_zero_patch_available`. :param str data: bytes to be checked :param int addr: the virtual address of the instruction to be patched @@ -1335,7 +1335,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_is_skip_and_return_value_patch_available(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``is_skip_and_return_value_patch_available``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`is_skip_and_return_value_patch_available`. :param str data: bytes to be checked :param int addr: the virtual address of the instruction to be patched @@ -1347,7 +1347,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_convert_to_nop(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``convert_to_nop``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`convert_to_nop`. :param str data: bytes at virtual address ``addr`` :param int addr: the virtual address of the instruction to be patched @@ -1359,7 +1359,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_always_branch(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``always_branch``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`always_branch`. :param str data: bytes to be checked :param int addr: the virtual address of the instruction to be patched @@ -1371,7 +1371,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_invert_branch(self, data, addr): """ - Deprecated method provided for compatibility. Architecture plugins should override ``invert_branch``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`invert_branch`. :param str data: bytes to be checked :param int addr: the virtual address of the instruction to be patched @@ -1383,7 +1383,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): @abc.abstractmethod def perform_skip_and_return_value(self, data, addr, value): """ - Deprecated method provided for compatibility. Architecture plugins should override ``skip_and_return_value``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`skip_and_return_value`. :param str data: bytes to be checked :param int addr: the virtual address of the instruction to be patched @@ -1395,7 +1395,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): def perform_get_flag_role(self, flag, sem_class): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_flag_role``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_flag_role`. """ if flag in self._flag_roles: return self._flag_roles[flag] @@ -1403,7 +1403,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): def perform_get_flags_required_for_flag_condition(self, cond, sem_class): """ - Deprecated method provided for compatibility. Architecture plugins should override ``get_flags_required_for_flag_condition``. + Deprecated method provided for compatibility. Architecture plugins should override :func:`get_flags_required_for_flag_condition`. """ if cond in self.flags_required_for_flag_condition: return self.flags_required_for_flag_condition[cond] @@ -1470,7 +1470,7 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)): virtual address ``addr`` with data ``data``. This is used to analyze arbitrary data at an address, if you are working with an existing binary, you likely - want to be using ``Function.get_low_level_il_at``. + want to be using :func:`Function.get_low_level_il_at`. .. note:: Architecture subclasses should implement this method. @@ -2342,7 +2342,7 @@ class CoreArchitecture(Architecture): virtual address ``addr`` with data ``data``. This is used to analyze arbitrary data at an address, if you are working with an existing binary, you likely - want to be using ``Function.get_low_level_il_at``. + want to be using :func:`Function.get_low_level_il_at`. :param str data: max_instruction_length bytes from the binary at virtual address ``addr`` :param int addr: virtual address of bytes in ``data`` diff --git a/python/binaryview.py b/python/binaryview.py index 7e2a3d0c..f3ee7733 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -908,14 +908,14 @@ class BinaryView(object): `By convention in the rest of this document we will use bv to mean an open BinaryView of an executable file.` When a BinaryView is open on an executable view, analysis does not automatically run, this can be done by running - the ``update_analysis_and_wait()`` method which disassembles the executable and returns when all disassembly is + the :func:`update_analysis_and_wait` method which disassembles the executable and returns when all disassembly is finished:: >>> bv.update_analysis_and_wait() >>> Since BinaryNinja's analysis is multi-threaded (depending on version) this can also be done in the background by - using the ``update_analysis()`` method instead. + using the :func:`update_analysis` method instead. By standard python convention methods which start with '_' should be considered private and should not be called externally. Additionally, methods which begin with ``perform_`` should not be called either and are @@ -924,7 +924,7 @@ class BinaryView(object): .. note:: An important note on the ``*_user_*()`` methods. Binary Ninja makes a distinction between edits \ performed by the user and actions performed by auto analysis. Auto analysis actions that can quickly be recalculated \ are not saved to the database. Auto analysis actions that take a long time and all user edits are stored in the \ - database (e.g. ``remove_user_function()`` rather than ``remove_function()``). Thus use ``_user_`` methods if saving \ + database (e.g. :func:`remove_user_function` rather than :func:`remove_function`). Thus use ``_user_`` methods if saving \ to the database is desired. """ name = None @@ -1790,10 +1790,10 @@ class BinaryView(object): def get_next_disassembly(self, arch=None): """ ``get_next_disassembly`` simple helper function for printing disassembly of the next instruction. - The internal state of the instruction to be printed is stored in the ``next_address`` attribute + The internal state of the instruction to be printed is stored in the :attr:`next_address` attribute :param Architecture arch: optional Architecture, ``self.arch`` is used if this parameter is None - :return: a str representation of the instruction at virtual address ``self.next_address`` + :return: a str representation of the instruction at virtual address :attr:`next_address` :rtype: str or None :Example: @@ -1831,7 +1831,7 @@ class BinaryView(object): ``perform_get_length`` implements a query for the size of the virtual address range used by the BinaryView. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1845,7 +1845,7 @@ class BinaryView(object): ``perform_read`` implements a mapping between a virtual address and an absolute file offset, reading ``length`` bytes from the rebased address ``addr``. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1861,7 +1861,7 @@ class BinaryView(object): ``perform_write`` implements a mapping between a virtual address and an absolute file offset, writing the bytes ``data`` to rebased address ``addr``. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1906,7 +1906,7 @@ class BinaryView(object): """ ``perform_get_modification`` implements query to the whether the virtual address ``addr`` is modified. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1920,7 +1920,7 @@ class BinaryView(object): """ ``perform_is_valid_offset`` implements a check if an virtual address ``addr`` is valid. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1935,7 +1935,7 @@ class BinaryView(object): """ ``perform_is_offset_readable`` implements a check if an virtual address is readable. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1949,7 +1949,7 @@ class BinaryView(object): """ ``perform_is_offset_writable`` implements a check if a virtual address ``addr`` is writable. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1963,7 +1963,7 @@ class BinaryView(object): """ ``perform_is_offset_executable`` implements a check if a virtual address ``addr`` is executable. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1978,7 +1978,7 @@ class BinaryView(object): ``perform_get_next_valid_offset`` implements a query for the next valid readable, writable, or executable virtual memory address. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -1995,7 +1995,7 @@ class BinaryView(object): ``perform_get_start`` implements a query for the first readable, writable, or executable virtual address in the BinaryView. - .. note:: This method **may** be overridden by custom BinaryViews. Use ``add_auto_segment`` to provide + .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide data without overriding this method. .. warning:: This method **must not** be called directly. @@ -2035,7 +2035,7 @@ class BinaryView(object): .. note:: This method **may** be implemented for custom BinaryViews that are not LittleEndian. .. warning:: This method **must not** be called directly. - :return: either ``Endianness.LittleEndian`` or ``Endianness.BigEndian`` + :return: either :const:`Endianness.LittleEndian <binaryninja.enums.Endianness.LittleEndian>` or :const:`Endianness.BigEndian <binaryninja.enums.Endianness.BigEndian>` :rtype: Endianness """ return Endianness.LittleEndian @@ -2511,7 +2511,7 @@ class BinaryView(object): def add_analysis_option(self, name): """ ``add_analysis_option`` adds an analysis option. Analysis options elaborate the analysis phase. The user must - start analysis by calling either ``update_analysis()`` or ``update_analysis_and_wait()``. + start analysis by calling either :func:`update_analysis` or :func:`update_analysis_and_wait`. :param str name: name of the analysis option. Available options: "linearsweep" : apply linearsweep analysis during the next analysis update (run-once semantics) @@ -2527,8 +2527,8 @@ class BinaryView(object): def update_analysis(self): """ ``update_analysis`` asynchronously starts the analysis running and returns immediately. Analysis of BinaryViews - does not occur automatically, the user must start analysis by calling either ``update_analysis()`` or - ``update_analysis_and_wait()``. An analysis update **must** be run after changes are made which could change + does not occur automatically, the user must start analysis by calling either :func:`update_analysis` or + :func:`update_analysis_and_wait`. An analysis update **must** be run after changes are made which could change analysis results such as adding functions. :rtype: None @@ -2539,7 +2539,7 @@ class BinaryView(object): """ ``update_analysis_and_wait`` blocking call to update the analysis, this call returns when the analysis is complete. Analysis of BinaryViews does not occur automatically, the user must start analysis by calling either - ``update_analysis()`` or ``update_analysis_and_wait()``. An analysis update **must** be run after changes are + :func:`update_analysis` or :func:`update_analysis_and_wait`. An analysis update **must** be run after changes are made which could change analysis results such as adding functions. :rtype: None @@ -3432,7 +3432,7 @@ class BinaryView(object): def add_analysis_completion_event(self, callback): """ ``add_analysis_completion_event`` sets up a call back function to be called when analysis has been completed. - This is helpful when using ``update_analysis`` which does not wait for analysis completion before returning. + This is helpful when using :func:`update_analysis` which does not wait for analysis completion before returning. The callee of this function is not responsible for maintaining the lifetime of the returned AnalysisCompletionEvent object. diff --git a/python/flowgraph.py b/python/flowgraph.py index a5ac686c..1ef14269 100644 --- a/python/flowgraph.py +++ b/python/flowgraph.py @@ -419,7 +419,7 @@ class FlowGraph(object): def finish_prepare_for_layout(self): """ ``finish_prepare_for_layout`` signals that preparations for rendering a graph are complete. - This method should only be called by a ``prepare_for_layout`` reimplementation. + This method should only be called by a :func:`prepare_for_layout` reimplementation. """ core.BNFinishPrepareForLayout(self.handle) @@ -427,7 +427,7 @@ class FlowGraph(object): """ ``prepare_for_layout`` can be overridden by subclasses to handling preparations that must take place before a flow graph is rendered, such as waiting for a function to finish analysis. If - this function is overridden, the ``finish_prepare_for_layout`` method must be called once + this function is overridden, the :func:`finish_prepare_for_layout` method must be called once preparations are completed. """ self.finish_prepare_for_layout() @@ -663,7 +663,7 @@ class FlowGraph(object): display. After this function returns, each node will contain coordinates and extents that can be used to render a graph with minimum additional computation. - Do not use this API on the UI thread (use ``layout`` with a callback instead). + Do not use this API on the UI thread (use :func:`layout` with a callback instead). """ self._wait_cond = threading.Lock() @@ -710,10 +710,10 @@ class FlowGraph(object): def update(self): """ ``update`` can be overridden by subclasses to allow a graph to be updated after it has been - presented in the UI. This will automatically occur if the function referenced by the ``function`` + presented in the UI. This will automatically occur if the function referenced by the :attr:`function` property has been updated. - Return a new ``FlowGraph`` object with the new information if updates are desired. If the graph + Return a new :class:`FlowGraph` object with the new information if updates are desired. If the graph does not need updating, ``None`` can be returned to leave the graph in its current state. :return: Updated graph, or ``None`` diff --git a/python/lowlevelil.py b/python/lowlevelil.py index a32eb4a2..e5eef3c0 100644 --- a/python/lowlevelil.py +++ b/python/lowlevelil.py @@ -720,11 +720,11 @@ class LowLevelILExpr(object): class LowLevelILFunction(object): """ ``class LowLevelILFunction`` contains the list of LowLevelILExpr objects that make up a binaryninja.function. LowLevelILExpr - objects can be added to the LowLevelILFunction by calling ``append`` and passing the result of the various class + objects can be added to the LowLevelILFunction by calling :func:`append` and passing the result of the various class methods which return LowLevelILExpr objects. - LowLevelILFlagCondition values used as parameters in the ``flag_condition`` method. + LowLevelILFlagCondition values used as parameters in the :func:`flag_condition` method. ======================= ========== =============================== LowLevelILFlagCondition Operator Description diff --git a/python/mediumlevelil.py b/python/mediumlevelil.py index b6b7dbfc..8b8500e4 100644 --- a/python/mediumlevelil.py +++ b/python/mediumlevelil.py @@ -619,7 +619,7 @@ class MediumLevelILExpr(object): class MediumLevelILFunction(object): """ ``class MediumLevelILFunction`` contains the list of MediumLevelILExpr objects that make up a binaryninja.function. MediumLevelILExpr - objects can be added to the MediumLevelILFunction by calling ``append`` and passing the result of the various class + objects can be added to the MediumLevelILFunction by calling :func:`append` and passing the result of the various class methods which return MediumLevelILExpr objects. """ def __init__(self, arch = None, handle = None, source_func = None): diff --git a/python/plugin.py b/python/plugin.py index a3eafdde..afaf3032 100644 --- a/python/plugin.py +++ b/python/plugin.py @@ -281,8 +281,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` as an argument - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` as an argument + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -300,8 +300,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and address as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and address as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_address`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -319,8 +319,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and ``AddressRange`` as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and :class:`~binaryninja.binaryview.AddressRange` as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_range`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -338,8 +338,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and a ``Function`` as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.function.Function` as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_function`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -357,8 +357,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and a ``LowLevelILFunction`` as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.LowLevelILFunction` as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_low_level_il_function`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -376,8 +376,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and a ``LowLevelILInstruction`` as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.LowLevelILInstruction` as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_low_level_il_instruction`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -395,8 +395,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and a ``MediumLevelILFunction`` as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.MediumLevelILFunction` as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_medium_level_il_function`` with the same function name will replace the existing function but will leak the memory of the original plugin. @@ -414,8 +414,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)): :param str name: name of the plugin :param str description: description of the plugin - :param action: function to call with the ``BinaryView`` and a ``MediumLevelILInstruction`` as arguments - :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view + :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.MediumLevelILInstruction` as arguments + :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view :rtype: None .. warning:: Calling ``register_for_medium_level_il_instruction`` with the same function name will replace the existing function but will leak the memory of the original plugin. |