Better time formatting by using an explicit format
[quassel.git] / src / uisupport / uistyle.h
index 4d98330..fd05974 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2012 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef _UISTYLE_H_
-#define _UISTYLE_H_
+#ifndef UISTYLE_H_
+#define UISTYLE_H_
 
+#include <QDataStream>
+#include <QFontMetricsF>
+#include <QHash>
 #include <QTextCharFormat>
 #include <QTextLayout>
-#include <QUrl>
+#include <QPalette>
+#include <QVector>
 
+#include "bufferinfo.h"
 #include "message.h"
+#include "networkmodel.h"
 #include "settings.h"
 
-class UiStyle {
+class UiStyle : public QObject
+{
+    Q_OBJECT
 
-  public:
-    UiStyle(const QString &settingsKey);
+public:
+    UiStyle(QObject *parent = 0);
     virtual ~UiStyle();
 
-    /** This enumerates the possible formats a text element may have. */
+    typedef QList<QPair<quint16, quint32> > FormatList;
+
+    //! This enumerates the possible formats a text element may have. */
+    /** These formats are ordered on increasing importance, in cases where a given property is specified
+     *  by multiple active formats.
+     *  \NOTE: Do not change/add values here without also adapting the relevant
+     *         methods in this class (in particular mergedFormat())!
+     *         Also, we _do_ rely on certain properties of these values in styleString() and friends!
+     */
     enum FormatType {
-      None, Bold, Italic, Underline, Reverse,                                        // Standard formats
-      PlainMsg, NoticeMsg, ServerMsg, ErrorMsg, JoinMsg, PartMsg, QuitMsg, KickMsg,  // Internal message formats
-      RenameMsg, ModeMsg, ActionMsg,                                                 // ...cnt'd
-      Timestamp, Sender, Nick, Hostmask, ChannelName, ModeFlags, Url,                // individual elements
-      FgCol00, FgCol01, FgCol02, FgCol03, FgCol04, FgCol05, FgCol06, FgCol07,        // Color codes
-      FgCol08, FgCol09, FgCol10, FgCol11, FgCol12, FgCol13, FgCol14, FgCol15,
-      BgCol00, BgCol01, BgCol02, BgCol03, BgCol04, BgCol05, BgCol06, BgCol07,
-      BgCol08, BgCol09, BgCol10, BgCol11, BgCol12, BgCol13, BgCol14, BgCol15,
-      NumFormatTypes, Invalid   // Do not add anything after this
+        Base            = 0x00000000,
+        Invalid         = 0xffffffff,
+
+        // Message Formats (mutually exclusive!)
+        PlainMsg        = 0x00000001,
+        NoticeMsg       = 0x00000002,
+        ActionMsg       = 0x00000003,
+        NickMsg         = 0x00000004,
+        ModeMsg         = 0x00000005,
+        JoinMsg         = 0x00000006,
+        PartMsg         = 0x00000007,
+        QuitMsg         = 0x00000008,
+        KickMsg         = 0x00000009,
+        KillMsg         = 0x0000000a,
+        ServerMsg       = 0x0000000b,
+        InfoMsg         = 0x0000000c,
+        ErrorMsg        = 0x0000000d,
+        DayChangeMsg    = 0x0000000e,
+        TopicMsg        = 0x0000000f,
+        NetsplitJoinMsg = 0x00000010,
+        NetsplitQuitMsg = 0x00000020,
+        InviteMsg       = 0x00000030,
+
+        // Standard Formats
+        Bold            = 0x00000100,
+        Italic          = 0x00000200,
+        Underline       = 0x00000400,
+        Reverse         = 0x00000800,
+
+        // Individual parts of a message
+        Timestamp       = 0x00001000,
+        Sender          = 0x00002000,
+        Contents        = 0x00004000,
+        Nick            = 0x00008000,
+        Hostmask        = 0x00010000,
+        ChannelName     = 0x00020000,
+        ModeFlags       = 0x00040000,
+
+        // URL is special, we want that to take precedence over the rest...
+        Url             = 0x00080000
+
+                          // mIRC Colors - we assume those to be present only in plain contents
+                          // foreground: 0x0.400000
+                          // background: 0x.0800000
     };
 
-    struct UrlInfo {
-      int start, end;
-      QUrl url;
+    enum MessageLabel {
+        OwnMsg          = 0x00000001,
+        Highlight       = 0x00000002,
+        Selected        = 0x00000004 // must be last!
     };
 
-    struct StyledText {
-      QString text;
-      QList<QTextLayout::FormatRange> formats;
-      QList<UrlInfo> urls;
+    enum ItemFormatType {
+        BufferViewItem    = 0x00000001,
+        NickViewItem      = 0x00000002,
+
+        NetworkItem       = 0x00000010,
+        ChannelBufferItem = 0x00000020,
+        QueryBufferItem   = 0x00000040,
+        IrcUserItem       = 0x00000080,
+        UserCategoryItem  = 0x00000100,
+
+        InactiveBuffer    = 0x00001000,
+        ActiveBuffer      = 0x00002000,
+        UnreadBuffer      = 0x00004000,
+        HighlightedBuffer = 0x00008000,
+        UserAway          = 0x00010000
     };
 
-    StyledText styleString(QString);
+    enum ColorRole {
+        MarkerLine,
+        NumRoles // must be last!
+    };
 
-    void setFormat(FormatType, QTextCharFormat, Settings::Mode mode/* = Settings::Custom*/);
-    QTextCharFormat format(FormatType, Settings::Mode mode = Settings::Custom) const;
+    struct StyledString {
+        QString plainText;
+        FormatList formatList; // starting pos, ftypes
+    };
+
+    class StyledMessage;
+
+    static FormatType formatType(Message::Type msgType);
+    static StyledString styleString(const QString &string, quint32 baseFormat = Base);
+    static QString mircToInternal(const QString &);
+    static inline QString timestampFormatString() { return _timestampFormatString; }
+
+    QTextCharFormat format(quint32 formatType, quint32 messageLabel) const;
+    QFontMetricsF *fontMetrics(quint32 formatType, quint32 messageLabel) const;
+
+    QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, quint32 messageLabel) const;
+
+    inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int)role); }
+    inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int)role] = brush; }
+
+    QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
+    QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
+
+public slots:
+    void reload();
+
+signals:
+    void changed();
+
+protected:
+    void loadStyleSheet();
+    QString loadStyleSheet(const QString &name, bool shouldExist = false);
+
+    QTextCharFormat format(quint64 key) const;
+    QTextCharFormat cachedFormat(quint32 formatType, quint32 messageLabel) const;
+    void setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) const;
+    void mergeFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel) const;
+    void mergeSubElementFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel) const;
+
+    static FormatType formatType(const QString &code);
+    static QString formatCode(FormatType);
+    static void setTimestampFormatString(const QString &format);
+
+    QVariant itemData(int role, const QTextCharFormat &format) const;
+
+private slots:
+    void allowMircColorsChanged(const QVariant &);
+    void showItemViewIconsChanged(const QVariant &);
+
+private:
+    QVector<QBrush> _uiStylePalette;
+    QBrush _markerLineBrush;
+    QHash<quint64, QTextCharFormat> _formats;
+    mutable QHash<quint64, QTextCharFormat> _formatCache;
+    mutable QHash<quint64, QFontMetricsF *> _metricsCache;
+    QHash<quint32, QTextCharFormat> _listItemFormats;
+    static QHash<QString, FormatType> _formatCodes;
+    static QString _timestampFormatString;
+
+    QPixmap _channelJoinedIcon;
+    QPixmap _channelPartedIcon;
+    QPixmap _userOfflineIcon;
+    QPixmap _userOnlineIcon;
+    QPixmap _userAwayIcon;
+    QPixmap _categoryOpIcon;
+    QPixmap _categoryVoiceIcon;
+    int _opIconLimit;
+    int _voiceIconLimit;
+    bool _showNickViewIcons;
+    bool _showBufferViewIcons;
+    bool _allowMircColors;
+};
 
-    FormatType formatType(const QString &code) const;
-    QString formatCode(FormatType) const;
 
-  protected:
+class UiStyle::StyledMessage : public Message
+{
+    Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage)
 
+public:
+    explicit StyledMessage(const Message &message);
 
-  private:
-    QTextCharFormat mergedFormat(QList<FormatType>);
+    QString decoratedTimestamp() const;
+    QString plainSender() const;           //!< Nickname (no decorations) for Plain and Notice, empty else
+    QString decoratedSender() const;
+    const QString &plainContents() const;
 
-    QVector<QTextCharFormat> _defaultFormats;
-    QVector<QTextCharFormat> _customFormats;
-    QHash<QString, FormatType> _formatCodes;
+    const FormatList &contentsFormatList() const;
 
-    QString _settingsKey;
+    quint8 senderHash() const;
 
+protected:
+    void style() const;
+
+private:
+    mutable StyledString _contents;
+    mutable quint8 _senderHash;
 };
 
+
+QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
+QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
+
+Q_DECLARE_METATYPE(UiStyle::FormatList)
+
 #endif