feat: settings for each parenthesis and tab jump out (#19)

ouuan · web-flow · commit 0b535efd010a · 2020-05-31T21:50:24.000+08:00
* feat: add per parentheses setting and tab jump out

1. Now you can configure each parenthesis of whether to auto-complete,
   auto-remove and tab jump out, or even add or delete parentheses.
2. Now you can use tab to jump out of a close parenthesis, which is
   optional for each parenthesis.

* chore: fix example

* fix: add default constructor for QCodeEditor::Parentheses

* refactor: use "Parenthesis" for the struct
diff --git a/example/include/MainWindow.hpp b/example/include/MainWindow.hpp
@@ -56,7 +56,6 @@ class MainWindow : public QMainWindow
 
     QCheckBox* m_readOnlyCheckBox;
     QCheckBox* m_wordWrapCheckBox;
-    QCheckBox* m_parenthesesEnabledCheckbox;
     QCheckBox* m_tabReplaceEnabledCheckbox;
     QSpinBox*  m_tabReplaceNumberSpinbox;
     QCheckBox* m_autoIndentationCheckbox;
diff --git a/example/src/MainWindow.cpp b/example/src/MainWindow.cpp
@@ -34,7 +34,6 @@ MainWindow::MainWindow(QWidget* parent) :
     m_styleCombobox(nullptr),
     m_readOnlyCheckBox(nullptr),
     m_wordWrapCheckBox(nullptr),
-    m_parenthesesEnabledCheckbox(nullptr),
     m_tabReplaceEnabledCheckbox(nullptr),
     m_tabReplaceNumberSpinbox(nullptr),
     m_autoIndentationCheckbox(nullptr),
@@ -147,7 +146,6 @@ void MainWindow::createWidgets()
 
     m_readOnlyCheckBox           = new QCheckBox("Read Only", setupGroup);
     m_wordWrapCheckBox           = new QCheckBox("Word Wrap", setupGroup);
-    m_parenthesesEnabledCheckbox = new QCheckBox("Auto Parentheses", setupGroup);
     m_tabReplaceEnabledCheckbox  = new QCheckBox("Tab Replace", setupGroup);
     m_tabReplaceNumberSpinbox    = new QSpinBox(setupGroup);
     m_autoIndentationCheckbox    = new QCheckBox("Auto Indentation", setupGroup);
@@ -177,7 +175,6 @@ void MainWindow::createWidgets()
     m_setupLayout->addWidget(m_styleCombobox);
     m_setupLayout->addWidget(m_readOnlyCheckBox);
     m_setupLayout->addWidget(m_wordWrapCheckBox);
-    m_setupLayout->addWidget(m_parenthesesEnabledCheckbox);
     m_setupLayout->addWidget(m_tabReplaceEnabledCheckbox);
     m_setupLayout->addWidget(m_tabReplaceNumberSpinbox);
     m_setupLayout->addWidget(m_autoIndentationCheckbox);
@@ -237,7 +234,6 @@ void MainWindow::setupWidgets()
     m_styleCombobox->addItems(list);
     list.clear();
 
-    m_parenthesesEnabledCheckbox->setChecked(m_codeEditor->autoParentheses());
     m_tabReplaceEnabledCheckbox->setChecked(m_codeEditor->tabReplace());
     m_tabReplaceNumberSpinbox->setValue(m_codeEditor->tabReplaceSize());
     m_tabReplaceNumberSpinbox->setSuffix(tr(" spaces"));
@@ -300,13 +296,6 @@ void MainWindow::performConnections()
         }
     );
 
-    connect(
-        m_parenthesesEnabledCheckbox,
-        &QCheckBox::stateChanged,
-        [this](int state)
-        { m_codeEditor->setAutoParentheses(state != 0); }
-    );
-
     connect(
         m_tabReplaceEnabledCheckbox,
         &QCheckBox::stateChanged,
diff --git a/include/internal/QCodeEditor.hpp b/include/internal/QCodeEditor.hpp
@@ -29,6 +29,18 @@ class QCodeEditor : public QTextEdit
         Error
     };
 
+    struct Parenthesis
+    {
+        QChar left, right;
+        bool autoComplete, autoRemove, tabJumpOut;
+
+        Parenthesis(const QChar &l = '(', const QChar &r = ')', bool complete = true, bool remove = true,
+                    bool jumpout = true)
+            : left(l), right(r), autoComplete(complete), autoRemove(remove), tabJumpOut(jumpout)
+        {
+        }
+    };
+
     /**
      * @brief Constructor.
      * @param widget Pointer to parent widget.
@@ -58,17 +70,6 @@ class QCodeEditor : public QTextEdit
      */
     void setSyntaxStyle(QSyntaxStyle *style);
 
-    /**
-     * @brief Method setting auto parentheses enabled.
-     */
-    void setAutoParentheses(bool enabled);
-
-    /**
-     * @brief Method for getting is auto parentheses enabled.
-     * Default value: true
-     */
-    bool autoParentheses() const;
-
     /**
      * @brief Method for setting tab replacing
      * enabled.
@@ -101,9 +102,9 @@ class QCodeEditor : public QTextEdit
     void setAutoIndentation(bool enabled);
 
     /**
-     * @brief Method for setting auto remove parenthesis enabled.
+     * @brief Method for setting the parentheses.
      */
-    void setAutoRemoveParentheses(bool enabled);
+    void setParentheses(const QVector<Parenthesis> &parentheses);
 
     /**
      * @brief Method for setting extra bottom margin enabled.
@@ -370,13 +371,13 @@ class QCodeEditor : public QTextEdit
     QCompleter *m_completer;
 
     bool m_autoIndentation;
-    bool m_autoParentheses;
     bool m_replaceTab;
-    bool m_autoRemoveParentheses;
     bool m_extraBottomMargin;
     QString m_tabReplace;
 
     QList<QTextEdit::ExtraSelection> extra1, extra2, extra_squiggles;
 
     QVector<SquiggleInformation> m_squiggler;
+
+    QVector<Parenthesis> m_parentheses;
 };
diff --git a/src/internal/QCodeEditor.cpp b/src/internal/QCodeEditor.cpp
@@ -24,13 +24,11 @@
 #include <QTextStream>
 #include <QToolTip>
 
-static QVector<QPair<QString, QString>> parentheses = {{"(", ")"}, {"{", "}"}, {"[", "]"}, {"\"", "\""}, {"'", "'"}};
-
 QCodeEditor::QCodeEditor(QWidget *widget)
     : QTextEdit(widget), m_highlighter(nullptr), m_syntaxStyle(nullptr), m_lineNumberArea(new QLineNumberArea(this)),
-      m_completer(nullptr), m_autoIndentation(true), m_autoParentheses(true), m_replaceTab(true),
-      m_autoRemoveParentheses(true), m_extraBottomMargin(true), m_tabReplace(QString(4, ' ')), extra1(), extra2(),
-      extra_squiggles(), m_squiggler()
+      m_completer(nullptr), m_autoIndentation(true), m_replaceTab(true), m_extraBottomMargin(true),
+      m_tabReplace(QString(4, ' ')), extra1(), extra2(), extra_squiggles(), m_squiggler(),
+      m_parentheses({{'(', ')'}, {'{', '}'}, {'[', ']'}, {'\"', '\"'}, {'\'', '\''}})
 {
     initFont();
     performConnections();
@@ -400,24 +398,24 @@ void QCodeEditor::highlightParenthesis()
     auto currentSymbol = charUnderCursor();
     auto prevSymbol = charUnderCursor(-1);
 
-    for (auto &pair : parentheses)
+    for (auto &p : m_parentheses)
     {
         int direction;
 
         QChar counterSymbol;
         QChar activeSymbol;
         auto position = textCursor().position();
 
-        if (pair.first == currentSymbol)
+        if (p.left == currentSymbol)
         {
             direction = 1;
-            counterSymbol = pair.second[0];
+            counterSymbol = p.right;
             activeSymbol = currentSymbol;
         }
-        else if (pair.second == prevSymbol)
+        else if (p.right == prevSymbol)
         {
             direction = -1;
-            counterSymbol = pair.first[0];
+            counterSymbol = p.left;
             activeSymbol = prevSymbol;
             position--;
         }
@@ -661,7 +659,18 @@ void QCodeEditor::keyPressEvent(QKeyEvent *e)
                 indent();
                 return;
             }
-            else if (m_replaceTab)
+
+            auto c = charUnderCursor();
+            for (auto p : m_parentheses)
+            {
+                if (p.tabJumpOut && c == p.right)
+                {
+                    moveCursor(QTextCursor::NextCharacter);
+                    return;
+                }
+            }
+
+            if (m_replaceTab)
             {
                 insertPlainText(m_tabReplace);
                 return;
@@ -708,14 +717,13 @@ void QCodeEditor::keyPressEvent(QKeyEvent *e)
             return;
         }
 
-        if (m_autoRemoveParentheses && e->key() == Qt::Key_Backspace && e->modifiers() == Qt::NoModifier &&
-            !textCursor().hasSelection())
+        if (e->key() == Qt::Key_Backspace && e->modifiers() == Qt::NoModifier && !textCursor().hasSelection())
         {
             auto pre = charUnderCursor(-1);
             auto nxt = charUnderCursor();
-            for (auto p : parentheses)
+            for (auto p : m_parentheses)
             {
-                if (p.first == pre && p.second == nxt)
+                if (p.autoRemove && p.left == pre && p.right == nxt)
                 {
                     auto cursor = textCursor();
                     cursor.movePosition(QTextCursor::Left, QTextCursor::MoveAnchor);
@@ -753,20 +761,20 @@ void QCodeEditor::keyPressEvent(QKeyEvent *e)
             }
         }
 
-        if (m_autoParentheses)
+        for (auto p : m_parentheses)
         {
-            for (auto &&el : parentheses)
+            if (p.autoComplete)
             {
-                // Add parentheses for selection
-                if (el.first == e->text())
+                auto cursor = textCursor();
+                if (cursor.hasSelection())
                 {
-                    auto cursor = textCursor();
-                    if (cursor.hasSelection())
+                    if (p.left == e->text())
                     {
+                        // Add parentheses for selection
                         int startPos = cursor.selectionStart();
                         int endPos = cursor.selectionEnd();
                         bool cursorAtEnd = cursor.position() == endPos;
-                        auto text = el.first + cursor.selectedText() + el.second;
+                        auto text = p.left + cursor.selectedText() + p.right;
                         insertPlainText(text);
                         if (cursorAtEnd)
                         {
@@ -782,6 +790,26 @@ void QCodeEditor::keyPressEvent(QKeyEvent *e)
                         return;
                     }
                 }
+                else
+                {
+                    if (p.right == e->text())
+                    {
+                        auto symbol = charUnderCursor();
+
+                        if (symbol == p.right)
+                        {
+                            moveCursor(QTextCursor::NextCharacter);
+                            return;
+                        }
+                    }
+
+                    if (p.left == e->text())
+                    {
+                        insertPlainText(QString(p.left) + p.right);
+                        moveCursor(QTextCursor::PreviousCharacter);
+                        return;
+                    }
+                }
             }
         }
 
@@ -792,31 +820,6 @@ void QCodeEditor::keyPressEvent(QKeyEvent *e)
             return;
         }
 
-        if (m_autoParentheses)
-        {
-            for (auto &&el : parentheses)
-            {
-                // If it's close brace - check parentheses
-                if (el.second == e->text())
-                {
-                    auto symbol = charUnderCursor();
-
-                    if (symbol == el.second)
-                    {
-                        moveCursor(QTextCursor::MoveOperation::Right);
-                        return;
-                    }
-                }
-                // Inserting closed brace
-                if (el.first == e->text())
-                {
-                    insertPlainText(el.first + el.second);
-                    moveCursor(QTextCursor::MoveOperation::Left);
-                    return;
-                }
-            }
-        }
-
         QTextEdit::keyPressEvent(e);
     }
 
@@ -828,9 +831,9 @@ void QCodeEditor::setAutoIndentation(bool enabled)
     m_autoIndentation = enabled;
 }
 
-void QCodeEditor::setAutoRemoveParentheses(bool enabled)
+void QCodeEditor::setParentheses(const QVector<Parenthesis> &parentheses)
 {
-    m_autoRemoveParentheses = enabled;
+    m_parentheses = parentheses;
 }
 
 void QCodeEditor::setExtraBottomMargin(bool enabled)
@@ -844,16 +847,6 @@ bool QCodeEditor::autoIndentation() const
     return m_autoIndentation;
 }
 
-void QCodeEditor::setAutoParentheses(bool enabled)
-{
-    m_autoParentheses = enabled;
-}
-
-bool QCodeEditor::autoParentheses() const
-{
-    return m_autoParentheses;
-}
-
 void QCodeEditor::setTabReplace(bool enabled)
 {
     m_replaceTab = enabled;
