Merge pull request #80342 from AnthonyLatsis/andrias-japonicus

 Diag: Handle `CustomAttr` in `formatDiagnosticArgument`

Author: AnthonyLatsis

include/swift/AST/DiagnosticsParse.def

@@ -463,7 +463,7 @@ ERROR(operator_decl_no_fixity,none,
 ERROR(operator_decl_expected_precedencegroup, none,
       "expected precedence group name after ':' in operator declaration", ())
 ERROR(operator_decl_should_not_contain_other_attributes, none, 
-      "unexpected attribute %0 in operator declaration", (StringRef))
+      "unexpected attribute %0 in operator declaration", (DeclAttribute))
 WARNING(operator_decl_remove_designated_types,none,
         "designated types are no longer used by the compiler; please remove "
         "the designated type list from this operator declaration", ())
@@ -1485,7 +1485,11 @@ ERROR(multiple_access_level_modifiers,none,
 NOTE(previous_access_level_modifier,none,
      "previous modifier specified here", ())
 ERROR(mutually_exclusive_attrs,none,
-      "'%0' contradicts previous %select{attribute|modifier}2 '%1'", (StringRef, StringRef, bool))
+      "%0 contradicts previous %select{attribute|modifier}2 %1",
+      (DeclAttribute, DeclAttribute, bool))
+ERROR(mutually_exclusive_attr_names,none,
+      "'%0' contradicts previous %select{attribute|modifier}2 '%1'",
+      (StringRef, StringRef, bool))
 
 ERROR(invalid_infix_on_func,none,
       "'infix' modifier is not required or allowed on func declarations", ())
@@ -1560,6 +1564,8 @@ WARNING(attr_renamed_to_modifier_warning, none,
 ERROR(attr_name_close_match, none,
       "no attribute named '@%0'; did you mean '@%1'?", (StringRef, StringRef))
 ERROR(attr_unsupported_on_target, none,
+      "attribute %0 is unsupported on target '%1'", (DeclAttribute, StringRef))
+ERROR(attr_name_unsupported_on_target, none,
       "attribute '%0' is unsupported on target '%1'", (StringRef, StringRef))
 
 // availability

include/swift/AST/DiagnosticsSema.def

@@ -319,8 +319,8 @@ ERROR(class_cannot_be_addressable_for_dependencies,none,
       "a class cannot be @_addressableForDependencies", ())
 
 ERROR(unsupported_closure_attr,none,
-      "%select{attribute |}0'%1' is not supported on a closure",
-      (bool, StringRef))
+      "%select{attribute |}0%1 is not supported on a closure",
+      (bool, DeclAttribute))
 
 NOTE(suggest_partial_overloads,none,
       "overloads for '%1' exist with these %select{"
@@ -1730,11 +1730,11 @@ ERROR(missing_initializer_def,PointsToFirstBadToken,
 ERROR(operator_not_func,none,
       "operators must be declared with 'func'", ())
 ERROR(redefining_builtin_operator,none,
-      "cannot declare a custom %0 '%1' operator", (StringRef, StringRef))
+      "cannot declare a custom %0 '%1' operator", (DeclAttribute, StringRef))
 ERROR(attribute_requires_operator_identifier,none,
-      "'%0' requires a function with an operator identifier", (StringRef))
+      "%0 requires a function with an operator identifier", (DeclAttribute))
 ERROR(attribute_requires_single_argument,none,
-      "'%0' requires a function with one argument", (StringRef))
+      "%0 requires a function with one argument", (DeclAttribute))
 
 ERROR(nominal_type_not_attribute,none,
       "%kind0 cannot be used as an attribute", (const ValueDecl *))
@@ -1783,23 +1783,24 @@ ERROR(invalid_ibdesignable_extension,none,
       "@IBDesignable can only be applied to classes and extensions "
       "of classes", ())
 ERROR(attr_must_be_used_on_class_instance,none,
-      "only class instance properties can be declared @%0", (StringRef))
+      "only class instance properties can be declared %0", (DeclAttribute))
 ERROR(invalid_ibaction_decl,none,
-      "only instance methods can be declared @%0", (StringRef))
+      "only instance methods can be declared %0", (DeclAttribute))
 ERROR(invalid_ibaction_result,none,
-      "methods declared @%0 must %select{|not }1return a value", (StringRef, bool))
+      "methods declared %0 must %select{|not }1return a value",
+      (DeclAttribute, bool))
 ERROR(invalid_ibaction_argument_count,none,
-      "@%0 methods must have %1 to %2 arguments",
-      (StringRef, int, int))
+      "%0 methods must have %1 to %2 arguments",
+      (DeclAttribute, int, int))
 ERROR(invalid_ibaction_argument_count_exact,none,
-      "@%0 methods must have %2 argument%s2",
-      (StringRef, int, int))
+      "%0 methods must have %2 argument%s2",
+      (DeclAttribute, int, int))
 ERROR(invalid_ibaction_argument_count_max,none,
-      "@%0 methods must have at most %2 argument%s2",
-      (StringRef, int, int))
+      "%0 methods must have at most %2 argument%s2",
+      (DeclAttribute, int, int))
 ERROR(ibsegueaction_objc_method_family,none,
-      "@%0 method cannot have selector %1 because it has special memory "
-      "management behavior", (StringRef, ObjCSelector))
+      "%0 method cannot have selector %1 because it has special memory "
+      "management behavior", (DeclAttribute, ObjCSelector))
 NOTE(fixit_rename_in_swift,none,
      "change Swift name to %0", (DeclName))
 NOTE(fixit_rename_in_objc,none,
@@ -2051,7 +2052,8 @@ ERROR(extern_not_at_top_level_func,none,
 ERROR(extern_empty_c_name,none,
       "expected non-empty C name in @_extern attribute", ())
 ERROR(extern_only_non_other_attr,none,
-      "@_extern attribute cannot be applied to an '@%0' declaration", (StringRef))
+      "@_extern attribute cannot be applied to an %0 declaration",
+      (DeclAttribute))
 WARNING(extern_c_maybe_invalid_name, none,
         "C name '%0' may be invalid; explicitly specify the name in @_extern(c) to suppress this warning",
         (StringRef))
@@ -2142,14 +2144,16 @@ ERROR(expose_zero_size_to_cxx,none,
 ERROR(attr_methods_only,none,
       "only methods can be declared %0", (DeclAttribute))
 ERROR(attr_decl_async,none,
-      "@%0 %1 cannot be asynchronous", (StringRef, DescriptiveDeclKind))
+      "%0 %kindonly1 cannot be asynchronous", (DeclAttribute, const FuncDecl *))
 
 ERROR(attr_only_at_non_local_scope, none,
+      "attribute %0 can only be used in a non-local scope", (DeclAttribute))
+ERROR(attr_name_only_at_non_local_scope, none,
       "attribute '%0' can only be used in a non-local scope", (StringRef))
 ERROR(attr_only_at_non_generic_scope, none,
-      "attribute '%0' cannot be used in a generic context", (StringRef))
+      "attribute %0 cannot be used in a generic context", (DeclAttribute))
 ERROR(attr_only_on_static_properties, none,
-      "properties with attribute '%0' must be static", (StringRef))
+      "properties with attribute %0 must be static", (DeclAttribute))
 
 ERROR(weak_unowned_in_embedded_swift, none,
       "attribute %0 cannot be used in embedded Swift", (ReferenceOwnership))
@@ -4018,7 +4022,7 @@ ERROR(attr_has_no_effect_on_unavailable_decl,none,
       (DeclAttribute, const ValueDecl *, AvailabilityDomain))
 
 ERROR(attr_ambiguous_reference_to_decl,none,
-      "ambiguous reference to %0 in '@%1' attribute", (DeclNameRef, StringRef))
+      "ambiguous reference to %0 in %1 attribute", (DeclNameRef, DeclAttribute))
 
 ERROR(attr_contains_multiple_versions_for_platform,none,
       "'%0' contains multiple versions for %1", (DeclAttribute, StringRef))
@@ -6001,14 +6005,15 @@ NOTE(move_global_actor_attr_to_storage_decl,none,
      "move global actor attribute to %kind0", (const ValueDecl *))
 
 ERROR(actor_isolation_multiple_attr_2,none,
-      "%kind0 has multiple actor-isolation attributes ('%1' and '%2')",
-      (const Decl *, StringRef, StringRef))
+      "%kind0 has multiple actor-isolation attributes (%1 and %2)",
+      (const Decl *, DeclAttribute, DeclAttribute))
 ERROR(actor_isolation_multiple_attr_3,none,
-      "%0 %1 has multiple actor-isolation attributes ('%2', '%3' and '%4')",
-      (const Decl *, StringRef, StringRef, StringRef))
+      "%0 %1 has multiple actor-isolation attributes (%2, %3 and %4)",
+      (const Decl *, DeclAttribute, DeclAttribute, DeclAttribute))
 ERROR(actor_isolation_multiple_attr_4,none,
-      "%0 %1 has multiple actor-isolation attributes ('%2', '%3', '%4', and '%5')",
-      (const Decl *, StringRef, StringRef, StringRef, StringRef))
+      "%0 %1 has multiple actor-isolation attributes (%2, %3, %4, and %5)",
+      (const Decl *, DeclAttribute, DeclAttribute, DeclAttribute,
+       DeclAttribute))
 ERROR(actor_isolation_override_mismatch,none,
       "%0 %kind1 has different actor isolation from %2 overridden declaration",
       (ActorIsolation, const ValueDecl *, ActorIsolation))

lib/AST/DiagnosticEngine.cpp

@@ -1083,17 +1083,28 @@ static void formatDiagnosticArgument(StringRef Modifier,
     Out << Stmt::getDescriptiveKindName(Arg.getAsDescriptiveStmtKind());
     break;
 
-  case DiagnosticArgumentKind::DeclAttribute:
+  case DiagnosticArgumentKind::DeclAttribute: {
+    auto *const attr = Arg.getAsDeclAttribute();
+    const auto printAttrName = [&] {
+      if (auto *custom = dyn_cast<CustomAttr>(attr)) {
+        custom->getTypeRepr()->print(Out);
+      } else {
+        Out << attr->getAttrName();
+      }
+    };
+
     assert(Modifier.empty() &&
            "Improper modifier for DeclAttribute argument");
-    if (Arg.getAsDeclAttribute()->isDeclModifier())
-      Out << FormatOpts.OpeningQuotationMark
-          << Arg.getAsDeclAttribute()->getAttrName()
-          << FormatOpts.ClosingQuotationMark;
-    else
-      Out << '@' << Arg.getAsDeclAttribute()->getAttrName();
+    if (Arg.getAsDeclAttribute()->isDeclModifier()) {
+      Out << FormatOpts.OpeningQuotationMark;
+      printAttrName();
+      Out << FormatOpts.ClosingQuotationMark;
+    } else {
+      Out << '@';
+      printAttrName();
+    }
     break;
-
+  }
   case DiagnosticArgumentKind::AvailabilityDomain:
     assert(Modifier.empty() &&
            "Improper modifier for AvailabilityDomain argument");

lib/Parse/ParseDecl.cpp

@@ -2858,7 +2858,7 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
 
     // Diagnose using access control in a local scope, which isn't meaningful.
     if (CurDeclContext->isLocalContext()) {
-      diagnose(Loc, diag::attr_only_at_non_local_scope, AttrName);
+      diagnose(Loc, diag::attr_name_only_at_non_local_scope, AttrName);
     }
 
     AccessLevel access = llvm::StringSwitch<AccessLevel>(AttrName)
@@ -3067,7 +3067,7 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
     if (CurDeclContext->isLocalContext()) {
       // Emit an error, but do not discard the attribute.  This enables
       // better recovery in the parser.
-      diagnose(Loc, diag::attr_only_at_non_local_scope, AttrName);
+      diagnose(Loc, diag::attr_name_only_at_non_local_scope, AttrName);
     }
 
     if (!DiscardAttribute) {
@@ -3132,7 +3132,7 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
 
     // @_section in a local scope is not allowed.
     if (CurDeclContext->isLocalContext()) {
-      diagnose(Loc, diag::attr_only_at_non_local_scope, AttrName);
+      diagnose(Loc, diag::attr_name_only_at_non_local_scope, AttrName);
     }
 
     if (!DiscardAttribute)
@@ -3619,7 +3619,8 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
   case DeclAttrKind::Derivative: {
     // `@derivative` in a local scope is not allowed.
     if (CurDeclContext->isLocalContext())
-      diagnose(Loc, diag::attr_only_at_non_local_scope, '@' + AttrName.str());
+      diagnose(Loc, diag::attr_name_only_at_non_local_scope,
+               '@' + AttrName.str());
 
     auto Attr = parseDerivativeAttribute(AtLoc, Loc);
     Status |= Attr;
@@ -3631,7 +3632,8 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
   case DeclAttrKind::Transpose: {
     // `@transpose` in a local scope is not allowed.
     if (CurDeclContext->isLocalContext())
-      diagnose(Loc, diag::attr_only_at_non_local_scope, '@' + AttrName.str());
+      diagnose(Loc, diag::attr_name_only_at_non_local_scope,
+               '@' + AttrName.str());
 
     auto Attr = parseTransposeAttribute(AtLoc, Loc);
     Status |= Attr;
@@ -5455,10 +5457,9 @@ static void diagnoseOperatorFixityAttributes(Parser &P,
   for (auto it = fixityAttrs.begin(); it != fixityAttrs.end(); ++it) {
     if (it != fixityAttrs.begin()) {
       auto *attr = *it;
-      P.diagnose(attr->getLocation(), diag::mutually_exclusive_attrs,
-                 attr->getAttrName(), fixityAttrs.front()->getAttrName(),
-                 attr->isDeclModifier())
-      .fixItRemove(attr->getRange());
+      P.diagnose(attr->getLocation(), diag::mutually_exclusive_attrs, attr,
+                 fixityAttrs.front(), attr->isDeclModifier())
+          .fixItRemove(attr->getRange());
       attr->setInvalid();
     }
   }
@@ -5475,8 +5476,7 @@ static void diagnoseOperatorFixityAttributes(Parser &P,
       }
       auto *attr = *it;
       P.diagnose(attr->getLocation(),
-                 diag::operator_decl_should_not_contain_other_attributes,
-                 attr->getAttrName())
+                 diag::operator_decl_should_not_contain_other_attributes, attr)
           .fixItRemove(attr->getRange());
       attr->setInvalid();
     }

lib/SIL/Parser/ParseSIL.cpp

@@ -744,7 +744,7 @@ static bool parseDeclSILOptional(
       *specialPurpose = SILFunction::Purpose::GlobalInitOnceFunction;
     else if (isWeakImported && SP.P.Tok.getText() == "weak_imported") {
       if (M.getASTContext().LangOpts.Target.isOSBinFormatCOFF())
-        SP.P.diagnose(SP.P.Tok, diag::attr_unsupported_on_target,
+        SP.P.diagnose(SP.P.Tok, diag::attr_name_unsupported_on_target,
                       SP.P.Tok.getText(),
                       M.getASTContext().LangOpts.Target.str());
       else

lib/SIL/Parser/SILParser.h

@@ -394,7 +394,8 @@ class SILParser {
       if (*existing.Value == value) {
         P.diagnose(loc, diag::duplicate_attribute, /*modifier*/ 1);
       } else {
-        P.diagnose(loc, diag::mutually_exclusive_attrs, name, existing.Name,
+        P.diagnose(loc, diag::mutually_exclusive_attr_names, name,
+                   existing.Name,
                    /*modifier*/ 1);
       }
       P.diagnose(existing.Loc, diag::previous_attribute, /*modifier*/ 1);