LanguageClient: allow generating specialized extra selections

for LanguageClient Diagnostics

Change-Id: Ib7226aaaa420d4c7531b9c534ab193d1b22b467d
Reviewed-by: Christian Stenger <christian.stenger@qt.io>

src/plugins/languageclient/diagnosticmanager.cpp

@@ -40,7 +40,6 @@
 #include <QAction>
 #include <QApplication>
 #include <QClipboard>
-#include <QTextEdit>
 
 using namespace LanguageServerProtocol;
 using namespace Utils;
@@ -68,6 +67,7 @@ public:
 
 DiagnosticManager::DiagnosticManager(Client *client)
     : m_client(client)
+    , m_extraSelectionsId(TextEditorWidget::CodeWarningsSelection)
 {
 }
 
@@ -88,7 +88,7 @@ void DiagnosticManager::hideDiagnostics(const Utils::FilePath &filePath)
 {
     if (auto doc = TextDocument::textDocumentForFilePath(filePath)) {
         for (BaseTextEditor *editor : BaseTextEditor::textEditorsForDocument(doc))
-            editor->editorWidget()->setExtraSelections(TextEditorWidget::CodeWarningsSelection, {});
+            editor->editorWidget()->setExtraSelections(m_extraSelectionsId, {});
     }
     qDeleteAll(m_marks.take(filePath));
 }
@@ -98,21 +98,6 @@ QList<Diagnostic> DiagnosticManager::filteredDiagnostics(const QList<Diagnostic>
     return diagnostics;
 }
 
-static QTextEdit::ExtraSelection toDiagnosticsSelections(const Diagnostic &diagnostic,
-                                                         QTextDocument *textDocument)
-{
-    QTextCursor cursor(textDocument);
-    cursor.setPosition(diagnostic.range().start().toPositionInDocument(textDocument));
-    cursor.setPosition(diagnostic.range().end().toPositionInDocument(textDocument),
-                       QTextCursor::KeepAnchor);
-
-    const FontSettings &fontSettings = TextEditorSettings::fontSettings();
-    const DiagnosticSeverity severity = diagnostic.severity().value_or(DiagnosticSeverity::Warning);
-    const TextStyle style = severity == DiagnosticSeverity::Error ? C_ERROR : C_WARNING;
-
-    return QTextEdit::ExtraSelection{cursor, fontSettings.toTextCharFormat(style)};
-}
-
 void DiagnosticManager::showDiagnostics(const DocumentUri &uri, int version)
 {
     const FilePath &filePath = uri.toFilePath();
@@ -120,22 +105,20 @@ void DiagnosticManager::showDiagnostics(const DocumentUri &uri, int version)
         QList<QTextEdit::ExtraSelection> extraSelections;
         const VersionedDiagnostics &versionedDiagnostics = m_diagnostics.value(uri);
         if (versionedDiagnostics.version.value_or(version) == version
-                && !versionedDiagnostics.diagnostics.isEmpty()) {
+            && !versionedDiagnostics.diagnostics.isEmpty()) {
             QList<TextEditor::TextMark *> &marks = m_marks[filePath];
             const bool isProjectFile = m_client->project()
                                        && m_client->project()->isKnownFile(filePath);
             for (const Diagnostic &diagnostic : versionedDiagnostics.diagnostics) {
-                extraSelections << toDiagnosticsSelections(diagnostic, doc->document());
+                extraSelections << createDiagnosticSelection(diagnostic, doc->document());
                 marks.append(createTextMark(filePath, diagnostic, isProjectFile));
             }
             if (!marks.isEmpty())
                 emit textMarkCreated(filePath);
         }
 
-        for (BaseTextEditor *editor : BaseTextEditor::textEditorsForDocument(doc)) {
-            editor->editorWidget()->setExtraSelections(TextEditorWidget::CodeWarningsSelection,
-                                                       extraSelections);
-        }
+        for (BaseTextEditor *editor : BaseTextEditor::textEditorsForDocument(doc))
+            editor->editorWidget()->setExtraSelections(m_extraSelectionsId, extraSelections);
     }
 }
 
@@ -156,6 +139,28 @@ TextEditor::TextMark *DiagnosticManager::createTextMark(const FilePath &filePath
     return mark;
 }
 
+QTextEdit::ExtraSelection DiagnosticManager::createDiagnosticSelection(
+    const LanguageServerProtocol::Diagnostic &diagnostic, QTextDocument *textDocument) const
+{
+    QTextCursor cursor(textDocument);
+    cursor.setPosition(diagnostic.range().start().toPositionInDocument(textDocument));
+    cursor.setPosition(diagnostic.range().end().toPositionInDocument(textDocument),
+                       QTextCursor::KeepAnchor);
+
+    const FontSettings &fontSettings = TextEditorSettings::fontSettings();
+    const DiagnosticSeverity severity = diagnostic.severity().value_or(DiagnosticSeverity::Warning);
+    const TextStyle style = severity == DiagnosticSeverity::Error ? C_ERROR : C_WARNING;
+
+    return QTextEdit::ExtraSelection{cursor, fontSettings.toTextCharFormat(style)};
+}
+
+void DiagnosticManager::setExtraSelectionsId(const Utils::Id &extraSelectionsId)
+{
+    // this function should be called before any diagnostics are handled
+    QTC_CHECK(m_diagnostics.isEmpty());
+    m_extraSelectionsId = extraSelectionsId;
+}
+
 void DiagnosticManager::clearDiagnostics()
 {
     for (const DocumentUri &uri : m_diagnostics.keys())

src/plugins/languageclient/diagnosticmanager.h

@@ -32,6 +32,7 @@
 #include <utils/id.h>
 
 #include <QMap>
+#include <QTextEdit>
 
 #include <functional>
 
@@ -49,7 +50,7 @@ class LANGUAGECLIENT_EXPORT DiagnosticManager : public QObject
     Q_OBJECT
 public:
     explicit DiagnosticManager(Client *client);
-    ~DiagnosticManager();
+    ~DiagnosticManager() override;
 
     virtual void setDiagnostics(const LanguageServerProtocol::DocumentUri &uri,
                                 const QList<LanguageServerProtocol::Diagnostic> &diagnostics,
@@ -77,15 +78,21 @@ protected:
     virtual TextEditor::TextMark *createTextMark(const Utils::FilePath &filePath,
                                                  const LanguageServerProtocol::Diagnostic &diagnostic,
                                                  bool isProjectFile) const;
+    virtual QTextEdit::ExtraSelection createDiagnosticSelection(
+        const LanguageServerProtocol::Diagnostic &diagnostic, QTextDocument *textDocument) const;
+
+    void setExtraSelectionsId(const Utils::Id &extraSelectionsId);
 
 private:
-    struct VersionedDiagnostics {
+    struct VersionedDiagnostics
+    {
         Utils::optional<int> version;
         QList<LanguageServerProtocol::Diagnostic> diagnostics;
     };
     QMap<LanguageServerProtocol::DocumentUri, VersionedDiagnostics> m_diagnostics;
     QMap<Utils::FilePath, QList<TextEditor::TextMark *>> m_marks;
     Client *m_client;
+    Utils::Id m_extraSelectionsId;
 };
 
 } // namespace LanguageClient