Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 1 | //===-- CommandObjectHelp.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 "CommandObjectHelp.h" |
| 11 | |
| 12 | // C Includes |
| 13 | // C++ Includes |
| 14 | // Other libraries and framework includes |
| 15 | // Project includes |
| 16 | #include "lldb/Interpreter/CommandObjectMultiword.h" |
| 17 | #include "lldb/Interpreter/CommandInterpreter.h" |
Jim Ingham | 84cdc15 | 2010-06-15 19:49:27 +0000 | [diff] [blame] | 18 | #include "lldb/Interpreter/Options.h" |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 19 | #include "lldb/Interpreter/CommandReturnObject.h" |
| 20 | |
| 21 | using namespace lldb; |
| 22 | using namespace lldb_private; |
| 23 | |
| 24 | //------------------------------------------------------------------------- |
| 25 | // CommandObjectHelp |
| 26 | //------------------------------------------------------------------------- |
| 27 | |
| 28 | CommandObjectHelp::CommandObjectHelp () : |
| 29 | CommandObject ("help", |
| 30 | "Shows a list of all debugger commands, or give details about specific commands.", |
| 31 | "help [<cmd-name>]") |
| 32 | { |
| 33 | } |
| 34 | |
| 35 | CommandObjectHelp::~CommandObjectHelp() |
| 36 | { |
| 37 | } |
| 38 | |
| 39 | |
| 40 | bool |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 41 | CommandObjectHelp::Execute (CommandInterpreter &interpreter, Args& command, CommandReturnObject &result) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 42 | { |
| 43 | CommandObject::CommandMap::iterator pos; |
| 44 | CommandObject *cmd_obj; |
| 45 | const int argc = command.GetArgumentCount (); |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 46 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 47 | // 'help' doesn't take any options or arguments, other than command names. If argc is 0, we show the user |
| 48 | // all commands and aliases. Otherwise every argument must be the name of a command or a sub-command. |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 49 | if (argc == 0) |
| 50 | { |
| 51 | result.SetStatus (eReturnStatusSuccessFinishNoResult); |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 52 | interpreter.GetHelp (result); // General help, for ALL commands. |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 53 | } |
| 54 | else |
| 55 | { |
| 56 | // Get command object for the first command argument. Only search built-in command dictionary. |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 57 | cmd_obj = interpreter.GetCommandObject (command.GetArgumentAtIndex (0), false, false); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 58 | if (cmd_obj == NULL) |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 59 | { |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 60 | // That failed, so now search in the aliases dictionary, too. |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 61 | cmd_obj = interpreter.GetCommandObject (command.GetArgumentAtIndex (0), true, false); |
| 62 | } |
| 63 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 64 | if (cmd_obj != NULL) |
| 65 | { |
| 66 | bool all_okay = true; |
| 67 | CommandObject *sub_cmd_obj = cmd_obj; |
| 68 | // Loop down through sub_command dictionaries until we find the command object that corresponds |
| 69 | // to the help command entered. |
| 70 | for (int i = 1; i < argc && all_okay; ++i) |
| 71 | { |
| 72 | std::string sub_command = command.GetArgumentAtIndex(i); |
| 73 | if (! sub_cmd_obj->IsMultiwordObject ()) |
| 74 | { |
| 75 | all_okay = false; |
| 76 | } |
| 77 | else |
| 78 | { |
| 79 | pos = ((CommandObjectMultiword *) sub_cmd_obj)->m_subcommand_dict.find (sub_command); |
| 80 | if (pos != ((CommandObjectMultiword *) sub_cmd_obj)->m_subcommand_dict.end()) |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 81 | sub_cmd_obj = pos->second.get(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 82 | else |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 83 | all_okay = false; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 84 | } |
| 85 | } |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 86 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 87 | if (!all_okay || (sub_cmd_obj == NULL)) |
| 88 | { |
| 89 | std::string cmd_string; |
| 90 | command.GetCommandString (cmd_string); |
| 91 | result.AppendErrorWithFormat |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 92 | ("'%s' is not a known command.\nTry 'help' to see a current list of commands.\n", |
| 93 | cmd_string.c_str()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 94 | result.SetStatus (eReturnStatusFailed); |
| 95 | } |
| 96 | else |
| 97 | { |
| 98 | Stream &output_strm = result.GetOutputStream(); |
| 99 | if (sub_cmd_obj->GetOptions() != NULL) |
| 100 | { |
| 101 | output_strm.Printf ("%s\n", sub_cmd_obj->GetHelp()); |
| 102 | output_strm.Printf ("\nSyntax: %s\n", sub_cmd_obj->GetSyntax()); |
| 103 | sub_cmd_obj->GetOptions()->GenerateOptionUsage (output_strm, sub_cmd_obj); |
| 104 | const char *long_help = sub_cmd_obj->GetHelpLong(); |
| 105 | if ((long_help != NULL) |
| 106 | && (strlen (long_help) > 0)) |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 107 | output_strm.Printf ("\n%s", long_help); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 108 | } |
| 109 | else if (sub_cmd_obj->IsMultiwordObject()) |
| 110 | { |
| 111 | output_strm.Printf ("%s\n", sub_cmd_obj->GetHelp()); |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 112 | ((CommandObjectMultiword *) sub_cmd_obj)->GenerateHelpText (interpreter, result); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 113 | } |
| 114 | else |
| 115 | { |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 116 | const char *long_help = sub_cmd_obj->GetHelpLong(); |
| 117 | if ((long_help != NULL) |
| 118 | && (strlen (long_help) > 0)) |
| 119 | output_strm.Printf ("%s", long_help); |
| 120 | else |
| 121 | output_strm.Printf ("%s\n", sub_cmd_obj->GetHelp()); |
| 122 | output_strm.Printf ("\nSyntax: %s\n", sub_cmd_obj->GetSyntax()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 123 | } |
| 124 | } |
| 125 | } |
| 126 | else |
| 127 | { |
| 128 | result.AppendErrorWithFormat |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 129 | ("'%s' is not a known command.\nTry 'help' to see a current list of commands.\n", |
| 130 | command.GetArgumentAtIndex(0)); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 131 | result.SetStatus (eReturnStatusFailed); |
| 132 | } |
| 133 | } |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 134 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 135 | return result.Succeeded(); |
| 136 | } |
| 137 | |
| 138 | int |
| 139 | CommandObjectHelp::HandleCompletion |
| 140 | ( |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 141 | CommandInterpreter &interpreter, |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 142 | Args &input, |
| 143 | int &cursor_index, |
| 144 | int &cursor_char_position, |
| 145 | int match_start_point, |
| 146 | int max_return_elements, |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame^] | 147 | bool &word_complete, |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 148 | StringList &matches |
| 149 | ) |
| 150 | { |
| 151 | // Return the completions of the commands in the help system: |
| 152 | if (cursor_index == 0) |
| 153 | { |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame^] | 154 | return interpreter.HandleCompletionMatches(input, cursor_index, cursor_char_position, match_start_point, |
| 155 | max_return_elements, word_complete, matches); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 156 | } |
| 157 | else |
| 158 | { |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 159 | CommandObject *cmd_obj = interpreter.GetCommandObject (input.GetArgumentAtIndex(0), true, false); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 160 | input.Shift(); |
| 161 | cursor_index--; |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame^] | 162 | return cmd_obj->HandleCompletion (interpreter, input, cursor_index, cursor_char_position, match_start_point, |
| 163 | max_return_elements, word_complete, matches); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 164 | } |
| 165 | } |