contrib/llvm/tools/clang/include/clang/Sema/Lookup.h

   1 //===--- Lookup.h - Classes for name lookup ---------------------*- 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 LookupResult class, which is integral to
  11 // Sema's name-lookup subsystem.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_SEMA_LOOKUP_H
  16 #define LLVM_CLANG_SEMA_LOOKUP_H
  17
  18 #include "clang/Sema/Sema.h"
  19 #include "clang/AST/DeclCXX.h"
  20
  21 namespace clang {
  22
  23 /// @brief Represents the results of name lookup.
  24 ///
  25 /// An instance of the LookupResult class captures the results of a
  26 /// single name lookup, which can return no result (nothing found),
  27 /// a single declaration, a set of overloaded functions, or an
  28 /// ambiguity. Use the getKind() method to determine which of these
  29 /// results occurred for a given lookup.
  30 class LookupResult {
  31 public:
  32   enum LookupResultKind {
  33     /// @brief No entity found met the criteria.
  34     NotFound = 0,
  35
  36     /// @brief No entity found met the criteria within the current
  37     /// instantiation,, but there were dependent base classes of the
  38     /// current instantiation that could not be searched.
  39     NotFoundInCurrentInstantiation,
  40
  41     /// @brief Name lookup found a single declaration that met the
  42     /// criteria.  getFoundDecl() will return this declaration.
  43     Found,
  44
  45     /// @brief Name lookup found a set of overloaded functions that
  46     /// met the criteria.
  47     FoundOverloaded,
  48
  49     /// @brief Name lookup found an unresolvable value declaration
  50     /// and cannot yet complete.  This only happens in C++ dependent
  51     /// contexts with dependent using declarations.
  52     FoundUnresolvedValue,
  53
  54     /// @brief Name lookup results in an ambiguity; use
  55     /// getAmbiguityKind to figure out what kind of ambiguity
  56     /// we have.
  57     Ambiguous
  58   };
  59
  60   enum AmbiguityKind {
  61     /// Name lookup results in an ambiguity because multiple
  62     /// entities that meet the lookup criteria were found in
  63     /// subobjects of different types. For example:
  64     /// @code
  65     /// struct A { void f(int); }
  66     /// struct B { void f(double); }
  67     /// struct C : A, B { };
  68     /// void test(C c) {
  69     ///   c.f(0); // error: A::f and B::f come from subobjects of different
  70     ///           // types. overload resolution is not performed.
  71     /// }
  72     /// @endcode
  73     AmbiguousBaseSubobjectTypes,
  74
  75     /// Name lookup results in an ambiguity because multiple
  76     /// nonstatic entities that meet the lookup criteria were found
  77     /// in different subobjects of the same type. For example:
  78     /// @code
  79     /// struct A { int x; };
  80     /// struct B : A { };
  81     /// struct C : A { };
  82     /// struct D : B, C { };
  83     /// int test(D d) {
  84     ///   return d.x; // error: 'x' is found in two A subobjects (of B and C)
  85     /// }
  86     /// @endcode
  87     AmbiguousBaseSubobjects,
  88
  89     /// Name lookup results in an ambiguity because multiple definitions
  90     /// of entity that meet the lookup criteria were found in different
  91     /// declaration contexts.
  92     /// @code
  93     /// namespace A {
  94     ///   int i;
  95     ///   namespace B { int i; }
  96     ///   int test() {
  97     ///     using namespace B;
  98     ///     return i; // error 'i' is found in namespace A and A::B
  99     ///    }
 100     /// }
 101     /// @endcode
 102     AmbiguousReference,
 103
 104     /// Name lookup results in an ambiguity because an entity with a
 105     /// tag name was hidden by an entity with an ordinary name from
 106     /// a different context.
 107     /// @code
 108     /// namespace A { struct Foo {}; }
 109     /// namespace B { void Foo(); }
 110     /// namespace C {
 111     ///   using namespace A;
 112     ///   using namespace B;
 113     /// }
 114     /// void test() {
 115     ///   C::Foo(); // error: tag 'A::Foo' is hidden by an object in a
 116     ///             // different namespace
 117     /// }
 118     /// @endcode
 119     AmbiguousTagHiding
 120   };
 121
 122   /// A little identifier for flagging temporary lookup results.
 123   enum TemporaryToken {
 124     Temporary
 125   };
 126
 127   typedef UnresolvedSetImpl::iterator iterator;
 128
 129   LookupResult(Sema &SemaRef, const DeclarationNameInfo &NameInfo,
 130                Sema::LookupNameKind LookupKind,
 131                Sema::RedeclarationKind Redecl = Sema::NotForRedeclaration)
 132     : ResultKind(NotFound),
 133       Paths(0),
 134       NamingClass(0),
 135       SemaRef(SemaRef),
 136       NameInfo(NameInfo),
 137       LookupKind(LookupKind),
 138       IDNS(0),
 139       Redecl(Redecl != Sema::NotForRedeclaration),
 140       HideTags(true),
 141       Diagnose(Redecl == Sema::NotForRedeclaration)
 142   {
 143     configure();
 144   }
 145
 146   // TODO: consider whether this constructor should be restricted to take
 147   // as input a const IndentifierInfo* (instead of Name),
 148   // forcing other cases towards the constructor taking a DNInfo.
 149   LookupResult(Sema &SemaRef, DeclarationName Name,
 150                SourceLocation NameLoc, Sema::LookupNameKind LookupKind,
 151                Sema::RedeclarationKind Redecl = Sema::NotForRedeclaration)
 152     : ResultKind(NotFound),
 153       Paths(0),
 154       NamingClass(0),
 155       SemaRef(SemaRef),
 156       NameInfo(Name, NameLoc),
 157       LookupKind(LookupKind),
 158       IDNS(0),
 159       Redecl(Redecl != Sema::NotForRedeclaration),
 160       HideTags(true),
 161       Diagnose(Redecl == Sema::NotForRedeclaration)
 162   {
 163     configure();
 164   }
 165
 166   /// Creates a temporary lookup result, initializing its core data
 167   /// using the information from another result.  Diagnostics are always
 168   /// disabled.
 169   LookupResult(TemporaryToken _, const LookupResult &Other)
 170     : ResultKind(NotFound),
 171       Paths(0),
 172       NamingClass(0),
 173       SemaRef(Other.SemaRef),
 174       NameInfo(Other.NameInfo),
 175       LookupKind(Other.LookupKind),
 176       IDNS(Other.IDNS),
 177       Redecl(Other.Redecl),
 178       HideTags(Other.HideTags),
 179       Diagnose(false)
 180   {}
 181
 182   ~LookupResult() {
 183     if (Diagnose) diagnose();
 184     if (Paths) deletePaths(Paths);
 185   }
 186
 187   /// Gets the name info to look up.
 188   const DeclarationNameInfo &getLookupNameInfo() const {
 189     return NameInfo;
 190   }
 191
 192   /// \brief Sets the name info to look up.
 193   void setLookupNameInfo(const DeclarationNameInfo &NameInfo) {
 194     this->NameInfo = NameInfo;
 195   }
 196
 197   /// Gets the name to look up.
 198   DeclarationName getLookupName() const {
 199     return NameInfo.getName();
 200   }
 201
 202   /// \brief Sets the name to look up.
 203   void setLookupName(DeclarationName Name) {
 204     NameInfo.setName(Name);
 205   }
 206
 207   /// Gets the kind of lookup to perform.
 208   Sema::LookupNameKind getLookupKind() const {
 209     return LookupKind;
 210   }
 211
 212   /// True if this lookup is just looking for an existing declaration.
 213   bool isForRedeclaration() const {
 214     return Redecl;
 215   }
 216
 217   /// Sets whether tag declarations should be hidden by non-tag
 218   /// declarations during resolution.  The default is true.
 219   void setHideTags(bool Hide) {
 220     HideTags = Hide;
 221   }
 222
 223   bool isAmbiguous() const {
 224     return getResultKind() == Ambiguous;
 225   }
 226
 227   /// Determines if this names a single result which is not an
 228   /// unresolved value using decl.  If so, it is safe to call
 229   /// getFoundDecl().
 230   bool isSingleResult() const {
 231     return getResultKind() == Found;
 232   }
 233
 234   /// Determines if the results are overloaded.
 235   bool isOverloadedResult() const {
 236     return getResultKind() == FoundOverloaded;
 237   }
 238
 239   bool isUnresolvableResult() const {
 240     return getResultKind() == FoundUnresolvedValue;
 241   }
 242
 243   LookupResultKind getResultKind() const {
 244     sanity();
 245     return ResultKind;
 246   }
 247
 248   AmbiguityKind getAmbiguityKind() const {
 249     assert(isAmbiguous());
 250     return Ambiguity;
 251   }
 252
 253   const UnresolvedSetImpl &asUnresolvedSet() const {
 254     return Decls;
 255   }
 256
 257   iterator begin() const { return iterator(Decls.begin()); }
 258   iterator end() const { return iterator(Decls.end()); }
 259
 260   /// \brief Return true if no decls were found
 261   bool empty() const { return Decls.empty(); }
 262
 263   /// \brief Return the base paths structure that's associated with
 264   /// these results, or null if none is.
 265   CXXBasePaths *getBasePaths() const {
 266     return Paths;
 267   }
 268
 269   /// \brief Tests whether the given declaration is acceptable.
 270   bool isAcceptableDecl(NamedDecl *D) const {
 271     if (!D->isInIdentifierNamespace(IDNS))
 272       return false;
 273
 274     // So long as this declaration is not module-private or was parsed as
 275     // part of this translation unit (i.e., in the module), we're allowed to
 276     // find it.
 277     if (!D->isModulePrivate() || !D->isFromASTFile())
 278       return true;
 279
 280     // FIXME: We should be allowed to refer to a module-private name from
 281     // within the same module, e.g., during template instantiation.
 282     // This requires us know which module a particular declaration came from.
 283     return false;
 284   }
 285
 286   /// \brief Returns the identifier namespace mask for this lookup.
 287   unsigned getIdentifierNamespace() const {
 288     return IDNS;
 289   }
 290
 291   /// \brief Returns whether these results arose from performing a
 292   /// lookup into a class.
 293   bool isClassLookup() const {
 294     return NamingClass != 0;
 295   }
 296
 297   /// \brief Returns the 'naming class' for this lookup, i.e. the
 298   /// class which was looked into to find these results.
 299   ///
 300   /// C++0x [class.access.base]p5:
 301   ///   The access to a member is affected by the class in which the
 302   ///   member is named. This naming class is the class in which the
 303   ///   member name was looked up and found. [Note: this class can be
 304   ///   explicit, e.g., when a qualified-id is used, or implicit,
 305   ///   e.g., when a class member access operator (5.2.5) is used
 306   ///   (including cases where an implicit "this->" is added). If both
 307   ///   a class member access operator and a qualified-id are used to
 308   ///   name the member (as in p->T::m), the class naming the member
 309   ///   is the class named by the nested-name-specifier of the
 310   ///   qualified-id (that is, T). -- end note ]
 311   ///
 312   /// This is set by the lookup routines when they find results in a class.
 313   CXXRecordDecl *getNamingClass() const {
 314     return NamingClass;
 315   }
 316
 317   /// \brief Sets the 'naming class' for this lookup.
 318   void setNamingClass(CXXRecordDecl *Record) {
 319     NamingClass = Record;
 320   }
 321
 322   /// \brief Returns the base object type associated with this lookup;
 323   /// important for [class.protected].  Most lookups do not have an
 324   /// associated base object.
 325   QualType getBaseObjectType() const {
 326     return BaseObjectType;
 327   }
 328
 329   /// \brief Sets the base object type for this lookup.
 330   void setBaseObjectType(QualType T) {
 331     BaseObjectType = T;
 332   }
 333
 334   /// \brief Add a declaration to these results with its natural access.
 335   /// Does not test the acceptance criteria.
 336   void addDecl(NamedDecl *D) {
 337     addDecl(D, D->getAccess());
 338   }
 339
 340   /// \brief Add a declaration to these results with the given access.
 341   /// Does not test the acceptance criteria.
 342   void addDecl(NamedDecl *D, AccessSpecifier AS) {
 343     Decls.addDecl(D, AS);
 344     ResultKind = Found;
 345   }
 346
 347   /// \brief Add all the declarations from another set of lookup
 348   /// results.
 349   void addAllDecls(const LookupResult &Other) {
 350     Decls.append(Other.Decls.begin(), Other.Decls.end());
 351     ResultKind = Found;
 352   }
 353
 354   /// \brief Determine whether no result was found because we could not
 355   /// search into dependent base classes of the current instantiation.
 356   bool wasNotFoundInCurrentInstantiation() const {
 357     return ResultKind == NotFoundInCurrentInstantiation;
 358   }
 359
 360   /// \brief Note that while no result was found in the current instantiation,
 361   /// there were dependent base classes that could not be searched.
 362   void setNotFoundInCurrentInstantiation() {
 363     assert(ResultKind == NotFound && Decls.empty());
 364     ResultKind = NotFoundInCurrentInstantiation;
 365   }
 366
 367   /// \brief Resolves the result kind of the lookup, possibly hiding
 368   /// decls.
 369   ///
 370   /// This should be called in any environment where lookup might
 371   /// generate multiple lookup results.
 372   void resolveKind();
 373
 374   /// \brief Re-resolves the result kind of the lookup after a set of
 375   /// removals has been performed.
 376   void resolveKindAfterFilter() {
 377     if (Decls.empty()) {
 378       if (ResultKind != NotFoundInCurrentInstantiation)
 379         ResultKind = NotFound;
 380
 381       if (Paths) {
 382         deletePaths(Paths);
 383         Paths = 0;
 384       }
 385     } else {
 386       AmbiguityKind SavedAK = Ambiguity;
 387       ResultKind = Found;
 388       resolveKind();
 389
 390       // If we didn't make the lookup unambiguous, restore the old
 391       // ambiguity kind.
 392       if (ResultKind == Ambiguous) {
 393         Ambiguity = SavedAK;
 394       } else if (Paths) {
 395         deletePaths(Paths);
 396         Paths = 0;
 397       }
 398     }
 399   }
 400
 401   template <class DeclClass>
 402   DeclClass *getAsSingle() const {
 403     if (getResultKind() != Found) return 0;
 404     return dyn_cast<DeclClass>(getFoundDecl());
 405   }
 406
 407   /// \brief Fetch the unique decl found by this lookup.  Asserts
 408   /// that one was found.
 409   ///
 410   /// This is intended for users who have examined the result kind
 411   /// and are certain that there is only one result.
 412   NamedDecl *getFoundDecl() const {
 413     assert(getResultKind() == Found
 414            && "getFoundDecl called on non-unique result");
 415     return (*begin())->getUnderlyingDecl();
 416   }
 417
 418   /// Fetches a representative decl.  Useful for lazy diagnostics.
 419   NamedDecl *getRepresentativeDecl() const {
 420     assert(!Decls.empty() && "cannot get representative of empty set");
 421     return *begin();
 422   }
 423
 424   /// \brief Asks if the result is a single tag decl.
 425   bool isSingleTagDecl() const {
 426     return getResultKind() == Found && isa<TagDecl>(getFoundDecl());
 427   }
 428
 429   /// \brief Make these results show that the name was found in
 430   /// base classes of different types.
 431   ///
 432   /// The given paths object is copied and invalidated.
 433   void setAmbiguousBaseSubobjectTypes(CXXBasePaths &P);
 434
 435   /// \brief Make these results show that the name was found in
 436   /// distinct base classes of the same type.
 437   ///
 438   /// The given paths object is copied and invalidated.
 439   void setAmbiguousBaseSubobjects(CXXBasePaths &P);
 440
 441   /// \brief Make these results show that the name was found in
 442   /// different contexts and a tag decl was hidden by an ordinary
 443   /// decl in a different context.
 444   void setAmbiguousQualifiedTagHiding() {
 445     setAmbiguous(AmbiguousTagHiding);
 446   }
 447
 448   /// \brief Clears out any current state.
 449   void clear() {
 450     ResultKind = NotFound;
 451     Decls.clear();
 452     if (Paths) deletePaths(Paths);
 453     Paths = NULL;
 454     NamingClass = 0;
 455   }
 456
 457   /// \brief Clears out any current state and re-initializes for a
 458   /// different kind of lookup.
 459   void clear(Sema::LookupNameKind Kind) {
 460     clear();
 461     LookupKind = Kind;
 462     configure();
 463   }
 464
 465   /// \brief Change this lookup's redeclaration kind.
 466   void setRedeclarationKind(Sema::RedeclarationKind RK) {
 467     Redecl = RK;
 468     configure();
 469   }
 470
 471   void print(raw_ostream &);
 472
 473   /// Suppress the diagnostics that would normally fire because of this
 474   /// lookup.  This happens during (e.g.) redeclaration lookups.
 475   void suppressDiagnostics() {
 476     Diagnose = false;
 477   }
 478
 479   /// Determines whether this lookup is suppressing diagnostics.
 480   bool isSuppressingDiagnostics() const {
 481     return !Diagnose;
 482   }
 483
 484   /// Sets a 'context' source range.
 485   void setContextRange(SourceRange SR) {
 486     NameContextRange = SR;
 487   }
 488
 489   /// Gets the source range of the context of this name; for C++
 490   /// qualified lookups, this is the source range of the scope
 491   /// specifier.
 492   SourceRange getContextRange() const {
 493     return NameContextRange;
 494   }
 495
 496   /// Gets the location of the identifier.  This isn't always defined:
 497   /// sometimes we're doing lookups on synthesized names.
 498   SourceLocation getNameLoc() const {
 499     return NameInfo.getLoc();
 500   }
 501
 502   /// \brief Get the Sema object that this lookup result is searching
 503   /// with.
 504   Sema &getSema() const { return SemaRef; }
 505
 506   /// A class for iterating through a result set and possibly
 507   /// filtering out results.  The results returned are possibly
 508   /// sugared.
 509   class Filter {
 510     LookupResult &Results;
 511     LookupResult::iterator I;
 512     bool Changed;
 513     bool CalledDone;
 514
 515     friend class LookupResult;
 516     Filter(LookupResult &Results)
 517       : Results(Results), I(Results.begin()), Changed(false), CalledDone(false)
 518     {}
 519
 520   public:
 521     ~Filter() {
 522       assert(CalledDone &&
 523              "LookupResult::Filter destroyed without done() call");
 524     }
 525
 526     bool hasNext() const {
 527       return I != Results.end();
 528     }
 529
 530     NamedDecl *next() {
 531       assert(I != Results.end() && "next() called on empty filter");
 532       return *I++;
 533     }
 534
 535     /// Erase the last element returned from this iterator.
 536     void erase() {
 537       Results.Decls.erase(--I);
 538       Changed = true;
 539     }
 540
 541     /// Replaces the current entry with the given one, preserving the
 542     /// access bits.
 543     void replace(NamedDecl *D) {
 544       Results.Decls.replace(I-1, D);
 545       Changed = true;
 546     }
 547
 548     /// Replaces the current entry with the given one.
 549     void replace(NamedDecl *D, AccessSpecifier AS) {
 550       Results.Decls.replace(I-1, D, AS);
 551       Changed = true;
 552     }
 553
 554     void done() {
 555       assert(!CalledDone && "done() called twice");
 556       CalledDone = true;
 557
 558       if (Changed)
 559         Results.resolveKindAfterFilter();
 560     }
 561   };
 562
 563   /// Create a filter for this result set.
 564   Filter makeFilter() {
 565     return Filter(*this);
 566   }
 567
 568 private:
 569   void diagnose() {
 570     if (isAmbiguous())
 571       SemaRef.DiagnoseAmbiguousLookup(*this);
 572     else if (isClassLookup() && SemaRef.getLangOptions().AccessControl)
 573       SemaRef.CheckLookupAccess(*this);
 574   }
 575
 576   void setAmbiguous(AmbiguityKind AK) {
 577     ResultKind = Ambiguous;
 578     Ambiguity = AK;
 579   }
 580
 581   void addDeclsFromBasePaths(const CXXBasePaths &P);
 582   void configure();
 583
 584   // Sanity checks.
 585   void sanity() const;
 586
 587   bool sanityCheckUnresolved() const {
 588     for (iterator I = begin(), E = end(); I != E; ++I)
 589       if (isa<UnresolvedUsingValueDecl>(*I))
 590         return true;
 591     return false;
 592   }
 593
 594   static void deletePaths(CXXBasePaths *);
 595
 596   // Results.
 597   LookupResultKind ResultKind;
 598   AmbiguityKind Ambiguity; // ill-defined unless ambiguous
 599   UnresolvedSet<8> Decls;
 600   CXXBasePaths *Paths;
 601   CXXRecordDecl *NamingClass;
 602   QualType BaseObjectType;
 603
 604   // Parameters.
 605   Sema &SemaRef;
 606   DeclarationNameInfo NameInfo;
 607   SourceRange NameContextRange;
 608   Sema::LookupNameKind LookupKind;
 609   unsigned IDNS; // set by configure()
 610
 611   bool Redecl;
 612
 613   /// \brief True if tag declarations should be hidden if non-tags
 614   ///   are present
 615   bool HideTags;
 616
 617   bool Diagnose;
 618 };
 619
 620   /// \brief Consumes visible declarations found when searching for
 621   /// all visible names within a given scope or context.
 622   ///
 623   /// This abstract class is meant to be subclassed by clients of \c
 624   /// Sema::LookupVisibleDecls(), each of which should override the \c
 625   /// FoundDecl() function to process declarations as they are found.
 626   class VisibleDeclConsumer {
 627   public:
 628     /// \brief Destroys the visible declaration consumer.
 629     virtual ~VisibleDeclConsumer();
 630
 631     /// \brief Invoked each time \p Sema::LookupVisibleDecls() finds a
 632     /// declaration visible from the current scope or context.
 633     ///
 634     /// \param ND the declaration found.
 635     ///
 636     /// \param Hiding a declaration that hides the declaration \p ND,
 637     /// or NULL if no such declaration exists.
 638     ///
 639     /// \param Ctx the original context from which the lookup started.
 640     ///
 641     /// \param InBaseClass whether this declaration was found in base
 642     /// class of the context we searched.
 643     virtual void FoundDecl(NamedDecl *ND, NamedDecl *Hiding, DeclContext *Ctx,
 644                            bool InBaseClass) = 0;
 645   };
 646
 647 /// \brief A class for storing results from argument-dependent lookup.
 648 class ADLResult {
 649 private:
 650   /// A map from canonical decls to the 'most recent' decl.
 651   llvm::DenseMap<NamedDecl*, NamedDecl*> Decls;
 652
 653 public:
 654   /// Adds a new ADL candidate to this map.
 655   void insert(NamedDecl *D);
 656
 657   /// Removes any data associated with a given decl.
 658   void erase(NamedDecl *D) {
 659     Decls.erase(cast<NamedDecl>(D->getCanonicalDecl()));
 660   }
 661
 662   class iterator {
 663     typedef llvm::DenseMap<NamedDecl*,NamedDecl*>::iterator inner_iterator;
 664     inner_iterator iter;
 665
 666     friend class ADLResult;
 667     iterator(const inner_iterator &iter) : iter(iter) {}
 668   public:
 669     iterator() {}
 670
 671     iterator &operator++() { ++iter; return *this; }
 672     iterator operator++(int) { return iterator(iter++); }
 673
 674     NamedDecl *operator*() const { return iter->second; }
 675
 676     bool operator==(const iterator &other) const { return iter == other.iter; }
 677     bool operator!=(const iterator &other) const { return iter != other.iter; }
 678   };
 679
 680   iterator begin() { return iterator(Decls.begin()); }
 681   iterator end() { return iterator(Decls.end()); }
 682 };
 683
 684 }
 685
 686 #endif