git.cworth.org Git - apitrace/blob - common/formatter.hpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2010 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26 /*
  27  * Helpers for coloring output.
  28  */
  29
  30 #ifndef _FORMATTER_HPP_
  31 #define _FORMATTER_HPP_
  32
  33
  34 #include <iostream>
  35
  36
  37 namespace formatter {
  38
  39 /*
  40  * See also http://bytes.com/topic/c/answers/63822-design-question-little-c-header-colorizing-text-linux-comments-ideas
  41  */
  42
  43 class Attribute {
  44 public:
  45     virtual ~Attribute() {}
  46
  47     virtual void apply(std::ostream &) const {}
  48 };
  49
  50
  51 enum Color {
  52     RED,
  53     GREEN,
  54     BLUE,
  55 };
  56
  57
  58 class Formatter {
  59 public:
  60     virtual ~Formatter() {}
  61
  62     virtual Attribute *normal(void) const { return new Attribute; }
  63     virtual Attribute *bold(void) const { return new Attribute; }
  64     virtual Attribute *italic(void) const { return new Attribute; }
  65     virtual Attribute *strike(void) const { return new Attribute; }
  66     virtual Attribute *color(Color) const { return new Attribute; }
  67 };
  68
  69
  70 class AnsiAttribute : public Attribute {
  71 protected:
  72     const char *escape;
  73 public:
  74     AnsiAttribute(const char *_escape) : escape(_escape) {}
  75     void apply(std::ostream& os) const {
  76         os << "\33[" << escape;
  77     }
  78 };
  79
  80
  81 /**
  82  * Formatter for plain-text files which outputs ANSI escape codes. See
  83  * http://en.wikipedia.org/wiki/ANSI_escape_code for more information
  84  * concerning ANSI escape codes.
  85  */
  86 class AnsiFormatter : public Formatter {
  87 protected:
  88 public:
  89     virtual Attribute *normal(void) const { return new AnsiAttribute("0m"); }
  90     virtual Attribute *bold(void) const { return new AnsiAttribute("1m"); }
  91     virtual Attribute *italic(void) const { return new AnsiAttribute("3m"); }
  92     virtual Attribute *strike(void) const { return new AnsiAttribute("9m"); }
  93     virtual Attribute *color(Color c) const {
  94         static const char *color_escapes[] = {
  95             "31m", /* red */
  96             "32m", /* green */
  97             "34m", /* blue */
  98         };
  99         return new AnsiAttribute(color_escapes[c]);
 100     }
 101 };
 102
 103
 104 inline std::ostream& operator<<(std::ostream& os, const Attribute *attr) {
 105     attr->apply(os);
 106     return os;
 107 }
 108
 109
 110 #ifdef _WIN32
 111
 112 #include <windows.h>
 113
 114 class WindowsAttribute : public Attribute {
 115 protected:
 116     WORD wAttributes;
 117 public:
 118     WindowsAttribute(WORD _wAttributes) : wAttributes(_wAttributes) {}
 119     void apply(std::ostream& os) const {
 120         DWORD nStdHandleOutput;
 121         if (os == std::cout) {
 122             nStdHandleOutput = STD_OUTPUT_HANDLE;
 123         } else if (os == std::cerr) {
 124             nStdHandleOutput = STD_ERROR_HANDLE;
 125         } else {
 126             return;
 127         }
 128         HANDLE hConsoleOutput = GetStdHandle(nStdHandleOutput);
 129         if (hConsoleOutput == INVALID_HANDLE_VALUE) {
 130             return;
 131         }
 132
 133         SetConsoleTextAttribute(hConsoleOutput, wAttributes);
 134     }
 135 };
 136
 137
 138 /**
 139  * Formatter for the Windows Console.
 140  */
 141 class WindowsFormatter : public Formatter {
 142 protected:
 143 public:
 144     virtual Attribute *normal(void) const { return new WindowsAttribute(FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED); }
 145     virtual Attribute *bold(void) const { return new WindowsAttribute(FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_INTENSITY); }
 146     virtual Attribute *italic(void) const { return new WindowsAttribute(FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED); }
 147     virtual Attribute *strike(void) const { return new WindowsAttribute(COMMON_LVB_REVERSE_VIDEO | FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED); }
 148     virtual Attribute *color(Color c) const {
 149         static const WORD color_escapes[] = {
 150             FOREGROUND_RED | FOREGROUND_INTENSITY,
 151             FOREGROUND_GREEN | FOREGROUND_INTENSITY,
 152             FOREGROUND_BLUE | FOREGROUND_INTENSITY,
 153         };
 154         return new WindowsAttribute(color_escapes[c]);
 155     }
 156 };
 157
 158 #endif
 159
 160
 161 inline Formatter *defaultFormatter(bool color = true) {
 162     if (color) {
 163 #ifdef _WIN32
 164         return new WindowsFormatter;
 165 #else
 166         return new AnsiFormatter;
 167 #endif
 168     } else {
 169         return new Formatter;
 170     }
 171 }
 172
 173
 174 } /* namespace formatter */
 175
 176
 177 #endif /* _FORMATTER_HPP_ */