Handle all message types properly in UiStyle; eliminate msgtype format codes
[quassel.git] / src / uisupport / qssparser.cpp
1 /***************************************************************************
2 *   Copyright (C) 2005-09 by the Quassel Project                          *
3 *   devel@quassel-irc.org                                                 *
4 *                                                                         *
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.                                           *
9 *                                                                         *
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.                          *
14 *                                                                         *
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
21 #include <QApplication>
22
23 #include "qssparser.h"
24
25 QssParser::QssParser()
26 : _maxSenderHash(0)
27 {
28   _palette = QApplication::palette();
29
30   // Init palette color roles
31   _paletteColorRoles["alternate-base"] = QPalette::AlternateBase;
32   _paletteColorRoles["background"] = QPalette::Background;
33   _paletteColorRoles["base"] = QPalette::Base;
34   _paletteColorRoles["bright-text"] = QPalette::BrightText;
35   _paletteColorRoles["button"] = QPalette::Button;
36   _paletteColorRoles["button-text"] = QPalette::ButtonText;
37   _paletteColorRoles["dark"] = QPalette::Dark;
38   _paletteColorRoles["foreground"] = QPalette::Foreground;
39   _paletteColorRoles["highlight"] = QPalette::Highlight;
40   _paletteColorRoles["highlighted-text"] = QPalette::HighlightedText;
41   _paletteColorRoles["light"] = QPalette::Light;
42   _paletteColorRoles["link"] = QPalette::Link;
43   _paletteColorRoles["link-visited"] = QPalette::LinkVisited;
44   _paletteColorRoles["mid"] = QPalette::Mid;
45   _paletteColorRoles["midlight"] = QPalette::Midlight;
46   _paletteColorRoles["shadow"] = QPalette::Shadow;
47   _paletteColorRoles["text"] = QPalette::Text;
48   _paletteColorRoles["tooltip-base"] = QPalette::ToolTipBase;
49   _paletteColorRoles["tooltip-text"] = QPalette::ToolTipText;
50   _paletteColorRoles["window"] = QPalette::Window;
51   _paletteColorRoles["window-text"] = QPalette::WindowText;
52 }
53
54 void QssParser::loadStyleSheet(const QString &styleSheet) {
55   QString ss = styleSheet;
56   ss = "file:////home/sputnick/devel/quassel/test.qss"; // FIXME
57   if(ss.startsWith("file:///")) {
58     ss.remove(0, 8);
59     QFile file(ss);
60     if(file.open(QFile::ReadOnly)) {
61       QTextStream stream(&file);
62       ss = stream.readAll();
63     } else {
64       qWarning() << tr("Could not read stylesheet \"%1\"!").arg(file.fileName());
65       return;
66     }
67   }
68   if(ss.isEmpty())
69     return;
70
71   // Now we have the stylesheet itself in ss, start parsing
72   // Palette definitions first, so we can apply roles later on
73   QRegExp paletterx("(Palette[^{]*)\\{([^}]+)\\}");
74   int pos = 0;
75   while((pos = paletterx.indexIn(ss, pos)) >= 0) {
76     parsePaletteData(paletterx.cap(1).trimmed(), paletterx.cap(2).trimmed());
77     pos += paletterx.matchedLength();
78   }
79
80   // Now we can parse the rest of our custom blocks
81   QRegExp blockrx("((?:ChatLine|BufferList|NickList|TreeView)[^{]*)\\{([^}]+)\\}");
82   pos = 0;
83   while((pos = blockrx.indexIn(ss, pos)) >= 0) {
84     //qDebug() << blockrx.cap(1) << blockrx.cap(2);
85
86     if(blockrx.cap(1).startsWith("ChatLine"))
87       parseChatLineData(blockrx.cap(1).trimmed(), blockrx.cap(2).trimmed());
88     //else
89     // TODO: add moar here
90
91     pos += blockrx.matchedLength();
92   }
93
94 }
95
96 void QssParser::parseChatLineData(const QString &decl, const QString &contents) {
97   quint64 fmtType = parseFormatType(decl);
98   if(fmtType == UiStyle::Invalid)
99     return;
100
101   QTextCharFormat format;
102
103   foreach(QString line, contents.split(';', QString::SkipEmptyParts)) {
104     int idx = line.indexOf(':');
105     if(idx <= 0) {
106       qWarning() << Q_FUNC_INFO << tr("Invalid property declaration: %1").arg(line.trimmed());
107       continue;
108     }
109     QString property = line.left(idx).trimmed();
110     QString value = line.mid(idx + 1).simplified();
111
112     if(property == "background" || property == "background-color")
113       format.setBackground(parseBrush(value));
114     else if(property == "foreground" || property == "color")
115       format.setForeground(parseBrush(value));
116
117     // font-related properties
118     else if(property.startsWith("font")) {
119       bool ok;
120       QFont font = format.font();
121       if(property == "font")
122         ok = parseFont(value, &font);
123       else if(property == "font-style")
124         ok = parseFontStyle(value, &font);
125       else if(property == "font-weight")
126         ok = parseFontWeight(value, &font);
127       else if(property == "font-size")
128         ok = parseFontSize(value, &font);
129       else if(property == "font-family")
130         ok = parseFontFamily(value, &font);
131       else {
132         qWarning() << Q_FUNC_INFO << tr("Invalid font property: %1").arg(line);
133         continue;
134       }
135       if(ok)
136         format.setFont(font);
137     }
138
139     else {
140       qWarning() << Q_FUNC_INFO << tr("Unknown ChatLine property: %1").arg(property);
141     }
142   }
143
144   _formats[fmtType] = format;
145 }
146
147 quint64 QssParser::parseFormatType(const QString &decl) {
148   QRegExp rx("ChatLine(?:::(\\w+))?(?:#(\\w+))?(?:\\[([=-,\\\"\\w\\s]+)\\])?\\s*");
149   // $1: subelement; $2: msgtype; $3: conditionals
150   if(!rx.exactMatch(decl)) {
151     qWarning() << Q_FUNC_INFO << tr("Invalid block declaration: %1").arg(decl);
152     return UiStyle::Invalid;
153   }
154   QString subElement = rx.cap(1);
155   QString msgType = rx.cap(2);
156   QString conditions = rx.cap(3);
157
158   quint64 fmtType = 0;
159
160   // First determine the subelement
161   if(!subElement.isEmpty()) {
162     if(subElement == "timestamp")
163       fmtType |= UiStyle::Timestamp;
164     else if(subElement == "sender")
165       fmtType |= UiStyle::Sender;
166     else if(subElement == "nick")
167       fmtType |= UiStyle::Nick;
168     else if(subElement == "hostmask")
169       fmtType |= UiStyle::Hostmask;
170     else if(subElement == "modeflags")
171       fmtType |= UiStyle::ModeFlags;
172     else {
173       qWarning() << Q_FUNC_INFO << tr("Invalid subelement name in %1").arg(decl);
174       return UiStyle::Invalid;
175     }
176   }
177
178   // Now, figure out the message type
179   if(!msgType.isEmpty()) {
180     if(msgType == "plain")
181       fmtType |= UiStyle::PlainMsg;
182     else if(msgType == "notice")
183       fmtType |= UiStyle::NoticeMsg;
184     else if(msgType == "action")
185       fmtType |= UiStyle::ActionMsg;
186     else if(msgType == "nick")
187       fmtType |= UiStyle::NickMsg;
188     else if(msgType == "mode")
189       fmtType |= UiStyle::ModeMsg;
190     else if(msgType == "join")
191       fmtType |= UiStyle::JoinMsg;
192     else if(msgType == "part")
193       fmtType |= UiStyle::PartMsg;
194     else if(msgType == "quit")
195       fmtType |= UiStyle::QuitMsg;
196     else if(msgType == "kick")
197       fmtType |= UiStyle::KickMsg;
198     else if(msgType == "kill")
199       fmtType |= UiStyle::KillMsg;
200     else if(msgType == "server")
201       fmtType |= UiStyle::ServerMsg;
202     else if(msgType == "info")
203       fmtType |= UiStyle::InfoMsg;
204     else if(msgType == "error")
205       fmtType |= UiStyle::ErrorMsg;
206     else if(msgType == "daychange")
207       fmtType |= UiStyle::DayChangeMsg;
208     else {
209       qWarning() << Q_FUNC_INFO << tr("Invalid message type in %1").arg(decl);
210     }
211   }
212
213   // Next up: conditional (formats, labels, nickhash)
214   QRegExp condRx("\\s*(\\w+)\\s*=\\s*\"(\\w+)\"\\s*");
215   if(!conditions.isEmpty()) {
216     foreach(const QString &cond, conditions.split(',', QString::SkipEmptyParts)) {
217       if(!condRx.exactMatch(cond)) {
218         qWarning() << Q_FUNC_INFO << tr("Invalid condition %1").arg(cond);
219         return UiStyle::Invalid;
220       }
221       QString condName = condRx.cap(1);
222       QString condValue = condRx.cap(2);
223       if(condName == "label") {
224         quint64 labeltype = 0;
225         if(condValue == "highlight")
226           labeltype = UiStyle::Highlight;
227         else {
228           qWarning() << Q_FUNC_INFO << tr("Invalid message label: %1").arg(condValue);
229           return UiStyle::Invalid;
230         }
231         fmtType |= (labeltype << 32);
232       } else if(condName == "sender") {
233         if(condValue == "self")
234           fmtType |= (quint64)UiStyle::OwnMsg << 32; // sender="self" is actually treated as a label
235           else {
236             bool ok = true;
237             quint64 val = condValue.toUInt(&ok, 16);
238             if(!ok) {
239               qWarning() << Q_FUNC_INFO << tr("Invalid senderhash specification: %1").arg(condValue);
240               return UiStyle::Invalid;
241             }
242             if(val >= 255) {
243               qWarning() << Q_FUNC_INFO << tr("Senderhash can be at most \"fe\"!");
244               return UiStyle::Invalid;
245             }
246             fmtType |= val << 48;
247           }
248       }
249       // TODO: colors
250     }
251   }
252
253   return fmtType;
254 }
255
256 // Palette { ... } specifies the application palette
257 // ColorGroups can be specified like pseudo states, chaining is OR (contrary to normal CSS handling):
258 //   Palette:inactive:disabled { ... } applies to both the Inactive and the Disabled state
259 void QssParser::parsePaletteData(const QString &decl, const QString &contents) {
260   QList<QPalette::ColorGroup> colorGroups;
261
262   // Check if we want to apply this palette definition for particular ColorGroups
263   QRegExp rx("Palette((:(normal|active|inactive|disabled))*)");
264   if(!rx.exactMatch(decl)) {
265     qWarning() << Q_FUNC_INFO << tr("Invalid block declaration: %1").arg(decl);
266     return;
267   }
268   if(!rx.cap(1).isEmpty()) {
269     QStringList groups = rx.cap(1).split(':', QString::SkipEmptyParts);
270     foreach(QString g, groups) {
271       if((g == "normal" || g == "active") && !colorGroups.contains(QPalette::Active))
272         colorGroups.append(QPalette::Active);
273       else if(g == "inactive" && !colorGroups.contains(QPalette::Inactive))
274         colorGroups.append(QPalette::Inactive);
275       else if(g == "disabled" && !colorGroups.contains(QPalette::Disabled))
276         colorGroups.append(QPalette::Disabled);
277     }
278   }
279
280   // Now let's go through the roles
281   foreach(QString line, contents.split(';', QString::SkipEmptyParts)) {
282     int idx = line.indexOf(':');
283     if(idx <= 0) {
284       qWarning() << Q_FUNC_INFO << tr("Invalid palette role assignment: %1").arg(line.trimmed());
285       continue;
286     }
287     QString rolestr = line.left(idx).trimmed();
288     QString brushstr = line.mid(idx + 1).trimmed();
289     if(!_paletteColorRoles.contains(rolestr)) {
290       qWarning() << Q_FUNC_INFO << tr("Unknown palette role name: %1").arg(rolestr);
291       continue;
292     }
293     QBrush brush = parseBrush(brushstr);
294     if(colorGroups.count()) {
295       foreach(QPalette::ColorGroup group, colorGroups)
296         _palette.setBrush(group, _paletteColorRoles.value(rolestr), brush);
297     } else
298       _palette.setBrush(_paletteColorRoles.value(rolestr), brush);
299   }
300 }
301
302 QBrush QssParser::parseBrush(const QString &str, bool *ok) {
303   if(ok)
304     *ok = false;
305   QColor c = parseColor(str);
306   if(c.isValid()) {
307     if(ok)
308       *ok = true;
309     return QBrush(c);
310   }
311
312   if(str.startsWith("palette")) { // Palette color role
313     QRegExp rx("palette\\s*\\(\\s*([a-z-]+)\\s*\\)");
314     if(!rx.exactMatch(str)) {
315       qWarning() << Q_FUNC_INFO << tr("Invalid palette color role specification: %1").arg(str);
316       return QBrush();
317     }
318     if(!_paletteColorRoles.contains(rx.cap(1))) {
319       qWarning() << Q_FUNC_INFO << tr("Unknown palette color role: %1").arg(rx.cap(1));
320       return QBrush();
321     }
322     return QBrush(_palette.brush(_paletteColorRoles.value(rx.cap(1))));
323
324   } else if(str.startsWith("qlineargradient")) {
325     static QString rxFloat("\\s*(-?\\s*[0-9]*\\.?[0-9]+)\\s*");
326     QRegExp rx(QString("qlineargradient\\s*\\(\\s*x1:%1,\\s*y1:%1,\\s*x2:%1,\\s*y2:%1,(.+)\\)").arg(rxFloat));
327     if(!rx.exactMatch(str)) {
328       qWarning() << Q_FUNC_INFO << tr("Invalid gradient declaration: %1").arg(str);
329       return QBrush();
330     }
331     qreal x1 = rx.cap(1).toDouble();
332     qreal y1 = rx.cap(2).toDouble();
333     qreal x2 = rx.cap(3).toDouble();
334     qreal y2 = rx.cap(4).toDouble();
335     QGradientStops stops = parseGradientStops(rx.cap(5).trimmed());
336     if(!stops.count()) {
337       qWarning() << Q_FUNC_INFO << tr("Invalid gradient stops list: %1").arg(str);
338       return QBrush();
339     }
340     QLinearGradient gradient(x1, y1, x2, y2);
341     gradient.setStops(stops);
342     if(ok)
343       *ok = true;
344     return QBrush(gradient);
345
346   } else if(str.startsWith("qconicalgradient")) {
347     static QString rxFloat("\\s*(-?\\s*[0-9]*\\.?[0-9]+)\\s*");
348     QRegExp rx(QString("qconicalgradient\\s*\\(\\s*cx:%1,\\s*cy:%1,\\s*angle:%1,(.+)\\)").arg(rxFloat));
349     if(!rx.exactMatch(str)) {
350       qWarning() << Q_FUNC_INFO << tr("Invalid gradient declaration: %1").arg(str);
351       return QBrush();
352     }
353     qreal cx = rx.cap(1).toDouble();
354     qreal cy = rx.cap(2).toDouble();
355     qreal angle = rx.cap(3).toDouble();
356     QGradientStops stops = parseGradientStops(rx.cap(4).trimmed());
357     if(!stops.count()) {
358       qWarning() << Q_FUNC_INFO << tr("Invalid gradient stops list: %1").arg(str);
359       return QBrush();
360     }
361     QConicalGradient gradient(cx, cy, angle);
362     gradient.setStops(stops);
363     if(ok)
364       *ok = true;
365     return QBrush(gradient);
366
367   } else if(str.startsWith("qradialgradient")) {
368     static QString rxFloat("\\s*(-?\\s*[0-9]*\\.?[0-9]+)\\s*");
369     QRegExp rx(QString("qradialgradient\\s*\\(\\s*cx:%1,\\s*cy:%1,\\s*radius:%1,\\s*fx:%1,\\s*fy:%1,(.+)\\)").arg(rxFloat));
370     if(!rx.exactMatch(str)) {
371       qWarning() << Q_FUNC_INFO << tr("Invalid gradient declaration: %1").arg(str);
372       return QBrush();
373     }
374     qreal cx = rx.cap(1).toDouble();
375     qreal cy = rx.cap(2).toDouble();
376     qreal radius = rx.cap(3).toDouble();
377     qreal fx = rx.cap(4).toDouble();
378     qreal fy = rx.cap(5).toDouble();
379     QGradientStops stops = parseGradientStops(rx.cap(6).trimmed());
380     if(!stops.count()) {
381       qWarning() << Q_FUNC_INFO << tr("Invalid gradient stops list: %1").arg(str);
382       return QBrush();
383     }
384     QRadialGradient gradient(cx, cy, radius, fx, fy);
385     gradient.setStops(stops);
386     if(ok)
387       *ok = true;
388     return QBrush(gradient);
389   }
390
391   return QBrush();
392 }
393
394 QColor QssParser::parseColor(const QString &str) {
395   if(str.startsWith("rgba")) {
396     ColorTuple tuple = parseColorTuple(str.mid(4));
397     if(tuple.count() == 4)
398       return QColor(tuple.at(0), tuple.at(1), tuple.at(2), tuple.at(3));
399   } else if(str.startsWith("rgb")) {
400     ColorTuple tuple = parseColorTuple(str.mid(3));
401     if(tuple.count() == 3)
402       return QColor(tuple.at(0), tuple.at(1), tuple.at(2));
403   } else if(str.startsWith("hsva")) {
404     ColorTuple tuple = parseColorTuple(str.mid(4));
405     if(tuple.count() == 4) {
406       QColor c;
407       c.setHsvF(tuple.at(0), tuple.at(1), tuple.at(2), tuple.at(3));
408       return c;
409     }
410   } else if(str.startsWith("hsv")) {
411     ColorTuple tuple = parseColorTuple(str.mid(3));
412     if(tuple.count() == 3) {
413       QColor c;
414       c.setHsvF(tuple.at(0), tuple.at(1), tuple.at(2));
415       return c;
416     }
417   } else {
418     QRegExp rx("#?[0-9A-Fa-z]+");
419     if(rx.exactMatch(str))
420       return QColor(str);
421   }
422   return QColor();
423 }
424
425 // get a list of comma-separated int values or percentages (rel to 0-255)
426 QssParser::ColorTuple QssParser::parseColorTuple(const QString &str) {
427   ColorTuple result;
428   QRegExp rx("\\(((\\s*[0-9]{1,3}%?\\s*)(,\\s*[0-9]{1,3}%?\\s*)*)\\)");
429   if(!rx.exactMatch(str.trimmed())) {
430     return ColorTuple();
431   }
432   QStringList values = rx.cap(1).split(',');
433   foreach(QString v, values) {
434     qreal val;
435     bool perc = false;
436     bool ok;
437     v = v.trimmed();
438     if(v.endsWith('%')) {
439       perc = true;
440       v.chop(1);
441     }
442     val = (qreal)v.toUInt(&ok);
443     if(!ok)
444       return ColorTuple();
445     if(perc)
446       val = 255 * val/100;
447     result.append(val);
448   }
449   return result;
450 }
451
452 QGradientStops QssParser::parseGradientStops(const QString &str_) {
453   QString str = str_;
454   QGradientStops result;
455   static QString rxFloat("(0?\\.[0-9]+|[01])"); // values between 0 and 1
456   QRegExp rx(QString("\\s*,?\\s*stop:\\s*(%1)\\s+([^:]+)(,\\s*stop:|$)").arg(rxFloat));
457   int idx;
458   while((idx = rx.indexIn(str)) == 0) {
459     qreal x = rx.cap(1).toDouble();
460     QColor c = parseColor(rx.cap(3));
461     if(!c.isValid())
462       return QGradientStops();
463     result << QGradientStop(x, c);
464     str.remove(0, rx.matchedLength() - rx.cap(4).length());
465   }
466   if(!str.trimmed().isEmpty())
467     return QGradientStops();
468
469   return result;
470 }
471
472 /******** Font Properties ********/
473
474 bool QssParser::parseFont(const QString &value, QFont *font) {
475   QRegExp rx("((?:(?:normal|italic|oblique|bold|100|200|300|400|500|600|700|800|900) ){0,2}) ?(\\d+)(pt|px)? \"(.*)\"");
476   if(!rx.exactMatch(value)) {
477     qWarning() << Q_FUNC_INFO << tr("Invalid font specification: %1").arg(value);
478     return false;
479   }
480   font->setStyle(QFont::StyleNormal);
481   font->setWeight(QFont::Normal);
482   QStringList proplist = rx.cap(1).split(' ', QString::SkipEmptyParts);
483   foreach(QString prop, proplist) {
484     if(prop == "italic")
485       font->setStyle(QFont::StyleItalic);
486     else if(prop == "oblique")
487       font->setStyle(QFont::StyleOblique);
488     else if(prop == "bold")
489       font->setWeight(QFont::Bold);
490     else { // number
491       int w = prop.toInt();
492       font->setWeight(qMin(w / 8, 99)); // taken from Qt's qss parser
493     }
494   }
495
496   if(rx.cap(3) == "px")
497     font->setPixelSize(rx.cap(2).toInt());
498   else
499     font->setPointSize(rx.cap(2).toInt());
500
501   font->setFamily(rx.cap(4));
502   return true;
503 }
504
505 bool QssParser::parseFontStyle(const QString &value, QFont *font) {
506   if(value == "normal")
507     font->setStyle(QFont::StyleNormal);
508   else if(value == "italic")
509     font->setStyle(QFont::StyleItalic);
510   else if(value == "oblique")
511     font->setStyle(QFont::StyleOblique);
512   else {
513     qWarning() << Q_FUNC_INFO << tr("Invalid font style specification: %1").arg(value);
514     return false;
515   }
516   return true;
517 }
518
519 bool QssParser::parseFontWeight(const QString &value, QFont *font) {
520   if(value == "normal")
521     font->setWeight(QFont::Normal);
522   else if(value == "bold")
523     font->setWeight(QFont::Bold);
524   else {
525     bool ok;
526     int w = value.toInt(&ok);
527     if(!ok) {
528       qWarning() << Q_FUNC_INFO << tr("Invalid font weight specification: %1").arg(value);
529       return false;
530     }
531     font->setWeight(qMin(w / 8, 99)); // taken from Qt's qss parser
532   }
533   return true;
534 }
535
536 bool QssParser::parseFontSize(const QString &value, QFont *font) {
537   QRegExp rx("\\(d+)(pt|px)");
538   if(!rx.exactMatch(value)) {
539     qWarning() << Q_FUNC_INFO << tr("Invalid font size specification: %1").arg(value);
540     return false;
541   }
542   if(rx.cap(2) == "px")
543     font->setPixelSize(rx.cap(1).toInt());
544   else
545     font->setPointSize(rx.cap(1).toInt());
546   return true;
547 }
548
549 bool QssParser::parseFontFamily(const QString &value, QFont *font) {
550   QString family = value;
551   if(family.startsWith('"') && family.endsWith('"')) {
552     family = family.mid(1, family.length() -2);
553   }
554   font->setFamily(family);
555   return true;
556 }