Clang: Add current and visible editor message

Change-Id: Ifd88bc032388ae7a8d3dbc0f1f5746665074cc18
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@theqtcompany.com>

src/libs/clangbackendipc/clangbackendipc-lib.pri

@@ -46,7 +46,8 @@ SOURCES += $$PWD/ipcserverinterface.cpp \
     $$PWD/requestdiagnosticsmessage.cpp \
     $$PWD/registerunsavedfilesforeditormessage.cpp \
     $$PWD/unregisterunsavedfilesforeditormessage.cpp \
-    $$PWD/updatetranslationunitsforeditormessage.cpp
+    $$PWD/updatetranslationunitsforeditormessage.cpp \
+    $$PWD/updatevisibletranslationunitsmessage.cpp
 
 HEADERS += \
     $$PWD/ipcserverinterface.h \
@@ -87,6 +88,7 @@ HEADERS += \
     $$PWD/requestdiagnosticsmessage.h \
     $$PWD/registerunsavedfilesforeditormessage.h \
     $$PWD/unregisterunsavedfilesforeditormessage.h \
-    $$PWD/updatetranslationunitsforeditormessage.h
+    $$PWD/updatetranslationunitsforeditormessage.h \
+    $$PWD/updatevisibletranslationunitsmessage.h
 
 contains(QT_CONFIG, reduce_exports):CONFIG += hide_symbols

src/libs/clangbackendipc/cmbmessages.cpp

@@ -49,6 +49,7 @@
 #include "translationunitdoesnotexistmessage.h"
 #include "unregisterunsavedfilesforeditormessage.h"
 #include "updatetranslationunitsforeditormessage.h"
+#include "updatevisibletranslationunitsmessage.h"
 
 #include <QDataStream>
 
@@ -82,6 +83,8 @@ void Messages::registerMessages()
     registerMetaType<RequestDiagnosticsMessage>();
     registerMetaType<DiagnosticsChangedMessage>();
 
+    registerMetaType<UpdateVisibleTranslationUnitsMessage>();
+
     registerMetaType<CompleteCodeMessage>();
     registerMetaType<CodeCompletedMessage>();
     registerMetaType<CodeCompletion>();

src/libs/clangbackendipc/ipcclientinterface.h

@@ -50,6 +50,7 @@ class DiagnosticsChangedMessage;
 class RequestDiagnosticsMessage;
 class RegisterUnsavedFilesForEditorMessage;
 class UnregisterUnsavedFilesForEditorMessage;
+class UpdateVisibleTranslationUnitsMessage;
 
 class CMBIPC_EXPORT IpcClientInterface : public IpcInterface
 {

src/libs/clangbackendipc/ipcserverinterface.cpp

@@ -39,6 +39,7 @@
 #include "requestdiagnosticsmessage.h"
 #include "unregisterunsavedfilesforeditormessage.h"
 #include "updatetranslationunitsforeditormessage.h"
+#include "updatevisibletranslationunitsmessage.h"
 
 #include <QDebug>
 #include <QVariant>
@@ -57,6 +58,8 @@ void IpcServerInterface::dispatch(const QVariant &message)
     static const int unregisterUnsavedFilesForEditorMessageType = QMetaType::type("ClangBackEnd::UnregisterUnsavedFilesForEditorMessage");
     static const int completeCodeMessageType = QMetaType::type("ClangBackEnd::CompleteCodeMessage");
     static const int requestDiagnosticsMessageType = QMetaType::type("ClangBackEnd::RequestDiagnosticsMessage");
+    static const int updateVisibleTranslationUnitsMessageType = QMetaType::type("ClangBackEnd::UpdateVisibleTranslationUnitsMessage");
+
 
     int type = message.userType();
 
@@ -80,6 +83,8 @@ void IpcServerInterface::dispatch(const QVariant &message)
         completeCode(message.value<CompleteCodeMessage>());
     else if (type == requestDiagnosticsMessageType)
         requestDiagnostics(message.value<RequestDiagnosticsMessage>());
+    else if (type == updateVisibleTranslationUnitsMessageType)
+        updateVisibleTranslationUnits(message.value<UpdateVisibleTranslationUnitsMessage>());
     else
         qWarning() << "Unknown IpcServerMessage";
 }

src/libs/clangbackendipc/ipcserverinterface.h

@@ -54,6 +54,7 @@ public:
     virtual void unregisterUnsavedFilesForEditor(const UnregisterUnsavedFilesForEditorMessage &message) = 0;
     virtual void completeCode(const CompleteCodeMessage &message) = 0;
     virtual void requestDiagnostics(const RequestDiagnosticsMessage &message) = 0;
+    virtual void updateVisibleTranslationUnits(const UpdateVisibleTranslationUnitsMessage &message) = 0;
 
     void addClient(IpcClientInterface *client);
     void removeClient(IpcClientInterface *client);

src/libs/clangbackendipc/ipcserverproxy.cpp

@@ -42,6 +42,7 @@
 #include <requestdiagnosticsmessage.h>
 #include <unregisterunsavedfilesforeditormessage.h>
 #include <updatetranslationunitsforeditormessage.h>
+#include <updatevisibletranslationunitsmessage.h>
 
 #include <QLocalServer>
 #include <QLocalSocket>
@@ -119,5 +120,10 @@ void IpcServerProxy::requestDiagnostics(const ClangBackEnd::RequestDiagnosticsMe
     writeMessageBlock.write(QVariant::fromValue(message));
 }
 
+void IpcServerProxy::updateVisibleTranslationUnits(const UpdateVisibleTranslationUnitsMessage &message)
+{
+    writeMessageBlock.write(QVariant::fromValue(message));
+}
+
 } // namespace ClangBackEnd
 

src/libs/clangbackendipc/ipcserverproxy.h

@@ -65,7 +65,7 @@ public:
     void unregisterUnsavedFilesForEditor(const UnregisterUnsavedFilesForEditorMessage &message) override;
     void completeCode(const CompleteCodeMessage &message) override;
     void requestDiagnostics(const RequestDiagnosticsMessage &message) override;
-
+    void updateVisibleTranslationUnits(const UpdateVisibleTranslationUnitsMessage &message) override;
     void readMessages();
 
     void resetCounter();

src/libs/clangbackendipc/updatevisibletranslationunitsmessage.cpp

@@ -0,0 +1,116 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company.  For licensing terms and
+** conditions see http://www.qt.io/terms-conditions.  For further information
+** use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+#include "updatevisibletranslationunitsmessage.h"
+
+#include "container_common.h"
+
+#include <QDataStream>
+#include <QDebug>
+
+#include <algorithm>
+#include <iterator>
+#include <ostream>
+
+namespace ClangBackEnd {
+
+UpdateVisibleTranslationUnitsMessage::UpdateVisibleTranslationUnitsMessage(
+        const Utf8String &currentEditorFilePath,
+        const Utf8StringVector &visibleEditorFilePaths)
+    : currentEditorFilePath_(currentEditorFilePath),
+      visibleEditorFilePaths_(visibleEditorFilePaths)
+{
+}
+
+const Utf8String &UpdateVisibleTranslationUnitsMessage::currentEditorFilePath() const
+{
+    return currentEditorFilePath_;
+}
+
+const Utf8StringVector &UpdateVisibleTranslationUnitsMessage::visibleEditorFilePaths() const
+{
+    return visibleEditorFilePaths_;
+}
+
+QDataStream &operator<<(QDataStream &out, const UpdateVisibleTranslationUnitsMessage &message)
+{
+    out << message.currentEditorFilePath_;
+    out << message.visibleEditorFilePaths_;
+
+    return out;
+}
+
+QDataStream &operator>>(QDataStream &in, UpdateVisibleTranslationUnitsMessage &message)
+{
+    in >> message.currentEditorFilePath_;
+    in >> message.visibleEditorFilePaths_;
+
+    return in;
+}
+
+bool operator==(const UpdateVisibleTranslationUnitsMessage &first, const UpdateVisibleTranslationUnitsMessage &second)
+{
+    return first.currentEditorFilePath_ == second.currentEditorFilePath_
+        && first.visibleEditorFilePaths_ == second.visibleEditorFilePaths_;
+}
+
+bool operator<(const UpdateVisibleTranslationUnitsMessage &first, const UpdateVisibleTranslationUnitsMessage &second)
+{
+    return first.currentEditorFilePath_ < second.currentEditorFilePath_
+        && compareContainer(first.visibleEditorFilePaths_, second.visibleEditorFilePaths_);
+}
+
+QDebug operator<<(QDebug debug, const UpdateVisibleTranslationUnitsMessage &message)
+{
+    debug.nospace() << "UpdateVisibleTranslationUnitsMessage(";
+
+    debug.nospace() << message.currentEditorFilePath()  << ", ";
+
+    for (const Utf8String &visibleEditorFilePath : message.visibleEditorFilePaths())
+        debug.nospace() << visibleEditorFilePath << ", ";
+
+    debug.nospace() << ")";
+
+    return debug;
+}
+
+void PrintTo(const UpdateVisibleTranslationUnitsMessage &message, ::std::ostream* os)
+{
+    *os << "UpdateVisibleTranslationUnitsMessage(";
+
+    *os << message.currentEditorFilePath().constData()  << ", ";
+
+    auto visiblePaths = message.visibleEditorFilePaths();
+
+    std::copy(visiblePaths.cbegin(), visiblePaths.cend(), std::ostream_iterator<Utf8String>(*os, ", "));
+
+    *os << ")";
+}
+
+} // namespace ClangBackEnd

src/libs/clangbackendipc/updatevisibletranslationunitsmessage.h

@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company.  For licensing terms and
+** conditions see http://www.qt.io/terms-conditions.  For further information
+** use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+#ifndef CLANGBACKEND_UPDATEVISIBLETRANSLATIONUNITSMESSAGE_H
+#define CLANGBACKEND_UPDATEVISIBLETRANSLATIONUNITSMESSAGE_H
+
+#include <clangbackendipc_global.h>
+
+#include <utf8stringvector.h>
+
+#include <QMetaType>
+
+namespace ClangBackEnd {
+
+class CMBIPC_EXPORT UpdateVisibleTranslationUnitsMessage
+{
+    friend CMBIPC_EXPORT QDataStream &operator<<(QDataStream &out, const UpdateVisibleTranslationUnitsMessage &message);
+    friend CMBIPC_EXPORT QDataStream &operator>>(QDataStream &in, UpdateVisibleTranslationUnitsMessage &message);
+    friend CMBIPC_EXPORT bool operator==(const UpdateVisibleTranslationUnitsMessage &first, const UpdateVisibleTranslationUnitsMessage &second);
+    friend CMBIPC_EXPORT bool operator<(const UpdateVisibleTranslationUnitsMessage &first, const UpdateVisibleTranslationUnitsMessage &second);
+
+public:
+    UpdateVisibleTranslationUnitsMessage() = default;
+    UpdateVisibleTranslationUnitsMessage(const Utf8String &currentEditorFilePath,
+                                         const Utf8StringVector &visibleEditorFilePaths);
+
+    const Utf8String &currentEditorFilePath() const;
+    const Utf8StringVector &visibleEditorFilePaths() const;
+
+private:
+    Utf8String currentEditorFilePath_;
+    Utf8StringVector visibleEditorFilePaths_;
+};
+
+CMBIPC_EXPORT QDataStream &operator<<(QDataStream &out, const UpdateVisibleTranslationUnitsMessage &message);
+CMBIPC_EXPORT QDataStream &operator>>(QDataStream &in, UpdateVisibleTranslationUnitsMessage &message);
+CMBIPC_EXPORT bool operator==(const UpdateVisibleTranslationUnitsMessage &first, const UpdateVisibleTranslationUnitsMessage &second);
+CMBIPC_EXPORT bool operator<(const UpdateVisibleTranslationUnitsMessage &first, const UpdateVisibleTranslationUnitsMessage &second);
+
+CMBIPC_EXPORT QDebug operator<<(QDebug debug, const UpdateVisibleTranslationUnitsMessage &message);
+void PrintTo(const UpdateVisibleTranslationUnitsMessage &message, ::std::ostream* os);
+} // namespace ClangBackEnd
+
+Q_DECLARE_METATYPE(ClangBackEnd::UpdateVisibleTranslationUnitsMessage)
+
+#endif // CLANGBACKEND_UPDATEVISIBLETRANSLATIONUNITSMESSAGE_H