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