common: Avoid repeated and unnecessary creation/destruction of highlighter attributes.

1 files changed, 242 insertions, 0 deletions

diff --git a/common/highlight.cpp b/common/highlight.cpp
new file mode 100644
index 00000000..cc973d43
--- /dev/null
+++ b/common/highlight.cpp
@@ -0,0 +1,242 @@
+/**************************************************************************
+ *
+ * Copyright 2010 VMware, Inc.
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ **************************************************************************/
+
+/*
+ * Helpers for coloring output.
+ */
+
+
+#ifdef _WIN32
+#include <windows.h>
+
+#ifndef COMMON_LVB_LEADING_BYTE
+#define COMMON_LVB_LEADING_BYTE    0x0100
+#endif
+
+#ifndef COMMON_LVB_TRAILING_BYTE
+#define COMMON_LVB_TRAILING_BYTE   0x0200
+#endif
+
+#ifndef COMMON_LVB_GRID_HORIZONTAL
+#define COMMON_LVB_GRID_HORIZONTAL 0x0400
+#endif
+
+#ifndef COMMON_LVB_GRID_LVERTICAL
+#define COMMON_LVB_GRID_LVERTICAL  0x0800
+#endif
+
+#ifndef COMMON_LVB_GRID_RVERTICAL
+#define COMMON_LVB_GRID_RVERTICAL  0x1000
+#endif
+
+#ifndef COMMON_LVB_REVERSE_VIDEO
+#define COMMON_LVB_REVERSE_VIDEO   0x4000
+#endif
+
+#ifndef COMMON_LVB_UNDERSCORE
+#define COMMON_LVB_UNDERSCORE      0x8000
+#endif
+
+#endif /* _WIN32 */
+
+
+#include "highlight.hpp"
+
+
+namespace highlight {
+
+
+class PlainAttribute : public Attribute {
+public:
+    virtual void apply(std::ostream &) const {}
+};
+
+static const PlainAttribute plainAttribute;
+
+
+class PlainHighlighter : public Highlighter {
+public:
+    virtual const Attribute & normal(void) const { return plainAttribute; }
+    virtual const Attribute & bold(void) const { return plainAttribute; }
+    virtual const Attribute & italic(void) const { return plainAttribute; }
+    virtual const Attribute & strike(void) const { return plainAttribute; }
+    virtual const Attribute & color(Color) const { return plainAttribute; }
+};
+
+static const PlainHighlighter plainHighlighter;
+
+
+class AnsiAttribute : public Attribute {
+protected:
+    const char *escape;
+
+public:
+    AnsiAttribute(const char *_escape) :
+        escape(_escape)
+    {}
+
+    void apply(std::ostream& os) const {
+        os << "\33[" << escape;
+    }
+};
+
+static const AnsiAttribute ansiNormal("0m");
+static const AnsiAttribute ansiBold("1m");
+static const AnsiAttribute ansiItalic("3m");
+static const AnsiAttribute ansiStrike("9m");
+static const AnsiAttribute ansiRed("31m");
+static const AnsiAttribute ansiGreen("32m");
+static const AnsiAttribute ansiBlue("34m");
+
+
+/**
+ * Highlighter for plain-text files which outputs ANSI escape codes. See
+ * http://en.wikipedia.org/wiki/ANSI_escape_code for more information
+ * concerning ANSI escape codes.
+ */
+class AnsiHighlighter : public Highlighter {
+public:
+    virtual const Attribute & normal(void) const { return ansiNormal; }
+    virtual const Attribute & bold(void) const { return ansiBold; }
+    virtual const Attribute & italic(void) const {
+        /* Italic is not widely supported, or worse, implemented with a reverse */
+        if (0)
+            return ansiItalic;
+        else
+            return plainAttribute;
+    }
+    virtual const Attribute & strike(void) const { return ansiStrike; }
+    virtual const Attribute & color(Color c) const {
+        switch (c) {
+        case RED:
+            return ansiRed;
+        case GREEN:
+            return ansiGreen;
+        case BLUE:
+            return ansiBlue;
+        default:
+            return plainAttribute;
+        }
+    }
+};
+
+static const AnsiHighlighter ansiHighlighter;
+
+
+#ifdef _WIN32
+
+
+class WindowsAttribute : public Attribute {
+protected:
+    WORD wAttributes;
+
+public:
+    WindowsAttribute(WORD _wAttributes) :
+        wAttributes(_wAttributes)
+    {}
+
+    void apply(std::ostream& os) const {
+        DWORD nStdHandleOutput;
+        if (&os == &std::cout) {
+            nStdHandleOutput = STD_OUTPUT_HANDLE;
+        } else if (&os == &std::cerr) {
+            nStdHandleOutput = STD_ERROR_HANDLE;
+        } else {
+            return;
+        }
+        HANDLE hConsoleOutput = GetStdHandle(nStdHandleOutput);
+        if (hConsoleOutput == INVALID_HANDLE_VALUE) {
+            return;
+        }
+
+        SetConsoleTextAttribute(hConsoleOutput, wAttributes);
+    }
+};
+
+static const WindowsAttribute winNormal(FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED);
+static const WindowsAttribute winBold(FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY);
+static const WindowsAttribute winItalic(FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED);
+static const WindowsAttribute winStrike(COMMON_LVB_REVERSE_VIDEO | FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED);
+static const WindowsAttribute winRed(FOREGROUND_RED | FOREGROUND_INTENSITY);
+static const WindowsAttribute winGreen(FOREGROUND_GREEN | FOREGROUND_INTENSITY);
+static const WindowsAttribute winBlue(FOREGROUND_BLUE | FOREGROUND_INTENSITY);
+
+
+/**
+ * Highlighter for the Windows Console.
+ */
+class WindowsHighlighter : public Highlighter {
+public:
+    virtual const Attribute & normal(void) const { return winNormal; }
+    virtual const Attribute & bold(void) const { return winBold; }
+    virtual const Attribute & italic(void) const { return winItalic; }
+    virtual const Attribute & strike(void) const { return winStrike; }
+    virtual const Attribute & color(Color c) const {
+        switch (c) {
+        case RED:
+            return winRed;
+        case GREEN:
+            return winGreen;
+        case BLUE:
+            return winBlue;
+        default:
+            return plainAttribute;
+        }
+    }
+};
+
+static const WindowsHighlighter windowsHighlighter;
+
+
+#endif /* _WIN32 */
+
+
+const Highlighter &
+defaultHighlighter(bool color) {
+    if (color) {
+#ifdef _WIN32
+        // http://wiki.winehq.org/DeveloperFaq#detect-wine
+        static HMODULE hNtDll = NULL;
+        static bool bWine = false;
+        if (!hNtDll) {
+            hNtDll = LoadLibraryA("ntdll");
+            if (hNtDll) {
+                bWine = GetProcAddress(hNtDll, "wine_get_version") != NULL;
+            }
+        }
+        if (bWine) {
+            return ansiHighlighter;
+        }
+        return windowsHighlighter;
+#else
+        return ansiHighlighter;
+#endif
+    } else {
+        return plainHighlighter;
+    }
+}
+
+
+} /* namespace highlight */