summaryrefslogtreecommitdiff
path: root/python/architecture.py
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2020-02-19 15:24:30 -0500
committerJordan Wiens <jordan@psifertex.com>2020-02-19 15:24:30 -0500
commita54caeeacdad4c3209301e114a6acb5312d92c28 (patch)
treefb1b803d41d1cba6463375668aaee265315a4602 /python/architecture.py
parentcd8dd4e1f5d54510a07f816e47851e1c76f030e9 (diff)
updates get_instruction_text documentation
Diffstat (limited to 'python/architecture.py')
-rw-r--r--python/architecture.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/python/architecture.py b/python/architecture.py
index d5daec55..b9001bf3 100644
--- a/python/architecture.py
+++ b/python/architecture.py
@@ -1455,15 +1455,15 @@ class Architecture(with_metaclass(_ArchitectureMetaClass, object)):
def get_instruction_text(self, data, addr):
"""
- ``get_instruction_text`` returns a list of InstructionTextToken objects for the instruction at the given virtual
+ ``get_instruction_text`` returns a tuple containing a list of decoded InstructionTextToken objects and the bytes used at the given virtual
address ``addr`` with data ``data``.
.. note:: Architecture subclasses should implement this method.
:param str data: max_instruction_length bytes from the binary at virtual address ``addr``
:param int addr: virtual address of bytes in ``data``
- :return: an InstructionTextToken list for the current instruction
- :rtype: list(InstructionTextToken)
+ :return: a tuple containing the InstructionTextToken list and length of bytes decoded
+ :rtype: tuple(list(InstructionTextToken), int)
"""
return self.perform_get_instruction_text(data, addr)