1 //===-- ClangExpressionSourceCode.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_SOURCE_PLUGINS_EXPRESSIONPARSER_CLANG_CLANGEXPRESSIONSOURCECODE_H 10 #define LLDB_SOURCE_PLUGINS_EXPRESSIONPARSER_CLANG_CLANGEXPRESSIONSOURCECODE_H 11 12 #include "lldb/Expression/Expression.h" 13 #include "lldb/Expression/ExpressionSourceCode.h" 14 #include "lldb/lldb-enumerations.h" 15 #include "llvm/ADT/ArrayRef.h" 16 #include "llvm/ADT/StringRef.h" 17 18 #include <string> 19 20 namespace lldb_private { 21 22 class ExecutionContext; 23 24 class ClangExpressionSourceCode : public ExpressionSourceCode { 25 public: 26 /// The file name we use for the wrapper code that we inject before 27 /// the user expression. 28 static const llvm::StringRef g_prefix_file_name; 29 static const char *g_expression_prefix; 30 static const char *g_expression_suffix; 31 32 /// The possible ways an expression can be wrapped. 33 enum class WrapKind { 34 /// Wrapped in a non-static member function of a C++ class. 35 CppMemberFunction, 36 /// Wrapped in a static member function of a C++ class. 37 CppStaticMemberFunction, 38 /// Wrapped in an instance Objective-C method. 39 ObjCInstanceMethod, 40 /// Wrapped in a static Objective-C method. 41 ObjCStaticMethod, 42 /// Wrapped in a non-member function. 43 Function 44 }; 45 46 static ClangExpressionSourceCode *CreateWrapped(llvm::StringRef filename, 47 llvm::StringRef prefix, 48 llvm::StringRef body, 49 WrapKind wrap_kind) { 50 return new ClangExpressionSourceCode(filename, "$__lldb_expr", prefix, body, 51 Wrap, wrap_kind); 52 } 53 54 /// Generates the source code that will evaluate the expression. 55 /// 56 /// \param text output parameter containing the source code string. 57 /// \param exe_ctx The execution context in which the expression will be 58 /// evaluated. 59 /// \param add_locals True iff local variables should be injected into the 60 /// expression source code. 61 /// \param force_add_all_locals True iff all local variables should be 62 /// injected even if they are not used in the expression. 63 /// \param modules A list of (C++) modules that the expression should import. 64 /// 65 /// \return true iff the source code was successfully generated. 66 bool GetText(std::string &text, ExecutionContext &exe_ctx, bool add_locals, 67 bool force_add_all_locals, 68 llvm::ArrayRef<std::string> modules) const; 69 70 // Given a string returned by GetText, find the beginning and end of the body 71 // passed to CreateWrapped. Return true if the bounds could be found. This 72 // will also work on text with FixItHints applied. 73 bool GetOriginalBodyBounds(std::string transformed_text, 74 size_t &start_loc, size_t &end_loc); 75 76 protected: 77 ClangExpressionSourceCode(llvm::StringRef filename, llvm::StringRef name, 78 llvm::StringRef prefix, llvm::StringRef body, 79 Wrapping wrap, WrapKind wrap_kind); 80 81 private: 82 void AddLocalVariableDecls(const lldb::VariableListSP &var_list_sp, 83 StreamString &stream, 84 const std::string &expr) const; 85 86 /// String marking the start of the user expression. 87 std::string m_start_marker; 88 /// String marking the end of the user expression. 89 std::string m_end_marker; 90 /// How the expression has been wrapped. 91 const WrapKind m_wrap_kind; 92 }; 93 94 } // namespace lldb_private 95 96 #endif 97