LLDB mainline
Public Member Functions | Private Attributes | List of all members
lldb_private::CompletionResult::Completion Class Reference

A single completion and all associated data. More...

#include <CompletionRequest.h>

Public Member Functions

 Completion (llvm::StringRef completion, llvm::StringRef description, CompletionMode mode)
 
const std::string & GetCompletion () const
 
const std::string & GetDescription () const
 
CompletionMode GetMode () const
 
std::string GetUniqueKey () const
 Generates a string that uniquely identifies this completion result.
 

Private Attributes

std::string m_completion
 The actual text that should be completed.
 
std::string m_descripton
 The description that should be displayed to the user alongside the completion text.
 
CompletionMode m_mode
 

Detailed Description

A single completion and all associated data.

Definition at line 41 of file CompletionRequest.h.

Constructor & Destructor Documentation

◆ Completion()

lldb_private::CompletionResult::Completion::Completion ( llvm::StringRef  completion,
llvm::StringRef  description,
CompletionMode  mode 
)
inline

Definition at line 53 of file CompletionRequest.h.

Member Function Documentation

◆ GetCompletion()

const std::string & lldb_private::CompletionResult::Completion::GetCompletion ( ) const
inline

Definition at line 57 of file CompletionRequest.h.

References m_completion.

Referenced by lldb_private::Editline::TabCommand().

◆ GetDescription()

const std::string & lldb_private::CompletionResult::Completion::GetDescription ( ) const
inline

Definition at line 58 of file CompletionRequest.h.

References m_descripton.

◆ GetMode()

CompletionMode lldb_private::CompletionResult::Completion::GetMode ( ) const
inline

Definition at line 59 of file CompletionRequest.h.

References m_mode.

Referenced by lldb_private::Editline::TabCommand().

◆ GetUniqueKey()

std::string CompletionResult::Completion::GetUniqueKey ( ) const

Generates a string that uniquely identifies this completion result.

Definition at line 44 of file CompletionRequest.cpp.

References m_completion, m_descripton, and m_mode.

Referenced by lldb_private::CompletionResult::AddResult().

Member Data Documentation

◆ m_completion

std::string lldb_private::CompletionResult::Completion::m_completion
private

The actual text that should be completed.

The meaning of this text is defined by the CompletionMode.

See also
m_mode

Definition at line 46 of file CompletionRequest.h.

Referenced by GetCompletion(), and GetUniqueKey().

◆ m_descripton

std::string lldb_private::CompletionResult::Completion::m_descripton
private

The description that should be displayed to the user alongside the completion text.

Definition at line 49 of file CompletionRequest.h.

Referenced by GetDescription(), and GetUniqueKey().

◆ m_mode

CompletionMode lldb_private::CompletionResult::Completion::m_mode
private

Definition at line 50 of file CompletionRequest.h.

Referenced by GetMode(), and GetUniqueKey().


The documentation for this class was generated from the following files: