blob: 1ef420d98248f8034bed5ad0d9e4bb2377a9cba7 [file] [log] [blame]
//===--- ConcreteDeclRef.h - Reference to a concrete decl -------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file defines the ConcreteDeclRef class, which provides a reference to
// a declaration that is potentially specialized.
//===----------------------------------------------------------------------===//
#ifndef SWIFT_AST_CONCRETEDECLREF_H
#define SWIFT_AST_CONCRETEDECLREF_H
#include "swift/Basic/Debug.h"
#include "swift/Basic/LLVM.h"
#include "swift/AST/SubstitutionMap.h"
#include "swift/AST/TypeAlignments.h"
#include "llvm/ADT/PointerUnion.h"
#include "llvm/Support/Compiler.h"
#include <cstring>
namespace swift {
class ASTContext;
class SourceManager;
class ValueDecl;
/// A reference to a concrete representation of a particular declaration,
/// providing substitutions for all type parameters of the original,
/// underlying declaration.
class ConcreteDeclRef {
/// The declaration.
ValueDecl *decl = nullptr;
/// The substitutions.
SubstitutionMap substitutions;
public:
/// Create an empty declaration reference.
ConcreteDeclRef() { }
/// Construct a reference to the given value.
ConcreteDeclRef(ValueDecl *decl) : decl(decl) { }
/// Construct a reference to the given value, specialized with the given
/// substitutions.
///
/// \param decl The declaration to which this reference refers, which will
/// be specialized by applying the given substitutions.
///
/// \param substitutions The complete set of substitutions to apply to the
/// given declaration.
ConcreteDeclRef(ValueDecl *decl, SubstitutionMap substitutions)
: decl(decl), substitutions(substitutions) { }
/// Determine whether this declaration reference refers to anything.
explicit operator bool() const { return decl != nullptr; }
/// Retrieve the declarations to which this reference refers.
ValueDecl *getDecl() const { return decl; }
/// Retrieve a reference to the declaration this one overrides.
ConcreteDeclRef getOverriddenDecl() const;
/// Determine whether this reference specializes the declaration to which
/// it refers.
bool isSpecialized() const { return !substitutions.empty(); }
/// For a specialized reference, return the set of substitutions applied to
/// the declaration reference.
SubstitutionMap getSubstitutions() const { return substitutions; }
friend bool operator==(ConcreteDeclRef lhs, ConcreteDeclRef rhs) {
return lhs.decl == rhs.decl && lhs.substitutions == rhs.substitutions;
}
/// Dump a debug representation of this reference.
void dump(raw_ostream &os) const;
SWIFT_DEBUG_DUMP;
};
} // end namespace swift
#endif