src/uisupport/multilineedit.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2010 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 #include <QMenu>
  23 #include <QMessageBox>
  24 #include <QScrollBar>
  25
  26 #include "bufferview.h"
  27 #include "graphicalui.h"
  28 #include "multilineedit.h"
  29 #include "tabcompleter.h"
  30
  31 const int leftMargin = 3;
  32
  33 MultiLineEdit::MultiLineEdit(QWidget *parent)
  34   :
  35 #ifdef HAVE_KDE
  36     KTextEdit(parent),
  37 #else
  38     QTextEdit(parent),
  39 #endif
  40     idx(0),
  41     _mode(SingleLine),
  42     _singleLine(true),
  43     _minHeight(1),
  44     _maxHeight(5),
  45     _scrollBarsEnabled(true),
  46     _lastDocumentHeight(-1)
  47 {
  48 #if QT_VERSION >= 0x040500
  49   document()->setDocumentMargin(0); // new in Qt 4.5 and we really don't want it here
  50 #endif
  51
  52   setAcceptRichText(false);
  53 #ifdef HAVE_KDE
  54   enableFindReplace(false);
  55 #endif
  56
  57   setMode(SingleLine);
  58   setWordWrapEnabled(false);
  59   reset();
  60
  61   connect(this, SIGNAL(textChanged()), this, SLOT(on_textChanged()));
  62
  63   _mircColorMap["00"] = "#ffffff";
  64   _mircColorMap["01"] = "#000000";
  65   _mircColorMap["02"] = "#000080";
  66   _mircColorMap["03"] = "#008000";
  67   _mircColorMap["04"] = "#ff0000";
  68   _mircColorMap["05"] = "#800000";
  69   _mircColorMap["06"] = "#800080";
  70   _mircColorMap["07"] = "#ffa500";
  71   _mircColorMap["08"] = "#ffff00";
  72   _mircColorMap["09"] = "#00ff00";
  73   _mircColorMap["10"] = "#008080";
  74   _mircColorMap["11"] = "#00ffff";
  75   _mircColorMap["12"] = "#4169e1";
  76   _mircColorMap["13"] = "#ff00ff";
  77   _mircColorMap["14"] = "#808080";
  78   _mircColorMap["15"] = "#c0c0c0";
  79
  80 }
  81
  82 MultiLineEdit::~MultiLineEdit() {
  83 }
  84
  85 void MultiLineEdit::setCustomFont(const QFont &font) {
  86   setFont(font);
  87   updateSizeHint();
  88 }
  89
  90 void MultiLineEdit::setMode(Mode mode) {
  91   if(mode == _mode)
  92     return;
  93
  94   _mode = mode;
  95 }
  96
  97 void MultiLineEdit::setMinHeight(int lines) {
  98   if(lines == _minHeight)
  99     return;
 100
 101   _minHeight = lines;
 102   updateSizeHint();
 103 }
 104
 105 void MultiLineEdit::setMaxHeight(int lines) {
 106   if(lines == _maxHeight)
 107     return;
 108
 109   _maxHeight = lines;
 110   updateSizeHint();
 111 }
 112
 113 void MultiLineEdit::setScrollBarsEnabled(bool enable) {
 114   if(_scrollBarsEnabled == enable)
 115     return;
 116
 117   _scrollBarsEnabled = enable;
 118   updateScrollBars();
 119 }
 120
 121 void MultiLineEdit::updateScrollBars() {
 122   QFontMetrics fm(font());
 123   int _maxPixelHeight = fm.lineSpacing() * _maxHeight;
 124   if(_scrollBarsEnabled && document()->size().height() > _maxPixelHeight)
 125     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
 126   else
 127     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 128
 129   if(!_scrollBarsEnabled || isSingleLine())
 130     setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 131   else
 132     setHorizontalScrollBarPolicy(Qt::ScrollBarAsNeeded);
 133 }
 134
 135 void MultiLineEdit::resizeEvent(QResizeEvent *event) {
 136   QTextEdit::resizeEvent(event);
 137   updateSizeHint();
 138   updateScrollBars();
 139 }
 140
 141 void MultiLineEdit::updateSizeHint() {
 142   QFontMetrics fm(font());
 143   int minPixelHeight = fm.lineSpacing() * _minHeight;
 144   int maxPixelHeight = fm.lineSpacing() * _maxHeight;
 145   int scrollBarHeight = horizontalScrollBar()->isVisible() ? horizontalScrollBar()->height() : 0;
 146
 147   // use the style to determine a decent size
 148   int h = qMin(qMax((int)document()->size().height() + scrollBarHeight, minPixelHeight), maxPixelHeight) + 2 * frameWidth();
 149   QStyleOptionFrameV2 opt;
 150   opt.initFrom(this);
 151   opt.rect = QRect(0, 0, 100, h);
 152   opt.lineWidth = lineWidth();
 153   opt.midLineWidth = midLineWidth();
 154   opt.state |= QStyle::State_Sunken;
 155   QSize s = style()->sizeFromContents(QStyle::CT_LineEdit, &opt, QSize(100, h).expandedTo(QApplication::globalStrut()), this);
 156   if(s != _sizeHint) {
 157     _sizeHint = s;
 158     updateGeometry();
 159   }
 160 }
 161
 162 QSize MultiLineEdit::sizeHint() const {
 163   if(!_sizeHint.isValid()) {
 164     MultiLineEdit *that = const_cast<MultiLineEdit *>(this);
 165     that->updateSizeHint();
 166   }
 167   return _sizeHint;
 168 }
 169
 170 QSize MultiLineEdit::minimumSizeHint() const {
 171   return sizeHint();
 172 }
 173
 174 void MultiLineEdit::setSpellCheckEnabled(bool enable) {
 175 #ifdef HAVE_KDE
 176   setCheckSpellingEnabled(enable);
 177 #else
 178   Q_UNUSED(enable)
 179 #endif
 180 }
 181
 182 void MultiLineEdit::setWordWrapEnabled(bool enable) {
 183   setLineWrapMode(enable? WidgetWidth : NoWrap);
 184   updateSizeHint();
 185 }
 186
 187 void MultiLineEdit::setPasteProtectionEnabled(bool enable, QWidget *) {
 188   _pasteProtectionEnabled = enable;
 189 }
 190
 191 void MultiLineEdit::historyMoveBack() {
 192   addToHistory(convertHtmlToMircCodes(html()), true);
 193
 194   if(idx > 0) {
 195     idx--;
 196     showHistoryEntry();
 197   }
 198 }
 199
 200 void MultiLineEdit::historyMoveForward() {
 201   addToHistory(convertHtmlToMircCodes(html()), true);
 202
 203   if(idx < history.count()) {
 204     idx++;
 205     if(idx < history.count() || tempHistory.contains(idx)) // tempHistory might have an entry for idx == history.count() + 1
 206       showHistoryEntry();
 207     else
 208       reset();              // equals clear() in this case
 209   } else {
 210     addToHistory(convertHtmlToMircCodes(html()));
 211     reset();
 212   }
 213 }
 214
 215 bool MultiLineEdit::addToHistory(const QString &text, bool temporary) {
 216   if(text.isEmpty())
 217     return false;
 218
 219   Q_ASSERT(0 <= idx && idx <= history.count());
 220
 221   if(temporary) {
 222     // if an entry of the history is changed, we remember it and show it again at this
 223     // position until a line was actually sent
 224     // sent lines get appended to the history
 225     if(history.isEmpty() || text != history[idx - (int)(idx == history.count())]) {
 226       tempHistory[idx] = text;
 227       return true;
 228     }
 229   } else {
 230     if(history.isEmpty() || text != history.last()) {
 231       history << text;
 232       tempHistory.clear();
 233       return true;
 234     }
 235   }
 236   return false;
 237 }
 238
 239 void MultiLineEdit::keyPressEvent(QKeyEvent *event) {
 240   // Workaround the fact that Qt < 4.5 doesn't know InsertLineSeparator yet
 241 #if QT_VERSION >= 0x040500
 242   if(event == QKeySequence::InsertLineSeparator) {
 243 #else
 244
 245 # ifdef Q_WS_MAC
 246   if((event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) && event->modifiers() & Qt::META) {
 247 # else
 248   if((event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) && event->modifiers() & Qt::SHIFT) {
 249 # endif
 250 #endif
 251
 252     if(_mode == SingleLine) {
 253       event->accept();
 254       on_returnPressed();
 255       return;
 256     }
 257 #ifdef HAVE_KDE
 258     KTextEdit::keyPressEvent(event);
 259 #else
 260     QTextEdit::keyPressEvent(event);
 261 #endif
 262     return;
 263   }
 264
 265   switch(event->key()) {
 266   case Qt::Key_Up:
 267     if(event->modifiers() & Qt::ShiftModifier)
 268       break;
 269     {
 270       event->accept();
 271       if(!(event->modifiers() & Qt::ControlModifier)) {
 272         int pos = textCursor().position();
 273         moveCursor(QTextCursor::Up);
 274         if(pos == textCursor().position()) // already on top line -> history
 275           historyMoveBack();
 276       } else
 277         historyMoveBack();
 278       return;
 279     }
 280
 281   case Qt::Key_Down:
 282     if(event->modifiers() & Qt::ShiftModifier)
 283       break;
 284     {
 285       event->accept();
 286       if(!(event->modifiers() & Qt::ControlModifier)) {
 287         int pos = textCursor().position();
 288         moveCursor(QTextCursor::Down);
 289         if(pos == textCursor().position()) // already on bottom line -> history
 290           historyMoveForward();
 291       } else
 292         historyMoveForward();
 293       return;
 294     }
 295
 296   case Qt::Key_Return:
 297   case Qt::Key_Enter:
 298   case Qt::Key_Select:
 299     event->accept();
 300     on_returnPressed();
 301     return;
 302
 303   // We don't want to have the tab key react even if no completer is installed
 304   case Qt::Key_Tab:
 305     event->accept();
 306     return;
 307
 308   default:
 309     ;
 310   }
 311
 312
 313 #ifdef HAVE_KDE
 314   KTextEdit::keyPressEvent(event);
 315 #else
 316   QTextEdit::keyPressEvent(event);
 317 #endif
 318 }
 319
 320 QString MultiLineEdit::convertHtmlToMircCodes(const QString &text) {
 321   QRegExp regexHtmlContent = QRegExp("<p.*>(.*)</p>", Qt::CaseInsensitive);
 322   regexHtmlContent.setMinimal(true);
 323
 324   QRegExp regexLines = QRegExp("(.*)(?:<br />)?", Qt::CaseInsensitive);
 325   regexLines.setMinimal(true);
 326
 327   QRegExp regexStyles = QRegExp("(?:((<span.*>)(.*)</span>))", Qt::CaseInsensitive);
 328   regexStyles.setMinimal(true);
 329
 330   QRegExp regexColors = QRegExp("((?:background-)?color):(#[0-9a-f]{6})", Qt::CaseInsensitive);
 331   regexStyles.setMinimal(true);
 332
 333   QStringList result;
 334   QString htmlContent, line, line2, styleText, style, content;
 335
 336   if (regexHtmlContent.indexIn((text)) > -1) {
 337     htmlContent = regexHtmlContent.cap(1);
 338     QStringList lines = htmlContent.split("<br />");
 339     for (int i=0; i < lines.count(); i++) {
 340       line = line2 = lines[i];
 341       int posStyles = 0;
 342       while ((posStyles = regexStyles.indexIn(line2, posStyles)) != -1) {
 343         styleText = regexStyles.cap(1);
 344         style = regexStyles.cap(2);
 345         content = regexStyles.cap(3);
 346
 347         if (style.contains("font-weight:600;")) {
 348           content.prepend('\x02');
 349           content.append('\x02');
 350         }
 351         if (style.contains("font-style:italic;")) {
 352           content.prepend('\x1d');
 353           content.append('\x1d');
 354         }
 355         if (style.contains("text-decoration: underline;")) {
 356           content.prepend('\x1f');
 357           content.append('\x1f');
 358         }
 359         if (style.contains("color:#")) { // we have either foreground or background color or both
 360           int posColors = 0;
 361           QString mircFgColor, mircBgColor;
 362           while ((posColors = regexColors.indexIn(style, posColors)) != -1) {
 363             QString colorType = regexColors.cap(1);
 364             QString color = regexColors.cap(2);
 365
 366             if (colorType == "color")
 367               mircFgColor = _mircColorMap.key(color);
 368
 369             if (colorType == "background-color")
 370               mircBgColor = _mircColorMap.key(color);
 371
 372             posColors += regexColors.matchedLength();
 373           }
 374           if (!mircBgColor.isEmpty())
 375             content.prepend("," + mircBgColor);
 376
 377           // we need a fg color to be able to use a bg color
 378           if (mircFgColor.isEmpty()) {
 379             //FIXME try to use the current forecolor
 380             mircFgColor = _mircColorMap.key(textColor().name());
 381             if (mircFgColor.isEmpty())
 382               mircFgColor = "01"; //use black if the current foreground color can't be converted
 383           }
 384
 385           content.prepend(mircFgColor);
 386           content.prepend('\x03');
 387           content.append('\x03');
 388         }
 389
 390         line.replace(styleText, content);
 391         posStyles += regexStyles.matchedLength();
 392       }
 393
 394       // get rid of all remaining html tags
 395       QRegExp regexTags = QRegExp("<.*>",Qt::CaseInsensitive);
 396       regexTags.setMinimal(true);
 397       line.replace(regexTags, "");
 398
 399       line.replace("&amp;","&");
 400       line.replace("&lt;","<");
 401       line.replace("&gt;",">");
 402       line.replace("&quot;","\"");
 403
 404       result << line;
 405     }
 406   }
 407   return result.join("\n");
 408 }
 409
 410 QString MultiLineEdit::convertMircCodesToHtml(const QString &text) {
 411   QStringList words;
 412   QRegExp mircCode = QRegExp("(\ 2|\1d|\1f|\ 3)", Qt::CaseSensitive);
 413
 414   int posLeft = 0;
 415   int posRight = 0;
 416
 417   for(;;) {
 418     posRight = mircCode.indexIn(text, posLeft);
 419
 420     if(posRight < 0) {
 421       words << text.mid(posLeft);
 422       break; // no more mirc color codes
 423     }
 424
 425     if (posLeft < posRight) {
 426       words << text.mid(posLeft, posRight - posLeft);
 427       posLeft = posRight;
 428     }
 429
 430     posRight = text.indexOf(mircCode.cap(), posRight + 1);
 431     words << text.mid(posLeft, posRight + 1 - posLeft);
 432     posLeft = posRight + 1;
 433   }
 434
 435   for (int i = 0; i < words.count(); i++) {
 436       QString style;
 437       if (words[i].contains('\x02')) {
 438         style.append(" font-weight:600;");
 439         words[i].replace('\x02',"");
 440       }
 441       if (words[i].contains('\x1d')) {
 442         style.append(" font-style:italic;");
 443         words[i].replace('\x1d',"");
 444       }
 445       if (words[i].contains('\x1f')) {
 446         style.append(" text-decoration: underline;");
 447         words[i].replace('\x1f',"");
 448       }
 449       if (words[i].contains('\x03')) {
 450         int pos = words[i].indexOf('\x03');
 451         int len = 3;
 452         QString fg = words[i].mid(pos + 1,2);
 453         QString bg;
 454         if (words[i][pos+3] == ',')
 455           bg = words[i].mid(pos+4,2);
 456
 457         style.append(" color:");
 458         style.append(_mircColorMap[fg]);
 459         style.append(";");
 460
 461         if (!bg.isEmpty()) {
 462           style.append(" background-color:");
 463           style.append(_mircColorMap[bg]);
 464           style.append(";");
 465           len = 6;
 466         }
 467         words[i].replace(pos, len, "");
 468         words[i].replace('\x03',"");
 469       }
 470       words[i].replace("&","&amp;");
 471       words[i].replace("<", "&lt;");
 472       words[i].replace(">", "&gt;");
 473       words[i].replace("\"", "&quot;");
 474       if (style.isEmpty()) {
 475         words[i] = "<span>" + words[i] + "</span>";
 476       }
 477       else {
 478         words[i] = "<span style=\"" + style + "\">" + words[i] + "</span>";
 479       }
 480   }
 481   return words.join("");
 482 }
 483
 484 void MultiLineEdit::on_returnPressed() {
 485   on_returnPressed(convertHtmlToMircCodes(html()));
 486 }
 487
 488 void MultiLineEdit::on_returnPressed(const QString & text) {
 489   if(!text.isEmpty()) {
 490     foreach(const QString &line, text.split('\n', QString::SkipEmptyParts)) {
 491       if(line.isEmpty())
 492         continue;
 493       addToHistory(line);
 494       emit textEntered(line);
 495     }
 496     reset();
 497     tempHistory.clear();
 498   } else {
 499     emit noTextEntered();
 500   }
 501 }
 502
 503 void MultiLineEdit::on_textChanged() {
 504   QString newText = text();
 505   newText.replace("\r\n", "\n");
 506   newText.replace('\r', '\n');
 507   if(_mode == SingleLine) {
 508     if(!pasteProtectionEnabled())
 509       newText.replace('\n', ' ');
 510     else if(newText.contains('\n')) {
 511       QStringList lines = newText.split('\n', QString::SkipEmptyParts);
 512       clear();
 513
 514       if(lines.count() >= 4) {
 515         QString msg = tr("Do you really want to paste %n lines?", "", lines.count());
 516         msg += "<p>";
 517         for(int i = 0; i < 4; i++) {
 518           msg += Qt::escape(lines[i].left(40));
 519           if(lines[i].count() > 40)
 520             msg += "...";
 521           msg += "<br />";
 522         }
 523         msg += "...</p>";
 524         QMessageBox question(QMessageBox::NoIcon, tr("Paste Protection"), msg, QMessageBox::Yes|QMessageBox::No);
 525         question.setDefaultButton(QMessageBox::No);
 526 #ifdef Q_WS_MAC
 527         question.setWindowFlags(question.windowFlags() | Qt::Sheet);
 528 #endif
 529         if(question.exec() != QMessageBox::Yes)
 530           return;
 531       }
 532
 533       foreach(QString line, lines) {
 534         clear();
 535         insert(line);
 536         on_returnPressed();
 537       }
 538     }
 539   }
 540
 541   _singleLine = (newText.indexOf('\n') < 0);
 542
 543   if(document()->size().height() != _lastDocumentHeight) {
 544     _lastDocumentHeight = document()->size().height();
 545     on_documentHeightChanged(_lastDocumentHeight);
 546   }
 547   updateSizeHint();
 548   ensureCursorVisible();
 549 }
 550
 551 void MultiLineEdit::on_documentHeightChanged(qreal) {
 552   updateScrollBars();
 553 }
 554
 555 void MultiLineEdit::reset() {
 556   // every time the MultiLineEdit is cleared we also reset history index
 557   idx = history.count();
 558   clear();
 559   QTextBlockFormat format = textCursor().blockFormat();
 560   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 561   textCursor().setBlockFormat(format);
 562   updateScrollBars();
 563 }
 564
 565 void MultiLineEdit::showHistoryEntry() {
 566   // if the user changed the history, display the changed line
 567   setHtml(convertMircCodesToHtml(tempHistory.contains(idx) ? tempHistory[idx] : history[idx]));
 568   //setPlainText(tempHistory.contains(idx) ? tempHistory[idx] : history[idx]);
 569   QTextCursor cursor = textCursor();
 570   QTextBlockFormat format = cursor.blockFormat();
 571   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 572   cursor.setBlockFormat(format);
 573   cursor.movePosition(QTextCursor::End);
 574   setTextCursor(cursor);
 575   updateScrollBars();
 576 }