LanguageClient: pimpl Client and cleanup includes

Change-Id: I653861e29baeaddcbcd21a5e738be6bd85514617
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>

src/plugins/clangcodemodel/clangdclient.cpp

@@ -57,9 +57,18 @@
 #include <cppeditor/cppvirtualfunctionproposalitem.h>
 #include <cppeditor/semantichighlighter.h>
 #include <cppeditor/cppsemanticinfo.h>
+#include <languageclient/diagnosticmanager.h>
+#include <languageclient/documentsymbolcache.h>
+#include <languageclient/languageclientcompletionassist.h>
+#include <languageclient/languageclientfunctionhint.h>
+#include <languageclient/languageclienthoverhandler.h>
 #include <languageclient/languageclientinterface.h>
 #include <languageclient/languageclientmanager.h>
+#include <languageclient/languageclientquickfix.h>
+#include <languageclient/languageclientsymbolsupport.h>
 #include <languageclient/languageclientutils.h>
+#include <languageserverprotocol/clientcapabilities.h>
+#include <languageserverprotocol/progresssupport.h>
 #include <projectexplorer/project.h>
 #include <projectexplorer/projecttree.h>
 #include <projectexplorer/session.h>

src/plugins/clangcodemodel/clangdclient.h

@@ -25,6 +25,7 @@
 
 #pragma once
 
+#include <coreplugin/find/searchresultitem.h>
 #include <cppeditor/baseeditordocumentparser.h>
 #include <cppeditor/cppcodemodelsettings.h>
 #include <cppeditor/cursorineditor.h>
@@ -34,14 +35,16 @@
 
 #include <QVersionNumber>
 
-namespace Core { class SearchResultItem; }
 namespace CppEditor { class CppEditorWidget; }
 namespace LanguageServerProtocol { class Range; }
 namespace ProjectExplorer {
 class Project;
 class Task;
 }
-namespace TextEditor { class BaseTextEditor; }
+namespace TextEditor {
+class BaseTextEditor;
+class IAssistProposal;
+}
 
 namespace ClangCodeModel {
 namespace Internal {

src/plugins/coco/cocolanguageclient.cpp

@@ -27,7 +27,12 @@
 
 #include <app/app_version.h>
 #include <coreplugin/editormanager/editormanager.h>
+#include <languageclient/diagnosticmanager.h>
+#include <languageclient/languageclienthoverhandler.h>
 #include <languageclient/languageclientinterface.h>
+#include <languageclient/languageclientsettings.h>
+#include <languageserverprotocol/diagnostics.h>
+#include <languageserverprotocol/initializemessages.h>
 #include <projectexplorer/project.h>
 #include <texteditor/texteditor.h>
 #include <texteditor/texteditorsettings.h>

src/plugins/languageclient/client.h

@@ -25,45 +25,10 @@
 
 #pragma once
 
-#include "diagnosticmanager.h"
-#include "documentsymbolcache.h"
-#include "dynamiccapabilities.h"
 #include "languageclient_global.h"
-#include "languageclientcompletionassist.h"
-#include "languageclientformatter.h"
-#include "languageclientfunctionhint.h"
-#include "languageclienthoverhandler.h"
-#include "languageclientquickfix.h"
-#include "languageclientsettings.h"
-#include "languageclientsymbolsupport.h"
-#include "progressmanager.h"
+#include "languageclientutils.h"
 #include "semantichighlightsupport.h"
 
-#include <coreplugin/messagemanager.h>
-
-#include <utils/id.h>
-#include <utils/link.h>
-
-#include <languageserverprotocol/client.h>
-#include <languageserverprotocol/diagnostics.h>
-#include <languageserverprotocol/initializemessages.h>
-#include <languageserverprotocol/languagefeatures.h>
-#include <languageserverprotocol/messages.h>
-#include <languageserverprotocol/progresssupport.h>
-#include <languageserverprotocol/semantictokens.h>
-#include <languageserverprotocol/shutdownmessages.h>
-#include <languageserverprotocol/textsynchronization.h>
-
-#include <texteditor/semantichighlighter.h>
-
-#include <QBuffer>
-#include <QHash>
-#include <QJsonDocument>
-#include <QTextCursor>
-
-#include <unordered_map>
-#include <utility>
-
 namespace Core { class IDocument; }
 namespace ProjectExplorer { class Project; }
 namespace TextEditor
@@ -77,10 +42,29 @@ QT_BEGIN_NAMESPACE
 class QWidget;
 QT_END_NAMESPACE
 
+namespace LanguageServerProtocol {
+class ClientCapabilities;
+class ClientInfo;
+class ProgressToken;
+class PublishDiagnosticsParams;
+class Registration;
+class ServerCapabilities;
+class Unregistration;
+} // namespace LanguageServerProtocol
+
 namespace LanguageClient {
 
 class BaseClientInterface;
+class ClientPrivate;
+class DiagnosticManager;
+class DocumentSymbolCache;
+class DynamicCapabilities;
+class HoverHandler;
 class InterfaceController;
+class LanguageClientCompletionAssistProvider;
+class LanguageClientQuickFixProvider;
+class LanguageFilter;
+class SymbolSupport;
 
 class LANGUAGECLIENT_EXPORT Client : public QObject
 {
@@ -96,8 +80,8 @@ public:
     Client &operator=(Client &&) = delete;
 
     // basic properties
-    Utils::Id id() const { return m_id; }
-    void setName(const QString &name) { m_displayName = name; }
+    Utils::Id id() const;
+    void setName(const QString &name);
     QString name() const;
 
     enum class SendDocUpdates { Send, Ignore };
@@ -123,22 +107,22 @@ public:
     };
     State state() const;
     QString stateString() const;
-    bool reachable() const { return m_state == Initialized; }
+    bool reachable() const;
 
     void setClientInfo(const LanguageServerProtocol::ClientInfo &clientInfo);
     // capabilities
     static LanguageServerProtocol::ClientCapabilities defaultClientCapabilities();
     void setClientCapabilities(const LanguageServerProtocol::ClientCapabilities &caps);
     const LanguageServerProtocol::ServerCapabilities &capabilities() const;
-    QString serverName() const { return m_serverName; }
-    QString serverVersion() const { return m_serverVersion; }
+    QString serverName() const;
+    QString serverVersion() const;
     const DynamicCapabilities &dynamicCapabilities() const;
     void registerCapabilities(const QList<LanguageServerProtocol::Registration> &registrations);
     void unregisterCapabilities(const QList<LanguageServerProtocol::Unregistration> &unregistrations);
 
-    void setLocatorsEnabled(bool enabled) { m_locatorsEnabled = enabled; }
-    bool locatorsEnabled() const { return m_locatorsEnabled; }
-    void setAutoRequestCodeActions(bool enabled) { m_autoRequestCodeActions = enabled; }
+    void setLocatorsEnabled(bool enabled);
+    bool locatorsEnabled() const;
+    void setAutoRequestCodeActions(bool enabled);
 
     // document synchronization
     void setSupportedLanguage(const LanguageFilter &filter);
@@ -202,7 +186,7 @@ public:
 
     // logging
     enum class LogTarget { Console, Ui };
-    void setLogTarget(LogTarget target) { m_logTarget = target; }
+    void setLogTarget(LogTarget target);
     void log(const QString &message) const;
     template<typename Error>
     void log(const LanguageServerProtocol::ResponseError<Error> &responseError) const
@@ -232,91 +216,13 @@ protected:
     virtual DiagnosticManager *createDiagnosticManager();
 
 private:
-    void sendMessageNow(const LanguageServerProtocol::JsonRpcMessage &message);
-    void handleResponse(const LanguageServerProtocol::MessageId &id,
-                        const LanguageServerProtocol::JsonRpcMessage &message);
-    void handleMethod(const QString &method,
-                      const LanguageServerProtocol::MessageId &id,
-                      const LanguageServerProtocol::JsonRpcMessage &message);
-
-    void initializeCallback(const LanguageServerProtocol::InitializeRequest::Response &initResponse);
-    void shutDownCallback(const LanguageServerProtocol::ShutdownRequest::Response &shutdownResponse);
-    bool sendWorkspceFolderChanges() const;
-    void log(const LanguageServerProtocol::ShowMessageParams &message);
-
-    LanguageServerProtocol::LanguageClientValue<LanguageServerProtocol::MessageActionItem>
-    showMessageBox(const LanguageServerProtocol::ShowMessageRequestParams &message);
-
-    void removeDiagnostics(const LanguageServerProtocol::DocumentUri &uri);
-    void resetAssistProviders(TextEditor::TextDocument *document);
-
-    void sendPostponedDocumentUpdates(Schedule semanticTokensSchedule);
-
-    void updateCompletionProvider(TextEditor::TextDocument *document);
-    void updateFunctionHintProvider(TextEditor::TextDocument *document);
-
-    void requestDocumentHighlights(TextEditor::TextEditorWidget *widget);
-    void requestDocumentHighlightsNow(TextEditor::TextEditorWidget *widget);
-    LanguageServerProtocol::SemanticRequestTypes supportedSemanticRequests(TextEditor::TextDocument *document) const;
-    void handleSemanticTokens(const LanguageServerProtocol::SemanticTokens &tokens);
-    void requestCodeActions(const LanguageServerProtocol::DocumentUri &uri,
-                            const LanguageServerProtocol::Range &range,
-                            const QList<LanguageServerProtocol::Diagnostic> &diagnostics);
-    void documentClosed(Core::IDocument *document);
+    friend class ClientPrivate;
+    ClientPrivate *d = nullptr;
 
     virtual void handleDocumentClosed(TextEditor::TextDocument *) {}
     virtual void handleDocumentOpened(TextEditor::TextDocument *) {}
     virtual QTextCursor adjustedCursorForHighlighting(const QTextCursor &cursor,
                                                       TextEditor::TextDocument *doc);
-
-    State m_state = Uninitialized;
-    QHash<LanguageServerProtocol::MessageId,
-          LanguageServerProtocol::ResponseHandler::Callback> m_responseHandlers;
-    QString m_displayName;
-    LanguageFilter m_languagFilter;
-    QJsonObject m_initializationOptions;
-    QMap<TextEditor::TextDocument *, QString> m_openedDocument;
-    QSet<TextEditor::TextDocument *> m_postponedDocuments;
-    QMap<Utils::FilePath, int> m_documentVersions;
-    std::unordered_map<TextEditor::TextDocument *,
-         QList<LanguageServerProtocol::DidChangeTextDocumentParams::TextDocumentContentChangeEvent>>
-        m_documentsToUpdate;
-    QMap<TextEditor::TextEditorWidget *, QTimer *> m_documentHighlightsTimer;
-    QTimer m_documentUpdateTimer;
-    Utils::Id m_id;
-    LanguageServerProtocol::ClientCapabilities m_clientCapabilities = defaultClientCapabilities();
-    LanguageServerProtocol::ServerCapabilities m_serverCapabilities;
-    DynamicCapabilities m_dynamicCapabilities;
-    struct AssistProviders
-    {
-        QPointer<TextEditor::CompletionAssistProvider> completionAssistProvider;
-        QPointer<TextEditor::CompletionAssistProvider> functionHintProvider;
-        QPointer<TextEditor::IAssistProvider> quickFixAssistProvider;
-    };
-
-    AssistProviders m_clientProviders;
-    QMap<TextEditor::TextDocument *, AssistProviders> m_resetAssistProvider;
-    QHash<TextEditor::TextEditorWidget *, LanguageServerProtocol::MessageId> m_highlightRequests;
-    int m_restartsLeft = 5;
-    InterfaceController *m_clientInterface = nullptr;
-    DiagnosticManager *m_diagnosticManager = nullptr;
-    DocumentSymbolCache m_documentSymbolCache;
-    HoverHandler m_hoverHandler;
-    QHash<LanguageServerProtocol::DocumentUri, TextEditor::HighlightingResults> m_highlights;
-    ProjectExplorer::Project *m_project = nullptr;
-    QSet<TextEditor::IAssistProcessor *> m_runningAssistProcessors;
-    SymbolSupport m_symbolSupport;
-    ProgressManager m_progressManager;
-    bool m_activateDocAutomatically = false;
-    SemanticTokenSupport m_tokenSupport;
-    QString m_serverName;
-    QString m_serverVersion;
-    LanguageServerProtocol::SymbolStringifier m_symbolStringifier;
-    LogTarget m_logTarget = LogTarget::Ui;
-    bool m_locatorsEnabled = true;
-    bool m_autoRequestCodeActions = true;
-    QTimer m_shutdownTimer;
-    LanguageServerProtocol::ClientInfo m_clientInfo;
 };
 
 } // namespace LanguageClient

src/plugins/languageclient/languageclientcompletionassist.cpp

@@ -35,6 +35,7 @@
 #include <texteditor/codeassist/genericproposalmodel.h>
 #include <texteditor/snippets/snippet.h>
 #include <texteditor/snippets/snippetassistcollector.h>
+#include <texteditor/textdocument.h>
 #include <texteditor/texteditorsettings.h>
 #include <utils/algorithm.h>
 #include <utils/textutils.h>

src/plugins/languageclient/languageclientformatter.cpp

@@ -26,6 +26,7 @@
 #include "languageclientformatter.h"
 
 #include "client.h"
+#include "dynamiccapabilities.h"
 #include "languageclientutils.h"
 
 #include <texteditor/tabsettings.h>

src/plugins/languageclient/languageclienthoverhandler.cpp

@@ -26,6 +26,7 @@
 #include "languageclienthoverhandler.h"
 
 #include "client.h"
+#include "dynamiccapabilities.h"
 
 #include <texteditor/textdocument.h>
 #include <texteditor/texteditor.h>

src/plugins/languageclient/languageclientmanager.cpp

@@ -25,7 +25,9 @@
 
 #include "languageclientmanager.h"
 
+#include "languageclienthoverhandler.h"
 #include "languageclientplugin.h"
+#include "languageclientsymbolsupport.h"
 #include "languageclientutils.h"
 
 #include <coreplugin/editormanager/editormanager.h>

src/plugins/languageclient/languageclientoutline.cpp

@@ -25,6 +25,7 @@
 
 #include "languageclientoutline.h"
 
+#include "documentsymbolcache.h"
 #include "languageclientmanager.h"
 #include "languageclientutils.h"
 

src/plugins/languageclient/languageclientsettings.h

@@ -58,8 +58,9 @@ namespace LanguageClient {
 class Client;
 class BaseClientInterface;
 
-struct LANGUAGECLIENT_EXPORT LanguageFilter
+class LANGUAGECLIENT_EXPORT LanguageFilter
 {
+public:
     QStringList mimeTypes;
     QStringList filePattern;
     bool isSupported(const Utils::FilePath &filePath, const QString &mimeType) const;

src/plugins/languageclient/languageclientsymbolsupport.cpp

@@ -26,6 +26,7 @@
 #include "languageclientsymbolsupport.h"
 
 #include "client.h"
+#include "dynamiccapabilities.h"
 #include "languageclientutils.h"
 
 #include <coreplugin/editormanager/editormanager.h>
@@ -34,6 +35,7 @@
 #include <utils/mimeutils.h>
 
 #include <QFile>
+#include <QLabel>
 
 using namespace LanguageServerProtocol;
 

src/plugins/languageclient/locatorfilter.cpp

@@ -25,6 +25,7 @@
 
 #include "locatorfilter.h"
 
+#include "documentsymbolcache.h"
 #include "languageclient_global.h"
 #include "languageclientmanager.h"
 #include "languageclientutils.h"

src/plugins/languageclient/locatorfilter.h

@@ -33,6 +33,7 @@
 #include <languageserverprotocol/languagefeatures.h>
 #include <languageserverprotocol/workspace.h>
 
+#include <QPointer>
 #include <QVector>
 
 namespace Core { class IEditor; }

src/plugins/languageclient/lspinspector.cpp

@@ -42,6 +42,7 @@
 #include <QFormLayout>
 #include <QGroupBox>
 #include <QHeaderView>
+#include <QJsonDocument>
 #include <QLabel>
 #include <QListWidget>
 #include <QPlainTextEdit>

src/plugins/python/pythonlanguageclient.cpp

@@ -51,6 +51,7 @@
 #include <QFutureWatcher>
 #include <QGridLayout>
 #include <QGroupBox>
+#include <QJsonDocument>
 #include <QPushButton>
 #include <QRegularExpression>
 #include <QTimer>