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