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 | |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 28 | CommandObjectHelp::CommandObjectHelp (CommandInterpreter &interpreter) : |
| 29 | CommandObject (interpreter, |
| 30 | "help", |
Caroline Tice | c1ad82e | 2010-09-07 22:38:08 +0000 | [diff] [blame] | 31 | "Show a list of all debugger commands, or give details about specific commands.", |
Greg Clayton | 54e7afa | 2010-07-09 20:39:50 +0000 | [diff] [blame] | 32 | "help [<cmd-name>]") |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 33 | { |
Caroline Tice | 43b014a | 2010-10-04 22:28:36 +0000 | [diff] [blame] | 34 | CommandArgumentEntry arg; |
| 35 | CommandArgumentData command_arg; |
| 36 | |
| 37 | // Define the first (and only) variant of this arg. |
| 38 | command_arg.arg_type = eArgTypeCommandName; |
| 39 | command_arg.arg_repetition = eArgRepeatStar; |
| 40 | |
| 41 | // There is only one variant this argument could be; put it into the argument entry. |
| 42 | arg.push_back (command_arg); |
| 43 | |
| 44 | // Push the data for the first argument into the m_arguments vector. |
| 45 | m_arguments.push_back (arg); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | CommandObjectHelp::~CommandObjectHelp() |
| 49 | { |
| 50 | } |
| 51 | |
| 52 | |
| 53 | bool |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 54 | CommandObjectHelp::Execute (Args& command, CommandReturnObject &result) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 55 | { |
| 56 | CommandObject::CommandMap::iterator pos; |
| 57 | CommandObject *cmd_obj; |
| 58 | const int argc = command.GetArgumentCount (); |
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 | // 'help' doesn't take any options or arguments, other than command names. If argc is 0, we show the user |
| 61 | // 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] | 62 | if (argc == 0) |
| 63 | { |
| 64 | result.SetStatus (eReturnStatusSuccessFinishNoResult); |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 65 | m_interpreter.GetHelp (result); // General help, for ALL commands. |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 66 | } |
| 67 | else |
| 68 | { |
| 69 | // Get command object for the first command argument. Only search built-in command dictionary. |
Jim Ingham | d40f8a6 | 2010-07-06 22:46:59 +0000 | [diff] [blame] | 70 | StringList matches; |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 71 | cmd_obj = m_interpreter.GetCommandObject (command.GetArgumentAtIndex (0), &matches); |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 72 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 73 | if (cmd_obj != NULL) |
| 74 | { |
| 75 | bool all_okay = true; |
| 76 | CommandObject *sub_cmd_obj = cmd_obj; |
| 77 | // Loop down through sub_command dictionaries until we find the command object that corresponds |
| 78 | // to the help command entered. |
| 79 | for (int i = 1; i < argc && all_okay; ++i) |
| 80 | { |
| 81 | std::string sub_command = command.GetArgumentAtIndex(i); |
| 82 | if (! sub_cmd_obj->IsMultiwordObject ()) |
| 83 | { |
| 84 | all_okay = false; |
| 85 | } |
| 86 | else |
| 87 | { |
| 88 | pos = ((CommandObjectMultiword *) sub_cmd_obj)->m_subcommand_dict.find (sub_command); |
| 89 | if (pos != ((CommandObjectMultiword *) sub_cmd_obj)->m_subcommand_dict.end()) |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 90 | sub_cmd_obj = pos->second.get(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 91 | else |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 92 | all_okay = false; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 93 | } |
| 94 | } |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 95 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 96 | if (!all_okay || (sub_cmd_obj == NULL)) |
| 97 | { |
| 98 | std::string cmd_string; |
| 99 | command.GetCommandString (cmd_string); |
| 100 | result.AppendErrorWithFormat |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 101 | ("'%s' is not a known command.\nTry 'help' to see a current list of commands.\n", |
| 102 | cmd_string.c_str()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 103 | result.SetStatus (eReturnStatusFailed); |
| 104 | } |
| 105 | else |
| 106 | { |
| 107 | Stream &output_strm = result.GetOutputStream(); |
| 108 | if (sub_cmd_obj->GetOptions() != NULL) |
| 109 | { |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 110 | if (sub_cmd_obj->WantsRawCommandString()) |
| 111 | { |
| 112 | std::string help_text (sub_cmd_obj->GetHelp()); |
| 113 | help_text.append (" This command takes 'raw' input (no need to quote stuff)."); |
| 114 | m_interpreter.OutputFormattedHelpText (output_strm, "", "", help_text.c_str(), 1); |
| 115 | } |
| 116 | else |
| 117 | m_interpreter.OutputFormattedHelpText (output_strm, "", "", sub_cmd_obj->GetHelp(), 1); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 118 | output_strm.Printf ("\nSyntax: %s\n", sub_cmd_obj->GetSyntax()); |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 119 | sub_cmd_obj->GetOptions()->GenerateOptionUsage (m_interpreter, output_strm, sub_cmd_obj); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 120 | const char *long_help = sub_cmd_obj->GetHelpLong(); |
| 121 | if ((long_help != NULL) |
| 122 | && (strlen (long_help) > 0)) |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 123 | output_strm.Printf ("\n%s", long_help); |
Johnny Chen | 8e46859 | 2010-10-08 17:21:27 +0000 | [diff] [blame^] | 124 | // Mark this help command with a success status. |
| 125 | result.SetStatus (eReturnStatusSuccessFinishNoResult); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 126 | } |
| 127 | else if (sub_cmd_obj->IsMultiwordObject()) |
| 128 | { |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 129 | if (sub_cmd_obj->WantsRawCommandString()) |
| 130 | { |
| 131 | std::string help_text (sub_cmd_obj->GetHelp()); |
| 132 | help_text.append (" This command takes 'raw' input (no need to quote stuff)."); |
| 133 | m_interpreter.OutputFormattedHelpText (output_strm, "", "", help_text.c_str(), 1); |
| 134 | } |
| 135 | else |
| 136 | m_interpreter.OutputFormattedHelpText (output_strm, "", "", sub_cmd_obj->GetHelp(), 1); |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 137 | ((CommandObjectMultiword *) sub_cmd_obj)->GenerateHelpText (result); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 138 | } |
| 139 | else |
| 140 | { |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 141 | const char *long_help = sub_cmd_obj->GetHelpLong(); |
| 142 | if ((long_help != NULL) |
| 143 | && (strlen (long_help) > 0)) |
Caroline Tice | abb507a | 2010-09-08 21:06:11 +0000 | [diff] [blame] | 144 | output_strm.Printf ("\n%s", long_help); |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 145 | else if (sub_cmd_obj->WantsRawCommandString()) |
| 146 | { |
| 147 | std::string help_text (sub_cmd_obj->GetHelp()); |
| 148 | help_text.append (" This command takes 'raw' input (no need to quote stuff)."); |
| 149 | m_interpreter.OutputFormattedHelpText (output_strm, "", "", help_text.c_str(), 1); |
| 150 | } |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 151 | else |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 152 | m_interpreter.OutputFormattedHelpText (output_strm, "", "", sub_cmd_obj->GetHelp(), 1); |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 153 | output_strm.Printf ("\nSyntax: %s\n", sub_cmd_obj->GetSyntax()); |
Johnny Chen | 8e46859 | 2010-10-08 17:21:27 +0000 | [diff] [blame^] | 154 | // Mark this help command with a success status. |
| 155 | result.SetStatus (eReturnStatusSuccessFinishNoResult); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 156 | } |
| 157 | } |
| 158 | } |
Jim Ingham | d40f8a6 | 2010-07-06 22:46:59 +0000 | [diff] [blame] | 159 | else if (matches.GetSize() > 0) |
| 160 | { |
| 161 | Stream &output_strm = result.GetOutputStream(); |
| 162 | output_strm.Printf("Help requested with ambiguous command name, possible completions:\n"); |
Greg Clayton | 54e7afa | 2010-07-09 20:39:50 +0000 | [diff] [blame] | 163 | const uint32_t match_count = matches.GetSize(); |
| 164 | for (uint32_t i = 0; i < match_count; i++) |
Jim Ingham | d40f8a6 | 2010-07-06 22:46:59 +0000 | [diff] [blame] | 165 | { |
| 166 | output_strm.Printf("\t%s\n", matches.GetStringAtIndex(i)); |
| 167 | } |
| 168 | } |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 169 | else |
| 170 | { |
Caroline Tice | fb35511 | 2010-10-01 17:46:38 +0000 | [diff] [blame] | 171 | // Maybe the user is asking for help about a command argument rather than a command. |
| 172 | const CommandArgumentType arg_type = CommandObject::LookupArgumentName (command.GetArgumentAtIndex (0)); |
| 173 | if (arg_type != eArgTypeLastArg) |
| 174 | { |
| 175 | Stream &output_strm = result.GetOutputStream (); |
| 176 | CommandObject::GetArgumentHelp (output_strm, arg_type, m_interpreter); |
| 177 | result.SetStatus (eReturnStatusSuccessFinishNoResult); |
| 178 | } |
| 179 | else |
| 180 | { |
| 181 | result.AppendErrorWithFormat |
| 182 | ("'%s' is not a known command.\nTry 'help' to see a current list of commands.\n", |
| 183 | command.GetArgumentAtIndex(0)); |
| 184 | result.SetStatus (eReturnStatusFailed); |
| 185 | } |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 186 | } |
| 187 | } |
Greg Clayton | 63094e0 | 2010-06-23 01:19:29 +0000 | [diff] [blame] | 188 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 189 | return result.Succeeded(); |
| 190 | } |
| 191 | |
| 192 | int |
| 193 | CommandObjectHelp::HandleCompletion |
| 194 | ( |
| 195 | Args &input, |
| 196 | int &cursor_index, |
| 197 | int &cursor_char_position, |
| 198 | int match_start_point, |
| 199 | int max_return_elements, |
Jim Ingham | 802f8b0 | 2010-06-30 05:02:46 +0000 | [diff] [blame] | 200 | bool &word_complete, |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 201 | StringList &matches |
| 202 | ) |
| 203 | { |
| 204 | // Return the completions of the commands in the help system: |
| 205 | if (cursor_index == 0) |
| 206 | { |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 207 | return m_interpreter.HandleCompletionMatches (input, |
| 208 | cursor_index, |
| 209 | cursor_char_position, |
| 210 | match_start_point, |
| 211 | max_return_elements, |
| 212 | word_complete, |
| 213 | matches); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 214 | } |
| 215 | else |
| 216 | { |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 217 | CommandObject *cmd_obj = m_interpreter.GetCommandObject (input.GetArgumentAtIndex(0)); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 218 | input.Shift(); |
| 219 | cursor_index--; |
Greg Clayton | 238c0a1 | 2010-09-18 01:14:36 +0000 | [diff] [blame] | 220 | return cmd_obj->HandleCompletion (input, |
| 221 | cursor_index, |
| 222 | cursor_char_position, |
| 223 | match_start_point, |
| 224 | max_return_elements, |
| 225 | word_complete, |
| 226 | matches); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 227 | } |
| 228 | } |