LLDB mainline
DebugMacros.h
Go to the documentation of this file.
1//===-- DebugMacros.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_SYMBOL_DEBUGMACROS_H
10#define LLDB_SYMBOL_DEBUGMACROS_H
11
12#include <memory>
13#include <vector>
14
16#include "lldb/lldb-private.h"
17
18namespace lldb_private {
19
20class CompileUnit;
21class DebugMacros;
22typedef std::shared_ptr<DebugMacros> DebugMacrosSP;
23
25public:
26 enum EntryType : uint8_t {
28 };
29
30 static DebugMacroEntry CreateDefineEntry(uint32_t line, const char *str);
31
32 static DebugMacroEntry CreateUndefEntry(uint32_t line, const char *str);
33
35 uint32_t debug_line_file_idx);
36
38
39 static DebugMacroEntry
40 CreateIndirectEntry(const DebugMacrosSP &debug_macros_sp);
41
43
44 ~DebugMacroEntry() = default;
45
46 EntryType GetType() const { return static_cast<EntryType>(m_type); }
47
48 uint64_t GetLineNumber() const { return m_line; }
49
50 ConstString GetMacroString() const { return m_str; }
51
52 const FileSpec &GetFileSpec(CompileUnit *comp_unit) const;
53
55 return m_debug_macros_sp.get();
56 }
57
58private:
59 DebugMacroEntry(EntryType type, uint32_t line, uint32_t debug_line_file_idx,
60 const char *str);
61
62 DebugMacroEntry(EntryType type, const DebugMacrosSP &debug_macros_sp);
63
69};
70
72public:
73 DebugMacros() = default;
74
75 ~DebugMacros() = default;
76
77 void AddMacroEntry(const DebugMacroEntry &entry) {
78 m_macro_entries.push_back(entry);
79 }
80
81 size_t GetNumMacroEntries() const { return m_macro_entries.size(); }
82
83 DebugMacroEntry GetMacroEntryAtIndex(const size_t index) const {
84 if (index < m_macro_entries.size())
85 return m_macro_entries[index];
86 else
87 return DebugMacroEntry();
88 }
89
90private:
91 DebugMacros(const DebugMacros &) = delete;
92 const DebugMacros &operator=(const DebugMacros &) = delete;
93
94 std::vector<DebugMacroEntry> m_macro_entries;
95};
96
97} // namespace lldb_private
98
99#endif // LLDB_SYMBOL_DEBUGMACROS_H
FormatEntity::Entry::Type EntryType
A class that describes a compilation unit.
Definition: CompileUnit.h:41
A uniqued constant string class.
Definition: ConstString.h:39
static DebugMacroEntry CreateIndirectEntry(const DebugMacrosSP &debug_macros_sp)
Definition: DebugMacros.cpp:51
ConstString GetMacroString() const
Definition: DebugMacros.h:50
static DebugMacroEntry CreateEndFileEntry()
Definition: DebugMacros.cpp:46
static DebugMacroEntry CreateUndefEntry(uint32_t line, const char *str)
Definition: DebugMacros.cpp:34
const FileSpec & GetFileSpec(CompileUnit *comp_unit) const
Definition: DebugMacros.cpp:25
static DebugMacroEntry CreateDefineEntry(uint32_t line, const char *str)
Definition: DebugMacros.cpp:29
DebugMacros * GetIndirectDebugMacros() const
Definition: DebugMacros.h:54
DebugMacrosSP m_debug_macros_sp
Definition: DebugMacros.h:68
EntryType GetType() const
Definition: DebugMacros.h:46
static DebugMacroEntry CreateStartFileEntry(uint32_t line, uint32_t debug_line_file_idx)
Definition: DebugMacros.cpp:40
uint64_t GetLineNumber() const
Definition: DebugMacros.h:48
std::vector< DebugMacroEntry > m_macro_entries
Definition: DebugMacros.h:94
DebugMacroEntry GetMacroEntryAtIndex(const size_t index) const
Definition: DebugMacros.h:83
void AddMacroEntry(const DebugMacroEntry &entry)
Definition: DebugMacros.h:77
size_t GetNumMacroEntries() const
Definition: DebugMacros.h:81
const DebugMacros & operator=(const DebugMacros &)=delete
DebugMacros(const DebugMacros &)=delete
A file utility class.
Definition: FileSpec.h:56
A class that represents a running process on the host machine.
std::shared_ptr< DebugMacros > DebugMacrosSP
Definition: DebugMacros.h:22