Merge all stylesheet formats with the base format
[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 if(condValue == "selected")
216           labeltype = UiStyle::Selected;
217         else {
218           qWarning() << Q_FUNC_INFO << tr("Invalid message label: %1").arg(condValue);
219           return UiStyle::Invalid;
220         }
221         fmtType |= (labeltype << 32);
222       } else if(condName == "sender") {
223         if(condValue == "self")
224           fmtType |= (quint64)UiStyle::OwnMsg << 32; // sender="self" is actually treated as a label
225           else {
226             bool ok = true;
227             quint64 val = condValue.toUInt(&ok, 16);
228             if(!ok) {
229               qWarning() << Q_FUNC_INFO << tr("Invalid senderhash specification: %1").arg(condValue);
230               return UiStyle::Invalid;
231             }
232             if(val >= 16) {
233               qWarning() << Q_FUNC_INFO << tr("Senderhash can be at most \"0x0f\"!");
234               return UiStyle::Invalid;
235             }
236             fmtType |= val << 48;
237           }
238       } else if(condName == "format") {
239         if(condValue == "bold")
240           fmtType |= UiStyle::Bold;
241         else if(condValue == "italic")
242           fmtType |= UiStyle::Italic;
243         else if(condValue == "underline")
244           fmtType |= UiStyle::Underline;
245         else if(condValue == "reverse")
246           fmtType |= UiStyle::Reverse;
247         else {
248           qWarning() << Q_FUNC_INFO << tr("Invalid format name: %1").arg(condValue);
249           return UiStyle::Invalid;
250         }
251       } else if(condName == "fg-color" || condName == "bg-color") {
252         bool ok;
253         quint8 col = condValue.toUInt(&ok, 16);
254         if(!ok || col > 0x0f) {
255           qWarning() << Q_FUNC_INFO << tr("Illegal IRC color specification (must be between 00 and 0f): %1").arg(condValue);
256           return UiStyle::Invalid;
257         }
258         if(condName == "fg-color")
259           fmtType |= 0x00400000 | (col << 24);
260         else
261           fmtType |= 0x00800000 | (col << 28);
262       } else {
263         qWarning() << Q_FUNC_INFO << tr("Unhandled condition: %1").arg(condName);
264         return UiStyle::Invalid;
265       }
266     }
267   }
268
269   return fmtType;
270 }
271
272 // Palette { ... } specifies the application palette
273 // ColorGroups can be specified like pseudo states, chaining is OR (contrary to normal CSS handling):
274 //   Palette:inactive:disabled { ... } applies to both the Inactive and the Disabled state
275 void QssParser::parsePaletteData(const QString &decl, const QString &contents) {
276   QList<QPalette::ColorGroup> colorGroups;
277
278   // Check if we want to apply this palette definition for particular ColorGroups
279   QRegExp rx("Palette((:(normal|active|inactive|disabled))*)");
280   if(!rx.exactMatch(decl)) {
281     qWarning() << Q_FUNC_INFO << tr("Invalid block declaration: %1").arg(decl);
282     return;
283   }
284   if(!rx.cap(1).isEmpty()) {
285     QStringList groups = rx.cap(1).split(':', QString::SkipEmptyParts);
286     foreach(QString g, groups) {
287       if((g == "normal" || g == "active") && !colorGroups.contains(QPalette::Active))
288         colorGroups.append(QPalette::Active);
289       else if(g == "inactive" && !colorGroups.contains(QPalette::Inactive))
290         colorGroups.append(QPalette::Inactive);
291       else if(g == "disabled" && !colorGroups.contains(QPalette::Disabled))
292         colorGroups.append(QPalette::Disabled);
293     }
294   }
295
296   // Now let's go through the roles
297   foreach(QString line, contents.split(';', QString::SkipEmptyParts)) {
298     int idx = line.indexOf(':');
299     if(idx <= 0) {
300       qWarning() << Q_FUNC_INFO << tr("Invalid palette role assignment: %1").arg(line.trimmed());
301       continue;
302     }
303     QString rolestr = line.left(idx).trimmed();
304     QString brushstr = line.mid(idx + 1).trimmed();
305     if(!_paletteColorRoles.contains(rolestr)) {
306       qWarning() << Q_FUNC_INFO << tr("Unknown palette role name: %1").arg(rolestr);
307       continue;
308     }
309     QBrush brush = parseBrush(brushstr);
310     if(colorGroups.count()) {
311       foreach(QPalette::ColorGroup group, colorGroups)
312         _palette.setBrush(group, _paletteColorRoles.value(rolestr), brush);
313     } else
314       _palette.setBrush(_paletteColorRoles.value(rolestr), brush);
315   }
316 }
317
318 QBrush QssParser::parseBrush(const QString &str, bool *ok) {
319   if(ok)
320     *ok = false;
321   QColor c = parseColor(str);
322   if(c.isValid()) {
323     if(ok)
324       *ok = true;
325     return QBrush(c);
326   }
327
328   if(str.startsWith("palette")) { // Palette color role
329     QRegExp rx("palette\\s*\\(\\s*([a-z-]+)\\s*\\)");
330     if(!rx.exactMatch(str)) {
331       qWarning() << Q_FUNC_INFO << tr("Invalid palette color role specification: %1").arg(str);
332       return QBrush();
333     }
334     if(!_paletteColorRoles.contains(rx.cap(1))) {
335       qWarning() << Q_FUNC_INFO << tr("Unknown palette color role: %1").arg(rx.cap(1));
336       return QBrush();
337     }
338     return QBrush(_palette.brush(_paletteColorRoles.value(rx.cap(1))));
339
340   } else if(str.startsWith("qlineargradient")) {
341     static QString rxFloat("\\s*(-?\\s*[0-9]*\\.?[0-9]+)\\s*");
342     QRegExp rx(QString("qlineargradient\\s*\\(\\s*x1:%1,\\s*y1:%1,\\s*x2:%1,\\s*y2:%1,(.+)\\)").arg(rxFloat));
343     if(!rx.exactMatch(str)) {
344       qWarning() << Q_FUNC_INFO << tr("Invalid gradient declaration: %1").arg(str);
345       return QBrush();
346     }
347     qreal x1 = rx.cap(1).toDouble();
348     qreal y1 = rx.cap(2).toDouble();
349     qreal x2 = rx.cap(3).toDouble();
350     qreal y2 = rx.cap(4).toDouble();
351     QGradientStops stops = parseGradientStops(rx.cap(5).trimmed());
352     if(!stops.count()) {
353       qWarning() << Q_FUNC_INFO << tr("Invalid gradient stops list: %1").arg(str);
354       return QBrush();
355     }
356     QLinearGradient gradient(x1, y1, x2, y2);
357     gradient.setStops(stops);
358     if(ok)
359       *ok = true;
360     return QBrush(gradient);
361
362   } else if(str.startsWith("qconicalgradient")) {
363     static QString rxFloat("\\s*(-?\\s*[0-9]*\\.?[0-9]+)\\s*");
364     QRegExp rx(QString("qconicalgradient\\s*\\(\\s*cx:%1,\\s*cy:%1,\\s*angle:%1,(.+)\\)").arg(rxFloat));
365     if(!rx.exactMatch(str)) {
366       qWarning() << Q_FUNC_INFO << tr("Invalid gradient declaration: %1").arg(str);
367       return QBrush();
368     }
369     qreal cx = rx.cap(1).toDouble();
370     qreal cy = rx.cap(2).toDouble();
371     qreal angle = rx.cap(3).toDouble();
372     QGradientStops stops = parseGradientStops(rx.cap(4).trimmed());
373     if(!stops.count()) {
374       qWarning() << Q_FUNC_INFO << tr("Invalid gradient stops list: %1").arg(str);
375       return QBrush();
376     }
377     QConicalGradient gradient(cx, cy, angle);
378     gradient.setStops(stops);
379     if(ok)
380       *ok = true;
381     return QBrush(gradient);
382
383   } else if(str.startsWith("qradialgradient")) {
384     static QString rxFloat("\\s*(-?\\s*[0-9]*\\.?[0-9]+)\\s*");
385     QRegExp rx(QString("qradialgradient\\s*\\(\\s*cx:%1,\\s*cy:%1,\\s*radius:%1,\\s*fx:%1,\\s*fy:%1,(.+)\\)").arg(rxFloat));
386     if(!rx.exactMatch(str)) {
387       qWarning() << Q_FUNC_INFO << tr("Invalid gradient declaration: %1").arg(str);
388       return QBrush();
389     }
390     qreal cx = rx.cap(1).toDouble();
391     qreal cy = rx.cap(2).toDouble();
392     qreal radius = rx.cap(3).toDouble();
393     qreal fx = rx.cap(4).toDouble();
394     qreal fy = rx.cap(5).toDouble();
395     QGradientStops stops = parseGradientStops(rx.cap(6).trimmed());
396     if(!stops.count()) {
397       qWarning() << Q_FUNC_INFO << tr("Invalid gradient stops list: %1").arg(str);
398       return QBrush();
399     }
400     QRadialGradient gradient(cx, cy, radius, fx, fy);
401     gradient.setStops(stops);
402     if(ok)
403       *ok = true;
404     return QBrush(gradient);
405   }
406
407   return QBrush();
408 }
409
410 QColor QssParser::parseColor(const QString &str) {
411   if(str.startsWith("rgba")) {
412     ColorTuple tuple = parseColorTuple(str.mid(4));
413     if(tuple.count() == 4)
414       return QColor(tuple.at(0), tuple.at(1), tuple.at(2), tuple.at(3));
415   } else if(str.startsWith("rgb")) {
416     ColorTuple tuple = parseColorTuple(str.mid(3));
417     if(tuple.count() == 3)
418       return QColor(tuple.at(0), tuple.at(1), tuple.at(2));
419   } else if(str.startsWith("hsva")) {
420     ColorTuple tuple = parseColorTuple(str.mid(4));
421     if(tuple.count() == 4) {
422       QColor c;
423       c.setHsvF(tuple.at(0), tuple.at(1), tuple.at(2), tuple.at(3));
424       return c;
425     }
426   } else if(str.startsWith("hsv")) {
427     ColorTuple tuple = parseColorTuple(str.mid(3));
428     if(tuple.count() == 3) {
429       QColor c;
430       c.setHsvF(tuple.at(0), tuple.at(1), tuple.at(2));
431       return c;
432     }
433   } else {
434     QRegExp rx("#?[0-9A-Fa-z]+");
435     if(rx.exactMatch(str))
436       return QColor(str);
437   }
438   return QColor();
439 }
440
441 // get a list of comma-separated int values or percentages (rel to 0-255)
442 QssParser::ColorTuple QssParser::parseColorTuple(const QString &str) {
443   ColorTuple result;
444   QRegExp rx("\\(((\\s*[0-9]{1,3}%?\\s*)(,\\s*[0-9]{1,3}%?\\s*)*)\\)");
445   if(!rx.exactMatch(str.trimmed())) {
446     return ColorTuple();
447   }
448   QStringList values = rx.cap(1).split(',');
449   foreach(QString v, values) {
450     qreal val;
451     bool perc = false;
452     bool ok;
453     v = v.trimmed();
454     if(v.endsWith('%')) {
455       perc = true;
456       v.chop(1);
457     }
458     val = (qreal)v.toUInt(&ok);
459     if(!ok)
460       return ColorTuple();
461     if(perc)
462       val = 255 * val/100;
463     result.append(val);
464   }
465   return result;
466 }
467
468 QGradientStops QssParser::parseGradientStops(const QString &str_) {
469   QString str = str_;
470   QGradientStops result;
471   static QString rxFloat("(0?\\.[0-9]+|[01])"); // values between 0 and 1
472   QRegExp rx(QString("\\s*,?\\s*stop:\\s*(%1)\\s+([^:]+)(,\\s*stop:|$)").arg(rxFloat));
473   int idx;
474   while((idx = rx.indexIn(str)) == 0) {
475     qreal x = rx.cap(1).toDouble();
476     QColor c = parseColor(rx.cap(3));
477     if(!c.isValid())
478       return QGradientStops();
479     result << QGradientStop(x, c);
480     str.remove(0, rx.matchedLength() - rx.cap(4).length());
481   }
482   if(!str.trimmed().isEmpty())
483     return QGradientStops();
484
485   return result;
486 }
487
488 /******** Font Properties ********/
489
490 void QssParser::parseFont(const QString& value, QTextCharFormat* format) {
491   QRegExp rx("((?:(?:normal|italic|oblique|underline|bold|100|200|300|400|500|600|700|800|900) ){0,2}) ?(\\d+)(pt|px)? \"(.*)\"");
492   if(!rx.exactMatch(value)) {
493     qWarning() << Q_FUNC_INFO << tr("Invalid font specification: %1").arg(value);
494     return;
495   }
496   format->setFontItalic(false);
497   format->setFontWeight(QFont::Normal);
498   QStringList proplist = rx.cap(1).split(' ', QString::SkipEmptyParts);
499   foreach(QString prop, proplist) {
500     if(prop == "italic")
501       format->setFontItalic(true);
502     else if(prop == "underline")
503       format->setFontUnderline(true);
504     //else if(prop == "oblique")
505     //  format->setStyle(QFont::StyleOblique);
506     else if(prop == "bold")
507       format->setFontWeight(QFont::Bold);
508     else { // number
509       int w = prop.toInt();
510       format->setFontWeight(qMin(w / 8, 99)); // taken from Qt's qss parser
511     }
512   }
513
514   if(rx.cap(3) == "px")
515     format->setProperty(QTextFormat::FontPixelSize, rx.cap(2).toInt());
516   else
517     format->setFontPointSize(rx.cap(2).toInt());
518
519   format->setFontFamily(rx.cap(4));
520 }
521
522 void QssParser::parseFontStyle(const QString& value, QTextCharFormat* format) {
523   if(value == "normal")
524     format->setFontItalic(false);
525   else if(value == "italic")
526     format->setFontItalic(true);
527   else if(value == "underline")
528     format->setFontUnderline(true);
529   //else if(value == "oblique")
530   //  format->setStyle(QFont::StyleOblique);
531   else {
532     qWarning() << Q_FUNC_INFO << tr("Invalid font style specification: %1").arg(value);
533   }
534 }
535
536 void QssParser::parseFontWeight(const QString& value, QTextCharFormat* format) {
537   if(value == "normal")
538     format->setFontWeight(QFont::Normal);
539   else if(value == "bold")
540     format->setFontWeight(QFont::Bold);
541   else {
542     bool ok;
543     int w = value.toInt(&ok);
544     if(!ok) {
545       qWarning() << Q_FUNC_INFO << tr("Invalid font weight specification: %1").arg(value);
546       return;
547     }
548     format->setFontWeight(qMin(w / 8, 99)); // taken from Qt's qss parser
549   }
550 }
551
552 void QssParser::parseFontSize(const QString& value, QTextCharFormat* format) {
553   QRegExp rx("\\(d+)(pt|px)");
554   if(!rx.exactMatch(value)) {
555     qWarning() << Q_FUNC_INFO << tr("Invalid font size specification: %1").arg(value);
556     return;
557   }
558   if(rx.cap(2) == "px")
559     format->setProperty(QTextFormat::FontPixelSize, rx.cap(1).toInt());
560   else
561     format->setFontPointSize(rx.cap(1).toInt());
562 }
563
564 void QssParser::parseFontFamily(const QString& value, QTextCharFormat* format) {
565   QString family = value;
566   if(family.startsWith('"') && family.endsWith('"')) {
567     family = family.mid(1, family.length() - 2);
568   }
569   format->setFontFamily(family);
570 }