9#include "llvm/ADT/STLExtras.h"
10#include "llvm/ADT/SmallString.h"
11#include "llvm/ADT/StringRef.h"
12#include "llvm/ADT/StringSet.h"
35#include "llvm/Support/FileSystem.h"
36#include "llvm/Support/Path.h"
94 for (
int i = 0;; i++) {
97 else if ((common_completions[i].type & completion_mask) ==
98 common_completions[i].type &&
99 common_completions[i].callback !=
nullptr) {
101 common_completions[i].
callback(interpreter, request, searcher);
113 : m_interpreter(interpreter), m_request(request) {}
115 ~Completer()
override =
default;
129 Completer(
const Completer &) =
delete;
130 const Completer &operator=(
const Completer &) =
delete;
136class SourceFileCompleter :
public Completer {
140 : Completer(interpreter, request) {
141 FileSpec partial_spec(m_request.GetCursorArgumentPrefix());
142 m_file_name = partial_spec.GetFilename().GetCString();
143 m_dir_name = partial_spec.GetDirectory().GetCString();
152 const char *cur_file_name =
154 const char *cur_dir_name =
158 if (m_file_name && cur_file_name &&
159 strstr(cur_file_name, m_file_name) == cur_file_name)
162 if (match && m_dir_name && cur_dir_name &&
163 strstr(cur_dir_name, m_dir_name) != cur_dir_name)
176 for (
size_t i = 0; i < m_matching_files.GetSize(); i++) {
177 m_request.AddCompletion(
178 m_matching_files.GetFileSpecAtIndex(i).GetFilename().GetCString());
184 const char *m_file_name;
185 const char *m_dir_name;
187 SourceFileCompleter(
const SourceFileCompleter &) =
delete;
188 const SourceFileCompleter &operator=(
const SourceFileCompleter &) =
delete;
193 return llvm::StringRef(
"[](){}+.*|^$\\?").contains(comp);
197class SymbolCompleter :
public Completer {
201 : Completer(interpreter, request) {
202 std::string regex_str;
203 if (!m_request.GetCursorArgumentPrefix().empty()) {
204 regex_str.append(
"^");
205 regex_str.append(std::string(m_request.GetCursorArgumentPrefix()));
208 regex_str.append(
".");
210 std::string::iterator pos =
211 find_if(regex_str.begin() + 1, regex_str.end(),
regex_chars);
212 while (pos < regex_str.end()) {
213 pos = regex_str.insert(pos,
'\\');
214 pos = find_if(pos + 2, regex_str.end(),
regex_chars);
229 context.
module_sp->FindFunctions(m_regex, function_options, sc_list);
239 m_match_set.insert(func_name);
247 collection::iterator pos = m_match_set.begin(), end = m_match_set.end();
248 for (pos = m_match_set.begin(); pos != end; pos++)
249 m_request.AddCompletion((*pos).GetCString());
254 typedef std::set<ConstString> collection;
255 collection m_match_set;
257 SymbolCompleter(
const SymbolCompleter &) =
delete;
258 const SymbolCompleter &operator=(
const SymbolCompleter &) =
delete;
263class ModuleCompleter :
public Completer {
266 : Completer(interpreter, request) {
267 llvm::StringRef request_str = m_request.GetCursorArgumentPrefix();
274 m_spelled_path = request_str;
276 if (!m_spelled_path.empty() &&
277 llvm::sys::path::is_separator(m_spelled_path.back()) &&
278 !llvm::StringRef(m_canonical_path).ends_with(m_spelled_path.back())) {
279 m_canonical_path += m_spelled_path.back();
282 if (llvm::find_if(request_str, [](
char c) {
283 return llvm::sys::path::is_separator(c);
284 }) == request_str.end())
285 m_file_name = request_str;
295 std::string cur_path = context.
module_sp->GetFileSpec().GetPath();
296 llvm::StringRef cur_path_view = cur_path;
297 if (cur_path_view.consume_front(m_canonical_path))
298 m_request.AddCompletion((m_spelled_path + cur_path_view).str());
302 llvm::StringRef cur_file_name =
303 context.
module_sp->GetFileSpec().GetFilename().GetStringRef();
304 if (cur_file_name.starts_with(*m_file_name))
305 m_request.AddCompletion(cur_file_name);
314 std::optional<llvm::StringRef> m_file_name;
315 llvm::StringRef m_spelled_path;
316 std::string m_canonical_path;
318 ModuleCompleter(
const ModuleCompleter &) =
delete;
319 const ModuleCompleter &operator=(
const ModuleCompleter &) =
delete;
326 SourceFileCompleter completer(interpreter, request);
328 if (searcher ==
nullptr) {
331 completer.DoCompletion(&null_searcher);
333 completer.DoCompletion(searcher);
338 bool only_directories,
341 llvm::SmallString<256> CompletionBuffer;
342 llvm::SmallString<256> Storage;
343 partial_name.toVector(CompletionBuffer);
345 if (CompletionBuffer.size() >=
PATH_MAX)
348 namespace path = llvm::sys::path;
350 llvm::StringRef SearchDir;
351 llvm::StringRef PartialItem;
353 if (CompletionBuffer.starts_with(
"~")) {
354 llvm::StringRef Buffer = CompletionBuffer;
356 Buffer.find_if([](
char c) {
return path::is_separator(c); });
358 llvm::StringRef Username = Buffer.take_front(FirstSep);
359 llvm::StringRef Remainder;
360 if (FirstSep != llvm::StringRef::npos)
361 Remainder = Buffer.drop_front(FirstSep + 1);
363 llvm::SmallString<256> Resolved;
368 if (FirstSep == llvm::StringRef::npos) {
369 llvm::StringSet<> MatchSet;
371 for (
const auto &S : MatchSet) {
372 Resolved = S.getKey();
373 path::append(Resolved, path::get_separator());
383 if (FirstSep == llvm::StringRef::npos) {
385 path::append(CompletionBuffer, path::get_separator());
394 llvm::StringRef RemainderDir = path::parent_path(Remainder);
395 if (!RemainderDir.empty()) {
397 Storage.append(path::get_separator());
398 Storage.append(RemainderDir);
401 }
else if (CompletionBuffer == path::root_directory(CompletionBuffer)) {
402 SearchDir = CompletionBuffer;
404 SearchDir = path::parent_path(CompletionBuffer);
407 size_t FullPrefixLen = CompletionBuffer.size();
409 PartialItem = path::filename(CompletionBuffer);
415 if ((PartialItem ==
"." || PartialItem == path::get_separator()) &&
416 path::is_separator(CompletionBuffer.back()))
417 PartialItem = llvm::StringRef();
419 if (SearchDir.empty()) {
420 llvm::sys::fs::current_path(Storage);
423 assert(!PartialItem.contains(path::get_separator()));
430 llvm::vfs::directory_iterator Iter = fs.
DirBegin(SearchDir, EC);
431 llvm::vfs::directory_iterator End;
432 for (; Iter != End && !EC; Iter.increment(EC)) {
439 auto Name = path::filename(
Entry.path());
442 if (Name ==
"." || Name ==
".." || !Name.starts_with(PartialItem))
445 bool is_dir =
Status->isDirectory();
449 if (
Status->isSymlink()) {
457 if (only_directories && !is_dir)
463 CompletionBuffer.resize(FullPrefixLen);
464 Name = Name.drop_front(PartialItem.size());
465 CompletionBuffer.append(Name);
468 path::append(CompletionBuffer, path::get_separator());
481 std::string partial_name_str = partial_name.str();
488 bool only_directories) {
524 platform_sp->AutoCompleteDiskFileOrDirectory(request,
false);
533 platform_sp->AutoCompleteDiskFileOrDirectory(request,
true);
539 ModuleCompleter completer(interpreter, request);
541 if (searcher ==
nullptr) {
544 completer.DoCompletion(&null_searcher);
546 completer.DoCompletion(searcher);
571 SymbolCompleter completer(interpreter, request);
573 if (searcher ==
nullptr) {
576 completer.DoCompletion(&null_searcher);
578 completer.DoCompletion(searcher);
587 if (g_property_names.
GetSize() == 0) {
594 const std::string &str = std::string(strm.
GetString());
599 for (
const std::string &s : g_property_names)
625 std::string reg_prefix;
635 for (
size_t reg_idx = 0; reg_idx < reg_num; ++reg_idx) {
651 std::unique_lock<std::recursive_mutex> lock;
654 size_t num_breakpoints = breakpoints.
GetSize();
655 if (num_breakpoints == 0)
658 for (
size_t i = 0; i < num_breakpoints; ++i) {
665 const size_t colon_pos = bp_info.find_first_of(
':');
666 if (colon_pos != llvm::StringRef::npos)
667 bp_info = bp_info.drop_front(colon_pos + 2);
680 std::vector<std::string> name_list;
681 target->GetBreakpointNames(name_list);
683 for (
const std::string &name : name_list)
698 static const char *flavors[] = {
"default",
"att",
"intel"};
699 for (
const char *flavor : flavors) {
712 platform_sp->FindProcesses(match_info, process_infos);
715 info.GetNameAsStringRef());
726 platform_sp->FindProcesses(match_info, process_infos);
750 const uint32_t frame_num = thread_sp->GetStackFrameCount();
751 for (uint32_t i = 0; i < frame_num; ++i) {
757 frame_sp->Dump(&strm,
false,
true);
770 const size_t num = target_sp->GetNumStopHooks();
771 for (
size_t idx = 0; idx < num; ++idx) {
792 for (uint32_t idx = 0; (thread_sp = threads.
GetThreadAtIndex(idx)); ++idx) {
794 thread_sp->GetStatus(strm, 0, 1, 1,
true);
822 category_sp->GetDescription());
836 for (uint32_t idx = 0; (thread_sp = threads.
GetThreadAtIndex(idx)); ++idx) {
838 thread_sp->GetStatus(strm, 0, 1, 1,
true);
851 std::vector<size_t> to_delete;
852 for (
auto &elem : opt_element_vector) {
853 to_delete.push_back(elem.opt_pos);
854 if (elem.opt_arg_pos != 0)
855 to_delete.push_back(elem.opt_arg_pos);
857 sort(to_delete.begin(), to_delete.end(), std::greater<size_t>());
858 for (
size_t idx : to_delete)
892 assert(mwc !=
nullptr);
static void DiskFilesOrDirectories(const llvm::Twine &partial_name, bool only_directories, CompletionRequest &request, TildeExpressionResolver &Resolver)
static bool regex_chars(const char comp)
void(* CompletionCallback)(CommandInterpreter &interpreter, CompletionRequest &request, lldb_private::SearchFilter *searcher)
static llvm::raw_ostream & error(Stream &strm)
#define INTERRUPT_REQUESTED(debugger,...)
This handy define will keep you from having to generate a report for the interruption by hand.
A section + offset based address class.
static void AutoComplete(CompletionRequest &request)
A command line argument class.
void DeleteArgumentAtIndex(size_t idx)
Deletes the argument value at index if idx is a valid argument index.
size_t GetArgumentCount() const
Gets the number of arguments left in this command object.
const char * GetArgumentAtIndex(size_t idx) const
Gets the NULL terminated C string argument pointer for the argument at index idx.
General Outline: Allows adding and removing breakpoints and find by ID and index.
void GetListMutex(std::unique_lock< std::recursive_mutex > &lock)
Sets the passed in Locker to hold the Breakpoint List mutex.
size_t GetSize() const
Returns the number of elements in this breakpoint list.
lldb::BreakpointSP GetBreakpointAtIndex(size_t i) const
Returns a shared pointer to the breakpoint with index i.
static void DisassemblyFlavors(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static bool InvokeCommonCompletionCallbacks(CommandInterpreter &interpreter, uint32_t completion_mask, lldb_private::CompletionRequest &request, SearchFilter *searcher)
static void ArchitectureNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void DiskDirectories(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void RemoteDiskDirectories(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void SourceFiles(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void Registers(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void TypeLanguages(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void DiskFiles(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void ProcessPluginNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void PlatformPluginNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void Breakpoints(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void ThreadIDs(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void ProcessIDs(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void Symbols(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void StopHookIDs(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void ModuleUUIDs(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void ThreadIndexes(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void SettingsNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void CompleteModifiableCmdPathArgs(CommandInterpreter &interpreter, CompletionRequest &request, OptionElementVector &opt_element_vector)
This completer works for commands whose only arguments are a command path.
static void FrameIndexes(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void TypeCategoryNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void WatchPointIDs(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void Modules(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void RemoteDiskFiles(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void ProcessNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void VariablePath(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
static void BreakpointNames(CommandInterpreter &interpreter, CompletionRequest &request, SearchFilter *searcher)
ExecutionContext GetExecutionContext() const
CommandObject * GetUserCommandObject(llvm::StringRef cmd, StringList *matches=nullptr, StringList *descriptions=nullptr) const
CommandObjectMultiword * VerifyUserMultiwordCmdPath(Args &path, bool leaf_is_command, Status &result)
Look up the command pointed to by path encoded in the arguments of the incoming command object.
lldb::PlatformSP GetPlatform(bool prefer_target_platform)
CommandObject * GetSubcommandObject(llvm::StringRef sub_cmd, StringList *matches=nullptr) override
const FileSpec & GetPrimaryFile() const
Return the primary source spec associated with this compile unit.
"lldb/Utility/ArgCompletionRequest.h"
void AddCompletion(llvm::StringRef completion, llvm::StringRef description="", CompletionMode mode=CompletionMode::Normal)
Adds a possible completion string.
void AddCompletions(const StringList &completions)
Adds multiple possible completion strings.
const Args & GetParsedLine() const
llvm::StringRef GetCursorArgumentPrefix() const
void TryCompleteCurrentArg(llvm::StringRef completion, llvm::StringRef description="")
Adds a possible completion string if the completion would complete the current argument.
void GetMatches(StringList &matches) const
Adds all collected completion matches to the given list.
A uniqued constant string class.
bool IsEmpty() const
Test for empty string.
llvm::StringRef GetStringRef() const
Get the string value as a llvm::StringRef.
const char * GetCString() const
Get the string value as a C string.
static void ForEach(TypeCategoryMap::ForEachCallback callback)
A class to manage flag bits.
lldb::TargetSP GetSelectedTarget()
PlatformList & GetPlatformList()
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
bool HasProcessScope() const
Returns true the ExecutionContext object contains a valid target and process.
const lldb::TargetSP & GetTargetSP() const
Get accessor to get the target shared pointer.
Target * GetTargetPtr() const
Returns a pointer to the target object.
const lldb::ThreadSP & GetThreadSP() const
Get accessor to get the thread shared pointer.
bool HasTargetScope() const
Returns true the ExecutionContext object contains a valid target.
Process * GetProcessPtr() const
Returns a pointer to the process object.
RegisterContext * GetRegisterContext() const
const ConstString & GetFilename() const
Filename string const get accessor.
const ConstString & GetDirectory() const
Directory string const get accessor.
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Status ResolveSymbolicLink(const FileSpec &src, FileSpec &dst)
llvm::vfs::directory_iterator DirBegin(const FileSpec &file_spec, std::error_code &ec)
Get a directory iterator.
llvm::ErrorOr< llvm::vfs::Status > GetStatus(const FileSpec &file_spec) const
Returns the Status object for the given file.
bool IsDirectory(const FileSpec &file_spec) const
Returns whether the given path is a directory.
static FileSystem & Instance()
static LanguageSet GetLanguagesSupportingTypeSystems()
static const char * GetNameForLanguageType(lldb::LanguageType language)
void ForEach(std::function< bool(const lldb::ModuleSP &module_sp)> const &callback) const
Applies 'callback' to each module in this ModuleList.
static void AutoCompletePlatformName(llvm::StringRef partial_name, CompletionRequest &request)
static void AutoCompleteProcessName(llvm::StringRef partial_name, CompletionRequest &request)
ThreadList & GetThreadList()
virtual lldb::OptionValuePropertiesSP GetValueProperties() const
virtual const RegisterInfo * GetRegisterInfoAtIndex(size_t reg)=0
virtual size_t GetRegisterCount()=0
"lldb/Core/SearchFilter.h" This is a SearchFilter that searches through all modules.
General Outline: Provides the callback and search depth for the SearchFilter search.
virtual void Search(Searcher &searcher)
Call this method to do the search using the Searcher.
General Outline: Provides the callback and search depth for the SearchFilter search.
@ eCallbackReturnContinue
llvm::StringRef GetString() const
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
void SetIndentLevel(unsigned level)
Set the current indentation level.
size_t SplitIntoLines(const std::string &lines)
Defines a list of symbol context objects.
Defines a symbol context baton that can be handed other debug core functions.
lldb::ModuleSP module_sp
The Module for a given query.
CompileUnit * comp_unit
The CompileUnit for a given query.
std::shared_ptr< StopHook > StopHookSP
const ModuleList & GetImages() const
Get accessor for the images for this process.
WatchpointList & GetWatchpointList()
lldb::ThreadSP GetThreadAtIndex(uint32_t idx, bool can_update=true)
virtual bool ResolveExact(llvm::StringRef Expr, llvm::SmallVectorImpl< char > &Output)=0
Resolve a Tilde Expression contained according to bash rules.
virtual bool ResolvePartial(llvm::StringRef Expr, llvm::StringSet<> &Output)=0
Auto-complete a tilde expression with all matching values.
static void AutoComplete(const ExecutionContext &exe_ctx, CompletionRequest &request)
This class is used by Watchpoint to manage a list of watchpoints,.
WatchpointIterable Watchpoints() const
A class that represents a running process on the host machine.
std::vector< OptionArgElement > OptionElementVector
@ Partial
The current token has been partially completed.
@ Normal
The current token has been completed.
std::vector< ProcessInstanceInfo > ProcessInstanceInfoList
@ eRemoteDiskDirectoryCompletion
@ eDisassemblyFlavorCompletion
@ eVariablePathCompletion
@ eDiskDirectoryCompletion
@ eTypeCategoryNameCompletion
@ ePlatformPluginCompletion
@ eSettingsNameCompletion
@ eTypeLanguageCompletion
@ eWatchpointIDCompletion
@ eBreakpointNameCompletion
@ eProcessPluginCompletion
@ eRemoteDiskFileCompletion
@ eArchitectureCompletion
std::shared_ptr< lldb_private::OptionValueProperties > OptionValuePropertiesSP
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
@ eDescriptionLevelInitial
std::shared_ptr< lldb_private::Thread > ThreadSP
std::shared_ptr< lldb_private::Platform > PlatformSP
LanguageType
Programming language type.
std::shared_ptr< lldb_private::Breakpoint > BreakpointSP
std::shared_ptr< lldb_private::Watchpoint > WatchpointSP
std::shared_ptr< lldb_private::TypeCategoryImpl > TypeCategoryImplSP
std::shared_ptr< lldb_private::Target > TargetSP
std::shared_ptr< lldb_private::Module > ModuleSP
CompletionCallback callback
Options used by Module::FindFunctions.
bool include_inlines
Include inlined functions.
bool include_symbols
Include the symbol table.
Every register is described in detail including its name, alternate name (optional),...
const char * alt_name
Alternate name of this register, can be NULL.
const char * name
Name of this register, can't be NULL.