emacs bindings: added M-t (transpose words)
[quassel.git] / 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
342         // modify
343       case Qt::Key_Y:
344         paste();
345         return;
346       case Qt::Key_K:
347         moveCursor(QTextCursor::EndOfLine, QTextCursor::KeepAnchor);
348         cut();
349         return;
350       }
351     }
352     else if(event->modifiers() & Qt::MetaModifier ||
353             event->modifiers() & Qt::AltModifier)
354     {
355       switch(event->key()) {
356       case Qt::Key_Right:
357         moveCursor(QTextCursor::WordRight);
358         return;
359       case Qt::Key_Left:
360         moveCursor(QTextCursor::WordLeft);
361         return;
362       case Qt::Key_F:
363         moveCursor(QTextCursor::WordRight);
364         return;
365       case Qt::Key_B:
366         moveCursor(QTextCursor::WordLeft);
367         return;
368       case Qt::Key_Less:
369         moveCursor(QTextCursor::Start);
370         return;
371       case Qt::Key_Greater:
372         moveCursor(QTextCursor::End);
373         return;
374
375         // modify
376       case Qt::Key_D:
377         moveCursor(QTextCursor::WordRight, QTextCursor::KeepAnchor);
378         cut();
379         return;
380
381       case Qt::Key_U: // uppercase word
382         moveCursor(QTextCursor::WordRight, QTextCursor::KeepAnchor);
383         textCursor().insertText(textCursor().selectedText().toUpper());
384         return;
385
386       case Qt::Key_L: // lowercase word
387         moveCursor(QTextCursor::WordRight, QTextCursor::KeepAnchor);
388         textCursor().insertText(textCursor().selectedText().toLower());
389         return;
390
391       case Qt::Key_C: { // capitalize word
392         moveCursor(QTextCursor::WordRight, QTextCursor::KeepAnchor);
393         QString const text = textCursor().selectedText();
394         textCursor().insertText(text.left(1).toUpper() + text.mid(1).toLower());
395         return;
396       }
397
398       case Qt::Key_T: { // transpose words
399         moveCursor(QTextCursor::StartOfWord);
400         moveCursor(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);
401         QString const word1 = textCursor().selectedText();
402         textCursor().clearSelection();
403         moveCursor(QTextCursor::WordRight);
404         moveCursor(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);
405         QString const word2 = textCursor().selectedText();
406         if(!word2.isEmpty() && !word1.isEmpty()) {
407           textCursor().insertText(word1);
408           moveCursor(QTextCursor::WordLeft);
409           moveCursor(QTextCursor::WordLeft);
410           moveCursor(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);
411           textCursor().insertText(word2);
412           moveCursor(QTextCursor::WordRight);
413           moveCursor(QTextCursor::EndOfWord);
414         }
415         return;
416       }
417       }
418     }
419   }
420
421 #ifdef HAVE_KDE
422   KTextEdit::keyPressEvent(event);
423 #else
424   QTextEdit::keyPressEvent(event);
425 #endif
426 }
427
428 QString MultiLineEdit::convertRichtextToMircCodes() {
429   bool underline, bold, italic, color;
430   QString mircText, mircFgColor, mircBgColor;
431   QTextCursor cursor = textCursor();
432   QTextCursor peekcursor = textCursor();
433   cursor.movePosition(QTextCursor::Start);
434
435   underline = bold = italic = color = false;
436
437   while (cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor)) {
438
439     if (cursor.selectedText() == QString(QChar(QChar::LineSeparator))
440       || cursor.selectedText() == QString(QChar(QChar::ParagraphSeparator))) {
441       if (color) {
442         color = false;
443         mircText.append('\x03');
444       }
445       if (underline) {
446         underline = false;
447         mircText.append('\x1f');
448       }
449       if (italic) {
450         italic = false;
451         mircText.append('\x1d');
452       }
453       if (bold) {
454         bold = false;
455         mircText.append('\x02');
456       }
457       mircText.append('\n');
458     }
459     else {
460       if (!bold && cursor.charFormat().font().bold()) {
461         bold = true;
462         mircText.append('\x02');
463       }
464       if (!italic && cursor.charFormat().fontItalic()) {
465         italic = true;
466         mircText.append('\x1d');
467       }
468       if (!underline && cursor.charFormat().fontUnderline()) {
469         underline = true;
470         mircText.append('\x1f');
471       }
472       if (!color && (cursor.charFormat().foreground().isOpaque() || cursor.charFormat().background().isOpaque())) {
473         color = true;
474         mircText.append('\x03');
475         mircFgColor = _mircColorMap.key(cursor.charFormat().foreground().color().name());
476         mircBgColor = _mircColorMap.key(cursor.charFormat().background().color().name());
477
478         if (mircFgColor.isEmpty()) {
479             mircFgColor = "01"; //use black if the current foreground color can't be converted
480         }
481
482         mircText.append(mircFgColor);
483         if (cursor.charFormat().background().isOpaque())
484           mircText.append("," + mircBgColor);
485       }
486
487       mircText.append(cursor.selectedText());
488
489       peekcursor.setPosition(cursor.position());
490       peekcursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor);
491
492       if (mircCodesChanged(cursor, peekcursor)) {
493         if (color) {
494           color = false;
495           mircText.append('\x03');
496         }
497         if (underline) {
498           underline = false;
499           mircText.append('\x1f');
500         }
501         if (italic) {
502           italic = false;
503           mircText.append('\x1d');
504         }
505         if (bold) {
506           bold = false;
507           mircText.append('\x02');
508         }
509       }
510     }
511
512     cursor.clearSelection();
513   }
514   if (color) {
515     color = false;
516     mircText.append('\x03');
517   }
518   if (underline) {
519     underline = false;
520     mircText.append('\x1f');
521   }
522   if (italic) {
523     italic = false;
524     mircText.append('\x1d');
525   }
526   if (bold) {
527     bold = false;
528     mircText.append('\x02');
529   }
530
531   return mircText;
532 }
533
534 bool MultiLineEdit::mircCodesChanged(QTextCursor &cursor, QTextCursor &peekcursor) {
535   bool changed = false;
536   if (cursor.charFormat().font().bold() != peekcursor.charFormat().font().bold())
537     changed = true;
538   if (cursor.charFormat().fontItalic() != peekcursor.charFormat().fontItalic())
539     changed = true;
540   if (cursor.charFormat().fontUnderline() != peekcursor.charFormat().fontUnderline())
541     changed = true;
542   if (cursor.charFormat().foreground().color() != peekcursor.charFormat().foreground().color())
543     changed = true;
544   if (cursor.charFormat().background().color() != peekcursor.charFormat().background().color())
545     changed = true;
546   return changed;
547 }
548
549 QString MultiLineEdit::convertMircCodesToHtml(const QString &text) {
550   QStringList words;
551   QRegExp mircCode = QRegExp("(\ 2|\1d|\1f|\ 3)", Qt::CaseSensitive);
552
553   int posLeft = 0;
554   int posRight = 0;
555
556   for(;;) {
557     posRight = mircCode.indexIn(text, posLeft);
558
559     if(posRight < 0) {
560       words << text.mid(posLeft);
561       break; // no more mirc color codes
562     }
563
564     if (posLeft < posRight) {
565       words << text.mid(posLeft, posRight - posLeft);
566       posLeft = posRight;
567     }
568
569     posRight = text.indexOf(mircCode.cap(), posRight + 1);
570     words << text.mid(posLeft, posRight + 1 - posLeft);
571     posLeft = posRight + 1;
572   }
573
574   for (int i = 0; i < words.count(); i++) {
575       QString style;
576       if (words[i].contains('\x02')) {
577         style.append(" font-weight:600;");
578         words[i].replace('\x02',"");
579       }
580       if (words[i].contains('\x1d')) {
581         style.append(" font-style:italic;");
582         words[i].replace('\x1d',"");
583       }
584       if (words[i].contains('\x1f')) {
585         style.append(" text-decoration: underline;");
586         words[i].replace('\x1f',"");
587       }
588       if (words[i].contains('\x03')) {
589         int pos = words[i].indexOf('\x03');
590         int len = 3;
591         QString fg = words[i].mid(pos + 1,2);
592         QString bg;
593         if (words[i][pos+3] == ',')
594           bg = words[i].mid(pos+4,2);
595
596         style.append(" color:");
597         style.append(_mircColorMap[fg]);
598         style.append(";");
599
600         if (!bg.isEmpty()) {
601           style.append(" background-color:");
602           style.append(_mircColorMap[bg]);
603           style.append(";");
604           len = 6;
605         }
606         words[i].replace(pos, len, "");
607         words[i].replace('\x03',"");
608       }
609       words[i].replace("&","&amp;");
610       words[i].replace("<", "&lt;");
611       words[i].replace(">", "&gt;");
612       words[i].replace("\"", "&quot;");
613       if (style.isEmpty()) {
614         words[i] = "<span>" + words[i] + "</span>";
615       }
616       else {
617         words[i] = "<span style=\"" + style + "\">" + words[i] + "</span>";
618       }
619   }
620   return words.join("").replace("\n","<br />");
621 }
622
623 void MultiLineEdit::on_returnPressed() {
624   on_returnPressed(convertRichtextToMircCodes());
625 }
626
627 void MultiLineEdit::on_returnPressed(const QString & text) {
628   if(!text.isEmpty()) {
629     foreach(const QString &line, text.split('\n', QString::SkipEmptyParts)) {
630       if(line.isEmpty())
631         continue;
632       addToHistory(line);
633       emit textEntered(line);
634     }
635     reset();
636     _tempHistory.clear();
637   } else {
638     emit noTextEntered();
639   }
640 }
641
642 void MultiLineEdit::on_textChanged() {
643   QString newText = text();
644   newText.replace("\r\n", "\n");
645   newText.replace('\r', '\n');
646   if(_mode == SingleLine) {
647     if(!pasteProtectionEnabled())
648       newText.replace('\n', ' ');
649     else if(newText.contains('\n')) {
650       QStringList lines = newText.split('\n', QString::SkipEmptyParts);
651       clear();
652
653       if(lines.count() >= 4) {
654         QString msg = tr("Do you really want to paste %n lines?", "", lines.count());
655         msg += "<p>";
656         for(int i = 0; i < 4; i++) {
657           msg += Qt::escape(lines[i].left(40));
658           if(lines[i].count() > 40)
659             msg += "...";
660           msg += "<br />";
661         }
662         msg += "...</p>";
663         QMessageBox question(QMessageBox::NoIcon, tr("Paste Protection"), msg, QMessageBox::Yes|QMessageBox::No);
664         question.setDefaultButton(QMessageBox::No);
665 #ifdef Q_WS_MAC
666         question.setWindowFlags(question.windowFlags() | Qt::Sheet);
667 #endif
668         if(question.exec() != QMessageBox::Yes)
669           return;
670       }
671
672       foreach(QString line, lines) {
673         clear();
674         insert(line);
675         on_returnPressed();
676       }
677     }
678   }
679
680   _singleLine = (newText.indexOf('\n') < 0);
681
682   if(document()->size().height() != _lastDocumentHeight) {
683     _lastDocumentHeight = document()->size().height();
684     on_documentHeightChanged(_lastDocumentHeight);
685   }
686   updateSizeHint();
687   ensureCursorVisible();
688 }
689
690 void MultiLineEdit::on_documentHeightChanged(qreal) {
691   updateScrollBars();
692 }
693
694 void MultiLineEdit::reset() {
695   // every time the MultiLineEdit is cleared we also reset history index
696   _idx = _history.count();
697   clear();
698   QTextBlockFormat format = textCursor().blockFormat();
699   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
700   textCursor().setBlockFormat(format);
701   updateScrollBars();
702 }
703
704 void MultiLineEdit::showHistoryEntry() {
705   // if the user changed the history, display the changed line
706   setHtml(convertMircCodesToHtml(_tempHistory.contains(_idx) ? _tempHistory[_idx] : _history[_idx]));
707   QTextCursor cursor = textCursor();
708   QTextBlockFormat format = cursor.blockFormat();
709   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
710   cursor.setBlockFormat(format);
711   cursor.movePosition(QTextCursor::End);
712   setTextCursor(cursor);
713   updateScrollBars();
714 }