mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-26 14:58:59 -04:00
21dfcd9d41
This checkin adds the capability for LLDB to load plugins from external dylibs that can provide new commands It exports an SBCommand class from the public API layer, and a new SBCommandPluginInterface There is a minimal load-only plugin manager built into the debugger, which can be accessed via Debugger::LoadPlugin. Plugins are loaded from two locations at debugger startup (LLDB.framework/Resources/PlugIns and ~/Library/Application Support/LLDB/PlugIns) and more can be (re)loaded via the "plugin load" command For an example of how to make a plugin, refer to the fooplugin.cpp file in examples/plugins/commands Caveats: Currently, the new API objects and features are not exposed via Python. The new commands can only be "parsed" (i.e. not raw) and get their command line via a char** parameter (we do not expose our internal Args object) There is no unloading feature, which can potentially lead to leaks if you overwrite the commands by reloading the same or different plugins There is no API exposed for option parsing, which means you may need to use getopt or roll-your-own llvm-svn: 164865
126 lines
3.6 KiB
C++
126 lines
3.6 KiB
C++
//===-- SWIG Interface for SBCommandInterpreter -----------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
namespace lldb {
|
|
|
|
%feature("docstring",
|
|
"SBCommandInterpreter handles/interprets commands for lldb. You get the
|
|
command interpreter from the SBDebugger instance. For example (from test/
|
|
python_api/interpreter/TestCommandInterpreterAPI.py),
|
|
|
|
def command_interpreter_api(self):
|
|
'''Test the SBCommandInterpreter APIs.'''
|
|
exe = os.path.join(os.getcwd(), 'a.out')
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
# Retrieve the associated command interpreter from our debugger.
|
|
ci = self.dbg.GetCommandInterpreter()
|
|
self.assertTrue(ci, VALID_COMMAND_INTERPRETER)
|
|
|
|
# Exercise some APIs....
|
|
|
|
self.assertTrue(ci.HasCommands())
|
|
self.assertTrue(ci.HasAliases())
|
|
self.assertTrue(ci.HasAliasOptions())
|
|
self.assertTrue(ci.CommandExists('breakpoint'))
|
|
self.assertTrue(ci.CommandExists('target'))
|
|
self.assertTrue(ci.CommandExists('platform'))
|
|
self.assertTrue(ci.AliasExists('file'))
|
|
self.assertTrue(ci.AliasExists('run'))
|
|
self.assertTrue(ci.AliasExists('bt'))
|
|
|
|
res = lldb.SBCommandReturnObject()
|
|
ci.HandleCommand('breakpoint set -f main.c -l %d' % self.line, res)
|
|
self.assertTrue(res.Succeeded())
|
|
ci.HandleCommand('process launch', res)
|
|
self.assertTrue(res.Succeeded())
|
|
|
|
process = ci.GetProcess()
|
|
self.assertTrue(process)
|
|
|
|
...
|
|
|
|
The HandleCommand() instance method takes two args: the command string and
|
|
an SBCommandReturnObject instance which encapsulates the result of command
|
|
execution.
|
|
") SBCommandInterpreter;
|
|
class SBCommandInterpreter
|
|
{
|
|
public:
|
|
enum
|
|
{
|
|
eBroadcastBitThreadShouldExit = (1 << 0),
|
|
eBroadcastBitResetPrompt = (1 << 1),
|
|
eBroadcastBitQuitCommandReceived = (1 << 2), // User entered quit
|
|
eBroadcastBitAsynchronousOutputData = (1 << 3),
|
|
eBroadcastBitAsynchronousErrorData = (1 << 4)
|
|
};
|
|
|
|
SBCommandInterpreter (const lldb::SBCommandInterpreter &rhs);
|
|
|
|
~SBCommandInterpreter ();
|
|
|
|
static const char *
|
|
GetArgumentTypeAsCString (const lldb::CommandArgumentType arg_type);
|
|
|
|
static const char *
|
|
GetArgumentDescriptionAsCString (const lldb::CommandArgumentType arg_type);
|
|
|
|
bool
|
|
IsValid() const;
|
|
|
|
bool
|
|
CommandExists (const char *cmd);
|
|
|
|
bool
|
|
AliasExists (const char *cmd);
|
|
|
|
lldb::SBBroadcaster
|
|
GetBroadcaster ();
|
|
|
|
static const char *
|
|
GetBroadcasterClass ();
|
|
|
|
bool
|
|
HasCommands ();
|
|
|
|
bool
|
|
HasAliases ();
|
|
|
|
bool
|
|
HasAliasOptions ();
|
|
|
|
lldb::SBProcess
|
|
GetProcess ();
|
|
|
|
lldb::SBDebugger
|
|
GetDebugger ();
|
|
|
|
void
|
|
SourceInitFileInHomeDirectory (lldb::SBCommandReturnObject &result);
|
|
|
|
void
|
|
SourceInitFileInCurrentWorkingDirectory (lldb::SBCommandReturnObject &result);
|
|
|
|
lldb::ReturnStatus
|
|
HandleCommand (const char *command_line, lldb::SBCommandReturnObject &result, bool add_to_history = false);
|
|
|
|
int
|
|
HandleCompletion (const char *current_line,
|
|
uint32_t cursor_pos,
|
|
int match_start_point,
|
|
int max_return_elements,
|
|
lldb::SBStringList &matches);
|
|
};
|
|
|
|
} // namespace lldb
|