1 /***************************************************************************
2 * Copyright (C) 2005-08 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>
23 #include "uistylesettings.h"
26 UiStyle::UiStyle(const QString &settingsKey) : _settingsKey(settingsKey) {
27 // register FormatList if that hasn't happened yet
28 // FIXME I don't think this actually avoids double registration... then again... does it hurt?
29 if(QVariant::nameToType("UiStyle::FormatList") == QVariant::Invalid) {
30 qRegisterMetaType<FormatList>("UiStyle::FormatList");
31 qRegisterMetaTypeStreamOperators<FormatList>("UiStyle::FormatList");
32 Q_ASSERT(QVariant::nameToType("UiStyle::FormatList") != QVariant::Invalid);
35 _defaultFont = QFont("Monospace", QApplication::font().pointSize());
38 _defaultPlainFormat.setForeground(QBrush("#000000"));
39 _defaultPlainFormat.setFont(_defaultFont);
40 _defaultPlainFormat.font().setFixedPitch(true);
41 _defaultPlainFormat.font().setStyleHint(QFont::TypeWriter);
42 setFormat(None, _defaultPlainFormat, Settings::Default);
44 // Load saved custom formats
45 UiStyleSettings s(_settingsKey);
46 foreach(FormatType type, s.availableFormats()) {
47 _customFormats[type] = s.customFormat(type);
50 // Initialize color codes according to mIRC "standard"
52 //colors << "white" << "black" << "navy" << "green" << "red" << "maroon" << "purple" << "orange";
53 //colors << "yellow" << "lime" << "teal" << "aqua" << "royalblue" << "fuchsia" << "grey" << "silver";
54 colors << "#ffffff" << "#000000" << "#000080" << "#008000" << "#ff0000" << "#800000" << "#800080" << "#ffa500";
55 colors << "#ffff00" << "#00ff00" << "#008080" << "#00ffff" << "#4169E1" << "#ff00ff" << "#808080" << "#c0c0c0";
57 // Now initialize the mapping between FormatCodes and FormatTypes...
58 _formatCodes["%O"] = None;
59 _formatCodes["%B"] = Bold;
60 _formatCodes["%S"] = Italic;
61 _formatCodes["%U"] = Underline;
62 _formatCodes["%R"] = Reverse;
64 _formatCodes["%D0"] = PlainMsg;
65 _formatCodes["%Dn"] = NoticeMsg;
66 _formatCodes["%Ds"] = ServerMsg;
67 _formatCodes["%De"] = ErrorMsg;
68 _formatCodes["%Dj"] = JoinMsg;
69 _formatCodes["%Dp"] = PartMsg;
70 _formatCodes["%Dq"] = QuitMsg;
71 _formatCodes["%Dk"] = KickMsg;
72 _formatCodes["%Dr"] = RenameMsg;
73 _formatCodes["%Dm"] = ModeMsg;
74 _formatCodes["%Da"] = ActionMsg;
76 _formatCodes["%DT"] = Timestamp;
77 _formatCodes["%DS"] = Sender;
78 _formatCodes["%DN"] = Nick;
79 _formatCodes["%DH"] = Hostmask;
80 _formatCodes["%DC"] = ChannelName;
81 _formatCodes["%DM"] = ModeFlags;
82 _formatCodes["%DU"] = Url;
85 for(int i = 0; i < 16; i++) {
86 QString idx = QString("%1").arg(i, (int)2, (int)10, (QChar)'0');
87 _formatCodes[QString("%Dcf%1").arg(idx)] = (FormatType)(FgCol00 + i);
88 _formatCodes[QString("%Dcb%1").arg(idx)] = (FormatType)(BgCol00 + i);
89 QTextCharFormat fgf, bgf;
90 fgf.setForeground(QBrush(QColor(colors[i]))); setFormat((FormatType)(FgCol00 + i), fgf, Settings::Default);
91 bgf.setBackground(QBrush(QColor(colors[i]))); setFormat((FormatType)(BgCol00 + i), bgf, Settings::Default);
94 // Set a few more standard formats
95 QTextCharFormat bold; bold.setFontWeight(QFont::Bold);
96 setFormat(Bold, bold, Settings::Default);
98 QTextCharFormat italic; italic.setFontItalic(true);
99 setFormat(Italic, italic, Settings::Default);
101 QTextCharFormat underline; underline.setFontUnderline(true);
102 setFormat(Underline, underline, Settings::Default);
104 // All other formats should be defined in derived classes.
107 UiStyle::~ UiStyle() {
108 qDeleteAll(_cachedFontMetrics);
111 void UiStyle::setFormat(FormatType ftype, QTextCharFormat fmt, Settings::Mode mode) {
112 if(mode == Settings::Default) {
113 _defaultFormats[ftype] = fmt;
115 UiStyleSettings s(_settingsKey);
116 if(fmt != _defaultFormats[ftype]) {
117 _customFormats[ftype] = fmt;
118 s.setCustomFormat(ftype, fmt);
120 _customFormats[ftype] = QTextFormat().toCharFormat();
121 s.removeCustomFormat(ftype);
124 // TODO: invalidate only affected cached formats... if that's possible with less overhead than just rebuilding them
125 _cachedFormats.clear();
128 QTextCharFormat UiStyle::format(FormatType ftype, Settings::Mode mode) const {
129 if(mode == Settings::Custom && _customFormats.contains(ftype)) return _customFormats.value(ftype);
130 else return _defaultFormats.value(ftype, QTextCharFormat());
133 // NOTE: This function is intimately tied to the values in FormatType. Don't change this
134 // until you _really_ know what you do!
135 QTextCharFormat UiStyle::mergedFormat(quint32 ftype) {
136 if(_cachedFormats.contains(ftype)) return _cachedFormats.value(ftype);
137 if(ftype == Invalid) return QTextCharFormat();
138 // Now we construct the merged format, starting with the default
139 QTextCharFormat fmt = format(None);
140 // First: general message format
141 fmt.merge(format((FormatType)(ftype & 0x0f)));
142 // now more specific ones
143 for(quint32 mask = 0x0010; mask <= 0x2000; mask <<= 1) {
144 if(ftype & mask) fmt.merge(format((FormatType)mask));
147 if(ftype & 0x00400000) fmt.merge(format((FormatType)(ftype & 0x0f400000))); // foreground
148 if(ftype & 0x00800000) fmt.merge(format((FormatType)(ftype & 0xf0800000))); // background
150 if(ftype & Url) fmt.merge(format(Url));
151 return _cachedFormats[ftype] = fmt;
154 QFontMetricsF *UiStyle::fontMetrics(quint32 ftype) {
155 // QFontMetricsF is not assignable, so we need to store pointers :/
156 if(_cachedFontMetrics.contains(ftype)) return _cachedFontMetrics.value(ftype);
157 return (_cachedFontMetrics[ftype] = new QFontMetricsF(mergedFormat(ftype).font()));
160 UiStyle::FormatType UiStyle::formatType(const QString & code) const {
161 if(_formatCodes.contains(code)) return _formatCodes.value(code);
165 QString UiStyle::formatCode(FormatType ftype) const {
166 return _formatCodes.key(ftype);
169 // This method expects a well-formatted string, there is no error checking!
170 // Since we create those ourselves, we should be pretty safe that nobody does something crappy here.
171 UiStyle::StyledString UiStyle::styleString(const QString &s_) {
173 if(s.length() > 65535) {
174 qWarning() << QString("String too long to be styled: %1").arg(s);
175 return StyledString();
178 result.formatList.append(qMakePair((quint16)0, (quint32)None));
179 quint32 curfmt = (quint32)None;
180 int pos = 0; quint16 length = 0;
182 int pos = s.indexOf('%', pos);
184 if(s[pos+1] == '%') { // escaped %, we just remove one and continue
189 if(s[pos+1] == 'D' && s[pos+2] == 'c') { // color code
190 if(s[pos+3] == '-') { // color off
191 curfmt &= 0x003fffff;
194 int color = 10 * s[pos+4].digitValue() + s[pos+5].digitValue();
195 //TODO: use 99 as transparent color (re mirc color "standard")
198 curfmt |= (color << 24) | 0x00400000;
200 curfmt |= (color << 28) | 0x00800000;
203 } else if(s[pos+1] == 'O') { // reset formatting
204 curfmt &= 0x0000000f; // we keep message type-specific formatting
206 } else if(s[pos+1] == 'R') { // reverse
207 // TODO: implement reverse formatting
210 } else { // all others are toggles
211 QString code = QString("%") + s[pos+1];
212 if(s[pos+1] == 'D') code += s[pos+2];
213 FormatType ftype = formatType(code);
214 if(ftype == Invalid) {
215 qWarning(qPrintable(QString("Invalid format code in string: %1").arg(s)));
219 length = code.length();
221 s.remove(pos, length);
222 if(pos == result.formatList.last().first)
223 result.formatList.last().second = curfmt;
225 result.formatList.append(qMakePair((quint16)pos, curfmt));
227 result.plainText = s;
231 QString UiStyle::mircToInternal(const QString &mirc_) {
232 QString mirc = mirc_;
233 mirc.replace('%', "%%"); // escape % just to be sure
234 mirc.replace('\x02', "%B");
235 mirc.replace('\x0f', "%O");
236 mirc.replace('\x12', "%R");
237 mirc.replace('\x16', "%R");
238 mirc.replace('\x1d', "%S");
239 mirc.replace('\x1f', "%U");
241 // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
242 // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
243 // %Dc- turns color off.
244 // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
245 // This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
248 pos = mirc.indexOf('\x03', pos);
249 if(pos < 0) break; // no more mirc color codes
251 int l = mirc.length();
253 // check for fg color
254 if(i < l && mirc[i].isDigit()) {
256 if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
257 else num.prepend('0');
258 ins = QString("%Dcf%1").arg(num);
260 if(i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
263 if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
264 else num.prepend('0');
265 ins += QString("%Dcb%1").arg(num);
270 mirc.replace(pos, i-pos, ins);
275 UiStyle::StyledMessage UiStyle::styleMessage(const Message &msg) {
276 QString user = userFromMask(msg.sender());
277 QString host = hostFromMask(msg.sender());
278 QString nick = nickFromMask(msg.sender());
279 QString txt = mircToInternal(msg.contents());
280 QString bufferName = msg.bufferInfo().bufferName();
282 StyledMessage result;
284 result.timestamp = styleString(tr("%DT[%1]").arg(msg.timestamp().toLocalTime().toString("hh:mm:ss")));
289 s = tr("%DS<%1>").arg(nick); t = tr("%D0%1").arg(txt); break;
290 case Message::Notice:
291 s = tr("%Dn[%1]").arg(nick); t = tr("%Dn%1").arg(txt); break;
292 case Message::Server:
293 s = tr("%Ds*"); t = tr("%Ds%1").arg(txt); break;
295 s = tr("%De*"); t = tr("%De%1").arg(txt); break;
297 s = tr("%Dj-->"); t = tr("%Dj%DN%1%DN %DH(%2@%3)%DH has joined %DC%4%DC").arg(nick, user, host, bufferName); break;
299 s = tr("%Dp<--"); t = tr("%Dp%DN%1%DN %DH(%2@%3)%DH has left %DC%4%DC").arg(nick, user, host, bufferName);
300 if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
303 s = tr("%Dq<--"); t = tr("%Dq%DN%DU%1%DU%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
304 if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
308 QString victim = txt.section(" ", 0, 0);
309 //if(victim == ui.ownNick->currentText()) victim = tr("you");
310 QString kickmsg = txt.section(" ", 1);
311 t = tr("%Dk%DN%1%DN has kicked %DN%2%DN from %DC%3%DC").arg(nick).arg(victim).arg(bufferName);
312 if(!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
317 if(nick == msg.contents()) t = tr("%DrYou are now known as %DN%1%DN").arg(txt);
318 else t = tr("%Dr%DN%1%DN is now known as %DN%2%DN").arg(nick, txt);
322 if(nick.isEmpty()) t = tr("%DmUser mode: %DM%1%DM").arg(txt);
323 else t = tr("%DmMode %DM%1%DM by %DN%2%DN").arg(txt, nick);
325 case Message::Action:
327 t = tr("%Da%DN%1%DN %2").arg(nick).arg(txt);
330 s = tr("%De%1").arg(msg.sender());
331 t = tr("%De[%1]").arg(txt);
333 result.sender = styleString(s);
334 result.contents = styleString(t);
338 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList) {
339 out << formatList.count();
340 UiStyle::FormatList::const_iterator it = formatList.begin();
341 while(it != formatList.end()) {
342 out << (*it).first << (*it).second;
348 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList) {
351 for(quint16 i = 0; i < cnt; i++) {
352 quint16 pos; quint32 ftype;
354 formatList.append(qMakePair((quint16)pos, ftype));