LLDB  mainline
Public Member Functions | List of all members
lldb_private::DefaultHighlighter Class Reference

A default highlighter that only highlights the user cursor, but doesn't do any other highlighting. More...

#include <Highlighter.h>

Inheritance diagram for lldb_private::DefaultHighlighter:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::DefaultHighlighter:
Collaboration graph
[legend]

Public Member Functions

llvm::StringRef GetName () const override
 Returns a human readable name for the selected highlighter. More...
 
void Highlight (const HighlightStyle &options, llvm::StringRef line, llvm::Optional< size_t > cursor_pos, llvm::StringRef previous_lines, Stream &s) const override
 Highlights the given line. More...
 
- Public Member Functions inherited from lldb_private::Highlighter
 Highlighter ()=default
 
virtual ~Highlighter ()=default
 
 Highlighter (const Highlighter &)=delete
 
const Highlighteroperator= (const Highlighter &)=delete
 
std::string Highlight (const HighlightStyle &options, llvm::StringRef line, llvm::Optional< size_t > cursor_pos, llvm::StringRef previous_lines="") const
 Utility method for calling Highlight without a stream. More...
 

Detailed Description

A default highlighter that only highlights the user cursor, but doesn't do any other highlighting.

Definition at line 126 of file Highlighter.h.

Member Function Documentation

◆ GetName()

llvm::StringRef lldb_private::DefaultHighlighter::GetName ( ) const
inlineoverridevirtual

Returns a human readable name for the selected highlighter.

Implements lldb_private::Highlighter.

Definition at line 128 of file Highlighter.h.

◆ Highlight()

void DefaultHighlighter::Highlight ( const HighlightStyle options,
llvm::StringRef  line,
llvm::Optional< size_t >  cursor_pos,
llvm::StringRef  previous_lines,
Stream s 
) const
overridevirtual

Highlights the given line.

Parameters
optionsThe highlight options.
lineThe user supplied line that needs to be highlighted.
cursor_posThe cursor position of the user in this line, starting at 0 (which means the cursor is on the first character in 'line').
previous_linesAny previous lines the user has written which we should only use for getting the context of the Highlighting right.
sThe stream to which the highlighted version of the user string should be written.

Implements lldb_private::Highlighter.

Definition at line 28 of file Highlighter.cpp.

References lldb_private::HighlightStyle::ColorStyle::Apply(), and lldb_private::HighlightStyle::selected.


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