1 /***************************************************************************
2 * Copyright (C) 2005-2020 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #include "tabcompleter.h"
26 #include "actioncollection.h"
27 #include "buffermodel.h"
29 #include "graphicalui.h"
30 #include "ircchannel.h"
32 #include "multilineedit.h"
34 #include "networkmodel.h"
35 #include "uisettings.h"
37 const Network* TabCompleter::_currentNetwork;
38 BufferId TabCompleter::_currentBufferId;
39 QString TabCompleter::_currentBufferName;
40 TabCompleter::Type TabCompleter::_completionType;
42 TabCompleter::TabCompleter(MultiLineEdit* _lineEdit)
44 , _lineEdit(_lineEdit)
48 // This Action just serves as a container for the custom shortcut and isn't actually handled;
49 // apparently, using tab as an Action shortcut in an input widget is unreliable on some platforms (e.g. OS/2)
50 _lineEdit->installEventFilter(this);
51 ActionCollection* coll = GraphicalUi::actionCollection("General");
52 QAction* a = coll->addAction("TabCompletionKey",
53 new Action(tr("Tab completion"), coll, this, &TabCompleter::onTabCompletionKey, QKeySequence(Qt::Key_Tab)));
54 a->setEnabled(false); // avoid catching the shortcut
57 void TabCompleter::onTabCompletionKey()
59 // do nothing; we use the event filter instead
62 void TabCompleter::buildCompletionList()
64 // ensure a safe state in case we return early.
65 _completionMap.clear();
66 _nextCompletion = _completionMap.begin();
68 // this is the first time tab is pressed -> build up the completion list and it's iterator
69 QModelIndex currentIndex = Client::bufferModel()->currentIndex();
70 _currentBufferId = currentIndex.data(NetworkModel::BufferIdRole).value<BufferId>();
71 if (!_currentBufferId.isValid())
74 NetworkId networkId = currentIndex.data(NetworkModel::NetworkIdRole).value<NetworkId>();
75 _currentBufferName = currentIndex.sibling(currentIndex.row(), 0).data().toString();
77 _currentNetwork = Client::network(networkId);
81 QString tabAbbrev = _lineEdit->text().left(_lineEdit->cursorPosition()).section(QRegExp(R"([^#\w\d-_\[\]{}|`^.\\])"), -1, -1);
82 QRegExp regex(QString(R"(^[-_\[\]{}|`^.\\]*)").append(QRegExp::escape(tabAbbrev)), Qt::CaseInsensitive);
84 // channel completion - add all channels of the current network to the map
85 if (tabAbbrev.startsWith('#')) {
86 _completionType = ChannelTab;
87 foreach (IrcChannel* ircChannel, _currentNetwork->ircChannels()) {
88 if (regex.indexIn(ircChannel->name()) > -1)
89 _completionMap[ircChannel->name()] = ircChannel->name();
94 _completionType = UserTab;
95 switch (static_cast<BufferInfo::Type>(currentIndex.data(NetworkModel::BufferTypeRole).toInt())) {
96 case BufferInfo::ChannelBuffer: { // scope is needed for local var declaration
97 IrcChannel* channel = _currentNetwork->ircChannel(_currentBufferName);
100 foreach (IrcUser* ircUser, channel->ircUsers()) {
101 if (regex.indexIn(ircUser->nick()) > -1)
102 _completionMap[ircUser->nick().toLower()] = ircUser->nick();
105 case BufferInfo::QueryBuffer:
106 if (regex.indexIn(_currentBufferName) > -1)
107 _completionMap[_currentBufferName.toLower()] = _currentBufferName;
109 case BufferInfo::StatusBuffer:
110 if (!_currentNetwork->myNick().isEmpty() && regex.indexIn(_currentNetwork->myNick()) > -1)
111 _completionMap[_currentNetwork->myNick().toLower()] = _currentNetwork->myNick();
118 _nextCompletion = _completionMap.begin();
119 _lastCompletionLength = tabAbbrev.length();
122 void TabCompleter::complete()
124 TabCompletionSettings s;
125 _nickSuffix = s.completionSuffix();
128 buildCompletionList();
132 if (_nextCompletion != _completionMap.end()) {
133 // clear previous completion
134 for (int i = 0; i < _lastCompletionLength; i++) {
135 _lineEdit->backspace();
139 _lineEdit->insert(*_nextCompletion);
141 // remember charcount to delete next time and advance to next completion
142 _lastCompletionLength = _nextCompletion->length();
145 // we're completing the first word of the line
146 if (_completionType == UserTab && _lineEdit->cursorPosition() == _lastCompletionLength) {
147 _lineEdit->insert(_nickSuffix);
148 _lastCompletionLength += _nickSuffix.length();
150 else if (s.addSpaceMidSentence()) {
151 _lineEdit->addCompletionSpace();
152 _lastCompletionLength++;
155 // we're at the end of the list -> start over again
158 if (!_completionMap.isEmpty()) {
159 _nextCompletion = _completionMap.begin();
165 void TabCompleter::reset()
170 bool TabCompleter::eventFilter(QObject* obj, QEvent* event)
172 if (obj != _lineEdit || event->type() != QEvent::KeyPress)
173 return QObject::eventFilter(obj, event);
175 auto* keyEvent = static_cast<QKeyEvent*>(event);
177 if (keyEvent->key() == GraphicalUi::actionCollection("General")->action("TabCompletionKey")->shortcut()[0])
185 // this determines the sort order
186 bool TabCompleter::CompletionKey::operator<(const CompletionKey& other) const
188 switch (_completionType) {
190 IrcUser* thisUser = _currentNetwork->ircUser(this->contents);
191 if (thisUser && _currentNetwork->isMe(thisUser))
194 IrcUser* thatUser = _currentNetwork->ircUser(other.contents);
195 if (thatUser && _currentNetwork->isMe(thatUser))
198 if (!thisUser || !thatUser)
199 return QString::localeAwareCompare(this->contents, other.contents) < 0;
201 QDateTime thisSpokenTo = thisUser->lastSpokenTo(_currentBufferId);
202 QDateTime thatSpokenTo = thatUser->lastSpokenTo(_currentBufferId);
204 if (thisSpokenTo.isValid() || thatSpokenTo.isValid())
205 return thisSpokenTo > thatSpokenTo;
207 QDateTime thisTime = thisUser->lastChannelActivity(_currentBufferId);
208 QDateTime thatTime = thatUser->lastChannelActivity(_currentBufferId);
210 if (thisTime.isValid() || thatTime.isValid())
211 return thisTime > thatTime;
214 if (QString::compare(_currentBufferName, this->contents, Qt::CaseInsensitive) == 0)
217 if (QString::compare(_currentBufferName, other.contents, Qt::CaseInsensitive) == 0)
224 return QString::localeAwareCompare(this->contents, other.contents) < 0;