Better time formatting by using an explicit format
[quassel.git] / src / uisupport / tabcompleter.cpp
index 311801a..baae742 100644 (file)
 /***************************************************************************
-*   Copyright (C) 2005-09 by the Quassel Project                          *
-*   devel@quassel-irc.org                                                 *
-*                                                                         *
-*   This program is free software; you can redistribute it and/or modify  *
-*   it under the terms of the GNU General Public License as published by  *
-*   the Free Software Foundation; either version 2 of the License, or     *
-*   (at your option) version 3.                                           *
-*                                                                         *
-*   This program is distributed in the hope that it will be useful,       *
-*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
-*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
-*   GNU General Public License for more details.                          *
-*                                                                         *
-*   You should have received a copy of the GNU General Public License     *
-*   along with this program; if not, write to the                         *
-*   Free Software Foundation, Inc.,                                       *
-*   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
-***************************************************************************/
+ *   Copyright (C) 2005-2012 by the Quassel Project                        *
+ *   devel@quassel-irc.org                                                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) version 3.                                           *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
+ ***************************************************************************/
 
 #include "tabcompleter.h"
 
-#include "inputline.h"
-#include "client.h"
 #include "buffermodel.h"
-#include "networkmodel.h"
-#include "network.h"
+#include "client.h"
 #include "ircchannel.h"
 #include "ircuser.h"
+#include "multilineedit.h"
+#include "network.h"
+#include "networkmodel.h"
 #include "uisettings.h"
+#include "action.h"
+#include "actioncollection.h"
+#include "graphicalui.h"
 
 #include <QRegExp>
 
 const Network *TabCompleter::_currentNetwork;
 BufferId TabCompleter::_currentBufferId;
-
-TabCompleter::TabCompleter(InputLine *inputLine_)
-  : QObject(inputLine_),
-    inputLine(inputLine_),
-    enabled(false),
-    nickSuffix(": ")
+QString TabCompleter::_currentBufferName;
+TabCompleter::Type TabCompleter::_completionType;
+
+TabCompleter::TabCompleter(MultiLineEdit *_lineEdit)
+    : QObject(_lineEdit),
+    _lineEdit(_lineEdit),
+    _enabled(false),
+    _nickSuffix(": ")
 {
-  inputLine->installEventFilter(this);
+    // use both an Action and generic eventFilter, to make the shortcut configurable
+    // yet still be able to reset() when required
+    _lineEdit->installEventFilter(this);
+    ActionCollection *coll = GraphicalUi::actionCollection("General");
+    coll->addAction("TabCompletionKey", new Action(tr("Tab completion"), coll,
+            this, SLOT(onTabCompletionKey()), QKeySequence(Qt::Key_Tab)));
 }
 
-void TabCompleter::buildCompletionList() {
-  // ensure a safe state in case we return early.
-  completionMap.clear();
-  nextCompletion = completionMap.begin();
 
-  // this is the first time tab is pressed -> build up the completion list and it's iterator
-  QModelIndex currentIndex = Client::bufferModel()->currentIndex();
-  _currentBufferId = currentIndex.data(NetworkModel::BufferIdRole).value<BufferId>();
-  if(!_currentBufferId.isValid())
-    return;
+void TabCompleter::onTabCompletionKey()
+{
+    complete();
+}
 
-  NetworkId networkId = currentIndex.data(NetworkModel::NetworkIdRole).value<NetworkId>();
-  QString bufferName = currentIndex.sibling(currentIndex.row(), 0).data().toString();
 
-  _currentNetwork = Client::network(networkId);
-  if(!_currentNetwork)
-    return;
+void TabCompleter::buildCompletionList()
+{
+    // ensure a safe state in case we return early.
+    _completionMap.clear();
+    _nextCompletion = _completionMap.begin();
+
+    // this is the first time tab is pressed -> build up the completion list and it's iterator
+    QModelIndex currentIndex = Client::bufferModel()->currentIndex();
+    _currentBufferId = currentIndex.data(NetworkModel::BufferIdRole).value<BufferId>();
+    if (!_currentBufferId.isValid())
+        return;
 
-  QString tabAbbrev = inputLine->text().left(inputLine->cursorPosition()).section(' ',-1,-1);
-  QRegExp regex(QString("^[^a-zA-Z]*").append(QRegExp::escape(tabAbbrev)), Qt::CaseInsensitive);
+    NetworkId networkId = currentIndex.data(NetworkModel::NetworkIdRole).value<NetworkId>();
+    _currentBufferName = currentIndex.sibling(currentIndex.row(), 0).data().toString();
 
-  switch(static_cast<BufferInfo::Type>(currentIndex.data(NetworkModel::BufferTypeRole).toInt())) {
-  case BufferInfo::ChannelBuffer:
-    { // scope is needed for local var declaration
-      IrcChannel *channel = _currentNetwork->ircChannel(bufferName);
-      if(!channel)
+    _currentNetwork = Client::network(networkId);
+    if (!_currentNetwork)
         return;
-      foreach(IrcUser *ircUser, channel->ircUsers()) {
-        if(regex.indexIn(ircUser->nick()) > -1)
-          completionMap[ircUser->nick().toLower()] = ircUser->nick();
-      }
+
+    QString tabAbbrev = _lineEdit->text().left(_lineEdit->cursorPosition()).section(QRegExp("[^#\\w\\d-_\\[\\]{}|`^.\\\\]"), -1, -1);
+    QRegExp regex(QString("^[-_\\[\\]{}|`^.\\\\]*").append(QRegExp::escape(tabAbbrev)), Qt::CaseInsensitive);
+
+    // channel completion - add all channels of the current network to the map
+    if (tabAbbrev.startsWith('#')) {
+        _completionType = ChannelTab;
+        foreach(IrcChannel *ircChannel, _currentNetwork->ircChannels()) {
+            if (regex.indexIn(ircChannel->name()) > -1)
+                _completionMap[ircChannel->name()] = ircChannel->name();
+        }
+    }
+    else {
+        // user completion
+        _completionType = UserTab;
+        switch (static_cast<BufferInfo::Type>(currentIndex.data(NetworkModel::BufferTypeRole).toInt())) {
+        case BufferInfo::ChannelBuffer:
+        { // scope is needed for local var declaration
+            IrcChannel *channel = _currentNetwork->ircChannel(_currentBufferName);
+            if (!channel)
+                return;
+            foreach(IrcUser *ircUser, channel->ircUsers()) {
+                if (regex.indexIn(ircUser->nick()) > -1)
+                    _completionMap[ircUser->nick().toLower()] = ircUser->nick();
+            }
+        }
+        break;
+        case BufferInfo::QueryBuffer:
+            if (regex.indexIn(_currentBufferName) > -1)
+                _completionMap[_currentBufferName.toLower()] = _currentBufferName;
+        case BufferInfo::StatusBuffer:
+            if (!_currentNetwork->myNick().isEmpty() && regex.indexIn(_currentNetwork->myNick()) > -1)
+                _completionMap[_currentNetwork->myNick().toLower()] = _currentNetwork->myNick();
+            break;
+        default:
+            return;
+        }
     }
-    break;
-  case BufferInfo::QueryBuffer:
-    if(regex.indexIn(bufferName) > -1)
-      completionMap[bufferName.toLower()] = bufferName;
-  case BufferInfo::StatusBuffer:
-    if(!_currentNetwork->myNick().isEmpty() && regex.indexIn(_currentNetwork->myNick()) > -1)
-      completionMap[_currentNetwork->myNick().toLower()] = _currentNetwork->myNick();
-    break;
-  default:
-    return;
-  }
 
-  nextCompletion = completionMap.begin();
-  lastCompletionLength = tabAbbrev.length();
+    _nextCompletion = _completionMap.begin();
+    _lastCompletionLength = tabAbbrev.length();
 }
 
-void TabCompleter::complete() {
-  NickCompletionSettings s;
-  nickSuffix = s.completionSuffix();
 
-  if(!enabled) {
-    buildCompletionList();
-    enabled = true;
-  }
+void TabCompleter::complete()
+{
+    TabCompletionSettings s;
+    _nickSuffix = s.completionSuffix();
 
-  if (nextCompletion != completionMap.end()) {
-    // clear previous completion
-    for (int i = 0; i < lastCompletionLength; i++) {
-      inputLine->backspace();
+    if (!_enabled) {
+        buildCompletionList();
+        _enabled = true;
     }
 
-    // insert completion
-    inputLine->insert(*nextCompletion);
-
-    // remember charcount to delete next time and advance to next completion
-    lastCompletionLength = nextCompletion->length();
-    nextCompletion++;
-
-    // we're completing the first word of the line
-    if(inputLine->cursorPosition() == lastCompletionLength) {
-      inputLine->insert(nickSuffix);
-      lastCompletionLength += nickSuffix.length();
+    if (_nextCompletion != _completionMap.end()) {
+        // clear previous completion
+        for (int i = 0; i < _lastCompletionLength; i++) {
+            _lineEdit->backspace();
+        }
+
+        // insert completion
+        _lineEdit->insert(*_nextCompletion);
+
+        // remember charcount to delete next time and advance to next completion
+        _lastCompletionLength = _nextCompletion->length();
+        _nextCompletion++;
+
+        // we're completing the first word of the line
+        if (_completionType == UserTab && _lineEdit->cursorPosition() == _lastCompletionLength) {
+            _lineEdit->insert(_nickSuffix);
+            _lastCompletionLength += _nickSuffix.length();
+        }
+        else if (s.addSpaceMidSentence()) {
+            _lineEdit->insert(" ");
+            _lastCompletionLength++;
+        }
+
+        // we're at the end of the list -> start over again
     }
-
-  // we're at the end of the list -> start over again
-  } else {
-    if(!completionMap.isEmpty()) {
-      nextCompletion = completionMap.begin();
-      complete();
+    else {
+        if (!_completionMap.isEmpty()) {
+            _nextCompletion = _completionMap.begin();
+            complete();
+        }
     }
-  }
 }
 
-void TabCompleter::reset() {
-  enabled = false;
+
+void TabCompleter::reset()
+{
+    _enabled = false;
 }
 
-bool TabCompleter::eventFilter(QObject *obj, QEvent *event) {
-  if(obj != inputLine || event->type() != QEvent::KeyPress)
-    return QObject::eventFilter(obj, event);
 
-  QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
+bool TabCompleter::eventFilter(QObject *obj, QEvent *event)
+{
+    if (obj != _lineEdit || event->type() != QEvent::KeyPress)
+        return QObject::eventFilter(obj, event);
+
+    QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
 
-  if(keyEvent->key() == Qt::Key_Tab) {
-    complete();
-    return true;
-  } else {
-    reset();
+    if (keyEvent->key() != GraphicalUi::actionCollection("General")->action("TabCompletionKey")->shortcut()) {
+        reset();
+    }
     return false;
-  }
 }
 
+
 // this determines the sort order
-bool TabCompleter::CompletionKey::operator<(const CompletionKey &other) const {
-  IrcUser *thisUser = _currentNetwork->ircUser(this->nick);
-  IrcUser *thatUser = _currentNetwork->ircUser(other.nick);
-  if(!thisUser || !thatUser)
-    return QString::localeAwareCompare(this->nick, other.nick) < 0;
+bool TabCompleter::CompletionKey::operator<(const CompletionKey &other) const
+{
+    switch (_completionType) {
+    case UserTab:
+    {
+        IrcUser *thisUser = _currentNetwork->ircUser(this->contents);
+        if (thisUser && _currentNetwork->isMe(thisUser))
+            return false;
+
+        IrcUser *thatUser = _currentNetwork->ircUser(other.contents);
+        if (thatUser && _currentNetwork->isMe(thatUser))
+            return true;
 
-  QDateTime thisSpokenTo = thisUser->lastSpokenTo(_currentBufferId);
-  QDateTime thatSpokenTo = thatUser->lastSpokenTo(_currentBufferId);
+        if (!thisUser || !thatUser)
+            return QString::localeAwareCompare(this->contents, other.contents) < 0;
 
-  if(thisSpokenTo.isValid() || thatSpokenTo.isValid())
-    return thisSpokenTo > thatSpokenTo;
+        QDateTime thisSpokenTo = thisUser->lastSpokenTo(_currentBufferId);
+        QDateTime thatSpokenTo = thatUser->lastSpokenTo(_currentBufferId);
 
-  QDateTime thisTime = thisUser->lastChannelActivity(_currentBufferId);
-  QDateTime thatTime = thatUser->lastChannelActivity(_currentBufferId);
+        if (thisSpokenTo.isValid() || thatSpokenTo.isValid())
+            return thisSpokenTo > thatSpokenTo;
 
-  if(thisTime.isValid() || thatTime.isValid())
-    return thisTime > thatTime;
+        QDateTime thisTime = thisUser->lastChannelActivity(_currentBufferId);
+        QDateTime thatTime = thatUser->lastChannelActivity(_currentBufferId);
+
+        if (thisTime.isValid() || thatTime.isValid())
+            return thisTime > thatTime;
+    }
+    break;
+    case ChannelTab:
+        if (QString::compare(_currentBufferName, this->contents, Qt::CaseInsensitive) == 0)
+            return true;
+
+        if (QString::compare(_currentBufferName, other.contents, Qt::CaseInsensitive) == 0)
+            return false;
+        break;
+    default:
+        break;
+    }
 
-  return QString::localeAwareCompare(this->nick, other.nick) < 0;
+    return QString::localeAwareCompare(this->contents, other.contents) < 0;
 }