1 //===-- SymbolFileSymtab.h --------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef liblldb_SymbolFileSymtab_h_
11 #define liblldb_SymbolFileSymtab_h_
12 
13 // C Includes
14 // C++ Includes
15 #include <map>
16 #include <vector>
17 
18 // Other libraries and framework includes
19 // Project includes
20 #include "lldb/Symbol/SymbolFile.h"
21 #include "lldb/Symbol/Symtab.h"
22 
23 class SymbolFileSymtab : public lldb_private::SymbolFile {
24 public:
25   //------------------------------------------------------------------
26   // Constructors and Destructors
27   //------------------------------------------------------------------
28   SymbolFileSymtab(lldb_private::ObjectFile *obj_file);
29 
30   ~SymbolFileSymtab() override;
31 
32   //------------------------------------------------------------------
33   // Static Functions
34   //------------------------------------------------------------------
35   static void Initialize();
36 
37   static void Terminate();
38 
39   static lldb_private::ConstString GetPluginNameStatic();
40 
41   static const char *GetPluginDescriptionStatic();
42 
43   static lldb_private::SymbolFile *
44   CreateInstance(lldb_private::ObjectFile *obj_file);
45 
46   uint32_t CalculateAbilities() override;
47 
48   //------------------------------------------------------------------
49   // Compile Unit function calls
50   //------------------------------------------------------------------
51   uint32_t GetNumCompileUnits() override;
52 
53   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
54 
55   lldb::LanguageType
56   ParseCompileUnitLanguage(const lldb_private::SymbolContext &sc) override;
57 
58   size_t
59   ParseCompileUnitFunctions(const lldb_private::SymbolContext &sc) override;
60 
61   bool
62   ParseCompileUnitLineTable(const lldb_private::SymbolContext &sc) override;
63 
64   bool
65   ParseCompileUnitDebugMacros(const lldb_private::SymbolContext &sc) override;
66 
67   bool ParseCompileUnitSupportFiles(
68       const lldb_private::SymbolContext &sc,
69       lldb_private::FileSpecList &support_files) override;
70 
71   bool ParseImportedModules(
72       const lldb_private::SymbolContext &sc,
73       std::vector<lldb_private::ConstString> &imported_modules) override;
74 
75   size_t ParseFunctionBlocks(const lldb_private::SymbolContext &sc) override;
76 
77   size_t ParseTypes(const lldb_private::SymbolContext &sc) override;
78 
79   size_t
80   ParseVariablesForContext(const lldb_private::SymbolContext &sc) override;
81 
82   lldb_private::Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
83   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
84       lldb::user_id_t type_uid,
85       const lldb_private::ExecutionContext *exe_ctx) override;
86 
87   bool CompleteType(lldb_private::CompilerType &compiler_type) override;
88 
89   uint32_t ResolveSymbolContext(const lldb_private::Address &so_addr,
90                                 lldb::SymbolContextItem resolve_scope,
91                                 lldb_private::SymbolContext &sc) override;
92 
93   size_t GetTypes(lldb_private::SymbolContextScope *sc_scope,
94                   lldb::TypeClass type_mask,
95                   lldb_private::TypeList &type_list) override;
96 
97   //------------------------------------------------------------------
98   // PluginInterface protocol
99   //------------------------------------------------------------------
100   lldb_private::ConstString GetPluginName() override;
101 
102   uint32_t GetPluginVersion() override;
103 
104 protected:
105   typedef std::map<lldb_private::ConstString, lldb::TypeSP> TypeMap;
106 
107   lldb_private::Symtab::IndexCollection m_source_indexes;
108   lldb_private::Symtab::IndexCollection m_func_indexes;
109   lldb_private::Symtab::IndexCollection m_code_indexes;
110   lldb_private::Symtab::IndexCollection m_data_indexes;
111   lldb_private::Symtab::NameToIndexMap m_objc_class_name_to_index;
112   TypeMap m_objc_class_types;
113 
114 private:
115   DISALLOW_COPY_AND_ASSIGN(SymbolFileSymtab);
116 };
117 
118 #endif // liblldb_SymbolFileSymtab_h_
119