130fdc8d8SChris Lattner //===-- CommandObject.cpp ---------------------------------------*- C++ -*-===//
230fdc8d8SChris Lattner //
330fdc8d8SChris Lattner //                     The LLVM Compiler Infrastructure
430fdc8d8SChris Lattner //
530fdc8d8SChris Lattner // This file is distributed under the University of Illinois Open Source
630fdc8d8SChris Lattner // License. See LICENSE.TXT for details.
730fdc8d8SChris Lattner //
830fdc8d8SChris Lattner //===----------------------------------------------------------------------===//
930fdc8d8SChris Lattner 
1030fdc8d8SChris Lattner #include "lldb/Interpreter/CommandObject.h"
1130fdc8d8SChris Lattner 
1230fdc8d8SChris Lattner #include <string>
1330fdc8d8SChris Lattner #include <map>
1430fdc8d8SChris Lattner 
1530fdc8d8SChris Lattner #include <getopt.h>
1630fdc8d8SChris Lattner #include <stdlib.h>
1730fdc8d8SChris Lattner #include <ctype.h>
1830fdc8d8SChris Lattner 
1930fdc8d8SChris Lattner #include "lldb/Core/Address.h"
2040af72e1SJim Ingham #include "lldb/Interpreter/Options.h"
2130fdc8d8SChris Lattner 
2230fdc8d8SChris Lattner // These are for the Sourcename completers.
2330fdc8d8SChris Lattner // FIXME: Make a separate file for the completers.
2430fdc8d8SChris Lattner #include "lldb/Core/FileSpec.h"
2530fdc8d8SChris Lattner #include "lldb/Core/FileSpecList.h"
2630fdc8d8SChris Lattner #include "lldb/Target/Process.h"
2730fdc8d8SChris Lattner #include "lldb/Target/Target.h"
2830fdc8d8SChris Lattner 
2930fdc8d8SChris Lattner #include "lldb/Interpreter/CommandInterpreter.h"
3030fdc8d8SChris Lattner #include "lldb/Interpreter/CommandReturnObject.h"
3130fdc8d8SChris Lattner #include "lldb/Interpreter/ScriptInterpreter.h"
3230fdc8d8SChris Lattner #include "lldb/Interpreter/ScriptInterpreterPython.h"
3330fdc8d8SChris Lattner 
3430fdc8d8SChris Lattner using namespace lldb;
3530fdc8d8SChris Lattner using namespace lldb_private;
3630fdc8d8SChris Lattner 
3730fdc8d8SChris Lattner //-------------------------------------------------------------------------
3830fdc8d8SChris Lattner // CommandObject
3930fdc8d8SChris Lattner //-------------------------------------------------------------------------
4030fdc8d8SChris Lattner 
41a7015092SGreg Clayton CommandObject::CommandObject
42a7015092SGreg Clayton (
43a7015092SGreg Clayton     CommandInterpreter &interpreter,
44a7015092SGreg Clayton     const char *name,
45a7015092SGreg Clayton     const char *help,
46a7015092SGreg Clayton     const char *syntax,
47a7015092SGreg Clayton     uint32_t flags
48a7015092SGreg Clayton ) :
49a7015092SGreg Clayton     m_interpreter (interpreter),
5030fdc8d8SChris Lattner     m_cmd_name (name),
5130fdc8d8SChris Lattner     m_cmd_help_short (),
5230fdc8d8SChris Lattner     m_cmd_help_long (),
5330fdc8d8SChris Lattner     m_cmd_syntax (),
54279a6c26SJim Ingham     m_is_alias (false),
55e139cf23SCaroline Tice     m_flags (flags),
56e139cf23SCaroline Tice     m_arguments()
5730fdc8d8SChris Lattner {
5830fdc8d8SChris Lattner     if (help && help[0])
5930fdc8d8SChris Lattner         m_cmd_help_short = help;
6030fdc8d8SChris Lattner     if (syntax && syntax[0])
6130fdc8d8SChris Lattner         m_cmd_syntax = syntax;
6230fdc8d8SChris Lattner }
6330fdc8d8SChris Lattner 
6430fdc8d8SChris Lattner CommandObject::~CommandObject ()
6530fdc8d8SChris Lattner {
6630fdc8d8SChris Lattner }
6730fdc8d8SChris Lattner 
6830fdc8d8SChris Lattner const char *
6930fdc8d8SChris Lattner CommandObject::GetHelp ()
7030fdc8d8SChris Lattner {
7130fdc8d8SChris Lattner     return m_cmd_help_short.c_str();
7230fdc8d8SChris Lattner }
7330fdc8d8SChris Lattner 
7430fdc8d8SChris Lattner const char *
7530fdc8d8SChris Lattner CommandObject::GetHelpLong ()
7630fdc8d8SChris Lattner {
7730fdc8d8SChris Lattner     return m_cmd_help_long.c_str();
7830fdc8d8SChris Lattner }
7930fdc8d8SChris Lattner 
8030fdc8d8SChris Lattner const char *
8130fdc8d8SChris Lattner CommandObject::GetSyntax ()
8230fdc8d8SChris Lattner {
83e139cf23SCaroline Tice     if (m_cmd_syntax.length() == 0)
84e139cf23SCaroline Tice     {
85e139cf23SCaroline Tice         StreamString syntax_str;
86e139cf23SCaroline Tice         syntax_str.Printf ("%s", GetCommandName());
87e139cf23SCaroline Tice         if (GetOptions() != NULL)
88e139cf23SCaroline Tice             syntax_str.Printf (" <cmd-options>");
89e139cf23SCaroline Tice         if (m_arguments.size() > 0)
90e139cf23SCaroline Tice         {
91e139cf23SCaroline Tice             syntax_str.Printf (" ");
92e139cf23SCaroline Tice             GetFormattedCommandArguments (syntax_str);
93e139cf23SCaroline Tice         }
94e139cf23SCaroline Tice         m_cmd_syntax = syntax_str.GetData ();
95e139cf23SCaroline Tice     }
96e139cf23SCaroline Tice 
9730fdc8d8SChris Lattner     return m_cmd_syntax.c_str();
9830fdc8d8SChris Lattner }
9930fdc8d8SChris Lattner 
10030fdc8d8SChris Lattner const char *
10130fdc8d8SChris Lattner CommandObject::Translate ()
10230fdc8d8SChris Lattner {
10330fdc8d8SChris Lattner     //return m_cmd_func_name.c_str();
10430fdc8d8SChris Lattner     return "This function is currently not implemented.";
10530fdc8d8SChris Lattner }
10630fdc8d8SChris Lattner 
10730fdc8d8SChris Lattner const char *
10830fdc8d8SChris Lattner CommandObject::GetCommandName ()
10930fdc8d8SChris Lattner {
11030fdc8d8SChris Lattner     return m_cmd_name.c_str();
11130fdc8d8SChris Lattner }
11230fdc8d8SChris Lattner 
11330fdc8d8SChris Lattner void
11430fdc8d8SChris Lattner CommandObject::SetCommandName (const char *name)
11530fdc8d8SChris Lattner {
11630fdc8d8SChris Lattner     m_cmd_name = name;
11730fdc8d8SChris Lattner }
11830fdc8d8SChris Lattner 
11930fdc8d8SChris Lattner void
12030fdc8d8SChris Lattner CommandObject::SetHelp (const char *cstr)
12130fdc8d8SChris Lattner {
12230fdc8d8SChris Lattner     m_cmd_help_short = cstr;
12330fdc8d8SChris Lattner }
12430fdc8d8SChris Lattner 
12530fdc8d8SChris Lattner void
12630fdc8d8SChris Lattner CommandObject::SetHelpLong (const char *cstr)
12730fdc8d8SChris Lattner {
12830fdc8d8SChris Lattner     m_cmd_help_long = cstr;
12930fdc8d8SChris Lattner }
13030fdc8d8SChris Lattner 
13130fdc8d8SChris Lattner void
13230fdc8d8SChris Lattner CommandObject::SetSyntax (const char *cstr)
13330fdc8d8SChris Lattner {
13430fdc8d8SChris Lattner     m_cmd_syntax = cstr;
13530fdc8d8SChris Lattner }
13630fdc8d8SChris Lattner 
13730fdc8d8SChris Lattner Options *
13830fdc8d8SChris Lattner CommandObject::GetOptions ()
13930fdc8d8SChris Lattner {
14030fdc8d8SChris Lattner     // By default commands don't have options unless this virtual function
14130fdc8d8SChris Lattner     // is overridden by base classes.
14230fdc8d8SChris Lattner     return NULL;
14330fdc8d8SChris Lattner }
14430fdc8d8SChris Lattner 
14530fdc8d8SChris Lattner Flags&
14630fdc8d8SChris Lattner CommandObject::GetFlags()
14730fdc8d8SChris Lattner {
14830fdc8d8SChris Lattner     return m_flags;
14930fdc8d8SChris Lattner }
15030fdc8d8SChris Lattner 
15130fdc8d8SChris Lattner const Flags&
15230fdc8d8SChris Lattner CommandObject::GetFlags() const
15330fdc8d8SChris Lattner {
15430fdc8d8SChris Lattner     return m_flags;
15530fdc8d8SChris Lattner }
15630fdc8d8SChris Lattner 
15730fdc8d8SChris Lattner bool
15830fdc8d8SChris Lattner CommandObject::ExecuteCommandString
15930fdc8d8SChris Lattner (
16030fdc8d8SChris Lattner     const char *command_line,
16130fdc8d8SChris Lattner     CommandReturnObject &result
16230fdc8d8SChris Lattner )
16330fdc8d8SChris Lattner {
16430fdc8d8SChris Lattner     Args command_args(command_line);
165a7015092SGreg Clayton     return ExecuteWithOptions (command_args, result);
16630fdc8d8SChris Lattner }
16730fdc8d8SChris Lattner 
16830fdc8d8SChris Lattner bool
16930fdc8d8SChris Lattner CommandObject::ParseOptions
17030fdc8d8SChris Lattner (
17130fdc8d8SChris Lattner     Args& args,
17230fdc8d8SChris Lattner     CommandReturnObject &result
17330fdc8d8SChris Lattner )
17430fdc8d8SChris Lattner {
17530fdc8d8SChris Lattner     // See if the subclass has options?
17630fdc8d8SChris Lattner     Options *options = GetOptions();
17730fdc8d8SChris Lattner     if (options != NULL)
17830fdc8d8SChris Lattner     {
17930fdc8d8SChris Lattner         Error error;
18030fdc8d8SChris Lattner         options->ResetOptionValues();
18130fdc8d8SChris Lattner 
18230fdc8d8SChris Lattner         // ParseOptions calls getopt_long, which always skips the zero'th item in the array and starts at position 1,
18330fdc8d8SChris Lattner         // so we need to push a dummy value into position zero.
18430fdc8d8SChris Lattner         args.Unshift("dummy_string");
18530fdc8d8SChris Lattner         error = args.ParseOptions (*options);
18630fdc8d8SChris Lattner 
18730fdc8d8SChris Lattner         // The "dummy_string" will have already been removed by ParseOptions,
18830fdc8d8SChris Lattner         // so no need to remove it.
18930fdc8d8SChris Lattner 
19030fdc8d8SChris Lattner         if (error.Fail() || !options->VerifyOptions (result))
19130fdc8d8SChris Lattner         {
19230fdc8d8SChris Lattner             const char *error_cstr = error.AsCString();
19330fdc8d8SChris Lattner             if (error_cstr)
19430fdc8d8SChris Lattner             {
19530fdc8d8SChris Lattner                 // We got an error string, lets use that
19630fdc8d8SChris Lattner                 result.GetErrorStream().PutCString(error_cstr);
19730fdc8d8SChris Lattner             }
19830fdc8d8SChris Lattner             else
19930fdc8d8SChris Lattner             {
20030fdc8d8SChris Lattner                 // No error string, output the usage information into result
201a7015092SGreg Clayton                 options->GenerateOptionUsage (m_interpreter, result.GetErrorStream(), this);
20230fdc8d8SChris Lattner             }
20330fdc8d8SChris Lattner             // Set the return status to failed (this was an error).
20430fdc8d8SChris Lattner             result.SetStatus (eReturnStatusFailed);
20530fdc8d8SChris Lattner             return false;
20630fdc8d8SChris Lattner         }
20730fdc8d8SChris Lattner     }
20830fdc8d8SChris Lattner     return true;
20930fdc8d8SChris Lattner }
21030fdc8d8SChris Lattner bool
211a7015092SGreg Clayton CommandObject::ExecuteWithOptions (Args& args, CommandReturnObject &result)
21230fdc8d8SChris Lattner {
21330fdc8d8SChris Lattner     for (size_t i = 0; i < args.GetArgumentCount();  ++i)
21430fdc8d8SChris Lattner     {
21530fdc8d8SChris Lattner         const char *tmp_str = args.GetArgumentAtIndex (i);
21630fdc8d8SChris Lattner         if (tmp_str[0] == '`')  // back-quote
217a7015092SGreg Clayton             args.ReplaceArgumentAtIndex (i, m_interpreter.ProcessEmbeddedScriptCommands (tmp_str));
21830fdc8d8SChris Lattner     }
21930fdc8d8SChris Lattner 
220a7015092SGreg Clayton     Process *process = m_interpreter.GetDebugger().GetExecutionContext().process;
22130fdc8d8SChris Lattner     if (process == NULL)
22230fdc8d8SChris Lattner     {
22330fdc8d8SChris Lattner         if (GetFlags().IsSet(CommandObject::eFlagProcessMustBeLaunched | CommandObject::eFlagProcessMustBePaused))
22430fdc8d8SChris Lattner         {
22530fdc8d8SChris Lattner             result.AppendError ("Process must exist.");
22630fdc8d8SChris Lattner             result.SetStatus (eReturnStatusFailed);
22730fdc8d8SChris Lattner             return false;
22830fdc8d8SChris Lattner         }
22930fdc8d8SChris Lattner     }
23030fdc8d8SChris Lattner     else
23130fdc8d8SChris Lattner     {
23230fdc8d8SChris Lattner         StateType state = process->GetState();
23330fdc8d8SChris Lattner 
23430fdc8d8SChris Lattner         switch (state)
23530fdc8d8SChris Lattner         {
23630fdc8d8SChris Lattner 
23730fdc8d8SChris Lattner         case eStateAttaching:
23830fdc8d8SChris Lattner         case eStateLaunching:
23930fdc8d8SChris Lattner         case eStateSuspended:
24030fdc8d8SChris Lattner         case eStateCrashed:
24130fdc8d8SChris Lattner         case eStateStopped:
24230fdc8d8SChris Lattner             break;
24330fdc8d8SChris Lattner 
24430fdc8d8SChris Lattner         case eStateDetached:
24530fdc8d8SChris Lattner         case eStateExited:
24630fdc8d8SChris Lattner         case eStateUnloaded:
24730fdc8d8SChris Lattner             if (GetFlags().IsSet(CommandObject::eFlagProcessMustBeLaunched))
24830fdc8d8SChris Lattner             {
24930fdc8d8SChris Lattner                 result.AppendError ("Process must be launched.");
25030fdc8d8SChris Lattner                 result.SetStatus (eReturnStatusFailed);
25130fdc8d8SChris Lattner                 return false;
25230fdc8d8SChris Lattner             }
25330fdc8d8SChris Lattner             break;
25430fdc8d8SChris Lattner 
25530fdc8d8SChris Lattner         case eStateRunning:
25630fdc8d8SChris Lattner         case eStateStepping:
25730fdc8d8SChris Lattner             if (GetFlags().IsSet(CommandObject::eFlagProcessMustBePaused))
25830fdc8d8SChris Lattner             {
25930fdc8d8SChris Lattner                 result.AppendError ("Process is running.  Use 'process interrupt' to pause execution.");
26030fdc8d8SChris Lattner                 result.SetStatus (eReturnStatusFailed);
26130fdc8d8SChris Lattner                 return false;
26230fdc8d8SChris Lattner             }
26330fdc8d8SChris Lattner         }
26430fdc8d8SChris Lattner     }
26530fdc8d8SChris Lattner 
266a7015092SGreg Clayton     if (!ParseOptions (args, result))
26730fdc8d8SChris Lattner         return false;
26830fdc8d8SChris Lattner 
26930fdc8d8SChris Lattner     // Call the command-specific version of 'Execute', passing it the already processed arguments.
270a7015092SGreg Clayton     return Execute (args, result);
27130fdc8d8SChris Lattner }
27230fdc8d8SChris Lattner 
27330fdc8d8SChris Lattner class CommandDictCommandPartialMatch
27430fdc8d8SChris Lattner {
27530fdc8d8SChris Lattner     public:
27630fdc8d8SChris Lattner         CommandDictCommandPartialMatch (const char *match_str)
27730fdc8d8SChris Lattner         {
27830fdc8d8SChris Lattner             m_match_str = match_str;
27930fdc8d8SChris Lattner         }
28030fdc8d8SChris Lattner         bool operator() (const std::pair<std::string, lldb::CommandObjectSP> map_element) const
28130fdc8d8SChris Lattner         {
28230fdc8d8SChris Lattner             // A NULL or empty string matches everything.
28330fdc8d8SChris Lattner             if (m_match_str == NULL || *m_match_str == '\0')
28430fdc8d8SChris Lattner                 return 1;
28530fdc8d8SChris Lattner 
28630fdc8d8SChris Lattner             size_t found = map_element.first.find (m_match_str, 0);
28730fdc8d8SChris Lattner             if (found == std::string::npos)
28830fdc8d8SChris Lattner                 return 0;
28930fdc8d8SChris Lattner             else
29030fdc8d8SChris Lattner                 return found == 0;
29130fdc8d8SChris Lattner         }
29230fdc8d8SChris Lattner 
29330fdc8d8SChris Lattner     private:
29430fdc8d8SChris Lattner         const char *m_match_str;
29530fdc8d8SChris Lattner };
29630fdc8d8SChris Lattner 
29730fdc8d8SChris Lattner int
29830fdc8d8SChris Lattner CommandObject::AddNamesMatchingPartialString (CommandObject::CommandMap &in_map, const char *cmd_str,
29930fdc8d8SChris Lattner                                               StringList &matches)
30030fdc8d8SChris Lattner {
30130fdc8d8SChris Lattner     int number_added = 0;
30230fdc8d8SChris Lattner     CommandDictCommandPartialMatch matcher(cmd_str);
30330fdc8d8SChris Lattner 
30430fdc8d8SChris Lattner     CommandObject::CommandMap::iterator matching_cmds = std::find_if (in_map.begin(), in_map.end(), matcher);
30530fdc8d8SChris Lattner 
30630fdc8d8SChris Lattner     while (matching_cmds != in_map.end())
30730fdc8d8SChris Lattner     {
30830fdc8d8SChris Lattner         ++number_added;
30930fdc8d8SChris Lattner         matches.AppendString((*matching_cmds).first.c_str());
31030fdc8d8SChris Lattner         matching_cmds = std::find_if (++matching_cmds, in_map.end(), matcher);;
31130fdc8d8SChris Lattner     }
31230fdc8d8SChris Lattner     return number_added;
31330fdc8d8SChris Lattner }
31430fdc8d8SChris Lattner 
31530fdc8d8SChris Lattner int
31630fdc8d8SChris Lattner CommandObject::HandleCompletion
31730fdc8d8SChris Lattner (
31830fdc8d8SChris Lattner     Args &input,
31930fdc8d8SChris Lattner     int &cursor_index,
32030fdc8d8SChris Lattner     int &cursor_char_position,
32130fdc8d8SChris Lattner     int match_start_point,
32230fdc8d8SChris Lattner     int max_return_elements,
323558ce124SJim Ingham     bool &word_complete,
32430fdc8d8SChris Lattner     StringList &matches
32530fdc8d8SChris Lattner )
32630fdc8d8SChris Lattner {
32730fdc8d8SChris Lattner     if (WantsRawCommandString())
32830fdc8d8SChris Lattner     {
32930fdc8d8SChris Lattner         // FIXME: Abstract telling the completion to insert the completion character.
33030fdc8d8SChris Lattner         matches.Clear();
33130fdc8d8SChris Lattner         return -1;
33230fdc8d8SChris Lattner     }
33330fdc8d8SChris Lattner     else
33430fdc8d8SChris Lattner     {
33530fdc8d8SChris Lattner         // Can we do anything generic with the options?
33630fdc8d8SChris Lattner         Options *cur_options = GetOptions();
33730fdc8d8SChris Lattner         CommandReturnObject result;
33830fdc8d8SChris Lattner         OptionElementVector opt_element_vector;
33930fdc8d8SChris Lattner 
34030fdc8d8SChris Lattner         if (cur_options != NULL)
34130fdc8d8SChris Lattner         {
34230fdc8d8SChris Lattner             // Re-insert the dummy command name string which will have been
34330fdc8d8SChris Lattner             // stripped off:
34430fdc8d8SChris Lattner             input.Unshift ("dummy-string");
34530fdc8d8SChris Lattner             cursor_index++;
34630fdc8d8SChris Lattner 
34730fdc8d8SChris Lattner 
34830fdc8d8SChris Lattner             // I stick an element on the end of the input, because if the last element is
34930fdc8d8SChris Lattner             // option that requires an argument, getopt_long will freak out.
35030fdc8d8SChris Lattner 
35130fdc8d8SChris Lattner             input.AppendArgument ("<FAKE-VALUE>");
35230fdc8d8SChris Lattner 
353d43e0094SJim Ingham             input.ParseArgsForCompletion (*cur_options, opt_element_vector, cursor_index);
35430fdc8d8SChris Lattner 
35530fdc8d8SChris Lattner             input.DeleteArgumentAtIndex(input.GetArgumentCount() - 1);
35630fdc8d8SChris Lattner 
35730fdc8d8SChris Lattner             bool handled_by_options;
358a7015092SGreg Clayton             handled_by_options = cur_options->HandleOptionCompletion (m_interpreter,
3596611103cSGreg Clayton                                                                       input,
36030fdc8d8SChris Lattner                                                                       opt_element_vector,
36130fdc8d8SChris Lattner                                                                       cursor_index,
36230fdc8d8SChris Lattner                                                                       cursor_char_position,
36330fdc8d8SChris Lattner                                                                       match_start_point,
36430fdc8d8SChris Lattner                                                                       max_return_elements,
365558ce124SJim Ingham                                                                       word_complete,
36630fdc8d8SChris Lattner                                                                       matches);
36730fdc8d8SChris Lattner             if (handled_by_options)
36830fdc8d8SChris Lattner                 return matches.GetSize();
36930fdc8d8SChris Lattner         }
37030fdc8d8SChris Lattner 
37130fdc8d8SChris Lattner         // If we got here, the last word is not an option or an option argument.
372a7015092SGreg Clayton         return HandleArgumentCompletion (input,
37330fdc8d8SChris Lattner                                          cursor_index,
37430fdc8d8SChris Lattner                                          cursor_char_position,
37530fdc8d8SChris Lattner                                          opt_element_vector,
37630fdc8d8SChris Lattner                                          match_start_point,
37730fdc8d8SChris Lattner                                          max_return_elements,
378558ce124SJim Ingham                                          word_complete,
37930fdc8d8SChris Lattner                                          matches);
38030fdc8d8SChris Lattner     }
38130fdc8d8SChris Lattner }
38230fdc8d8SChris Lattner 
38330fdc8d8SChris Lattner bool
384a7015092SGreg Clayton CommandObject::HelpTextContainsWord (const char *search_word)
38530fdc8d8SChris Lattner {
38630fdc8d8SChris Lattner     const char *short_help;
38730fdc8d8SChris Lattner     const char *long_help;
38830fdc8d8SChris Lattner     const char *syntax_help;
38930fdc8d8SChris Lattner     std::string options_usage_help;
39030fdc8d8SChris Lattner 
39130fdc8d8SChris Lattner 
39230fdc8d8SChris Lattner     bool found_word = false;
39330fdc8d8SChris Lattner 
39430fdc8d8SChris Lattner     short_help = GetHelp();
39530fdc8d8SChris Lattner     long_help = GetHelpLong();
39630fdc8d8SChris Lattner     syntax_help = GetSyntax();
39730fdc8d8SChris Lattner 
3984b6fbf37SCaroline Tice     if (strcasestr (short_help, search_word))
39930fdc8d8SChris Lattner         found_word = true;
4004b6fbf37SCaroline Tice     else if (strcasestr (long_help, search_word))
40130fdc8d8SChris Lattner         found_word = true;
4024b6fbf37SCaroline Tice     else if (strcasestr (syntax_help, search_word))
40330fdc8d8SChris Lattner         found_word = true;
40430fdc8d8SChris Lattner 
40530fdc8d8SChris Lattner     if (!found_word
40630fdc8d8SChris Lattner         && GetOptions() != NULL)
40730fdc8d8SChris Lattner     {
40830fdc8d8SChris Lattner         StreamString usage_help;
409a7015092SGreg Clayton         GetOptions()->GenerateOptionUsage (m_interpreter, usage_help, this);
41030fdc8d8SChris Lattner         if (usage_help.GetSize() > 0)
41130fdc8d8SChris Lattner         {
41230fdc8d8SChris Lattner             const char *usage_text = usage_help.GetData();
4134b6fbf37SCaroline Tice             if (strcasestr (usage_text, search_word))
41430fdc8d8SChris Lattner               found_word = true;
41530fdc8d8SChris Lattner         }
41630fdc8d8SChris Lattner     }
41730fdc8d8SChris Lattner 
41830fdc8d8SChris Lattner     return found_word;
41930fdc8d8SChris Lattner }
420e139cf23SCaroline Tice 
421e139cf23SCaroline Tice int
422e139cf23SCaroline Tice CommandObject::GetNumArgumentEntries  ()
423e139cf23SCaroline Tice {
424e139cf23SCaroline Tice     return m_arguments.size();
425e139cf23SCaroline Tice }
426e139cf23SCaroline Tice 
427e139cf23SCaroline Tice CommandObject::CommandArgumentEntry *
428e139cf23SCaroline Tice CommandObject::GetArgumentEntryAtIndex (int idx)
429e139cf23SCaroline Tice {
430e139cf23SCaroline Tice     if (idx < m_arguments.size())
431e139cf23SCaroline Tice         return &(m_arguments[idx]);
432e139cf23SCaroline Tice 
433e139cf23SCaroline Tice     return NULL;
434e139cf23SCaroline Tice }
435e139cf23SCaroline Tice 
436e139cf23SCaroline Tice CommandObject::ArgumentTableEntry *
437e139cf23SCaroline Tice CommandObject::FindArgumentDataByType (CommandArgumentType arg_type)
438e139cf23SCaroline Tice {
439e139cf23SCaroline Tice     const ArgumentTableEntry *table = CommandObject::GetArgumentTable();
440e139cf23SCaroline Tice 
441e139cf23SCaroline Tice     for (int i = 0; i < eArgTypeLastArg; ++i)
442e139cf23SCaroline Tice         if (table[i].arg_type == arg_type)
443e139cf23SCaroline Tice             return (ArgumentTableEntry *) &(table[i]);
444e139cf23SCaroline Tice 
445e139cf23SCaroline Tice     return NULL;
446e139cf23SCaroline Tice }
447e139cf23SCaroline Tice 
448e139cf23SCaroline Tice void
449e139cf23SCaroline Tice CommandObject::GetArgumentHelp (Stream &str, CommandArgumentType arg_type, CommandInterpreter &interpreter)
450e139cf23SCaroline Tice {
451e139cf23SCaroline Tice     const ArgumentTableEntry* table = CommandObject::GetArgumentTable();
452e139cf23SCaroline Tice     ArgumentTableEntry *entry = (ArgumentTableEntry *) &(table[arg_type]);
453e139cf23SCaroline Tice 
454e139cf23SCaroline Tice     // The table is *supposed* to be kept in arg_type order, but someone *could* have messed it up...
455e139cf23SCaroline Tice 
456e139cf23SCaroline Tice     if (entry->arg_type != arg_type)
457e139cf23SCaroline Tice         entry = CommandObject::FindArgumentDataByType (arg_type);
458e139cf23SCaroline Tice 
459e139cf23SCaroline Tice     if (!entry)
460e139cf23SCaroline Tice         return;
461e139cf23SCaroline Tice 
462e139cf23SCaroline Tice     StreamString name_str;
463e139cf23SCaroline Tice     name_str.Printf ("<%s>", entry->arg_name);
464e139cf23SCaroline Tice 
465e139cf23SCaroline Tice     if (entry->help_function != NULL)
466e139cf23SCaroline Tice         interpreter.OutputFormattedHelpText (str, name_str.GetData(), "--", (*(entry->help_function)) (),
467e139cf23SCaroline Tice                                              name_str.GetSize());
468e139cf23SCaroline Tice     else
469e139cf23SCaroline Tice         interpreter.OutputFormattedHelpText (str, name_str.GetData(), "--", entry->help_text, name_str.GetSize());
470e139cf23SCaroline Tice }
471e139cf23SCaroline Tice 
472e139cf23SCaroline Tice const char *
473e139cf23SCaroline Tice CommandObject::GetArgumentName (CommandArgumentType arg_type)
474e139cf23SCaroline Tice {
475deaab222SCaroline Tice     ArgumentTableEntry *entry = (ArgumentTableEntry *) &(CommandObject::GetArgumentTable()[arg_type]);
476deaab222SCaroline Tice 
477deaab222SCaroline Tice     // The table is *supposed* to be kept in arg_type order, but someone *could* have messed it up...
478deaab222SCaroline Tice 
479deaab222SCaroline Tice     if (entry->arg_type != arg_type)
480deaab222SCaroline Tice         entry = CommandObject::FindArgumentDataByType (arg_type);
481deaab222SCaroline Tice 
482e6acf355SJohnny Chen     if (entry)
483deaab222SCaroline Tice         return entry->arg_name;
484e6acf355SJohnny Chen 
485e6acf355SJohnny Chen     StreamString str;
486e6acf355SJohnny Chen     str << "Arg name for type (" << arg_type << ") not in arg table!";
487e6acf355SJohnny Chen     return str.GetData();
488e139cf23SCaroline Tice }
489e139cf23SCaroline Tice 
490405fe67fSCaroline Tice bool
491405fe67fSCaroline Tice CommandObject::IsPairType (lldb::ArgumentRepetitionType arg_repeat_type)
492405fe67fSCaroline Tice {
493405fe67fSCaroline Tice     if ((arg_repeat_type == eArgRepeatPairPlain)
494405fe67fSCaroline Tice         ||  (arg_repeat_type == eArgRepeatPairOptional)
495405fe67fSCaroline Tice         ||  (arg_repeat_type == eArgRepeatPairPlus)
496405fe67fSCaroline Tice         ||  (arg_repeat_type == eArgRepeatPairStar)
497405fe67fSCaroline Tice         ||  (arg_repeat_type == eArgRepeatPairRange)
498405fe67fSCaroline Tice         ||  (arg_repeat_type == eArgRepeatPairRangeOptional))
499405fe67fSCaroline Tice         return true;
500405fe67fSCaroline Tice 
501405fe67fSCaroline Tice     return false;
502405fe67fSCaroline Tice }
503405fe67fSCaroline Tice 
504e139cf23SCaroline Tice void
505e139cf23SCaroline Tice CommandObject::GetFormattedCommandArguments (Stream &str)
506e139cf23SCaroline Tice {
507e139cf23SCaroline Tice     int num_args = m_arguments.size();
508e139cf23SCaroline Tice     for (int i = 0; i < num_args; ++i)
509e139cf23SCaroline Tice     {
510e139cf23SCaroline Tice         if (i > 0)
511e139cf23SCaroline Tice             str.Printf (" ");
512e139cf23SCaroline Tice         CommandArgumentEntry arg_entry = m_arguments[i];
513e139cf23SCaroline Tice         int num_alternatives = arg_entry.size();
514405fe67fSCaroline Tice 
515405fe67fSCaroline Tice         if ((num_alternatives == 2)
516405fe67fSCaroline Tice             && IsPairType (arg_entry[0].arg_repetition))
517405fe67fSCaroline Tice         {
518405fe67fSCaroline Tice             const char *first_name = GetArgumentName (arg_entry[0].arg_type);
519405fe67fSCaroline Tice             const char *second_name = GetArgumentName (arg_entry[1].arg_type);
520405fe67fSCaroline Tice             switch (arg_entry[0].arg_repetition)
521405fe67fSCaroline Tice             {
522405fe67fSCaroline Tice                 case eArgRepeatPairPlain:
523405fe67fSCaroline Tice                     str.Printf ("<%s> <%s>", first_name, second_name);
524405fe67fSCaroline Tice                     break;
525405fe67fSCaroline Tice                 case eArgRepeatPairOptional:
526405fe67fSCaroline Tice                     str.Printf ("[<%s> <%s>]", first_name, second_name);
527405fe67fSCaroline Tice                     break;
528405fe67fSCaroline Tice                 case eArgRepeatPairPlus:
529405fe67fSCaroline Tice                     str.Printf ("<%s> <%s> [<%s> <%s> [...]]", first_name, second_name, first_name, second_name);
530405fe67fSCaroline Tice                     break;
531405fe67fSCaroline Tice                 case eArgRepeatPairStar:
532405fe67fSCaroline Tice                     str.Printf ("[<%s> <%s> [<%s> <%s> [...]]]", first_name, second_name, first_name, second_name);
533405fe67fSCaroline Tice                     break;
534405fe67fSCaroline Tice                 case eArgRepeatPairRange:
535405fe67fSCaroline Tice                     str.Printf ("<%s_1> <%s_1> ... <%s_n> <%s_n>", first_name, second_name, first_name, second_name);
536405fe67fSCaroline Tice                     break;
537405fe67fSCaroline Tice                 case eArgRepeatPairRangeOptional:
538405fe67fSCaroline Tice                     str.Printf ("[<%s_1> <%s_1> ... <%s_n> <%s_n>]", first_name, second_name, first_name, second_name);
539405fe67fSCaroline Tice                     break;
540405fe67fSCaroline Tice             }
541405fe67fSCaroline Tice         }
542405fe67fSCaroline Tice         else
543405fe67fSCaroline Tice         {
544e139cf23SCaroline Tice             StreamString names;
545e139cf23SCaroline Tice             for (int j = 0; j < num_alternatives; ++j)
546e139cf23SCaroline Tice             {
547e139cf23SCaroline Tice                 if (j > 0)
548e139cf23SCaroline Tice                     names.Printf (" | ");
549e139cf23SCaroline Tice                 names.Printf ("%s", GetArgumentName (arg_entry[j].arg_type));
550e139cf23SCaroline Tice             }
551e139cf23SCaroline Tice             switch (arg_entry[0].arg_repetition)
552e139cf23SCaroline Tice             {
553e139cf23SCaroline Tice                 case eArgRepeatPlain:
554e139cf23SCaroline Tice                     str.Printf ("<%s>", names.GetData());
555e139cf23SCaroline Tice                     break;
556e139cf23SCaroline Tice                 case eArgRepeatPlus:
557e139cf23SCaroline Tice                     str.Printf ("<%s> [<%s> [...]]", names.GetData(), names.GetData());
558e139cf23SCaroline Tice                     break;
559e139cf23SCaroline Tice                 case eArgRepeatStar:
560e139cf23SCaroline Tice                     str.Printf ("[<%s> [<%s> [...]]]", names.GetData(), names.GetData());
561e139cf23SCaroline Tice                     break;
562e139cf23SCaroline Tice                 case eArgRepeatOptional:
563e139cf23SCaroline Tice                     str.Printf ("[<%s>]", names.GetData());
564e139cf23SCaroline Tice                     break;
565405fe67fSCaroline Tice                 case eArgRepeatRange:
566405fe67fSCaroline Tice                     str.Printf ("<%s_1> .. <%s_n>", names.GetData());
567405fe67fSCaroline Tice             }
568e139cf23SCaroline Tice         }
569e139cf23SCaroline Tice     }
570e139cf23SCaroline Tice }
571e139cf23SCaroline Tice 
572e139cf23SCaroline Tice const CommandArgumentType
573e139cf23SCaroline Tice CommandObject::LookupArgumentName (const char *arg_name)
574e139cf23SCaroline Tice {
575e139cf23SCaroline Tice     CommandArgumentType return_type = eArgTypeLastArg;
576e139cf23SCaroline Tice 
577e139cf23SCaroline Tice     std::string arg_name_str (arg_name);
578e139cf23SCaroline Tice     size_t len = arg_name_str.length();
579e139cf23SCaroline Tice     if (arg_name[0] == '<'
580e139cf23SCaroline Tice         && arg_name[len-1] == '>')
581e139cf23SCaroline Tice         arg_name_str = arg_name_str.substr (1, len-2);
582e139cf23SCaroline Tice 
583e139cf23SCaroline Tice     for (int i = 0; i < eArgTypeLastArg; ++i)
584e139cf23SCaroline Tice         if (arg_name_str.compare (g_arguments_data[i].arg_name) == 0)
585e139cf23SCaroline Tice             return_type = g_arguments_data[i].arg_type;
586e139cf23SCaroline Tice 
587e139cf23SCaroline Tice     return return_type;
588e139cf23SCaroline Tice }
589e139cf23SCaroline Tice 
590e139cf23SCaroline Tice static const char *
591e139cf23SCaroline Tice BreakpointIDHelpTextCallback ()
592e139cf23SCaroline Tice {
593e139cf23SCaroline Tice     return "Breakpoint ID's consist major and minor numbers;  the major number corresponds to the single entity that was created with a 'breakpoint set' command; the minor numbers correspond to all the locations that were actually found/set based on the major breakpoint.  A full breakpoint ID might look like 3.14, meaning the 14th location set for the 3rd breakpoint.  You can specify all the locations of a breakpoint by just indicating the major breakpoint number. A valid breakpoint id consists either of just the major id number, or the major number, a dot, and the location number (e.g. 3 or 3.2 could both be valid breakpoint ids).";
594e139cf23SCaroline Tice }
595e139cf23SCaroline Tice 
596e139cf23SCaroline Tice static const char *
597e139cf23SCaroline Tice BreakpointIDRangeHelpTextCallback ()
598e139cf23SCaroline Tice {
599405fe67fSCaroline Tice     return "A 'breakpoint id list' is a manner of specifying multiple breakpoints. This can be done  through several mechanisms.  The easiest way is to just enter a space-separated list of breakpoint ids.  To specify all the breakpoint locations under a major breakpoint, you can use the major breakpoint number followed by '.*', eg. '5.*' means all the locations under breakpoint 5.  You can also indicate a range of breakpoints by using <start-bp-id> - <end-bp-id>.  The start-bp-id and end-bp-id for a range can be any valid breakpoint ids.  It is not legal, however, to specify a range using specific locations that cross major breakpoint numbers.  I.e. 3.2 - 3.7 is legal; 2 - 5 is legal; but 3.2 - 4.4 is not legal.";
600e139cf23SCaroline Tice }
601e139cf23SCaroline Tice 
602e139cf23SCaroline Tice CommandObject::ArgumentTableEntry
603e139cf23SCaroline Tice CommandObject::g_arguments_data[] =
604e139cf23SCaroline Tice {
605405fe67fSCaroline Tice     { eArgTypeAddress, "address", CommandCompletions::eNoCompletion, NULL, "A valid address in the target program's execution space." },
606405fe67fSCaroline Tice     { eArgTypeAliasName, "alias-name", CommandCompletions::eNoCompletion, NULL, "The name of an abbreviation (alias) for a debugger command." },
607405fe67fSCaroline Tice     { eArgTypeAliasOptions, "options-for-aliased-command", CommandCompletions::eNoCompletion, NULL, "Command options to be used as part of an alias (abbreviation) definition.  (See 'help commands alias' for more information.)" },
608405fe67fSCaroline Tice     { eArgTypeArchitecture, "arch", CommandCompletions::eNoCompletion, NULL, "The architecture name, e.g. i386 or x86_64." },
609deaab222SCaroline Tice     { eArgTypeBoolean, "boolean", CommandCompletions::eNoCompletion, NULL, "A Boolean value: 'true' or 'false'" },
610405fe67fSCaroline Tice     { eArgTypeBreakpointID, "breakpt-id", CommandCompletions::eNoCompletion, BreakpointIDHelpTextCallback, NULL },
611405fe67fSCaroline Tice     { eArgTypeBreakpointIDRange, "breakpt-id-list", CommandCompletions::eNoCompletion, BreakpointIDRangeHelpTextCallback, NULL },
612405fe67fSCaroline Tice     { eArgTypeByteSize, "byte-size", CommandCompletions::eNoCompletion, NULL, "Number of bytes to use." },
613405fe67fSCaroline Tice     { eArgTypeCommandName, "cmd-name", CommandCompletions::eNoCompletion, NULL, "A debugger command (may be multiple words), without any options or arguments." },
614deaab222SCaroline Tice     { eArgTypeCount, "count", CommandCompletions::eNoCompletion, NULL, "An unsigned integer." },
615405fe67fSCaroline Tice     { eArgTypeEndAddress, "end-address", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
616405fe67fSCaroline Tice     { eArgTypeExpression, "expr", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
617deaab222SCaroline Tice     { eArgTypeExprFormat, "expression-format", CommandCompletions::eNoCompletion, NULL, "[ [bool|b] | [bin] | [char|c] | [oct|o] | [dec|i|d|u] | [hex|x] | [float|f] | [cstr|s] ]" },
618deaab222SCaroline Tice     { eArgTypeFilename, "filename", CommandCompletions::eNoCompletion, NULL, "The name of a file (can include path)." },
619e139cf23SCaroline Tice     { eArgTypeFormat, "format", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
620405fe67fSCaroline Tice     { eArgTypeFrameIndex, "frame-index", CommandCompletions::eNoCompletion, NULL, "Index into a thread's list of frames." },
621405fe67fSCaroline Tice     { eArgTypeFullName, "fullname", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
622405fe67fSCaroline Tice     { eArgTypeFunctionName, "function-name", CommandCompletions::eNoCompletion, NULL, "The name of a function." },
623405fe67fSCaroline Tice     { eArgTypeIndex, "index", CommandCompletions::eNoCompletion, NULL, "An index into a list." },
624405fe67fSCaroline Tice     { eArgTypeLineNum, "linenum", CommandCompletions::eNoCompletion, NULL, "Line number in a source file." },
625405fe67fSCaroline Tice     { eArgTypeLogChannel, "log-channel", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
626405fe67fSCaroline Tice     { eArgTypeMethod, "method", CommandCompletions::eNoCompletion, NULL, "A C++ method name." },
627e139cf23SCaroline Tice     { eArgTypeName, "name", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
628405fe67fSCaroline Tice     { eArgTypeNewPathPrefix, "new-path-prefix", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
629405fe67fSCaroline Tice     { eArgTypeNumLines, "num-lines", CommandCompletions::eNoCompletion, NULL, "The number of lines to use." },
630405fe67fSCaroline Tice     { eArgTypeNumberPerLine, "number-per-line", CommandCompletions::eNoCompletion, NULL, "The number of items per line to display." },
631e139cf23SCaroline Tice     { eArgTypeOffset, "offset", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
632405fe67fSCaroline Tice     { eArgTypeOldPathPrefix, "old-path-prefix", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
633deaab222SCaroline Tice     { eArgTypeOneLiner, "one-line-breakpoint-command", CommandCompletions::eNoCompletion, NULL, "A breakpoint command that is entered as a single line of text." },
634e139cf23SCaroline Tice     { eArgTypePath, "path", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
635405fe67fSCaroline Tice     { eArgTypePid, "pid", CommandCompletions::eNoCompletion, NULL, "The process ID number." },
636e139cf23SCaroline Tice     { eArgTypePlugin, "plugin", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
637405fe67fSCaroline Tice     { eArgTypeProcessName, "process-name", CommandCompletions::eNoCompletion, NULL, "The name of the process." },
638405fe67fSCaroline Tice     { eArgTypeQueueName, "queue-name", CommandCompletions::eNoCompletion, NULL, "The name of the thread queue." },
639405fe67fSCaroline Tice     { eArgTypeRegisterName, "register-name", CommandCompletions::eNoCompletion, NULL, "A register name." },
640405fe67fSCaroline Tice     { eArgTypeRegularExpression, "regular-expression", CommandCompletions::eNoCompletion, NULL, "A regular expression." },
641405fe67fSCaroline Tice     { eArgTypeRunArgs, "run-args", CommandCompletions::eNoCompletion, NULL, "Arguments to be passed to the target program when it starts executing." },
642e139cf23SCaroline Tice     { eArgTypeRunMode, "run-mode", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
643405fe67fSCaroline Tice     { eArgTypeScriptLang, "script-language", CommandCompletions::eNoCompletion, NULL, "The scripting language to be used for script-based commands.  Currently only Python is valid." },
644405fe67fSCaroline Tice     { eArgTypeSearchWord, "search-word", CommandCompletions::eNoCompletion, NULL, "The word for which you wish to search for information about." },
645405fe67fSCaroline Tice     { eArgTypeSelector, "selector", CommandCompletions::eNoCompletion, NULL, "An Objective-C selector name." },
646405fe67fSCaroline Tice     { eArgTypeSettingIndex, "setting-index", CommandCompletions::eNoCompletion, NULL, "An index into a settings variable that is an array (try 'settings list' to see all the possible settings variables and their types)." },
647405fe67fSCaroline Tice     { eArgTypeSettingKey, "setting-key", CommandCompletions::eNoCompletion, NULL, "A key into a settings variables that is a dictionary (try 'settings list' to see all the possible settings variables and their types)." },
648405fe67fSCaroline Tice     { eArgTypeSettingPrefix, "setting-prefix", CommandCompletions::eNoCompletion, NULL, "The name of a settable internal debugger variable up to a dot ('.'), e.g. 'target.process.'" },
649405fe67fSCaroline Tice     { eArgTypeSettingVariableName, "setting-variable-name", CommandCompletions::eNoCompletion, NULL, "The name of a settable internal debugger variable.  Type 'settings list' to see a complete list of such variables." },
650405fe67fSCaroline Tice     { eArgTypeShlibName, "shlib-name", CommandCompletions::eNoCompletion, NULL, "The name of a shared library." },
651405fe67fSCaroline Tice     { eArgTypeSourceFile, "source-file", CommandCompletions::eNoCompletion, NULL, "The name of a source file.." },
652237cd906SGreg Clayton     { eArgTypeSortOrder, "sort-order", CommandCompletions::eNoCompletion, NULL, "Specify a sort order when dumping lists." },
653e139cf23SCaroline Tice     { eArgTypeStartAddress, "start-address", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
654405fe67fSCaroline Tice     { eArgTypeSymbol, "symbol", CommandCompletions::eNoCompletion, NULL, "Any symbol name (function name, variable, argument, etc.)" },
655405fe67fSCaroline Tice     { eArgTypeThreadID, "thread-id", CommandCompletions::eNoCompletion, NULL, "Thread ID number." },
656405fe67fSCaroline Tice     { eArgTypeThreadIndex, "thread-index", CommandCompletions::eNoCompletion, NULL, "Index into the process' list of threads." },
657405fe67fSCaroline Tice     { eArgTypeThreadName, "thread-name", CommandCompletions::eNoCompletion, NULL, "The thread's name." },
658*c0dbdfb6SCaroline Tice     { eArgTypeUnixSignal, "unix-signal", CommandCompletions::eNoCompletion, NULL, "A valid Unix signal name or number (e.g. SIGKILL, KILL or 9)." },
659405fe67fSCaroline Tice     { eArgTypeVarName, "variable-name", CommandCompletions::eNoCompletion, NULL, "The name of a variable in your program." },
660405fe67fSCaroline Tice     { eArgTypeValue, "value", CommandCompletions::eNoCompletion, NULL, "A value could be anything, depending on where and how it is used." },
661e139cf23SCaroline Tice     { eArgTypeWidth, "width", CommandCompletions::eNoCompletion, NULL, "Help text goes here." },
662405fe67fSCaroline Tice     { eArgTypeNone, "none", CommandCompletions::eNoCompletion, NULL, "No help available for this." },
663e139cf23SCaroline Tice };
664e139cf23SCaroline Tice 
665e139cf23SCaroline Tice const CommandObject::ArgumentTableEntry*
666e139cf23SCaroline Tice CommandObject::GetArgumentTable ()
667e139cf23SCaroline Tice {
668e139cf23SCaroline Tice     return CommandObject::g_arguments_data;
669e139cf23SCaroline Tice }
670e139cf23SCaroline Tice 
671e139cf23SCaroline Tice 
672