fix(cli): avoid Windows ERROR macro collision

Author: GaspardKirira

include/vix/cli/Style.hpp

@@ -25,7 +25,8 @@ namespace vix::cli::style
   inline constexpr const char *RESET = "\033[0m";
   inline constexpr const char *BOLD = "\033[1m";
   inline constexpr const char *UNDERLINE = "\033[4m";
-  inline constexpr const char *ERROR = "\033[1;91m";
+  // Do not name this ERROR: Windows headers define ERROR as a macro.
+  inline constexpr const char *ERROR_TEXT = "\033[1;91m";
   inline constexpr const char *WARNING = "\033[1;93m";
   inline constexpr const char *SUCCESS = "\033[1;92m";
   inline constexpr const char *ACCENT = "\033[1;96m";
@@ -37,7 +38,7 @@ namespace vix::cli::style
 
   // Compatibility aliases for existing callers.  New diagnostic code should
   // prefer the semantic names above.
-  inline constexpr const char *RED = ERROR;
+  inline constexpr const char *RED = ERROR_TEXT;
   inline constexpr const char *GREEN = SUCCESS;
   inline constexpr const char *YELLOW = WARNING;
   inline constexpr const char *CYAN = ACCENT;
@@ -47,7 +48,7 @@ namespace vix::cli::style
 
   inline void error(const std::string &msg)
   {
-    std::cerr << PAD << ERROR << "✖ " << msg << RESET << "\n";
+    std::cerr << PAD << ERROR_TEXT << "✖ " << msg << RESET << "\n";
   }
 
   inline void success(const std::string &msg)

include/vix/cli/util/Ui.hpp

@@ -67,7 +67,7 @@ namespace vix::cli::util
 
   inline void err_line(std::ostream &os, std::string_view msg)
   {
-    os << "  " << ERROR << "✖" << RESET << " " << msg << "\n";
+    os << "  " << ERROR_TEXT << "✖" << RESET << " " << msg << "\n";
   }
 
   inline std::string dim(std::string_view s)

src/build/BuildStyle.cpp

@@ -54,7 +54,7 @@ namespace vix::cli::build
     const char *duration_color(long long milliseconds) noexcept
     {
       if (milliseconds >= 10000)
-        return style::ERROR;
+        return style::ERROR_TEXT;
       if (milliseconds >= 3000)
         return style::WARNING;
       return style::SUCCESS;
@@ -107,7 +107,7 @@ namespace vix::cli::build
     static std::string label_color(const std::string &label)
     {
       if (label == "error:")
-        return style::ERROR;
+        return style::ERROR_TEXT;
 
       if (label == "hint:")
         return style::WARNING;
@@ -410,7 +410,7 @@ namespace vix::cli::build
     case BuildMessageKind::Warning:
       return colorize(style::WARNING, "!");
     case BuildMessageKind::Error:
-      return colorize(style::ERROR, "✖");
+      return colorize(style::ERROR_TEXT, "✖");
     default:
       return "•";
     }
@@ -534,7 +534,7 @@ namespace vix::cli::build
             : diagnostic.title;
 
     out << "  "
-        << style::ERROR
+        << style::ERROR_TEXT
         << style::BOLD
         << "✖ "
         << title
@@ -581,7 +581,7 @@ namespace vix::cli::build
           if (!pointer.empty())
           {
             out << "      | "
-                << colorize(style::ERROR, pointer)
+                << colorize(style::ERROR_TEXT, pointer)
                 << "\n";
           }
         }
@@ -738,7 +738,7 @@ namespace vix::cli::build
         << (static_cast<double>(milliseconds) / 1000.0);
 
     out << "  "
-        << colorize(style::ERROR, "✖")
+        << colorize(style::ERROR_TEXT, "✖")
         << " "
         << message
         << " after "

src/errors/CodeFrame.cpp

@@ -270,9 +270,9 @@ namespace vix::cli::errors
           caret,
           opt.maxLineWidth,
           prefixPrint,
-          ERROR,
+          ERROR_TEXT,
           CODE,
-          ERROR,
+          ERROR_TEXT,
           RESET,
           caretPrefix);
     }

tests/CMakeLists.txt

@@ -54,6 +54,14 @@ target_include_directories(vix_cli_code_frame_style_tests PRIVATE
 )
 add_test(NAME vix_cli_code_frame_style_tests COMMAND vix_cli_code_frame_style_tests)
 
+add_executable(vix_cli_style_windows_macro_compile_test StyleWindowsMacroCompileTest.cpp)
+target_include_directories(vix_cli_style_windows_macro_compile_test PRIVATE
+  ${CMAKE_CURRENT_SOURCE_DIR}/../include
+)
+add_test(NAME vix_cli_style_windows_macro_compile_test
+  COMMAND vix_cli_style_windows_macro_compile_test
+)
+
 add_executable(vix_cli_clang_gcc_parser_tests
   ClangGccParserTests.cpp
   ../src/errors/ClangGccParser.cpp

tests/StyleWindowsMacroCompileTest.cpp

@@ -0,0 +1,10 @@
+// Windows headers define ERROR as an object-like macro.  Keep this simulation
+// platform-neutral so the public style header is checked on every platform.
+#define ERROR 0
+#include <vix/cli/Style.hpp>
+
+int main()
+{
+  static_assert(vix::cli::style::ERROR_TEXT[0] == '\033');
+  return 0;
+}