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_REPL_h
10 #define lldb_REPL_h
11 
12 #include <string>
13 
14 #include "lldb/Core/IOHandler.h"
17 #include "lldb/Target/Target.h"
18 
19 namespace lldb_private {
20 
21 class REPL : public IOHandlerDelegate {
22 public:
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] error
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 
79  Status RunLoop();
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 
91  ConstString IOHandlerGetControlSequence(char ch) override;
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  int IOHandlerComplete(IOHandler &io_handler, const char *current_line,
107  const char *cursor, const char *last_char,
108  int skip_first_n_matches, int max_matches,
109  StringList &matches, StringList &descriptions) override;
110 
111 protected:
112  static int CalculateActualIndentation(const StringList &lines);
113 
114  // Subclasses should override these functions to implement a functional REPL.
115 
116  virtual Status DoInitialization() = 0;
117 
118  virtual ConstString GetSourceFileBasename() = 0;
119 
120  virtual const char *GetAutoIndentCharacters() = 0;
121 
122  virtual bool SourceIsComplete(const std::string &source) = 0;
123 
125  const StringList &lines, int cursor_position,
126  int tab_size) = 0; // LLDB_INVALID_OFFSET means no change
127 
128  virtual lldb::LanguageType GetLanguage() = 0;
129 
130  virtual bool PrintOneVariable(Debugger &debugger,
131  lldb::StreamFileSP &output_sp,
132  lldb::ValueObjectSP &valobj_sp,
133  ExpressionVariable *var = nullptr) = 0;
134 
135  virtual int CompleteCode(const std::string &current_code,
136  StringList &matches) = 0;
137 
141  std::string m_compiler_options;
142 
143  bool m_enable_auto_indent = true;
144  std::string m_indent_str; // Use this string for each level of indentation
145  std::string m_current_indent_str;
147 
148  std::string m_repl_source_path;
149  bool m_dedicated_repl_mode = false;
150 
151  StringList m_code; // All accumulated REPL statements are saved here
152 
154  lldb::IOHandlerSP m_io_handler_sp;
156 
157 private:
158  std::string GetSourcePath();
159 };
160 
161 } // namespace lldb_private
162 
163 #endif // lldb_REPL_h
A class to manage flag bits.
Definition: Debugger.h:82
virtual bool SourceIsComplete(const std::string &source)=0
lldb::IOHandlerSP m_io_handler_sp
Definition: REPL.h:154
bool m_enable_auto_indent
Definition: REPL.h:143
const char * IOHandlerGetFixIndentationCharacters() override
Definition: REPL.cpp:109
REPL(LLVMCastKind kind, Target &target)
Definition: REPL.cpp:25
Enumerations for broadcasting.
Definition: SBLaunchInfo.h:14
void SetEvaluateOptions(const EvaluateExpressionOptions &options)
Definition: REPL.h:68
LLVMCastKind getKind() const
Definition: REPL.h:26
virtual bool PrintOneVariable(Debugger &debugger, lldb::StreamFileSP &output_sp, lldb::ValueObjectSP &valobj_sp, ExpressionVariable *var=nullptr)=0
virtual const char * GetAutoIndentCharacters()=0
const char * IOHandlerGetHelpPrologue() override
Definition: REPL.cpp:121
ConstString IOHandlerGetControlSequence(char ch) override
Definition: REPL.cpp:113
bool IOHandlerInterrupt(IOHandler &io_handler) override
Definition: REPL.cpp:104
bool m_dedicated_repl_mode
Definition: REPL.h:149
static int CalculateActualIndentation(const StringList &lines)
Definition: REPL.cpp:146
void IOHandlerInputInterrupted(IOHandler &io_handler, std::string &line) override
Definition: REPL.cpp:106
A delegate class for use with IOHandler subclasses.
Definition: IOHandler.h:188
virtual lldb::offset_t GetDesiredIndentation(const StringList &lines, int cursor_position, int tab_size)=0
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:35
void IOHandlerInputComplete(IOHandler &io_handler, std::string &line) override
Called when a line or lines have been retrieved.
Definition: REPL.cpp:182
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:159
int IOHandlerComplete(IOHandler &io_handler, const char *current_line, const char *cursor, const char *last_char, int skip_first_n_matches, int max_matches, StringList &matches, StringList &descriptions) override
Definition: REPL.cpp:436
virtual lldb::LanguageType GetLanguage()=0
void SetCompilerOptions(const char *options)
Definition: REPL.h:72
std::string m_compiler_options
Definition: REPL.h:141
LanguageType
Programming language type.
uint32_t m_current_indent_level
Definition: REPL.h:146
uint64_t offset_t
Definition: lldb-types.h:87
StringList m_code
Definition: REPL.h:151
const char * IOHandlerGetCommandPrefix() override
Definition: REPL.cpp:119
void SetFormatOptions(const OptionGroupFormat &options)
Definition: REPL.h:59
LLVMCastKind m_kind
Definition: REPL.h:155
std::string m_current_indent_str
Definition: REPL.h:145
OptionGroupValueObjectDisplay m_varobj_options
Definition: REPL.h:139
EvaluateExpressionOptions m_expr_options
Definition: REPL.h:140
Target & m_target
Definition: REPL.h:153
lldb::IOHandlerSP GetIOHandler()
Definition: REPL.cpp:66
A uniqued constant string class.
Definition: ConstString.h:38
virtual Status DoInitialization()=0
OptionGroupFormat m_format_options
Definition: REPL.h:138
Status RunLoop()
Definition: REPL.cpp:500
void IOHandlerActivated(IOHandler &io_handler, bool interactive) override
Definition: REPL.cpp:95
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:132
std::string m_indent_str
Definition: REPL.h:144
virtual int CompleteCode(const std::string &current_code, StringList &matches)=0
void SetValueObjectDisplayOptions(const OptionGroupValueObjectDisplay &options)
Definition: REPL.h:64
virtual ConstString GetSourceFileBasename()=0
std::string m_repl_source_path
Definition: REPL.h:148
An error handling class.
Definition: Status.h:44