xref: /openbsd-src/gnu/llvm/lldb/source/Interpreter/CommandAlias.cpp (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1dda28197Spatrick //===-- CommandAlias.cpp --------------------------------------------------===//
2061da546Spatrick //
3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information.
5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6061da546Spatrick //
7061da546Spatrick //===----------------------------------------------------------------------===//
8061da546Spatrick 
9061da546Spatrick #include "lldb/Interpreter/CommandAlias.h"
10061da546Spatrick 
11061da546Spatrick #include "llvm/Support/ErrorHandling.h"
12061da546Spatrick 
13061da546Spatrick #include "lldb/Interpreter/CommandInterpreter.h"
14061da546Spatrick #include "lldb/Interpreter/CommandObject.h"
15061da546Spatrick #include "lldb/Interpreter/CommandReturnObject.h"
16061da546Spatrick #include "lldb/Interpreter/Options.h"
17061da546Spatrick #include "lldb/Utility/StreamString.h"
18061da546Spatrick 
19061da546Spatrick using namespace lldb;
20061da546Spatrick using namespace lldb_private;
21061da546Spatrick 
ProcessAliasOptionsArgs(lldb::CommandObjectSP & cmd_obj_sp,llvm::StringRef options_args,OptionArgVectorSP & option_arg_vector_sp)22061da546Spatrick static bool ProcessAliasOptionsArgs(lldb::CommandObjectSP &cmd_obj_sp,
23061da546Spatrick                                     llvm::StringRef options_args,
24061da546Spatrick                                     OptionArgVectorSP &option_arg_vector_sp) {
25061da546Spatrick   bool success = true;
26061da546Spatrick   OptionArgVector *option_arg_vector = option_arg_vector_sp.get();
27061da546Spatrick 
28061da546Spatrick   if (options_args.size() < 1)
29061da546Spatrick     return true;
30061da546Spatrick 
31061da546Spatrick   Args args(options_args);
32061da546Spatrick   std::string options_string(options_args);
33061da546Spatrick   // TODO: Find a way to propagate errors in this CommandReturnObject up the
34061da546Spatrick   // stack.
35dda28197Spatrick   CommandReturnObject result(false);
36061da546Spatrick   // Check to see if the command being aliased can take any command options.
37061da546Spatrick   Options *options = cmd_obj_sp->GetOptions();
38061da546Spatrick   if (options) {
39061da546Spatrick     // See if any options were specified as part of the alias;  if so, handle
40061da546Spatrick     // them appropriately.
41061da546Spatrick     ExecutionContext exe_ctx =
42061da546Spatrick         cmd_obj_sp->GetCommandInterpreter().GetExecutionContext();
43061da546Spatrick     options->NotifyOptionParsingStarting(&exe_ctx);
44061da546Spatrick 
45061da546Spatrick     llvm::Expected<Args> args_or =
46061da546Spatrick         options->ParseAlias(args, option_arg_vector, options_string);
47061da546Spatrick     if (!args_or) {
48061da546Spatrick       result.AppendError(toString(args_or.takeError()));
49061da546Spatrick       result.AppendError("Unable to create requested alias.\n");
50061da546Spatrick       return false;
51061da546Spatrick     }
52061da546Spatrick     args = std::move(*args_or);
53061da546Spatrick     options->VerifyPartialOptions(result);
54061da546Spatrick     if (!result.Succeeded() &&
55061da546Spatrick         result.GetStatus() != lldb::eReturnStatusStarted) {
56061da546Spatrick       result.AppendError("Unable to create requested alias.\n");
57061da546Spatrick       return false;
58061da546Spatrick     }
59061da546Spatrick   }
60061da546Spatrick 
61061da546Spatrick   if (!options_string.empty()) {
62061da546Spatrick     if (cmd_obj_sp->WantsRawCommandString())
63*f6aab3d8Srobert       option_arg_vector->emplace_back(CommandInterpreter::g_argument,
64*f6aab3d8Srobert                                       -1, options_string);
65061da546Spatrick     else {
66061da546Spatrick       for (auto &entry : args.entries()) {
67061da546Spatrick         if (!entry.ref().empty())
68*f6aab3d8Srobert           option_arg_vector->emplace_back(std::string(CommandInterpreter::g_argument), -1,
69061da546Spatrick                                           std::string(entry.ref()));
70061da546Spatrick       }
71061da546Spatrick     }
72061da546Spatrick   }
73061da546Spatrick 
74061da546Spatrick   return success;
75061da546Spatrick }
76061da546Spatrick 
CommandAlias(CommandInterpreter & interpreter,lldb::CommandObjectSP cmd_sp,llvm::StringRef options_args,llvm::StringRef name,llvm::StringRef help,llvm::StringRef syntax,uint32_t flags)77061da546Spatrick CommandAlias::CommandAlias(CommandInterpreter &interpreter,
78061da546Spatrick                            lldb::CommandObjectSP cmd_sp,
79061da546Spatrick                            llvm::StringRef options_args, llvm::StringRef name,
80061da546Spatrick                            llvm::StringRef help, llvm::StringRef syntax,
81061da546Spatrick                            uint32_t flags)
82061da546Spatrick     : CommandObject(interpreter, name, help, syntax, flags),
83be691f3bSpatrick       m_option_string(std::string(options_args)),
84061da546Spatrick       m_option_args_sp(new OptionArgVector),
85061da546Spatrick       m_is_dashdash_alias(eLazyBoolCalculate), m_did_set_help(false),
86061da546Spatrick       m_did_set_help_long(false) {
87061da546Spatrick   if (ProcessAliasOptionsArgs(cmd_sp, options_args, m_option_args_sp)) {
88061da546Spatrick     m_underlying_command_sp = cmd_sp;
89061da546Spatrick     for (int i = 0;
90061da546Spatrick          auto cmd_entry = m_underlying_command_sp->GetArgumentEntryAtIndex(i);
91061da546Spatrick          i++) {
92061da546Spatrick       m_arguments.push_back(*cmd_entry);
93061da546Spatrick     }
94061da546Spatrick     if (!help.empty()) {
95061da546Spatrick       StreamString sstr;
96061da546Spatrick       StreamString translation_and_help;
97061da546Spatrick       GetAliasExpansion(sstr);
98061da546Spatrick 
99061da546Spatrick       translation_and_help.Printf(
100061da546Spatrick           "(%s)  %s", sstr.GetData(),
101061da546Spatrick           GetUnderlyingCommand()->GetHelp().str().c_str());
102061da546Spatrick       SetHelp(translation_and_help.GetString());
103061da546Spatrick     }
104061da546Spatrick   }
105061da546Spatrick }
106061da546Spatrick 
WantsRawCommandString()107061da546Spatrick bool CommandAlias::WantsRawCommandString() {
108061da546Spatrick   if (IsValid())
109061da546Spatrick     return m_underlying_command_sp->WantsRawCommandString();
110061da546Spatrick   return false;
111061da546Spatrick }
112061da546Spatrick 
WantsCompletion()113061da546Spatrick bool CommandAlias::WantsCompletion() {
114061da546Spatrick   if (IsValid())
115061da546Spatrick     return m_underlying_command_sp->WantsCompletion();
116061da546Spatrick   return false;
117061da546Spatrick }
118061da546Spatrick 
HandleCompletion(CompletionRequest & request)119061da546Spatrick void CommandAlias::HandleCompletion(CompletionRequest &request) {
120061da546Spatrick   if (IsValid())
121061da546Spatrick     m_underlying_command_sp->HandleCompletion(request);
122061da546Spatrick }
123061da546Spatrick 
HandleArgumentCompletion(CompletionRequest & request,OptionElementVector & opt_element_vector)124061da546Spatrick void CommandAlias::HandleArgumentCompletion(
125061da546Spatrick     CompletionRequest &request, OptionElementVector &opt_element_vector) {
126061da546Spatrick   if (IsValid())
127061da546Spatrick     m_underlying_command_sp->HandleArgumentCompletion(request,
128061da546Spatrick                                                       opt_element_vector);
129061da546Spatrick }
130061da546Spatrick 
GetOptions()131061da546Spatrick Options *CommandAlias::GetOptions() {
132061da546Spatrick   if (IsValid())
133061da546Spatrick     return m_underlying_command_sp->GetOptions();
134061da546Spatrick   return nullptr;
135061da546Spatrick }
136061da546Spatrick 
Execute(const char * args_string,CommandReturnObject & result)137061da546Spatrick bool CommandAlias::Execute(const char *args_string,
138061da546Spatrick                            CommandReturnObject &result) {
139061da546Spatrick   llvm_unreachable("CommandAlias::Execute is not to be called");
140061da546Spatrick }
141061da546Spatrick 
GetAliasExpansion(StreamString & help_string) const142061da546Spatrick void CommandAlias::GetAliasExpansion(StreamString &help_string) const {
143061da546Spatrick   llvm::StringRef command_name = m_underlying_command_sp->GetCommandName();
144061da546Spatrick   help_string.Printf("'%*s", (int)command_name.size(), command_name.data());
145061da546Spatrick 
146061da546Spatrick   if (!m_option_args_sp) {
147061da546Spatrick     help_string.Printf("'");
148061da546Spatrick     return;
149061da546Spatrick   }
150061da546Spatrick 
151061da546Spatrick   OptionArgVector *options = m_option_args_sp.get();
152061da546Spatrick   std::string opt;
153061da546Spatrick   std::string value;
154061da546Spatrick 
155061da546Spatrick   for (const auto &opt_entry : *options) {
156061da546Spatrick     std::tie(opt, std::ignore, value) = opt_entry;
157*f6aab3d8Srobert     if (opt == CommandInterpreter::g_argument) {
158061da546Spatrick       help_string.Printf(" %s", value.c_str());
159061da546Spatrick     } else {
160061da546Spatrick       help_string.Printf(" %s", opt.c_str());
161*f6aab3d8Srobert       if ((value != CommandInterpreter::g_no_argument)
162*f6aab3d8Srobert            && (value != CommandInterpreter::g_need_argument)) {
163061da546Spatrick         help_string.Printf(" %s", value.c_str());
164061da546Spatrick       }
165061da546Spatrick     }
166061da546Spatrick   }
167061da546Spatrick 
168061da546Spatrick   help_string.Printf("'");
169061da546Spatrick }
170061da546Spatrick 
IsDashDashCommand()171061da546Spatrick bool CommandAlias::IsDashDashCommand() {
172061da546Spatrick   if (m_is_dashdash_alias != eLazyBoolCalculate)
173061da546Spatrick     return (m_is_dashdash_alias == eLazyBoolYes);
174061da546Spatrick   m_is_dashdash_alias = eLazyBoolNo;
175061da546Spatrick   if (!IsValid())
176061da546Spatrick     return false;
177061da546Spatrick 
178061da546Spatrick   std::string opt;
179061da546Spatrick   std::string value;
180061da546Spatrick 
181061da546Spatrick   for (const auto &opt_entry : *GetOptionArguments()) {
182061da546Spatrick     std::tie(opt, std::ignore, value) = opt_entry;
183*f6aab3d8Srobert     if (opt == CommandInterpreter::g_argument && !value.empty() &&
184061da546Spatrick         llvm::StringRef(value).endswith("--")) {
185061da546Spatrick       m_is_dashdash_alias = eLazyBoolYes;
186061da546Spatrick       break;
187061da546Spatrick     }
188061da546Spatrick   }
189061da546Spatrick 
190061da546Spatrick   // if this is a nested alias, it may be adding arguments on top of an already
191061da546Spatrick   // dash-dash alias
192061da546Spatrick   if ((m_is_dashdash_alias == eLazyBoolNo) && IsNestedAlias())
193061da546Spatrick     m_is_dashdash_alias =
194061da546Spatrick         (GetUnderlyingCommand()->IsDashDashCommand() ? eLazyBoolYes
195061da546Spatrick                                                      : eLazyBoolNo);
196061da546Spatrick   return (m_is_dashdash_alias == eLazyBoolYes);
197061da546Spatrick }
198061da546Spatrick 
IsNestedAlias()199061da546Spatrick bool CommandAlias::IsNestedAlias() {
200061da546Spatrick   if (GetUnderlyingCommand())
201061da546Spatrick     return GetUnderlyingCommand()->IsAlias();
202061da546Spatrick   return false;
203061da546Spatrick }
204061da546Spatrick 
Desugar()205061da546Spatrick std::pair<lldb::CommandObjectSP, OptionArgVectorSP> CommandAlias::Desugar() {
206061da546Spatrick   auto underlying = GetUnderlyingCommand();
207061da546Spatrick   if (!underlying)
208061da546Spatrick     return {nullptr, nullptr};
209061da546Spatrick 
210061da546Spatrick   if (underlying->IsAlias()) {
211*f6aab3d8Srobert     // FIXME: This doesn't work if the original alias fills a slot in the
212*f6aab3d8Srobert     // underlying alias, since this just appends the two lists.
213061da546Spatrick     auto desugared = ((CommandAlias *)underlying.get())->Desugar();
214061da546Spatrick     auto options = GetOptionArguments();
215061da546Spatrick     options->insert(options->begin(), desugared.second->begin(),
216061da546Spatrick                     desugared.second->end());
217061da546Spatrick     return {desugared.first, options};
218061da546Spatrick   }
219061da546Spatrick 
220061da546Spatrick   return {underlying, GetOptionArguments()};
221061da546Spatrick }
222061da546Spatrick 
223061da546Spatrick // allow CommandAlias objects to provide their own help, but fallback to the
224061da546Spatrick // info for the underlying command if no customization has been provided
SetHelp(llvm::StringRef str)225061da546Spatrick void CommandAlias::SetHelp(llvm::StringRef str) {
226061da546Spatrick   this->CommandObject::SetHelp(str);
227061da546Spatrick   m_did_set_help = true;
228061da546Spatrick }
229061da546Spatrick 
SetHelpLong(llvm::StringRef str)230061da546Spatrick void CommandAlias::SetHelpLong(llvm::StringRef str) {
231061da546Spatrick   this->CommandObject::SetHelpLong(str);
232061da546Spatrick   m_did_set_help_long = true;
233061da546Spatrick }
234061da546Spatrick 
GetHelp()235061da546Spatrick llvm::StringRef CommandAlias::GetHelp() {
236061da546Spatrick   if (!m_cmd_help_short.empty() || m_did_set_help)
237061da546Spatrick     return m_cmd_help_short;
238061da546Spatrick   if (IsValid())
239061da546Spatrick     return m_underlying_command_sp->GetHelp();
240061da546Spatrick   return llvm::StringRef();
241061da546Spatrick }
242061da546Spatrick 
GetHelpLong()243061da546Spatrick llvm::StringRef CommandAlias::GetHelpLong() {
244061da546Spatrick   if (!m_cmd_help_long.empty() || m_did_set_help_long)
245061da546Spatrick     return m_cmd_help_long;
246061da546Spatrick   if (IsValid())
247061da546Spatrick     return m_underlying_command_sp->GetHelpLong();
248061da546Spatrick   return llvm::StringRef();
249061da546Spatrick }
250