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,
84 Strikethrough = 0x00000800,
86 // Individual parts of a message
87 Timestamp = 0x00001000,
89 Contents = 0x00004000,
91 Hostmask = 0x00010000,
92 ChannelName = 0x00020000,
93 ModeFlags = 0x00040000,
95 // URL is special, we want that to take precedence over the rest...
98 // mIRC Colors - we assume those to be present only in plain contents
99 // foreground: 0x0.400000
100 // background: 0x.0800000
103 enum class MessageLabel : quint32 {
106 Highlight = 0x00000002,
107 Selected = 0x00000004 // must be last!
110 enum class ItemFormatType : quint32 {
113 BufferViewItem = 0x00000001,
114 NickViewItem = 0x00000002,
116 NetworkItem = 0x00000010,
117 ChannelBufferItem = 0x00000020,
118 QueryBufferItem = 0x00000040,
119 IrcUserItem = 0x00000080,
120 UserCategoryItem = 0x00000100,
122 InactiveBuffer = 0x00001000,
123 ActiveBuffer = 0x00002000,
124 UnreadBuffer = 0x00004000,
125 HighlightedBuffer = 0x00008000,
126 UserAway = 0x00010000,
131 enum class FormatProperty {
132 AllowForegroundOverride = QTextFormat::UserProperty,
133 AllowBackgroundOverride
136 enum class ColorRole {
138 // Sender colors (16 + self)
139 // These aren't used directly to avoid having storing all of the sender color options in the
140 // rendering routine of each item. Also, I couldn't figure out how to do that.
141 // It would be nice to have the UseSenderColors preference also toggle sender colors set by
142 // themes, so hopefully this can be extended in the future.
143 // Furthermore, using this palette directly would mean separate sets of colors couldn't be
144 // used for different message types.
162 NumRoles // must be last!
171 using FormatList = std::vector<std::pair<quint16, Format>>;
173 struct StyledString {
175 FormatList formatList; // starting pos, ftypes
181 * List of default sender colors
183 * In order from 1 - 16, matching the Sender## format in the settings file.
184 * Don't change the length or values of the colors without updating the UI and color roles, too.
186 * @see ../qtui/settingspages/chatviewsettingspage.ui
187 * @see UiStyle::ColorRole
189 const QList<QColor> defaultSenderColors = QList<QColor> {
190 QColor(204, 0, 0), /// Sender00
191 QColor( 0, 108, 173), /// Sender01
192 QColor( 77, 153, 0), /// Sender02
193 QColor(102, 0, 204), /// Sender03
194 QColor(166, 125, 0), /// Sender04
195 QColor( 0, 153, 39), /// Sender05
196 QColor( 0, 48, 192), /// Sender06
197 QColor(204, 0, 154), /// Sender07
198 QColor(185, 70, 0), /// Sender08
199 QColor(134, 153, 0), /// Sender09
200 QColor( 20, 153, 0), /// Sender10
201 QColor( 0, 153, 96), /// Sender11
202 QColor( 0, 108, 173), /// Sender12
203 QColor( 0, 153, 204), /// Sender13
204 QColor(179, 0, 204), /// Sender14
205 QColor(204, 0, 77), /// Sender15
207 // Explicitly declare QList<QColor> type for defaultSenderColors, otherwise error C2797
208 // "list initialization inside member initializer list" will occur in Windows builds with Visual
209 // Studio's compiler.
211 // See https://blogs.msdn.microsoft.com/vcblog/2014/08/19/the-future-of-non-static-data-member-initialization/
212 // Note: Qt Creator flags this as invalid unless you set Clang in
213 // Settings -> C++ -> Code Model -> Code Completion and Semantic Highlighting -> C
215 // See https://bugreports.qt.io/browse/QTCREATORBUG-1902
218 * Default sender color for sent messages
220 const QColor defaultSenderColorSelf = QColor(0, 0, 0);
222 static FormatType formatType(Message::Type msgType);
223 static StyledString styleString(const QString &string, FormatType baseFormat = FormatType::Base);
224 static QString mircToInternal(const QString &);
227 * Gets if a custom timestamp format is used.
229 * @return True if custom timestamp format used, otherwise false
231 static inline bool useCustomTimestampFormat() { return _useCustomTimestampFormat; }
234 * Gets the format string for chat log timestamps according to the system locale.
236 * This will return " hh:mm:ss" for system locales with 24-hour time or " h:mm:ss AP" for
237 * systems with 12-hour time.
239 * @return String representing timestamp format according to system locale, e.g. " hh:mm:ss"
241 static QString systemTimestampFormatString();
244 * Gets the format string for chat log timestamps, either system locale or custom.
246 * Depending on useCustomTimestampFormat(), this will return either the system locale based
247 * time format, or the custom user-specified string.
249 * @return String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
251 static QString timestampFormatString();
253 QTextCharFormat format(const Format &format, MessageLabel messageLabel) const;
254 QFontMetricsF *fontMetrics(FormatType formatType, MessageLabel messageLabel) const;
256 QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, MessageLabel messageLabel) const;
258 inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int)role); }
259 inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int)role] = brush; }
261 QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
262 QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
271 void loadStyleSheet();
272 QString loadStyleSheet(const QString &name, bool shouldExist = false);
274 QTextCharFormat parsedFormat(quint64 key) const;
275 QTextCharFormat cachedFormat(const Format &format, MessageLabel messageLabel) const;
276 void setCachedFormat(const QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
277 void mergeFormat(QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
278 void mergeSubElementFormat(QTextCharFormat &charFormat, FormatType formatType, MessageLabel messageLabel) const;
279 void mergeColors(QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
281 static FormatType formatType(const QString &code);
282 static QString formatCode(FormatType);
285 * Cache the system locale timestamp format string
287 * Based on whether or not AM/PM designators are used in the QLocale::system().timeFormat(),
288 * this extends the system locale timestamp format string to include seconds.
290 * @see UiStyle::systemTimestampFormatString()
292 static void updateSystemTimestampFormat();
295 * Updates the local setting cache of whether or not to use the custom timestamp format
297 * @param[in] enabled If true, custom timestamp format used, otherwise false
299 static void setUseCustomTimestampFormat(bool enabled);
302 * Updates the local setting cache of the timestamp format string
304 * @param[in] format Timestamp format string
306 static void setTimestampFormatString(const QString &format);
308 * Updates the local setting cache of whether or not to show sender prefixmodes
310 * @param[in] enabled If true, sender prefixmodes are enabled, otherwise false.
312 static void enableSenderPrefixes(bool enabled);
315 * Updates the local setting cache of whether or not to show sender brackets
317 * @param[in] enabled If true, sender brackets are enabled, otherwise false.
319 static void enableSenderBrackets(bool enabled);
321 QVariant itemData(int role, const QTextCharFormat &format) const;
324 void allowMircColorsChanged(const QVariant &);
325 void showItemViewIconsChanged(const QVariant &);
328 QVector<QBrush> _uiStylePalette;
329 QBrush _markerLineBrush;
330 QHash<quint64, QTextCharFormat> _formats;
331 mutable QHash<QString, QTextCharFormat> _formatCache;
332 mutable QHash<quint64, QFontMetricsF *> _metricsCache;
333 QHash<UiStyle::ItemFormatType, QTextCharFormat> _listItemFormats;
334 static QHash<QString, FormatType> _formatCodes;
335 static bool _useCustomTimestampFormat; /// If true, use the custom timestamp format
336 static QString _systemTimestampFormatString; /// Cached copy of system locale timestamp format
337 static QString _timestampFormatString; /// Timestamp format string
338 static bool _showSenderPrefixes; /// If true, show prefixmodes before sender names
339 static bool _showSenderBrackets; /// If true, show brackets around sender names
341 QIcon _channelJoinedIcon;
342 QIcon _channelPartedIcon;
343 QIcon _userOfflineIcon;
344 QIcon _userOnlineIcon;
346 QIcon _categoryOpIcon;
347 QIcon _categoryVoiceIcon;
350 bool _showNickViewIcons;
351 bool _showBufferViewIcons;
352 bool _allowMircColors;
356 class UiStyle::StyledMessage : public Message
358 Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage)
361 explicit StyledMessage(const Message &message);
363 QString decoratedTimestamp() const;
364 QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else
365 QString decoratedSender() const;
366 const QString &plainContents() const;
368 const FormatList &contentsFormatList() const;
370 quint8 senderHash() const;
376 mutable StyledString _contents;
377 mutable quint8 _senderHash;
380 #if QT_VERSION < 0x050000
381 uint qHash(UiStyle::ItemFormatType key);
383 uint qHash(UiStyle::ItemFormatType key, uint seed);
386 // ---- Operators for dealing with enums ----------------------------------------------------------
388 UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs);
389 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
390 UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs);
391 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, quint32 rhs);
392 UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs);
393 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
394 UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs);
395 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, quint32 rhs);
396 UiStyle::FormatType& operator^=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
398 UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs);
399 UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs);
400 UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs);
401 UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs);
403 // Shifts the label into the upper half of the return value
404 quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs);
406 UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs);
407 UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType &lhs, UiStyle::ItemFormatType rhs);
409 // ---- Allow for FormatList in QVariant ----------------------------------------------------------
411 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
412 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
414 Q_DECLARE_METATYPE(UiStyle::FormatList)
415 Q_DECLARE_METATYPE(UiStyle::MessageLabel)