include/clang/AST/ASTImporter.h

   1 //===--- ASTImporter.h - Importing ASTs from other Contexts -----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file defines the ASTImporter class which imports AST nodes from one
  11 //  context into another context.
  12 //
  13 //===----------------------------------------------------------------------===//
  14 #ifndef LLVM_CLANG_AST_ASTIMPORTER_H
  15 #define LLVM_CLANG_AST_ASTIMPORTER_H
  16
  17 #include "clang/AST/DeclarationName.h"
  18 #include "clang/AST/Type.h"
  19 #include "clang/Basic/SourceLocation.h"
  20 #include "llvm/ADT/DenseMap.h"
  21 #include "llvm/ADT/DenseSet.h"
  22 #include "llvm/ADT/SmallVector.h"
  23
  24 namespace clang {
  25   class ASTContext;
  26   class Decl;
  27   class DeclContext;
  28   class Diagnostic;
  29   class Expr;
  30   class FileManager;
  31   class FileSystemOptions;
  32   class IdentifierInfo;
  33   class NestedNameSpecifier;
  34   class Stmt;
  35   class TypeSourceInfo;
  36
  37   /// \brief Imports selected nodes from one AST context into another context,
  38   /// merging AST nodes where appropriate.
  39   class ASTImporter {
  40   public:
  41     typedef llvm::DenseSet<std::pair<Decl *, Decl *> > NonEquivalentDeclSet;
  42
  43   private:
  44     /// \brief The contexts we're importing to and from.
  45     ASTContext &ToContext, &FromContext;
  46
  47     /// \brief The file managers we're importing to and from.
  48     FileManager &ToFileManager, &FromFileManager;
  49
  50     const FileSystemOptions &ToFileSystemOpts, &FromFileSystemOpts;
  51
  52     /// \brief The diagnostics object that we should use to emit diagnostics.
  53     Diagnostic &Diags;
  54
  55     /// \brief Mapping from the already-imported types in the "from" context
  56     /// to the corresponding types in the "to" context.
  57     llvm::DenseMap<Type *, Type *> ImportedTypes;
  58
  59     /// \brief Mapping from the already-imported declarations in the "from"
  60     /// context to the corresponding declarations in the "to" context.
  61     llvm::DenseMap<Decl *, Decl *> ImportedDecls;
  62
  63     /// \brief Mapping from the already-imported statements in the "from"
  64     /// context to the corresponding statements in the "to" context.
  65     llvm::DenseMap<Stmt *, Stmt *> ImportedStmts;
  66
  67     /// \brief Mapping from the already-imported FileIDs in the "from" source
  68     /// manager to the corresponding FileIDs in the "to" source manager.
  69     llvm::DenseMap<FileID, FileID> ImportedFileIDs;
  70
  71     /// \brief Imported, anonymous tag declarations that are missing their
  72     /// corresponding typedefs.
  73     llvm::SmallVector<TagDecl *, 4> AnonTagsWithPendingTypedefs;
  74
  75     /// \brief Declaration (from, to) pairs that are known not to be equivalent
  76     /// (which we have already complained about).
  77     NonEquivalentDeclSet NonEquivalentDecls;
  78
  79   public:
  80     ASTImporter(Diagnostic &Diags,
  81                 ASTContext &ToContext, FileManager &ToFileManager,
  82                 const FileSystemOptions &ToFileSystemOpts,
  83                 ASTContext &FromContext, FileManager &FromFileManager,
  84                 const FileSystemOptions &FromFileSystemOpts);
  85
  86     virtual ~ASTImporter();
  87
  88     /// \brief Import the given type from the "from" context into the "to"
  89     /// context.
  90     ///
  91     /// \returns the equivalent type in the "to" context, or a NULL type if
  92     /// an error occurred.
  93     QualType Import(QualType FromT);
  94
  95     /// \brief Import the given type source information from the
  96     /// "from" context into the "to" context.
  97     ///
  98     /// \returns the equivalent type source information in the "to"
  99     /// context, or NULL if an error occurred.
 100     TypeSourceInfo *Import(TypeSourceInfo *FromTSI);
 101
 102     /// \brief Import the given declaration from the "from" context into the
 103     /// "to" context.
 104     ///
 105     /// \returns the equivalent declaration in the "to" context, or a NULL type
 106     /// if an error occurred.
 107     Decl *Import(Decl *FromD);
 108
 109     /// \brief Import the given declaration context from the "from"
 110     /// AST context into the "to" AST context.
 111     ///
 112     /// \returns the equivalent declaration context in the "to"
 113     /// context, or a NULL type if an error occurred.
 114     DeclContext *ImportContext(DeclContext *FromDC);
 115
 116     /// \brief Import the given expression from the "from" context into the
 117     /// "to" context.
 118     ///
 119     /// \returns the equivalent expression in the "to" context, or NULL if
 120     /// an error occurred.
 121     Expr *Import(Expr *FromE);
 122
 123     /// \brief Import the given statement from the "from" context into the
 124     /// "to" context.
 125     ///
 126     /// \returns the equivalent statement in the "to" context, or NULL if
 127     /// an error occurred.
 128     Stmt *Import(Stmt *FromS);
 129
 130     /// \brief Import the given nested-name-specifier from the "from"
 131     /// context into the "to" context.
 132     ///
 133     /// \returns the equivalent nested-name-specifier in the "to"
 134     /// context, or NULL if an error occurred.
 135     NestedNameSpecifier *Import(NestedNameSpecifier *FromNNS);
 136
 137     /// \brief Import the given source location from the "from" context into
 138     /// the "to" context.
 139     ///
 140     /// \returns the equivalent source location in the "to" context, or an
 141     /// invalid source location if an error occurred.
 142     SourceLocation Import(SourceLocation FromLoc);
 143
 144     /// \brief Import the given source range from the "from" context into
 145     /// the "to" context.
 146     ///
 147     /// \returns the equivalent source range in the "to" context, or an
 148     /// invalid source location if an error occurred.
 149     SourceRange Import(SourceRange FromRange);
 150
 151     /// \brief Import the given declaration name from the "from"
 152     /// context into the "to" context.
 153     ///
 154     /// \returns the equivalent declaration name in the "to" context,
 155     /// or an empty declaration name if an error occurred.
 156     DeclarationName Import(DeclarationName FromName);
 157
 158     /// \brief Import the given identifier from the "from" context
 159     /// into the "to" context.
 160     ///
 161     /// \returns the equivalent identifier in the "to" context.
 162     IdentifierInfo *Import(IdentifierInfo *FromId);
 163
 164     /// \brief Import the given Objective-C selector from the "from"
 165     /// context into the "to" context.
 166     ///
 167     /// \returns the equivalent selector in the "to" context.
 168     Selector Import(Selector FromSel);
 169
 170     /// \brief Import the given file ID from the "from" context into the
 171     /// "to" context.
 172     ///
 173     /// \returns the equivalent file ID in the source manager of the "to"
 174     /// context.
 175     FileID Import(FileID);
 176
 177     /// \brief Cope with a name conflict when importing a declaration into the
 178     /// given context.
 179     ///
 180     /// This routine is invoked whenever there is a name conflict while
 181     /// importing a declaration. The returned name will become the name of the
 182     /// imported declaration. By default, the returned name is the same as the
 183     /// original name, leaving the conflict unresolve such that name lookup
 184     /// for this name is likely to find an ambiguity later.
 185     ///
 186     /// Subclasses may override this routine to resolve the conflict, e.g., by
 187     /// renaming the declaration being imported.
 188     ///
 189     /// \param Name the name of the declaration being imported, which conflicts
 190     /// with other declarations.
 191     ///
 192     /// \param DC the declaration context (in the "to" AST context) in which
 193     /// the name is being imported.
 194     ///
 195     /// \param IDNS the identifier namespace in which the name will be found.
 196     ///
 197     /// \param Decls the set of declarations with the same name as the
 198     /// declaration being imported.
 199     ///
 200     /// \param NumDecls the number of conflicting declarations in \p Decls.
 201     ///
 202     /// \returns the name that the newly-imported declaration should have.
 203     virtual DeclarationName HandleNameConflict(DeclarationName Name,
 204                                                DeclContext *DC,
 205                                                unsigned IDNS,
 206                                                NamedDecl **Decls,
 207                                                unsigned NumDecls);
 208
 209     /// \brief Retrieve the context that AST nodes are being imported into.
 210     ASTContext &getToContext() const { return ToContext; }
 211
 212     /// \brief Retrieve the context that AST nodes are being imported from.
 213     ASTContext &getFromContext() const { return FromContext; }
 214
 215     /// \brief Retrieve the file manager that AST nodes are being imported into.
 216     FileManager &getToFileManager() const { return ToFileManager; }
 217
 218     /// \brief Retrieve the file manager that AST nodes are being imported from.
 219     FileManager &getFromFileManager() const { return FromFileManager; }
 220
 221     /// \brief Retrieve the diagnostic formatter.
 222     Diagnostic &getDiags() const { return Diags; }
 223
 224     /// \brief Report a diagnostic in the "to" context.
 225     DiagnosticBuilder ToDiag(SourceLocation Loc, unsigned DiagID);
 226
 227     /// \brief Report a diagnostic in the "from" context.
 228     DiagnosticBuilder FromDiag(SourceLocation Loc, unsigned DiagID);
 229
 230     /// \brief Return the set of declarations that we know are not equivalent.
 231     NonEquivalentDeclSet &getNonEquivalentDecls() { return NonEquivalentDecls; }
 232
 233     /// \brief Note that we have imported the "from" declaration by mapping it
 234     /// to the (potentially-newly-created) "to" declaration.
 235     ///
 236     /// \returns \p To
 237     Decl *Imported(Decl *From, Decl *To);
 238
 239     /// \brief Determine whether the given types are structurally
 240     /// equivalent.
 241     bool IsStructurallyEquivalent(QualType From, QualType To);
 242   };
 243 }
 244
 245 #endif // LLVM_CLANG_AST_ASTIMPORTER_H