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(convertRichtextToMircCodes(), true);
 193
 194   if(_idx > 0) {
 195     _idx--;
 196     showHistoryEntry();
 197   }
 198 }
 199
 200 void MultiLineEdit::historyMoveForward() {
 201   addToHistory(convertRichtextToMircCodes(), 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(convertRichtextToMircCodes());
 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::convertRichtextToMircCodes() {
 321   bool underline, bold, italic, color;
 322   QString mircText, mircFgColor, mircBgColor;
 323   QTextCursor cursor = textCursor();
 324   QTextCursor peekcursor = textCursor();
 325   cursor.movePosition(QTextCursor::Start);
 326
 327   underline = bold = italic = color = false;
 328
 329   while (cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor)) {
 330
 331     if (cursor.selectedText() == QString(QChar(QChar::LineSeparator))) {
 332       if (color) {
 333         color = false;
 334         mircText.append('\x03');
 335       }
 336       if (underline) {
 337         underline = false;
 338         mircText.append('\x1f');
 339       }
 340       if (italic) {
 341         italic = false;
 342         mircText.append('\x1d');
 343       }
 344       if (bold) {
 345         bold = false;
 346         mircText.append('\x02');
 347       }
 348       mircText.append('\n');
 349     }
 350     else {
 351       if (!bold && cursor.charFormat().font().bold()) {
 352         bold = true;
 353         mircText.append('\x02');
 354       }
 355       if (!italic && cursor.charFormat().fontItalic()) {
 356         italic = true;
 357         mircText.append('\x1d');
 358       }
 359       if (!underline && cursor.charFormat().fontUnderline()) {
 360         underline = true;
 361         mircText.append('\x1f');
 362       }
 363       if (!color && (cursor.charFormat().foreground().isOpaque() || cursor.charFormat().background().isOpaque())) {
 364         color = true;
 365         mircText.append('\x03');
 366         mircFgColor = _mircColorMap.key(cursor.charFormat().foreground().color().name());
 367         mircBgColor = _mircColorMap.key(cursor.charFormat().background().color().name());
 368
 369         if (mircFgColor.isEmpty()) {
 370             mircFgColor = "01"; //use black if the current foreground color can't be converted
 371         }
 372
 373         mircText.append(mircFgColor);
 374         if (cursor.charFormat().background().isOpaque())
 375           mircText.append("," + mircBgColor);
 376       }
 377
 378       mircText.append(cursor.selectedText());
 379
 380       peekcursor.setPosition(cursor.position());
 381       peekcursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor);
 382
 383       if (mircCodesChanged(cursor, peekcursor)) {
 384         if (color) {
 385           color = false;
 386           mircText.append('\x03');
 387         }
 388         if (underline) {
 389           underline = false;
 390           mircText.append('\x1f');
 391         }
 392         if (italic) {
 393           italic = false;
 394           mircText.append('\x1d');
 395         }
 396         if (bold) {
 397           bold = false;
 398           mircText.append('\x02');
 399         }
 400       }
 401     }
 402
 403     cursor.clearSelection();
 404   }
 405   if (color) {
 406     color = false;
 407     mircText.append('\x03');
 408   }
 409   if (underline) {
 410     underline = false;
 411     mircText.append('\x1f');
 412   }
 413   if (italic) {
 414     italic = false;
 415     mircText.append('\x1d');
 416   }
 417   if (bold) {
 418     bold = false;
 419     mircText.append('\x02');
 420   }
 421
 422   return mircText;
 423 }
 424
 425 bool MultiLineEdit::mircCodesChanged(QTextCursor &cursor, QTextCursor &peekcursor) {
 426   bool changed = false;
 427   if (cursor.charFormat().font().bold() != peekcursor.charFormat().font().bold())
 428     changed = true;
 429   if (cursor.charFormat().fontItalic() != peekcursor.charFormat().fontItalic())
 430     changed = true;
 431   if (cursor.charFormat().fontUnderline() != peekcursor.charFormat().fontUnderline())
 432     changed = true;
 433   if (cursor.charFormat().foreground().color() != peekcursor.charFormat().foreground().color())
 434     changed = true;
 435   if (cursor.charFormat().background().color() != peekcursor.charFormat().background().color())
 436     changed = true;
 437   return changed;
 438 }
 439
 440 QString MultiLineEdit::convertMircCodesToHtml(const QString &text) {
 441   QStringList words;
 442   QRegExp mircCode = QRegExp("(\ 2|\1d|\1f|\ 3)", Qt::CaseSensitive);
 443
 444   int posLeft = 0;
 445   int posRight = 0;
 446
 447   for(;;) {
 448     posRight = mircCode.indexIn(text, posLeft);
 449
 450     if(posRight < 0) {
 451       words << text.mid(posLeft);
 452       break; // no more mirc color codes
 453     }
 454
 455     if (posLeft < posRight) {
 456       words << text.mid(posLeft, posRight - posLeft);
 457       posLeft = posRight;
 458     }
 459
 460     posRight = text.indexOf(mircCode.cap(), posRight + 1);
 461     words << text.mid(posLeft, posRight + 1 - posLeft);
 462     posLeft = posRight + 1;
 463   }
 464
 465   for (int i = 0; i < words.count(); i++) {
 466       QString style;
 467       if (words[i].contains('\x02')) {
 468         style.append(" font-weight:600;");
 469         words[i].replace('\x02',"");
 470       }
 471       if (words[i].contains('\x1d')) {
 472         style.append(" font-style:italic;");
 473         words[i].replace('\x1d',"");
 474       }
 475       if (words[i].contains('\x1f')) {
 476         style.append(" text-decoration: underline;");
 477         words[i].replace('\x1f',"");
 478       }
 479       if (words[i].contains('\x03')) {
 480         int pos = words[i].indexOf('\x03');
 481         int len = 3;
 482         QString fg = words[i].mid(pos + 1,2);
 483         QString bg;
 484         if (words[i][pos+3] == ',')
 485           bg = words[i].mid(pos+4,2);
 486
 487         style.append(" color:");
 488         style.append(_mircColorMap[fg]);
 489         style.append(";");
 490
 491         if (!bg.isEmpty()) {
 492           style.append(" background-color:");
 493           style.append(_mircColorMap[bg]);
 494           style.append(";");
 495           len = 6;
 496         }
 497         words[i].replace(pos, len, "");
 498         words[i].replace('\x03',"");
 499       }
 500       words[i].replace("&","&amp;");
 501       words[i].replace("<", "&lt;");
 502       words[i].replace(">", "&gt;");
 503       words[i].replace("\"", "&quot;");
 504       if (style.isEmpty()) {
 505         words[i] = "<span>" + words[i] + "</span>";
 506       }
 507       else {
 508         words[i] = "<span style=\"" + style + "\">" + words[i] + "</span>";
 509       }
 510   }
 511   return words.join("").replace("\n","<br />");
 512 }
 513
 514 void MultiLineEdit::on_returnPressed() {
 515   on_returnPressed(convertRichtextToMircCodes());
 516 }
 517
 518 void MultiLineEdit::on_returnPressed(const QString & text) {
 519   if(!text.isEmpty()) {
 520     foreach(const QString &line, text.split('\n', QString::SkipEmptyParts)) {
 521       if(line.isEmpty())
 522         continue;
 523       addToHistory(line);
 524       emit textEntered(line);
 525     }
 526     reset();
 527     _tempHistory.clear();
 528   } else {
 529     emit noTextEntered();
 530   }
 531 }
 532
 533 void MultiLineEdit::on_textChanged() {
 534   QString newText = text();
 535   newText.replace("\r\n", "\n");
 536   newText.replace('\r', '\n');
 537   if(_mode == SingleLine) {
 538     if(!pasteProtectionEnabled())
 539       newText.replace('\n', ' ');
 540     else if(newText.contains('\n')) {
 541       QStringList lines = newText.split('\n', QString::SkipEmptyParts);
 542       clear();
 543
 544       if(lines.count() >= 4) {
 545         QString msg = tr("Do you really want to paste %n lines?", "", lines.count());
 546         msg += "<p>";
 547         for(int i = 0; i < 4; i++) {
 548           msg += Qt::escape(lines[i].left(40));
 549           if(lines[i].count() > 40)
 550             msg += "...";
 551           msg += "<br />";
 552         }
 553         msg += "...</p>";
 554         QMessageBox question(QMessageBox::NoIcon, tr("Paste Protection"), msg, QMessageBox::Yes|QMessageBox::No);
 555         question.setDefaultButton(QMessageBox::No);
 556 #ifdef Q_WS_MAC
 557         question.setWindowFlags(question.windowFlags() | Qt::Sheet);
 558 #endif
 559         if(question.exec() != QMessageBox::Yes)
 560           return;
 561       }
 562
 563       foreach(QString line, lines) {
 564         clear();
 565         insert(line);
 566         on_returnPressed();
 567       }
 568     }
 569   }
 570
 571   _singleLine = (newText.indexOf('\n') < 0);
 572
 573   if(document()->size().height() != _lastDocumentHeight) {
 574     _lastDocumentHeight = document()->size().height();
 575     on_documentHeightChanged(_lastDocumentHeight);
 576   }
 577   updateSizeHint();
 578   ensureCursorVisible();
 579 }
 580
 581 void MultiLineEdit::on_documentHeightChanged(qreal) {
 582   updateScrollBars();
 583 }
 584
 585 void MultiLineEdit::reset() {
 586   // every time the MultiLineEdit is cleared we also reset history index
 587   _idx = _history.count();
 588   clear();
 589   QTextBlockFormat format = textCursor().blockFormat();
 590   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 591   textCursor().setBlockFormat(format);
 592   updateScrollBars();
 593 }
 594
 595 void MultiLineEdit::showHistoryEntry() {
 596   // if the user changed the history, display the changed line
 597   setHtml(convertMircCodesToHtml(_tempHistory.contains(_idx) ? _tempHistory[_idx] : _history[_idx]));
 598   QTextCursor cursor = textCursor();
 599   QTextBlockFormat format = cursor.blockFormat();
 600   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 601   cursor.setBlockFormat(format);
 602   cursor.movePosition(QTextCursor::End);
 603   setTextCursor(cursor);
 604   updateScrollBars();
 605 }