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