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