blob: dfb4d5963d7a79748507499fa7dee98cbe23b53e [file] [log] [blame]
Chris Lattner24943d22010-06-08 16:52:24 +00001//===-- CommandInterpreter.cpp ----------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include <string>
Caroline Ticebd5c63e2010-10-12 21:57:09 +000011#include <vector>
Chris Lattner24943d22010-06-08 16:52:24 +000012
13#include <getopt.h>
14#include <stdlib.h>
15
Greg Clayton5c28dd12011-06-23 17:59:56 +000016#include "CommandObjectScript.h"
Peter Collingbourne921fac02011-06-23 20:37:26 +000017#include "lldb/Interpreter/CommandObjectRegexCommand.h"
Greg Clayton5c28dd12011-06-23 17:59:56 +000018
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000019#include "../Commands/CommandObjectApropos.h"
20#include "../Commands/CommandObjectArgs.h"
21#include "../Commands/CommandObjectBreakpoint.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000022#include "../Commands/CommandObjectDisassemble.h"
23#include "../Commands/CommandObjectExpression.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000024#include "../Commands/CommandObjectFrame.h"
25#include "../Commands/CommandObjectHelp.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000026#include "../Commands/CommandObjectLog.h"
27#include "../Commands/CommandObjectMemory.h"
Greg Claytonb1888f22011-03-19 01:12:21 +000028#include "../Commands/CommandObjectPlatform.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000029#include "../Commands/CommandObjectProcess.h"
30#include "../Commands/CommandObjectQuit.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000031#include "../Commands/CommandObjectRegister.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000032#include "../Commands/CommandObjectSettings.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000033#include "../Commands/CommandObjectSource.h"
Jim Ingham767af882010-07-07 03:36:20 +000034#include "../Commands/CommandObjectCommands.h"
Eli Friedmanccdb9ec2010-06-13 02:17:17 +000035#include "../Commands/CommandObjectSyntax.h"
36#include "../Commands/CommandObjectTarget.h"
37#include "../Commands/CommandObjectThread.h"
Greg Clayton5c28dd12011-06-23 17:59:56 +000038#include "../Commands/CommandObjectType.h"
Johnny Chen902e0182010-12-23 20:21:44 +000039#include "../Commands/CommandObjectVersion.h"
Johnny Chen01acfa72011-09-22 18:04:58 +000040#include "../Commands/CommandObjectWatchpoint.h"
Chris Lattner24943d22010-06-08 16:52:24 +000041
Jim Ingham84cdc152010-06-15 19:49:27 +000042#include "lldb/Interpreter/Args.h"
Caroline Tice5ddbe212011-05-06 21:37:15 +000043#include "lldb/Interpreter/Options.h"
Chris Lattner24943d22010-06-08 16:52:24 +000044#include "lldb/Core/Debugger.h"
Jim Ingham5e16ef52010-10-04 19:49:29 +000045#include "lldb/Core/InputReader.h"
Chris Lattner24943d22010-06-08 16:52:24 +000046#include "lldb/Core/Stream.h"
47#include "lldb/Core/Timer.h"
Greg Claytoncd548032011-02-01 01:31:41 +000048#include "lldb/Host/Host.h"
Chris Lattner24943d22010-06-08 16:52:24 +000049#include "lldb/Target/Process.h"
50#include "lldb/Target/Thread.h"
51#include "lldb/Target/TargetList.h"
Greg Claytone98ac252010-11-10 04:57:04 +000052#include "lldb/Utility/CleanUp.h"
Chris Lattner24943d22010-06-08 16:52:24 +000053
54#include "lldb/Interpreter/CommandReturnObject.h"
55#include "lldb/Interpreter/CommandInterpreter.h"
Caroline Tice0aa2e552011-01-14 00:29:16 +000056#include "lldb/Interpreter/ScriptInterpreterNone.h"
57#include "lldb/Interpreter/ScriptInterpreterPython.h"
Chris Lattner24943d22010-06-08 16:52:24 +000058
59using namespace lldb;
60using namespace lldb_private;
61
62CommandInterpreter::CommandInterpreter
63(
Greg Clayton63094e02010-06-23 01:19:29 +000064 Debugger &debugger,
Chris Lattner24943d22010-06-08 16:52:24 +000065 ScriptLanguage script_language,
Greg Clayton63094e02010-06-23 01:19:29 +000066 bool synchronous_execution
Chris Lattner24943d22010-06-08 16:52:24 +000067) :
Greg Clayton49ce6822010-10-31 03:01:06 +000068 Broadcaster ("lldb.command-interpreter"),
Greg Clayton63094e02010-06-23 01:19:29 +000069 m_debugger (debugger),
Greg Clayton887aa282010-10-11 01:05:37 +000070 m_synchronous_execution (synchronous_execution),
Caroline Tice0aa2e552011-01-14 00:29:16 +000071 m_skip_lldbinit_files (false),
Jim Ingham574c3d62011-08-12 23:34:31 +000072 m_skip_app_init_files (false),
Jim Ingham949d5ac2011-02-18 00:54:25 +000073 m_script_interpreter_ap (),
Caroline Tice892fadd2011-06-16 16:27:19 +000074 m_comment_char ('#'),
Jim Ingham6247dbe2011-07-12 03:12:18 +000075 m_repeat_char ('!'),
Enrico Granata293a7b32011-08-15 19:24:02 +000076 m_batch_command_mode (false),
77 m_truncation_warning(eNoTruncation)
Chris Lattner24943d22010-06-08 16:52:24 +000078{
Caroline Tice6e4c5ce2010-09-04 00:03:46 +000079 const char *dbg_name = debugger.GetInstanceName().AsCString();
80 std::string lang_name = ScriptInterpreter::LanguageToString (script_language);
81 StreamString var_name;
82 var_name.Printf ("[%s].script-lang", dbg_name);
Caroline Tice1d2aefd2010-09-09 06:25:08 +000083 debugger.GetSettingsController()->SetVariable (var_name.GetData(), lang_name.c_str(),
Greg Claytonb3448432011-03-24 21:19:54 +000084 eVarSetOperationAssign, false,
Greg Clayton49ce6822010-10-31 03:01:06 +000085 m_debugger.GetInstanceName().AsCString());
86 SetEventName (eBroadcastBitThreadShouldExit, "thread-should-exit");
87 SetEventName (eBroadcastBitResetPrompt, "reset-prompt");
88 SetEventName (eBroadcastBitQuitCommandReceived, "quit");
Chris Lattner24943d22010-06-08 16:52:24 +000089}
90
91void
92CommandInterpreter::Initialize ()
93{
94 Timer scoped_timer (__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
95
96 CommandReturnObject result;
97
98 LoadCommandDictionary ();
99
Chris Lattner24943d22010-06-08 16:52:24 +0000100 // Set up some initial aliases.
Caroline Tice5ddbe212011-05-06 21:37:15 +0000101 CommandObjectSP cmd_obj_sp = GetCommandSPExact ("quit", false);
102 if (cmd_obj_sp)
103 {
104 AddAlias ("q", cmd_obj_sp);
105 AddAlias ("exit", cmd_obj_sp);
106 }
107
108 cmd_obj_sp = GetCommandSPExact ("process continue", false);
109 if (cmd_obj_sp)
110 {
111 AddAlias ("c", cmd_obj_sp);
112 AddAlias ("continue", cmd_obj_sp);
113 }
114
115 cmd_obj_sp = GetCommandSPExact ("_regexp-break",false);
116 if (cmd_obj_sp)
117 AddAlias ("b", cmd_obj_sp);
118
119 cmd_obj_sp = GetCommandSPExact ("thread backtrace", false);
120 if (cmd_obj_sp)
121 AddAlias ("bt", cmd_obj_sp);
122
123 cmd_obj_sp = GetCommandSPExact ("thread step-inst", false);
124 if (cmd_obj_sp)
Jason Molenda47eb00e2011-10-22 00:47:41 +0000125 {
126 AddAlias ("stepi", cmd_obj_sp);
Caroline Tice5ddbe212011-05-06 21:37:15 +0000127 AddAlias ("si", cmd_obj_sp);
Jason Molenda47eb00e2011-10-22 00:47:41 +0000128 }
129
130 cmd_obj_sp = GetCommandSPExact ("thread step-inst-over", false);
131 if (cmd_obj_sp)
132 {
133 AddAlias ("nexti", cmd_obj_sp);
134 AddAlias ("ni", cmd_obj_sp);
135 }
Caroline Tice5ddbe212011-05-06 21:37:15 +0000136
137 cmd_obj_sp = GetCommandSPExact ("thread step-in", false);
138 if (cmd_obj_sp)
139 {
140 AddAlias ("s", cmd_obj_sp);
141 AddAlias ("step", cmd_obj_sp);
142 }
143
144 cmd_obj_sp = GetCommandSPExact ("thread step-over", false);
145 if (cmd_obj_sp)
146 {
147 AddAlias ("n", cmd_obj_sp);
148 AddAlias ("next", cmd_obj_sp);
149 }
150
151 cmd_obj_sp = GetCommandSPExact ("thread step-out", false);
152 if (cmd_obj_sp)
153 {
154 AddAlias ("f", cmd_obj_sp);
155 AddAlias ("finish", cmd_obj_sp);
156 }
157
158 cmd_obj_sp = GetCommandSPExact ("source list", false);
159 if (cmd_obj_sp)
160 {
161 AddAlias ("l", cmd_obj_sp);
162 AddAlias ("list", cmd_obj_sp);
163 }
164
165 cmd_obj_sp = GetCommandSPExact ("memory read", false);
166 if (cmd_obj_sp)
167 AddAlias ("x", cmd_obj_sp);
168
169 cmd_obj_sp = GetCommandSPExact ("_regexp-up", false);
170 if (cmd_obj_sp)
171 AddAlias ("up", cmd_obj_sp);
172
173 cmd_obj_sp = GetCommandSPExact ("_regexp-down", false);
174 if (cmd_obj_sp)
175 AddAlias ("down", cmd_obj_sp);
176
Jason Molenda3f2ec9b2011-10-25 02:11:20 +0000177 cmd_obj_sp = GetCommandSPExact ("_regexp-display", false);
Jason Molenda730cae02011-10-22 01:30:52 +0000178 if (cmd_obj_sp)
179 AddAlias ("display", cmd_obj_sp);
Jim Ingham9d1acc12011-10-24 18:37:00 +0000180
181 cmd_obj_sp = GetCommandSPExact ("disassemble", false);
182 if (cmd_obj_sp)
183 AddAlias ("dis", cmd_obj_sp);
184
185 cmd_obj_sp = GetCommandSPExact ("disassemble", false);
186 if (cmd_obj_sp)
187 AddAlias ("di", cmd_obj_sp);
188
189
Jason Molenda730cae02011-10-22 01:30:52 +0000190
Jason Molenda3f2ec9b2011-10-25 02:11:20 +0000191 cmd_obj_sp = GetCommandSPExact ("_regexp-undisplay", false);
Jason Molenda730cae02011-10-22 01:30:52 +0000192 if (cmd_obj_sp)
193 AddAlias ("undisplay", cmd_obj_sp);
194
Caroline Tice5ddbe212011-05-06 21:37:15 +0000195 cmd_obj_sp = GetCommandSPExact ("target create", false);
196 if (cmd_obj_sp)
197 AddAlias ("file", cmd_obj_sp);
198
199 cmd_obj_sp = GetCommandSPExact ("target modules", false);
200 if (cmd_obj_sp)
201 AddAlias ("image", cmd_obj_sp);
202
203
204 OptionArgVectorSP alias_arguments_vector_sp (new OptionArgVector);
Jim Inghame56493f2011-03-22 02:29:32 +0000205
Caroline Tice5ddbe212011-05-06 21:37:15 +0000206 cmd_obj_sp = GetCommandSPExact ("expression", false);
207 if (cmd_obj_sp)
208 {
209 AddAlias ("expr", cmd_obj_sp);
210
211 ProcessAliasOptionsArgs (cmd_obj_sp, "--", alias_arguments_vector_sp);
212 AddAlias ("p", cmd_obj_sp);
213 AddAlias ("print", cmd_obj_sp);
214 AddOrReplaceAliasOptions ("p", alias_arguments_vector_sp);
215 AddOrReplaceAliasOptions ("print", alias_arguments_vector_sp);
216
217 alias_arguments_vector_sp.reset (new OptionArgVector);
218 ProcessAliasOptionsArgs (cmd_obj_sp, "-o --", alias_arguments_vector_sp);
219 AddAlias ("po", cmd_obj_sp);
220 AddOrReplaceAliasOptions ("po", alias_arguments_vector_sp);
221 }
222
223 cmd_obj_sp = GetCommandSPExact ("process launch", false);
224 if (cmd_obj_sp)
225 {
226 alias_arguments_vector_sp.reset (new OptionArgVector);
227 ProcessAliasOptionsArgs (cmd_obj_sp, "--", alias_arguments_vector_sp);
228 AddAlias ("r", cmd_obj_sp);
229 AddAlias ("run", cmd_obj_sp);
230 AddOrReplaceAliasOptions ("r", alias_arguments_vector_sp);
231 AddOrReplaceAliasOptions ("run", alias_arguments_vector_sp);
232 }
Chris Lattner24943d22010-06-08 16:52:24 +0000233}
234
Chris Lattner24943d22010-06-08 16:52:24 +0000235const char *
236CommandInterpreter::ProcessEmbeddedScriptCommands (const char *arg)
237{
238 // This function has not yet been implemented.
239
240 // Look for any embedded script command
241 // If found,
242 // get interpreter object from the command dictionary,
243 // call execute_one_command on it,
244 // get the results as a string,
245 // substitute that string for current stuff.
246
247 return arg;
248}
249
250
251void
252CommandInterpreter::LoadCommandDictionary ()
253{
254 Timer scoped_timer (__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
255
256 // **** IMPORTANT **** IMPORTANT *** IMPORTANT *** **** IMPORTANT **** IMPORTANT *** IMPORTANT ***
257 //
258 // Command objects that are used as cross reference objects (i.e. they inherit from CommandObjectCrossref)
259 // *MUST* be created and put into the command dictionary *BEFORE* any multi-word commands (which may use
260 // the cross-referencing stuff) are created!!!
261 //
262 // **** IMPORTANT **** IMPORTANT *** IMPORTANT *** **** IMPORTANT **** IMPORTANT *** IMPORTANT ***
263
264
265 // Command objects that inherit from CommandObjectCrossref must be created before other command objects
266 // are created. This is so that when another command is created that needs to go into a crossref object,
267 // the crossref object exists and is ready to take the cross reference. Put the cross referencing command
268 // objects into the CommandDictionary now, so they are ready for use when the other commands get created.
269
Chris Lattner24943d22010-06-08 16:52:24 +0000270 // Non-CommandObjectCrossref commands can now be created.
271
Caroline Tice5bc8c972010-09-20 20:44:43 +0000272 lldb::ScriptLanguage script_language = m_debugger.GetScriptLanguage();
Caroline Tice6e4c5ce2010-09-04 00:03:46 +0000273
Greg Clayton238c0a12010-09-18 01:14:36 +0000274 m_command_dict["apropos"] = CommandObjectSP (new CommandObjectApropos (*this));
Greg Clayton63094e02010-06-23 01:19:29 +0000275 m_command_dict["breakpoint"]= CommandObjectSP (new CommandObjectMultiwordBreakpoint (*this));
Greg Clayton238c0a12010-09-18 01:14:36 +0000276 //m_command_dict["call"] = CommandObjectSP (new CommandObjectCall (*this));
Johnny Chen9e4c3d72011-04-21 00:39:18 +0000277 m_command_dict["command"] = CommandObjectSP (new CommandObjectMultiwordCommands (*this));
Greg Clayton238c0a12010-09-18 01:14:36 +0000278 m_command_dict["disassemble"] = CommandObjectSP (new CommandObjectDisassemble (*this));
279 m_command_dict["expression"]= CommandObjectSP (new CommandObjectExpression (*this));
Greg Claytonabe0fed2011-04-18 08:33:37 +0000280// m_command_dict["file"] = CommandObjectSP (new CommandObjectFile (*this));
Greg Clayton63094e02010-06-23 01:19:29 +0000281 m_command_dict["frame"] = CommandObjectSP (new CommandObjectMultiwordFrame (*this));
Greg Clayton238c0a12010-09-18 01:14:36 +0000282 m_command_dict["help"] = CommandObjectSP (new CommandObjectHelp (*this));
Greg Claytone1f50b92011-05-03 22:09:39 +0000283 /// m_command_dict["image"] = CommandObjectSP (new CommandObjectImage (*this));
Greg Clayton63094e02010-06-23 01:19:29 +0000284 m_command_dict["log"] = CommandObjectSP (new CommandObjectLog (*this));
285 m_command_dict["memory"] = CommandObjectSP (new CommandObjectMemory (*this));
Greg Claytonb1888f22011-03-19 01:12:21 +0000286 m_command_dict["platform"] = CommandObjectSP (new CommandObjectPlatform (*this));
Greg Clayton63094e02010-06-23 01:19:29 +0000287 m_command_dict["process"] = CommandObjectSP (new CommandObjectMultiwordProcess (*this));
Greg Clayton238c0a12010-09-18 01:14:36 +0000288 m_command_dict["quit"] = CommandObjectSP (new CommandObjectQuit (*this));
Greg Clayton63094e02010-06-23 01:19:29 +0000289 m_command_dict["register"] = CommandObjectSP (new CommandObjectRegister (*this));
Greg Clayton238c0a12010-09-18 01:14:36 +0000290 m_command_dict["script"] = CommandObjectSP (new CommandObjectScript (*this, script_language));
Caroline Tice6e4c5ce2010-09-04 00:03:46 +0000291 m_command_dict["settings"] = CommandObjectSP (new CommandObjectMultiwordSettings (*this));
Jim Ingham767af882010-07-07 03:36:20 +0000292 m_command_dict["source"] = CommandObjectSP (new CommandObjectMultiwordSource (*this));
Greg Clayton63094e02010-06-23 01:19:29 +0000293 m_command_dict["target"] = CommandObjectSP (new CommandObjectMultiwordTarget (*this));
294 m_command_dict["thread"] = CommandObjectSP (new CommandObjectMultiwordThread (*this));
Enrico Granata6b1596d2011-08-16 23:24:13 +0000295 m_command_dict["type"] = CommandObjectSP (new CommandObjectType (*this));
Johnny Chen902e0182010-12-23 20:21:44 +0000296 m_command_dict["version"] = CommandObjectSP (new CommandObjectVersion (*this));
Johnny Chen01acfa72011-09-22 18:04:58 +0000297 m_command_dict["watchpoint"]= CommandObjectSP (new CommandObjectMultiwordWatchpoint (*this));
Chris Lattner24943d22010-06-08 16:52:24 +0000298
299 std::auto_ptr<CommandObjectRegexCommand>
Greg Clayton238c0a12010-09-18 01:14:36 +0000300 break_regex_cmd_ap(new CommandObjectRegexCommand (*this,
Greg Claytonb72d0f02011-04-12 05:54:46 +0000301 "_regexp-break",
Caroline Ticec1ad82e2010-09-07 22:38:08 +0000302 "Set a breakpoint using a regular expression to specify the location.",
Greg Claytonb72d0f02011-04-12 05:54:46 +0000303 "_regexp-break [<filename>:<linenum>]\n_regexp-break [<address>]\n_regexp-break <...>", 2));
Chris Lattner24943d22010-06-08 16:52:24 +0000304 if (break_regex_cmd_ap.get())
305 {
306 if (break_regex_cmd_ap->AddRegexCommand("^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*$", "breakpoint set --file '%1' --line %2") &&
307 break_regex_cmd_ap->AddRegexCommand("^(0x[[:xdigit:]]+)[[:space:]]*$", "breakpoint set --address %1") &&
308 break_regex_cmd_ap->AddRegexCommand("^[\"']?([-+]\\[.*\\])[\"']?[[:space:]]*$", "breakpoint set --name '%1'") &&
Greg Claytonb72d0f02011-04-12 05:54:46 +0000309 break_regex_cmd_ap->AddRegexCommand("^$", "breakpoint list --full") &&
Chris Lattner24943d22010-06-08 16:52:24 +0000310 break_regex_cmd_ap->AddRegexCommand("^(-.*)$", "breakpoint set %1") &&
Greg Claytonb01000f2011-01-17 03:46:26 +0000311 break_regex_cmd_ap->AddRegexCommand("^(.*[^[:space:]])`(.*[^[:space:]])[[:space:]]*$", "breakpoint set --name '%2' --shlib '%1'") &&
Chris Lattner24943d22010-06-08 16:52:24 +0000312 break_regex_cmd_ap->AddRegexCommand("^(.*[^[:space:]])[[:space:]]*$", "breakpoint set --name '%1'"))
313 {
314 CommandObjectSP break_regex_cmd_sp(break_regex_cmd_ap.release());
315 m_command_dict[break_regex_cmd_sp->GetCommandName ()] = break_regex_cmd_sp;
316 }
317 }
Jim Inghame56493f2011-03-22 02:29:32 +0000318
319 std::auto_ptr<CommandObjectRegexCommand>
320 down_regex_cmd_ap(new CommandObjectRegexCommand (*this,
Greg Claytonb72d0f02011-04-12 05:54:46 +0000321 "_regexp-down",
322 "Go down \"n\" frames in the stack (1 frame by default).",
323 "_regexp-down [n]", 2));
Jim Inghame56493f2011-03-22 02:29:32 +0000324 if (down_regex_cmd_ap.get())
325 {
326 if (down_regex_cmd_ap->AddRegexCommand("^$", "frame select -r -1") &&
327 down_regex_cmd_ap->AddRegexCommand("^([0-9]+)$", "frame select -r -%1"))
328 {
329 CommandObjectSP down_regex_cmd_sp(down_regex_cmd_ap.release());
330 m_command_dict[down_regex_cmd_sp->GetCommandName ()] = down_regex_cmd_sp;
331 }
332 }
333
334 std::auto_ptr<CommandObjectRegexCommand>
335 up_regex_cmd_ap(new CommandObjectRegexCommand (*this,
Greg Claytonb72d0f02011-04-12 05:54:46 +0000336 "_regexp-up",
337 "Go up \"n\" frames in the stack (1 frame by default).",
338 "_regexp-up [n]", 2));
Jim Inghame56493f2011-03-22 02:29:32 +0000339 if (up_regex_cmd_ap.get())
340 {
341 if (up_regex_cmd_ap->AddRegexCommand("^$", "frame select -r 1") &&
342 up_regex_cmd_ap->AddRegexCommand("^([0-9]+)$", "frame select -r %1"))
343 {
344 CommandObjectSP up_regex_cmd_sp(up_regex_cmd_ap.release());
345 m_command_dict[up_regex_cmd_sp->GetCommandName ()] = up_regex_cmd_sp;
346 }
347 }
Jason Molenda730cae02011-10-22 01:30:52 +0000348
349 std::auto_ptr<CommandObjectRegexCommand>
350 display_regex_cmd_ap(new CommandObjectRegexCommand (*this,
Jason Molenda3f2ec9b2011-10-25 02:11:20 +0000351 "_regexp-display",
Jason Molenda730cae02011-10-22 01:30:52 +0000352 "Add an expression evaluation stop-hook.",
Jason Molenda3f2ec9b2011-10-25 02:11:20 +0000353 "_regexp-display expression", 2));
Jason Molenda730cae02011-10-22 01:30:52 +0000354 if (display_regex_cmd_ap.get())
355 {
356 if (display_regex_cmd_ap->AddRegexCommand("^(.+)$", "target stop-hook add -o \"expr -- %1\""))
357 {
358 CommandObjectSP display_regex_cmd_sp(display_regex_cmd_ap.release());
359 m_command_dict[display_regex_cmd_sp->GetCommandName ()] = display_regex_cmd_sp;
360 }
361 }
362
363 std::auto_ptr<CommandObjectRegexCommand>
364 undisplay_regex_cmd_ap(new CommandObjectRegexCommand (*this,
Jason Molenda3f2ec9b2011-10-25 02:11:20 +0000365 "_regexp-undisplay",
Jason Molenda730cae02011-10-22 01:30:52 +0000366 "Remove an expression evaluation stop-hook.",
Jason Molenda3f2ec9b2011-10-25 02:11:20 +0000367 "_regexp-undisplay stop-hook-number", 2));
Jason Molenda730cae02011-10-22 01:30:52 +0000368 if (undisplay_regex_cmd_ap.get())
369 {
370 if (undisplay_regex_cmd_ap->AddRegexCommand("^([0-9]+)$", "target stop-hook delete %1"))
371 {
372 CommandObjectSP undisplay_regex_cmd_sp(undisplay_regex_cmd_ap.release());
373 m_command_dict[undisplay_regex_cmd_sp->GetCommandName ()] = undisplay_regex_cmd_sp;
374 }
375 }
376
Chris Lattner24943d22010-06-08 16:52:24 +0000377}
378
379int
380CommandInterpreter::GetCommandNamesMatchingPartialString (const char *cmd_str, bool include_aliases,
381 StringList &matches)
382{
383 CommandObject::AddNamesMatchingPartialString (m_command_dict, cmd_str, matches);
384
385 if (include_aliases)
386 {
387 CommandObject::AddNamesMatchingPartialString (m_alias_dict, cmd_str, matches);
388 }
389
390 return matches.GetSize();
391}
392
393CommandObjectSP
394CommandInterpreter::GetCommandSP (const char *cmd_cstr, bool include_aliases, bool exact, StringList *matches)
395{
396 CommandObject::CommandMap::iterator pos;
397 CommandObjectSP ret_val;
398
399 std::string cmd(cmd_cstr);
400
401 if (HasCommands())
402 {
403 pos = m_command_dict.find(cmd);
404 if (pos != m_command_dict.end())
405 ret_val = pos->second;
406 }
407
408 if (include_aliases && HasAliases())
409 {
410 pos = m_alias_dict.find(cmd);
411 if (pos != m_alias_dict.end())
412 ret_val = pos->second;
413 }
414
415 if (HasUserCommands())
416 {
417 pos = m_user_dict.find(cmd);
418 if (pos != m_user_dict.end())
419 ret_val = pos->second;
420 }
421
422 if (!exact && ret_val == NULL)
423 {
Jim Inghamd40f8a62010-07-06 22:46:59 +0000424 // We will only get into here if we didn't find any exact matches.
425
426 CommandObjectSP user_match_sp, alias_match_sp, real_match_sp;
427
Chris Lattner24943d22010-06-08 16:52:24 +0000428 StringList local_matches;
429 if (matches == NULL)
430 matches = &local_matches;
431
Jim Inghamd40f8a62010-07-06 22:46:59 +0000432 unsigned int num_cmd_matches = 0;
433 unsigned int num_alias_matches = 0;
434 unsigned int num_user_matches = 0;
435
436 // Look through the command dictionaries one by one, and if we get only one match from any of
437 // them in toto, then return that, otherwise return an empty CommandObjectSP and the list of matches.
438
Chris Lattner24943d22010-06-08 16:52:24 +0000439 if (HasCommands())
440 {
441 num_cmd_matches = CommandObject::AddNamesMatchingPartialString (m_command_dict, cmd_cstr, *matches);
442 }
443
444 if (num_cmd_matches == 1)
445 {
446 cmd.assign(matches->GetStringAtIndex(0));
447 pos = m_command_dict.find(cmd);
448 if (pos != m_command_dict.end())
Jim Inghamd40f8a62010-07-06 22:46:59 +0000449 real_match_sp = pos->second;
Chris Lattner24943d22010-06-08 16:52:24 +0000450 }
451
Jim Ingham9a574172010-06-24 20:28:42 +0000452 if (include_aliases && HasAliases())
Chris Lattner24943d22010-06-08 16:52:24 +0000453 {
454 num_alias_matches = CommandObject::AddNamesMatchingPartialString (m_alias_dict, cmd_cstr, *matches);
455
456 }
457
Jim Inghamd40f8a62010-07-06 22:46:59 +0000458 if (num_alias_matches == 1)
Chris Lattner24943d22010-06-08 16:52:24 +0000459 {
460 cmd.assign(matches->GetStringAtIndex (num_cmd_matches));
461 pos = m_alias_dict.find(cmd);
462 if (pos != m_alias_dict.end())
Jim Inghamd40f8a62010-07-06 22:46:59 +0000463 alias_match_sp = pos->second;
Chris Lattner24943d22010-06-08 16:52:24 +0000464 }
465
Jim Ingham9a574172010-06-24 20:28:42 +0000466 if (HasUserCommands())
Chris Lattner24943d22010-06-08 16:52:24 +0000467 {
468 num_user_matches = CommandObject::AddNamesMatchingPartialString (m_user_dict, cmd_cstr, *matches);
469 }
470
Jim Inghamd40f8a62010-07-06 22:46:59 +0000471 if (num_user_matches == 1)
Chris Lattner24943d22010-06-08 16:52:24 +0000472 {
473 cmd.assign (matches->GetStringAtIndex (num_cmd_matches + num_alias_matches));
474
475 pos = m_user_dict.find (cmd);
476 if (pos != m_user_dict.end())
Jim Inghamd40f8a62010-07-06 22:46:59 +0000477 user_match_sp = pos->second;
478 }
479
480 // If we got exactly one match, return that, otherwise return the match list.
481
482 if (num_user_matches + num_cmd_matches + num_alias_matches == 1)
483 {
484 if (num_cmd_matches)
485 return real_match_sp;
486 else if (num_alias_matches)
487 return alias_match_sp;
488 else
489 return user_match_sp;
Chris Lattner24943d22010-06-08 16:52:24 +0000490 }
491 }
Jim Inghamd40f8a62010-07-06 22:46:59 +0000492 else if (matches && ret_val != NULL)
493 {
494 matches->AppendString (cmd_cstr);
Chris Lattner24943d22010-06-08 16:52:24 +0000495 }
496
497
498 return ret_val;
499}
500
Greg Claytond12aeab2011-04-20 16:37:46 +0000501bool
502CommandInterpreter::AddCommand (const char *name, const lldb::CommandObjectSP &cmd_sp, bool can_replace)
503{
504 if (name && name[0])
505 {
506 std::string name_sstr(name);
507 if (!can_replace)
508 {
509 if (m_command_dict.find (name_sstr) != m_command_dict.end())
510 return false;
511 }
512 m_command_dict[name_sstr] = cmd_sp;
513 return true;
514 }
515 return false;
516}
517
Enrico Granata6b1596d2011-08-16 23:24:13 +0000518bool
519CommandInterpreter::AddUserCommand (const char *name,
520 const lldb::CommandObjectSP &cmd_sp,
521 bool can_replace)
522{
523 if (name && name[0])
524 {
525 std::string name_sstr(name);
526 if (!can_replace)
527 {
528 if (m_user_dict.find (name_sstr) != m_user_dict.end())
529 return false;
530 }
531 m_user_dict[name_sstr] = cmd_sp;
532 return true;
533 }
534 return false;
535}
Greg Claytond12aeab2011-04-20 16:37:46 +0000536
Jim Inghamd40f8a62010-07-06 22:46:59 +0000537CommandObjectSP
538CommandInterpreter::GetCommandSPExact (const char *cmd_cstr, bool include_aliases)
Chris Lattner24943d22010-06-08 16:52:24 +0000539{
Caroline Tice56d2fc42010-12-14 18:51:39 +0000540 Args cmd_words (cmd_cstr); // Break up the command string into words, in case it's a multi-word command.
541 CommandObjectSP ret_val; // Possibly empty return value.
542
543 if (cmd_cstr == NULL)
544 return ret_val;
545
546 if (cmd_words.GetArgumentCount() == 1)
547 return GetCommandSP(cmd_cstr, include_aliases, true, NULL);
548 else
549 {
550 // We have a multi-word command (seemingly), so we need to do more work.
551 // First, get the cmd_obj_sp for the first word in the command.
552 CommandObjectSP cmd_obj_sp = GetCommandSP (cmd_words.GetArgumentAtIndex (0), include_aliases, true, NULL);
553 if (cmd_obj_sp.get() != NULL)
554 {
555 // Loop through the rest of the words in the command (everything passed in was supposed to be part of a
556 // command name), and find the appropriate sub-command SP for each command word....
557 size_t end = cmd_words.GetArgumentCount();
558 for (size_t j= 1; j < end; ++j)
559 {
560 if (cmd_obj_sp->IsMultiwordObject())
561 {
562 cmd_obj_sp = ((CommandObjectMultiword *) cmd_obj_sp.get())->GetSubcommandSP
563 (cmd_words.GetArgumentAtIndex (j));
564 if (cmd_obj_sp.get() == NULL)
565 // The sub-command name was invalid. Fail and return the empty 'ret_val'.
566 return ret_val;
567 }
568 else
569 // We have more words in the command name, but we don't have a multiword object. Fail and return
570 // empty 'ret_val'.
571 return ret_val;
572 }
573 // We successfully looped through all the command words and got valid command objects for them. Assign the
574 // last object retrieved to 'ret_val'.
575 ret_val = cmd_obj_sp;
576 }
577 }
578 return ret_val;
Jim Inghamd40f8a62010-07-06 22:46:59 +0000579}
580
581CommandObject *
582CommandInterpreter::GetCommandObjectExact (const char *cmd_cstr, bool include_aliases)
583{
584 return GetCommandSPExact (cmd_cstr, include_aliases).get();
585}
586
587CommandObject *
588CommandInterpreter::GetCommandObject (const char *cmd_cstr, StringList *matches)
589{
590 CommandObject *command_obj = GetCommandSP (cmd_cstr, false, true, matches).get();
591
592 // If we didn't find an exact match to the command string in the commands, look in
593 // the aliases.
594
595 if (command_obj == NULL)
596 {
597 command_obj = GetCommandSP (cmd_cstr, true, true, matches).get();
598 }
599
600 // Finally, if there wasn't an exact match among the aliases, look for an inexact match
601 // in both the commands and the aliases.
602
603 if (command_obj == NULL)
604 command_obj = GetCommandSP(cmd_cstr, true, false, matches).get();
605
606 return command_obj;
Chris Lattner24943d22010-06-08 16:52:24 +0000607}
608
609bool
610CommandInterpreter::CommandExists (const char *cmd)
611{
612 return m_command_dict.find(cmd) != m_command_dict.end();
613}
614
615bool
Caroline Tice5ddbe212011-05-06 21:37:15 +0000616CommandInterpreter::ProcessAliasOptionsArgs (lldb::CommandObjectSP &cmd_obj_sp,
617 const char *options_args,
618 OptionArgVectorSP &option_arg_vector_sp)
619{
620 bool success = true;
621 OptionArgVector *option_arg_vector = option_arg_vector_sp.get();
622
623 if (!options_args || (strlen (options_args) < 1))
624 return true;
625
626 std::string options_string (options_args);
627 Args args (options_args);
628 CommandReturnObject result;
629 // Check to see if the command being aliased can take any command options.
630 Options *options = cmd_obj_sp->GetOptions ();
631 if (options)
632 {
633 // See if any options were specified as part of the alias; if so, handle them appropriately.
634 options->NotifyOptionParsingStarting ();
635 args.Unshift ("dummy_arg");
636 args.ParseAliasOptions (*options, result, option_arg_vector, options_string);
637 args.Shift ();
638 if (result.Succeeded())
639 options->VerifyPartialOptions (result);
640 if (!result.Succeeded() && result.GetStatus() != lldb::eReturnStatusStarted)
641 {
642 result.AppendError ("Unable to create requested alias.\n");
643 return false;
644 }
645 }
646
Greg Clayton7268b4c2011-10-28 21:38:01 +0000647 if (!options_string.empty())
Caroline Tice5ddbe212011-05-06 21:37:15 +0000648 {
649 if (cmd_obj_sp->WantsRawCommandString ())
650 option_arg_vector->push_back (OptionArgPair ("<argument>",
651 OptionArgValue (-1,
652 options_string)));
653 else
654 {
655 int argc = args.GetArgumentCount();
656 for (size_t i = 0; i < argc; ++i)
657 if (strcmp (args.GetArgumentAtIndex (i), "") != 0)
658 option_arg_vector->push_back
659 (OptionArgPair ("<argument>",
660 OptionArgValue (-1,
661 std::string (args.GetArgumentAtIndex (i)))));
662 }
663 }
664
665 return success;
666}
667
668bool
Chris Lattner24943d22010-06-08 16:52:24 +0000669CommandInterpreter::AliasExists (const char *cmd)
670{
671 return m_alias_dict.find(cmd) != m_alias_dict.end();
672}
673
674bool
675CommandInterpreter::UserCommandExists (const char *cmd)
676{
677 return m_user_dict.find(cmd) != m_user_dict.end();
678}
679
680void
681CommandInterpreter::AddAlias (const char *alias_name, CommandObjectSP& command_obj_sp)
682{
Jim Inghamd40f8a62010-07-06 22:46:59 +0000683 command_obj_sp->SetIsAlias (true);
Chris Lattner24943d22010-06-08 16:52:24 +0000684 m_alias_dict[alias_name] = command_obj_sp;
685}
686
687bool
688CommandInterpreter::RemoveAlias (const char *alias_name)
689{
690 CommandObject::CommandMap::iterator pos = m_alias_dict.find(alias_name);
691 if (pos != m_alias_dict.end())
692 {
693 m_alias_dict.erase(pos);
694 return true;
695 }
696 return false;
697}
698bool
699CommandInterpreter::RemoveUser (const char *alias_name)
700{
701 CommandObject::CommandMap::iterator pos = m_user_dict.find(alias_name);
702 if (pos != m_user_dict.end())
703 {
704 m_user_dict.erase(pos);
705 return true;
706 }
707 return false;
708}
709
Chris Lattner24943d22010-06-08 16:52:24 +0000710void
711CommandInterpreter::GetAliasHelp (const char *alias_name, const char *command_name, StreamString &help_string)
712{
713 help_string.Printf ("'%s", command_name);
714 OptionArgVectorSP option_arg_vector_sp = GetAliasOptions (alias_name);
715
716 if (option_arg_vector_sp != NULL)
717 {
718 OptionArgVector *options = option_arg_vector_sp.get();
719 for (int i = 0; i < options->size(); ++i)
720 {
721 OptionArgPair cur_option = (*options)[i];
722 std::string opt = cur_option.first;
Caroline Tice44c841d2010-12-07 19:58:26 +0000723 OptionArgValue value_pair = cur_option.second;
724 std::string value = value_pair.second;
Chris Lattner24943d22010-06-08 16:52:24 +0000725 if (opt.compare("<argument>") == 0)
726 {
727 help_string.Printf (" %s", value.c_str());
728 }
729 else
730 {
731 help_string.Printf (" %s", opt.c_str());
732 if ((value.compare ("<no-argument>") != 0)
733 && (value.compare ("<need-argument") != 0))
734 {
735 help_string.Printf (" %s", value.c_str());
736 }
737 }
738 }
739 }
740
741 help_string.Printf ("'");
742}
743
Greg Clayton65124ea2010-08-26 22:05:43 +0000744size_t
Chris Lattner24943d22010-06-08 16:52:24 +0000745CommandInterpreter::FindLongestCommandWord (CommandObject::CommandMap &dict)
746{
747 CommandObject::CommandMap::const_iterator pos;
Greg Clayton65124ea2010-08-26 22:05:43 +0000748 CommandObject::CommandMap::const_iterator end = dict.end();
749 size_t max_len = 0;
Chris Lattner24943d22010-06-08 16:52:24 +0000750
Greg Clayton65124ea2010-08-26 22:05:43 +0000751 for (pos = dict.begin(); pos != end; ++pos)
752 {
753 size_t len = pos->first.size();
754 if (max_len < len)
755 max_len = len;
Chris Lattner24943d22010-06-08 16:52:24 +0000756 }
Greg Clayton65124ea2010-08-26 22:05:43 +0000757 return max_len;
Chris Lattner24943d22010-06-08 16:52:24 +0000758}
759
760void
Enrico Granata6b1596d2011-08-16 23:24:13 +0000761CommandInterpreter::GetHelp (CommandReturnObject &result,
Enrico Granata1ac6d1f2011-09-09 17:49:36 +0000762 uint32_t cmd_types)
Chris Lattner24943d22010-06-08 16:52:24 +0000763{
764 CommandObject::CommandMap::const_iterator pos;
Greg Clayton65124ea2010-08-26 22:05:43 +0000765 uint32_t max_len = FindLongestCommandWord (m_command_dict);
Enrico Granata6b1596d2011-08-16 23:24:13 +0000766
767 if ( (cmd_types & eCommandTypesBuiltin) == eCommandTypesBuiltin )
Chris Lattner24943d22010-06-08 16:52:24 +0000768 {
Enrico Granata6b1596d2011-08-16 23:24:13 +0000769
770 result.AppendMessage("The following is a list of built-in, permanent debugger commands:");
771 result.AppendMessage("");
Chris Lattner24943d22010-06-08 16:52:24 +0000772
Enrico Granata6b1596d2011-08-16 23:24:13 +0000773 for (pos = m_command_dict.begin(); pos != m_command_dict.end(); ++pos)
774 {
775 OutputFormattedHelpText (result.GetOutputStream(), pos->first.c_str(), "--", pos->second->GetHelp(),
776 max_len);
777 }
778 result.AppendMessage("");
779
780 }
781
Greg Clayton7268b4c2011-10-28 21:38:01 +0000782 if (!m_alias_dict.empty() && ( (cmd_types & eCommandTypesAliases) == eCommandTypesAliases ))
Chris Lattner24943d22010-06-08 16:52:24 +0000783 {
Jim Inghame3663e82010-10-22 18:47:16 +0000784 result.AppendMessage("The following is a list of your current command abbreviations "
Johnny Chen9e4c3d72011-04-21 00:39:18 +0000785 "(see 'help command alias' for more info):");
Chris Lattner24943d22010-06-08 16:52:24 +0000786 result.AppendMessage("");
Greg Clayton65124ea2010-08-26 22:05:43 +0000787 max_len = FindLongestCommandWord (m_alias_dict);
788
Chris Lattner24943d22010-06-08 16:52:24 +0000789 for (pos = m_alias_dict.begin(); pos != m_alias_dict.end(); ++pos)
790 {
791 StreamString sstr;
792 StreamString translation_and_help;
793 std::string entry_name = pos->first;
794 std::string second_entry = pos->second.get()->GetCommandName();
795 GetAliasHelp (pos->first.c_str(), pos->second->GetCommandName(), sstr);
796
797 translation_and_help.Printf ("(%s) %s", sstr.GetData(), pos->second->GetHelp());
798 OutputFormattedHelpText (result.GetOutputStream(), pos->first.c_str(), "--",
799 translation_and_help.GetData(), max_len);
800 }
801 result.AppendMessage("");
802 }
803
Greg Clayton7268b4c2011-10-28 21:38:01 +0000804 if (!m_user_dict.empty() && ( (cmd_types & eCommandTypesUserDef) == eCommandTypesUserDef ))
Chris Lattner24943d22010-06-08 16:52:24 +0000805 {
806 result.AppendMessage ("The following is a list of your current user-defined commands:");
807 result.AppendMessage("");
Enrico Granata6b1596d2011-08-16 23:24:13 +0000808 max_len = FindLongestCommandWord (m_user_dict);
Chris Lattner24943d22010-06-08 16:52:24 +0000809 for (pos = m_user_dict.begin(); pos != m_user_dict.end(); ++pos)
810 {
Enrico Granata6b1596d2011-08-16 23:24:13 +0000811 OutputFormattedHelpText (result.GetOutputStream(), pos->first.c_str(), "--", pos->second->GetHelp(),
812 max_len);
Chris Lattner24943d22010-06-08 16:52:24 +0000813 }
814 result.AppendMessage("");
815 }
816
817 result.AppendMessage("For more information on any particular command, try 'help <command-name>'.");
818}
819
Caroline Ticee0da7a52010-12-09 22:52:49 +0000820CommandObject *
821CommandInterpreter::GetCommandObjectForCommand (std::string &command_string)
Chris Lattner24943d22010-06-08 16:52:24 +0000822{
Caroline Ticee0da7a52010-12-09 22:52:49 +0000823 // This function finds the final, lowest-level, alias-resolved command object whose 'Execute' function will
824 // eventually be invoked by the given command line.
825
826 CommandObject *cmd_obj = NULL;
827 std::string white_space (" \t\v");
828 size_t start = command_string.find_first_not_of (white_space);
829 size_t end = 0;
830 bool done = false;
831 while (!done)
832 {
833 if (start != std::string::npos)
834 {
835 // Get the next word from command_string.
836 end = command_string.find_first_of (white_space, start);
837 if (end == std::string::npos)
838 end = command_string.size();
839 std::string cmd_word = command_string.substr (start, end - start);
840
841 if (cmd_obj == NULL)
842 // Since cmd_obj is NULL we are on our first time through this loop. Check to see if cmd_word is a valid
843 // command or alias.
844 cmd_obj = GetCommandObject (cmd_word.c_str());
845 else if (cmd_obj->IsMultiwordObject ())
846 {
847 // Our current object is a multi-word object; see if the cmd_word is a valid sub-command for our object.
848 CommandObject *sub_cmd_obj =
849 ((CommandObjectMultiword *) cmd_obj)->GetSubcommandObject (cmd_word.c_str());
850 if (sub_cmd_obj)
851 cmd_obj = sub_cmd_obj;
852 else // cmd_word was not a valid sub-command word, so we are donee
853 done = true;
854 }
855 else
856 // We have a cmd_obj and it is not a multi-word object, so we are done.
857 done = true;
Chris Lattner24943d22010-06-08 16:52:24 +0000858
Caroline Ticee0da7a52010-12-09 22:52:49 +0000859 // If we didn't find a valid command object, or our command object is not a multi-word object, or
860 // we are at the end of the command_string, then we are done. Otherwise, find the start of the
861 // next word.
862
863 if (!cmd_obj || !cmd_obj->IsMultiwordObject() || end >= command_string.size())
864 done = true;
865 else
866 start = command_string.find_first_not_of (white_space, end);
867 }
868 else
869 // Unable to find any more words.
870 done = true;
871 }
872
873 if (end == command_string.size())
874 command_string.clear();
875 else
876 command_string = command_string.substr(end);
877
878 return cmd_obj;
879}
880
Greg Clayton9d855c62011-10-25 00:36:27 +0000881static const char *k_white_space = " \t\v";
Greg Clayton7268b4c2011-10-28 21:38:01 +0000882static const char *k_valid_command_chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
Greg Clayton9d855c62011-10-25 00:36:27 +0000883static void
884StripLeadingSpaces (std::string &s)
Caroline Ticee0da7a52010-12-09 22:52:49 +0000885{
Greg Clayton9d855c62011-10-25 00:36:27 +0000886 if (!s.empty())
Caroline Ticee0da7a52010-12-09 22:52:49 +0000887 {
Greg Clayton9d855c62011-10-25 00:36:27 +0000888 size_t pos = s.find_first_not_of (k_white_space);
889 if (pos == std::string::npos)
890 s.clear();
891 else if (pos == 0)
892 return;
893 s.erase (0, pos);
894 }
895}
896
897static bool
Greg Clayton7268b4c2011-10-28 21:38:01 +0000898ExtractCommand (std::string &command_string, std::string &command, std::string &suffix, char &quote_char)
Greg Clayton9d855c62011-10-25 00:36:27 +0000899{
Greg Clayton7268b4c2011-10-28 21:38:01 +0000900 command.clear();
901 suffix.clear();
Greg Clayton9d855c62011-10-25 00:36:27 +0000902 StripLeadingSpaces (command_string);
903
904 bool result = false;
905 quote_char = '\0';
906
907 if (!command_string.empty())
908 {
909 const char first_char = command_string[0];
910 if (first_char == '\'' || first_char == '"')
Caroline Ticee0da7a52010-12-09 22:52:49 +0000911 {
Greg Clayton9d855c62011-10-25 00:36:27 +0000912 quote_char = first_char;
913 const size_t end_quote_pos = command_string.find (quote_char, 1);
914 if (end_quote_pos == std::string::npos)
Caroline Tice649116c2011-05-11 16:07:06 +0000915 {
Greg Clayton7268b4c2011-10-28 21:38:01 +0000916 command.swap (command_string);
Greg Clayton9d855c62011-10-25 00:36:27 +0000917 command_string.erase ();
Caroline Tice649116c2011-05-11 16:07:06 +0000918 }
919 else
920 {
Greg Clayton7268b4c2011-10-28 21:38:01 +0000921 command.assign (command_string, 1, end_quote_pos - 1);
Greg Clayton9d855c62011-10-25 00:36:27 +0000922 if (end_quote_pos + 1 < command_string.size())
923 command_string.erase (0, command_string.find_first_not_of (k_white_space, end_quote_pos + 1));
924 else
925 command_string.erase ();
Caroline Tice649116c2011-05-11 16:07:06 +0000926 }
Caroline Ticee0da7a52010-12-09 22:52:49 +0000927 }
928 else
929 {
Greg Clayton9d855c62011-10-25 00:36:27 +0000930 const size_t first_space_pos = command_string.find_first_of (k_white_space);
931 if (first_space_pos == std::string::npos)
Caroline Tice649116c2011-05-11 16:07:06 +0000932 {
Greg Clayton7268b4c2011-10-28 21:38:01 +0000933 command.swap (command_string);
Greg Clayton9d855c62011-10-25 00:36:27 +0000934 command_string.erase();
Caroline Tice649116c2011-05-11 16:07:06 +0000935 }
936 else
937 {
Greg Clayton7268b4c2011-10-28 21:38:01 +0000938 command.assign (command_string, 0, first_space_pos);
939 command_string.erase(0, command_string.find_first_not_of (k_white_space, first_space_pos));
Caroline Tice649116c2011-05-11 16:07:06 +0000940 }
Caroline Ticee0da7a52010-12-09 22:52:49 +0000941 }
Greg Clayton9d855c62011-10-25 00:36:27 +0000942 result = true;
Caroline Ticee0da7a52010-12-09 22:52:49 +0000943 }
Greg Clayton7268b4c2011-10-28 21:38:01 +0000944
945
946 if (!command.empty())
947 {
948 // actual commands can't start with '-' or '_'
949 if (command[0] != '-' && command[0] != '_')
950 {
951 size_t pos = command.find_first_not_of(k_valid_command_chars);
952 if (pos > 0 && pos != std::string::npos)
953 {
954 suffix.assign (command.begin() + pos, command.end());
955 command.erase (pos);
956 }
957 }
958 }
Greg Clayton9d855c62011-10-25 00:36:27 +0000959
960 return result;
Caroline Ticee0da7a52010-12-09 22:52:49 +0000961}
962
Greg Clayton7268b4c2011-10-28 21:38:01 +0000963CommandObject *
964CommandInterpreter::BuildAliasResult (const char *alias_name,
965 std::string &raw_input_string,
966 std::string &alias_result,
967 CommandReturnObject &result)
Caroline Ticee0da7a52010-12-09 22:52:49 +0000968{
Greg Clayton7268b4c2011-10-28 21:38:01 +0000969 CommandObject *alias_cmd_obj = NULL;
Caroline Ticee0da7a52010-12-09 22:52:49 +0000970 Args cmd_args (raw_input_string.c_str());
971 alias_cmd_obj = GetCommandObject (alias_name);
972 StreamString result_str;
973
974 if (alias_cmd_obj)
975 {
976 std::string alias_name_str = alias_name;
977 if ((cmd_args.GetArgumentCount() == 0)
978 || (alias_name_str.compare (cmd_args.GetArgumentAtIndex(0)) != 0))
979 cmd_args.Unshift (alias_name);
980
981 result_str.Printf ("%s", alias_cmd_obj->GetCommandName ());
982 OptionArgVectorSP option_arg_vector_sp = GetAliasOptions (alias_name);
983
984 if (option_arg_vector_sp.get())
985 {
986 OptionArgVector *option_arg_vector = option_arg_vector_sp.get();
987
988 for (int i = 0; i < option_arg_vector->size(); ++i)
989 {
990 OptionArgPair option_pair = (*option_arg_vector)[i];
991 OptionArgValue value_pair = option_pair.second;
992 int value_type = value_pair.first;
993 std::string option = option_pair.first;
994 std::string value = value_pair.second;
995 if (option.compare ("<argument>") == 0)
996 result_str.Printf (" %s", value.c_str());
997 else
998 {
999 result_str.Printf (" %s", option.c_str());
1000 if (value_type != optional_argument)
1001 result_str.Printf (" ");
1002 if (value.compare ("<no_argument>") != 0)
1003 {
1004 int index = GetOptionArgumentPosition (value.c_str());
1005 if (index == 0)
1006 result_str.Printf ("%s", value.c_str());
1007 else if (index >= cmd_args.GetArgumentCount())
1008 {
1009
1010 result.AppendErrorWithFormat
1011 ("Not enough arguments provided; you need at least %d arguments to use this alias.\n",
1012 index);
1013 result.SetStatus (eReturnStatusFailed);
Greg Clayton7268b4c2011-10-28 21:38:01 +00001014 return alias_cmd_obj;
Caroline Ticee0da7a52010-12-09 22:52:49 +00001015 }
1016 else
1017 {
1018 size_t strpos = raw_input_string.find (cmd_args.GetArgumentAtIndex (index));
1019 if (strpos != std::string::npos)
1020 raw_input_string = raw_input_string.erase (strpos,
1021 strlen (cmd_args.GetArgumentAtIndex (index)));
1022 result_str.Printf ("%s", cmd_args.GetArgumentAtIndex (index));
1023 }
1024 }
1025 }
1026 }
1027 }
1028
1029 alias_result = result_str.GetData();
1030 }
Greg Clayton7268b4c2011-10-28 21:38:01 +00001031 return alias_cmd_obj;
Caroline Ticee0da7a52010-12-09 22:52:49 +00001032}
1033
Greg Claytonf5c0c722011-10-14 07:41:33 +00001034Error
1035CommandInterpreter::PreprocessCommand (std::string &command)
1036{
1037 // The command preprocessor needs to do things to the command
1038 // line before any parsing of arguments or anything else is done.
1039 // The only current stuff that gets proprocessed is anyting enclosed
1040 // in backtick ('`') characters is evaluated as an expression and
1041 // the result of the expression must be a scalar that can be substituted
1042 // into the command. An example would be:
1043 // (lldb) memory read `$rsp + 20`
1044 Error error; // Error for any expressions that might not evaluate
1045 size_t start_backtick;
1046 size_t pos = 0;
1047 while ((start_backtick = command.find ('`', pos)) != std::string::npos)
1048 {
1049 if (start_backtick > 0 && command[start_backtick-1] == '\\')
1050 {
1051 // The backtick was preceeded by a '\' character, remove the slash
1052 // and don't treat the backtick as the start of an expression
1053 command.erase(start_backtick-1, 1);
1054 // No need to add one to start_backtick since we just deleted a char
1055 pos = start_backtick;
1056 }
1057 else
1058 {
1059 const size_t expr_content_start = start_backtick + 1;
1060 const size_t end_backtick = command.find ('`', expr_content_start);
1061 if (end_backtick == std::string::npos)
1062 return error;
1063 else if (end_backtick == expr_content_start)
1064 {
1065 // Empty expression (two backticks in a row)
1066 command.erase (start_backtick, 2);
1067 }
1068 else
1069 {
1070 std::string expr_str (command, expr_content_start, end_backtick - expr_content_start);
1071
1072 Target *target = m_exe_ctx.GetTargetPtr();
1073 if (target)
1074 {
1075 const bool unwind_on_error = true;
1076 const bool keep_in_memory = false;
1077 ValueObjectSP expr_result_valobj_sp;
1078 ExecutionResults expr_result = target->EvaluateExpression (expr_str.c_str(),
1079 m_exe_ctx.GetFramePtr(),
1080 eExecutionPolicyOnlyWhenNeeded,
1081 unwind_on_error, keep_in_memory,
1082 eNoDynamicValues,
1083 expr_result_valobj_sp);
1084 if (expr_result == eExecutionCompleted)
1085 {
1086 Scalar scalar;
1087 if (expr_result_valobj_sp->ResolveValue (scalar))
1088 {
1089 command.erase (start_backtick, end_backtick - start_backtick + 1);
1090 StreamString value_strm;
1091 const bool show_type = false;
1092 scalar.GetValue (&value_strm, show_type);
1093 size_t value_string_size = value_strm.GetSize();
1094 if (value_string_size)
1095 {
1096 command.insert (start_backtick, value_strm.GetData(), value_string_size);
1097 pos = start_backtick + value_string_size;
1098 continue;
1099 }
1100 else
1101 {
1102 error.SetErrorStringWithFormat("expression value didn't result in a scalar value for the expression '%s'", expr_str.c_str());
1103 }
1104 }
1105 else
1106 {
1107 error.SetErrorStringWithFormat("expression value didn't result in a scalar value for the expression '%s'", expr_str.c_str());
1108 }
1109 }
1110 else
1111 {
1112 if (expr_result_valobj_sp)
1113 error = expr_result_valobj_sp->GetError();
1114 if (error.Success())
1115 {
1116
1117 switch (expr_result)
1118 {
1119 case eExecutionSetupError:
1120 error.SetErrorStringWithFormat("expression setup error for the expression '%s'", expr_str.c_str());
1121 break;
1122 case eExecutionCompleted:
1123 break;
1124 case eExecutionDiscarded:
1125 error.SetErrorStringWithFormat("expression discarded for the expression '%s'", expr_str.c_str());
1126 break;
1127 case eExecutionInterrupted:
1128 error.SetErrorStringWithFormat("expression interrupted for the expression '%s'", expr_str.c_str());
1129 break;
1130 case eExecutionTimedOut:
1131 error.SetErrorStringWithFormat("expression timed out for the expression '%s'", expr_str.c_str());
1132 break;
1133 }
1134 }
1135 }
1136 }
1137 }
1138 if (error.Fail())
1139 break;
1140 }
1141 }
1142 return error;
1143}
1144
1145
Caroline Ticee0da7a52010-12-09 22:52:49 +00001146bool
1147CommandInterpreter::HandleCommand (const char *command_line,
1148 bool add_to_history,
1149 CommandReturnObject &result,
Jim Ingham949d5ac2011-02-18 00:54:25 +00001150 ExecutionContext *override_context,
Johnny Chen8bdf57c2011-10-05 00:42:59 +00001151 bool repeat_on_empty_command,
1152 bool no_context_switching)
Jim Ingham949d5ac2011-02-18 00:54:25 +00001153
Caroline Ticee0da7a52010-12-09 22:52:49 +00001154{
Jim Ingham949d5ac2011-02-18 00:54:25 +00001155
Caroline Ticee0da7a52010-12-09 22:52:49 +00001156 bool done = false;
1157 CommandObject *cmd_obj = NULL;
Caroline Ticee0da7a52010-12-09 22:52:49 +00001158 bool wants_raw_input = false;
1159 std::string command_string (command_line);
Jim Ingham6247dbe2011-07-12 03:12:18 +00001160 std::string original_command_string (command_line);
Caroline Ticee0da7a52010-12-09 22:52:49 +00001161
1162 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_COMMANDS));
Greg Claytone98ac252010-11-10 04:57:04 +00001163 Host::SetCrashDescriptionWithFormat ("HandleCommand(command = \"%s\")", command_line);
1164
1165 // Make a scoped cleanup object that will clear the crash description string
1166 // on exit of this function.
Enrico Granata1a102082011-07-12 00:18:11 +00001167 lldb_utility::CleanUp <const char *> crash_description_cleanup(NULL, Host::SetCrashDescription);
Greg Claytone98ac252010-11-10 04:57:04 +00001168
Caroline Ticee0da7a52010-12-09 22:52:49 +00001169 if (log)
1170 log->Printf ("Processing command: %s", command_line);
Chris Lattner24943d22010-06-08 16:52:24 +00001171
Jim Inghamabab14b2010-11-04 23:08:45 +00001172 Timer scoped_timer (__PRETTY_FUNCTION__, "Handling command: %s.", command_line);
1173
Johnny Chen8bdf57c2011-10-05 00:42:59 +00001174 if (!no_context_switching)
1175 UpdateExecutionContext (override_context);
Chris Lattner24943d22010-06-08 16:52:24 +00001176
Jim Ingham949d5ac2011-02-18 00:54:25 +00001177 bool empty_command = false;
1178 bool comment_command = false;
1179 if (command_string.empty())
1180 empty_command = true;
1181 else
Chris Lattner24943d22010-06-08 16:52:24 +00001182 {
Jim Ingham949d5ac2011-02-18 00:54:25 +00001183 const char *k_space_characters = "\t\n\v\f\r ";
1184
1185 size_t non_space = command_string.find_first_not_of (k_space_characters);
1186 // Check for empty line or comment line (lines whose first
1187 // non-space character is the comment character for this interpreter)
1188 if (non_space == std::string::npos)
1189 empty_command = true;
1190 else if (command_string[non_space] == m_comment_char)
1191 comment_command = true;
Jim Ingham6247dbe2011-07-12 03:12:18 +00001192 else if (command_string[non_space] == m_repeat_char)
1193 {
1194 const char *history_string = FindHistoryString (command_string.c_str() + non_space);
1195 if (history_string == NULL)
1196 {
1197 result.AppendErrorWithFormat ("Could not find entry: %s in history", command_string.c_str());
1198 result.SetStatus(eReturnStatusFailed);
1199 return false;
1200 }
1201 add_to_history = false;
1202 command_string = history_string;
1203 original_command_string = history_string;
1204 }
Jim Ingham949d5ac2011-02-18 00:54:25 +00001205 }
1206
1207 if (empty_command)
1208 {
1209 if (repeat_on_empty_command)
Chris Lattner24943d22010-06-08 16:52:24 +00001210 {
Jim Ingham949d5ac2011-02-18 00:54:25 +00001211 if (m_command_history.empty())
1212 {
1213 result.AppendError ("empty command");
1214 result.SetStatus(eReturnStatusFailed);
1215 return false;
1216 }
1217 else
1218 {
1219 command_line = m_repeat_command.c_str();
1220 command_string = command_line;
Jim Ingham6247dbe2011-07-12 03:12:18 +00001221 original_command_string = command_line;
Jim Ingham949d5ac2011-02-18 00:54:25 +00001222 if (m_repeat_command.empty())
1223 {
1224 result.AppendErrorWithFormat("No auto repeat.\n");
1225 result.SetStatus (eReturnStatusFailed);
1226 return false;
1227 }
1228 }
1229 add_to_history = false;
Chris Lattner24943d22010-06-08 16:52:24 +00001230 }
1231 else
1232 {
Jim Ingham949d5ac2011-02-18 00:54:25 +00001233 result.SetStatus (eReturnStatusSuccessFinishNoResult);
1234 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00001235 }
Jim Ingham949d5ac2011-02-18 00:54:25 +00001236 }
1237 else if (comment_command)
1238 {
1239 result.SetStatus (eReturnStatusSuccessFinishNoResult);
1240 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00001241 }
Caroline Tice649116c2011-05-11 16:07:06 +00001242
Greg Claytonf5c0c722011-10-14 07:41:33 +00001243
1244 Error error (PreprocessCommand (command_string));
1245
1246 if (error.Fail())
1247 {
1248 result.AppendError (error.AsCString());
1249 result.SetStatus(eReturnStatusFailed);
1250 return false;
1251 }
Caroline Ticee0da7a52010-12-09 22:52:49 +00001252 // Phase 1.
1253
1254 // Before we do ANY kind of argument processing, etc. we need to figure out what the real/final command object
1255 // is for the specified command, and whether or not it wants raw input. This gets complicated by the fact that
1256 // the user could have specified an alias, and in translating the alias there may also be command options and/or
1257 // even data (including raw text strings) that need to be found and inserted into the command line as part of
1258 // the translation. So this first step is plain look-up & replacement, resulting in three things: 1). the command
Greg Clayton5d187e52011-01-08 20:28:42 +00001259 // object whose Execute method will actually be called; 2). a revised command string, with all substitutions &
Caroline Ticee0da7a52010-12-09 22:52:49 +00001260 // replacements taken care of; 3). whether or not the Execute function wants raw input or not.
Caroline Tice44c841d2010-12-07 19:58:26 +00001261
Caroline Ticee0da7a52010-12-09 22:52:49 +00001262 StreamString revised_command_line;
Caroline Ticeea6e3df2010-12-11 08:16:56 +00001263 size_t actual_cmd_name_len = 0;
Greg Clayton7268b4c2011-10-28 21:38:01 +00001264 std::string next_word;
Caroline Ticee0da7a52010-12-09 22:52:49 +00001265 while (!done)
Chris Lattner24943d22010-06-08 16:52:24 +00001266 {
Caroline Tice649116c2011-05-11 16:07:06 +00001267 char quote_char = '\0';
Greg Clayton7268b4c2011-10-28 21:38:01 +00001268 std::string suffix;
1269 ExtractCommand (command_string, next_word, suffix, quote_char);
1270 if (cmd_obj == NULL)
Chris Lattner24943d22010-06-08 16:52:24 +00001271 {
Greg Clayton7268b4c2011-10-28 21:38:01 +00001272 if (AliasExists (next_word.c_str()))
Caroline Tice56d2fc42010-12-14 18:51:39 +00001273 {
Greg Clayton7268b4c2011-10-28 21:38:01 +00001274 std::string alias_result;
1275 cmd_obj = BuildAliasResult (next_word.c_str(), command_string, alias_result, result);
1276 revised_command_line.Printf ("%s", alias_result.c_str());
1277 if (cmd_obj)
1278 {
1279 wants_raw_input = cmd_obj->WantsRawCommandString ();
1280 actual_cmd_name_len = strlen (cmd_obj->GetCommandName());
1281 }
Chris Lattner24943d22010-06-08 16:52:24 +00001282 }
1283 else
1284 {
Greg Clayton7268b4c2011-10-28 21:38:01 +00001285 cmd_obj = GetCommandObject (next_word.c_str());
1286 if (cmd_obj)
1287 {
1288 actual_cmd_name_len += next_word.length();
1289 revised_command_line.Printf ("%s", next_word.c_str());
1290 wants_raw_input = cmd_obj->WantsRawCommandString ();
1291 }
Caroline Tice649116c2011-05-11 16:07:06 +00001292 else
Greg Clayton7268b4c2011-10-28 21:38:01 +00001293 {
1294 revised_command_line.Printf ("%s", next_word.c_str());
1295 }
Caroline Ticee0da7a52010-12-09 22:52:49 +00001296 }
1297 }
1298 else
1299 {
Greg Clayton7268b4c2011-10-28 21:38:01 +00001300 if (cmd_obj->IsMultiwordObject ())
1301 {
1302 CommandObject *sub_cmd_obj = ((CommandObjectMultiword *) cmd_obj)->GetSubcommandObject (next_word.c_str());
1303 if (sub_cmd_obj)
1304 {
1305 actual_cmd_name_len += next_word.length() + 1;
1306 revised_command_line.Printf (" %s", next_word.c_str());
1307 cmd_obj = sub_cmd_obj;
1308 wants_raw_input = cmd_obj->WantsRawCommandString ();
1309 }
1310 else
1311 {
1312 if (quote_char)
1313 revised_command_line.Printf (" %c%s%s%c", quote_char, next_word.c_str(), suffix.c_str(), quote_char);
1314 else
1315 revised_command_line.Printf (" %s%s", next_word.c_str(), suffix.c_str());
1316 done = true;
1317 }
1318 }
Caroline Tice649116c2011-05-11 16:07:06 +00001319 else
Greg Clayton7268b4c2011-10-28 21:38:01 +00001320 {
1321 if (quote_char)
1322 revised_command_line.Printf (" %c%s%s%c", quote_char, next_word.c_str(), suffix.c_str(), quote_char);
1323 else
1324 revised_command_line.Printf (" %s%s", next_word.c_str(), suffix.c_str());
1325 done = true;
1326 }
Caroline Ticee0da7a52010-12-09 22:52:49 +00001327 }
1328
1329 if (cmd_obj == NULL)
1330 {
1331 result.AppendErrorWithFormat ("'%s' is not a valid command.\n", next_word.c_str());
1332 result.SetStatus (eReturnStatusFailed);
1333 return false;
1334 }
1335
Greg Clayton7268b4c2011-10-28 21:38:01 +00001336 if (cmd_obj->IsMultiwordObject ())
1337 {
1338 if (!suffix.empty())
1339 {
1340
1341 result.AppendErrorWithFormat ("multi-word commands ('%s') can't have shorthand suffixes: '%s'\n",
1342 next_word.c_str(),
1343 suffix.c_str());
1344 result.SetStatus (eReturnStatusFailed);
1345 return false;
1346 }
1347 }
1348 else
1349 {
1350 // If we found a normal command, we are done
1351 done = true;
1352 if (!suffix.empty())
1353 {
1354 switch (suffix[0])
1355 {
1356 case '/':
1357 // GDB format suffixes
1358 revised_command_line.Printf (" --gdb-format=%s", suffix.c_str() + 1);
1359 break;
1360 }
1361 }
1362 }
Caroline Ticee0da7a52010-12-09 22:52:49 +00001363 if (command_string.length() == 0)
1364 done = true;
1365
Chris Lattner24943d22010-06-08 16:52:24 +00001366 }
Caroline Ticee0da7a52010-12-09 22:52:49 +00001367
Greg Clayton7268b4c2011-10-28 21:38:01 +00001368 if (!command_string.empty())
Caroline Ticee0da7a52010-12-09 22:52:49 +00001369 revised_command_line.Printf (" %s", command_string.c_str());
1370
1371 // End of Phase 1.
1372 // At this point cmd_obj should contain the CommandObject whose Execute method will be called, if the command
1373 // specified was valid; revised_command_line contains the complete command line (including command name(s)),
1374 // fully translated with all substitutions & translations taken care of (still in raw text format); and
1375 // wants_raw_input specifies whether the Execute method expects raw input or not.
1376
1377
1378 if (log)
1379 {
1380 log->Printf ("HandleCommand, cmd_obj : '%s'", cmd_obj ? cmd_obj->GetCommandName() : "<not found>");
1381 log->Printf ("HandleCommand, revised_command_line: '%s'", revised_command_line.GetData());
1382 log->Printf ("HandleCommand, wants_raw_input:'%s'", wants_raw_input ? "True" : "False");
1383 }
1384
1385 // Phase 2.
1386 // Take care of things like setting up the history command & calling the appropriate Execute method on the
1387 // CommandObject, with the appropriate arguments.
1388
1389 if (cmd_obj != NULL)
1390 {
1391 if (add_to_history)
1392 {
1393 Args command_args (revised_command_line.GetData());
1394 const char *repeat_command = cmd_obj->GetRepeatCommand(command_args, 0);
1395 if (repeat_command != NULL)
1396 m_repeat_command.assign(repeat_command);
1397 else
Jim Ingham6247dbe2011-07-12 03:12:18 +00001398 m_repeat_command.assign(original_command_string.c_str());
Caroline Ticee0da7a52010-12-09 22:52:49 +00001399
Jim Ingham6247dbe2011-07-12 03:12:18 +00001400 // Don't keep pushing the same command onto the history...
Greg Clayton7268b4c2011-10-28 21:38:01 +00001401 if (m_command_history.empty() || m_command_history.back() != original_command_string)
Jim Ingham6247dbe2011-07-12 03:12:18 +00001402 m_command_history.push_back (original_command_string);
Caroline Ticee0da7a52010-12-09 22:52:49 +00001403 }
1404
1405 command_string = revised_command_line.GetData();
1406 std::string command_name (cmd_obj->GetCommandName());
Caroline Ticeea6e3df2010-12-11 08:16:56 +00001407 std::string remainder;
1408 if (actual_cmd_name_len < command_string.length())
1409 remainder = command_string.substr (actual_cmd_name_len); // Note: 'actual_cmd_name_len' may be considerably shorter
1410 // than cmd_obj->GetCommandName(), because name completion
1411 // allows users to enter short versions of the names,
1412 // e.g. 'br s' for 'breakpoint set'.
Caroline Ticee0da7a52010-12-09 22:52:49 +00001413
1414 // Remove any initial spaces
1415 std::string white_space (" \t\v");
1416 size_t pos = remainder.find_first_not_of (white_space);
1417 if (pos != 0 && pos != std::string::npos)
Greg Clayton91c9dcf2011-04-22 20:58:45 +00001418 remainder.erase(0, pos);
Caroline Ticee0da7a52010-12-09 22:52:49 +00001419
1420 if (log)
Jason Molenda24c991c2011-08-25 00:20:04 +00001421 log->Printf ("HandleCommand, command line after removing command name(s): '%s'", remainder.c_str());
Caroline Ticee0da7a52010-12-09 22:52:49 +00001422
1423
1424 if (wants_raw_input)
1425 cmd_obj->ExecuteRawCommandString (remainder.c_str(), result);
1426 else
1427 {
1428 Args cmd_args (remainder.c_str());
1429 cmd_obj->ExecuteWithOptions (cmd_args, result);
1430 }
1431 }
1432 else
1433 {
1434 // We didn't find the first command object, so complete the first argument.
1435 Args command_args (revised_command_line.GetData());
1436 StringList matches;
1437 int num_matches;
1438 int cursor_index = 0;
1439 int cursor_char_position = strlen (command_args.GetArgumentAtIndex(0));
1440 bool word_complete;
1441 num_matches = HandleCompletionMatches (command_args,
1442 cursor_index,
1443 cursor_char_position,
1444 0,
1445 -1,
1446 word_complete,
1447 matches);
1448
1449 if (num_matches > 0)
1450 {
1451 std::string error_msg;
1452 error_msg.assign ("ambiguous command '");
1453 error_msg.append(command_args.GetArgumentAtIndex(0));
1454 error_msg.append ("'.");
1455
1456 error_msg.append (" Possible completions:");
1457 for (int i = 0; i < num_matches; i++)
1458 {
1459 error_msg.append ("\n\t");
1460 error_msg.append (matches.GetStringAtIndex (i));
1461 }
1462 error_msg.append ("\n");
1463 result.AppendRawError (error_msg.c_str(), error_msg.size());
1464 }
1465 else
1466 result.AppendErrorWithFormat ("Unrecognized command '%s'.\n", command_args.GetArgumentAtIndex (0));
1467
1468 result.SetStatus (eReturnStatusFailed);
1469 }
1470
Jason Molenda24c991c2011-08-25 00:20:04 +00001471 if (log)
1472 log->Printf ("HandleCommand, command %s", (result.Succeeded() ? "succeeded" : "did not succeed"));
1473
Chris Lattner24943d22010-06-08 16:52:24 +00001474 return result.Succeeded();
1475}
1476
1477int
1478CommandInterpreter::HandleCompletionMatches (Args &parsed_line,
1479 int &cursor_index,
1480 int &cursor_char_position,
1481 int match_start_point,
1482 int max_return_elements,
Jim Ingham802f8b02010-06-30 05:02:46 +00001483 bool &word_complete,
Chris Lattner24943d22010-06-08 16:52:24 +00001484 StringList &matches)
1485{
1486 int num_command_matches = 0;
Chris Lattner24943d22010-06-08 16:52:24 +00001487 bool look_for_subcommand = false;
Jim Ingham802f8b02010-06-30 05:02:46 +00001488
1489 // For any of the command completions a unique match will be a complete word.
1490 word_complete = true;
Chris Lattner24943d22010-06-08 16:52:24 +00001491
1492 if (cursor_index == -1)
1493 {
1494 // We got nothing on the command line, so return the list of commands
Jim Inghamd40f8a62010-07-06 22:46:59 +00001495 bool include_aliases = true;
Chris Lattner24943d22010-06-08 16:52:24 +00001496 num_command_matches = GetCommandNamesMatchingPartialString ("", include_aliases, matches);
1497 }
1498 else if (cursor_index == 0)
1499 {
1500 // The cursor is in the first argument, so just do a lookup in the dictionary.
Jim Inghamd40f8a62010-07-06 22:46:59 +00001501 CommandObject *cmd_obj = GetCommandObject (parsed_line.GetArgumentAtIndex(0), &matches);
Chris Lattner24943d22010-06-08 16:52:24 +00001502 num_command_matches = matches.GetSize();
1503
1504 if (num_command_matches == 1
1505 && cmd_obj && cmd_obj->IsMultiwordObject()
1506 && matches.GetStringAtIndex(0) != NULL
1507 && strcmp (parsed_line.GetArgumentAtIndex(0), matches.GetStringAtIndex(0)) == 0)
1508 {
1509 look_for_subcommand = true;
1510 num_command_matches = 0;
1511 matches.DeleteStringAtIndex(0);
1512 parsed_line.AppendArgument ("");
1513 cursor_index++;
1514 cursor_char_position = 0;
1515 }
1516 }
1517
1518 if (cursor_index > 0 || look_for_subcommand)
1519 {
1520 // We are completing further on into a commands arguments, so find the command and tell it
1521 // to complete the command.
1522 // First see if there is a matching initial command:
Jim Inghamd40f8a62010-07-06 22:46:59 +00001523 CommandObject *command_object = GetCommandObject (parsed_line.GetArgumentAtIndex(0));
Chris Lattner24943d22010-06-08 16:52:24 +00001524 if (command_object == NULL)
1525 {
1526 return 0;
1527 }
1528 else
1529 {
1530 parsed_line.Shift();
1531 cursor_index--;
Greg Clayton238c0a12010-09-18 01:14:36 +00001532 num_command_matches = command_object->HandleCompletion (parsed_line,
Greg Clayton63094e02010-06-23 01:19:29 +00001533 cursor_index,
1534 cursor_char_position,
1535 match_start_point,
Jim Ingham802f8b02010-06-30 05:02:46 +00001536 max_return_elements,
1537 word_complete,
Chris Lattner24943d22010-06-08 16:52:24 +00001538 matches);
1539 }
1540 }
1541
1542 return num_command_matches;
1543
1544}
1545
1546int
1547CommandInterpreter::HandleCompletion (const char *current_line,
1548 const char *cursor,
1549 const char *last_char,
1550 int match_start_point,
1551 int max_return_elements,
1552 StringList &matches)
1553{
1554 // We parse the argument up to the cursor, so the last argument in parsed_line is
1555 // the one containing the cursor, and the cursor is after the last character.
1556
1557 Args parsed_line(current_line, last_char - current_line);
1558 Args partial_parsed_line(current_line, cursor - current_line);
1559
Jim Ingham6247dbe2011-07-12 03:12:18 +00001560 // Don't complete comments, and if the line we are completing is just the history repeat character,
1561 // substitute the appropriate history line.
1562 const char *first_arg = parsed_line.GetArgumentAtIndex(0);
1563 if (first_arg)
1564 {
1565 if (first_arg[0] == m_comment_char)
1566 return 0;
1567 else if (first_arg[0] == m_repeat_char)
1568 {
1569 const char *history_string = FindHistoryString (first_arg);
1570 if (history_string != NULL)
1571 {
1572 matches.Clear();
1573 matches.InsertStringAtIndex(0, history_string);
1574 return -2;
1575 }
1576 else
1577 return 0;
1578
1579 }
1580 }
1581
1582
Chris Lattner24943d22010-06-08 16:52:24 +00001583 int num_args = partial_parsed_line.GetArgumentCount();
1584 int cursor_index = partial_parsed_line.GetArgumentCount() - 1;
1585 int cursor_char_position;
1586
1587 if (cursor_index == -1)
1588 cursor_char_position = 0;
1589 else
1590 cursor_char_position = strlen (partial_parsed_line.GetArgumentAtIndex(cursor_index));
Jim Inghamcf037652010-12-14 19:56:01 +00001591
1592 if (cursor > current_line && cursor[-1] == ' ')
1593 {
1594 // We are just after a space. If we are in an argument, then we will continue
1595 // parsing, but if we are between arguments, then we have to complete whatever the next
1596 // element would be.
1597 // We can distinguish the two cases because if we are in an argument (e.g. because the space is
1598 // protected by a quote) then the space will also be in the parsed argument...
1599
1600 const char *current_elem = partial_parsed_line.GetArgumentAtIndex(cursor_index);
1601 if (cursor_char_position == 0 || current_elem[cursor_char_position - 1] != ' ')
1602 {
1603 parsed_line.InsertArgumentAtIndex(cursor_index + 1, "", '"');
1604 cursor_index++;
1605 cursor_char_position = 0;
1606 }
1607 }
Chris Lattner24943d22010-06-08 16:52:24 +00001608
1609 int num_command_matches;
1610
1611 matches.Clear();
1612
1613 // Only max_return_elements == -1 is supported at present:
1614 assert (max_return_elements == -1);
Jim Ingham802f8b02010-06-30 05:02:46 +00001615 bool word_complete;
Greg Clayton63094e02010-06-23 01:19:29 +00001616 num_command_matches = HandleCompletionMatches (parsed_line,
1617 cursor_index,
1618 cursor_char_position,
1619 match_start_point,
Jim Ingham802f8b02010-06-30 05:02:46 +00001620 max_return_elements,
1621 word_complete,
Greg Clayton63094e02010-06-23 01:19:29 +00001622 matches);
Chris Lattner24943d22010-06-08 16:52:24 +00001623
1624 if (num_command_matches <= 0)
1625 return num_command_matches;
1626
1627 if (num_args == 0)
1628 {
1629 // If we got an empty string, insert nothing.
1630 matches.InsertStringAtIndex(0, "");
1631 }
1632 else
1633 {
1634 // Now figure out if there is a common substring, and if so put that in element 0, otherwise
1635 // put an empty string in element 0.
1636 std::string command_partial_str;
1637 if (cursor_index >= 0)
Jim Inghame3663e82010-10-22 18:47:16 +00001638 command_partial_str.assign(parsed_line.GetArgumentAtIndex(cursor_index),
1639 parsed_line.GetArgumentAtIndex(cursor_index) + cursor_char_position);
Chris Lattner24943d22010-06-08 16:52:24 +00001640
1641 std::string common_prefix;
1642 matches.LongestCommonPrefix (common_prefix);
1643 int partial_name_len = command_partial_str.size();
1644
1645 // If we matched a unique single command, add a space...
Jim Ingham802f8b02010-06-30 05:02:46 +00001646 // Only do this if the completer told us this was a complete word, however...
1647 if (num_command_matches == 1 && word_complete)
Chris Lattner24943d22010-06-08 16:52:24 +00001648 {
1649 char quote_char = parsed_line.GetArgumentQuoteCharAtIndex(cursor_index);
1650 if (quote_char != '\0')
1651 common_prefix.push_back(quote_char);
1652
1653 common_prefix.push_back(' ');
1654 }
1655 common_prefix.erase (0, partial_name_len);
1656 matches.InsertStringAtIndex(0, common_prefix.c_str());
1657 }
1658 return num_command_matches;
1659}
1660
Chris Lattner24943d22010-06-08 16:52:24 +00001661
1662CommandInterpreter::~CommandInterpreter ()
1663{
1664}
1665
1666const char *
1667CommandInterpreter::GetPrompt ()
1668{
Caroline Tice5bc8c972010-09-20 20:44:43 +00001669 return m_debugger.GetPrompt();
Chris Lattner24943d22010-06-08 16:52:24 +00001670}
1671
1672void
1673CommandInterpreter::SetPrompt (const char *new_prompt)
1674{
Caroline Tice5bc8c972010-09-20 20:44:43 +00001675 m_debugger.SetPrompt (new_prompt);
Chris Lattner24943d22010-06-08 16:52:24 +00001676}
1677
Jim Ingham5e16ef52010-10-04 19:49:29 +00001678size_t
Greg Clayton58928562011-02-09 01:08:52 +00001679CommandInterpreter::GetConfirmationInputReaderCallback
1680(
1681 void *baton,
1682 InputReader &reader,
1683 lldb::InputReaderAction action,
1684 const char *bytes,
1685 size_t bytes_len
1686)
Jim Ingham5e16ef52010-10-04 19:49:29 +00001687{
Greg Clayton58928562011-02-09 01:08:52 +00001688 File &out_file = reader.GetDebugger().GetOutputFile();
Jim Ingham5e16ef52010-10-04 19:49:29 +00001689 bool *response_ptr = (bool *) baton;
1690
1691 switch (action)
1692 {
1693 case eInputReaderActivate:
Greg Clayton58928562011-02-09 01:08:52 +00001694 if (out_file.IsValid())
Jim Ingham5e16ef52010-10-04 19:49:29 +00001695 {
1696 if (reader.GetPrompt())
Caroline Tice22a60092011-02-02 01:17:56 +00001697 {
Greg Clayton58928562011-02-09 01:08:52 +00001698 out_file.Printf ("%s", reader.GetPrompt());
1699 out_file.Flush ();
Caroline Tice22a60092011-02-02 01:17:56 +00001700 }
Jim Ingham5e16ef52010-10-04 19:49:29 +00001701 }
1702 break;
1703
1704 case eInputReaderDeactivate:
1705 break;
1706
1707 case eInputReaderReactivate:
Greg Clayton58928562011-02-09 01:08:52 +00001708 if (out_file.IsValid() && reader.GetPrompt())
Caroline Tice22a60092011-02-02 01:17:56 +00001709 {
Greg Clayton58928562011-02-09 01:08:52 +00001710 out_file.Printf ("%s", reader.GetPrompt());
1711 out_file.Flush ();
Caroline Tice22a60092011-02-02 01:17:56 +00001712 }
Jim Ingham5e16ef52010-10-04 19:49:29 +00001713 break;
Caroline Tice4a348082011-05-02 20:41:46 +00001714
1715 case eInputReaderAsynchronousOutputWritten:
1716 break;
1717
Jim Ingham5e16ef52010-10-04 19:49:29 +00001718 case eInputReaderGotToken:
1719 if (bytes_len == 0)
1720 {
1721 reader.SetIsDone(true);
1722 }
1723 else if (bytes[0] == 'y')
1724 {
1725 *response_ptr = true;
1726 reader.SetIsDone(true);
1727 }
1728 else if (bytes[0] == 'n')
1729 {
1730 *response_ptr = false;
1731 reader.SetIsDone(true);
1732 }
1733 else
1734 {
Greg Clayton58928562011-02-09 01:08:52 +00001735 if (out_file.IsValid() && !reader.IsDone() && reader.GetPrompt())
Jim Ingham5e16ef52010-10-04 19:49:29 +00001736 {
Greg Clayton58928562011-02-09 01:08:52 +00001737 out_file.Printf ("Please answer \"y\" or \"n\"\n%s", reader.GetPrompt());
1738 out_file.Flush ();
Jim Ingham5e16ef52010-10-04 19:49:29 +00001739 }
1740 }
1741 break;
1742
Caroline Ticec4f55fe2010-11-19 20:47:54 +00001743 case eInputReaderInterrupt:
1744 case eInputReaderEndOfFile:
1745 *response_ptr = false; // Assume ^C or ^D means cancel the proposed action
1746 reader.SetIsDone (true);
1747 break;
1748
Jim Ingham5e16ef52010-10-04 19:49:29 +00001749 case eInputReaderDone:
1750 break;
1751 }
1752
1753 return bytes_len;
1754
1755}
1756
1757bool
1758CommandInterpreter::Confirm (const char *message, bool default_answer)
1759{
Jim Ingham93057472010-10-04 22:44:14 +00001760 // Check AutoConfirm first:
1761 if (m_debugger.GetAutoConfirm())
1762 return default_answer;
1763
Jim Ingham5e16ef52010-10-04 19:49:29 +00001764 InputReaderSP reader_sp (new InputReader(GetDebugger()));
1765 bool response = default_answer;
1766 if (reader_sp)
1767 {
1768 std::string prompt(message);
1769 prompt.append(": [");
1770 if (default_answer)
1771 prompt.append ("Y/n] ");
1772 else
1773 prompt.append ("y/N] ");
1774
1775 Error err (reader_sp->Initialize (CommandInterpreter::GetConfirmationInputReaderCallback,
1776 &response, // baton
1777 eInputReaderGranularityLine, // token size, to pass to callback function
1778 NULL, // end token
1779 prompt.c_str(), // prompt
1780 true)); // echo input
1781 if (err.Success())
1782 {
1783 GetDebugger().PushInputReader (reader_sp);
1784 }
1785 reader_sp->WaitOnReaderIsDone();
1786 }
1787 return response;
1788}
1789
1790
Chris Lattner24943d22010-06-08 16:52:24 +00001791void
1792CommandInterpreter::CrossRegisterCommand (const char * dest_cmd, const char * object_type)
1793{
Jim Inghamd40f8a62010-07-06 22:46:59 +00001794 CommandObjectSP cmd_obj_sp = GetCommandSPExact (dest_cmd, true);
Chris Lattner24943d22010-06-08 16:52:24 +00001795
1796 if (cmd_obj_sp != NULL)
1797 {
1798 CommandObject *cmd_obj = cmd_obj_sp.get();
1799 if (cmd_obj->IsCrossRefObject ())
1800 cmd_obj->AddObject (object_type);
1801 }
1802}
1803
Chris Lattner24943d22010-06-08 16:52:24 +00001804OptionArgVectorSP
1805CommandInterpreter::GetAliasOptions (const char *alias_name)
1806{
1807 OptionArgMap::iterator pos;
1808 OptionArgVectorSP ret_val;
1809
1810 std::string alias (alias_name);
1811
1812 if (HasAliasOptions())
1813 {
1814 pos = m_alias_options.find (alias);
1815 if (pos != m_alias_options.end())
1816 ret_val = pos->second;
1817 }
1818
1819 return ret_val;
1820}
1821
1822void
1823CommandInterpreter::RemoveAliasOptions (const char *alias_name)
1824{
1825 OptionArgMap::iterator pos = m_alias_options.find(alias_name);
1826 if (pos != m_alias_options.end())
1827 {
1828 m_alias_options.erase (pos);
1829 }
1830}
1831
1832void
1833CommandInterpreter::AddOrReplaceAliasOptions (const char *alias_name, OptionArgVectorSP &option_arg_vector_sp)
1834{
1835 m_alias_options[alias_name] = option_arg_vector_sp;
1836}
1837
1838bool
1839CommandInterpreter::HasCommands ()
1840{
1841 return (!m_command_dict.empty());
1842}
1843
1844bool
1845CommandInterpreter::HasAliases ()
1846{
1847 return (!m_alias_dict.empty());
1848}
1849
1850bool
1851CommandInterpreter::HasUserCommands ()
1852{
1853 return (!m_user_dict.empty());
1854}
1855
1856bool
1857CommandInterpreter::HasAliasOptions ()
1858{
1859 return (!m_alias_options.empty());
1860}
1861
Chris Lattner24943d22010-06-08 16:52:24 +00001862void
Caroline Ticebd5c63e2010-10-12 21:57:09 +00001863CommandInterpreter::BuildAliasCommandArgs (CommandObject *alias_cmd_obj,
1864 const char *alias_name,
1865 Args &cmd_args,
Caroline Tice44c841d2010-12-07 19:58:26 +00001866 std::string &raw_input_string,
Caroline Ticebd5c63e2010-10-12 21:57:09 +00001867 CommandReturnObject &result)
Chris Lattner24943d22010-06-08 16:52:24 +00001868{
1869 OptionArgVectorSP option_arg_vector_sp = GetAliasOptions (alias_name);
Caroline Tice44c841d2010-12-07 19:58:26 +00001870
1871 bool wants_raw_input = alias_cmd_obj->WantsRawCommandString();
Chris Lattner24943d22010-06-08 16:52:24 +00001872
Caroline Tice44c841d2010-12-07 19:58:26 +00001873 // Make sure that the alias name is the 0th element in cmd_args
1874 std::string alias_name_str = alias_name;
1875 if (alias_name_str.compare (cmd_args.GetArgumentAtIndex(0)) != 0)
1876 cmd_args.Unshift (alias_name);
1877
1878 Args new_args (alias_cmd_obj->GetCommandName());
1879 if (new_args.GetArgumentCount() == 2)
1880 new_args.Shift();
1881
Chris Lattner24943d22010-06-08 16:52:24 +00001882 if (option_arg_vector_sp.get())
1883 {
Caroline Tice44c841d2010-12-07 19:58:26 +00001884 if (wants_raw_input)
1885 {
1886 // We have a command that both has command options and takes raw input. Make *sure* it has a
1887 // " -- " in the right place in the raw_input_string.
1888 size_t pos = raw_input_string.find(" -- ");
1889 if (pos == std::string::npos)
1890 {
1891 // None found; assume it goes at the beginning of the raw input string
1892 raw_input_string.insert (0, " -- ");
1893 }
1894 }
Chris Lattner24943d22010-06-08 16:52:24 +00001895
1896 OptionArgVector *option_arg_vector = option_arg_vector_sp.get();
1897 int old_size = cmd_args.GetArgumentCount();
Caroline Ticebd5c63e2010-10-12 21:57:09 +00001898 std::vector<bool> used (old_size + 1, false);
1899
1900 used[0] = true;
Chris Lattner24943d22010-06-08 16:52:24 +00001901
1902 for (int i = 0; i < option_arg_vector->size(); ++i)
1903 {
1904 OptionArgPair option_pair = (*option_arg_vector)[i];
Caroline Tice44c841d2010-12-07 19:58:26 +00001905 OptionArgValue value_pair = option_pair.second;
1906 int value_type = value_pair.first;
Chris Lattner24943d22010-06-08 16:52:24 +00001907 std::string option = option_pair.first;
Caroline Tice44c841d2010-12-07 19:58:26 +00001908 std::string value = value_pair.second;
Chris Lattner24943d22010-06-08 16:52:24 +00001909 if (option.compare ("<argument>") == 0)
Caroline Tice44c841d2010-12-07 19:58:26 +00001910 {
1911 if (!wants_raw_input
1912 || (value.compare("--") != 0)) // Since we inserted this above, make sure we don't insert it twice
1913 new_args.AppendArgument (value.c_str());
1914 }
Chris Lattner24943d22010-06-08 16:52:24 +00001915 else
1916 {
Caroline Tice44c841d2010-12-07 19:58:26 +00001917 if (value_type != optional_argument)
1918 new_args.AppendArgument (option.c_str());
Chris Lattner24943d22010-06-08 16:52:24 +00001919 if (value.compare ("<no-argument>") != 0)
1920 {
1921 int index = GetOptionArgumentPosition (value.c_str());
1922 if (index == 0)
Caroline Tice44c841d2010-12-07 19:58:26 +00001923 {
Chris Lattner24943d22010-06-08 16:52:24 +00001924 // value was NOT a positional argument; must be a real value
Caroline Tice44c841d2010-12-07 19:58:26 +00001925 if (value_type != optional_argument)
1926 new_args.AppendArgument (value.c_str());
1927 else
1928 {
1929 char buffer[255];
1930 ::snprintf (buffer, sizeof (buffer), "%s%s", option.c_str(), value.c_str());
1931 new_args.AppendArgument (buffer);
1932 }
1933
1934 }
Chris Lattner24943d22010-06-08 16:52:24 +00001935 else if (index >= cmd_args.GetArgumentCount())
1936 {
1937 result.AppendErrorWithFormat
1938 ("Not enough arguments provided; you need at least %d arguments to use this alias.\n",
1939 index);
1940 result.SetStatus (eReturnStatusFailed);
1941 return;
1942 }
1943 else
1944 {
Caroline Tice44c841d2010-12-07 19:58:26 +00001945 // Find and remove cmd_args.GetArgumentAtIndex(i) from raw_input_string
1946 size_t strpos = raw_input_string.find (cmd_args.GetArgumentAtIndex (index));
1947 if (strpos != std::string::npos)
1948 {
1949 raw_input_string = raw_input_string.erase (strpos, strlen (cmd_args.GetArgumentAtIndex (index)));
1950 }
1951
1952 if (value_type != optional_argument)
1953 new_args.AppendArgument (cmd_args.GetArgumentAtIndex (index));
1954 else
1955 {
1956 char buffer[255];
1957 ::snprintf (buffer, sizeof(buffer), "%s%s", option.c_str(),
1958 cmd_args.GetArgumentAtIndex (index));
1959 new_args.AppendArgument (buffer);
1960 }
Caroline Ticebd5c63e2010-10-12 21:57:09 +00001961 used[index] = true;
Chris Lattner24943d22010-06-08 16:52:24 +00001962 }
1963 }
1964 }
1965 }
1966
1967 for (int j = 0; j < cmd_args.GetArgumentCount(); ++j)
1968 {
Caroline Tice44c841d2010-12-07 19:58:26 +00001969 if (!used[j] && !wants_raw_input)
Chris Lattner24943d22010-06-08 16:52:24 +00001970 new_args.AppendArgument (cmd_args.GetArgumentAtIndex (j));
1971 }
1972
1973 cmd_args.Clear();
1974 cmd_args.SetArguments (new_args.GetArgumentCount(), (const char **) new_args.GetArgumentVector());
1975 }
1976 else
1977 {
1978 result.SetStatus (eReturnStatusSuccessFinishNoResult);
Caroline Tice44c841d2010-12-07 19:58:26 +00001979 // This alias was not created with any options; nothing further needs to be done, unless it is a command that
1980 // wants raw input, in which case we need to clear the rest of the data from cmd_args, since its in the raw
1981 // input string.
1982 if (wants_raw_input)
1983 {
1984 cmd_args.Clear();
1985 cmd_args.SetArguments (new_args.GetArgumentCount(), (const char **) new_args.GetArgumentVector());
1986 }
Chris Lattner24943d22010-06-08 16:52:24 +00001987 return;
1988 }
1989
1990 result.SetStatus (eReturnStatusSuccessFinishNoResult);
1991 return;
1992}
1993
1994
1995int
1996CommandInterpreter::GetOptionArgumentPosition (const char *in_string)
1997{
1998 int position = 0; // Any string that isn't an argument position, i.e. '%' followed by an integer, gets a position
1999 // of zero.
2000
2001 char *cptr = (char *) in_string;
2002
2003 // Does it start with '%'
2004 if (cptr[0] == '%')
2005 {
2006 ++cptr;
2007
2008 // Is the rest of it entirely digits?
2009 if (isdigit (cptr[0]))
2010 {
2011 const char *start = cptr;
2012 while (isdigit (cptr[0]))
2013 ++cptr;
2014
2015 // We've gotten to the end of the digits; are we at the end of the string?
2016 if (cptr[0] == '\0')
2017 position = atoi (start);
2018 }
2019 }
2020
2021 return position;
2022}
2023
2024void
2025CommandInterpreter::SourceInitFile (bool in_cwd, CommandReturnObject &result)
2026{
Jim Ingham574c3d62011-08-12 23:34:31 +00002027 FileSpec init_file;
Greg Claytond6edcb52011-09-11 00:01:44 +00002028 if (in_cwd)
Jim Ingham574c3d62011-08-12 23:34:31 +00002029 {
Greg Claytond6edcb52011-09-11 00:01:44 +00002030 // In the current working directory we don't load any program specific
2031 // .lldbinit files, we only look for a "./.lldbinit" file.
2032 if (m_skip_lldbinit_files)
2033 return;
2034
2035 init_file.SetFile ("./.lldbinit", true);
Jim Ingham574c3d62011-08-12 23:34:31 +00002036 }
Greg Claytond6edcb52011-09-11 00:01:44 +00002037 else
Jim Ingham574c3d62011-08-12 23:34:31 +00002038 {
Greg Claytond6edcb52011-09-11 00:01:44 +00002039 // If we aren't looking in the current working directory we are looking
2040 // in the home directory. We will first see if there is an application
2041 // specific ".lldbinit" file whose name is "~/.lldbinit" followed by a
2042 // "-" and the name of the program. If this file doesn't exist, we fall
2043 // back to just the "~/.lldbinit" file. We also obey any requests to not
2044 // load the init files.
2045 const char *init_file_path = "~/.lldbinit";
2046
2047 if (m_skip_app_init_files == false)
2048 {
2049 FileSpec program_file_spec (Host::GetProgramFileSpec());
2050 const char *program_name = program_file_spec.GetFilename().AsCString();
Jim Ingham574c3d62011-08-12 23:34:31 +00002051
Greg Claytond6edcb52011-09-11 00:01:44 +00002052 if (program_name)
2053 {
2054 char program_init_file_name[PATH_MAX];
2055 ::snprintf (program_init_file_name, sizeof(program_init_file_name), "%s-%s", init_file_path, program_name);
2056 init_file.SetFile (program_init_file_name, true);
2057 if (!init_file.Exists())
2058 init_file.Clear();
2059 }
2060 }
2061
2062 if (!init_file && !m_skip_lldbinit_files)
2063 init_file.SetFile (init_file_path, true);
2064 }
2065
Chris Lattner24943d22010-06-08 16:52:24 +00002066 // If the file exists, tell HandleCommand to 'source' it; this will do the actual broadcasting
2067 // of the commands back to any appropriate listener (see CommandObjectSource::Execute for more details).
2068
2069 if (init_file.Exists())
2070 {
Jim Ingham949d5ac2011-02-18 00:54:25 +00002071 ExecutionContext *exe_ctx = NULL; // We don't have any context yet.
2072 bool stop_on_continue = true;
2073 bool stop_on_error = false;
2074 bool echo_commands = false;
2075 bool print_results = false;
2076
2077 HandleCommandsFromFile (init_file, exe_ctx, stop_on_continue, stop_on_error, echo_commands, print_results, result);
Chris Lattner24943d22010-06-08 16:52:24 +00002078 }
2079 else
2080 {
2081 // nothing to be done if the file doesn't exist
2082 result.SetStatus(eReturnStatusSuccessFinishNoResult);
2083 }
2084}
2085
Greg Claytonb72d0f02011-04-12 05:54:46 +00002086PlatformSP
2087CommandInterpreter::GetPlatform (bool prefer_target_platform)
2088{
2089 PlatformSP platform_sp;
Greg Clayton567e7f32011-09-22 04:58:26 +00002090 if (prefer_target_platform)
2091 {
2092 Target *target = m_exe_ctx.GetTargetPtr();
2093 if (target)
2094 platform_sp = target->GetPlatform();
2095 }
Greg Claytonb72d0f02011-04-12 05:54:46 +00002096
2097 if (!platform_sp)
2098 platform_sp = m_debugger.GetPlatformList().GetSelectedPlatform();
2099 return platform_sp;
2100}
2101
Jim Ingham949d5ac2011-02-18 00:54:25 +00002102void
Jim Inghama4fede32011-03-11 01:51:49 +00002103CommandInterpreter::HandleCommands (const StringList &commands,
Jim Ingham949d5ac2011-02-18 00:54:25 +00002104 ExecutionContext *override_context,
2105 bool stop_on_continue,
2106 bool stop_on_error,
2107 bool echo_commands,
2108 bool print_results,
2109 CommandReturnObject &result)
2110{
2111 size_t num_lines = commands.GetSize();
Jim Ingham949d5ac2011-02-18 00:54:25 +00002112
2113 // If we are going to continue past a "continue" then we need to run the commands synchronously.
2114 // Make sure you reset this value anywhere you return from the function.
2115
2116 bool old_async_execution = m_debugger.GetAsyncExecution();
2117
2118 // If we've been given an execution context, set it at the start, but don't keep resetting it or we will
2119 // cause series of commands that change the context, then do an operation that relies on that context to fail.
2120
2121 if (override_context != NULL)
Greg Claytonb72d0f02011-04-12 05:54:46 +00002122 UpdateExecutionContext (override_context);
Jim Ingham949d5ac2011-02-18 00:54:25 +00002123
2124 if (!stop_on_continue)
2125 {
2126 m_debugger.SetAsyncExecution (false);
2127 }
2128
2129 for (int idx = 0; idx < num_lines; idx++)
2130 {
2131 const char *cmd = commands.GetStringAtIndex(idx);
2132 if (cmd[0] == '\0')
2133 continue;
2134
Jim Ingham949d5ac2011-02-18 00:54:25 +00002135 if (echo_commands)
2136 {
2137 result.AppendMessageWithFormat ("%s %s\n",
2138 GetPrompt(),
2139 cmd);
2140 }
2141
Greg Claytonaa378b12011-02-20 02:15:07 +00002142 CommandReturnObject tmp_result;
Johnny Chen8bdf57c2011-10-05 00:42:59 +00002143 // If override_context is not NULL, pass no_context_switching = true for
2144 // HandleCommand() since we updated our context already.
2145 bool success = HandleCommand(cmd, false, tmp_result,
2146 NULL, /* override_context */
2147 true, /* repeat_on_empty_command */
2148 override_context != NULL /* no_context_switching */);
Jim Ingham949d5ac2011-02-18 00:54:25 +00002149
2150 if (print_results)
2151 {
2152 if (tmp_result.Succeeded())
Jim Ingham2e8cb8a2011-02-19 02:53:09 +00002153 result.AppendMessageWithFormat("%s", tmp_result.GetOutputData());
Jim Ingham949d5ac2011-02-18 00:54:25 +00002154 }
2155
2156 if (!success || !tmp_result.Succeeded())
2157 {
2158 if (stop_on_error)
2159 {
2160 result.AppendErrorWithFormat("Aborting reading of commands after command #%d: '%s' failed.\n",
2161 idx, cmd);
2162 result.SetStatus (eReturnStatusFailed);
2163 m_debugger.SetAsyncExecution (old_async_execution);
2164 return;
2165 }
2166 else if (print_results)
2167 {
2168 result.AppendMessageWithFormat ("Command #%d '%s' failed with error: %s.\n",
2169 idx + 1,
2170 cmd,
Jim Ingham2e8cb8a2011-02-19 02:53:09 +00002171 tmp_result.GetErrorData());
Jim Ingham949d5ac2011-02-18 00:54:25 +00002172 }
2173 }
2174
Caroline Tice4a348082011-05-02 20:41:46 +00002175 if (result.GetImmediateOutputStream())
2176 result.GetImmediateOutputStream()->Flush();
2177
2178 if (result.GetImmediateErrorStream())
2179 result.GetImmediateErrorStream()->Flush();
2180
Jim Ingham949d5ac2011-02-18 00:54:25 +00002181 // N.B. Can't depend on DidChangeProcessState, because the state coming into the command execution
2182 // could be running (for instance in Breakpoint Commands.
2183 // So we check the return value to see if it is has running in it.
2184 if ((tmp_result.GetStatus() == eReturnStatusSuccessContinuingNoResult)
2185 || (tmp_result.GetStatus() == eReturnStatusSuccessContinuingResult))
2186 {
2187 if (stop_on_continue)
2188 {
2189 // If we caused the target to proceed, and we're going to stop in that case, set the
2190 // status in our real result before returning. This is an error if the continue was not the
2191 // last command in the set of commands to be run.
2192 if (idx != num_lines - 1)
2193 result.AppendErrorWithFormat("Aborting reading of commands after command #%d: '%s' continued the target.\n",
2194 idx + 1, cmd);
2195 else
2196 result.AppendMessageWithFormat ("Command #%d '%s' continued the target.\n", idx + 1, cmd);
2197
2198 result.SetStatus(tmp_result.GetStatus());
2199 m_debugger.SetAsyncExecution (old_async_execution);
2200
2201 return;
2202 }
2203 }
2204
2205 }
2206
2207 result.SetStatus (eReturnStatusSuccessFinishResult);
2208 m_debugger.SetAsyncExecution (old_async_execution);
2209
2210 return;
2211}
2212
2213void
2214CommandInterpreter::HandleCommandsFromFile (FileSpec &cmd_file,
2215 ExecutionContext *context,
2216 bool stop_on_continue,
2217 bool stop_on_error,
2218 bool echo_command,
2219 bool print_result,
2220 CommandReturnObject &result)
2221{
2222 if (cmd_file.Exists())
2223 {
2224 bool success;
2225 StringList commands;
2226 success = commands.ReadFileLines(cmd_file);
2227 if (!success)
2228 {
2229 result.AppendErrorWithFormat ("Error reading commands from file: %s.\n", cmd_file.GetFilename().AsCString());
2230 result.SetStatus (eReturnStatusFailed);
2231 return;
2232 }
2233 HandleCommands (commands, context, stop_on_continue, stop_on_error, echo_command, print_result, result);
2234 }
2235 else
2236 {
2237 result.AppendErrorWithFormat ("Error reading commands from file %s - file not found.\n",
2238 cmd_file.GetFilename().AsCString());
2239 result.SetStatus (eReturnStatusFailed);
2240 return;
2241 }
2242}
2243
Chris Lattner24943d22010-06-08 16:52:24 +00002244ScriptInterpreter *
2245CommandInterpreter::GetScriptInterpreter ()
2246{
Caroline Tice0aa2e552011-01-14 00:29:16 +00002247 if (m_script_interpreter_ap.get() != NULL)
2248 return m_script_interpreter_ap.get();
Greg Clayton63094e02010-06-23 01:19:29 +00002249
Caroline Tice0aa2e552011-01-14 00:29:16 +00002250 lldb::ScriptLanguage script_lang = GetDebugger().GetScriptLanguage();
2251 switch (script_lang)
Chris Lattner24943d22010-06-08 16:52:24 +00002252 {
Caroline Tice0aa2e552011-01-14 00:29:16 +00002253 case eScriptLanguageNone:
2254 m_script_interpreter_ap.reset (new ScriptInterpreterNone (*this));
2255 break;
2256 case eScriptLanguagePython:
2257 m_script_interpreter_ap.reset (new ScriptInterpreterPython (*this));
2258 break;
2259 default:
2260 break;
2261 };
2262
2263 return m_script_interpreter_ap.get();
Chris Lattner24943d22010-06-08 16:52:24 +00002264}
2265
2266
2267
2268bool
2269CommandInterpreter::GetSynchronous ()
2270{
2271 return m_synchronous_execution;
2272}
2273
2274void
2275CommandInterpreter::SetSynchronous (bool value)
2276{
Johnny Chend7a4eb02010-10-14 01:22:03 +00002277 m_synchronous_execution = value;
Chris Lattner24943d22010-06-08 16:52:24 +00002278}
2279
2280void
2281CommandInterpreter::OutputFormattedHelpText (Stream &strm,
2282 const char *word_text,
2283 const char *separator,
2284 const char *help_text,
2285 uint32_t max_word_len)
2286{
Greg Clayton238c0a12010-09-18 01:14:36 +00002287 const uint32_t max_columns = m_debugger.GetTerminalWidth();
2288
Chris Lattner24943d22010-06-08 16:52:24 +00002289 int indent_size = max_word_len + strlen (separator) + 2;
2290
2291 strm.IndentMore (indent_size);
Greg Claytond284b662011-02-18 01:44:25 +00002292
2293 StreamString text_strm;
2294 text_strm.Printf ("%-*s %s %s", max_word_len, word_text, separator, help_text);
2295
2296 size_t len = text_strm.GetSize();
2297 const char *text = text_strm.GetData();
Chris Lattner24943d22010-06-08 16:52:24 +00002298 if (text[len - 1] == '\n')
Greg Claytond284b662011-02-18 01:44:25 +00002299 {
2300 text_strm.EOL();
2301 len = text_strm.GetSize();
2302 }
Chris Lattner24943d22010-06-08 16:52:24 +00002303
2304 if (len < max_columns)
2305 {
2306 // Output it as a single line.
2307 strm.Printf ("%s", text);
2308 }
2309 else
2310 {
2311 // We need to break it up into multiple lines.
2312 bool first_line = true;
2313 int text_width;
2314 int start = 0;
2315 int end = start;
2316 int final_end = strlen (text);
2317 int sub_len;
2318
2319 while (end < final_end)
2320 {
2321 if (first_line)
2322 text_width = max_columns - 1;
2323 else
2324 text_width = max_columns - indent_size - 1;
2325
2326 // Don't start the 'text' on a space, since we're already outputting the indentation.
2327 if (!first_line)
2328 {
2329 while ((start < final_end) && (text[start] == ' '))
2330 start++;
2331 }
2332
2333 end = start + text_width;
2334 if (end > final_end)
2335 end = final_end;
2336 else
2337 {
2338 // If we're not at the end of the text, make sure we break the line on white space.
2339 while (end > start
2340 && text[end] != ' ' && text[end] != '\t' && text[end] != '\n')
2341 end--;
2342 }
2343
2344 sub_len = end - start;
2345 if (start != 0)
2346 strm.EOL();
2347 if (!first_line)
2348 strm.Indent();
2349 else
2350 first_line = false;
2351 assert (start <= final_end);
2352 assert (start + sub_len <= final_end);
2353 if (sub_len > 0)
2354 strm.Write (text + start, sub_len);
2355 start = end + 1;
2356 }
2357 }
2358 strm.EOL();
2359 strm.IndentLess(indent_size);
Chris Lattner24943d22010-06-08 16:52:24 +00002360}
2361
2362void
Enrico Granata1bba6e52011-07-07 00:38:40 +00002363CommandInterpreter::OutputHelpText (Stream &strm,
2364 const char *word_text,
2365 const char *separator,
2366 const char *help_text,
2367 uint32_t max_word_len)
2368{
2369 int indent_size = max_word_len + strlen (separator) + 2;
2370
2371 strm.IndentMore (indent_size);
2372
2373 StreamString text_strm;
2374 text_strm.Printf ("%-*s %s %s", max_word_len, word_text, separator, help_text);
2375
2376 const uint32_t max_columns = m_debugger.GetTerminalWidth();
2377 bool first_line = true;
2378
2379 size_t len = text_strm.GetSize();
2380 const char *text = text_strm.GetData();
2381
2382 uint32_t chars_left = max_columns;
2383
2384 for (uint32_t i = 0; i < len; i++)
2385 {
2386 if ((text[i] == ' ' && ::strchr((text+i+1), ' ') && chars_left < ::strchr((text+i+1), ' ')-(text+i)) || text[i] == '\n')
2387 {
2388 first_line = false;
2389 chars_left = max_columns - indent_size;
2390 strm.EOL();
2391 strm.Indent();
2392 }
2393 else
2394 {
2395 strm.PutChar(text[i]);
2396 chars_left--;
2397 }
2398
2399 }
2400
2401 strm.EOL();
2402 strm.IndentLess(indent_size);
2403}
2404
2405void
Chris Lattner24943d22010-06-08 16:52:24 +00002406CommandInterpreter::AproposAllSubCommands (CommandObject *cmd_obj, const char *prefix, const char *search_word,
2407 StringList &commands_found, StringList &commands_help)
2408{
2409 CommandObject::CommandMap::const_iterator pos;
2410 CommandObject::CommandMap sub_cmd_dict = ((CommandObjectMultiword *) cmd_obj)->m_subcommand_dict;
2411 CommandObject *sub_cmd_obj;
2412
2413 for (pos = sub_cmd_dict.begin(); pos != sub_cmd_dict.end(); ++pos)
2414 {
2415 const char * command_name = pos->first.c_str();
2416 sub_cmd_obj = pos->second.get();
2417 StreamString complete_command_name;
2418
2419 complete_command_name.Printf ("%s %s", prefix, command_name);
2420
Greg Clayton238c0a12010-09-18 01:14:36 +00002421 if (sub_cmd_obj->HelpTextContainsWord (search_word))
Chris Lattner24943d22010-06-08 16:52:24 +00002422 {
2423 commands_found.AppendString (complete_command_name.GetData());
2424 commands_help.AppendString (sub_cmd_obj->GetHelp());
2425 }
2426
2427 if (sub_cmd_obj->IsMultiwordObject())
2428 AproposAllSubCommands (sub_cmd_obj, complete_command_name.GetData(), search_word, commands_found,
2429 commands_help);
2430 }
2431
2432}
2433
2434void
2435CommandInterpreter::FindCommandsForApropos (const char *search_word, StringList &commands_found,
2436 StringList &commands_help)
2437{
2438 CommandObject::CommandMap::const_iterator pos;
2439
2440 for (pos = m_command_dict.begin(); pos != m_command_dict.end(); ++pos)
2441 {
2442 const char *command_name = pos->first.c_str();
2443 CommandObject *cmd_obj = pos->second.get();
2444
Greg Clayton238c0a12010-09-18 01:14:36 +00002445 if (cmd_obj->HelpTextContainsWord (search_word))
Chris Lattner24943d22010-06-08 16:52:24 +00002446 {
2447 commands_found.AppendString (command_name);
2448 commands_help.AppendString (cmd_obj->GetHelp());
2449 }
2450
2451 if (cmd_obj->IsMultiwordObject())
2452 AproposAllSubCommands (cmd_obj, command_name, search_word, commands_found, commands_help);
2453
2454 }
2455}
Greg Claytonb72d0f02011-04-12 05:54:46 +00002456
2457
2458void
2459CommandInterpreter::UpdateExecutionContext (ExecutionContext *override_context)
2460{
2461 m_exe_ctx.Clear();
2462
2463 if (override_context != NULL)
2464 {
Greg Clayton567e7f32011-09-22 04:58:26 +00002465 m_exe_ctx = *override_context;
Greg Claytonb72d0f02011-04-12 05:54:46 +00002466 }
2467 else
2468 {
2469 TargetSP target_sp (m_debugger.GetSelectedTarget());
2470 if (target_sp)
2471 {
Greg Clayton567e7f32011-09-22 04:58:26 +00002472 m_exe_ctx.SetTargetSP (target_sp);
2473 ProcessSP process_sp (target_sp->GetProcessSP());
2474 m_exe_ctx.SetProcessSP (process_sp);
2475 if (process_sp && process_sp->IsAlive() && !process_sp->IsRunning())
Greg Claytonb72d0f02011-04-12 05:54:46 +00002476 {
Greg Clayton567e7f32011-09-22 04:58:26 +00002477 ThreadSP thread_sp (process_sp->GetThreadList().GetSelectedThread().get());
2478 if (thread_sp)
Greg Claytonb72d0f02011-04-12 05:54:46 +00002479 {
Greg Clayton567e7f32011-09-22 04:58:26 +00002480 m_exe_ctx.SetThreadSP (thread_sp);
2481 StackFrameSP frame_sp (thread_sp->GetSelectedFrame());
2482 if (!frame_sp)
Greg Claytonb72d0f02011-04-12 05:54:46 +00002483 {
Greg Clayton567e7f32011-09-22 04:58:26 +00002484 frame_sp = thread_sp->GetStackFrameAtIndex (0);
Greg Claytonb72d0f02011-04-12 05:54:46 +00002485 // If we didn't have a selected frame select one here.
Greg Clayton567e7f32011-09-22 04:58:26 +00002486 if (frame_sp)
2487 thread_sp->SetSelectedFrame(frame_sp.get());
Greg Claytonb72d0f02011-04-12 05:54:46 +00002488 }
Greg Clayton567e7f32011-09-22 04:58:26 +00002489 if (frame_sp)
2490 m_exe_ctx.SetFrameSP (frame_sp);
Greg Claytonb72d0f02011-04-12 05:54:46 +00002491 }
2492 }
2493 }
2494 }
2495}
2496
Jim Ingham6247dbe2011-07-12 03:12:18 +00002497void
2498CommandInterpreter::DumpHistory (Stream &stream, uint32_t count) const
2499{
2500 DumpHistory (stream, 0, count - 1);
2501}
2502
2503void
2504CommandInterpreter::DumpHistory (Stream &stream, uint32_t start, uint32_t end) const
2505{
Greg Clayton7268b4c2011-10-28 21:38:01 +00002506 const size_t last_idx = std::min<size_t>(m_command_history.size(), end + 1);
2507 for (size_t i = start; i < last_idx; i++)
Jim Ingham6247dbe2011-07-12 03:12:18 +00002508 {
2509 if (!m_command_history[i].empty())
2510 {
2511 stream.Indent();
Greg Clayton7268b4c2011-10-28 21:38:01 +00002512 stream.Printf ("%4zu: %s\n", i, m_command_history[i].c_str());
Jim Ingham6247dbe2011-07-12 03:12:18 +00002513 }
2514 }
2515}
2516
2517const char *
2518CommandInterpreter::FindHistoryString (const char *input_str) const
2519{
2520 if (input_str[0] != m_repeat_char)
2521 return NULL;
2522 if (input_str[1] == '-')
2523 {
2524 bool success;
2525 uint32_t idx = Args::StringToUInt32 (input_str+2, 0, 0, &success);
2526 if (!success)
2527 return NULL;
2528 if (idx > m_command_history.size())
2529 return NULL;
2530 idx = m_command_history.size() - idx;
2531 return m_command_history[idx].c_str();
2532
2533 }
2534 else if (input_str[1] == m_repeat_char)
2535 {
2536 if (m_command_history.empty())
2537 return NULL;
2538 else
2539 return m_command_history.back().c_str();
2540 }
2541 else
2542 {
2543 bool success;
2544 uint32_t idx = Args::StringToUInt32 (input_str+1, 0, 0, &success);
2545 if (!success)
2546 return NULL;
2547 if (idx >= m_command_history.size())
2548 return NULL;
2549 return m_command_history[idx].c_str();
2550 }
2551}