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