src/xmlpatterns/api/qcoloroutput_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the XMLPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_ColorOutput_h
  53 #define Patternist_ColorOutput_h
  54
  55 #include <QtCore/QtGlobal>
  56 #include <QtCore/QHash>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     class ColorOutputPrivate;
  65
  66     class ColorOutput
  67     {
  68         enum
  69         {
  70             ForegroundShift = 10,
  71             BackgroundShift = 20,
  72             SpecialShift    = 20,
  73             ForegroundMask  = ((1 << ForegroundShift) - 1) << ForegroundShift,
  74             BackgroundMask  = ((1 << BackgroundShift) - 1) << BackgroundShift
  75         };
  76
  77     public:
  78         enum ColorCodeComponent
  79         {
  80             BlackForeground         = 1 << ForegroundShift,
  81             BlueForeground          = 2 << ForegroundShift,
  82             GreenForeground         = 3 << ForegroundShift,
  83             CyanForeground          = 4 << ForegroundShift,
  84             RedForeground           = 5 << ForegroundShift,
  85             PurpleForeground        = 6 << ForegroundShift,
  86             BrownForeground         = 7 << ForegroundShift,
  87             LightGrayForeground     = 8 << ForegroundShift,
  88             DarkGrayForeground      = 9 << ForegroundShift,
  89             LightBlueForeground     = 10 << ForegroundShift,
  90             LightGreenForeground    = 11 << ForegroundShift,
  91             LightCyanForeground     = 12 << ForegroundShift,
  92             LightRedForeground      = 13 << ForegroundShift,
  93             LightPurpleForeground   = 14 << ForegroundShift,
  94             YellowForeground        = 15 << ForegroundShift,
  95             WhiteForeground         = 16 << ForegroundShift,
  96
  97             BlackBackground         = 1 << BackgroundShift,
  98             BlueBackground          = 2 << BackgroundShift,
  99             GreenBackground         = 3 << BackgroundShift,
 100             CyanBackground          = 4 << BackgroundShift,
 101             RedBackground           = 5 << BackgroundShift,
 102             PurpleBackground        = 6 << BackgroundShift,
 103             BrownBackground         = 7 << BackgroundShift,
 104             DefaultColor            = 1 << SpecialShift
 105         };
 106
 107         typedef QFlags<ColorCodeComponent> ColorCode;
 108         typedef QHash<int, ColorCode> ColorMapping;
 109
 110         ColorOutput();
 111         ~ColorOutput();
 112
 113         void setColorMapping(const ColorMapping &cMapping);
 114         ColorMapping colorMapping() const;
 115         void insertMapping(int colorID, const ColorCode colorCode);
 116
 117         void writeUncolored(const QString &message);
 118         void write(const QString &message, int color = -1);
 119         QString colorify(const QString &message, int color = -1) const;
 120
 121     private:
 122         ColorOutputPrivate *d;
 123         Q_DISABLE_COPY(ColorOutput)
 124     };
 125 }
 126
 127 Q_DECLARE_OPERATORS_FOR_FLAGS(QPatternist::ColorOutput::ColorCode)
 128
 129 QT_END_NAMESPACE
 130
 131 QT_END_HEADER
 132
 133 #endif