Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-11-24 22:30:13 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Use internal_dict everywhere we refer to the python session dict in docs.

Browse Source
This commit is contained in:
Jim Ingham 2021-02-09 17:48:04 -08:00
parent 74c3615997
commit 483ec136da
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
lldb/docs/use/python-reference.rst
View File

@ -179,35 +179,35 @@ arguments:
::
def breakpoint_function_wrapper(frame, bp_loc, dict):
def breakpoint_function_wrapper(frame, bp_loc, internal_dict):
# Your code goes here
or:
::
def breakpoint_function_wrapper(frame, bp_loc, extra_args, dict):
def breakpoint_function_wrapper(frame, bp_loc, extra_args, internal_dict):
# Your code goes here
+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Argument | Type | Description |
+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **frame** | **lldb.SBFrame** | The current stack frame where the breakpoint got hit. |
| | | The object will always be valid. |
| | | This **frame** argument might *not* match the currently selected stack frame found in the **lldb** module global variable **lldb.frame**. |
+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **bp_loc** | **lldb.SBBreakpointLocation** | The breakpoint location that just got hit. Breakpoints are represented by **lldb.SBBreakpoint** |
| | | objects. These breakpoint objects can have one or more locations. These locations |
| | | are represented by **lldb.SBBreakpointLocation** objects. |
+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **extra_args** | **lldb.SBStructuredData** | **Optional** If your breakpoint callback function takes this extra parameter, then when the callback gets added to a breakpoint, its |
| | | contents can parametrize this use of the callback. For instance, instead of writing a callback that stops when the caller is "Foo", |
| | | you could take the function name from a field in the **extra_args**, making the callback more general. The **-k** and **-v** options |
| | | to **breakpoint command add** will be passed as a Dictionary in the **extra_args** parameter, or you can provide it with the SB API's. |
+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **dict** | **dict** | The python session dictionary as a standard python dictionary object. |
+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Argument | Type | Description |
+-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **frame** | **lldb.SBFrame** | The current stack frame where the breakpoint got hit. |
| | | The object will always be valid. |
| | | This **frame** argument might *not* match the currently selected stack frame found in the **lldb** module global variable **lldb.frame**. |
+-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **bp_loc** | **lldb.SBBreakpointLocation** | The breakpoint location that just got hit. Breakpoints are represented by **lldb.SBBreakpoint** |
| | | objects. These breakpoint objects can have one or more locations. These locations |
| | | are represented by **lldb.SBBreakpointLocation** objects. |
+-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **extra_args** | **lldb.SBStructuredData** | **Optional** If your breakpoint callback function takes this extra parameter, then when the callback gets added to a breakpoint, its |
| | | contents can parametrize this use of the callback. For instance, instead of writing a callback that stops when the caller is "Foo", |
| | | you could take the function name from a field in the **extra_args**, making the callback more general. The **-k** and **-v** options |
| | | to **breakpoint command add** will be passed as a Dictionary in the **extra_args** parameter, or you can provide it with the SB API's. |
+-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **internal_dict** | **dict** | The python session dictionary as a standard python dictionary object. |
+-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Optionally, a Python breakpoint command can return a value. Returning False
tells LLDB that you do not want to stop at the breakpoint. Any other return
@ -546,7 +546,7 @@ which should implement the following interface:
::
class CommandObjectType:
def __init__(self, debugger, session_dict):
def __init__(self, debugger, internal_dict):
this call should initialize the command with respect to the command interpreter for the passed-in debugger
def __call__(self, debugger, command, exe_ctx, result):
this is the actual bulk of the command, akin to Python command functions

4
lldb/source/Commands/CommandObjectBreakpointCommand.cpp
View File

@ -119,12 +119,12 @@ to supply the function name prepended by the module name:"
The function itself must have either of the following prototypes:
def breakpoint_callback(frame, bp_loc, dict):
def breakpoint_callback(frame, bp_loc, internal_dict):
# Your code goes here
or:
def breakpoint_callback(frame, bp_loc, extra_args, dict):
def breakpoint_callback(frame, bp_loc, extra_args, internal_dict):
# Your code goes here
)"