1 /***************************************************************************
2 * Copyright (C) 2005-2018 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
44 Q_ENUMS(SenderPrefixModes)
47 UiStyle(QObject *parent = 0);
50 //! This enumerates the possible formats a text element may have. */
51 /** These formats are ordered on increasing importance, in cases where a given property is specified
52 * by multiple active formats.
53 * \NOTE: Do not change/add values here without also adapting the relevant
54 * methods in this class (in particular mergedFormat())!
55 * Also, we _do_ rely on certain properties of these values in styleString() and friends!
57 enum class FormatType : quint32 {
61 // Message Formats (mutually exclusive!)
62 PlainMsg = 0x00000001,
63 NoticeMsg = 0x00000002,
64 ActionMsg = 0x00000003,
72 ServerMsg = 0x0000000b,
74 ErrorMsg = 0x0000000d,
75 DayChangeMsg = 0x0000000e,
76 TopicMsg = 0x0000000f,
77 NetsplitJoinMsg = 0x00000010,
78 NetsplitQuitMsg = 0x00000020,
79 InviteMsg = 0x00000030,
84 Underline = 0x00000400,
85 Strikethrough = 0x00000800,
87 // Individual parts of a message
88 Timestamp = 0x00001000,
90 Contents = 0x00004000,
92 Hostmask = 0x00010000,
93 ChannelName = 0x00020000,
94 ModeFlags = 0x00040000,
96 // URL is special, we want that to take precedence over the rest...
99 // mIRC Colors - we assume those to be present only in plain contents
100 // foreground: 0x0.400000
101 // background: 0x.0800000
104 enum class MessageLabel : quint32 {
107 Highlight = 0x00000002,
108 Selected = 0x00000004,
109 Hovered = 0x00000008,
113 enum class ItemFormatType : quint32 {
116 BufferViewItem = 0x00000001,
117 NickViewItem = 0x00000002,
119 NetworkItem = 0x00000010,
120 ChannelBufferItem = 0x00000020,
121 QueryBufferItem = 0x00000040,
122 IrcUserItem = 0x00000080,
123 UserCategoryItem = 0x00000100,
125 InactiveBuffer = 0x00001000,
126 ActiveBuffer = 0x00002000,
127 UnreadBuffer = 0x00004000,
128 HighlightedBuffer = 0x00008000,
129 UserAway = 0x00010000,
134 enum class FormatProperty {
135 AllowForegroundOverride = QTextFormat::UserProperty,
136 AllowBackgroundOverride
139 enum class ColorRole {
141 // Sender colors (16 + self)
142 // These aren't used directly to avoid having storing all of the sender color options in the
143 // rendering routine of each item. Also, I couldn't figure out how to do that.
144 // It would be nice to have the UseSenderColors preference also toggle sender colors set by
145 // themes, so hopefully this can be extended in the future.
146 // Furthermore, using this palette directly would mean separate sets of colors couldn't be
147 // used for different message types.
165 NumRoles // must be last!
168 /// Display of sender prefix modes
169 enum class SenderPrefixMode {
170 NoModes = 0, ///< Hide sender modes
171 HighestMode = 1, ///< Show the highest active sender mode
172 AllModes = 2 ///< Show all active sender modes
174 // Do not change SenderPrefixMode numbering without also adjusting
175 // ChatViewSettingsPage::initSenderPrefixComboBox() and chatviewsettingspage.ui "defaultValue"
183 using FormatList = std::vector<std::pair<quint16, Format>>;
185 struct StyledString {
187 FormatList formatList; // starting pos, ftypes
193 * List of default sender colors
195 * In order from 1 - 16, matching the Sender## format in the settings file.
196 * Don't change the length or values of the colors without updating the UI and color roles, too.
198 * @see ../qtui/settingspages/chatviewsettingspage.ui
199 * @see UiStyle::ColorRole
201 const QList<QColor> defaultSenderColors = QList<QColor> {
202 QColor(204, 0, 0), ///< Sender00
203 QColor( 0, 108, 173), ///< Sender01
204 QColor( 77, 153, 0), ///< Sender02
205 QColor(102, 0, 204), ///< Sender03
206 QColor(166, 125, 0), ///< Sender04
207 QColor( 0, 153, 39), ///< Sender05
208 QColor( 0, 48, 192), ///< Sender06
209 QColor(204, 0, 154), ///< Sender07
210 QColor(185, 70, 0), ///< Sender08
211 QColor(134, 153, 0), ///< Sender09
212 QColor( 20, 153, 0), ///< Sender10
213 QColor( 0, 153, 96), ///< Sender11
214 QColor( 0, 108, 173), ///< Sender12
215 QColor( 0, 153, 204), ///< Sender13
216 QColor(179, 0, 204), ///< Sender14
217 QColor(204, 0, 77), ///< Sender15
219 // Explicitly declare QList<QColor> type for defaultSenderColors, otherwise error C2797
220 // "list initialization inside member initializer list" will occur in Windows builds with Visual
221 // Studio's compiler.
223 // See https://blogs.msdn.microsoft.com/vcblog/2014/08/19/the-future-of-non-static-data-member-initialization/
224 // Note: Qt Creator flags this as invalid unless you set Clang in
225 // Settings -> C++ -> Code Model -> Code Completion and Semantic Highlighting -> C
227 // See https://bugreports.qt.io/browse/QTCREATORBUG-1902
230 * Default sender color for sent messages
232 const QColor defaultSenderColorSelf = QColor(0, 0, 0);
234 static FormatType formatType(Message::Type msgType);
235 static StyledString styleString(const QString &string, FormatType baseFormat = FormatType::Base);
236 static QString mircToInternal(const QString &);
239 * Gets if a custom timestamp format is used.
241 * @return True if custom timestamp format used, otherwise false
243 static inline bool useCustomTimestampFormat() { return _useCustomTimestampFormat; }
246 * Gets the format string for chat log timestamps according to the system locale.
248 * This will return " hh:mm:ss" for system locales with 24-hour time or " h:mm:ss AP" for
249 * systems with 12-hour time.
251 * @return String representing timestamp format according to system locale, e.g. " hh:mm:ss"
253 static QString systemTimestampFormatString();
256 * Gets the format string for chat log timestamps, either system locale or custom.
258 * Depending on useCustomTimestampFormat(), this will return either the system locale based
259 * time format, or the custom user-specified string.
261 * @return String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
263 static QString timestampFormatString();
265 QTextCharFormat format(const Format &format, MessageLabel messageLabel) const;
266 QFontMetricsF *fontMetrics(FormatType formatType, MessageLabel messageLabel) const;
268 QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, MessageLabel messageLabel) const;
270 inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int)role); }
271 inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int)role] = brush; }
273 QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
274 QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
283 void loadStyleSheet();
284 QString loadStyleSheet(const QString &name, bool shouldExist = false);
286 QTextCharFormat parsedFormat(quint64 key) const;
287 QTextCharFormat cachedFormat(const Format &format, MessageLabel messageLabel) const;
288 void setCachedFormat(const QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
289 void mergeFormat(QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
290 void mergeSubElementFormat(QTextCharFormat &charFormat, FormatType formatType, MessageLabel messageLabel) const;
291 void mergeColors(QTextCharFormat &charFormat, const Format &format, MessageLabel messageLabel) const;
293 static FormatType formatType(const QString &code);
294 static QString formatCode(FormatType);
297 * Cache the system locale timestamp format string
299 * Based on whether or not AM/PM designators are used in the QLocale.timeFormat(), this extends
300 * the application locale timestamp format string to include seconds.
302 * @see UiStyle::systemTimestampFormatString()
304 static void updateSystemTimestampFormat();
307 * Updates the local setting cache of whether or not to use the custom timestamp format
309 * @param[in] enabled If true, custom timestamp format used, otherwise false
311 static void setUseCustomTimestampFormat(bool enabled);
314 * Updates the local setting cache of the timestamp format string
316 * @param[in] format Timestamp format string
318 static void setTimestampFormatString(const QString &format);
320 * Updates the local setting cache of how to display sender prefix modes
322 * @param[in] mode Display format for sender prefix modes
324 static void setSenderPrefixDisplay(UiStyle::SenderPrefixMode mode);
327 * Updates the local setting cache of whether or not to show sender brackets
329 * @param[in] enabled If true, sender brackets are enabled, otherwise false.
331 static void enableSenderBrackets(bool enabled);
333 QVariant itemData(int role, const QTextCharFormat &format) const;
336 void allowMircColorsChanged(const QVariant &);
337 void showItemViewIconsChanged(const QVariant &);
340 QVector<QBrush> _uiStylePalette;
341 QBrush _markerLineBrush;
342 QHash<quint64, QTextCharFormat> _formats;
343 mutable QHash<QString, QTextCharFormat> _formatCache;
344 mutable QHash<quint64, QFontMetricsF *> _metricsCache;
345 QHash<UiStyle::ItemFormatType, QTextCharFormat> _listItemFormats;
346 static QHash<QString, FormatType> _formatCodes;
347 static bool _useCustomTimestampFormat; ///< If true, use the custom timestamp format
348 static QString _systemTimestampFormatString; ///< Cached copy of system locale timestamp format
349 static QString _timestampFormatString; ///< Timestamp format string
350 static UiStyle::SenderPrefixMode _senderPrefixDisplay; ///< Prefix mode display before sender
351 static bool _showSenderBrackets; ///< If true, show brackets around sender names
353 QIcon _channelJoinedIcon;
354 QIcon _channelPartedIcon;
355 QIcon _userOfflineIcon;
356 QIcon _userOnlineIcon;
358 QIcon _categoryOpIcon;
359 QIcon _categoryVoiceIcon;
362 bool _showNickViewIcons;
363 bool _showBufferViewIcons;
364 bool _allowMircColors;
368 class UiStyle::StyledMessage : public Message
370 Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage)
373 explicit StyledMessage(const Message &message);
375 QString decoratedTimestamp() const;
376 QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else
377 QString decoratedSender() const;
378 const QString &plainContents() const;
380 const FormatList &contentsFormatList() const;
382 quint8 senderHash() const;
388 mutable StyledString _contents;
389 mutable quint8 _senderHash;
392 uint qHash(UiStyle::ItemFormatType key, uint seed);
394 // ---- Operators for dealing with enums ----------------------------------------------------------
396 UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs);
397 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
398 UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs);
399 UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, quint32 rhs);
400 UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs);
401 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
402 UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs);
403 UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, quint32 rhs);
404 UiStyle::FormatType& operator^=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs);
406 UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs);
407 UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs);
408 UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs);
409 UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs);
411 // Shifts the label into the upper half of the return value
412 quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs);
414 UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs);
415 UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType &lhs, UiStyle::ItemFormatType rhs);
417 // ---- Allow for FormatList in QVariant ----------------------------------------------------------
419 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
420 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
422 Q_DECLARE_METATYPE(UiStyle::FormatList)
423 Q_DECLARE_METATYPE(UiStyle::MessageLabel)
424 Q_DECLARE_METATYPE(UiStyle::SenderPrefixMode)