1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
27 #include <QDataStream>
28 #include <QFontMetricsF>
31 #include <QTextCharFormat>
32 #include <QTextLayout>
36 #include "bufferinfo.h"
38 #include "networkmodel.h"
41 class UiStyle : public QObject
46 UiStyle(QObject *parent = 0);
49 //! This enumerates the possible formats a text element may have. */
50 /** These formats are ordered on increasing importance, in cases where a given property is specified
51 * by multiple active formats.
52 * \NOTE: Do not change/add values here without also adapting the relevant
53 * methods in this class (in particular mergedFormat())!
54 * Also, we _do_ rely on certain properties of these values in styleString() and friends!
56 enum class FormatType : quint32 {
60 // Message Formats (mutually exclusive!)
61 PlainMsg = 0x00000001,
62 NoticeMsg = 0x00000002,
63 ActionMsg = 0x00000003,
71 ServerMsg = 0x0000000b,
73 ErrorMsg = 0x0000000d,
74 DayChangeMsg = 0x0000000e,
75 TopicMsg = 0x0000000f,
76 NetsplitJoinMsg = 0x00000010,
77 NetsplitQuitMsg = 0x00000020,
78 InviteMsg = 0x00000030,
83 Underline = 0x00000400,
85 // Individual parts of a message
86 Timestamp = 0x00001000,
88 Contents = 0x00004000,
90 Hostmask = 0x00010000,
91 ChannelName = 0x00020000,
92 ModeFlags = 0x00040000,
94 // URL is special, we want that to take precedence over the rest...
97 // mIRC Colors - we assume those to be present only in plain contents
98 // foreground: 0x0.400000
99 // background: 0x.0800000
102 enum class MessageLabel : quint32 {
105 Highlight = 0x00000002,
106 Selected = 0x00000004 // must be last!
109 enum class ItemFormatType : quint32 {
112 BufferViewItem = 0x00000001,
113 NickViewItem = 0x00000002,
115 NetworkItem = 0x00000010,
116 ChannelBufferItem = 0x00000020,
117 QueryBufferItem = 0x00000040,
118 IrcUserItem = 0x00000080,
119 UserCategoryItem = 0x00000100,
121 InactiveBuffer = 0x00001000,
122 ActiveBuffer = 0x00002000,
123 UnreadBuffer = 0x00004000,
124 HighlightedBuffer = 0x00008000,
125 UserAway = 0x00010000,
130 enum class FormatProperty {
131 AllowForegroundOverride = QTextFormat::UserProperty,
132 AllowBackgroundOverride
135 enum class ColorRole {
137 // Sender colors (16 + self)
138 // These aren't used directly to avoid having storing all of the sender color options in the
139 // rendering routine of each item. Also, I couldn't figure out how to do that.
140 // It would be nice to have the UseSenderColors preference also toggle sender colors set by
141 // themes, so hopefully this can be extended in the future.
142 // Furthermore, using this palette directly would mean separate sets of colors couldn't be
143 // used for different message types.
161 NumRoles // must be last!
170 using FormatList = std::vector<std::pair<quint16, Format>>;
172 struct StyledString {
174 FormatList formatList; // starting pos, ftypes
180 * List of default sender colors
182 * In order from 1 - 16, matching the Sender## format in the settings file.
183 * Don't change the length or values of the colors without updating the UI and color roles, too.
185 * @see ../qtui/settingspages/chatviewsettingspage.ui
186 * @see UiStyle::ColorRole
188 const QList<QColor> defaultSenderColors = QList<QColor> {
189 QColor(204, 0, 0), /// Sender00
190 QColor( 0, 108, 173), /// Sender01
191 QColor( 77, 153, 0), /// Sender02
192 QColor(102, 0, 204), /// Sender03
193 QColor(166, 125, 0), /// Sender04
194 QColor( 0, 153, 39), /// Sender05
195 QColor( 0, 48, 192), /// Sender06
196 QColor(204, 0, 154), /// Sender07
197 QColor(185, 70, 0), /// Sender08
198 QColor(134, 153, 0), /// Sender09
199 QColor( 20, 153, 0), /// Sender10
200 QColor( 0, 153, 96), /// Sender11
201 QColor( 0, 108, 173), /// Sender12
202 QColor( 0, 153, 204), /// Sender13
203 QColor(179, 0, 204), /// Sender14
204 QColor(204, 0, 77), /// Sender15
206 // Explicitly declare QList<QColor> type for defaultSenderColors, otherwise error C2797
207 // "list initialization inside member initializer list" will occur in Windows builds with Visual
208 // Studio's compiler.
210 // See https://blogs.msdn.microsoft.com/vcblog/2014/08/19/the-future-of-non-static-data-member-initialization/
211 // Note: Qt Creator flags this as invalid unless you set Clang in
212 // Settings -> C++ -> Code Model -> Code Completion and Semantic Highlighting -> C
214 // See https://bugreports.qt.io/browse/QTCREATORBUG-1902
217 * Default sender color for sent messages
219 const QColor defaultSenderColorSelf = QColor(0, 0, 0);
221 static FormatType formatType(Message::Type msgType);
222 static StyledString styleString(const QString &string, FormatType baseFormat = FormatType::Base);
223 static QString mircToInternal(const QString &);
226 * Gets if a custom timestamp format is used.
228 * @return True if custom timestamp format used, otherwise false
230 static inline bool useCustomTimestampFormat() { return _useCustomTimestampFormat; }
233 * Gets the format string for chat log timestamps according to the system locale.
235 * This will return " hh:mm:ss" for system locales with 24-hour time or " h:mm:ss AP" for
236 * systems with 12-hour time.
238 * @return String representing timestamp format according to system locale, e.g. " hh:mm:ss"
240 static QString systemTimestampFormatString();
243 * Gets the format string for chat log timestamps, either system locale or custom.
245 * Depending on useCustomTimestampFormat(), this will return either the system locale based
246 * time format, or the custom user-specified string.
248 * @return String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
250 static QString timestampFormatString();
252 QTextCharFormat format(const Format &format, MessageLabel messageLabel) const;
253 QFontMetricsF *fontMetrics(FormatType formatType, MessageLabel messageLabel) const;
255 QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, MessageLabel messageLabel) const;
257 inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int)role); }
258 inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int)role] = brush; }
260 QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
261 QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
270 void loadStyleSheet();
271 QString loadStyleSheet(const QString &name, bool shouldExist = false);
273 QTextCharFormat parsedFormat(quint64 key) const;
274 QTextCharFormat cachedFormat(const Format &format, MessageLabel messageLabel) const;
275 void setCachedFormat(const QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
276 void mergeFormat(QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
277 void mergeSubElementFormat(QTextCharFormat &charFormat, FormatType formatType, MessageLabel messageLabel) const;
278 void mergeColors(QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
280 static FormatType formatType(const QString &code);
281 static QString formatCode(FormatType);
284 * Cache the system locale timestamp format string
286 * Based on whether or not AM/PM designators are used in the QLocale::system().timeFormat(),
287 * this extends the system locale timestamp format string to include seconds.
289 * @see UiStyle::systemTimestampFormatString()
291 static void updateSystemTimestampFormat();
294 * Updates the local setting cache of whether or not to use the custom timestamp format
296 * @param[in] enabled If true, custom timestamp format used, otherwise false
298 static void setUseCustomTimestampFormat(bool enabled);
301 * Updates the local setting cache of the timestamp format string
303 * @param[in] format Timestamp format string
305 static void setTimestampFormatString(const QString &format);
307 * Updates the local setting cache of whether or not to show sender prefixmodes
309 * @param[in] enabled If true, sender prefixmodes are enabled, otherwise false.
311 static void enableSenderPrefixes(bool enabled);
314 * Updates the local setting cache of whether or not to show sender brackets
316 * @param[in] enabled If true, sender brackets are enabled, otherwise false.
318 static void enableSenderBrackets(bool enabled);
320 QVariant itemData(int role, const QTextCharFormat &format) const;
323 void allowMircColorsChanged(const QVariant &);
324 void showItemViewIconsChanged(const QVariant &);
327 QVector<QBrush> _uiStylePalette;
328 QBrush _markerLineBrush;
329 QHash<quint64, QTextCharFormat> _formats;
330 mutable QHash<QString, QTextCharFormat> _formatCache;
331 mutable QHash<quint64, QFontMetricsF *> _metricsCache;
332 QHash<UiStyle::ItemFormatType, QTextCharFormat> _listItemFormats;
333 static QHash<QString, FormatType> _formatCodes;
334 static bool _useCustomTimestampFormat; /// If true, use the custom timestamp format
335 static QString _systemTimestampFormatString; /// Cached copy of system locale timestamp format
336 static QString _timestampFormatString; /// Timestamp format string
337 static bool _showSenderPrefixes; /// If true, show prefixmodes before sender names
338 static bool _showSenderBrackets; /// If true, show brackets around sender names
340 QIcon _channelJoinedIcon;
341 QIcon _channelPartedIcon;
342 QIcon _userOfflineIcon;
343 QIcon _userOnlineIcon;
345 QIcon _categoryOpIcon;
346 QIcon _categoryVoiceIcon;
349 bool _showNickViewIcons;
350 bool _showBufferViewIcons;
351 bool _allowMircColors;
355 class UiStyle::StyledMessage : public Message
357 Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage)
360 explicit StyledMessage(const Message &message);
362 QString decoratedTimestamp() const;
363 QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else
364 QString decoratedSender() const;
365 const QString &plainContents() const;
367 const FormatList &contentsFormatList() const;
369 quint8 senderHash() const;
375 mutable StyledString _contents;
376 mutable quint8 _senderHash;
379 #if QT_VERSION < 0x050000
380 uint qHash(UiStyle::ItemFormatType key);
382 uint qHash(UiStyle::ItemFormatType key, uint seed);
385 // ---- Operators for dealing with enums ----------------------------------------------------------
387 UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs);
388 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
389 UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs);
390 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, quint32 rhs);
391 UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs);
392 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
393 UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs);
394 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, quint32 rhs);
395 UiStyle::FormatType& operator^=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
397 UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs);
398 UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs);
399 UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs);
400 UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs);
402 // Shifts the label into the upper half of the return value
403 quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs);
405 UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs);
406 UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType &lhs, UiStyle::ItemFormatType rhs);
408 // ---- Allow for FormatList in QVariant ----------------------------------------------------------
410 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
411 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
413 Q_DECLARE_METATYPE(UiStyle::FormatList)
414 Q_DECLARE_METATYPE(UiStyle::MessageLabel)