fixup! [Diagnostics] Add -[no-]warning-as-error flags for precise control over warning behavior

Author: DmT021

include/swift/AST/DefineDiagnosticGroupsMacros.h

@@ -20,60 +20,47 @@
 
 #undef DEFINE_DIAGNOSTIC_GROUPS_MACROS
 
-#ifndef GROUP_DECL
-#error GROUP_DECL(Name, Version) macro is not defined
+#if !(defined(GROUP) || defined(GROUP_LINK))
+#error No reqired macros defined. Define at least one of the following macros: GROUP(Name, DocsFile), GROUP_LINK(Parent, Child)
 #endif
 
-#ifndef GROUP_LINK
-#error GROUP_LINK(Parent, Child) macro is not defined
-#endif
-
-// FOR_EACH macro implementation from
-// https://www.scs.stanford.edu/~dm/blog/va-opt.html
-// Extended with "context" parameter to pass an additional common argument
-#define PARENS ()
-#define EXPAND(...) EXPAND4(EXPAND4(EXPAND4(EXPAND4(__VA_ARGS__))))
-#define EXPAND4(...) EXPAND3(EXPAND3(EXPAND3(EXPAND3(__VA_ARGS__))))
-#define EXPAND3(...) EXPAND2(EXPAND2(EXPAND2(EXPAND2(__VA_ARGS__))))
-#define EXPAND2(...) EXPAND1(EXPAND1(EXPAND1(EXPAND1(__VA_ARGS__))))
-#define EXPAND1(...) __VA_ARGS__
-#define FOR_EACH_WITH_CTX(macro, context, ...)                                 \
-  __VA_OPT__(EXPAND(FOR_EACH_WITH_CTX_HELPER(macro, context, __VA_ARGS__)))
-#define FOR_EACH_WITH_CTX_HELPER(macro, context, a1, ...)                      \
-  macro(context, a1)                                                           \
-  __VA_OPT__(FOR_EACH_WITH_CTX_AGAIN PARENS (macro, context, __VA_ARGS__))
-#define FOR_EACH_WITH_CTX_AGAIN() FOR_EACH_WITH_CTX_HELPER
-
 // GROUP macro:
+// Declares a diagnostic group.
+// Parameters:
 //   Name - group name as it appears in DiagGroupID enum and DiagGroupInfo.name
-//   Version - compiler version when this group was added
-//   __VA_ARGS__ - subgroups of this group
-#define GROUP(Name, Version, ...)                                              \
-  GROUP_DECL(Name, Version)                                                    \
-  FOR_EACH_WITH_CTX(GROUP_LINK, Name, __VA_ARGS__)
+//   DocsFile - file with a human readable description for the group located in
+//   userdocs/diagnostic_groups
+#ifndef GROUP
+#define GROUP(Name, DocsFile)
+#endif
+
+// GROUP_LINK macro:
+// Establishes an edge in the diagnostic group graph between
+// a supergroup(Parent) and its subgroup(Child).
+// Parameters:
+//   Parent - parent group name
+//   Child - child group name
+#ifndef GROUP_LINK
+#define GROUP_LINK(Parent, Child)
+#endif
 
 // Undefine macros
 #elif defined(UNDEFINE_DIAGNOSTIC_GROUPS_MACROS) &&                            \
     !defined(DEFINE_DIAGNOSTIC_GROUPS_MACROS)
 
 #undef UNDEFINE_DIAGNOSTIC_GROUPS_MACROS
 
-#ifndef GROUP
+#ifdef GROUP
+#undef GROUP
+#else
 #error Trying to undefine the diagnostic groups macros, but GROUP macro wasn't defined
 #endif
 
-#undef PARENS
-#undef EXPAND
-#undef EXPAND4
-#undef EXPAND3
-#undef EXPAND2
-#undef EXPAND1
-#undef FOR_EACH
-#undef FOR_EACH_HELPER
-#undef FOR_EACH_AGAIN
-#undef GROUP
-#undef GROUP_DECL
+#ifdef GROUP_LINK
 #undef GROUP_LINK
+#else
+#error Trying to undefine the diagnostic groups macros, but GROUP_LINK macro wasn't defined
+#endif
 
 #else
 #error Invalid DefineDiagnosticGroupsMacros.h inclusion

include/swift/AST/DiagnosticEngine.h

@@ -1109,9 +1109,7 @@ namespace swift {
 
     /// Apply rules specifing what warnings should or shouldn't be treated as
     /// errors. For group rules the string is either a group name defined by
-    /// DiagnosticGroups.def or a string with format "_id:<diag_id>" where
-    /// <diag_id> is one of the diagnostic IDs listed in
-    /// include/swift/AST/Diagnostics*.def
+    /// DiagnosticGroups.def
     /// Rules are applied in order they appear in the vector.
     /// In case the vector contains rules affecting the same diagnostic ID
     /// the last rule wins.

include/swift/AST/DiagnosticGroups.def

@@ -10,25 +10,24 @@
 //
 //===----------------------------------------------------------------------===//
 //
-//  This file defines diagnostic groups.
+//  This file defines diagnostic groups and links between them.
 //
 //===----------------------------------------------------------------------===//
 
 #define DEFINE_DIAGNOSTIC_GROUPS_MACROS
 #include "swift/AST/DefineDiagnosticGroupsMacros.h"
 
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments"
+// GROUP(Name, DocsFile)
+// GROUP_LINK(Parent, Child)
 
-GROUP(no_group, 6.0)
+GROUP(no_group, "")
 
-GROUP(deprecated, 6.0, availability_deprecated)
-GROUP(availability_deprecated, 6.0)
+GROUP(deprecated, "deprecated.md")
+GROUP_LINK(deprecated, availability_deprecated)
 
-GROUP(unknown_warning_group, 6.0)
-GROUP(error_in_future_swift_version, 6.0)
+GROUP(availability_deprecated, "availability_deprecated.md")
 
-#pragma clang diagnostic pop
+GROUP(unknown_warning_group, "unknown_warning_group.md")
 
 #define UNDEFINE_DIAGNOSTIC_GROUPS_MACROS
 #include "swift/AST/DefineDiagnosticGroupsMacros.h"

include/swift/AST/DiagnosticGroups.h

@@ -27,15 +27,13 @@
 namespace swift {
 
 enum class DiagGroupID : uint16_t {
-#define GROUP_DECL(Name, Version) Name,
-#define GROUP_LINK(Parent, Child)
+#define GROUP(Name, Version) Name,
 #include "swift/AST/DiagnosticGroups.def"
 };
 
 constexpr const auto DiagGroupsCount = [] {
   size_t count = 0;
-#define GROUP_DECL(Name, Version) count++;
-#define GROUP_LINK(Parent, Child)
+#define GROUP(Name, Version) count++;
 #include "DiagnosticGroups.def"
   return count;
 }();
@@ -48,8 +46,8 @@ struct DiagGroupInfo {
   llvm::ArrayRef<DiagGroupID> subgroups;
   llvm::ArrayRef<DiagID> diagnostics;
 
-  void
-  traverseDepthFirst(std::function<void(const DiagGroupInfo &)> func) const;
+  void traverseDepthFirst(
+      llvm::function_ref<void(const DiagGroupInfo &)> func) const;
 };
 
 extern const std::array<DiagGroupInfo, DiagGroupsCount> diagnosticGroupsInfo;

include/swift/AST/DiagnosticsCommon.def

@@ -47,7 +47,7 @@ ERROR(error_no_group_info,none,
 NOTE(brace_stmt_suggest_do,none,
      "did you mean to use a 'do' statement?", ())
 
-GROUPED_WARNING(error_in_future_swift_version,error_in_future_swift_version,none,
+WARNING(error_in_future_swift_version,none,
         "%0; this is an error in the Swift %1 language mode",
         (DiagnosticInfo *, unsigned))
 

lib/AST/DiagnosticEngine.cpp

@@ -145,11 +145,6 @@ static constexpr const char *const diagnosticIDStrings[] = {
     "<not a diagnostic>",
 };
 
-std::unordered_map<std::string_view, DiagID> diagnosticIDStringToIDMap{
-#define DIAG(KIND, ID, Group, Options, Text, Signature) {#ID, DiagID::ID},
-#include "swift/AST/DiagnosticsAll.def"
-};
-
 static constexpr const char *const fixItStrings[] = {
 #define DIAG(KIND, ID, Group, Options, Text, Signature)
 #define FIXIT(ID, Text, Signature) Text,
@@ -526,7 +521,6 @@ bool DiagnosticEngine::finishProcessing() {
 
 void DiagnosticEngine::setWarningsAsErrorsRules(
     const std::vector<WarningAsErrorRule> &rules) {
-  const std::string_view idPrefix = "_id:";
   std::vector<std::string> unknownGroups;
   for (const auto &rule : rules) {
     bool isEnabled = [&] {
@@ -540,29 +534,17 @@ void DiagnosticEngine::setWarningsAsErrorsRules(
     auto target = rule.getTarget();
     if (auto group = std::get_if<WarningAsErrorRule::TargetGroup>(&target)) {
       auto name = std::string_view(group->name);
-      if (name.rfind(idPrefix, 0) == 0) {
-        // The rule is defined as a prefixed diagID
-        auto diagIDName = name.substr(idPrefix.size());
-        auto it = diagnosticIDStringToIDMap.find(diagIDName);
-        if (it != diagnosticIDStringToIDMap.end()) {
-          auto diagID = it->second;
-          state.setWarningAsErrorForDiagID(diagID, isEnabled);
-        } else {
-          unknownGroups.push_back(std::string(name));
-        }
+      // Validate the group name and set the new behavior for each diagnostic
+      // associated with the group and all its subgroups.
+      if (auto groupID = getDiagGroupIDByName(name);
+          groupID && *groupID != DiagGroupID::no_group) {
+        getDiagGroupInfoByID(*groupID).traverseDepthFirst([&](auto group) {
+          for (DiagID diagID : group.diagnostics) {
+            state.setWarningAsErrorForDiagID(diagID, isEnabled);
+          }
+        });
       } else {
-        // The rule is defined as a group name. Apply it to each diagnostic
-        // associated with the group and all its subgroups.
-        if (auto groupID = getDiagGroupIDByName(name);
-            groupID && *groupID != DiagGroupID::no_group) {
-          getDiagGroupInfoByID(*groupID).traverseDepthFirst([&](auto group) {
-            for (DiagID diagID : group.diagnostics) {
-              state.setWarningAsErrorForDiagID(diagID, isEnabled);
-            }
-          });
-        } else {
-          unknownGroups.push_back(std::string(name));
-        }
+        unknownGroups.push_back(std::string(name));
       }
     } else if (std::holds_alternative<WarningAsErrorRule::TargetAll>(target)) {
       state.setAllWarningsAsErrors(isEnabled);

lib/AST/DiagnosticGroups.cpp

@@ -1,4 +1,4 @@
-//===--- DiagnosticGroups.h - Diagnostic Groups -----------------*- C++ -*-===//
+//===--- DiagnosticGroups.cpp - Diagnostic Groups ---------------*- C++ -*-===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -50,7 +50,6 @@ constexpr const auto diagnosticGroupConnections = [] {
     std::array<size_t, DiagGroupsCount> diagnosticsCount{};
 
     // Count edges for each diagnostic group
-#define GROUP_DECL(Name, Version)
 #define GROUP_LINK(Parent, Child)                                              \
   subgroupsCount[(size_t)DiagGroupID::Parent]++;                               \
   supergroupsCount[(size_t)DiagGroupID::Child]++;
@@ -68,54 +67,45 @@ constexpr const auto diagnosticGroupConnections = [] {
   constexpr auto diagnosticsCount = std::get<2>(sizes);
 
   // Declare all edges
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wunused-variable"
-
-#define GROUP_DECL(Name, Version)                                              \
+#define GROUP(Name, Version)                                              \
   std::array<DiagGroupID, supergroupsCount[(size_t)DiagGroupID::Name]>         \
       Name##_supergroups{};                                                    \
   std::array<DiagGroupID, subgroupsCount[(size_t)DiagGroupID::Name]>           \
       Name##_subgroups{};                                                      \
   std::array<DiagID, diagnosticsCount[(size_t)DiagGroupID::Name]>              \
       Name##_diagnostics{};                                                    \
-  size_t Name##_supergroupsIndex = 0;                                          \
-  size_t Name##_subgroupsIndex = 0;                                            \
-  size_t Name##_diagnosticsIndex = 0;
-#define GROUP_LINK(Parent, Child)
+  [[maybe_unused]] size_t Name##_supergroupsIndex = 0;                         \
+  [[maybe_unused]] size_t Name##_subgroupsIndex = 0;                           \
+  [[maybe_unused]] size_t Name##_diagnosticsIndex = 0;
 #include "swift/AST/DiagnosticGroups.def"
 
   // Bind all groups to each other
-#define GROUP_DECL(Name, Version)
 #define GROUP_LINK(Parent, Child)                                              \
   Parent##_subgroups[Parent##_subgroupsIndex++] = DiagGroupID::Child;          \
   Child##_supergroups[Child##_supergroupsIndex++] = DiagGroupID::Parent;
 #include "swift/AST/DiagnosticGroups.def"
 
-#pragma clang diagnostic pop
-
   // Bind all diagnostics to their groups
 #define DIAG(KIND, ID, Group, Options, Text, Signature)                        \
   Group##_diagnostics[Group##_diagnosticsIndex++] = DiagID::ID;
 #include "swift/AST/DiagnosticsAll.def"
 
   // Produce the resulting structure with all the edges
-#define GROUP_DECL(Name, Version)                                              \
+#define GROUP(Name, Version)                                              \
   GroupConnections(Name##_supergroups, Name##_subgroups, Name##_diagnostics),
-#define GROUP_LINK(Parent, Child)
   return std::tuple{
 #include "swift/AST/DiagnosticGroups.def"
   };
 }();
 
 std::unordered_map<std::string_view, DiagGroupID> nameToIDMap{
-#define GROUP_DECL(Name, Version) {#Name, DiagGroupID::Name},
-#define GROUP_LINK(Parent, Child)
+#define GROUP(Name, Version) {#Name, DiagGroupID::Name},
 #include "swift/AST/DiagnosticGroups.def"
 };
 
 void traverseDepthFirst(DiagGroupID id,
                         std::unordered_set<DiagGroupID> &visited,
-                        std::function<void(const DiagGroupInfo &)> func) {
+                        llvm::function_ref<void(const DiagGroupInfo &)> func) {
   if (visited.insert(id).second) {
     const auto &info = getDiagGroupInfoByID(id);
     func(info);
@@ -128,7 +118,7 @@ void traverseDepthFirst(DiagGroupID id,
 } // end anonymous namespace
 
 constexpr const std::array<DiagGroupInfo, DiagGroupsCount> diagnosticGroupsInfo{
-#define GROUP_DECL(Name, Version)                                              \
+#define GROUP(Name, Version)                                              \
   DiagGroupInfo{                                                               \
       DiagGroupID::Name,                                                       \
       #Name,                                                                   \
@@ -142,7 +132,6 @@ constexpr const std::array<DiagGroupInfo, DiagGroupsCount> diagnosticGroupsInfo{
       llvm::ArrayRef<DiagID>(                                                  \
           std::get<(size_t)DiagGroupID::Name>(diagnosticGroupConnections)      \
               .diagnostics)},
-#define GROUP_LINK(Parent, Child)
 #include "swift/AST/DiagnosticGroups.def"
 };
 
@@ -158,7 +147,7 @@ std::optional<DiagGroupID> getDiagGroupIDByName(std::string_view name) {
 }
 
 void DiagGroupInfo::traverseDepthFirst(
-    std::function<void(const DiagGroupInfo &)> func) const {
+    llvm::function_ref<void(const DiagGroupInfo &)> func) const {
   std::unordered_set<DiagGroupID> visited;
   ::swift::traverseDepthFirst(id, visited, func);
 }

test/diagnostics/warnings_as_errors_rules.swift

@@ -1,13 +1,10 @@
 // RUN: not %target-swift-frontend -typecheck -diagnostic-style llvm -warnings-as-errors %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-ALL
 // RUN: not %target-swift-frontend -typecheck -diagnostic-style llvm -warning-as-error availability_deprecated %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-GROUP
 // RUN: not %target-swift-frontend -typecheck -diagnostic-style llvm -warning-as-error deprecated %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-SUPERGROUP
-// RUN: not %target-swift-frontend -typecheck -diagnostic-style llvm -warning-as-error _id:availability_deprecated -warning-as-error _id:availability_deprecated_rename %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-DIAGID
 // RUN: %target-swift-frontend -typecheck -diagnostic-style llvm -warnings-as-errors -no-warnings-as-errors %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-ALL-NWAE-ALL
 // RUN: %target-swift-frontend -typecheck -diagnostic-style llvm -warnings-as-errors -no-warning-as-error availability_deprecated %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-ALL-NWAE-GROUP
 // RUN: %target-swift-frontend -typecheck -diagnostic-style llvm -warnings-as-errors -no-warning-as-error deprecated %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-ALL-NWAE-SUPERGROUP
-// RUN: %target-swift-frontend -typecheck -diagnostic-style llvm -warnings-as-errors -no-warning-as-error _id:availability_deprecated -no-warning-as-error _id:availability_deprecated_rename %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-ALL-NWAE-DIAGID
 // RUN: %target-swift-frontend -typecheck -diagnostic-style llvm -warning-as-error deprecated -no-warning-as-error availability_deprecated %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-SUPERGROUP-NWAE-GROUP
-// RUN: not %target-swift-frontend -typecheck -diagnostic-style llvm -warning-as-error availability_deprecated -no-warning-as-error _id:availability_deprecated %s 2>&1 | %FileCheck %s --check-prefix=CHECK-WAE-GROUP-NWAE-DIAGID
 
 
 @available(*, deprecated)
@@ -25,20 +22,14 @@ func bar() {
 // CHECK-WAE-GROUP-NOT: warning: 'foo()' is deprecated
 // CHECK-WAE-SUPERGROUP: error: 'foo()' is deprecated
 // CHECK-WAE-SUPERGROUP-NOT: warning: 'foo()' is deprecated
-// CHECK-WAE-DIAGID: error: 'foo()' is deprecated
-// CHECK-WAE-DIAGID-NOT: warning: 'foo()' is deprecated
 // CHECK-WAE-ALL-NWAE-ALL: warning: 'foo()' is deprecated
 // CHECK-WAE-ALL-NWAE-ALL-NOT: error: 'foo()' is deprecated
 // CHECK-WAE-ALL-NWAE-GROUP: warning: 'foo()' is deprecated
 // CHECK-WAE-ALL-NWAE-GROUP-NOT: error: 'foo()' is deprecated
 // CHECK-WAE-ALL-NWAE-SUPERGROUP: warning: 'foo()' is deprecated
 // CHECK-WAE-ALL-NWAE-SUPERGROUP-NOT: error: 'foo()' is deprecated
-// CHECK-WAE-ALL-NWAE-DIAGID: warning: 'foo()' is deprecated
-// CHECK-WAE-ALL-NWAE-DIAGID-NOT: error: 'foo()' is deprecated
 // CHECK-WAE-SUPERGROUP-NWAE-GROUP: warning: 'foo()' is deprecated
 // CHECK-WAE-SUPERGROUP-NWAE-GROUP-NOT: error: 'foo()' is deprecated
-// CHECK-WAE-GROUP-NWAE-DIAGID: warning: 'foo()' is deprecated
-// CHECK-WAE-GROUP-NWAE-DIAGID-NOT: error: 'foo()' is deprecated
 foo()
 
 
@@ -48,18 +39,12 @@ foo()
 // CHECK-WAE-GROUP-NOT: warning: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-SUPERGROUP: error: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-SUPERGROUP-NOT: warning: 'bar()' is deprecated: renamed to 'bar2'
-// CHECK-WAE-DIAGID: error: 'bar()' is deprecated: renamed to 'bar2'
-// CHECK-WAE-DIAGID-NOT: warning: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-ALL-NWAE-ALL: warning: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-ALL-NWAE-ALL-NOT: error: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-ALL-NWAE-GROUP: warning: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-ALL-NWAE-GROUP-NOT: error: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-ALL-NWAE-SUPERGROUP: warning: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-ALL-NWAE-SUPERGROUP-NOT: error: 'bar()' is deprecated: renamed to 'bar2'
-// CHECK-WAE-ALL-NWAE-DIAGID: warning: 'bar()' is deprecated: renamed to 'bar2'
-// CHECK-WAE-ALL-NWAE-DIAGID-NOT: error: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-SUPERGROUP-NWAE-GROUP: warning: 'bar()' is deprecated: renamed to 'bar2'
 // CHECK-WAE-SUPERGROUP-NWAE-GROUP-NOT: error: 'bar()' is deprecated: renamed to 'bar2'
-// CHECK-WAE-GROUP-NWAE-DIAGID: error: 'bar()' is deprecated: renamed to 'bar2'
-// CHECK-WAE-GROUP-NWAE-DIAGID-NOT: warning: 'bar()' is deprecated: renamed to 'bar2'
 bar()