180814287SRaphael Isemann //===-- CommandCompletions.cpp --------------------------------------------===// 2c9af18a5SGreg Clayton // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6c9af18a5SGreg Clayton // 7c9af18a5SGreg Clayton //===----------------------------------------------------------------------===// 8c9af18a5SGreg Clayton 9c8ecc2a9SEugene Zelenko #include "llvm/ADT/SmallString.h" 102cc5a18dSZachary Turner #include "llvm/ADT/StringSet.h" 11c8ecc2a9SEugene Zelenko 129b62fd2fSGreg Clayton #include "lldb/Core/FileSpecList.h" 131f746071SGreg Clayton #include "lldb/Core/Module.h" 14190fadcdSZachary Turner #include "lldb/Core/PluginManager.h" 15190fadcdSZachary Turner #include "lldb/Host/FileSystem.h" 169b62fd2fSGreg Clayton #include "lldb/Interpreter/CommandCompletions.h" 179b62fd2fSGreg Clayton #include "lldb/Interpreter/CommandInterpreter.h" 18633a29cfSZachary Turner #include "lldb/Interpreter/OptionValueProperties.h" 191f746071SGreg Clayton #include "lldb/Symbol/CompileUnit.h" 20f21feadcSGreg Clayton #include "lldb/Symbol/Variable.h" 213ce57e01SGongyu Deng #include "lldb/Target/Language.h" 22a14f4a75SGongyu Deng #include "lldb/Target/RegisterContext.h" 2366fa73faSGongyu Deng #include "lldb/Target/Thread.h" 245713a05bSZachary Turner #include "lldb/Utility/FileSpec.h" 252f3df613SZachary Turner #include "lldb/Utility/StreamString.h" 262cc5a18dSZachary Turner #include "lldb/Utility/TildeExpressionResolver.h" 27c9af18a5SGreg Clayton 287d86ee5aSZachary Turner #include "llvm/Support/FileSystem.h" 292cc5a18dSZachary Turner #include "llvm/Support/Path.h" 30190fadcdSZachary Turner 31c9af18a5SGreg Clayton using namespace lldb_private; 32c9af18a5SGreg Clayton 33440460f1SRaphael Isemann // This is the command completion callback that is used to complete the 34440460f1SRaphael Isemann // argument of the option it is bound to (in the OptionDefinition table 35440460f1SRaphael Isemann // below). 36440460f1SRaphael Isemann typedef void (*CompletionCallback)(CommandInterpreter &interpreter, 37440460f1SRaphael Isemann CompletionRequest &request, 38440460f1SRaphael Isemann // A search filter to limit the search... 39440460f1SRaphael Isemann lldb_private::SearchFilter *searcher); 40440460f1SRaphael Isemann 41440460f1SRaphael Isemann struct CommonCompletionElement { 42440460f1SRaphael Isemann uint32_t type; 43440460f1SRaphael Isemann CompletionCallback callback; 44440460f1SRaphael Isemann }; 45440460f1SRaphael Isemann 46440460f1SRaphael Isemann bool CommandCompletions::InvokeCommonCompletionCallbacks( 47440460f1SRaphael Isemann CommandInterpreter &interpreter, uint32_t completion_mask, 48440460f1SRaphael Isemann CompletionRequest &request, SearchFilter *searcher) { 49440460f1SRaphael Isemann bool handled = false; 50440460f1SRaphael Isemann 51440460f1SRaphael Isemann const CommonCompletionElement common_completions[] = { 52c9af18a5SGreg Clayton {eSourceFileCompletion, CommandCompletions::SourceFiles}, 53558ce124SJim Ingham {eDiskFileCompletion, CommandCompletions::DiskFiles}, 54558ce124SJim Ingham {eDiskDirectoryCompletion, CommandCompletions::DiskDirectories}, 55c9af18a5SGreg Clayton {eSymbolCompletion, CommandCompletions::Symbols}, 56c9af18a5SGreg Clayton {eModuleCompletion, CommandCompletions::Modules}, 57419f1be7SGongyu Deng {eModuleUUIDCompletion, CommandCompletions::ModuleUUIDs}, 583df9a8dfSCaroline Tice {eSettingsNameCompletion, CommandCompletions::SettingsNames}, 59ab65b34fSGreg Clayton {ePlatformPluginCompletion, CommandCompletions::PlatformPluginNames}, 60ab65b34fSGreg Clayton {eArchitectureCompletion, CommandCompletions::ArchitectureNames}, 61f21feadcSGreg Clayton {eVariablePathCompletion, CommandCompletions::VariablePath}, 62a14f4a75SGongyu Deng {eRegisterCompletion, CommandCompletions::Registers}, 630e50b9a4SGongyu Deng {eBreakpointCompletion, CommandCompletions::Breakpoints}, 64763bc230SGongyu Deng {eProcessPluginCompletion, CommandCompletions::ProcessPluginNames}, 658a5e2969SGongyu Deng {eDisassemblyFlavorCompletion, CommandCompletions::DisassemblyFlavors}, 663ce57e01SGongyu Deng {eTypeLanguageCompletion, CommandCompletions::TypeLanguages}, 6766fa73faSGongyu Deng {eFrameIndexCompletion, CommandCompletions::FrameIndexes}, 68*b2b7dbb4SGongyu Deng {eStopHookIDCompletion, CommandCompletions::StopHookIDs}, 69c8ecc2a9SEugene Zelenko {eNoCompletion, nullptr} // This one has to be last in the list. 70c9af18a5SGreg Clayton }; 71c9af18a5SGreg Clayton 72b9c1b51eSKate Stone for (int i = 0;; i++) { 73440460f1SRaphael Isemann if (common_completions[i].type == eNoCompletion) 74c9af18a5SGreg Clayton break; 75440460f1SRaphael Isemann else if ((common_completions[i].type & completion_mask) == 76440460f1SRaphael Isemann common_completions[i].type && 77440460f1SRaphael Isemann common_completions[i].callback != nullptr) { 78c9af18a5SGreg Clayton handled = true; 79440460f1SRaphael Isemann common_completions[i].callback(interpreter, request, searcher); 80c9af18a5SGreg Clayton } 81c9af18a5SGreg Clayton } 82c9af18a5SGreg Clayton return handled; 83c9af18a5SGreg Clayton } 84c9af18a5SGreg Clayton 85572fc897SRaphael Isemann namespace { 86572fc897SRaphael Isemann // The Completer class is a convenient base class for building searchers that 87572fc897SRaphael Isemann // go along with the SearchFilter passed to the standard Completer functions. 88572fc897SRaphael Isemann class Completer : public Searcher { 89572fc897SRaphael Isemann public: 90572fc897SRaphael Isemann Completer(CommandInterpreter &interpreter, CompletionRequest &request) 91572fc897SRaphael Isemann : m_interpreter(interpreter), m_request(request) {} 92572fc897SRaphael Isemann 93572fc897SRaphael Isemann ~Completer() override = default; 94572fc897SRaphael Isemann 95572fc897SRaphael Isemann CallbackReturn SearchCallback(SearchFilter &filter, SymbolContext &context, 96572fc897SRaphael Isemann Address *addr) override = 0; 97572fc897SRaphael Isemann 98572fc897SRaphael Isemann lldb::SearchDepth GetDepth() override = 0; 99572fc897SRaphael Isemann 100572fc897SRaphael Isemann virtual void DoCompletion(SearchFilter *filter) = 0; 101572fc897SRaphael Isemann 102572fc897SRaphael Isemann protected: 103572fc897SRaphael Isemann CommandInterpreter &m_interpreter; 104572fc897SRaphael Isemann CompletionRequest &m_request; 105572fc897SRaphael Isemann 106572fc897SRaphael Isemann private: 107eaebcbc6SKonrad Kleine Completer(const Completer &) = delete; 108eaebcbc6SKonrad Kleine const Completer &operator=(const Completer &) = delete; 109572fc897SRaphael Isemann }; 110572fc897SRaphael Isemann } // namespace 111572fc897SRaphael Isemann 112572fc897SRaphael Isemann // SourceFileCompleter implements the source file completer 113572fc897SRaphael Isemann namespace { 114572fc897SRaphael Isemann class SourceFileCompleter : public Completer { 115572fc897SRaphael Isemann public: 116572fc897SRaphael Isemann SourceFileCompleter(CommandInterpreter &interpreter, 117572fc897SRaphael Isemann CompletionRequest &request) 118572fc897SRaphael Isemann : Completer(interpreter, request), m_matching_files() { 119572fc897SRaphael Isemann FileSpec partial_spec(m_request.GetCursorArgumentPrefix()); 120572fc897SRaphael Isemann m_file_name = partial_spec.GetFilename().GetCString(); 121572fc897SRaphael Isemann m_dir_name = partial_spec.GetDirectory().GetCString(); 122572fc897SRaphael Isemann } 123572fc897SRaphael Isemann 124572fc897SRaphael Isemann lldb::SearchDepth GetDepth() override { return lldb::eSearchDepthCompUnit; } 125572fc897SRaphael Isemann 126572fc897SRaphael Isemann Searcher::CallbackReturn SearchCallback(SearchFilter &filter, 127572fc897SRaphael Isemann SymbolContext &context, 128572fc897SRaphael Isemann Address *addr) override { 129572fc897SRaphael Isemann if (context.comp_unit != nullptr) { 130572fc897SRaphael Isemann const char *cur_file_name = 131572fc897SRaphael Isemann context.comp_unit->GetPrimaryFile().GetFilename().GetCString(); 132572fc897SRaphael Isemann const char *cur_dir_name = 133572fc897SRaphael Isemann context.comp_unit->GetPrimaryFile().GetDirectory().GetCString(); 134572fc897SRaphael Isemann 135572fc897SRaphael Isemann bool match = false; 136572fc897SRaphael Isemann if (m_file_name && cur_file_name && 137572fc897SRaphael Isemann strstr(cur_file_name, m_file_name) == cur_file_name) 138572fc897SRaphael Isemann match = true; 139572fc897SRaphael Isemann 140572fc897SRaphael Isemann if (match && m_dir_name && cur_dir_name && 141572fc897SRaphael Isemann strstr(cur_dir_name, m_dir_name) != cur_dir_name) 142572fc897SRaphael Isemann match = false; 143572fc897SRaphael Isemann 144572fc897SRaphael Isemann if (match) { 145572fc897SRaphael Isemann m_matching_files.AppendIfUnique(context.comp_unit->GetPrimaryFile()); 146572fc897SRaphael Isemann } 147572fc897SRaphael Isemann } 148572fc897SRaphael Isemann return Searcher::eCallbackReturnContinue; 149572fc897SRaphael Isemann } 150572fc897SRaphael Isemann 151572fc897SRaphael Isemann void DoCompletion(SearchFilter *filter) override { 152572fc897SRaphael Isemann filter->Search(*this); 153572fc897SRaphael Isemann // Now convert the filelist to completions: 154572fc897SRaphael Isemann for (size_t i = 0; i < m_matching_files.GetSize(); i++) { 155572fc897SRaphael Isemann m_request.AddCompletion( 156572fc897SRaphael Isemann m_matching_files.GetFileSpecAtIndex(i).GetFilename().GetCString()); 157572fc897SRaphael Isemann } 158572fc897SRaphael Isemann } 159572fc897SRaphael Isemann 160572fc897SRaphael Isemann private: 161572fc897SRaphael Isemann FileSpecList m_matching_files; 162572fc897SRaphael Isemann const char *m_file_name; 163572fc897SRaphael Isemann const char *m_dir_name; 164572fc897SRaphael Isemann 165eaebcbc6SKonrad Kleine SourceFileCompleter(const SourceFileCompleter &) = delete; 166eaebcbc6SKonrad Kleine const SourceFileCompleter &operator=(const SourceFileCompleter &) = delete; 167572fc897SRaphael Isemann }; 168572fc897SRaphael Isemann } // namespace 169572fc897SRaphael Isemann 170572fc897SRaphael Isemann static bool regex_chars(const char comp) { 171572fc897SRaphael Isemann return llvm::StringRef("[](){}+.*|^$\\?").contains(comp); 172572fc897SRaphael Isemann } 173572fc897SRaphael Isemann 174572fc897SRaphael Isemann namespace { 175572fc897SRaphael Isemann class SymbolCompleter : public Completer { 176572fc897SRaphael Isemann 177572fc897SRaphael Isemann public: 178572fc897SRaphael Isemann SymbolCompleter(CommandInterpreter &interpreter, CompletionRequest &request) 179572fc897SRaphael Isemann : Completer(interpreter, request) { 180572fc897SRaphael Isemann std::string regex_str; 181572fc897SRaphael Isemann if (!m_request.GetCursorArgumentPrefix().empty()) { 182572fc897SRaphael Isemann regex_str.append("^"); 183572fc897SRaphael Isemann regex_str.append(std::string(m_request.GetCursorArgumentPrefix())); 184572fc897SRaphael Isemann } else { 185572fc897SRaphael Isemann // Match anything since the completion string is empty 186572fc897SRaphael Isemann regex_str.append("."); 187572fc897SRaphael Isemann } 188572fc897SRaphael Isemann std::string::iterator pos = 189572fc897SRaphael Isemann find_if(regex_str.begin() + 1, regex_str.end(), regex_chars); 190572fc897SRaphael Isemann while (pos < regex_str.end()) { 191572fc897SRaphael Isemann pos = regex_str.insert(pos, '\\'); 192572fc897SRaphael Isemann pos = find_if(pos + 2, regex_str.end(), regex_chars); 193572fc897SRaphael Isemann } 194572fc897SRaphael Isemann m_regex = RegularExpression(regex_str); 195572fc897SRaphael Isemann } 196572fc897SRaphael Isemann 197572fc897SRaphael Isemann lldb::SearchDepth GetDepth() override { return lldb::eSearchDepthModule; } 198572fc897SRaphael Isemann 199572fc897SRaphael Isemann Searcher::CallbackReturn SearchCallback(SearchFilter &filter, 200572fc897SRaphael Isemann SymbolContext &context, 201572fc897SRaphael Isemann Address *addr) override { 202572fc897SRaphael Isemann if (context.module_sp) { 203572fc897SRaphael Isemann SymbolContextList sc_list; 204572fc897SRaphael Isemann const bool include_symbols = true; 205572fc897SRaphael Isemann const bool include_inlines = true; 206572fc897SRaphael Isemann context.module_sp->FindFunctions(m_regex, include_symbols, 207572fc897SRaphael Isemann include_inlines, sc_list); 208572fc897SRaphael Isemann 209572fc897SRaphael Isemann SymbolContext sc; 210572fc897SRaphael Isemann // Now add the functions & symbols to the list - only add if unique: 211572fc897SRaphael Isemann for (uint32_t i = 0; i < sc_list.GetSize(); i++) { 212572fc897SRaphael Isemann if (sc_list.GetContextAtIndex(i, sc)) { 213572fc897SRaphael Isemann ConstString func_name = sc.GetFunctionName(Mangled::ePreferDemangled); 214572fc897SRaphael Isemann // Ensure that the function name matches the regex. This is more than 215572fc897SRaphael Isemann // a sanity check. It is possible that the demangled function name 216572fc897SRaphael Isemann // does not start with the prefix, for example when it's in an 217572fc897SRaphael Isemann // anonymous namespace. 218572fc897SRaphael Isemann if (!func_name.IsEmpty() && m_regex.Execute(func_name.GetStringRef())) 219572fc897SRaphael Isemann m_match_set.insert(func_name); 220572fc897SRaphael Isemann } 221572fc897SRaphael Isemann } 222572fc897SRaphael Isemann } 223572fc897SRaphael Isemann return Searcher::eCallbackReturnContinue; 224572fc897SRaphael Isemann } 225572fc897SRaphael Isemann 226572fc897SRaphael Isemann void DoCompletion(SearchFilter *filter) override { 227572fc897SRaphael Isemann filter->Search(*this); 228572fc897SRaphael Isemann collection::iterator pos = m_match_set.begin(), end = m_match_set.end(); 229572fc897SRaphael Isemann for (pos = m_match_set.begin(); pos != end; pos++) 230572fc897SRaphael Isemann m_request.AddCompletion((*pos).GetCString()); 231572fc897SRaphael Isemann } 232572fc897SRaphael Isemann 233572fc897SRaphael Isemann private: 234572fc897SRaphael Isemann RegularExpression m_regex; 235572fc897SRaphael Isemann typedef std::set<ConstString> collection; 236572fc897SRaphael Isemann collection m_match_set; 237572fc897SRaphael Isemann 238eaebcbc6SKonrad Kleine SymbolCompleter(const SymbolCompleter &) = delete; 239eaebcbc6SKonrad Kleine const SymbolCompleter &operator=(const SymbolCompleter &) = delete; 240572fc897SRaphael Isemann }; 241572fc897SRaphael Isemann } // namespace 242572fc897SRaphael Isemann 243572fc897SRaphael Isemann namespace { 244572fc897SRaphael Isemann class ModuleCompleter : public Completer { 245572fc897SRaphael Isemann public: 246572fc897SRaphael Isemann ModuleCompleter(CommandInterpreter &interpreter, CompletionRequest &request) 247572fc897SRaphael Isemann : Completer(interpreter, request) { 248572fc897SRaphael Isemann FileSpec partial_spec(m_request.GetCursorArgumentPrefix()); 249572fc897SRaphael Isemann m_file_name = partial_spec.GetFilename().GetCString(); 250572fc897SRaphael Isemann m_dir_name = partial_spec.GetDirectory().GetCString(); 251572fc897SRaphael Isemann } 252572fc897SRaphael Isemann 253572fc897SRaphael Isemann lldb::SearchDepth GetDepth() override { return lldb::eSearchDepthModule; } 254572fc897SRaphael Isemann 255572fc897SRaphael Isemann Searcher::CallbackReturn SearchCallback(SearchFilter &filter, 256572fc897SRaphael Isemann SymbolContext &context, 257572fc897SRaphael Isemann Address *addr) override { 258572fc897SRaphael Isemann if (context.module_sp) { 259572fc897SRaphael Isemann const char *cur_file_name = 260572fc897SRaphael Isemann context.module_sp->GetFileSpec().GetFilename().GetCString(); 261572fc897SRaphael Isemann const char *cur_dir_name = 262572fc897SRaphael Isemann context.module_sp->GetFileSpec().GetDirectory().GetCString(); 263572fc897SRaphael Isemann 264572fc897SRaphael Isemann bool match = false; 265572fc897SRaphael Isemann if (m_file_name && cur_file_name && 266572fc897SRaphael Isemann strstr(cur_file_name, m_file_name) == cur_file_name) 267572fc897SRaphael Isemann match = true; 268572fc897SRaphael Isemann 269572fc897SRaphael Isemann if (match && m_dir_name && cur_dir_name && 270572fc897SRaphael Isemann strstr(cur_dir_name, m_dir_name) != cur_dir_name) 271572fc897SRaphael Isemann match = false; 272572fc897SRaphael Isemann 273572fc897SRaphael Isemann if (match) { 274572fc897SRaphael Isemann m_request.AddCompletion(cur_file_name); 275572fc897SRaphael Isemann } 276572fc897SRaphael Isemann } 277572fc897SRaphael Isemann return Searcher::eCallbackReturnContinue; 278572fc897SRaphael Isemann } 279572fc897SRaphael Isemann 280572fc897SRaphael Isemann void DoCompletion(SearchFilter *filter) override { filter->Search(*this); } 281572fc897SRaphael Isemann 282572fc897SRaphael Isemann private: 283572fc897SRaphael Isemann const char *m_file_name; 284572fc897SRaphael Isemann const char *m_dir_name; 285572fc897SRaphael Isemann 286eaebcbc6SKonrad Kleine ModuleCompleter(const ModuleCompleter &) = delete; 287eaebcbc6SKonrad Kleine const ModuleCompleter &operator=(const ModuleCompleter &) = delete; 288572fc897SRaphael Isemann }; 289572fc897SRaphael Isemann } // namespace 290572fc897SRaphael Isemann 291ae34ed2cSRaphael Isemann void CommandCompletions::SourceFiles(CommandInterpreter &interpreter, 292a2e76c0bSRaphael Isemann CompletionRequest &request, 293a2e76c0bSRaphael Isemann SearchFilter *searcher) { 29462174682SRaphael Isemann SourceFileCompleter completer(interpreter, request); 295c9af18a5SGreg Clayton 296b9c1b51eSKate Stone if (searcher == nullptr) { 2972976d00aSJim Ingham lldb::TargetSP target_sp = interpreter.GetDebugger().GetSelectedTarget(); 29833df7cd3SJim Ingham SearchFilterForUnconstrainedSearches null_searcher(target_sp); 299c9af18a5SGreg Clayton completer.DoCompletion(&null_searcher); 300b9c1b51eSKate Stone } else { 301c9af18a5SGreg Clayton completer.DoCompletion(searcher); 302c9af18a5SGreg Clayton } 303c9af18a5SGreg Clayton } 304c9af18a5SGreg Clayton 305ae34ed2cSRaphael Isemann static void DiskFilesOrDirectories(const llvm::Twine &partial_name, 3065edee822SRaphael Isemann bool only_directories, 3075edee822SRaphael Isemann CompletionRequest &request, 3082cc5a18dSZachary Turner TildeExpressionResolver &Resolver) { 3092cc5a18dSZachary Turner llvm::SmallString<256> CompletionBuffer; 3102cc5a18dSZachary Turner llvm::SmallString<256> Storage; 3112cc5a18dSZachary Turner partial_name.toVector(CompletionBuffer); 312b2f1fb29SVirgile Bello 3132cc5a18dSZachary Turner if (CompletionBuffer.size() >= PATH_MAX) 314ae34ed2cSRaphael Isemann return; 315b2f1fb29SVirgile Bello 3162cc5a18dSZachary Turner namespace path = llvm::sys::path; 317b2f1fb29SVirgile Bello 3182cc5a18dSZachary Turner llvm::StringRef SearchDir; 3192cc5a18dSZachary Turner llvm::StringRef PartialItem; 3202cc5a18dSZachary Turner 3212cc5a18dSZachary Turner if (CompletionBuffer.startswith("~")) { 3222cc5a18dSZachary Turner llvm::StringRef Buffer(CompletionBuffer); 3235c5091fcSZachary Turner size_t FirstSep = 3245c5091fcSZachary Turner Buffer.find_if([](char c) { return path::is_separator(c); }); 3252cc5a18dSZachary Turner 3262cc5a18dSZachary Turner llvm::StringRef Username = Buffer.take_front(FirstSep); 3272cc5a18dSZachary Turner llvm::StringRef Remainder; 3282cc5a18dSZachary Turner if (FirstSep != llvm::StringRef::npos) 3292cc5a18dSZachary Turner Remainder = Buffer.drop_front(FirstSep + 1); 3302cc5a18dSZachary Turner 331b3f44ad9SStella Stamenova llvm::SmallString<256> Resolved; 3322cc5a18dSZachary Turner if (!Resolver.ResolveExact(Username, Resolved)) { 3332cc5a18dSZachary Turner // We couldn't resolve it as a full username. If there were no slashes 3342cc5a18dSZachary Turner // then this might be a partial username. We try to resolve it as such 3352cc5a18dSZachary Turner // but after that, we're done regardless of any matches. 3362cc5a18dSZachary Turner if (FirstSep == llvm::StringRef::npos) { 3372cc5a18dSZachary Turner llvm::StringSet<> MatchSet; 338a2e76c0bSRaphael Isemann Resolver.ResolvePartial(Username, MatchSet); 3392cc5a18dSZachary Turner for (const auto &S : MatchSet) { 3402cc5a18dSZachary Turner Resolved = S.getKey(); 3412cc5a18dSZachary Turner path::append(Resolved, path::get_separator()); 3425edee822SRaphael Isemann request.AddCompletion(Resolved, "", CompletionMode::Partial); 343b2f1fb29SVirgile Bello } 344b2f1fb29SVirgile Bello } 345ae34ed2cSRaphael Isemann return; 3462cc5a18dSZachary Turner } 3470734e6a5SZachary Turner 34805097246SAdrian Prantl // If there was no trailing slash, then we're done as soon as we resolve 34905097246SAdrian Prantl // the expression to the correct directory. Otherwise we need to continue 3502cc5a18dSZachary Turner // looking for matches within that directory. 3512cc5a18dSZachary Turner if (FirstSep == llvm::StringRef::npos) { 3522cc5a18dSZachary Turner // Make sure it ends with a separator. 3532cc5a18dSZachary Turner path::append(CompletionBuffer, path::get_separator()); 3545edee822SRaphael Isemann request.AddCompletion(CompletionBuffer, "", CompletionMode::Partial); 355ae34ed2cSRaphael Isemann return; 3562cc5a18dSZachary Turner } 3572cc5a18dSZachary Turner 3582cc5a18dSZachary Turner // We want to keep the form the user typed, so we special case this to 3592cc5a18dSZachary Turner // search in the fully resolved directory, but CompletionBuffer keeps the 3602cc5a18dSZachary Turner // unmodified form that the user typed. 3612cc5a18dSZachary Turner Storage = Resolved; 36288ec2e4eSPavel Labath llvm::StringRef RemainderDir = path::parent_path(Remainder); 3634621e0b0SRaphael Isemann if (!RemainderDir.empty()) { 3644621e0b0SRaphael Isemann // Append the remaining path to the resolved directory. 3654621e0b0SRaphael Isemann Storage.append(path::get_separator()); 3664621e0b0SRaphael Isemann Storage.append(RemainderDir); 3674621e0b0SRaphael Isemann } 36817843885SRaphael Isemann SearchDir = Storage; 3690734e6a5SZachary Turner } else { 3702cc5a18dSZachary Turner SearchDir = path::parent_path(CompletionBuffer); 3712cc5a18dSZachary Turner } 3722cc5a18dSZachary Turner 3732cc5a18dSZachary Turner size_t FullPrefixLen = CompletionBuffer.size(); 3742cc5a18dSZachary Turner 3752cc5a18dSZachary Turner PartialItem = path::filename(CompletionBuffer); 37678a10a7aSFrederic Riss 37778a10a7aSFrederic Riss // path::filename() will return "." when the passed path ends with a 37878a10a7aSFrederic Riss // directory separator. We have to filter those out, but only when the 37978a10a7aSFrederic Riss // "." doesn't come from the completion request itself. 38078a10a7aSFrederic Riss if (PartialItem == "." && path::is_separator(CompletionBuffer.back())) 3812cc5a18dSZachary Turner PartialItem = llvm::StringRef(); 3822cc5a18dSZachary Turner 383426d1379SZachary Turner if (SearchDir.empty()) { 384426d1379SZachary Turner llvm::sys::fs::current_path(Storage); 385426d1379SZachary Turner SearchDir = Storage; 386426d1379SZachary Turner } 3872cc5a18dSZachary Turner assert(!PartialItem.contains(path::get_separator())); 3882cc5a18dSZachary Turner 3892cc5a18dSZachary Turner // SearchDir now contains the directory to search in, and Prefix contains the 3902cc5a18dSZachary Turner // text we want to match against items in that directory. 3912cc5a18dSZachary Turner 392edaf2bccSJonas Devlieghere FileSystem &fs = FileSystem::Instance(); 3932cc5a18dSZachary Turner std::error_code EC; 394edaf2bccSJonas Devlieghere llvm::vfs::directory_iterator Iter = fs.DirBegin(SearchDir, EC); 395edaf2bccSJonas Devlieghere llvm::vfs::directory_iterator End; 3962cc5a18dSZachary Turner for (; Iter != End && !EC; Iter.increment(EC)) { 3972cc5a18dSZachary Turner auto &Entry = *Iter; 398edaf2bccSJonas Devlieghere llvm::ErrorOr<llvm::vfs::Status> Status = fs.GetStatus(Entry.path()); 399edaf2bccSJonas Devlieghere 400edaf2bccSJonas Devlieghere if (!Status) 401edaf2bccSJonas Devlieghere continue; 4022cc5a18dSZachary Turner 4032cc5a18dSZachary Turner auto Name = path::filename(Entry.path()); 4042cc5a18dSZachary Turner 4052cc5a18dSZachary Turner // Omit ".", ".." 4062cc5a18dSZachary Turner if (Name == "." || Name == ".." || !Name.startswith(PartialItem)) 4072cc5a18dSZachary Turner continue; 4082cc5a18dSZachary Turner 409edaf2bccSJonas Devlieghere bool is_dir = Status->isDirectory(); 4102cc5a18dSZachary Turner 4112cc5a18dSZachary Turner // If it's a symlink, then we treat it as a directory as long as the target 4122cc5a18dSZachary Turner // is a directory. 413edaf2bccSJonas Devlieghere if (Status->isSymlink()) { 414edaf2bccSJonas Devlieghere FileSpec symlink_filespec(Entry.path()); 415edaf2bccSJonas Devlieghere FileSpec resolved_filespec; 416edaf2bccSJonas Devlieghere auto error = fs.ResolveSymbolicLink(symlink_filespec, resolved_filespec); 417edaf2bccSJonas Devlieghere if (error.Success()) 418edaf2bccSJonas Devlieghere is_dir = fs.IsDirectory(symlink_filespec); 4192cc5a18dSZachary Turner } 420edaf2bccSJonas Devlieghere 4212cc5a18dSZachary Turner if (only_directories && !is_dir) 4222cc5a18dSZachary Turner continue; 4232cc5a18dSZachary Turner 4242cc5a18dSZachary Turner // Shrink it back down so that it just has the original prefix the user 4252cc5a18dSZachary Turner // typed and remove the part of the name which is common to the located 4262cc5a18dSZachary Turner // item and what the user typed. 4272cc5a18dSZachary Turner CompletionBuffer.resize(FullPrefixLen); 4282cc5a18dSZachary Turner Name = Name.drop_front(PartialItem.size()); 4292cc5a18dSZachary Turner CompletionBuffer.append(Name); 4302cc5a18dSZachary Turner 4312cc5a18dSZachary Turner if (is_dir) { 4322cc5a18dSZachary Turner path::append(CompletionBuffer, path::get_separator()); 4330734e6a5SZachary Turner } 4340734e6a5SZachary Turner 4355edee822SRaphael Isemann CompletionMode mode = 4365edee822SRaphael Isemann is_dir ? CompletionMode::Partial : CompletionMode::Normal; 4375edee822SRaphael Isemann request.AddCompletion(CompletionBuffer, "", mode); 438d5bd3a1eSZachary Turner } 439558ce124SJim Ingham } 440558ce124SJim Ingham 4415edee822SRaphael Isemann static void DiskFilesOrDirectories(const llvm::Twine &partial_name, 4425edee822SRaphael Isemann bool only_directories, StringList &matches, 4435edee822SRaphael Isemann TildeExpressionResolver &Resolver) { 4445edee822SRaphael Isemann CompletionResult result; 4455edee822SRaphael Isemann std::string partial_name_str = partial_name.str(); 4465edee822SRaphael Isemann CompletionRequest request(partial_name_str, partial_name_str.size(), result); 4475edee822SRaphael Isemann DiskFilesOrDirectories(partial_name, only_directories, request, Resolver); 4485edee822SRaphael Isemann result.GetMatches(matches); 4495edee822SRaphael Isemann } 4505edee822SRaphael Isemann 451ae34ed2cSRaphael Isemann static void DiskFilesOrDirectories(CompletionRequest &request, 4521a6d7ab5SRaphael Isemann bool only_directories) { 45372787ac6SJonas Devlieghere StandardTildeExpressionResolver resolver; 4541a6d7ab5SRaphael Isemann DiskFilesOrDirectories(request.GetCursorArgumentPrefix(), only_directories, 4555edee822SRaphael Isemann request, resolver); 4561a6d7ab5SRaphael Isemann } 4571a6d7ab5SRaphael Isemann 458ae34ed2cSRaphael Isemann void CommandCompletions::DiskFiles(CommandInterpreter &interpreter, 459a2e76c0bSRaphael Isemann CompletionRequest &request, 460a2e76c0bSRaphael Isemann SearchFilter *searcher) { 461ae34ed2cSRaphael Isemann DiskFilesOrDirectories(request, /*only_dirs*/ false); 4622cc5a18dSZachary Turner } 4632cc5a18dSZachary Turner 464ae34ed2cSRaphael Isemann void CommandCompletions::DiskFiles(const llvm::Twine &partial_file_name, 4652cc5a18dSZachary Turner StringList &matches, 4662cc5a18dSZachary Turner TildeExpressionResolver &Resolver) { 467ae34ed2cSRaphael Isemann DiskFilesOrDirectories(partial_file_name, false, matches, Resolver); 468558ce124SJim Ingham } 469558ce124SJim Ingham 470ae34ed2cSRaphael Isemann void CommandCompletions::DiskDirectories(CommandInterpreter &interpreter, 471a2e76c0bSRaphael Isemann CompletionRequest &request, 472a2e76c0bSRaphael Isemann SearchFilter *searcher) { 473ae34ed2cSRaphael Isemann DiskFilesOrDirectories(request, /*only_dirs*/ true); 4742cc5a18dSZachary Turner } 4752cc5a18dSZachary Turner 476ae34ed2cSRaphael Isemann void CommandCompletions::DiskDirectories(const llvm::Twine &partial_file_name, 4772cc5a18dSZachary Turner StringList &matches, 4782cc5a18dSZachary Turner TildeExpressionResolver &Resolver) { 479ae34ed2cSRaphael Isemann DiskFilesOrDirectories(partial_file_name, true, matches, Resolver); 480558ce124SJim Ingham } 481558ce124SJim Ingham 482ae34ed2cSRaphael Isemann void CommandCompletions::Modules(CommandInterpreter &interpreter, 483a2e76c0bSRaphael Isemann CompletionRequest &request, 484a2e76c0bSRaphael Isemann SearchFilter *searcher) { 485a2e76c0bSRaphael Isemann ModuleCompleter completer(interpreter, request); 486c9af18a5SGreg Clayton 487b9c1b51eSKate Stone if (searcher == nullptr) { 4882976d00aSJim Ingham lldb::TargetSP target_sp = interpreter.GetDebugger().GetSelectedTarget(); 48933df7cd3SJim Ingham SearchFilterForUnconstrainedSearches null_searcher(target_sp); 490c9af18a5SGreg Clayton completer.DoCompletion(&null_searcher); 491b9c1b51eSKate Stone } else { 492c9af18a5SGreg Clayton completer.DoCompletion(searcher); 493c9af18a5SGreg Clayton } 494c9af18a5SGreg Clayton } 495c9af18a5SGreg Clayton 496419f1be7SGongyu Deng void CommandCompletions::ModuleUUIDs(CommandInterpreter &interpreter, 497419f1be7SGongyu Deng CompletionRequest &request, 498419f1be7SGongyu Deng SearchFilter *searcher) { 499419f1be7SGongyu Deng const ExecutionContext &exe_ctx = interpreter.GetExecutionContext(); 500419f1be7SGongyu Deng if (!exe_ctx.HasTargetScope()) 501419f1be7SGongyu Deng return; 502419f1be7SGongyu Deng 503419f1be7SGongyu Deng exe_ctx.GetTargetPtr()->GetImages().ForEach( 504419f1be7SGongyu Deng [&request](const lldb::ModuleSP &module) { 505419f1be7SGongyu Deng StreamString strm; 506419f1be7SGongyu Deng module->GetDescription(strm.AsRawOstream(), 507419f1be7SGongyu Deng lldb::eDescriptionLevelInitial); 508419f1be7SGongyu Deng request.TryCompleteCurrentArg(module->GetUUID().GetAsString(), 509419f1be7SGongyu Deng strm.GetString()); 510419f1be7SGongyu Deng return true; 511419f1be7SGongyu Deng }); 512419f1be7SGongyu Deng } 513419f1be7SGongyu Deng 514ae34ed2cSRaphael Isemann void CommandCompletions::Symbols(CommandInterpreter &interpreter, 515a2e76c0bSRaphael Isemann CompletionRequest &request, 516a2e76c0bSRaphael Isemann SearchFilter *searcher) { 517a2e76c0bSRaphael Isemann SymbolCompleter completer(interpreter, request); 518c9af18a5SGreg Clayton 519b9c1b51eSKate Stone if (searcher == nullptr) { 5202976d00aSJim Ingham lldb::TargetSP target_sp = interpreter.GetDebugger().GetSelectedTarget(); 52133df7cd3SJim Ingham SearchFilterForUnconstrainedSearches null_searcher(target_sp); 522c9af18a5SGreg Clayton completer.DoCompletion(&null_searcher); 523b9c1b51eSKate Stone } else { 524c9af18a5SGreg Clayton completer.DoCompletion(searcher); 525c9af18a5SGreg Clayton } 526c9af18a5SGreg Clayton } 527c9af18a5SGreg Clayton 528ae34ed2cSRaphael Isemann void CommandCompletions::SettingsNames(CommandInterpreter &interpreter, 529a2e76c0bSRaphael Isemann CompletionRequest &request, 530a2e76c0bSRaphael Isemann SearchFilter *searcher) { 53167cc0636SGreg Clayton // Cache the full setting name list 53267cc0636SGreg Clayton static StringList g_property_names; 533b9c1b51eSKate Stone if (g_property_names.GetSize() == 0) { 53467cc0636SGreg Clayton // Generate the full setting name list on demand 535b9c1b51eSKate Stone lldb::OptionValuePropertiesSP properties_sp( 536b9c1b51eSKate Stone interpreter.GetDebugger().GetValueProperties()); 537b9c1b51eSKate Stone if (properties_sp) { 53867cc0636SGreg Clayton StreamString strm; 539c8ecc2a9SEugene Zelenko properties_sp->DumpValue(nullptr, strm, OptionValue::eDumpOptionName); 540adcd0268SBenjamin Kramer const std::string &str = std::string(strm.GetString()); 54167cc0636SGreg Clayton g_property_names.SplitIntoLines(str.c_str(), str.size()); 54267cc0636SGreg Clayton } 54367cc0636SGreg Clayton } 5443df9a8dfSCaroline Tice 54593ca36d7SRaphael Isemann for (const std::string &s : g_property_names) 54693ca36d7SRaphael Isemann request.TryCompleteCurrentArg(s); 547b8639f5cSRaphael Isemann } 548b8639f5cSRaphael Isemann 549ae34ed2cSRaphael Isemann void CommandCompletions::PlatformPluginNames(CommandInterpreter &interpreter, 550a2e76c0bSRaphael Isemann CompletionRequest &request, 551a2e76c0bSRaphael Isemann SearchFilter *searcher) { 552ae34ed2cSRaphael Isemann PluginManager::AutoCompletePlatformName(request.GetCursorArgumentPrefix(), 553ae34ed2cSRaphael Isemann request); 554ab65b34fSGreg Clayton } 555ab65b34fSGreg Clayton 556ae34ed2cSRaphael Isemann void CommandCompletions::ArchitectureNames(CommandInterpreter &interpreter, 557a2e76c0bSRaphael Isemann CompletionRequest &request, 558a2e76c0bSRaphael Isemann SearchFilter *searcher) { 559ae34ed2cSRaphael Isemann ArchSpec::AutoComplete(request); 560ab65b34fSGreg Clayton } 561ab65b34fSGreg Clayton 562ae34ed2cSRaphael Isemann void CommandCompletions::VariablePath(CommandInterpreter &interpreter, 563a2e76c0bSRaphael Isemann CompletionRequest &request, 564a2e76c0bSRaphael Isemann SearchFilter *searcher) { 565ae34ed2cSRaphael Isemann Variable::AutoComplete(interpreter.GetExecutionContext(), request); 566f21feadcSGreg Clayton } 567a14f4a75SGongyu Deng 568a14f4a75SGongyu Deng void CommandCompletions::Registers(CommandInterpreter &interpreter, 569a14f4a75SGongyu Deng CompletionRequest &request, 570a14f4a75SGongyu Deng SearchFilter *searcher) { 571a14f4a75SGongyu Deng std::string reg_prefix = ""; 572a14f4a75SGongyu Deng if (request.GetCursorArgumentPrefix().startswith("$")) 573a14f4a75SGongyu Deng reg_prefix = "$"; 574a14f4a75SGongyu Deng 575a14f4a75SGongyu Deng RegisterContext *reg_ctx = 576a14f4a75SGongyu Deng interpreter.GetExecutionContext().GetRegisterContext(); 577a14f4a75SGongyu Deng const size_t reg_num = reg_ctx->GetRegisterCount(); 578a14f4a75SGongyu Deng for (size_t reg_idx = 0; reg_idx < reg_num; ++reg_idx) { 579a14f4a75SGongyu Deng const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex(reg_idx); 580a14f4a75SGongyu Deng request.TryCompleteCurrentArg(reg_prefix + reg_info->name, 581a14f4a75SGongyu Deng reg_info->alt_name); 582a14f4a75SGongyu Deng } 583a14f4a75SGongyu Deng } 5840e50b9a4SGongyu Deng 5850e50b9a4SGongyu Deng void CommandCompletions::Breakpoints(CommandInterpreter &interpreter, 5860e50b9a4SGongyu Deng CompletionRequest &request, 5870e50b9a4SGongyu Deng SearchFilter *searcher) { 5880e50b9a4SGongyu Deng lldb::TargetSP target = interpreter.GetDebugger().GetSelectedTarget(); 5890e50b9a4SGongyu Deng if (!target) 5900e50b9a4SGongyu Deng return; 5910e50b9a4SGongyu Deng 5920e50b9a4SGongyu Deng const BreakpointList &breakpoints = target->GetBreakpointList(); 5930e50b9a4SGongyu Deng 5940e50b9a4SGongyu Deng std::unique_lock<std::recursive_mutex> lock; 5950e50b9a4SGongyu Deng target->GetBreakpointList().GetListMutex(lock); 5960e50b9a4SGongyu Deng 5970e50b9a4SGongyu Deng size_t num_breakpoints = breakpoints.GetSize(); 5980e50b9a4SGongyu Deng if (num_breakpoints == 0) 5990e50b9a4SGongyu Deng return; 6000e50b9a4SGongyu Deng 6010e50b9a4SGongyu Deng for (size_t i = 0; i < num_breakpoints; ++i) { 6020e50b9a4SGongyu Deng lldb::BreakpointSP bp = breakpoints.GetBreakpointAtIndex(i); 6030e50b9a4SGongyu Deng 6040e50b9a4SGongyu Deng StreamString s; 6050e50b9a4SGongyu Deng bp->GetDescription(&s, lldb::eDescriptionLevelBrief); 6060e50b9a4SGongyu Deng llvm::StringRef bp_info = s.GetString(); 6070e50b9a4SGongyu Deng 6080e50b9a4SGongyu Deng const size_t colon_pos = bp_info.find_first_of(':'); 6090e50b9a4SGongyu Deng if (colon_pos != llvm::StringRef::npos) 6100e50b9a4SGongyu Deng bp_info = bp_info.drop_front(colon_pos + 2); 6110e50b9a4SGongyu Deng 6120e50b9a4SGongyu Deng request.TryCompleteCurrentArg(std::to_string(bp->GetID()), bp_info); 6130e50b9a4SGongyu Deng } 6140e50b9a4SGongyu Deng } 615763bc230SGongyu Deng 616763bc230SGongyu Deng void CommandCompletions::ProcessPluginNames(CommandInterpreter &interpreter, 617763bc230SGongyu Deng CompletionRequest &request, 618763bc230SGongyu Deng SearchFilter *searcher) { 619763bc230SGongyu Deng PluginManager::AutoCompleteProcessName(request.GetCursorArgumentPrefix(), 620763bc230SGongyu Deng request); 621763bc230SGongyu Deng } 6228a5e2969SGongyu Deng 6238a5e2969SGongyu Deng void CommandCompletions::DisassemblyFlavors(CommandInterpreter &interpreter, 6248a5e2969SGongyu Deng CompletionRequest &request, 6258a5e2969SGongyu Deng SearchFilter *searcher) { 6268a5e2969SGongyu Deng // Currently the only valid options for disassemble -F are default, and for 6278a5e2969SGongyu Deng // Intel architectures, att and intel. 6288a5e2969SGongyu Deng static const char *flavors[] = {"default", "att", "intel"}; 6298a5e2969SGongyu Deng for (const char *flavor : flavors) { 6308a5e2969SGongyu Deng request.TryCompleteCurrentArg(flavor); 6318a5e2969SGongyu Deng } 6328a5e2969SGongyu Deng } 6333ce57e01SGongyu Deng 6343ce57e01SGongyu Deng void CommandCompletions::TypeLanguages(CommandInterpreter &interpreter, 6353ce57e01SGongyu Deng CompletionRequest &request, 6363ce57e01SGongyu Deng SearchFilter *searcher) { 6373ce57e01SGongyu Deng for (int bit : 6383ce57e01SGongyu Deng Language::GetLanguagesSupportingTypeSystems().bitvector.set_bits()) { 6393ce57e01SGongyu Deng request.TryCompleteCurrentArg( 6403ce57e01SGongyu Deng Language::GetNameForLanguageType(static_cast<lldb::LanguageType>(bit))); 6413ce57e01SGongyu Deng } 6423ce57e01SGongyu Deng } 64366fa73faSGongyu Deng 64466fa73faSGongyu Deng void CommandCompletions::FrameIndexes(CommandInterpreter &interpreter, 64566fa73faSGongyu Deng CompletionRequest &request, 64666fa73faSGongyu Deng SearchFilter *searcher) { 64766fa73faSGongyu Deng const ExecutionContext &exe_ctx = interpreter.GetExecutionContext(); 64866fa73faSGongyu Deng if (!exe_ctx.HasProcessScope()) 64966fa73faSGongyu Deng return; 65066fa73faSGongyu Deng 65166fa73faSGongyu Deng lldb::ThreadSP thread_sp = exe_ctx.GetThreadSP(); 65266fa73faSGongyu Deng const uint32_t frame_num = thread_sp->GetStackFrameCount(); 65366fa73faSGongyu Deng for (uint32_t i = 0; i < frame_num; ++i) { 65466fa73faSGongyu Deng lldb::StackFrameSP frame_sp = thread_sp->GetStackFrameAtIndex(i); 65566fa73faSGongyu Deng StreamString strm; 65666fa73faSGongyu Deng frame_sp->Dump(&strm, false, true); 65766fa73faSGongyu Deng request.TryCompleteCurrentArg(std::to_string(i), strm.GetString()); 65866fa73faSGongyu Deng } 65966fa73faSGongyu Deng } 660*b2b7dbb4SGongyu Deng 661*b2b7dbb4SGongyu Deng void CommandCompletions::StopHookIDs(CommandInterpreter &interpreter, 662*b2b7dbb4SGongyu Deng CompletionRequest &request, 663*b2b7dbb4SGongyu Deng SearchFilter *searcher) { 664*b2b7dbb4SGongyu Deng const lldb::TargetSP target_sp = 665*b2b7dbb4SGongyu Deng interpreter.GetExecutionContext().GetTargetSP(); 666*b2b7dbb4SGongyu Deng if (!target_sp) 667*b2b7dbb4SGongyu Deng return; 668*b2b7dbb4SGongyu Deng 669*b2b7dbb4SGongyu Deng const size_t num = target_sp->GetNumStopHooks(); 670*b2b7dbb4SGongyu Deng for (size_t idx = 0; idx < num; ++idx) { 671*b2b7dbb4SGongyu Deng StreamString strm; 672*b2b7dbb4SGongyu Deng // The value 11 is an offset to make the completion description looks 673*b2b7dbb4SGongyu Deng // neater. 674*b2b7dbb4SGongyu Deng strm.SetIndentLevel(11); 675*b2b7dbb4SGongyu Deng const Target::StopHookSP stophook_sp = target_sp->GetStopHookAtIndex(idx); 676*b2b7dbb4SGongyu Deng stophook_sp->GetDescription(&strm, lldb::eDescriptionLevelInitial); 677*b2b7dbb4SGongyu Deng request.TryCompleteCurrentArg(std::to_string(stophook_sp->GetID()), 678*b2b7dbb4SGongyu Deng strm.GetString()); 679*b2b7dbb4SGongyu Deng } 680*b2b7dbb4SGongyu Deng } 681