[Support] Move syntax highlighting into support

[JDevlieghere]

Summary

Move the DWARF syntax highlighting into support. This has several
advantages, among which the facts that this makes the WithColor RAII
wrapper available outside libDebugInfo. Furthermore, several projects
all have their own code for handling colored output. This provides a
place to centralize it and guarantees a consistent experience.

[davide]

Makes sense to me, can you do the formatting separately?

llvm/include/llvm/Support/SyntaxHighlighting.h

32–33

unrelated formatting change?

llvm/lib/Support/SyntaxHighlighting.cpp

32–58

these formatting changes are unrelated I assume? If so, can you split?

[davide]

Marking as requested changes to get off of my queue. You can commit the formatting changes without review, then update this patch (I'll take another look).

[zturner]

This would be a good chance to change the name of SyntaxHighlighting.h to WithColor.h and similarly for the cpp. Thoughts?

[JDevlieghere]

In D44215#1030164, @davide wrote:

Makes sense to me, can you do the formatting separately?

My motivation is that I'm touching the lines anyway, so I might as well do it now.

[dblaikie]

llvm/lib/Support/SyntaxHighlighting.cpp

32

Any interest in fixing this enum (Address/String/Tag/Attribute) to either have a prefix (HC_) or use an enum class (HighlightColor::Address, etc) in a follow-up change?

I think I wrote some code the other day where I thought I was using a variable named "Address" (wihch I'd forgotten to actually declare/initialize) but was actually using this enum constant...

[JDevlieghere]

Updated the diff with feedback Zachary & Dave. Thanks for the swift reviews!

[davide]

As discussed, given you're moving the whole file anyway, this is fine. Thanks

llvm/include/llvm/Support/SyntaxHighlighting.h

 //===- SyntaxHighlighting.h -------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_LIB_DEBUGINFO_SYNTAXHIGHLIGHTING_H
-#define LLVM_LIB_DEBUGINFO_SYNTAXHIGHLIGHTING_H
+#ifndef LLVM_SUPPORT_SYNTAXHIGHLIGHTING_H
+#define LLVM_SUPPORT_SYNTAXHIGHLIGHTING_H
 
 namespace llvm {
 
 class raw_ostream;
 
-namespace dwarf {
 namespace syntax {
 
 // Symbolic names for various syntax elements.
 enum HighlightColor {
   Address,
   String,
   Tag,
   Attribute,
   Enumerator,
   Macro,
   Error,
   Warning,
   Note
 };
 
-/// An RAII object that temporarily switches an output stream to a
-/// specific color.
+/// An RAII object that temporarily switches an output stream to a specific
+/// color.
 class WithColor {
   raw_ostream &OS;
   /// Determine whether colors should be displayed.
   bool colorsEnabled(raw_ostream &OS);
 
 public:
   /// To be used like this: WithColor(OS, syntax::String) << "text";
   WithColor(raw_ostream &OS, enum HighlightColor Type);
   ~WithColor();
 
   raw_ostream &get() { return OS; }
   operator raw_ostream &() { return OS; }
 };
 
 } // end namespace syntax
-} // end namespace dwarf
-
 } // end namespace llvm
 
 #endif // LLVM_LIB_DEBUGINFO_SYNTAXHIGHLIGHTING_H

llvm/lib/DebugInfo/DWARF/CMakeLists.txt

add_llvm_library(LLVMDebugInfoDWARF
   DWARFDie.cpp
   DWARFExpression.cpp
   DWARFFormValue.cpp
   DWARFGdbIndex.cpp
   DWARFTypeUnit.cpp
   DWARFUnitIndex.cpp
   DWARFUnit.cpp
   DWARFVerifier.cpp
-  SyntaxHighlighting.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${LLVM_MAIN_INCLUDE_DIR}/llvm/DebugInfo/DWARF
   ${LLVM_MAIN_INCLUDE_DIR}/llvm/DebugInfo
   )

llvm/lib/DebugInfo/DWARF/DWARFDebugMacro.cpp

 //===- DWARFDebugMacro.cpp ------------------------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/DebugInfo/DWARF/DWARFDebugMacro.h"
-#include "SyntaxHighlighting.h"
 #include "llvm/BinaryFormat/Dwarf.h"
+#include "llvm/Support/SyntaxHighlighting.h"
 #include "llvm/Support/raw_ostream.h"
 #include <cstdint>
 
 using namespace llvm;
 using namespace dwarf;
 using namespace syntax;
 
 void DWARFDebugMacro::dump(raw_ostream &OS) const {

llvm/lib/DebugInfo/DWARF/DWARFDie.cpp

 //===- DWARFDie.cpp -------------------------------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/DebugInfo/DWARF/DWARFDie.h"
-#include "SyntaxHighlighting.h"
 #include "llvm/ADT/None.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/BinaryFormat/Dwarf.h"
 #include "llvm/DebugInfo/DWARF/DWARFAbbreviationDeclaration.h"
 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
 #include "llvm/DebugInfo/DWARF/DWARFDebugRangeList.h"
 #include "llvm/DebugInfo/DWARF/DWARFExpression.h"
 #include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
 #include "llvm/DebugInfo/DWARF/DWARFUnit.h"
 #include "llvm/Object/ObjectFile.h"
 #include "llvm/Support/DataExtractor.h"
 #include "llvm/Support/Format.h"
 #include "llvm/Support/MathExtras.h"
+#include "llvm/Support/SyntaxHighlighting.h"
 #include "llvm/Support/raw_ostream.h"
 #include <algorithm>
 #include <cassert>
 #include <cinttypes>
 #include <cstdint>
 #include <string>
 #include <utility>
 

llvm/lib/DebugInfo/DWARF/DWARFFormValue.cpp

 //===- DWARFFormValue.cpp -------------------------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
-#include "SyntaxHighlighting.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/None.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/BinaryFormat/Dwarf.h"
 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
 #include "llvm/DebugInfo/DWARF/DWARFRelocMap.h"
 #include "llvm/DebugInfo/DWARF/DWARFUnit.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/Format.h"
+#include "llvm/Support/SyntaxHighlighting.h"
 #include "llvm/Support/raw_ostream.h"
 #include <cinttypes>
 #include <cstdint>
 #include <limits>
 
 using namespace llvm;
 using namespace dwarf;
 using namespace syntax;

llvm/lib/DebugInfo/DWARF/DWARFVerifier.cpp

 //===- DWARFVerifier.cpp --------------------------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#include "SyntaxHighlighting.h"
 #include "llvm/DebugInfo/DWARF/DWARFVerifier.h"
+#include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
 #include "llvm/DebugInfo/DWARF/DWARFCompileUnit.h"
 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
 #include "llvm/DebugInfo/DWARF/DWARFDebugLine.h"
 #include "llvm/DebugInfo/DWARF/DWARFDie.h"
 #include "llvm/DebugInfo/DWARF/DWARFExpression.h"
 #include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
 #include "llvm/DebugInfo/DWARF/DWARFSection.h"
-#include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
 #include "llvm/Support/FormatVariadic.h"
+#include "llvm/Support/SyntaxHighlighting.h"
 #include "llvm/Support/raw_ostream.h"
 #include <map>
 #include <set>
 #include <vector>
 
 using namespace llvm;
 using namespace dwarf;
 using namespace object;

llvm/lib/Support/CMakeLists.txt

add_llvm_library(LLVMSupport
   SourceMgr.cpp
   SpecialCaseList.cpp
   Statistic.cpp
   StringExtras.cpp
   StringMap.cpp
   StringPool.cpp
   StringSaver.cpp
   StringRef.cpp
+  SyntaxHighlighting.cpp
   SystemUtils.cpp
   TarWriter.cpp
   TargetParser.cpp
   ThreadPool.cpp
   Timer.cpp
   ToolOutputFile.cpp
   TrigramIndex.cpp
   Triple.cpp

llvm/lib/Support/SyntaxHighlighting.cpp

 //===- SyntaxHighlighting.cpp ---------------------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#include "SyntaxHighlighting.h"
+#include "llvm/Support/SyntaxHighlighting.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/raw_ostream.h"
 
 using namespace llvm;
-using namespace dwarf;
 using namespace syntax;
 
 static cl::opt<cl::boolOrDefault>
     UseColor("color",
              cl::desc("use colored syntax highlighting (default=autodetect)"),
              cl::init(cl::BOU_UNSET));
 
 bool WithColor::colorsEnabled(raw_ostream &OS) {
   if (UseColor == cl::BOU_UNSET)
     return OS.has_colors();
   return UseColor == cl::BOU_TRUE;
 }
 
 WithColor::WithColor(raw_ostream &OS, enum HighlightColor Type) : OS(OS) {
   // Detect color from terminal type unless the user passed the --color option.
   if (colorsEnabled(OS)) {
     switch (Type) {
-    case Address:    OS.changeColor(raw_ostream::YELLOW);         break;
-    case String:     OS.changeColor(raw_ostream::GREEN);          break;
-    case Tag:        OS.changeColor(raw_ostream::BLUE);           break;
-    case Attribute:  OS.changeColor(raw_ostream::CYAN);           break;
-    case Enumerator: OS.changeColor(raw_ostream::MAGENTA);        break;
-    case Macro:      OS.changeColor(raw_ostream::RED);            break;
-    case Error:      OS.changeColor(raw_ostream::RED, true);      break;
-    case Warning:    OS.changeColor(raw_ostream::MAGENTA, true);  break;
-    case Note:       OS.changeColor(raw_ostream::BLACK, true);    break;
+    case Address:
+      OS.changeColor(raw_ostream::YELLOW);
+      break;
+    case String:
+      OS.changeColor(raw_ostream::GREEN);
+      break;
+    case Tag:
+      OS.changeColor(raw_ostream::BLUE);
+      break;
+    case Attribute:
+      OS.changeColor(raw_ostream::CYAN);
+      break;
+    case Enumerator:
+      OS.changeColor(raw_ostream::MAGENTA);
+      break;
+    case Macro:
+      OS.changeColor(raw_ostream::RED);
+      break;
+    case Error:
+      OS.changeColor(raw_ostream::RED, true);
+      break;
+    case Warning:
+      OS.changeColor(raw_ostream::MAGENTA, true);
+      break;
+    case Note:
+      OS.changeColor(raw_ostream::BLACK, true);
+      break;
     }
   }
 }
 
 WithColor::~WithColor() {
   if (colorsEnabled(OS))
     OS.resetColor();
 }