Merge pull request swiftlang#76814 from gottesmm/pr-6413df7cbed605312aee2525fa8079b8a161d897

Fix syntax highlighting by changing how we include COMPATIBILITY_OVERRIDE_INCLUDE_PATH

Author: gottesmm

stdlib/public/CompatibilityOverride/CompatibilityOverride.cpp

@@ -43,7 +43,7 @@ struct OverrideSection {
 
 #define OVERRIDE(name, ret, attrs, ccAttrs, namespace, typedArgs, namedArgs) \
   Override_ ## name name;
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "CompatibilityOverrideIncludePath.h"
 };
 
 static_assert(std::is_pod<OverrideSection>::value,
@@ -98,6 +98,6 @@ static OverrideSection *getOverrideSectionPtr() {
     Section->name;                                           \
   }
 
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "CompatibilityOverrideIncludePath.h"
 
 #endif // #ifdef SWIFT_STDLIB_SUPPORT_BACK_DEPLOYMENT

stdlib/public/CompatibilityOverride/CompatibilityOverride.h

@@ -120,9 +120,9 @@ namespace swift {
 #define COMPATIBILITY_PAREN_PARAMS(...) (__VA_ARGS__)
 #define COMPATIBILITY_PAREN_COMPATIBILITY_PAREN2 ()
 
-// Include path computation. Code that includes this file can write
-// `#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH` to include the appropriate
-// .def file for the current library.
+// Include path computation. Code that includes this file can write `#include
+// "..CompatibilityOverride/CompatibilityOverrideIncludePath.h"` to include the
+// appropriate .def file for the current library.
 #define COMPATIBILITY_OVERRIDE_INCLUDE_PATH_swiftRuntime                       \
   "../CompatibilityOverride/CompatibilityOverrideRuntime.def"
 #define COMPATIBILITY_OVERRIDE_INCLUDE_PATH_swift_Concurrency                  \
@@ -173,18 +173,18 @@ namespace swift {
 // Create typedefs for function pointers to call the original implementation.
 #define OVERRIDE(name, ret, attrs, ccAttrs, namespace, typedArgs, namedArgs)   \
   ccAttrs typedef ret(*Original_##name) COMPATIBILITY_PAREN(typedArgs);
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "CompatibilityOverrideIncludePath.h"
 
 // Create typedefs for override function pointers.
 #define OVERRIDE(name, ret, attrs, ccAttrs, namespace, typedArgs, namedArgs)   \
   ccAttrs typedef ret (*Override_##name)(COMPATIBILITY_UNPAREN_WITH_COMMA(     \
       typedArgs) Original_##name originalImpl);
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "CompatibilityOverrideIncludePath.h"
 
 // Create declarations for getOverride functions.
-#define OVERRIDE(name, ret, attrs, ccAttrs, namespace, typedArgs, namedArgs) \
-  Override_ ## name getOverride_ ## name();
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#define OVERRIDE(name, ret, attrs, ccAttrs, namespace, typedArgs, namedArgs)   \
+  Override_##name getOverride_##name();
+#include "CompatibilityOverrideIncludePath.h"
 
 /// Used to define an override point. The override point #defines the appropriate
 /// OVERRIDE macro from CompatibilityOverride.def to this macro, then includes

stdlib/public/CompatibilityOverride/CompatibilityOverrideIncludePath.h

@@ -0,0 +1,24 @@
+//===--- CompatibilityOverrideIncludePath.h -------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file This file should be included instead of including
+/// COMPATIBILITY_OVERRIDE_INCLUDE_PATH directly to ensure that syntax
+/// highlighting in certain errors is not broken. It is assumed that
+/// CompatibilityOverride.h is already included.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef COMPATIBILITY_OVERRIDE_H
+#error "Must define COMPATIBILITY_OVERRIDE_H before including this file"
+#endif
+
+#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH

stdlib/public/Concurrency/Actor.cpp

@@ -2310,8 +2310,7 @@ void swift::swift_executor_escalate(SerialExecutorRef executor, AsyncTask *task,
 }
 
 #define OVERRIDE_ACTOR COMPATIBILITY_OVERRIDE
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
-
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"
 
 /*****************************************************************************/
 /***************************** DISTRIBUTED ACTOR *****************************/

stdlib/public/Concurrency/AsyncLet.cpp

@@ -577,4 +577,4 @@ void AsyncLet::setDidAllocateFromParentTask(bool value) {
 // =============================================================================
 
 #define OVERRIDE_ASYNC_LET COMPATIBILITY_OVERRIDE
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"

stdlib/public/Concurrency/GlobalExecutor.cpp

@@ -233,4 +233,4 @@ bool SerialExecutorRef::isMainExecutor() const {
 }
 
 #define OVERRIDE_GLOBAL_EXECUTOR COMPATIBILITY_OVERRIDE
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"

stdlib/public/Concurrency/Task.cpp

@@ -1832,4 +1832,4 @@ static void swift_task_startOnMainActorImpl(AsyncTask* task) {
   }
 #endif // #else SWIFT_STDLIB_SUPPORT_BACK_DEPLOYMENT
 
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"

stdlib/public/Concurrency/TaskGroup.cpp

@@ -2084,4 +2084,4 @@ static bool swift_taskGroup_addPendingImpl(TaskGroup *_group, bool unconditional
 }
 
 #define OVERRIDE_TASK_GROUP COMPATIBILITY_OVERRIDE
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"

stdlib/public/Concurrency/TaskLocal.cpp

@@ -536,4 +536,4 @@ void TaskLocal::Storage::copyToOnlyOnlyFromCurrentGroup(AsyncTask *target) {
 }
 
 #define OVERRIDE_TASK_LOCAL COMPATIBILITY_OVERRIDE
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"

stdlib/public/Concurrency/TaskStatus.cpp

@@ -1118,4 +1118,4 @@ void TaskDependencyStatusRecord::performEscalationAction(JobPriority newPriority
 }
 
 #define OVERRIDE_TASK_STATUS COMPATIBILITY_OVERRIDE
-#include COMPATIBILITY_OVERRIDE_INCLUDE_PATH
+#include "../CompatibilityOverride/CompatibilityOverrideIncludePath.h"