blob: 67290b9be0663a3739e9d7bc415f9e0b0fab8268 [file] [log] [blame]
//===-- CompilerDecl.h ------------------------------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "lldb/Symbol/CompilerType.h"
#include "lldb/Utility/ConstString.h"
#include "lldb/lldb-private.h"
namespace lldb_private {
/// Represents a generic declaration such as a function declaration.
/// This class serves as an abstraction for a declaration inside one of the
/// TypeSystems implemented by the language plugins. It does not have any actual
/// logic in it but only stores an opaque pointer and a pointer to the
/// TypeSystem that gives meaning to this opaque pointer. All methods of this
/// class should call their respective method in the TypeSystem interface and
/// pass the opaque pointer along.
/// \see lldb_private::TypeSystem
class CompilerDecl {
// Constructors and Destructors
CompilerDecl() = default;
/// Creates a CompilerDecl with the given TypeSystem and opaque pointer.
/// This constructor should only be called from the respective TypeSystem
/// implementation.
CompilerDecl(TypeSystem *type_system, void *decl)
: m_type_system(type_system), m_opaque_decl(decl) {}
// Tests
explicit operator bool() const { return IsValid(); }
bool operator<(const CompilerDecl &rhs) const {
if (m_type_system == rhs.m_type_system)
return m_opaque_decl < rhs.m_opaque_decl;
return m_type_system < rhs.m_type_system;
bool IsValid() const {
return m_type_system != nullptr && m_opaque_decl != nullptr;
// Accessors
TypeSystem *GetTypeSystem() const { return m_type_system; }
void *GetOpaqueDecl() const { return m_opaque_decl; }
void SetDecl(TypeSystem *type_system, void *decl) {
m_type_system = type_system;
m_opaque_decl = decl;
void Clear() {
m_type_system = nullptr;
m_opaque_decl = nullptr;
ConstString GetName() const;
ConstString GetMangledName() const;
CompilerDeclContext GetDeclContext() const;
// If this decl represents a function, return the return type
CompilerType GetFunctionReturnType() const;
// If this decl represents a function, return the number of arguments for the
// function
size_t GetNumFunctionArguments() const;
// If this decl represents a function, return the argument type given a zero
// based argument index
CompilerType GetFunctionArgumentType(size_t arg_idx) const;
TypeSystem *m_type_system = nullptr;
void *m_opaque_decl = nullptr;
bool operator==(const CompilerDecl &lhs, const CompilerDecl &rhs);
bool operator!=(const CompilerDecl &lhs, const CompilerDecl &rhs);
} // namespace lldb_private