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 "qssparser.h"
25 #include "uisettings.h"
28 QHash<QString, UiStyle::FormatType> UiStyle::_formatCodes;
29 QString UiStyle::_timestampFormatString;
31 UiStyle::UiStyle(QObject *parent) : QObject(parent) {
32 // register FormatList if that hasn't happened yet
33 // FIXME I don't think this actually avoids double registration... then again... does it hurt?
34 if(QVariant::nameToType("UiStyle::FormatList") == QVariant::Invalid) {
35 qRegisterMetaType<FormatList>("UiStyle::FormatList");
36 qRegisterMetaTypeStreamOperators<FormatList>("UiStyle::FormatList");
37 Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
40 // Now initialize the mapping between FormatCodes and FormatTypes...
41 _formatCodes["%O"] = None;
42 _formatCodes["%B"] = Bold;
43 _formatCodes["%S"] = Italic;
44 _formatCodes["%U"] = Underline;
45 _formatCodes["%R"] = Reverse;
47 _formatCodes["%DN"] = Nick;
48 _formatCodes["%DH"] = Hostmask;
49 _formatCodes["%DC"] = ChannelName;
50 _formatCodes["%DM"] = ModeFlags;
51 _formatCodes["%DU"] = Url;
53 setTimestampFormatString("[hh:mm:ss]");
59 qDeleteAll(_metricsCache);
62 void UiStyle::reload() {
66 void UiStyle::loadStyleSheet() {
67 qDeleteAll(_metricsCache);
68 _metricsCache.clear();
74 styleSheet += loadStyleSheet("file:///" + Quassel::findDataFilePath("default.qss"));
75 styleSheet += loadStyleSheet("file:///" + Quassel::configDirPath() + "settings.qss");
76 if(s.value("UseCustomStyleSheet", false).toBool())
77 styleSheet += loadStyleSheet("file:///" + s.value("CustomStyleSheetPath").toString(), true);
78 styleSheet += loadStyleSheet("file:///" + Quassel::optionValue("qss"), true);
80 if(!styleSheet.isEmpty()) {
82 parser.processStyleSheet(styleSheet);
83 QApplication::setPalette(parser.palette());
84 _formatCache = parser.formats();
86 qApp->setStyleSheet(styleSheet); // pass the remaining sections to the application
92 QString UiStyle::loadStyleSheet(const QString &styleSheet, bool shouldExist) {
93 QString ss = styleSheet;
94 if(ss.startsWith("file:///")) {
100 if(file.open(QFile::ReadOnly)) {
101 QTextStream stream(&file);
102 ss = stream.readAll();
106 qWarning() << "Could not open stylesheet file:" << file.fileName();
113 void UiStyle::setTimestampFormatString(const QString &format) {
114 if(_timestampFormatString != format) {
115 _timestampFormatString = format;
120 /******** Caching *******/
122 QTextCharFormat UiStyle::cachedFormat(quint64 key) const {
123 return _formatCache.value(key, QTextCharFormat());
126 QTextCharFormat UiStyle::cachedFormat(quint32 formatType, quint32 messageLabel) const {
127 return cachedFormat(formatType | ((quint64)messageLabel << 32));
130 void UiStyle::setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) {
131 _formatCache[formatType | ((quint64)messageLabel << 32)] = format;
134 QFontMetricsF *UiStyle::fontMetrics(quint32 ftype, quint32 label) {
135 // QFontMetricsF is not assignable, so we need to store pointers :/
136 quint64 key = ftype | ((quint64)label << 32);
138 if(_metricsCache.contains(key))
139 return _metricsCache.value(key);
141 return (_metricsCache[key] = new QFontMetricsF(format(ftype, label).font()));
144 /******** Generate formats ********/
146 // NOTE: This and the following functions are intimately tied to the values in FormatType. Don't change this
147 // until you _really_ know what you do!
148 QTextCharFormat UiStyle::format(quint32 ftype, quint32 label_) {
150 return QTextCharFormat();
152 quint64 label = (quint64)label_ << 32;
154 // check if we have exactly this format readily cached already
155 QTextCharFormat fmt = cachedFormat(label|ftype);
156 if(fmt.properties().count())
159 mergeFormat(fmt, ftype, label & Q_UINT64_C(0xffff000000000000));
161 for(quint64 mask = Q_UINT64_C(0x0000000100000000); mask <= (quint64)Selected << 32; mask <<=1) {
163 mergeFormat(fmt, ftype, mask | Q_UINT64_C(0xffff000000000000));
166 setCachedFormat(fmt, ftype, label_);
170 void UiStyle::mergeFormat(QTextCharFormat &fmt, quint32 ftype, quint64 label) {
171 mergeSubElementFormat(fmt, ftype & 0x000f, label);
173 // TODO: allow combinations for mirc formats and colors (each), e.g. setting a special format for "bold and italic"
174 // or "foreground 01 and background 03"
175 if((ftype & 0xfff0)) { // element format
176 for(quint32 mask = 0x0010; mask <= 0x2000; mask <<= 1) {
178 mergeSubElementFormat(fmt, mask | 0x0f, label);
183 // Now we handle color codes
184 // We assume that those can't be combined with subelement and message types.
185 if(ftype & 0x00400000)
186 mergeSubElementFormat(fmt, ftype & 0x0f400000, label); // foreground
187 if(ftype & 0x00800000)
188 mergeSubElementFormat(fmt, ftype & 0xf0800000, label); // background
189 if((ftype & 0x00c00000) == 0x00c00000)
190 mergeSubElementFormat(fmt, ftype & 0xffc00000, label); // combination
194 mergeSubElementFormat(fmt, ftype & Url, label);
197 // Merge a subelement format into an existing message format
198 void UiStyle::mergeSubElementFormat(QTextCharFormat& fmt, quint32 ftype, quint64 label) {
199 quint64 key = ftype | label;
200 fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000fffffffffff0))); // label + subelement
201 fmt.merge(cachedFormat(key & Q_UINT64_C(0x0000ffffffffffff))); // label + subelement + msgtype
202 fmt.merge(cachedFormat(key & Q_UINT64_C(0xfffffffffffffff0))); // label + subelement + nickhash
203 fmt.merge(cachedFormat(key & Q_UINT64_C(0xffffffffffffffff))); // label + subelement + nickhash + msgtype
206 UiStyle::FormatType UiStyle::formatType(Message::Type msgType) {
210 case Message::Notice:
212 case Message::Action:
228 case Message::Server:
234 case Message::DayChange:
237 //Q_ASSERT(false); // we need to handle all message types
238 qWarning() << Q_FUNC_INFO << "Unknown message type:" << msgType;
242 UiStyle::FormatType UiStyle::formatType(const QString & code) {
243 if(_formatCodes.contains(code)) return _formatCodes.value(code);
247 QString UiStyle::formatCode(FormatType ftype) {
248 return _formatCodes.key(ftype);
251 QList<QTextLayout::FormatRange> UiStyle::toTextLayoutList(const FormatList &formatList, int textLength, quint32 messageLabel) {
252 QList<QTextLayout::FormatRange> formatRanges;
253 QTextLayout::FormatRange range;
255 for(i = 0; i < formatList.count(); i++) {
256 range.format = format(formatList.at(i).second, messageLabel);
257 range.start = formatList.at(i).first;
258 if(i > 0) formatRanges.last().length = range.start - formatRanges.last().start;
259 formatRanges.append(range);
261 if(i > 0) formatRanges.last().length = textLength - formatRanges.last().start;
265 // This method expects a well-formatted string, there is no error checking!
266 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
267 UiStyle::StyledString UiStyle::styleString(const QString &s_, quint32 baseFormat) {
269 if(s.length() > 65535) {
270 qWarning() << QString("String too long to be styled: %1").arg(s);
271 return StyledString();
274 result.formatList.append(qMakePair((quint16)0, baseFormat));
275 quint32 curfmt = baseFormat;
276 int pos = 0; quint16 length = 0;
278 pos = s.indexOf('%', pos);
280 if(s[pos+1] == '%') { // escaped %, we just remove one and continue
285 if(s[pos+1] == 'D' && s[pos+2] == 'c') { // color code
286 if(s[pos+3] == '-') { // color off
287 curfmt &= 0x003fffff;
290 int color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
291 //TODO: use 99 as transparent color (re mirc color "standard")
293 if(s[pos+3] == 'f') {
294 curfmt &= 0xf0ffffff;
295 curfmt |= (color << 24) | 0x00400000;
297 curfmt &= 0x0fffffff;
298 curfmt |= (color << 28) | 0x00800000;
302 } else if(s[pos+1] == 'O') { // reset formatting
303 curfmt &= 0x0000000f; // we keep message type-specific formatting
305 } else if(s[pos+1] == 'R') { // reverse
306 // TODO: implement reverse formatting
309 } else { // all others are toggles
310 QString code = QString("%") + s[pos+1];
311 if(s[pos+1] == 'D') code += s[pos+2];
312 FormatType ftype = formatType(code);
313 if(ftype == Invalid) {
314 qWarning() << (QString("Invalid format code in string: %1").arg(s));
318 length = code.length();
320 s.remove(pos, length);
321 if(pos == result.formatList.last().first)
322 result.formatList.last().second = curfmt;
324 result.formatList.append(qMakePair((quint16)pos, curfmt));
326 result.plainText = s;
330 QString UiStyle::mircToInternal(const QString &mirc_) {
331 QString mirc = mirc_;
332 mirc.replace('%', "%%"); // escape % just to be sure
333 mirc.replace('\x02', "%B");
334 mirc.replace('\x0f', "%O");
335 mirc.replace('\x12', "%R");
336 mirc.replace('\x16', "%R");
337 mirc.replace('\x1d', "%S");
338 mirc.replace('\x1f', "%U");
340 // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
341 // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
342 // %Dc- turns color off.
343 // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
344 // This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
347 pos = mirc.indexOf('\x03', pos);
348 if(pos < 0) break; // no more mirc color codes
350 int l = mirc.length();
352 // check for fg color
353 if(i < l && mirc[i].isDigit()) {
355 if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
356 else num.prepend('0');
357 ins = QString("%Dcf%1").arg(num);
359 if(i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
362 if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
363 else num.prepend('0');
364 ins += QString("%Dcb%1").arg(num);
369 mirc.replace(pos, i-pos, ins);
374 /***********************************************************************************/
375 UiStyle::StyledMessage::StyledMessage(const Message &msg)
378 if(type() == Message::Plain)
381 _senderHash = 0x00; // this means we never compute the hash for msgs that aren't plain
384 void UiStyle::StyledMessage::style() const {
385 QString user = userFromMask(sender());
386 QString host = hostFromMask(sender());
387 QString nick = nickFromMask(sender());
388 QString txt = UiStyle::mircToInternal(contents());
389 QString bufferName = bufferInfo().bufferName();
390 bufferName.replace('%', "%%"); // well, you _can_ have a % in a buffername apparently... -_-
396 t = tr("%1").arg(txt); break;
397 case Message::Notice:
399 t = tr("%1").arg(txt); break;
400 case Message::Action:
402 t = tr("%DN%1%DN %2").arg(nick).arg(txt);
406 if(nick == contents()) t = tr("You are now known as %DN%1%DN").arg(txt);
407 else t = tr("%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
411 if(nick.isEmpty()) t = tr("User mode: %DM%1%DM").arg(txt);
412 else t = tr("Mode %DM%1%DM by %DN%2%DN").arg(txt, nick);
416 t = tr("%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
419 t = tr("%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
420 if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
424 t = tr("%DN%1%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
425 if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
427 case Message::Kick: {
428 QString victim = txt.section(" ", 0, 0);
429 QString kickmsg = txt.section(" ", 1);
431 t = tr("%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
432 if(!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
435 //case Message::Kill: FIXME
437 case Message::Server:
439 t = tr("%1").arg(txt); break;
442 t = tr("%1").arg(txt); break;
445 t = tr("%1").arg(txt); break;
446 case Message::DayChange:
447 //: Day Change Message
448 t = tr("{Day changed to %1}").arg(timestamp().toString());
451 t = tr("[%1]").arg(txt);
453 _contents = UiStyle::styleString(t, UiStyle::formatType(type()));
456 const QString &UiStyle::StyledMessage::plainContents() const {
457 if(_contents.plainText.isNull())
460 return _contents.plainText;
463 const UiStyle::FormatList &UiStyle::StyledMessage::contentsFormatList() const {
464 if(_contents.plainText.isNull())
467 return _contents.formatList;
470 QString UiStyle::StyledMessage::decoratedTimestamp() const {
471 return timestamp().toLocalTime().toString(UiStyle::timestampFormatString());
474 QString UiStyle::StyledMessage::plainSender() const {
477 case Message::Notice:
478 return nickFromMask(sender());
484 QString UiStyle::StyledMessage::decoratedSender() const {
487 return tr("<%1>").arg(plainSender()); break;
488 case Message::Notice:
489 return tr("[%1]").arg(plainSender()); break;
492 case Message::Server:
493 return tr("*"); break;
495 return tr("*"); break;
497 case Message::Action:
498 return tr("-*-"); break;
500 return tr("<->"); break;
502 return tr("***"); break;
503 >>>>>>> Handle all message types properly in UiStyle; eliminate msgtype format codes
505 return tr("-->"); break;
507 return tr("<--"); break;
509 return tr("<--"); break;
511 return tr("<-*"); break;
513 return tr("<-x"); break;
514 case Message::Server:
515 return tr("*"); break;
517 return tr("*"); break;
519 return tr("*"); break;
520 case Message::DayChange:
521 return tr("-"); break;
523 return tr("%1").arg(plainSender());
527 UiStyle::FormatType UiStyle::StyledMessage::senderFormat() const {
530 // To produce random like but stable nick colorings some sort of hashing should work best.
531 // In this case we just use the qt function qChecksum which produces a
532 // CRC16 hash. This should be fast and 16 bits are more than enough.
534 QString nick = nickFromMask(sender()).toLower();
535 if(!nick.isEmpty()) {
537 while(nick[nick.count() - 1 - chopCount] == '_') {
540 nick.chop(chopCount);
542 quint16 hash = qChecksum(nick.toAscii().data(), nick.toAscii().size());
543 return (UiStyle::FormatType)((((hash % 12) + 1) << 24) + 0x200); // FIXME: amount of sender colors hardwired
545 case Message::Notice:
546 return UiStyle::NoticeMsg; break;
548 case Message::Server:
549 return UiStyle::ServerMsg; break;
551 return UiStyle::ErrorMsg; break;
553 return UiStyle::JoinMsg; break;
555 return UiStyle::PartMsg; break;
557 return UiStyle::QuitMsg; break;
559 return UiStyle::KickMsg; break;
561 return UiStyle::NickMsg; break;
563 return UiStyle::ModeMsg; break;
564 case Message::Action:
565 return UiStyle::ActionMsg; break;
567 return UiStyle::ErrorMsg;
571 // FIXME hardcoded to 16 sender hashes
572 quint8 UiStyle::StyledMessage::senderHash() const {
573 if(_senderHash != 0xff)
576 QString nick = nickFromMask(sender()).toLower();
577 if(!nick.isEmpty()) {
579 while(nick.at(nick.count() - 1 - chopCount) == '_')
581 nick.chop(chopCount);
583 quint16 hash = qChecksum(nick.toAscii().data(), nick.toAscii().size());
584 return (_senderHash = (hash & 0xf) + 1);
587 /***********************************************************************************/
589 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList) {
590 out << formatList.count();
591 UiStyle::FormatList::const_iterator it = formatList.begin();
592 while(it != formatList.end()) {
593 out << (*it).first << (*it).second;
599 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList) {
602 for(quint16 i = 0; i < cnt; i++) {
603 quint16 pos; quint32 ftype;
605 formatList.append(qMakePair((quint16)pos, ftype));