1 //===-- DWARFIndex.h -------------------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFINDEX_H
10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFINDEX_H
12 #include "Plugins/SymbolFile/DWARF/DIERef.h"
13 #include "Plugins/SymbolFile/DWARF/DWARFDIE.h"
14 #include "Plugins/SymbolFile/DWARF/DWARFFormValue.h"
16 class DWARFDeclContext;
19 namespace lldb_private {
22 DWARFIndex(Module &module) : m_module(module) {}
23 virtual ~DWARFIndex();
25 virtual void Preload() = 0;
27 /// Finds global variables with the given base name. Any additional filtering
28 /// (e.g., to only retrieve variables from a given context) should be done by
31 GetGlobalVariables(ConstString basename,
32 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
35 GetGlobalVariables(const RegularExpression ®ex,
36 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
38 GetGlobalVariables(const DWARFUnit &cu,
39 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
41 GetObjCMethods(ConstString class_name,
42 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
44 GetCompleteObjCClass(ConstString class_name, bool must_be_implementation,
45 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
46 virtual void GetTypes(ConstString name,
47 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
48 virtual void GetTypes(const DWARFDeclContext &context,
49 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
51 GetNamespaces(ConstString name,
52 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
54 GetFunctions(ConstString name, SymbolFileDWARF &dwarf,
55 const CompilerDeclContext &parent_decl_ctx,
56 uint32_t name_type_mask,
57 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
59 GetFunctions(const RegularExpression ®ex,
60 llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
62 virtual void Dump(Stream &s) = 0;
67 /// Helper function implementing common logic for processing function dies. If
68 /// the function given by "ref" matches search criteria given by
69 /// "parent_decl_ctx" and "name_type_mask", it is inserted into the "dies"
71 bool ProcessFunctionDIE(llvm::StringRef name, DIERef ref,
72 SymbolFileDWARF &dwarf,
73 const CompilerDeclContext &parent_decl_ctx,
74 uint32_t name_type_mask,
75 llvm::function_ref<bool(DWARFDIE die)> callback);
77 class DIERefCallbackImpl {
79 DIERefCallbackImpl(const DWARFIndex &index,
80 llvm::function_ref<bool(DWARFDIE die)> callback,
81 llvm::StringRef name);
82 bool operator()(DIERef ref) const;
85 const DWARFIndex &m_index;
86 SymbolFileDWARF &m_dwarf;
87 const llvm::function_ref<bool(DWARFDIE die)> m_callback;
88 const llvm::StringRef m_name;
91 DIERefCallback(llvm::function_ref<bool(DWARFDIE die)> callback,
92 llvm::StringRef name = {}) const {
93 return DIERefCallbackImpl(*this, callback, name);
96 void ReportInvalidDIERef(DIERef ref, llvm::StringRef name) const;
98 } // namespace lldb_private
100 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFINDEX_H