2009-06-02 17:58:47 +00:00
|
|
|
//===--- TemplateName.h - C++ Template Name Representation-------*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file defines the TemplateName interface and subclasses.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_CLANG_AST_TEMPLATENAME_H
|
|
|
|
#define LLVM_CLANG_AST_TEMPLATENAME_H
|
|
|
|
|
|
|
|
#include "llvm/ADT/FoldingSet.h"
|
|
|
|
#include "llvm/ADT/PointerUnion.h"
|
2009-11-04 15:04:32 +00:00
|
|
|
#include "clang/Basic/OperatorKinds.h"
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
class raw_ostream;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace clang {
|
|
|
|
|
|
|
|
class DependentTemplateName;
|
2010-05-04 16:12:48 +00:00
|
|
|
class DiagnosticBuilder;
|
2009-06-02 17:58:47 +00:00
|
|
|
class IdentifierInfo;
|
|
|
|
class NestedNameSpecifier;
|
2009-10-14 18:03:49 +00:00
|
|
|
struct PrintingPolicy;
|
2009-06-02 17:58:47 +00:00
|
|
|
class QualifiedTemplateName;
|
2009-10-14 18:03:49 +00:00
|
|
|
class NamedDecl;
|
2009-06-02 17:58:47 +00:00
|
|
|
class TemplateDecl;
|
2009-12-15 18:49:47 +00:00
|
|
|
|
|
|
|
/// \brief A structure for storing the information associated with an
|
|
|
|
/// overloaded template name.
|
|
|
|
class OverloadedTemplateStorage {
|
|
|
|
union {
|
|
|
|
unsigned Size;
|
|
|
|
NamedDecl *Storage[1];
|
|
|
|
};
|
|
|
|
|
|
|
|
friend class ASTContext;
|
|
|
|
|
|
|
|
OverloadedTemplateStorage(unsigned Size) : Size(Size) {}
|
|
|
|
|
|
|
|
NamedDecl **getStorage() {
|
|
|
|
return &Storage[1];
|
|
|
|
}
|
|
|
|
NamedDecl * const *getStorage() const {
|
|
|
|
return &Storage[1];
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
|
|
|
typedef NamedDecl *const *iterator;
|
|
|
|
|
|
|
|
unsigned size() const { return Size; }
|
|
|
|
|
|
|
|
iterator begin() const { return getStorage(); }
|
|
|
|
iterator end() const { return getStorage() + size(); }
|
|
|
|
};
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
/// \brief Represents a C++ template name within the type system.
|
|
|
|
///
|
|
|
|
/// A C++ template name refers to a template within the C++ type
|
|
|
|
/// system. In most cases, a template name is simply a reference to a
|
|
|
|
/// class template, e.g.
|
|
|
|
///
|
|
|
|
/// \code
|
|
|
|
/// template<typename T> class X { };
|
|
|
|
///
|
|
|
|
/// X<int> xi;
|
|
|
|
/// \endcode
|
|
|
|
///
|
|
|
|
/// Here, the 'X' in \c X<int> is a template name that refers to the
|
|
|
|
/// declaration of the class template X, above. Template names can
|
|
|
|
/// also refer to function templates, C++0x template aliases, etc.
|
|
|
|
///
|
|
|
|
/// Some template names are dependent. For example, consider:
|
|
|
|
///
|
|
|
|
/// \code
|
|
|
|
/// template<typename MetaFun, typename T1, typename T2> struct apply2 {
|
|
|
|
/// typedef typename MetaFun::template apply<T1, T2>::type type;
|
|
|
|
/// };
|
|
|
|
/// \endcode
|
|
|
|
///
|
|
|
|
/// Here, "apply" is treated as a template name within the typename
|
|
|
|
/// specifier in the typedef. "apply" is a nested template, and can
|
|
|
|
/// only be understood in the context of
|
|
|
|
class TemplateName {
|
2009-12-15 18:49:47 +00:00
|
|
|
typedef llvm::PointerUnion4<TemplateDecl *,
|
|
|
|
OverloadedTemplateStorage *,
|
2009-10-14 18:03:49 +00:00
|
|
|
QualifiedTemplateName *,
|
2009-06-02 17:58:47 +00:00
|
|
|
DependentTemplateName *> StorageType;
|
|
|
|
|
|
|
|
StorageType Storage;
|
|
|
|
|
|
|
|
explicit TemplateName(void *Ptr) {
|
|
|
|
Storage = StorageType::getFromOpaqueValue(Ptr);
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
2010-07-13 17:21:42 +00:00
|
|
|
// \brief Kind of name that is actually stored.
|
|
|
|
enum NameKind {
|
|
|
|
Template,
|
|
|
|
OverloadedTemplate,
|
|
|
|
QualifiedTemplate,
|
|
|
|
DependentTemplate
|
|
|
|
};
|
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
TemplateName() : Storage() { }
|
|
|
|
explicit TemplateName(TemplateDecl *Template) : Storage(Template) { }
|
2009-12-15 18:49:47 +00:00
|
|
|
explicit TemplateName(OverloadedTemplateStorage *Storage)
|
|
|
|
: Storage(Storage) { }
|
2009-06-02 17:58:47 +00:00
|
|
|
explicit TemplateName(QualifiedTemplateName *Qual) : Storage(Qual) { }
|
|
|
|
explicit TemplateName(DependentTemplateName *Dep) : Storage(Dep) { }
|
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
/// \brief Determine whether this template name is NULL.
|
|
|
|
bool isNull() const { return Storage.isNull(); }
|
2010-07-13 17:21:42 +00:00
|
|
|
|
|
|
|
// \brief Get the kind of name that is actually stored.
|
|
|
|
NameKind getKind() const;
|
2009-10-14 18:03:49 +00:00
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
/// \brief Retrieve the the underlying template declaration that
|
|
|
|
/// this template name refers to, if known.
|
|
|
|
///
|
|
|
|
/// \returns The template declaration that this template name refers
|
|
|
|
/// to, if any. If the template name does not refer to a specific
|
2009-10-14 18:03:49 +00:00
|
|
|
/// declaration because it is a dependent name, or if it refers to a
|
|
|
|
/// set of function templates, returns NULL.
|
2009-06-02 17:58:47 +00:00
|
|
|
TemplateDecl *getAsTemplateDecl() const;
|
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
/// \brief Retrieve the the underlying, overloaded function template
|
|
|
|
// declarations that this template name refers to, if known.
|
|
|
|
///
|
|
|
|
/// \returns The set of overloaded function templates that this template
|
|
|
|
/// name refers to, if known. If the template name does not refer to a
|
|
|
|
/// specific set of function templates because it is a dependent name or
|
|
|
|
/// refers to a single template, returns NULL.
|
2009-12-15 18:49:47 +00:00
|
|
|
OverloadedTemplateStorage *getAsOverloadedTemplate() const {
|
|
|
|
return Storage.dyn_cast<OverloadedTemplateStorage *>();
|
|
|
|
}
|
2009-10-14 18:03:49 +00:00
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
/// \brief Retrieve the underlying qualified template name
|
|
|
|
/// structure, if any.
|
|
|
|
QualifiedTemplateName *getAsQualifiedTemplateName() const {
|
|
|
|
return Storage.dyn_cast<QualifiedTemplateName *>();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// \brief Retrieve the underlying dependent template name
|
|
|
|
/// structure, if any.
|
|
|
|
DependentTemplateName *getAsDependentTemplateName() const {
|
|
|
|
return Storage.dyn_cast<DependentTemplateName *>();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// \brief Determines whether this is a dependent template name.
|
|
|
|
bool isDependent() const;
|
|
|
|
|
|
|
|
/// \brief Print the template name.
|
|
|
|
///
|
|
|
|
/// \param OS the output stream to which the template name will be
|
|
|
|
/// printed.
|
|
|
|
///
|
|
|
|
/// \param SuppressNNS if true, don't print the
|
|
|
|
/// nested-name-specifier that precedes the template name (if it has
|
|
|
|
/// one).
|
|
|
|
void print(llvm::raw_ostream &OS, const PrintingPolicy &Policy,
|
|
|
|
bool SuppressNNS = false) const;
|
|
|
|
|
|
|
|
/// \brief Debugging aid that dumps the template name to standard
|
|
|
|
/// error.
|
|
|
|
void dump() const;
|
|
|
|
|
|
|
|
void Profile(llvm::FoldingSetNodeID &ID) {
|
|
|
|
ID.AddPointer(Storage.getOpaqueValue());
|
|
|
|
}
|
|
|
|
|
|
|
|
/// \brief Retrieve the template name as a void pointer.
|
|
|
|
void *getAsVoidPointer() const { return Storage.getOpaqueValue(); }
|
|
|
|
|
|
|
|
/// \brief Build a template name from a void pointer.
|
2009-10-14 18:03:49 +00:00
|
|
|
static TemplateName getFromVoidPointer(void *Ptr) {
|
|
|
|
return TemplateName(Ptr);
|
2009-06-02 17:58:47 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2010-05-04 16:12:48 +00:00
|
|
|
/// Insertion operator for diagnostics. This allows sending TemplateName's
|
|
|
|
/// into a diagnostic with <<.
|
|
|
|
const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
|
|
|
|
TemplateName N);
|
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
/// \brief Represents a template name that was expressed as a
|
|
|
|
/// qualified name.
|
|
|
|
///
|
|
|
|
/// This kind of template name refers to a template name that was
|
|
|
|
/// preceded by a nested name specifier, e.g., \c std::vector. Here,
|
|
|
|
/// the nested name specifier is "std::" and the template name is the
|
|
|
|
/// declaration for "vector". The QualifiedTemplateName class is only
|
|
|
|
/// used to provide "sugar" for template names that were expressed
|
|
|
|
/// with a qualified name, and has no semantic meaning. In this
|
2010-05-27 15:17:06 +00:00
|
|
|
/// manner, it is to TemplateName what ElaboratedType is to Type,
|
2009-06-02 17:58:47 +00:00
|
|
|
/// providing extra syntactic sugar for downstream clients.
|
|
|
|
class QualifiedTemplateName : public llvm::FoldingSetNode {
|
|
|
|
/// \brief The nested name specifier that qualifies the template name.
|
|
|
|
///
|
|
|
|
/// The bit is used to indicate whether the "template" keyword was
|
|
|
|
/// present before the template name itself. Note that the
|
|
|
|
/// "template" keyword is always redundant in this case (otherwise,
|
|
|
|
/// the template name would be a dependent name and we would express
|
|
|
|
/// this name with DependentTemplateName).
|
|
|
|
llvm::PointerIntPair<NestedNameSpecifier *, 1> Qualifier;
|
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
/// \brief The template declaration or set of overloaded function templates
|
|
|
|
/// that this qualified name refers to.
|
2009-12-15 18:49:47 +00:00
|
|
|
TemplateDecl *Template;
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
friend class ASTContext;
|
|
|
|
|
|
|
|
QualifiedTemplateName(NestedNameSpecifier *NNS, bool TemplateKeyword,
|
|
|
|
TemplateDecl *Template)
|
2009-10-14 18:03:49 +00:00
|
|
|
: Qualifier(NNS, TemplateKeyword? 1 : 0),
|
2009-12-15 18:49:47 +00:00
|
|
|
Template(Template) { }
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
/// \brief Return the nested name specifier that qualifies this name.
|
|
|
|
NestedNameSpecifier *getQualifier() const { return Qualifier.getPointer(); }
|
|
|
|
|
|
|
|
/// \brief Whether the template name was prefixed by the "template"
|
|
|
|
/// keyword.
|
|
|
|
bool hasTemplateKeyword() const { return Qualifier.getInt(); }
|
|
|
|
|
2009-12-15 18:49:47 +00:00
|
|
|
/// \brief The template declaration that this qualified name refers
|
|
|
|
/// to.
|
|
|
|
TemplateDecl *getDecl() const { return Template; }
|
2009-10-14 18:03:49 +00:00
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
/// \brief The template declaration to which this qualified name
|
2009-12-15 18:49:47 +00:00
|
|
|
/// refers.
|
|
|
|
TemplateDecl *getTemplateDecl() const { return Template; }
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
void Profile(llvm::FoldingSetNodeID &ID) {
|
2009-12-15 18:49:47 +00:00
|
|
|
Profile(ID, getQualifier(), hasTemplateKeyword(), getTemplateDecl());
|
2009-06-02 17:58:47 +00:00
|
|
|
}
|
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
static void Profile(llvm::FoldingSetNodeID &ID, NestedNameSpecifier *NNS,
|
2009-12-15 18:49:47 +00:00
|
|
|
bool TemplateKeyword, TemplateDecl *Template) {
|
2009-06-02 17:58:47 +00:00
|
|
|
ID.AddPointer(NNS);
|
|
|
|
ID.AddBoolean(TemplateKeyword);
|
|
|
|
ID.AddPointer(Template);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/// \brief Represents a dependent template name that cannot be
|
|
|
|
/// resolved prior to template instantiation.
|
|
|
|
///
|
|
|
|
/// This kind of template name refers to a dependent template name,
|
2009-10-14 18:03:49 +00:00
|
|
|
/// including its nested name specifier (if any). For example,
|
2009-06-02 17:58:47 +00:00
|
|
|
/// DependentTemplateName can refer to "MetaFun::template apply",
|
|
|
|
/// where "MetaFun::" is the nested name specifier and "apply" is the
|
|
|
|
/// template name referenced. The "template" keyword is implied.
|
|
|
|
class DependentTemplateName : public llvm::FoldingSetNode {
|
|
|
|
/// \brief The nested name specifier that qualifies the template
|
|
|
|
/// name.
|
2009-11-04 15:04:32 +00:00
|
|
|
///
|
|
|
|
/// The bit stored in this qualifier describes whether the \c Name field
|
|
|
|
/// is interpreted as an IdentifierInfo pointer (when clear) or as an
|
|
|
|
/// overloaded operator kind (when set).
|
|
|
|
llvm::PointerIntPair<NestedNameSpecifier *, 1, bool> Qualifier;
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
/// \brief The dependent template name.
|
2009-11-04 15:04:32 +00:00
|
|
|
union {
|
|
|
|
/// \brief The identifier template name.
|
|
|
|
///
|
|
|
|
/// Only valid when the bit on \c Qualifier is clear.
|
|
|
|
const IdentifierInfo *Identifier;
|
|
|
|
|
|
|
|
/// \brief The overloaded operator name.
|
|
|
|
///
|
|
|
|
/// Only valid when the bit on \c Qualifier is set.
|
|
|
|
OverloadedOperatorKind Operator;
|
|
|
|
};
|
2009-06-02 17:58:47 +00:00
|
|
|
|
|
|
|
/// \brief The canonical template name to which this dependent
|
|
|
|
/// template name refers.
|
|
|
|
///
|
|
|
|
/// The canonical template name for a dependent template name is
|
|
|
|
/// another dependent template name whose nested name specifier is
|
|
|
|
/// canonical.
|
|
|
|
TemplateName CanonicalTemplateName;
|
|
|
|
|
|
|
|
friend class ASTContext;
|
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
DependentTemplateName(NestedNameSpecifier *Qualifier,
|
2009-11-04 15:04:32 +00:00
|
|
|
const IdentifierInfo *Identifier)
|
|
|
|
: Qualifier(Qualifier, false), Identifier(Identifier),
|
|
|
|
CanonicalTemplateName(this) { }
|
2009-06-02 17:58:47 +00:00
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
DependentTemplateName(NestedNameSpecifier *Qualifier,
|
2009-11-04 15:04:32 +00:00
|
|
|
const IdentifierInfo *Identifier,
|
2009-06-02 17:58:47 +00:00
|
|
|
TemplateName Canon)
|
2009-11-04 15:04:32 +00:00
|
|
|
: Qualifier(Qualifier, false), Identifier(Identifier),
|
|
|
|
CanonicalTemplateName(Canon) { }
|
2009-06-02 17:58:47 +00:00
|
|
|
|
2009-11-04 15:04:32 +00:00
|
|
|
DependentTemplateName(NestedNameSpecifier *Qualifier,
|
|
|
|
OverloadedOperatorKind Operator)
|
|
|
|
: Qualifier(Qualifier, true), Operator(Operator),
|
|
|
|
CanonicalTemplateName(this) { }
|
|
|
|
|
|
|
|
DependentTemplateName(NestedNameSpecifier *Qualifier,
|
|
|
|
OverloadedOperatorKind Operator,
|
|
|
|
TemplateName Canon)
|
|
|
|
: Qualifier(Qualifier, true), Operator(Operator),
|
|
|
|
CanonicalTemplateName(Canon) { }
|
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
public:
|
|
|
|
/// \brief Return the nested name specifier that qualifies this name.
|
2009-11-04 15:04:32 +00:00
|
|
|
NestedNameSpecifier *getQualifier() const { return Qualifier.getPointer(); }
|
2009-06-02 17:58:47 +00:00
|
|
|
|
2009-11-04 15:04:32 +00:00
|
|
|
/// \brief Determine whether this template name refers to an identifier.
|
|
|
|
bool isIdentifier() const { return !Qualifier.getInt(); }
|
2009-06-02 17:58:47 +00:00
|
|
|
|
2009-11-04 15:04:32 +00:00
|
|
|
/// \brief Returns the identifier to which this template name refers.
|
|
|
|
const IdentifierInfo *getIdentifier() const {
|
|
|
|
assert(isIdentifier() && "Template name isn't an identifier?");
|
|
|
|
return Identifier;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// \brief Determine whether this template name refers to an overloaded
|
|
|
|
/// operator.
|
|
|
|
bool isOverloadedOperator() const { return Qualifier.getInt(); }
|
|
|
|
|
|
|
|
/// \brief Return the overloaded operator to which this template name refers.
|
|
|
|
OverloadedOperatorKind getOperator() const {
|
|
|
|
assert(isOverloadedOperator() &&
|
|
|
|
"Template name isn't an overloaded operator?");
|
|
|
|
return Operator;
|
|
|
|
}
|
|
|
|
|
2009-06-02 17:58:47 +00:00
|
|
|
void Profile(llvm::FoldingSetNodeID &ID) {
|
2009-11-04 15:04:32 +00:00
|
|
|
if (isIdentifier())
|
|
|
|
Profile(ID, getQualifier(), getIdentifier());
|
|
|
|
else
|
|
|
|
Profile(ID, getQualifier(), getOperator());
|
|
|
|
}
|
|
|
|
|
|
|
|
static void Profile(llvm::FoldingSetNodeID &ID, NestedNameSpecifier *NNS,
|
|
|
|
const IdentifierInfo *Identifier) {
|
|
|
|
ID.AddPointer(NNS);
|
|
|
|
ID.AddBoolean(false);
|
|
|
|
ID.AddPointer(Identifier);
|
2009-06-02 17:58:47 +00:00
|
|
|
}
|
|
|
|
|
2009-10-14 18:03:49 +00:00
|
|
|
static void Profile(llvm::FoldingSetNodeID &ID, NestedNameSpecifier *NNS,
|
2009-11-04 15:04:32 +00:00
|
|
|
OverloadedOperatorKind Operator) {
|
2009-06-02 17:58:47 +00:00
|
|
|
ID.AddPointer(NNS);
|
2009-11-04 15:04:32 +00:00
|
|
|
ID.AddBoolean(true);
|
|
|
|
ID.AddInteger(Operator);
|
2009-06-02 17:58:47 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
} // end namespace clang.
|
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
|
|
|
/// \brief The clang::TemplateName class is effectively a pointer.
|
|
|
|
template<>
|
|
|
|
class PointerLikeTypeTraits<clang::TemplateName> {
|
|
|
|
public:
|
|
|
|
static inline void *getAsVoidPointer(clang::TemplateName TN) {
|
|
|
|
return TN.getAsVoidPointer();
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline clang::TemplateName getFromVoidPointer(void *Ptr) {
|
|
|
|
return clang::TemplateName::getFromVoidPointer(Ptr);
|
|
|
|
}
|
|
|
|
|
|
|
|
// No bits are available!
|
|
|
|
enum { NumLowBitsAvailable = 0 };
|
|
|
|
};
|
|
|
|
|
|
|
|
} // end namespace llvm.
|
|
|
|
|
|
|
|
#endif
|