Files
clang-p2996/lldb/source/Plugins/SymbolFile/DWARF/NameToDIE.h
Walter Erquinigo 1673a1ba5d [LLDB][NFC] Create a namespace for the DWARF plugin (#68150)
As a followup of https://github.com/llvm/llvm-project/pull/67851, I'm
defining a new namespace `lldb_plugin::dwarf` for the classes in this
Plugins/SymbolFile/DWARF folder. This change is very NFC and helped me
with exporting the necessary symbols for my out-of-tree language plugin.
The only class that I didn't change is ClangDWARFASTParser, because that
shouldn't be in the same namespace as the generic language-agnostic
dwarf parser.
It would be a good idea if other plugins follow the same namespace
scheme.
2023-10-13 16:51:24 -04:00

95 lines
2.9 KiB
C++

//===-- NameToDIE.h ---------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_NAMETODIE_H
#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_NAMETODIE_H
#include <functional>
#include "DIERef.h"
#include "lldb/Core/UniqueCStringMap.h"
#include "lldb/Core/dwarf.h"
#include "lldb/lldb-defines.h"
namespace lldb_private::plugin {
namespace dwarf {
class DWARFUnit;
class NameToDIE {
public:
NameToDIE() : m_map() {}
~NameToDIE() = default;
void Dump(Stream *s);
void Insert(ConstString name, const DIERef &die_ref);
void Append(const NameToDIE &other);
void Finalize();
bool Find(ConstString name,
llvm::function_ref<bool(DIERef ref)> callback) const;
bool Find(const RegularExpression &regex,
llvm::function_ref<bool(DIERef ref)> callback) const;
/// \a unit must be the skeleton unit if possible, not GetNonSkeletonUnit().
void
FindAllEntriesForUnit(DWARFUnit &unit,
llvm::function_ref<bool(DIERef ref)> callback) const;
void
ForEach(std::function<bool(ConstString name, const DIERef &die_ref)> const
&callback) const;
/// Decode a serialized version of this object from data.
///
/// \param data
/// The decoder object that references the serialized data.
///
/// \param offset_ptr
/// A pointer that contains the offset from which the data will be decoded
/// from that gets updated as data gets decoded.
///
/// \param strtab
/// All strings in cache files are put into string tables for efficiency
/// and cache file size reduction. Strings are stored as uint32_t string
/// table offsets in the cache data.
bool Decode(const DataExtractor &data, lldb::offset_t *offset_ptr,
const StringTableReader &strtab);
/// Encode this object into a data encoder object.
///
/// This allows this object to be serialized to disk.
///
/// \param encoder
/// A data encoder object that serialized bytes will be encoded into.
///
/// \param strtab
/// All strings in cache files are put into string tables for efficiency
/// and cache file size reduction. Strings are stored as uint32_t string
/// table offsets in the cache data.
void Encode(DataEncoder &encoder, ConstStringTable &strtab) const;
/// Used for unit testing the encoding and decoding.
bool operator==(const NameToDIE &rhs) const;
bool IsEmpty() const { return m_map.IsEmpty(); }
void Clear() { m_map.Clear(); }
protected:
UniqueCStringMap<DIERef> m_map;
};
} // namespace dwarf
} // namespace lldb_private::plugin
#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_NAMETODIE_H