mirror of
https://github.com/idapython/src
synced 2026-06-08 14:47:00 +00:00
Arnaud Diederen
101 lines
3.1 KiB
Python
101 lines
3.1 KiB
Python
# -----------------------------------------------------------------------
|
|
#<pycode(py_kernwin_cli)>
|
|
import ida_idaapi
|
|
|
|
class cli_t(ida_idaapi.pyidc_opaque_object_t):
|
|
"""
|
|
cli_t wrapper class.
|
|
|
|
This class allows you to implement your own command line interface handlers.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.__cli_idx = -1
|
|
self.__clink__ = None
|
|
|
|
def __del__(self):
|
|
self.unregister()
|
|
|
|
def register(self, flags = 0, sname = None, lname = None, hint = None):
|
|
"""
|
|
Registers the CLI.
|
|
|
|
@param flags: Feature bits. No bits are defined yet, must be 0
|
|
@param sname: Short name (displayed on the button)
|
|
@param lname: Long name (displayed in the menu)
|
|
@param hint: Hint for the input line
|
|
|
|
@return Boolean: True-Success, False-Failed
|
|
"""
|
|
|
|
# Already registered?
|
|
if self.__cli_idx >= 0:
|
|
return True
|
|
|
|
if sname is not None: self.sname = sname
|
|
if lname is not None: self.lname = lname
|
|
if hint is not None: self.hint = hint
|
|
|
|
# Register
|
|
self.__cli_idx = _ida_kernwin.install_command_interpreter(self)
|
|
return False if self.__cli_idx < 0 else True
|
|
|
|
def unregister(self):
|
|
"""
|
|
Unregisters the CLI (if it was registered)
|
|
"""
|
|
if self.__cli_idx < 0:
|
|
return False
|
|
|
|
_ida_kernwin.remove_command_interpreter(self.__cli_idx)
|
|
self.__cli_idx = -1
|
|
return True
|
|
|
|
def OnExecuteLine(self, line):
|
|
"""
|
|
The user pressed Enter. The CLI is free to execute the line immediately or ask for more lines.
|
|
|
|
This callback is mandatory.
|
|
|
|
@param line: typed line(s)
|
|
@return Boolean: True-executed line, False-ask for more lines
|
|
"""
|
|
return True
|
|
|
|
def OnKeydown(self, line, x, sellen, vkey, shift):
|
|
"""
|
|
A keyboard key has been pressed
|
|
This is a generic callback and the CLI is free to do whatever it wants.
|
|
|
|
This callback is optional.
|
|
|
|
@param line: current input line
|
|
@param x: current x coordinate of the cursor
|
|
@param sellen: current selection length (usually 0)
|
|
@param vkey: virtual key code. if the key has been handled, it should be returned as zero
|
|
@param shift: shift state
|
|
|
|
@return:
|
|
None - Nothing was changed
|
|
tuple(line, x, sellen, vkey): if either of the input line or the x coordinate or the selection length has been modified.
|
|
It is possible to return a tuple with None elements to preserve old values. Example: tuple(new_line, None, None, None) or tuple(new_line)
|
|
"""
|
|
return None
|
|
|
|
def OnFindCompletions(self, line, x):
|
|
"""
|
|
The user pressed Tab. Return a list of completions
|
|
|
|
This callback is optional.
|
|
|
|
@param line: the current line (string)
|
|
@param x: the index where the cursor is (int)
|
|
|
|
@return: None if no completion could be generated, otherwise a tuple:
|
|
(completions : Sequence[str], hints : Sequence[str], docs: Sequence[str],
|
|
match_start: int, match_end: int)
|
|
"""
|
|
return None
|
|
|
|
#</pycode(py_kernwin_cli)>
|