LLDB mainline
REPL.h
Go to the documentation of this file.
1//===-- REPL.h --------------------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLDB_EXPRESSION_REPL_H
10#define LLDB_EXPRESSION_REPL_H
11
12#include <string>
13
14#include "lldb/Core/IOHandler.h"
17#include "lldb/Target/Target.h"
18
19namespace lldb_private {
20
21class REPL : public IOHandlerDelegate {
22public:
23 // See TypeSystem.h for how to add subclasses to this.
25
26 LLVMCastKind getKind() const { return m_kind; }
27
28 REPL(LLVMCastKind kind, Target &target);
29
30 ~REPL() override;
31
32 /// Get a REPL with an existing target (or, failing that, a debugger to use),
33 /// and (optional) extra arguments for the compiler.
34 ///
35 /// \param[out] Status
36 /// If this language is supported but the REPL couldn't be created, this
37 /// error is populated with the reason.
38 ///
39 /// \param[in] language
40 /// The language to create a REPL for.
41 ///
42 /// \param[in] debugger
43 /// If provided, and target is nullptr, the debugger to use when setting
44 /// up a top-level REPL.
45 ///
46 /// \param[in] target
47 /// If provided, the target to put the REPL inside.
48 ///
49 /// \param[in] repl_options
50 /// If provided, additional options for the compiler when parsing REPL
51 /// expressions.
52 ///
53 /// \return
54 /// The range of the containing object in the target process.
55 static lldb::REPLSP Create(Status &Status, lldb::LanguageType language,
56 Debugger *debugger, Target *target,
57 const char *repl_options);
58
59 void SetFormatOptions(const OptionGroupFormat &options) {
60 m_format_options = options;
61 }
62
63 void
65 m_varobj_options = options;
66 }
67
69 m_expr_options = options;
70 }
71
72 void SetCompilerOptions(const char *options) {
73 if (options)
74 m_compiler_options = options;
75 }
76
77 lldb::IOHandlerSP GetIOHandler();
78
80
81 // IOHandler::Delegate functions
82 void IOHandlerActivated(IOHandler &io_handler, bool interactive) override;
83
84 bool IOHandlerInterrupt(IOHandler &io_handler) override;
85
86 void IOHandlerInputInterrupted(IOHandler &io_handler,
87 std::string &line) override;
88
89 const char *IOHandlerGetFixIndentationCharacters() override;
90
92
93 const char *IOHandlerGetCommandPrefix() override;
94
95 const char *IOHandlerGetHelpPrologue() override;
96
97 bool IOHandlerIsInputComplete(IOHandler &io_handler,
98 StringList &lines) override;
99
100 int IOHandlerFixIndentation(IOHandler &io_handler, const StringList &lines,
101 int cursor_position) override;
102
103 void IOHandlerInputComplete(IOHandler &io_handler,
104 std::string &line) override;
105
106 void IOHandlerComplete(IOHandler &io_handler,
107 CompletionRequest &request) override;
108
109protected:
110 static int CalculateActualIndentation(const StringList &lines);
111
112 // Subclasses should override these functions to implement a functional REPL.
113
115
117
118 virtual const char *GetAutoIndentCharacters() = 0;
119
120 virtual bool SourceIsComplete(const std::string &source) = 0;
121
123 const StringList &lines, int cursor_position,
124 int tab_size) = 0; // LLDB_INVALID_OFFSET means no change
125
127
128 virtual bool PrintOneVariable(Debugger &debugger,
129 lldb::StreamFileSP &output_sp,
130 lldb::ValueObjectSP &valobj_sp,
131 ExpressionVariable *var = nullptr) = 0;
132
133 virtual void CompleteCode(const std::string &current_code,
134 CompletionRequest &request) = 0;
135
140
142 std::string m_indent_str; // Use this string for each level of indentation
145
148
149 StringList m_code; // All accumulated REPL statements are saved here
150
152 lldb::IOHandlerSP m_io_handler_sp;
154
155private:
156 std::string GetSourcePath();
157};
158
159} // namespace lldb_private
160
161#endif // LLDB_EXPRESSION_REPL_H
"lldb/Utility/ArgCompletionRequest.h"
A uniqued constant string class.
Definition: ConstString.h:39
A class to manage flag bits.
Definition: Debugger.h:78
A delegate class for use with IOHandler subclasses.
Definition: IOHandler.h:191
const char * IOHandlerGetHelpPrologue() override
Definition: REPL.cpp:126
static int CalculateActualIndentation(const StringList &lines)
Definition: REPL.cpp:152
virtual Status DoInitialization()=0
virtual lldb::offset_t GetDesiredIndentation(const StringList &lines, int cursor_position, int tab_size)=0
const char * IOHandlerGetFixIndentationCharacters() override
Definition: REPL.cpp:114
int IOHandlerFixIndentation(IOHandler &io_handler, const StringList &lines, int cursor_position) override
Called when a new line is created or one of an identified set of indentation characters is typed.
Definition: REPL.cpp:165
virtual const char * GetAutoIndentCharacters()=0
OptionGroupValueObjectDisplay m_varobj_options
Definition: REPL.h:137
uint32_t m_current_indent_level
Definition: REPL.h:144
bool IOHandlerInterrupt(IOHandler &io_handler) override
Definition: REPL.cpp:109
static lldb::REPLSP Create(Status &Status, lldb::LanguageType language, Debugger *debugger, Target *target, const char *repl_options)
Get a REPL with an existing target (or, failing that, a debugger to use), and (optional) extra argume...
Definition: REPL.cpp:36
std::string m_current_indent_str
Definition: REPL.h:143
std::string m_indent_str
Definition: REPL.h:142
ConstString IOHandlerGetControlSequence(char ch) override
Definition: REPL.cpp:118
virtual bool PrintOneVariable(Debugger &debugger, lldb::StreamFileSP &output_sp, lldb::ValueObjectSP &valobj_sp, ExpressionVariable *var=nullptr)=0
void IOHandlerComplete(IOHandler &io_handler, CompletionRequest &request) override
Definition: REPL.cpp:491
OptionGroupFormat m_format_options
Definition: REPL.h:136
EvaluateExpressionOptions m_expr_options
Definition: REPL.h:138
bool IOHandlerIsInputComplete(IOHandler &io_handler, StringList &lines) override
Called to determine whether typing enter after the last line in lines should end input.
Definition: REPL.cpp:138
std::string GetSourcePath()
Definition: REPL.cpp:57
bool m_enable_auto_indent
Definition: REPL.h:141
virtual ConstString GetSourceFileBasename()=0
virtual bool SourceIsComplete(const std::string &source)=0
const char * IOHandlerGetCommandPrefix() override
Definition: REPL.cpp:124
Status RunLoop()
Definition: REPL.cpp:556
void IOHandlerInputInterrupted(IOHandler &io_handler, std::string &line) override
Definition: REPL.cpp:111
void IOHandlerActivated(IOHandler &io_handler, bool interactive) override
Definition: REPL.cpp:100
virtual lldb::LanguageType GetLanguage()=0
void IOHandlerInputComplete(IOHandler &io_handler, std::string &line) override
Called when a line or lines have been retrieved.
Definition: REPL.cpp:218
lldb::IOHandlerSP m_io_handler_sp
Definition: REPL.h:152
LLVMCastKind getKind() const
Definition: REPL.h:26
void SetEvaluateOptions(const EvaluateExpressionOptions &options)
Definition: REPL.h:68
void SetValueObjectDisplayOptions(const OptionGroupValueObjectDisplay &options)
Definition: REPL.h:64
std::string m_compiler_options
Definition: REPL.h:139
StringList m_code
Definition: REPL.h:149
std::string m_repl_source_path
Definition: REPL.h:146
LLVMCastKind m_kind
Definition: REPL.h:153
lldb::IOHandlerSP GetIOHandler()
Definition: REPL.cpp:71
bool m_dedicated_repl_mode
Definition: REPL.h:147
virtual void CompleteCode(const std::string &current_code, CompletionRequest &request)=0
void SetFormatOptions(const OptionGroupFormat &options)
Definition: REPL.h:59
void SetCompilerOptions(const char *options)
Definition: REPL.h:72
Target & m_target
Definition: REPL.h:151
An error handling class.
Definition: Status.h:44
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
uint64_t offset_t
Definition: lldb-types.h:87
LanguageType
Programming language type.