Added Utils::BraceMatcher.

Change-Id: I76676ce75bf029a13e2e848c6dd746eabc4f1d39
Reviewed-by: Leandro Melo <leandro.melo@nokia.com>

src/libs/utils/bracematcher.cpp

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Konstantin Tokarev <annulen@yandex.ru>
+**
+** Contact: http://www.qt-project.org/
+**
+**
+** GNU Lesser General Public License Usage
+**
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this file.
+** Please review the following information to ensure the GNU Lesser General
+** Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**************************************************************************/
+
+#include "bracematcher.h"
+
+#include <QTextDocument>
+#include <QTextCursor>
+
+/*!
+    \class Utils::BraceMatcher
+    \brief Generic autocompleter of braces and quotes.
+
+    This is a helper class for autocompleter implementations. To use it,
+    define "brace", "quote", and "delimiter" characters for given language.
+*/
+
+namespace Utils {
+
+/*!
+ * Adds a pair of characters, corresponding to opening and closing braces.
+ */
+void BraceMatcher::addBraceCharPair(const QChar opening, const QChar closing)
+{
+    m_braceChars[opening] = closing;
+}
+
+/*!
+ * Adds quote character
+ */
+void BraceMatcher::addQuoteChar(const QChar quote)
+{
+    m_quoteChars << quote;
+}
+
+/*!
+ * Adds separator character that should be skipped when overtyping it, e.g.
+ * it could be ';' or ',' in C-like languages.
+ */
+void BraceMatcher::addDelimiterChar(const QChar sep)
+{
+    m_delimiterChars << sep;
+}
+
+bool BraceMatcher::shouldInsertMatchingText(const QTextCursor &tc) const
+{
+    QTextDocument *doc = tc.document();
+    return shouldInsertMatchingText(doc->characterAt(tc.selectionEnd()));
+}
+
+bool BraceMatcher::shouldInsertMatchingText(const QChar lookAhead) const
+{
+    return lookAhead.isSpace()
+        || isQuote(lookAhead)
+        || isDelimiter(lookAhead)
+        || isClosingBrace(lookAhead);
+}
+
+QString BraceMatcher::insertMatchingBrace(const QTextCursor &cursor,
+                                          const QString &text,
+                                          const QChar la,
+                                          int *skippedChars) const
+{
+    if (text.length() != 1)
+        return QString();
+
+    if (!shouldInsertMatchingText(cursor))
+        return QString();
+
+    const QChar ch = text.at(0);
+    if (isQuote(ch)) {
+        if (la != ch)
+            return QString(ch);
+        ++*skippedChars;
+        return QString();
+    }
+
+    if (isOpeningBrace(ch))
+        return QString(m_braceChars[ch]);
+
+    if (isDelimiter(ch) || isClosingBrace(ch)) {
+        if (la == ch)
+            ++*skippedChars;
+    }
+
+    return QString();
+}
+
+/*!
+ * Returns true if given character was added as one of character types.
+ */
+bool BraceMatcher::isKnownChar(const QChar c) const
+{
+    return isQuote(c) || isDelimiter(c) || isOpeningBrace(c) || isClosingBrace(c);
+}
+
+} // namespace Utils

src/libs/utils/bracematcher.h

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Konstantin Tokarev <annulen@yandex.ru>
+**
+** Contact: http://www.qt-project.org/
+**
+**
+** GNU Lesser General Public License Usage
+**
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this file.
+** Please review the following information to ensure the GNU Lesser General
+** Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**************************************************************************/
+
+#ifndef BRACEMATCHER_H
+#define BRACEMATCHER_H
+
+#include "utils_global.h"
+
+#include <QChar>
+#include <QSet>
+#include <QMap>
+
+QT_BEGIN_NAMESPACE
+class QString;
+class QTextCursor;
+QT_END_NAMESPACE
+
+namespace Utils {
+
+class QTCREATOR_UTILS_EXPORT BraceMatcher
+{
+public:
+    void addBraceCharPair(const QChar opening, const QChar closing);
+    void addQuoteChar(const QChar quote);
+    void addDelimiterChar(const QChar delim);
+
+    bool shouldInsertMatchingText(const QTextCursor &tc) const;
+    bool shouldInsertMatchingText(const QChar lookAhead) const;
+
+    QString insertMatchingBrace(const QTextCursor &tc, const QString &text,
+                                const QChar la, int *skippedChars) const;
+
+    bool isOpeningBrace(const QChar c) const { return m_braceChars.contains(c); }
+    bool isClosingBrace(const QChar c) const { return m_braceChars.values().contains(c); }
+    bool isQuote(const QChar c) const { return m_quoteChars.contains(c); }
+    bool isDelimiter(const QChar c) const { return m_delimiterChars.contains(c); }
+    bool isKnownChar(const QChar c) const;
+
+private:
+    QMap<QChar, QChar> m_braceChars;
+    QSet<QChar> m_quoteChars;
+    QSet<QChar> m_delimiterChars;
+};
+
+}  // namespace Utils
+
+#endif // BRACEMATCHER_H

src/libs/utils/utils-lib.pri

@@ -78,7 +78,8 @@ SOURCES += $$PWD/environment.cpp \
     $$PWD/appmainwindow.cpp \
     $$PWD/basetreeview.cpp \
     $$PWD/qtcassert.cpp \
-    $$PWD/elfreader.cpp
+    $$PWD/elfreader.cpp \
+    $$PWD/bracematcher.cpp
 
 win32 {
     SOURCES += \
@@ -163,7 +164,8 @@ HEADERS += \
     $$PWD/tcpportsgatherer.h \
     $$PWD/appmainwindow.h \
     $$PWD/basetreeview.h \
-    $$PWD/elfreader.h
+    $$PWD/elfreader.h \
+    $$PWD/bracematcher.h
 
 FORMS += $$PWD/filewizardpage.ui \
     $$PWD/projectintropage.ui \

src/libs/utils/utils.qbs

@@ -40,6 +40,8 @@ QtcLibrary {
         "basetreeview.h",
         "basevalidatinglineedit.cpp",
         "basevalidatinglineedit.h",
+        "bracematcher.cpp",
+        "bracematcher.h",
         "buildablehelperlibrary.h",
         "changeset.cpp",
         "changeset.h",