src/uisupport/uistyle.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef UISTYLE_H_
  22 #define UISTYLE_H_
  23
  24 #include <QDataStream>
  25 #include <QFontMetricsF>
  26 #include <QHash>
  27 #include <QTextCharFormat>
  28 #include <QTextLayout>
  29 #include <QPalette>
  30 #include <QVector>
  31
  32 #include "message.h"
  33 #include "settings.h"
  34
  35 class UiStyle {
  36   Q_DECLARE_TR_FUNCTIONS(UiStyle)
  37
  38 public:
  39   UiStyle();
  40   virtual ~UiStyle();
  41
  42   typedef QList<QPair<quint16, quint32> > FormatList;
  43
  44   //! This enumerates the possible formats a text element may have. */
  45   /** These formats are ordered on increasing importance, in cases where a given property is specified
  46    *  by multiple active formats.
  47    *  \NOTE: Do not change/add values here without also adapting the relevant
  48    *         methods in this class (in particular mergedFormat())!
  49    *         Also, we _do_ rely on certain properties of these values in styleString() and friends!
  50    */
  51   enum FormatType {
  52     None            = 0x00000000,
  53     Invalid         = 0x11111111,
  54
  55     // Message Formats (mutually exclusive!)
  56     PlainMsg        = 0x00000001,
  57     NoticeMsg       = 0x00000002,
  58     ActionMsg       = 0x00000003,
  59     NickMsg         = 0x00000004,
  60     ModeMsg         = 0x00000005,
  61     JoinMsg         = 0x00000006,
  62     PartMsg         = 0x00000007,
  63     QuitMsg         = 0x00000008,
  64     KickMsg         = 0x00000009,
  65     KillMsg         = 0x0000000a,
  66     ServerMsg       = 0x0000000b,
  67     InfoMsg         = 0x0000000c,
  68     ErrorMsg        = 0x0000000d,
  69     DayChangeMsg    = 0x0000000e,
  70
  71     // Standard Formats
  72     Bold            = 0x00000010,
  73     Italic          = 0x00000020,
  74     Underline       = 0x00000040,
  75     Reverse         = 0x00000080,
  76
  77     // Individual parts of a message
  78     Timestamp       = 0x00000100,
  79     Sender          = 0x00000200,
  80     Contents        = 0x00000400,
  81     Nick            = 0x00000800,
  82     Hostmask        = 0x00001000,
  83     ChannelName     = 0x00002000,
  84     ModeFlags       = 0x00004000,
  85
  86     // URL is special, we want that to take precedence over the rest...
  87     Url             = 0x00080000
  88
  89     // mIRC Colors - we assume those to be present only in plain contents
  90     // foreground: 0x0.400000
  91     // background: 0x.0800000
  92   };
  93
  94   enum MessageLabel {
  95     OwnMsg          = 0x00000001,
  96     Highlight       = 0x00000002
  97   };
  98
  99   struct StyledString {
 100     QString plainText;
 101     FormatList formatList;  // starting pos, ftypes
 102   };
 103
 104   class StyledMessage;
 105
 106   void loadStyleSheet();
 107
 108   static FormatType formatType(Message::Type msgType);
 109   static StyledString styleString(const QString &string, quint32 baseFormat = None);
 110   static QString mircToInternal(const QString &);
 111
 112   QTextCharFormat format(quint32 formatType, quint32 messageLabel = 0);
 113   QFontMetricsF *fontMetrics(quint32 formatType, quint32 messageLabel = 0);
 114
 115   inline QFont defaultFont() const { return _defaultFont; }
 116
 117   QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, quint32 messageLabel = 0);
 118
 119 protected:
 120   QString loadStyleSheet(const QString &name, bool shouldExist = false);
 121
 122   QTextCharFormat cachedFormat(quint64 key) const;
 123   QTextCharFormat cachedFormat(quint32 formatType, quint32 messageLabel = 0) const;
 124   void setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel = 0);
 125   void mergeSubElementFormat(QTextCharFormat &format, quint32 formatType, quint32 messageLabel = 0);
 126
 127   static FormatType formatType(const QString &code);
 128   static QString formatCode(FormatType);
 129
 130 private:
 131   QFont _defaultFont;
 132   QHash<quint64, QTextCharFormat> _formatCache;
 133   QHash<quint64, QFontMetricsF *> _metricsCache;
 134   static QHash<QString, FormatType> _formatCodes;
 135 };
 136
 137 class UiStyle::StyledMessage : public Message {
 138 public:
 139   explicit StyledMessage(const Message &message);
 140
 141   QString decoratedTimestamp() const;
 142   QString plainSender() const;             //!< Nickname (no decorations) for Plain and Notice, empty else
 143   QString decoratedSender() const;
 144   const QString &plainContents() const;
 145
 146   inline FormatType timestampFormat() const { return UiStyle::Timestamp; }
 147   FormatType senderFormat() const;
 148   const FormatList &contentsFormatList() const;
 149
 150   quint8 senderHash() const;
 151
 152 protected:
 153   //! Styling is only needed for calls to plainContents() and contentsFormatList()
 154   void style() const;
 155
 156
 157 private:
 158   mutable StyledString _contents;
 159   mutable quint8 _senderHash;
 160 };
 161
 162 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
 163 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
 164
 165 Q_DECLARE_METATYPE(UiStyle::FormatList)
 166
 167 #endif