feature-pimpin'-up the chat input line in frontend:
authorsheepluva
Tue, 18 Oct 2011 14:28:50 +0200
changeset 6147 b4d7d8d62feb
parent 6146 c7c2dd71ced4
child 6148 726daa066fea
feature-pimpin'-up the chat input line in frontend: ESC key will clear input TAB key will expand names and commands
QTfrontend/ui/widget/SmartLineEdit.cpp
QTfrontend/ui/widget/SmartLineEdit.h
QTfrontend/ui/widget/chatwidget.cpp
QTfrontend/ui/widget/chatwidget.h
project_files/hedgewars.pro
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/QTfrontend/ui/widget/SmartLineEdit.cpp	Tue Oct 18 14:28:50 2011 +0200
@@ -0,0 +1,246 @@
+/*
+ * Hedgewars, a free turn based strategy game
+ * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
+ * Copyright (c) 2007-2011 Andrey Korotaev <unC0Rr@gmail.com>
+ *
+ * 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; version 2 of the License
+ *
+ * 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
+ */
+
+#include <QStringList>
+
+#include "SmartLineEdit.h"
+
+SmartLineEdit::SmartLineEdit(QWidget * parent)
+: QLineEdit(parent)
+{
+    m_whitespace = QRegExp("\\s");
+
+    m_cmds  = new QStringList();
+    m_nicks = new QStringList();
+
+    reset();
+
+    // reset when cursor is moved or content is changed
+    connect(this, SIGNAL(cursorPositionChanged(int, int)), this, SLOT(reset()));
+    connect(this, SIGNAL(textChanged(const QString&)), this, SLOT(reset()));
+}
+
+
+void SmartLineEdit::addCommands(const QStringList & commands)
+{
+    m_mutex.lock();
+
+    m_cmds->append(commands);
+
+    m_mutex.unlock();
+}
+
+
+void SmartLineEdit::removeCommands(const QStringList & commands)
+{
+    m_mutex.lock();
+
+    foreach (const QString & cmd, commands)
+    {
+        m_cmds->removeAll(cmd);
+    }
+
+    m_mutex.unlock();
+}
+
+
+void SmartLineEdit::addNickname(const QString & name)
+{
+    m_mutex.lock();
+
+    m_nicks->append(name);
+
+    m_mutex.unlock();
+}
+
+
+void SmartLineEdit::removeNickname(const QString & name)
+{
+    m_mutex.lock();
+
+    m_nicks->removeAll(name);
+
+    m_mutex.unlock();
+}
+
+bool SmartLineEdit::event(QEvent * event)
+{
+    // we only want special treatment for key press events
+    if (event->type() == QEvent::KeyPress)
+    {
+        QKeyEvent * keyEvent = static_cast<QKeyEvent*>(event);
+
+        // TAB key pressed and any useful chars in the matchMe -> let's process those
+        if ((keyEvent->key() == Qt::Key_Tab) && (!text().trimmed().isEmpty()))
+        {
+            keyPressEvent(keyEvent);
+            if (event->isAccepted())
+                return true;
+        }
+    }
+    return QLineEdit::event(event);
+}
+
+void SmartLineEdit::keyPressEvent(QKeyEvent * event)
+{
+    int key = event->key(); // retrieve pressed key
+
+    // auto-complete on pressed TAB (except for whitespace-only contents)
+    if ((key == Qt::Key_Tab) && (!text().trimmed().isEmpty()))
+    {
+        autoComplete();
+        event->accept();
+    }
+    // clear contents on pressed ESC
+    else if ((event->key() == Qt::Key_Escape) &&
+             (event->modifiers() == Qt::NoModifier)
+    )
+        clear();
+    // otherwise forward keys to parent
+    else
+        QLineEdit::keyPressEvent(event);
+}
+
+
+void SmartLineEdit::autoComplete()
+{
+    QString match = "";
+    bool isNick = false;
+    QString matchMe = text();
+    QString prefix = "";
+    QString postfix = "";
+    bool isFirstWord;
+
+    // we are trying to rematch, so use the data from earlier
+    if (m_hasJustMatched)
+    {
+        // restore values from earlier auto-completion
+        matchMe = m_beforeMatch;
+        prefix = m_prefix;
+        postfix = m_postfix;
+        isFirstWord = prefix.isEmpty();
+    }
+    else
+    {
+        m_mutex.lock();
+        m_cmds->sort();
+        m_nicks->sort();
+        m_mutex.unlock();
+
+        int cp = cursorPosition();
+
+        // cursor is not in or at end/beginning of word
+        if ((cp = matchMe.length()) || (QString(matchMe.at(cp)).contains(m_whitespace)))
+            if ((cp < 1) || (QString(matchMe.at(cp-1)).contains(m_whitespace)))
+                return;
+
+        // crop matchMe at cursor position
+        prefix  = matchMe.left (cp);
+        postfix = matchMe.right(matchMe.length()-cp);
+
+        matchMe = "";
+
+
+        // use the whole word the curser is on for matching
+        int prefixLen = prefix.lastIndexOf(m_whitespace) + 1;
+        int preWordLen = prefix.length() - prefixLen;
+        int postWordLen = postfix.indexOf(m_whitespace);
+        int postfixLen = 0;
+        if (postWordLen < 0)
+            postWordLen = postfix.length();
+        else
+            postfixLen = postfix.length() - (postWordLen + 1);
+
+        matchMe = prefix.right(preWordLen) + postfix.left(postWordLen);
+        prefix  = prefix.left(prefixLen);
+        postfix = postfix.right(postfixLen);
+
+
+        isFirstWord = prefix.isEmpty(); // true if first word
+    }
+
+
+    m_mutex.lock();
+
+    if (isFirstWord)
+    {
+        // find matching commands
+        foreach (const QString & cmd, *m_cmds)
+        {
+            if (cmd.startsWith(matchMe, Qt::CaseInsensitive))
+            {
+                match = cmd;
+
+                // move match to end so next time new matches will be prefered
+                if (m_cmds->removeAll(cmd) > 0);
+                    m_cmds->append(cmd);
+
+                break;
+            }
+        }
+    }
+
+    if (match.isEmpty())
+    {
+        // find matching nicks
+        foreach (const QString & nick, *m_nicks)
+        {
+            if (nick.startsWith(matchMe, Qt::CaseInsensitive))
+            {
+                match = nick;
+                isNick = true;
+
+                // move match to end so next time new matches will be prefered
+                if (m_nicks->removeAll(nick) > 0);
+                    m_nicks->append(nick);
+
+                break;
+            }
+        }
+    }
+
+    m_mutex.unlock();
+
+    // we found a single match?
+    if (!match.isEmpty())
+    {
+        // replace last word with match
+        // and append ':' if a name at the beginning of the matchMe got completed
+        // also add a space at the very end to ease further typing
+        QString addAfter = ((isNick && isFirstWord)?": ":" ");
+        match = prefix + match + addAfter;
+        setText(match + postfix);
+
+        setCursorPosition(match.length());
+
+        // save values for for the case a rematch is requested
+        m_beforeMatch = matchMe;
+        m_hasJustMatched = true;
+        m_prefix = prefix;
+        m_postfix = postfix;
+    }
+}
+
+void SmartLineEdit::reset()
+{
+    m_beforeMatch = "";
+    m_hasJustMatched = false;
+    m_prefix = "";
+    m_postfix = "";
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/QTfrontend/ui/widget/SmartLineEdit.h	Tue Oct 18 14:28:50 2011 +0200
@@ -0,0 +1,129 @@
+/*
+ * Hedgewars, a free turn based strategy game
+ * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
+ * Copyright (c) 2007-2011 Andrey Korotaev <unC0Rr@gmail.com>
+ *
+ * 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; version 2 of the License
+ *
+ * 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
+ */
+
+#ifndef HEDGEWARS_SMARTLINEDIT
+#define HEDGEWARS_SMARTLINEDIT
+
+#include <QLineEdit>
+#include <QStringList>
+#include <QString>
+
+#include <QEvent>
+#include <QKeyEvent>
+
+#include <QMutex>
+#include <QRegExp>
+
+class QLineEdit;
+
+/**
+ * A modification of QLineEdit that will attempt to auto-complete the current
+ * word with cursor when the TAB key is pressed.
+ * Additionally it will delete its contents when ESC is pressed.
+ * A Keyword can either be a command (if first word) or
+ * a nickname (completed if any word)
+ * @author sheepluva
+ * @since 0.9.17
+ */
+class SmartLineEdit : public QLineEdit
+{
+ Q_OBJECT
+
+public:
+    /**
+    * Class constructor.
+    */
+    SmartLineEdit(QWidget * parent = 0);
+
+    /**
+     * Adds commands to the auto-completion feature.
+     * @param commands list of commands to be added.
+     */
+    void addCommands(const QStringList & commands);
+
+    /**
+     * Adds a single nickname to the auto-completion feature.
+     * @param nickname name to be added.
+     */
+    void addNickname(const QString & nickname);
+
+    /**
+     * Removes commands from the auto-completion feature.
+     * @param commands list of commands to be removed.
+     */
+    void removeCommands(const QStringList & commands);
+
+    /**
+     * Removes a single nickname from the auto-completion feature.
+     * @param nickname name to be removed.
+     */
+    void removeNickname(const QString & nickname);
+
+
+protected:
+    /**
+     * Overrides method of parent class.
+     * Forward pressed TAB to parent class' method (for focus handling etc)
+     * only if line is empty.
+     * @param event the key event.
+     * @return returns true if the event was recognized.
+     */
+    virtual bool event(QEvent * event);
+
+    /**
+     * Overrides method of parent class.
+     * Autocompletes if TAB is reported as pressed key in the key event,
+     * otherwise keys except for ESC (with no modifiers)
+     * are forwarded to parent method.
+     * ESC leads to the contents being cleared.
+     * @param event the key event.
+     */
+    virtual void keyPressEvent(QKeyEvent * event);
+
+
+private:
+    QRegExp m_whitespace; // regexp that matches a whitespace
+
+    QStringList * m_cmds;  // list of recognized commands
+    QStringList * m_nicks; // list of recognized nicknames
+
+    // these variables contain information about the last replacement
+    // they get reset whenever cursor is moved or text is changed
+
+    QString m_beforeMatch; // the string that was just matched
+    bool m_hasJustMatched; // whether this widget just did an auto-completion
+    QString m_prefix; // prefix of the text replacement this widget just did
+    QString m_postfix; // postfix of the text replacement this widget just did
+
+    QMutex m_mutex; // make all the QStringList action thread-safe
+
+    /**
+     * Autocompletes the contents based on the known commands and/or names
+     */
+    void autoComplete();
+
+
+private slots:
+    // resets the information about the last match and text replacement
+    void reset();
+};
+
+
+
+#endif // HEDGEWARS_SMARTLINEDIT
--- a/QTfrontend/ui/widget/chatwidget.cpp	Tue Oct 18 00:13:50 2011 +0200
+++ b/QTfrontend/ui/widget/chatwidget.cpp	Tue Oct 18 14:28:50 2011 +0200
@@ -140,7 +140,8 @@
     mainLayout.setColumnStretch(0, 76);
     mainLayout.setColumnStretch(1, 24);
 
-    chatEditLine = new QLineEdit(this);
+    chatEditLine = new SmartLineEdit(this);
+    chatEditLine->addCommands(QStringList("/me"));
     chatEditLine->setMaxLength(300);
     connect(chatEditLine, SIGNAL(returnPressed()), this, SLOT(returnPressed()));
 
@@ -413,6 +414,8 @@
 
 void HWChatWidget::nickAdded(const QString& nick, bool notifyNick)
 {
+    chatEditLine->addNickname(nick);
+
     QListWidgetItem * item = new ListWidgetNickItem(nick, friendsList.contains(nick, Qt::CaseInsensitive), ignoreList.contains(nick, Qt::CaseInsensitive));
     updateNickItem(item);
     chatNicks->addItem(item);
@@ -426,6 +429,8 @@
 
 void HWChatWidget::nickRemoved(const QString& nick)
 {
+    chatEditLine->removeNickname(nick);
+
     foreach(QListWidgetItem * item, chatNicks->findItems(nick, Qt::MatchExactly))
         chatNicks->takeItem(chatNicks->row(item));
 
--- a/QTfrontend/ui/widget/chatwidget.h	Tue Oct 18 00:13:50 2011 +0200
+++ b/QTfrontend/ui/widget/chatwidget.h	Tue Oct 18 14:28:50 2011 +0200
@@ -28,6 +28,8 @@
 
 #include "SDLs.h"
 
+#include "SmartLineEdit.h"
+
 class ListWidgetNickItem;
 class QTextBrowser;
 class QLineEdit;
@@ -95,7 +97,7 @@
   QTextBrowser* chatText;
   QStringList chatStrings;
   QListWidget* chatNicks;
-  QLineEdit* chatEditLine;
+  SmartLineEdit* chatEditLine;
   QAction * acInfo;
   QAction * acKick;
   QAction * acBan;
--- a/project_files/hedgewars.pro	Tue Oct 18 00:13:50 2011 +0200
+++ b/project_files/hedgewars.pro	Tue Oct 18 14:28:50 2011 +0200
@@ -69,6 +69,7 @@
     ../QTfrontend/ui/widget/selectWeapon.h \
     ../QTfrontend/ui/widget/weaponItem.h \
     ../QTfrontend/ui/widget/gamecfgwidget.h \
+    ../QTfrontend/ui/widget/SmartLineEdit.h \
     ../QTfrontend/net/netregister.h \
     ../QTfrontend/net/netserver.h \
     ../QTfrontend/net/netudpwidget.h \
@@ -141,6 +142,7 @@
     ../QTfrontend/ui/widget/teamselhelper.cpp \
     ../QTfrontend/ui/widget/drawmapwidget.cpp \
     ../QTfrontend/ui/widget/weaponItem.cpp \
+    ../QTfrontend/ui/widget/SmartLineEdit.cpp \
     ../QTfrontend/net/tcpBase.cpp \
     ../QTfrontend/net/netregister.cpp \
     ../QTfrontend/net/proto.cpp \