Merge branch 'language-server'

Author: coder3101

.github/workflows/build_test.yml

@@ -1,6 +1,16 @@
 name: "CI: Build Test"
 
-on: [push, pull_request]
+on:
+  push:
+    paths-ignore:
+      - '*.md'
+      - '*/*.md'
+      - '*/*/*.md'
+  pull_request:
+    paths-ignore:
+      - '*.md'
+      - '*/*.md'
+      - '*/*/*.md'
 
 env:
   CMAKE_VERSION: 3.17.1

CMakeLists.txt

@@ -6,8 +6,8 @@ set(CMAKE_CXX_STANDARD 11)
 option(BUILD_EXAMPLE "Example building required" Off)
 
 if (${BUILD_EXAMPLE})
-    message(STATUS "QCodeEditor example will be built.")
-    add_subdirectory(example)
+   message(STATUS "QCodeEditor example will be built.")
+   add_subdirectory(example)
 endif()
 
 set(RESOURCES_FILE

example/src/MainWindow.cpp

@@ -192,7 +192,13 @@ void MainWindow::setupWidgets()
     m_codeEditor->setPlainText  (m_codeSamples[0].second);
     m_codeEditor->setSyntaxStyle(m_styles[0].second);
     m_codeEditor->setCompleter  (m_completers[0].second);
-    m_codeEditor->setHighlighter(m_highlighters[0].second);
+    m_codeEditor->setHighlighter(new QCXXHighlighter);
+
+   // m_codeEditor->squiggle(QCodeEditor::SeverityLevel::Warning, {3,2}, {13,5}, "unused variable");
+    m_codeEditor->squiggle(QCodeEditor::SeverityLevel::Error, {7,0}, {8,0}, "Big error");
+
+
+    //m_codeEditor->clearSquiggle();
 
     QStringList list;
     // Code samples

include/internal/QCodeEditor.hpp

@@ -3,6 +3,9 @@
 // Qt
 #include <QTextEdit> // Required for inheritance
 
+// Standard
+#include <set>
+
 class QCompleter;
 class QLineNumberArea;
 class QSyntaxStyle;
@@ -17,6 +20,17 @@ class QCodeEditor : public QTextEdit
     Q_OBJECT
 
   public:
+    /**
+     * @brief The SeverityLevel enum
+     */
+    enum class SeverityLevel
+    {
+        Error,
+        Warning,
+        Information,
+        Hint
+    };
+
     /**
      * @brief Constructor.
      * @param widget Pointer to parent widget.
@@ -111,6 +125,20 @@ class QCodeEditor : public QTextEdit
      */
     QCompleter *completer() const;
 
+    /**
+     * @brief squiggle Puts a underline squiggle under text ranges in Editor
+     * @param level defines the color of the underline depending upon the severity
+     * @param tooltipMessage The tooltip hover message to show when over selection.
+     * @note QPair<int, int>: first -> Line number in 1-based indexing
+     *                        second -> Character number in 0-based indexing
+     */
+    void squiggle(SeverityLevel level, QPair<int, int>, QPair<int, int>, QString tooltipMessage);
+
+    /**
+     * @brief clearSquiggle, Clears complete squiggle from editor
+     */
+    void clearSquiggle();
+
   public Q_SLOTS:
 
     /**
@@ -226,6 +254,11 @@ class QCodeEditor : public QTextEdit
      */
     void focusInEvent(QFocusEvent *e) override;
 
+    /**
+     * @brief Method for tooltip generation
+     */
+    bool event(QEvent *e) override;
+
   private:
     /**
      * @brief Method for initializing default
@@ -300,6 +333,21 @@ class QCodeEditor : public QTextEdit
      */
     void addInEachLineOfSelection(const QRegularExpression &regex, const QString &str);
 
+    /**
+     * @brief The SquiggleInformation struct, Line number will be index of vector+1;
+     */
+    struct SquiggleInformation
+    {
+        SquiggleInformation(QPair<int, int> start, QPair<int, int> stop, QString text)
+            : m_startPos(start), m_stopPos(stop), m_tooltipText(std::move(text))
+        {
+        }
+
+        QPair<int, int> m_startPos;
+        QPair<int, int> m_stopPos;
+        QString m_tooltipText;
+    };
+
     QStyleSyntaxHighlighter *m_highlighter;
     QSyntaxStyle *m_syntaxStyle;
     QLineNumberArea *m_lineNumberArea;
@@ -311,5 +359,7 @@ class QCodeEditor : public QTextEdit
     bool m_autoRemoveParentheses;
     QString m_tabReplace;
 
-    QList<QTextEdit::ExtraSelection> extra1, extra2;
+    QList<QTextEdit::ExtraSelection> extra1, extra2, extra_squiggles;
+
+    std::vector<SquiggleInformation> m_squiggler;
 };

src/internal/QCodeEditor.cpp

@@ -1,3 +1,5 @@
+#include <utility>
+
 // QCodeEditor
 #include <QCXXHighlighter>
 #include <QCodeEditor>
@@ -13,6 +15,7 @@
 #include <QAbstractTextDocumentLayout>
 #include <QCompleter>
 #include <QCursor>
+#include <QDebug>
 #include <QFontDatabase>
 #include <QMimeData>
 #include <QPaintEvent>
@@ -21,16 +24,18 @@
 #include <QTextBlock>
 #include <QTextCharFormat>
 #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_tabReplace(QString(4, ' ')), extra1(), extra2()
+      m_autoRemoveParentheses(true), m_tabReplace(QString(4, ' ')), extra1(), extra2(), extra_squiggles(), m_squiggler()
 {
     initFont();
     performConnections();
+    setMouseTracking(true);
 
     setSyntaxStyle(QSyntaxStyle::defaultStyle());
 }
@@ -147,7 +152,7 @@ void QCodeEditor::updateExtraSelection1()
     highlightCurrentLine();
     highlightParenthesis();
 
-    setExtraSelections(extra1 + extra2);
+    setExtraSelections(extra1 + extra2 + extra_squiggles);
 }
 
 void QCodeEditor::updateExtraSelection2()
@@ -156,7 +161,7 @@ void QCodeEditor::updateExtraSelection2()
 
     highlightOccurrences();
 
-    setExtraSelections(extra1 + extra2);
+    setExtraSelections(extra1 + extra2 + extra_squiggles);
 }
 
 void QCodeEditor::indent()
@@ -421,7 +426,7 @@ void QCodeEditor::highlightParenthesis()
             selection.cursor = textCursor();
             selection.cursor.clearSelection();
             selection.cursor.movePosition(directionEnum, QTextCursor::MoveMode::MoveAnchor,
-                                          std::abs(textCursor().position() - position));
+                                          qAbs(textCursor().position() - position));
 
             selection.cursor.movePosition(QTextCursor::MoveOperation::Right, QTextCursor::MoveMode::KeepAnchor, 1);
 
@@ -473,7 +478,7 @@ void QCodeEditor::highlightOccurrences()
                 {
                     QTextEdit::ExtraSelection e;
                     e.cursor = cursor;
-                    e.format.setFontUnderline(true);
+                    e.format.setBackground(m_syntaxStyle->getFormat("Selection").background());
                     extra2.push_back(e);
                 }
                 cursor = doc->find(text, cursor, QTextDocument::FindWholeWords | QTextDocument::FindCaseSensitively);
@@ -820,6 +825,45 @@ void QCodeEditor::focusInEvent(QFocusEvent *e)
     QTextEdit::focusInEvent(e);
 }
 
+bool QCodeEditor::event(QEvent *event)
+{
+    if (event->type() == QEvent::ToolTip)
+    {
+        auto *helpEvent = dynamic_cast<QHelpEvent *>(event);
+        auto point = helpEvent->pos();
+        point.setX(point.x() - m_lineNumberArea->geometry().right());
+        QTextCursor cursor = cursorForPosition(point);
+
+        auto lineNumber = cursor.blockNumber() + 1;
+
+        QTextCursor copyCursor(cursor);
+        copyCursor.movePosition(QTextCursor::StartOfBlock);
+
+        auto blockPositionStart = cursor.positionInBlock() - copyCursor.positionInBlock();
+        QPair<int, int> positionOfTooltip{lineNumber, blockPositionStart};
+
+        QString text;
+        for (auto const &e : m_squiggler)
+        {
+            if (e.m_startPos <= positionOfTooltip && e.m_stopPos >= positionOfTooltip)
+            {
+                if (text.isEmpty())
+                    text = e.m_tooltipText;
+                else
+                    text += "; " + e.m_tooltipText;
+            }
+        }
+
+        if (text.isEmpty())
+            QToolTip::hideText();
+        else
+            QToolTip::showText(helpEvent->globalPos(), text);
+
+        return true;
+    }
+    return QTextEdit::event(event);
+}
+
 void QCodeEditor::insertCompletion(QString s)
 {
     if (m_completer->widget() != this)
@@ -838,6 +882,65 @@ QCompleter *QCodeEditor::completer() const
     return m_completer;
 }
 
+void QCodeEditor::squiggle(SeverityLevel level, QPair<int, int> start, QPair<int, int> stop, QString tooltipMessage)
+{
+    if (stop < start)
+        return;
+
+    SquiggleInformation info(start, stop, tooltipMessage);
+    m_squiggler.push_back(info);
+
+    auto cursor = textCursor();
+
+    cursor.movePosition(QTextCursor::Start);
+    cursor.movePosition(QTextCursor::NextBlock, QTextCursor::MoveAnchor, start.first - 1);
+    cursor.movePosition(QTextCursor::StartOfBlock);
+    cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::MoveAnchor, start.second);
+
+    if (stop.first > start.first)
+        cursor.movePosition(QTextCursor::NextBlock, QTextCursor::KeepAnchor, stop.first - start.first);
+
+    cursor.movePosition(QTextCursor::StartOfBlock, QTextCursor::KeepAnchor);
+    cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, stop.second);
+
+    QTextCharFormat newcharfmt = currentCharFormat();
+    newcharfmt.setFontUnderline(true);
+
+    switch (level)
+    {
+    case SeverityLevel::Error:
+        newcharfmt.setUnderlineColor(m_syntaxStyle->getFormat("Error").underlineColor());
+        newcharfmt.setUnderlineStyle(m_syntaxStyle->getFormat("Error").underlineStyle());
+        break;
+    case SeverityLevel::Warning:
+        newcharfmt.setUnderlineColor(m_syntaxStyle->getFormat("Warning").underlineColor());
+        newcharfmt.setUnderlineStyle(m_syntaxStyle->getFormat("Warning").underlineStyle());
+        break;
+    case SeverityLevel::Information:
+        newcharfmt.setUnderlineColor(m_syntaxStyle->getFormat("Warning").underlineColor());
+        newcharfmt.setUnderlineStyle(QTextCharFormat::DotLine);
+        break;
+    case SeverityLevel::Hint:
+        newcharfmt.setUnderlineColor(m_syntaxStyle->getFormat("Text").foreground().color());
+        newcharfmt.setUnderlineStyle(QTextCharFormat::DotLine);
+    }
+
+    extra_squiggles.push_back({cursor, newcharfmt});
+
+    setExtraSelections(extra1 + extra2 + extra_squiggles);
+}
+
+void QCodeEditor::clearSquiggle()
+{
+    if (m_squiggler.empty())
+        return;
+
+    m_squiggler.clear();
+    extra_squiggles.clear();
+
+    setExtraSelections(extra1 + extra2);
+}
+
 QChar QCodeEditor::charUnderCursor(int offset) const
 {
     auto block = textCursor().blockNumber();

src/internal/QSyntaxStyle.cpp

@@ -97,6 +97,13 @@ bool QSyntaxStyle::load(QString fl)
                     format.setUnderlineStyle(s);
                 }
 
+                if (attributes.hasAttribute("underlineColor"))
+                {
+                    auto color = attributes.value("underlineColor");
+
+                    format.setUnderlineColor(QColor(color.toString()));
+                }
+
                 m_data[name.toString()] = format;
             }
         }