Merge pull request #16766 from AnthonyLatsis/generalize_declared_here

[Sema] Generalize the 'declared here' diagnostic

Author: slavapestov

include/swift/AST/Decl.h

@@ -122,14 +122,16 @@ enum class DescriptiveDeclKind : uint8_t {
   PrecedenceGroup,
   TypeAlias,
   GenericTypeParam,
-  AssociatedType,  
+  AssociatedType,
+  Type,
   Enum,
   Struct,
   Class,
   Protocol,
   GenericEnum,
   GenericStruct,
   GenericClass,
+  GenericType,
   Subscript,
   Constructor,
   Destructor,
@@ -149,6 +151,7 @@ enum class DescriptiveDeclKind : uint8_t {
   EnumElement,
   Module,
   MissingMember,
+  Requirement,
 };
 
 /// Keeps track of stage of circularity checking for the given protocol.

include/swift/AST/DiagnosticsSema.def

@@ -37,11 +37,16 @@
   DIAG(NOTE,ID,Options,Text,Signature)
 #endif
 
-
-NOTE(type_declared_here,none,
-     "type declared here", ())
+NOTE(kind_declname_declared_here,none,
+     "%0 %1 declared here", (DescriptiveDeclKind, DeclName))
+NOTE(kind_identifier_declared_here,none,
+     "%0 %1 declared here", (DescriptiveDeclKind, Identifier))
 NOTE(decl_declared_here,none,
      "%0 declared here", (DeclName))
+NOTE(identifier_declared_here,none,
+     "%0 declared here", (Identifier))
+NOTE(kind_declared_here,none,
+     "%0 declared here", (DescriptiveDeclKind))
 NOTE(implicit_member_declared_here,none,
      "%1 '%0' is implicitly declared", (StringRef, StringRef))
 NOTE(extended_type_declared_here,none,
@@ -766,8 +771,6 @@ ERROR(precedence_group_lower_within_module,none,
       "precedence group cannot be given lower precedence than group in same"
       " module; make the other precedence group higher than this one instead",
       ())
-NOTE(precedence_group_declared_here,none,"precedence group declared here",
-      ())
 ERROR(precedence_group_redeclared,none,
       "precedence group redeclared", ())
 NOTE(previous_precedence_group_decl,none,
@@ -1689,8 +1692,6 @@ NOTE(protocol_witness_nonconform_type,none,
      "possibly intended match %0 does not "
      "%select{inherit from|conform to}2 %1", (Type, Type, bool))
 
-NOTE(protocol_requirement_here,none,
-     "requirement %0 declared here", (DeclName))
 NOTE(protocol_conformance_here,none,
      "%select{|class }0%1 declares conformance to protocol %2 here",
      (bool, DeclName, DeclName))
@@ -1753,8 +1754,6 @@ ERROR(typealias_outside_of_protocol,none,
 
 ERROR(circular_protocol_def,none,
       "circular protocol inheritance %0", (StringRef))
-NOTE(protocol_here,none,
-     "protocol %0 declared here", (Identifier))
 ERROR(objc_protocol_inherits_non_objc_protocol,none,
       "@objc protocol %0 cannot refine non-@objc protocol %1", (Type, Type))
 WARNING(protocol_composition_with_postfix,none,
@@ -2072,8 +2071,6 @@ ERROR(superclass_of_open_not_open,none,
   "superclass %0 of open class must be open", (Type))
 ERROR(circular_class_inheritance,none,
       "circular class inheritance %0", (StringRef))
-NOTE(class_here,none,
-     "class %0 declared here", (Identifier))
 ERROR(inheritance_from_final_class,none,
       "inheritance from a final class %0", (Identifier))
 ERROR(inheritance_from_unspecialized_objc_generic_class,none,
@@ -2141,8 +2138,6 @@ WARNING(enum_raw_type_access_warn,none,
         "%select{a private|a fileprivate|an internal|%error|%error}2 type",
         (bool, AccessLevel, AccessLevel, bool))
 
-NOTE(enum_here,none,
-     "enum %0 declared here", (Identifier))
 ERROR(empty_enum_raw_type,none,
       "an enum with no cases cannot declare a raw type", ())
 ERROR(enum_raw_value_without_raw_type,none,
@@ -2247,8 +2242,6 @@ ERROR(property_behavior_not_protocol,none,
       "property behavior name must refer to a protocol", ())
 ERROR(property_behavior_protocol_reqt_ambiguous,none,
       "property behavior protocol has ambiguous %0 member", (Identifier))
-NOTE(property_behavior_protocol_reqt_here,none,
-     "%0 declared here", (Identifier))
 ERROR(property_behavior_protocol_no_value,none,
       "property behavior protocol does not have a 'value' property", ())
 ERROR(property_behavior_protocol_no_initStorage,none,
@@ -2685,8 +2678,6 @@ ERROR(type_parameter_count_mismatch,none,
       (Identifier, unsigned, unsigned, bool))
 ERROR(generic_type_requires_arguments,none,
       "reference to generic type %0 requires arguments in <...>", (Type))
-NOTE(generic_type_declared_here,none,
-     "generic type %0 declared here", (Identifier))
 NOTE(descriptive_generic_type_declared_here,none,
      "%0 declared here", (StringRef))
 

lib/AST/ASTContext.cpp

@@ -2837,8 +2837,8 @@ bool ASTContext::diagnoseObjCUnsatisfiedOptReqConflicts(SourceFile &sf) {
                    true,
                    classDecl->getFullName(),
                    protocolName);
-    Diags.diagnose(req, diag::protocol_requirement_here,
-                   reqDiagInfo.second);
+    Diags.diagnose(req, diag::kind_declname_declared_here,
+                   DescriptiveDeclKind::Requirement, reqDiagInfo.second);
 
     anyDiagnosed = true;
   }

lib/AST/Decl.cpp

@@ -252,13 +252,15 @@ StringRef Decl::getDescriptiveKindName(DescriptiveDeclKind K) {
   ENTRY(TypeAlias, "type alias");
   ENTRY(GenericTypeParam, "generic parameter");
   ENTRY(AssociatedType, "associated type");
+  ENTRY(Type, "type");
   ENTRY(Enum, "enum");
   ENTRY(Struct, "struct");
   ENTRY(Class, "class");
   ENTRY(Protocol, "protocol");
   ENTRY(GenericEnum, "generic enum");
   ENTRY(GenericStruct, "generic struct");
   ENTRY(GenericClass, "generic class");
+  ENTRY(GenericType, "generic type");
   ENTRY(Subscript, "subscript");
   ENTRY(Constructor, "initializer");
   ENTRY(Destructor, "deinitializer");
@@ -278,6 +280,7 @@ StringRef Decl::getDescriptiveKindName(DescriptiveDeclKind K) {
   ENTRY(EnumElement, "enum element");
   ENTRY(Module, "module");
   ENTRY(MissingMember, "missing member placeholder");
+  ENTRY(Requirement, "requirement");
   }
 #undef ENTRY
   llvm_unreachable("bad DescriptiveDeclKind");

lib/Sema/CSGen.cpp

@@ -1592,8 +1592,8 @@ namespace {
                         false)
               .highlight(SourceRange(expr->getLAngleLoc(),
                                      expr->getRAngleLoc()));
-            tc.diagnose(bgt->getDecl(), diag::generic_type_declared_here,
-                        bgt->getDecl()->getName());
+            tc.diagnose(bgt->getDecl(), diag::kind_identifier_declared_here,
+                        DescriptiveDeclKind::GenericType, bgt->getDecl()->getName());
             return Type();
           }
 

lib/Sema/CodeSynthesis.cpp

@@ -1738,11 +1738,9 @@ void swift::maybeAddAccessorsToVariable(VarDecl *var, TypeChecker &TC) {
             TC.diagnose(behavior->getLoc(),
                         diag::property_behavior_protocol_reqt_ambiguous,
                         TC.Context.Id_value);
-            TC.diagnose(valueProp->getLoc(),
-                        diag::property_behavior_protocol_reqt_here,
+            TC.diagnose(valueProp->getLoc(), diag::identifier_declared_here,
                         TC.Context.Id_value);
-            TC.diagnose(foundVar->getLoc(),
-                        diag::property_behavior_protocol_reqt_here,
+            TC.diagnose(foundVar->getLoc(), diag::identifier_declared_here,
                         TC.Context.Id_value);
             break;
           }

lib/Sema/DerivedConformances.cpp

@@ -402,7 +402,8 @@ bool DerivedConformance::checkAndDiagnoseDisallowedContext(
     TC.diagnose(ConformanceDecl->getLoc(),
                 diag::cannot_synthesize_in_crossfile_extension,
                 getProtocolType());
-    TC.diagnose(Nominal->getLoc(), diag::type_declared_here);
+    TC.diagnose(Nominal->getLoc(), diag::kind_declared_here,
+                DescriptiveDeclKind::Type);
     return true;
   }
 

lib/Sema/TypeCheckCaptures.cpp

@@ -271,7 +271,8 @@ class FindCapturedVars : public ASTWalker {
                         NTD->getDescriptiveKind(),
                         D->getBaseName().getIdentifier());
 
-            TC.diagnose(NTD->getLoc(), diag::type_declared_here);
+            TC.diagnose(NTD->getLoc(), diag::kind_declared_here,
+                        DescriptiveDeclKind::Type);
 
             TC.diagnose(D, diag::decl_declared_here, D->getFullName());
             return { false, DRE };

lib/Sema/TypeCheckDecl.cpp

@@ -707,7 +707,7 @@ static void breakInheritanceCycle(EnumDecl *enumDecl) {
 template<typename T>
 static void checkCircularity(TypeChecker &tc, T *decl,
                              Diag<StringRef> circularDiag,
-                             Diag<Identifier> declHereDiag,
+                             DescriptiveDeclKind declKind,
                              SmallVectorImpl<T *> &path) {
   switch (decl->getCircularityCheck()) {
   case CircularityCheck::Checked:
@@ -750,7 +750,8 @@ static void checkCircularity(TypeChecker &tc, T *decl,
     // Diagnose the cycle.
     tc.diagnose(decl->getLoc(), circularDiag, pathStr);
     for (auto i = cycleStart + 1, iEnd = path.end(); i != iEnd; ++i) {
-      tc.diagnose(*i, declHereDiag, (*i)->getName());
+      tc.diagnose(*i, diag::kind_identifier_declared_here,
+                  declKind, (*i)->getName());
     }
 
     // Set this declaration as invalid, then break the cycle somehow.
@@ -766,7 +767,7 @@ static void checkCircularity(TypeChecker &tc, T *decl,
     decl->setCircularityCheck(CircularityCheck::Checking);
     T *scratch = nullptr;
     for (auto inherited : getInheritedForCycleCheck(tc, decl, &scratch)) {
-      checkCircularity(tc, inherited, circularDiag, declHereDiag, path);
+      checkCircularity(tc, inherited, circularDiag, declKind, path);
     }
     decl->setCircularityCheck(CircularityCheck::Checked);
     path.pop_back();
@@ -1835,7 +1836,7 @@ static void highlightOffendingType(TypeChecker &TC, InFlightDiagnostic &diag,
 
   if (auto CITR = dyn_cast<ComponentIdentTypeRepr>(complainRepr)) {
     const ValueDecl *VD = CITR->getBoundDecl();
-    TC.diagnose(VD, diag::type_declared_here);
+    TC.diagnose(VD, diag::kind_declared_here, DescriptiveDeclKind::Type);
   }
 }
 
@@ -3428,11 +3429,9 @@ static void checkVarBehavior(VarDecl *decl, TypeChecker &TC) {
                       diag::property_behavior_protocol_reqt_ambiguous,
                       TC.Context.Id_initStorage);
           TC.diagnose(defaultInitStorageDecl->getLoc(),
-                      diag::property_behavior_protocol_reqt_here,
-                      TC.Context.Id_initStorage);
+                      diag::identifier_declared_here, TC.Context.Id_initStorage);
           TC.diagnose(parameterizedInitStorageDecl->getLoc(),
-                      diag::property_behavior_protocol_reqt_here,
-                      TC.Context.Id_initStorage);
+                      diag::identifier_declared_here, TC.Context.Id_initStorage);
           conformance->setInvalid();
           continue;
         }
@@ -3501,8 +3500,7 @@ static void checkVarBehavior(VarDecl *decl, TypeChecker &TC) {
           TC.diagnose(behavior->getLoc(),
                       diag::property_behavior_invalid_parameter_reqt,
                       behaviorProto->getName());
-          TC.diagnose(varReqt->getLoc(),
-                      diag::property_behavior_protocol_reqt_here,
+          TC.diagnose(varReqt->getLoc(), diag::identifier_declared_here,
                       TC.Context.Id_parameter);
           conformance->setInvalid();
           continue;
@@ -3772,7 +3770,8 @@ void TypeChecker::validateDecl(PrecedenceGroupDecl *PGD) {
             == dc->getParentModule()) {
         if (!PGD->isInvalid()) {
           diagnose(rel.NameLoc, diag::precedence_group_lower_within_module);
-          diagnose(group->getNameLoc(), diag::precedence_group_declared_here);
+          diagnose(group->getNameLoc(), diag::kind_declared_here,
+                   DescriptiveDeclKind::PrecedenceGroup);
           isInvalid = true;
         }
       } else {
@@ -4476,7 +4475,7 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
       SmallVector<EnumDecl *, 8> path;
       path.push_back(ED);
       checkCircularity(TC, ED, diag::circular_enum_inheritance,
-                       diag::enum_here, path);
+                       DescriptiveDeclKind::Enum, path);
     }
 
     for (Decl *member : ED->getMembers())
@@ -4636,7 +4635,7 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
       SmallVector<ClassDecl *, 8> path;
       path.push_back(CD);
       checkCircularity(TC, CD, diag::circular_class_inheritance,
-                       diag::class_here, path);
+                       DescriptiveDeclKind::Class, path);
     }
 
     for (Decl *Member : CD->getMembers())
@@ -4760,7 +4759,7 @@ class DeclChecker : public DeclVisitor<DeclChecker> {
       SmallVector<ProtocolDecl *, 8> path;
       path.push_back(PD);
       checkCircularity(TC, PD, diag::circular_protocol_def,
-                       diag::protocol_here, path);
+                       DescriptiveDeclKind::Protocol, path);
 
       // Make sure the parent protocols have been fully validated.
       for (auto inherited : PD->getLocalProtocols()) {
@@ -6877,7 +6876,7 @@ void TypeChecker::validateDecl(ValueDecl *D) {
         if (mentionsItself) {
           diagnose(defaultDefinition.getLoc(), diag::recursive_type_reference,
                    assocType->getDescriptiveKind(), assocType->getName());
-          diagnose(assocType, diag::type_declared_here);
+          diagnose(assocType, diag::kind_declared_here, DescriptiveDeclKind::Type);
         }
       }
     }
@@ -7007,8 +7006,8 @@ void TypeChecker::validateDecl(ValueDecl *D) {
           diagnose(proto->getLoc(),
                    diag::objc_protocol_inherits_non_objc_protocol,
                    proto->getDeclaredType(), inherited->getDeclaredType());
-          diagnose(inherited->getLoc(), diag::protocol_here,
-                   inherited->getName());
+          diagnose(inherited->getLoc(), diag::kind_identifier_declared_here,
+                   DescriptiveDeclKind::Protocol, inherited->getName());
           isObjC = None;
         }
       }

lib/Sema/TypeCheckProtocol.cpp

@@ -2732,9 +2732,9 @@ ConformanceChecker::resolveWitnessViaLookup(ValueDecl *requirement) {
             }
           }
 
-          diags.diagnose(requirement, diag::protocol_requirement_here,
+          diags.diagnose(requirement, diag::kind_declname_declared_here,
+                         DescriptiveDeclKind::Requirement,
                          requirement->getFullName());
-
         });
     }
 
@@ -2835,7 +2835,8 @@ ConformanceChecker::resolveWitnessViaLookup(ValueDecl *requirement) {
             }
           }
 
-          diags.diagnose(requirement, diag::protocol_requirement_here,
+          diags.diagnose(requirement, diag::kind_declname_declared_here,
+                         DescriptiveDeclKind::Requirement,
                          requirement->getFullName());
       });
       break;
@@ -2873,7 +2874,8 @@ ConformanceChecker::resolveWitnessViaLookup(ValueDecl *requirement) {
                          witness->getFullName(),
                          conformance->getProtocol()->getFullName());
           emitDeclaredHereIfNeeded(diags, diagLoc, witness);
-          diags.diagnose(requirement, diag::protocol_requirement_here,
+          diags.diagnose(requirement, diag::kind_declname_declared_here,
+                         DescriptiveDeclKind::Requirement,
                          requirement->getFullName());
         });
       break;
@@ -3516,7 +3518,8 @@ void ConformanceChecker::checkConformance(MissingWitnessDiagnosisKind Kind) {
                            "@nonobjc ");
           }
 
-          TC.diagnose(requirement, diag::protocol_requirement_here,
+          TC.diagnose(requirement, diag::kind_declname_declared_here,
+                      DescriptiveDeclKind::Requirement,
                       requirement->getFullName());
 
           Conformance->setInvalid();
@@ -4484,7 +4487,8 @@ static void diagnosePotentialWitness(TypeChecker &tc,
       .fixItInsert(witness->getAttributeInsertionLoc(false), "@nonobjc ");
   }
 
-  tc.diagnose(req, diag::protocol_requirement_here, req->getFullName());
+  tc.diagnose(req, diag::kind_declname_declared_here,
+              DescriptiveDeclKind::Requirement, req->getFullName());
 }
 
 /// Whether the given protocol is "NSCoding".