Improve module selector type lookup diagnostics

Author: beccadax

include/swift/AST/DiagnosticsSema.def

@@ -1193,6 +1193,10 @@ ERROR(cannot_find_type_in_cast_expression,none,
       "type-casting operator expects a type on its right-hand side (got: %kind0)", (const ValueDecl *))
 ERROR(cannot_find_type_in_scope_did_you_mean,none,
       "cannot find type %0 in scope; did you mean to use '%1'?", (DeclNameRef, StringRef))
+ERROR(type_not_in_module,none,
+      "type %0 is not imported through module %1", (DeclName, Identifier))
+NOTE(note_change_module_selector,none,
+     "did you mean module %0?", (Identifier))
 NOTE(note_typo_candidate_implicit_member,none,
      "did you mean the implicitly-synthesized %kindbase0?", (const ValueDecl *))
 NOTE(note_remapped_type,none,

lib/Sema/TypeCheckType.cpp

@@ -1492,6 +1492,33 @@ static Type diagnoseUnknownType(const TypeResolution &resolution,
       return ErrorType::get(ctx);
     }
 
+    // Is there an incorrect module selector?
+    if (repr->getNameRef().hasModuleSelector()) {
+      auto anyModuleName = DeclNameRef(repr->getNameRef().getFullName());
+      auto anyModuleResults =
+      TypeChecker::lookupUnqualifiedType(dc, anyModuleName,
+                                         repr->getLoc(), lookupOptions);
+      if (!anyModuleResults.empty()) {
+        diags.diagnose(repr->getNameLoc(), diag::type_not_in_module,
+                       repr->getNameRef().getFullName(),
+                       repr->getNameRef().getModuleSelector());
+
+        SourceLoc moduleSelectorLoc = repr->getNameLoc().getModuleSelectorLoc();
+
+        for (auto result : anyModuleResults) {
+          TypeDecl * decl = static_cast<TypeDecl*>(result.getValueDecl());
+          Identifier moduleName = decl->getModuleContext()->getName();
+
+          diags.diagnose(moduleSelectorLoc, diag::note_change_module_selector,
+                         moduleName)
+              .fixItReplace(moduleSelectorLoc, moduleName.str());
+        }
+
+        // FIXME: Can we recover by assuming the first/best result is correct?
+        return ErrorType::get(ctx);
+      }
+    }
+
     // Try ignoring access control.
     NameLookupOptions relookupOptions = lookupOptions;
     relookupOptions |= NameLookupFlags::IgnoreAccessControl;
@@ -1583,6 +1610,32 @@ static Type diagnoseUnknownType(const TypeResolution &resolution,
     return ErrorType::get(ctx);
   }
 
+  // Is there an incorrect module selector?
+  if (repr->getNameRef().hasModuleSelector()) {
+    auto anyModuleName = DeclNameRef(repr->getNameRef().getFullName());
+    auto anyModuleResults = TypeChecker::lookupMemberType(
+        dc, parentType, anyModuleName, repr->getLoc(), lookupOptions);
+    if (anyModuleResults) {
+      diags.diagnose(repr->getNameLoc(), diag::type_not_in_module,
+                     repr->getNameRef().getFullName(),
+                     repr->getNameRef().getModuleSelector());
+
+      SourceLoc moduleSelectorLoc = repr->getNameLoc().getModuleSelectorLoc();
+
+      for (auto result : anyModuleResults) {
+        TypeDecl * decl = result.Member;
+        Identifier moduleName = decl->getModuleContext()->getName();
+
+        diags.diagnose(moduleSelectorLoc, diag::note_change_module_selector,
+                       moduleName)
+            .fixItReplace(moduleSelectorLoc, moduleName.str());
+      }
+
+      // FIXME: Can we recover by assuming the first/best result is correct?
+      return ErrorType::get(ctx);
+    }
+  }
+
   // Try ignoring access control.
   NameLookupOptions relookupOptions = lookupOptions;
   relookupOptions |= NameLookupFlags::IgnoreAccessControl;

test/NameLookup/module_selector.swift

@@ -64,18 +64,23 @@ extension A: @retroactive Swift::Equatable {
 // Test resolution of main:: using `B`
 
 extension main::B {}
-// FIXME improve: expected-error@-1 {{cannot find type 'main::B' in scope}}
+// expected-error@-1 {{type 'B' is not imported through module 'main'}}
+// expected-note@-2 {{did you mean module 'ModuleSelectorTestingKit'?}} {{11-15=ModuleSelectorTestingKit}}
 
 extension B: @retroactive main::Equatable {
-  // FIXME improve: expected-error@-1 {{cannot find type 'main::Equatable' in scope}}
+  // expected-error@-1 {{type 'Equatable' is not imported through module 'main'}}
+  // expected-note@-2 {{did you mean module 'Swift'?}} {{27-31=Swift}}
 
   @_implements(main::Equatable, ==(_:_:))
-  // FIXME improve: expected-error@-1 {{cannot find type 'main::Equatable' in scope}}
+  // expected-error@-1 {{type 'Equatable' is not imported through module 'main'}}
+  // expected-note@-2 {{did you mean module 'Swift'?}} {{16-20=Swift}}
 
   public static func equals(_: main::B, _: main::B) -> main::Bool {
-  // FIXME improve: expected-error@-1 {{cannot find type 'main::B' in scope}}
-  // FIXME improve: expected-error@-2 {{cannot find type 'main::B' in scope}}
-  // FIXME improve: expected-error@-3 {{cannot find type 'main::Bool' in scope}}
+    // expected-error@-1 2{{type 'B' is not imported through module 'main'}}
+    // expected-note@-2 {{did you mean module 'ModuleSelectorTestingKit'?}} {{32-36=ModuleSelectorTestingKit}}
+    // expected-note@-3 {{did you mean module 'ModuleSelectorTestingKit'?}} {{44-48=ModuleSelectorTestingKit}}
+    // expected-error@-4 {{type 'Bool' is not imported through module 'main'}}
+    // expected-note@-5 {{did you mean module 'Swift'?}} {{56-60=Swift}}
     main::fatalError() // no-error -- not typechecking function bodies
   }
 
@@ -87,12 +92,16 @@ extension B: @retroactive main::Equatable {
 
   mutating func myNegate() {
     let fn: (main::Int, main::Int) -> main::Int =
-    // FIXME improve: expected-error@-1 3{{cannot find type 'main::Int' in scope}}
+    // expected-error@-1 3{{type 'Int' is not imported through module 'main'}}
+    // expected-note@-2 {{did you mean module 'Swift'?}} {{14-18=Swift}}
+    // expected-note@-3 {{did you mean module 'Swift'?}} {{25-29=Swift}}
+    // expected-note@-4 {{did you mean module 'Swift'?}} {{39-43=Swift}}
       (main::+)
       // FIXME: should fail????
 
     let magnitude: Int.main::Magnitude = main::magnitude
-    // FIXME improve: expected-error@-1 {{'main::Magnitude' is not a member type of struct 'Swift.Int'}}
+    // expected-error@-1 {{type 'Magnitude' is not imported through module 'main'}}
+    // expected-note@-2 {{did you mean module 'Swift'?}} {{24-28=Swift}}
 
     _ = (fn, magnitude)
 
@@ -126,13 +135,16 @@ extension B: @retroactive main::Equatable {
 extension ModuleSelectorTestingKit::C {}
 
 extension C: @retroactive ModuleSelectorTestingKit::Equatable {
-// FIXME improve: expected-error@-1 {{cannot find type 'ModuleSelectorTestingKit::Equatable' in scope}}
+  // expected-error@-1 {{type 'Equatable' is not imported through module 'ModuleSelectorTestingKit'}}
+  // expected-note@-2 {{did you mean module 'Swift'?}} {{27-51=Swift}}
 
   @_implements(ModuleSelectorTestingKit::Equatable, ==(_:_:))
-  // FIXME improve: expected-error@-1 {{cannot find type 'ModuleSelectorTestingKit::Equatable' in scope}}
+  // expected-error@-1 {{type 'Equatable' is not imported through module 'ModuleSelectorTestingKit'}}
+  // expected-note@-2 {{did you mean module 'Swift'?}} {{16-40=Swift}}
 
   public static func equals(_: ModuleSelectorTestingKit::C, _: ModuleSelectorTestingKit::C) -> ModuleSelectorTestingKit::Bool {
-  // FIXME improve: expected-error@-1 {{cannot find type 'ModuleSelectorTestingKit::Bool' in scope}}
+    // expected-error@-1 {{type 'Bool' is not imported through module 'ModuleSelectorTestingKit'}}
+    // expected-note@-2 {{did you mean module 'Swift'?}} {{96-120=Swift}}
 
     ModuleSelectorTestingKit::fatalError() // no-error -- not typechecking function bodies
   }
@@ -146,12 +158,16 @@ extension C: @retroactive ModuleSelectorTestingKit::Equatable {
   // FIXME improve: expected-note@-1 {{did you mean 'myNegate'?}}
 
     let fn: (ModuleSelectorTestingKit::Int, ModuleSelectorTestingKit::Int) -> ModuleSelectorTestingKit::Int =
-    // FIXME improve: expected-error@-1 3{{cannot find type 'ModuleSelectorTestingKit::Int' in scope}}
+    // expected-error@-1 3{{type 'Int' is not imported through module 'ModuleSelectorTestingKit'}}
+    // expected-note@-2 {{did you mean module 'Swift'?}} {{14-38=Swift}}
+    // expected-note@-3 {{did you mean module 'Swift'?}} {{45-69=Swift}}
+    // expected-note@-4 {{did you mean module 'Swift'?}} {{79-103=Swift}}
       (ModuleSelectorTestingKit::+)
       // FIXME: should fail????
 
     let magnitude: Int.ModuleSelectorTestingKit::Magnitude = ModuleSelectorTestingKit::magnitude
-    // FIXME improve: expected-error@-1 {{'ModuleSelectorTestingKit::Magnitude' is not a member type of struct 'Swift.Int'}}
+    // expected-error@-1 {{type 'Magnitude' is not imported through module 'ModuleSelectorTestingKit'}}
+    // expected-note@-2 {{did you mean module 'Swift'?}} {{24-48=Swift}}
 
     _ = (fn, magnitude)
 
@@ -181,15 +197,17 @@ extension C: @retroactive ModuleSelectorTestingKit::Equatable {
 // Test resolution of Swift:: using `D`
 
 extension Swift::D {}
-// FIXME improve: expected-error@-1 {{cannot find type 'Swift::D' in scope}}
+// expected-error@-1 {{type 'D' is not imported through module 'Swift'}}
+// expected-note@-2 {{did you mean module 'ModuleSelectorTestingKit'?}} {{11-16=ModuleSelectorTestingKit}}
 
 extension D: @retroactive Swift::Equatable {
 // Caused by Swift::D failing to typecheck in `equals(_:_:)`: expected-error@-1 *{{extension outside of file declaring struct 'D' prevents automatic synthesis of '==' for protocol 'Equatable'}} expected-note@-1 *{{add stubs for conformance}}
 
   @_implements(Swift::Equatable, ==(_:_:))
   public static func equals(_: Swift::D, _: Swift::D) -> Swift::Bool {
-  // expected-error@-1 {{cannot find type 'Swift::D' in scope}}
-  // expected-error@-2 {{cannot find type 'Swift::D' in scope}}
+  // expected-error@-1 2{{type 'D' is not imported through module 'Swift'}}
+  // expected-note@-2 {{did you mean module 'ModuleSelectorTestingKit'?}} {{32-37=ModuleSelectorTestingKit}}
+  // expected-note@-3 {{did you mean module 'ModuleSelectorTestingKit'?}} {{45-50=ModuleSelectorTestingKit}}
     Swift::fatalError() // no-error -- not typechecking function bodies
   }
 
@@ -270,7 +288,8 @@ func builderUser4(@Swift::MyBuilder fn: () -> Void) {}
 
 func decl1(
   p1: main::A,
-  // FIXME: expected-error@-1 {{cannot find type 'main::A' in scope}}
+  // expected-error@-1 {{type 'A' is not imported through module 'main'}}
+  // expected-note@-2 {{did you mean module 'ModuleSelectorTestingKit'?}} {{7-11=ModuleSelectorTestingKit}}
   label p2: inout A,
   label p3: @escaping () -> A
 ) {
@@ -300,7 +319,8 @@ func decl1(
 }
 
 typealias decl5 = main::Bool
-// FIXME improve: expected-error@-1 {{cannot find type 'main::Bool' in scope}}
+// expected-error@-1 {{type 'Bool' is not imported through module 'main'}}
+// expected-note@-2 {{did you mean module 'Swift'?}} {{19-23=Swift}}
 
 func badModuleNames() {
   NonexistentModule::print()