1 /***************************************************************************
2 * Copyright (C) 2005-09 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #include <QApplication>
22 #include "buffersettings.h"
23 #include "iconloader.h"
24 #include "qssparser.h"
27 #include "uisettings.h"
30 QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
31 QString UiStyle::_timestampFormatString;
33 UiStyle::UiStyle(QObject *parent)
35 _channelJoinedIcon(SmallIcon("irc-channel-active")),
36 _channelPartedIcon(SmallIcon("irc-channel-inactive")),
37 _userOfflineIcon(SmallIcon("im-user-offline")),
38 _userOnlineIcon(SmallIcon("im-user")),
39 _userAwayIcon(SmallIcon("im-user-away")),
40 _categoryOpIcon(SmallIcon("irc-operator")),
41 _categoryVoiceIcon(SmallIcon("irc-voice")),
42 _opIconLimit(UserCategoryItem::categoryFromModes("o")),
43 _voiceIconLimit(UserCategoryItem::categoryFromModes("v"))
45 // register FormatList if that hasn't happened yet
46 // FIXME I don't think this actually avoids double registration... then again... does it hurt?
47 if(QVariant::nameToType("UiStyle::FormatList") == QVariant::Invalid) {
48 qRegisterMetaType<FormatList>("UiStyle::FormatList");
49 qRegisterMetaTypeStreamOperators<FormatList>("UiStyle::FormatList");
50 Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
53 _uiStylePalette = QVector<QBrush>(NumRoles, QBrush());
55 // Now initialize the mapping between FormatCodes and FormatTypes...
56 _formatCodes["%O"] = Base;
57 _formatCodes["%B"] = Bold;
58 _formatCodes["%S"] = Italic;
59 _formatCodes["%U"] = Underline;
60 _formatCodes["%R"] = Reverse;
62 _formatCodes["%DN"] = Nick;
63 _formatCodes["%DH"] = Hostmask;
64 _formatCodes["%DC"] = ChannelName;
65 _formatCodes["%DM"] = ModeFlags;
66 _formatCodes["%DU"] = Url;
68 setTimestampFormatString("[hh:mm:ss]");
70 // BufferView / NickView settings
72 _showBufferViewIcons = _showNickViewIcons = s.value("ShowItemViewIcons", true).toBool();
73 s.notify("ShowItemViewIcons", this, SLOT(showItemViewIconsChanged()));
79 qDeleteAll(_metricsCache);
82 void UiStyle::reload() {
86 void UiStyle::loadStyleSheet() {
87 qDeleteAll(_metricsCache);
88 _metricsCache.clear();
95 styleSheet += loadStyleSheet("file:///" + Quassel::findDataFilePath("default.qss"));
96 styleSheet += loadStyleSheet("file:///" + Quassel::configDirPath() + "settings.qss");
97 if(s.value("UseCustomStyleSheet", false).toBool())
98 styleSheet += loadStyleSheet("file:///" + s.value("CustomStyleSheetPath").toString(), true);
99 styleSheet += loadStyleSheet("file:///" + Quassel::optionValue("qss"), true);
101 if(!styleSheet.isEmpty()) {
103 parser.processStyleSheet(styleSheet);
104 QApplication::setPalette(parser.palette());
105 _uiStylePalette = parser.uiStylePalette();
107 QTextCharFormat baseFmt = parser.formats().value(Base);
108 foreach(quint64 fmtType, parser.formats().keys()) {
109 QTextCharFormat fmt = baseFmt;
110 fmt.merge(parser.formats().value(fmtType));
111 _formats[fmtType] = fmt;
113 _listItemFormats = parser.listItemFormats();
115 styleSheet = styleSheet.trimmed();
116 if(!styleSheet.isEmpty())
117 qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
123 QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist) {
124 QString ss = styleSheet;
125 if(ss.startsWith("file:///")) {
131 if(file.open(QFile::ReadOnly)) {
132 QTextStream stream(&file);
133 ss = stream.readAll();
137 qWarning() << "Could not open stylesheet file:" << file.fileName();
144 void UiStyle::setTimestampFormatString(const QString &format) {
145 if(_timestampFormatString != format) {
146 _timestampFormatString = format;
151 /******** ItemView Styling *******/
153 void UiStyle::showItemViewIconsChanged() {
155 _showBufferViewIcons = _showNickViewIcons = s.value("ShowItemViewIcons").toBool();
158 QVariant UiStyle::bufferViewItemData(const QModelIndex &index, int role) const {
159 BufferInfo::Type type = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).toInt();
160 bool isActive = index.data(NetworkModel::ItemActiveRole).toBool();
162 if(role == Qt::DecorationRole) {
163 if(!_showBufferViewIcons)
167 case BufferInfo::ChannelBuffer:
169 return _channelJoinedIcon;
171 return _channelPartedIcon;
172 case BufferInfo::QueryBuffer:
174 return _userOfflineIcon;
175 if(index.data(NetworkModel::UserAwayRole).toBool())
176 return _userAwayIcon;
178 return _userOnlineIcon;
184 quint32 fmtType = BufferViewItem;
186 case BufferInfo::StatusBuffer:
187 fmtType |= NetworkItem;
189 case BufferInfo::ChannelBuffer:
190 fmtType |= ChannelBufferItem;
192 case BufferInfo::QueryBuffer:
193 fmtType |= QueryBufferItem;
199 QTextCharFormat fmt = _listItemFormats.value(BufferViewItem);
200 fmt.merge(_listItemFormats.value(fmtType));
202 BufferInfo::ActivityLevel activity = (BufferInfo::ActivityLevel)index.data(NetworkModel::BufferActivityRole).toInt();
203 if(activity & BufferInfo::Highlight) {
204 fmt.merge(_listItemFormats.value(BufferViewItem | HighlightedBuffer));
205 fmt.merge(_listItemFormats.value(fmtType | HighlightedBuffer));
206 } else if(activity & BufferInfo::NewMessage) {
207 fmt.merge(_listItemFormats.value(BufferViewItem | UnreadBuffer));
208 fmt.merge(_listItemFormats.value(fmtType | UnreadBuffer));
209 } else if(activity & BufferInfo::OtherActivity) {
210 fmt.merge(_listItemFormats.value(BufferViewItem | ActiveBuffer));
211 fmt.merge(_listItemFormats.value(fmtType | ActiveBuffer));
212 } else if(!isActive) {
213 fmt.merge(_listItemFormats.value(BufferViewItem | InactiveBuffer));
214 fmt.merge(_listItemFormats.value(fmtType | InactiveBuffer));
215 } else if(index.data(NetworkModel::UserAwayRole).toBool()) {
216 fmt.merge(_listItemFormats.value(BufferViewItem | UserAway));
217 fmt.merge(_listItemFormats.value(fmtType | UserAway));
220 return itemData(role, fmt);
223 QVariant UiStyle::nickViewItemData(const QModelIndex &index, int role) const {
224 NetworkModel::ItemType type = (NetworkModel::ItemType)index.data(NetworkModel::ItemTypeRole).toInt();
226 if(role == Qt::DecorationRole) {
227 if(!_showNickViewIcons)
231 case NetworkModel::UserCategoryItemType:
233 int categoryId = index.data(TreeModel::SortRole).toInt();
234 if(categoryId <= _opIconLimit)
235 return _categoryOpIcon;
236 if(categoryId <= _voiceIconLimit)
237 return _categoryVoiceIcon;
238 return _userOnlineIcon;
240 case NetworkModel::IrcUserItemType:
241 if(index.data(NetworkModel::ItemActiveRole).toBool())
242 return _userOnlineIcon;
244 return _userAwayIcon;
250 QTextCharFormat fmt = _listItemFormats.value(NickViewItem);
253 case NetworkModel::IrcUserItemType:
254 fmt.merge(_listItemFormats.value(NickViewItem | IrcUserItem));
255 if(!index.data(NetworkModel::ItemActiveRole).toBool()) {
256 fmt.merge(_listItemFormats.value(NickViewItem | UserAway));
257 fmt.merge(_listItemFormats.value(NickViewItem | IrcUserItem | UserAway));
260 case NetworkModel::UserCategoryItemType:
261 fmt.merge(_listItemFormats.value(NickViewItem | UserCategoryItem));
267 return itemData(role, fmt);
270 QVariant UiStyle::itemData(int role, const QTextCharFormat &format) const {
273 return format.font();
274 case Qt::ForegroundRole:
275 return format.property(QTextFormat::ForegroundBrush);
276 case Qt::BackgroundRole:
277 return format.property(QTextFormat::BackgroundBrush);
283 /******** Caching *******/
285 QTextCharFormat UiStyle::format(quint64 key) const {
286 return _formats.value(key, QTextCharFormat());
289 QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
290 return _formatCache.value(formatType | ((quint64)messageLabel << 32), QTextCharFormat());
293 void UiStyle::setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) {
294 _formatCache[formatType | ((quint64)messageLabel << 32)] = format;
297 QFontMetricsF *UiStyle::fontMetrics(quint32 ftype, quint32 label) {
298 // QFontMetricsF is not assignable, so we need to store pointers :/
299 quint64 key = ftype | ((quint64)label << 32);
301 if(_metricsCache.contains(key))
302 return _metricsCache.value(key);
304 return (_metricsCache[key] = new QFontMetricsF(format(ftype, label).font()));
307 /******** Generate formats ********/
309 // NOTE: This and the following functions are intimately tied to the values in FormatType. Don't change this
310 // until you _really_ know what you do!
311 QTextCharFormat UiStyle::format(quint32 ftype, quint32 label_) {
313 return QTextCharFormat();
315 quint64 label = (quint64)label_ << 32;
317 // check if we have exactly this format readily cached already
318 QTextCharFormat fmt = cachedFormat(ftype, label_);
319 if(fmt.properties().count())
322 mergeFormat(fmt, ftype, label & Q_UINT64_C(0xffff000000000000));
324 for(quint64 mask = Q_UINT64_C(0x0000000100000000); mask <= (quint64)Selected << 32; mask <<=1) {
326 mergeFormat(fmt, ftype, mask | Q_UINT64_C(0xffff000000000000));
329 setCachedFormat(fmt, ftype, label_);
333 void UiStyle::mergeFormat(QTextCharFormat &fmt, quint32 ftype, quint64 label) {
334 mergeSubElementFormat(fmt, ftype & 0x00ff, label);
336 // TODO: allow combinations for mirc formats and colors (each), e.g. setting a special format for "bold and italic"
337 // or "foreground 01 and background 03"
338 if((ftype & 0xfff00)) { // element format
339 for(quint32 mask = 0x00100; mask <= 0x40000; mask <<= 1) {
341 mergeSubElementFormat(fmt, ftype & (mask | 0xff), label);
346 // Now we handle color codes
347 // We assume that those can't be combined with subelement and message types.
348 if(ftype & 0x00400000)
349 mergeSubElementFormat(fmt, ftype & 0x0f400000, label); // foreground
350 if(ftype & 0x00800000)
351 mergeSubElementFormat(fmt, ftype & 0xf0800000, label); // background
352 if((ftype & 0x00c00000) == 0x00c00000)
353 mergeSubElementFormat(fmt, ftype & 0xffc00000, label); // combination
357 mergeSubElementFormat(fmt, ftype & (Url | 0x000000ff), label);
360 // Merge a subelement format into an existing message format
361 void UiStyle::mergeSubElementFormat(QTextCharFormat& fmt, quint32 ftype, quint64 label) {
362 quint64 key = ftype | label;
363 fmt.merge(format(key & Q_UINT64_C(0x0000ffffffffff00))); // label + subelement
364 fmt.merge(format(key & Q_UINT64_C(0x0000ffffffffffff))); // label + subelement + msgtype
365 fmt.merge(format(key & Q_UINT64_C(0xffffffffffffff00))); // label + subelement + nickhash
366 fmt.merge(format(key & Q_UINT64_C(0xffffffffffffffff))); // label + subelement + nickhash + msgtype
369 UiStyle::FormatType UiStyle::formatType(Message::Type msgType) {
373 case Message::Notice:
375 case Message::Action:
391 case Message::Server:
397 case Message::DayChange:
402 //Q_ASSERT(false); // we need to handle all message types
403 qWarning() << Q_FUNC_INFO << "Unknown message type:" << msgType;
407 UiStyle::FormatType UiStyle::formatType(const QString & code) {
408 if(_formatCodes.contains(code)) return _formatCodes.value(code);
412 QString UiStyle::formatCode(FormatType ftype) {
413 return _formatCodes.key(ftype);
416 QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength, quint32 messageLabel) {
417 QList<QTextLayout::FormatRange> formatRanges;
418 QTextLayout::FormatRange range;
420 for(i = 0; i < formatList.count(); i++) {
421 range.format = format(formatList.at(i).second, messageLabel);
422 range.start = formatList.at(i).first;
423 if(i > 0) formatRanges.last().length = range.start - formatRanges.last().start;
424 formatRanges.append(range);
426 if(i > 0) formatRanges.last().length = textLength - formatRanges.last().start;
430 // This method expects a well-formatted string, there is no error checking!
431 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
432 UiStyle::StyledString UiStyle::styleString(const QString &s_, quint32 baseFormat) {
434 if(s.length() > 65535) {
435 qWarning() << QString("String too long to be styled: %1").arg(s);
436 return StyledString();
439 result.formatList.append(qMakePair((quint16)0, baseFormat));
440 quint32 curfmt = baseFormat;
441 int pos = 0; quint16 length = 0;
443 pos = s.indexOf('%', pos);
445 if(s[pos+1] == '%') { // escaped %, we just remove one and continue
450 if(s[pos+1] == 'D' && s[pos+2] == 'c') { // color code
451 if(s[pos+3] == '-') { // color off
452 curfmt &= 0x003fffff;
455 int color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
456 //TODO: use 99 as transparent color (re mirc color "standard")
458 if(s[pos+3] == 'f') {
459 curfmt &= 0xf0ffffff;
460 curfmt |= (quint32)(color << 24) | 0x00400000;
462 curfmt &= 0x0fffffff;
463 curfmt |= (quint32)(color << 28) | 0x00800000;
467 } else if(s[pos+1] == 'O') { // reset formatting
468 curfmt &= 0x000000ff; // we keep message type-specific formatting
470 } else if(s[pos+1] == 'R') { // reverse
471 // TODO: implement reverse formatting
474 } else { // all others are toggles
475 QString code = QString("%") + s[pos+1];
476 if(s[pos+1] == 'D') code += s[pos+2];
477 FormatType ftype = formatType(code);
478 if(ftype == Invalid) {
479 qWarning() << (QString("Invalid format code in string: %1").arg(s));
483 length = code.length();
485 s.remove(pos, length);
486 if(pos == result.formatList.last().first)
487 result.formatList.last().second = curfmt;
489 result.formatList.append(qMakePair((quint16)pos, curfmt));
491 result.plainText = s;
495 QString UiStyle::mircToInternal(const QString &mirc_) {
496 QString mirc = mirc_;
497 mirc.replace('%', "%%"); // escape % just to be sure
498 mirc.replace('\x02', "%B");
499 mirc.replace('\x0f', "%O");
500 mirc.replace('\x12', "%R");
501 mirc.replace('\x16', "%R");
502 mirc.replace('\x1d', "%S");
503 mirc.replace('\x1f', "%U");
505 // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
506 // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
507 // %Dc- turns color off.
508 // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
509 // This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
512 pos = mirc.indexOf('\x03', pos);
513 if(pos < 0) break; // no more mirc color codes
515 int l = mirc.length();
517 // check for fg color
518 if(i < l && mirc[i].isDigit()) {
520 if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
521 else num.prepend('0');
522 ins = QString("%Dcf%1").arg(num);
524 if(i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
527 if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
528 else num.prepend('0');
529 ins += QString("%Dcb%1").arg(num);
534 mirc.replace(pos, i-pos, ins);
539 /***********************************************************************************/
540 UiStyle::StyledMessage::StyledMessage(const Message &msg)
543 if(type() == Message::Plain)
546 _senderHash = 0x00; // this means we never compute the hash for msgs that aren't plain
549 void UiStyle::StyledMessage::style() const {
550 QString user = userFromMask(sender());
551 QString host = hostFromMask(sender());
552 QString nick = nickFromMask(sender());
553 QString txt = UiStyle::mircToInternal(contents());
554 QString bufferName = bufferInfo().bufferName();
555 bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
561 t = tr("%1").arg(txt); break;
562 case Message::Notice:
564 t = tr("%1").arg(txt); break;
565 case Message::Action:
567 t = tr("%DN%1%DN %2").arg(nick).arg(txt);
571 if(nick == contents()) t = tr("You are now known as %DN%1%DN").arg(txt);
572 else t = tr("%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
576 if(nick.isEmpty()) t = tr("User mode: %DM%1%DM").arg(txt);
577 else t = tr("Mode %DM%1%DM by %DN%2%DN").arg(txt, nick);
581 t = tr("%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
584 t = tr("%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
585 if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
589 t = tr("%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
590 if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
592 case Message::Kick: {
593 QString victim = txt.section(" ", 0, 0);
594 QString kickmsg = txt.section(" ", 1);
596 t = tr("%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
597 if(!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
600 //case Message::Kill: FIXME
602 case Message::Server:
604 t = tr("%1").arg(txt); break;
607 t = tr("%1").arg(txt); break;
610 t = tr("%1").arg(txt); break;
611 case Message::DayChange:
612 //: Day Change Message
613 t = tr("{Day changed to %1}").arg(timestamp().toString());
617 t = tr("%1").arg(txt); break;
619 t = tr("[%1]").arg(txt);
621 _contents = UiStyle::styleString(t, UiStyle::formatType(type()));
624 const QString &UiStyle::StyledMessage::plainContents() const {
625 if(_contents.plainText.isNull())
628 return _contents.plainText;
631 const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const {
632 if(_contents.plainText.isNull())
635 return _contents.formatList;
638 QString UiStyle::StyledMessage::decoratedTimestamp() const {
639 return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
642 QString UiStyle::StyledMessage::plainSender() const {
645 case Message::Notice:
646 return nickFromMask(sender());
652 QString UiStyle::StyledMessage::decoratedSender() const {
655 return tr("<%1>").arg(plainSender()); break;
656 case Message::Notice:
657 return tr("[%1]").arg(plainSender()); break;
658 case Message::Action:
659 return tr("-*-"); break;
661 return tr("<->"); break;
663 return tr("***"); break;
665 return tr("-->"); break;
667 return tr("<--"); break;
669 return tr("<--"); break;
671 return tr("<-*"); break;
673 return tr("<-x"); break;
674 case Message::Server:
675 return tr("*"); break;
677 return tr("*"); break;
679 return tr("*"); break;
680 case Message::DayChange:
681 return tr("-"); break;
683 return tr("*"); break;
685 return tr("%1").arg(plainSender());
689 // FIXME hardcoded to 16 sender hashes
690 quint8 UiStyle::StyledMessage::senderHash() const {
691 if(_senderHash != 0xff)
694 QString nick = nickFromMask(sender()).toLower();
695 if(!nick.isEmpty()) {
697 while(chopCount < nick.size() && nick.at(nick.count() - 1 - chopCount) == '_')
699 if(chopCount < nick.size())
700 nick.chop(chopCount);
702 quint16 hash = qChecksum(nick.toAscii().data(), nick.toAscii().size());
703 return (_senderHash = (hash & 0xf) + 1);
706 /***********************************************************************************/
708 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList) {
709 out << formatList.count();
710 UiStyle::FormatList::const_iterator it = formatList.begin();
711 while(it != formatList.end()) {
712 out << (*it).first << (*it).second;
718 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList) {
721 for(quint16 i = 0; i < cnt; i++) {
722 quint16 pos; quint32 ftype;
724 formatList.append(qMakePair((quint16)pos, ftype));