Rework mergedFormats() to handle pre-set formats
[quassel.git] / src / uisupport / uistyle.h
index a80af5e..38d43f0 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _UISTYLE_H_
-#define _UISTYLE_H_
+#ifndef UISTYLE_H
+#define UISTYLE_H
 
+#include <QDataStream>
+#include <QFontMetricsF>
 #include <QTextCharFormat>
 #include <QTextLayout>
 #include <QUrl>
 #include "settings.h"
 
 class UiStyle {
+  Q_DECLARE_TR_FUNCTIONS(UiStyle)
+
+public:
+  UiStyle(const QString &settingsKey);
+  virtual ~UiStyle();
+
+  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            = 0x00000000,
+    Invalid         = 0x11111111,
+
+    // Message Formats (mutually exclusive!)
+    PlainMsg        = 0x00000001,
+    NoticeMsg       = 0x00000002,
+    ServerMsg       = 0x00000003,
+    ErrorMsg        = 0x00000004,
+    JoinMsg         = 0x00000005,
+    PartMsg         = 0x00000006,
+    QuitMsg         = 0x00000007,
+    KickMsg         = 0x00000008,
+    RenameMsg       = 0x00000009,
+    ModeMsg         = 0x0000000a,
+    ActionMsg       = 0x0000000b,
+    HighlightMsg    = 0x0000000f,
+
+    // Note: mergedFormat() assumes that 0x10 - 0x80 are *only* used within the message contents,
+    //       e.g. not together with any of 0x0100-0x2000!
+    //       If we happen to find a use case for that, we can see if/how to implement that though.
+
+    // Standard Formats
+    Bold            = 0x00000010,
+    Italic          = 0x00000020,
+    Underline       = 0x00000040,
+    Reverse         = 0x00000080,
+
+    // Individual parts of a message
+    Timestamp       = 0x00000100,
+    Sender          = 0x00000200,
+    Nick            = 0x00000400,
+    Hostmask        = 0x00000800,
+    ChannelName     = 0x00001000,
+    ModeFlags       = 0x00002000,
+
+    // URL is special, we want that to take precedence over the rest...
+    Url             = 0x00100000,
+
+    // mIRC Colors - we assume those to be present only in plain contents
+    FgCol00         = 0x00400000,
+    FgCol01         = 0x01400000,
+    FgCol02         = 0x02400000,
+    FgCol03         = 0x03400000,
+    FgCol04         = 0x04400000,
+    FgCol05         = 0x05400000,
+    FgCol06         = 0x06400000,
+    FgCol07         = 0x07400000,
+    FgCol08         = 0x08400000,
+    FgCol09         = 0x09400000,
+    FgCol10         = 0x0a400000,
+    FgCol11         = 0x0b400000,
+    FgCol12         = 0x0c400000,
+    FgCol13         = 0x0d400000,
+    FgCol14         = 0x0e400000,
+    FgCol15         = 0x0f400000,
+
+    BgCol00         = 0x00800000,
+    BgCol01         = 0x10800000,
+    BgCol02         = 0x20800000,
+    BgCol03         = 0x30800000,
+    BgCol04         = 0x40800000,
+    BgCol05         = 0x50800000,
+    BgCol06         = 0x60800000,
+    BgCol07         = 0x70800000,
+    BgCol08         = 0x80800000,
+    BgCol09         = 0x90800000,
+    BgCol10         = 0xa0800000,
+    BgCol11         = 0xb0800000,
+    BgCol12         = 0xc0800000,
+    BgCol13         = 0xd0800000,
+    BgCol14         = 0xe0800000,
+    BgCol15         = 0xf0800000,
+
+    // Colors used for sender auto coloring
+    // (starting at 01 because 00 is the default Sender format)
+    SenderCol01     = 0x01000200,
+    SenderCol02     = 0x02000200,
+    SenderCol03     = 0x03000200,
+    SenderCol04     = 0x04000200,
+    SenderCol05     = 0x05000200,
+    SenderCol06     = 0x06000200,
+    SenderCol07     = 0x07000200,
+    SenderCol08     = 0x08000200,
+    SenderCol09     = 0x09000200,
+    SenderCol10     = 0x0a000200,
+    SenderCol11     = 0x0b000200,
+    SenderCol12     = 0x0c000200,
+    SenderCol13     = 0x0d000200,
+    SenderCol14     = 0x0e000200,
+    SenderCol15     = 0x0f000200,
+    SenderCol16     = 0x10000200,
+    SenderCol17     = 0x11000200,
+    SenderCol18     = 0x12000200,
+    SenderCol19     = 0x13000200,
+    SenderCol20     = 0x14000200,
+    SenderCol21     = 0x15000200,
+
+    SenderColSelf   = 0xff000200
+  };
+
+  struct StyledString {
+    QString plainText;
+    FormatList formatList;  // starting pos, ftypes
+  };
+
+  class StyledMessage;
+
+  StyledString styleString(const QString &);
+  QString mircToInternal(const QString &) const;
+
+  void setFormat(FormatType, QTextCharFormat, Settings::Mode mode/* = Settings::Custom*/);
+    void setSenderAutoColor(bool state);
+  QTextCharFormat format(FormatType, Settings::Mode mode = Settings::Custom) const;
+  QTextCharFormat mergedFormat(quint32 formatType);
+  QFontMetricsF *fontMetrics(quint32 formatType);
+
+  FormatType formatType(const QString &code) const;
+  QString formatCode(FormatType) const;
+
+  inline QFont defaultFont() const { return _defaultFont; }
+
+  QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength);
+
+protected:
+  bool _senderAutoColor;
+private:
+  QFont _defaultFont;
+  QTextCharFormat _defaultPlainFormat;
+  QHash<FormatType, QTextCharFormat> _defaultFormats;
+  QHash<FormatType, QTextCharFormat> _customFormats;
+  QHash<quint32, QTextCharFormat> _cachedFormats;
+  QHash<quint32, QFontMetricsF *> _cachedFontMetrics;
+  QHash<QString, FormatType> _formatCodes;
+
+  QString _settingsKey;
+};
 
-  public:
-    UiStyle(const QString &settingsKey);
-    virtual ~UiStyle();
-
-    /** This enumerates the possible formats a text element may have. */
-    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
-    };
-
-    struct UrlInfo {
-      int start, end;
-      QUrl url;
-    };
-
-    struct StyledText {
-      QString text;
-      QList<QTextLayout::FormatRange> formats;
-      QList<UrlInfo> urls;
-    };
-
-    StyledText styleString(QString);
-
-    void setFormat(FormatType, QTextCharFormat, Settings::Mode mode/* = Settings::Custom*/);
-    QTextCharFormat format(FormatType, Settings::Mode mode = Settings::Custom) const;
+class UiStyle::StyledMessage : public Message {
+public:
+  explicit StyledMessage(const Message &message);
 
-    FormatType formatType(const QString &code) const;
-    QString formatCode(FormatType) const;
+  //! Styling is only needed for calls to plainContents() and contentsFormatList()
+  // StyledMessage can't style lazily by itself, as it doesn't know the used style
+  bool inline needsStyling() const { return _contents.plainText.isNull(); }
+  void style(UiStyle *style) const;
 
-  protected:
 
+  QString decoratedTimestamp() const;
+  QString plainSender() const;             //!< Nickname (no decorations) for Plain and Notice, empty else
+  QString decoratedSender() const;
+  inline const QString &plainContents() const { return _contents.plainText; }
 
-  private:
-    QTextCharFormat mergedFormat(QList<FormatType>);
+  inline FormatType timestampFormat() const { return UiStyle::Timestamp; }
+  FormatType senderFormat() const;
+  inline const FormatList &contentsFormatList() const { return _contents.formatList; }
 
-    QVector<QTextCharFormat> _defaultFormats;
-    QVector<QTextCharFormat> _customFormats;
-    QHash<QString, FormatType> _formatCodes;
+private:
+  mutable StyledString _contents;
+};
 
-    QString _settingsKey;
+QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
+QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
 
-};
+Q_DECLARE_METATYPE(UiStyle::FormatList)
 
 #endif