clangbackendipcintegration.cpp 15.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/****************************************************************************
**
** 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.
**
****************************************************************************/

31
#include "clangbackendipcintegration.h"
32

33
#include "clangcompletionassistprocessor.h"
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
#include "clangmodelmanagersupport.h"
#include "clangutils.h"
#include "pchmanager.h"

#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/icore.h>

#include <cpptools/abstracteditorsupport.h>
#include <cpptools/baseeditordocumentprocessor.h>
#include <cpptools/editordocumenthandle.h>

#include <texteditor/codeassist/functionhintproposal.h>
#include <texteditor/codeassist/iassistprocessor.h>
#include <texteditor/texteditor.h>

#include <utils/hostosinfo.h>
#include <utils/qtcassert.h>

52 53 54 55 56 57 58 59 60 61
#include <clangbackendipc/cmbcodecompletedcommand.h>
#include <clangbackendipc/cmbcompletecodecommand.h>
#include <clangbackendipc/cmbechocommand.h>
#include <clangbackendipc/cmbregistertranslationunitsforcodecompletioncommand.h>
#include <clangbackendipc/cmbregisterprojectsforcodecompletioncommand.h>
#include <clangbackendipc/cmbunregistertranslationunitsforcodecompletioncommand.h>
#include <clangbackendipc/cmbunregisterprojectsforcodecompletioncommand.h>
#include <clangbackendipc/cmbcommands.h>
#include <clangbackendipc/projectpartsdonotexistcommand.h>
#include <clangbackendipc/translationunitdoesnotexistcommand.h>
62 63 64 65 66 67 68 69 70 71 72 73

#include <cplusplus/Icons.h>

#include <QElapsedTimer>
#include <QLoggingCategory>
#include <QProcess>

static Q_LOGGING_CATEGORY(log, "qtc.clangcodemodel.ipc")

using namespace CPlusPlus;
using namespace ClangCodeModel;
using namespace ClangCodeModel::Internal;
74
using namespace ClangBackEnd;
75 76 77 78 79 80
using namespace TextEditor;

namespace {

QString backendProcessPath()
{
81
    return Core::ICore::libexecPath()
82
            + QStringLiteral("/clangbackend")
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
            + QStringLiteral(QTC_HOST_EXE_SUFFIX);
}

} // anonymous namespace

IpcReceiver::IpcReceiver()
{
}

IpcReceiver::~IpcReceiver()
{
    deleteAndClearWaitingAssistProcessors();
}

void IpcReceiver::setAliveHandler(const IpcReceiver::AliveHandler &handler)
{
    m_aliveHandler = handler;
}

void IpcReceiver::addExpectedCodeCompletedCommand(
        quint64 ticket,
        ClangCompletionAssistProcessor *processor)
{
    QTC_ASSERT(processor, return);
    QTC_CHECK(!m_assistProcessorsTable.contains(ticket));
    m_assistProcessorsTable.insert(ticket, processor);
}

void IpcReceiver::deleteAndClearWaitingAssistProcessors()
{
    qDeleteAll(m_assistProcessorsTable.begin(), m_assistProcessorsTable.end());
    m_assistProcessorsTable.clear();
}

void IpcReceiver::deleteProcessorsOfEditorWidget(TextEditor::TextEditorWidget *textEditorWidget)
{
    QMutableHashIterator<quint64, ClangCompletionAssistProcessor *> it(m_assistProcessorsTable);
    while (it.hasNext()) {
        it.next();
        ClangCompletionAssistProcessor *assistProcessor = it.value();
        if (assistProcessor->textEditorWidget() == textEditorWidget) {
            delete assistProcessor;
            it.remove();
        }
    }
}

void IpcReceiver::alive()
{
    qCDebug(log) << "<<< AliveCommand";
    QTC_ASSERT(m_aliveHandler, return);
    m_aliveHandler();
}

void IpcReceiver::echo(const EchoCommand &command)
{
    qCDebug(log) << "<<<" << command;
}

void IpcReceiver::codeCompleted(const CodeCompletedCommand &command)
{
    qCDebug(log) << "<<< CodeCompletedCommand with" << command.codeCompletions().size() << "items";

    const quint64 ticket = command.ticketNumber();
    QScopedPointer<ClangCompletionAssistProcessor> processor(m_assistProcessorsTable.take(ticket));
148 149 150 151 152
    if (processor) {
        const bool finished = processor->handleAvailableAsyncCompletions(command.codeCompletions());
        if (!finished)
            processor.take();
    }
153 154 155 156 157 158 159 160 161 162
}

void IpcReceiver::translationUnitDoesNotExist(const TranslationUnitDoesNotExistCommand &command)
{
    QTC_CHECK(!"Got TranslationUnitDoesNotExistCommand");
    qCDebug(log) << "<<< ERROR:" << command;
}

void IpcReceiver::projectPartsDoNotExist(const ProjectPartsDoNotExistCommand &command)
{
163
    QTC_CHECK(!"Got ProjectPartsDoNotExistCommand");
164 165 166 167 168 169
    qCDebug(log) << "<<< ERROR:" << command;
}

class IpcSender : public IpcSenderInterface
{
public:
170
    IpcSender(ClangBackEnd::ConnectionClient &connectionClient)
171 172 173 174
        : m_connection(connectionClient)
    {}

    void end() override;
175 176 177 178 179
    void registerTranslationUnitsForCodeCompletion(const ClangBackEnd::RegisterTranslationUnitForCodeCompletionCommand &command) override;
    void unregisterTranslationUnitsForCodeCompletion(const ClangBackEnd::UnregisterTranslationUnitsForCodeCompletionCommand &command) override;
    void registerProjectPartsForCodeCompletion(const ClangBackEnd::RegisterProjectPartsForCodeCompletionCommand &command) override;
    void unregisterProjectPartsForCodeCompletion(const ClangBackEnd::UnregisterProjectPartsForCodeCompletionCommand &command) override;
    void completeCode(const ClangBackEnd::CompleteCodeCommand &command) override;
180 181

private:
182
    ClangBackEnd::ConnectionClient &m_connection;
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
};

void IpcSender::end()
{
     QTC_CHECK(m_connection.isConnected());
     m_connection.sendEndCommand();
}

void IpcSender::registerTranslationUnitsForCodeCompletion(const RegisterTranslationUnitForCodeCompletionCommand &command)
{
     QTC_CHECK(m_connection.isConnected());
     m_connection.serverProxy().registerTranslationUnitsForCodeCompletion(command);
}

void IpcSender::unregisterTranslationUnitsForCodeCompletion(const UnregisterTranslationUnitsForCodeCompletionCommand &command)
{
     QTC_CHECK(m_connection.isConnected());
     m_connection.serverProxy().unregisterTranslationUnitsForCodeCompletion(command);
}

void IpcSender::registerProjectPartsForCodeCompletion(const RegisterProjectPartsForCodeCompletionCommand &command)
{
     QTC_CHECK(m_connection.isConnected());
     m_connection.serverProxy().registerProjectPartsForCodeCompletion(command);
}

void IpcSender::unregisterProjectPartsForCodeCompletion(const UnregisterProjectPartsForCodeCompletionCommand &command)
{
     QTC_CHECK(m_connection.isConnected());
     m_connection.serverProxy().unregisterProjectPartsForCodeCompletion(command);
}

void IpcSender::completeCode(const CompleteCodeCommand &command)
{
     QTC_CHECK(m_connection.isConnected());
     m_connection.serverProxy().completeCode(command);
}

IpcCommunicator::IpcCommunicator()
    : m_connection(&m_ipcReceiver)
    , m_ipcSender(new IpcSender(m_connection))
{
    m_ipcReceiver.setAliveHandler([this]() { m_connection.resetProcessAliveTimer(); });

    connect(Core::EditorManager::instance(), &Core::EditorManager::editorAboutToClose,
            this, &IpcCommunicator::onEditorAboutToClose);
229 230
    connect(Core::ICore::instance(), &Core::ICore::coreAboutToClose,
            this, &IpcCommunicator::onCoreAboutToClose);
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

    initializeBackend();
}

static bool areCommandsRegistered = false;

void IpcCommunicator::initializeBackend()
{
    // TODO: Add a asynchron API to ConnectionClient, otherwise we might hang here

    if (!areCommandsRegistered) {
        areCommandsRegistered = true;
        Commands::registerCommands();
    }
    QElapsedTimer timer; timer.start();

247 248 249
    const QString clangBackEndProcessPath = backendProcessPath();
    qCDebug(log) << "Starting" << clangBackEndProcessPath;
    QTC_ASSERT(QFileInfo(clangBackEndProcessPath).exists(), return);
250 251

    m_connection.setProcessAliveTimerInterval(10 * 1000);
252
    m_connection.setProcessPath(clangBackEndProcessPath);
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

    connect(&m_connection, &ConnectionClient::processRestarted,
            this, &IpcCommunicator::onBackendRestarted);

    if (m_connection.connectToServer()) {
        qCDebug(log) << "...started and connected in" << timer.elapsed() << "ms.";
        initializeBackendWithCurrentData();
    } else {
        qCDebug(log) << "...failed.";
    }
}

void IpcCommunicator::registerEmptyProjectForProjectLessFiles()
{
    QTC_CHECK(m_connection.isConnected());
268
    registerProjectPartsForCodeCompletion({ClangBackEnd::ProjectPartContainer(
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
                                           Utf8String(),
                                           Utf8StringVector())});
}

void IpcCommunicator::registerCurrentProjectParts()
{
    using namespace CppTools;

    const QList<ProjectInfo> projectInfos = CppModelManager::instance()->projectInfos();
    foreach (const ProjectInfo &projectInfo, projectInfos)
        registerProjectsParts(projectInfo.projectParts());
}

void IpcCommunicator::registerCurrentUnsavedFiles()
{
    using namespace CppTools;

    const auto cppEditorDocuments = CppModelManager::instance()->cppEditorDocuments();
    foreach (const CppEditorDocumentHandle *cppEditorDocument, cppEditorDocuments) {
        if (cppEditorDocument->processor()->baseTextDocument()->isModified())
            updateUnsavedFileFromCppEditorDocument(cppEditorDocument->filePath());
    }

}

void IpcCommunicator::registerCurrrentCodeModelUiHeaders()
{
    using namespace CppTools;

    const auto editorSupports = CppModelManager::instance()->abstractEditorSupports();
    foreach (const AbstractEditorSupport *es, editorSupports)
        updateUnsavedFile(es->fileName(), es->contents());
}

static QStringList projectPartCommandLine(const CppTools::ProjectPart::Ptr &projectPart)
{
    QStringList options = ClangCodeModel::Utils::createClangOptions(projectPart,
        CppTools::ProjectFile::Unclassified); // No language option
    if (PchInfo::Ptr pchInfo = PchManager::instance()->pchInfo(projectPart))
        options += ClangCodeModel::Utils::createPCHInclusionOptions(pchInfo->fileName());
    return options;
}

312
static ClangBackEnd::ProjectPartContainer toProjectPartContainer(
313 314 315
        const CppTools::ProjectPart::Ptr &projectPart)
{
    const QStringList arguments = projectPartCommandLine(projectPart);
316
    return ClangBackEnd::ProjectPartContainer(projectPart->id(), Utf8StringVector(arguments));
317 318
}

319
static QVector<ClangBackEnd::ProjectPartContainer> toProjectPartContainers(
320 321
        const QList<CppTools::ProjectPart::Ptr> projectParts)
{
322
    QVector<ClangBackEnd::ProjectPartContainer> projectPartContainers;
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    projectPartContainers.reserve(projectParts.size());
    foreach (const CppTools::ProjectPart::Ptr &projectPart, projectParts)
        projectPartContainers << toProjectPartContainer(projectPart);
    return projectPartContainers;
}

void IpcCommunicator::registerProjectsParts(const QList<CppTools::ProjectPart::Ptr> projectParts)
{
    const auto projectPartContainers = toProjectPartContainers(projectParts);
    registerProjectPartsForCodeCompletion(projectPartContainers);
}

void IpcCommunicator::updateUnsavedFileFromCppEditorDocument(const QString &filePath)
{
    const QByteArray unsavedContent = CppTools::CppModelManager::instance()
            ->cppEditorDocument(filePath)->contents();
    updateUnsavedFile(filePath, unsavedContent);
}

void IpcCommunicator::updateUnsavedFile(const QString &filePath, const QByteArray &contents)
{
344
    const QString projectPartId = Utils::projectPartIdForFile(filePath);
345 346 347 348
    const bool hasUnsavedContent = true;

    // TODO: Send new only if changed
    registerFilesForCodeCompletion({
349
        ClangBackEnd::FileContainer(filePath,
350
            projectPartId,
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
            Utf8String::fromByteArray(contents),
            hasUnsavedContent)
    });
}

void IpcCommunicator::updateUnsavedFileIfNotCurrentDocument(Core::IDocument *document)
{
    QTC_ASSERT(document, return);

    if (Core::EditorManager::currentDocument() != document)
        updateUnsavedFileFromCppEditorDocument(document->filePath().toString());
}

void IpcCommunicator::onBackendRestarted()
{
366
    qWarning("Clang back end finished unexpectedly, restarted.");
367 368 369 370 371 372 373 374 375 376 377 378
    qCDebug(log) << "Backend restarted, re-initializing with project data and unsaved files.";

    m_ipcReceiver.deleteAndClearWaitingAssistProcessors();
    initializeBackendWithCurrentData();
}

void IpcCommunicator::onEditorAboutToClose(Core::IEditor *editor)
{
    if (auto *textEditor = qobject_cast<TextEditor::BaseTextEditor *>(editor))
        m_ipcReceiver.deleteProcessorsOfEditorWidget(textEditor->editorWidget());
}

379 380 381 382 383
void IpcCommunicator::onCoreAboutToClose()
{
    m_sendMode = IgnoreSendRequests;
}

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
void IpcCommunicator::initializeBackendWithCurrentData()
{
    registerEmptyProjectForProjectLessFiles();
    registerCurrentProjectParts();
    registerCurrentUnsavedFiles();
    registerCurrrentCodeModelUiHeaders();

    emit backendReinitialized();
}

IpcSenderInterface *IpcCommunicator::setIpcSender(IpcSenderInterface *ipcSender)
{
    IpcSenderInterface *previousCommandSender = m_ipcSender.take();
    m_ipcSender.reset(ipcSender);
    return previousCommandSender;
}

void IpcCommunicator::killBackendProcess()
{
    m_connection.processForTestOnly()->kill();
}

void IpcCommunicator::registerFilesForCodeCompletion(const FileContainers &fileContainers)
{
    if (m_sendMode == IgnoreSendRequests)
        return;

    const RegisterTranslationUnitForCodeCompletionCommand command(fileContainers);
    qCDebug(log) << ">>>" << command;
    m_ipcSender->registerTranslationUnitsForCodeCompletion(command);
}

void IpcCommunicator::unregisterFilesForCodeCompletion(const FileContainers &fileContainers)
{
    if (m_sendMode == IgnoreSendRequests)
        return;

    const UnregisterTranslationUnitsForCodeCompletionCommand command(fileContainers);
    qCDebug(log) << ">>>" << command;
    m_ipcSender->unregisterTranslationUnitsForCodeCompletion(command);
}

void IpcCommunicator::registerProjectPartsForCodeCompletion(
        const ProjectPartContainers &projectPartContainers)
{
    if (m_sendMode == IgnoreSendRequests)
        return;

    const RegisterProjectPartsForCodeCompletionCommand command(projectPartContainers);
    qCDebug(log) << ">>>" << command;
    m_ipcSender->registerProjectPartsForCodeCompletion(command);
}

437
void IpcCommunicator::unregisterProjectPartsForCodeCompletion(const QStringList &projectPartIds)
438 439 440 441
{
    if (m_sendMode == IgnoreSendRequests)
        return;

442
    const UnregisterProjectPartsForCodeCompletionCommand command((Utf8StringVector(projectPartIds)));
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    qCDebug(log) << ">>>" << command;
    m_ipcSender->unregisterProjectPartsForCodeCompletion(command);
}

void IpcCommunicator::completeCode(ClangCompletionAssistProcessor *assistProcessor,
                              const QString &filePath,
                              quint32 line,
                              quint32 column,
                              const QString &projectFilePath)
{
    if (m_sendMode == IgnoreSendRequests)
        return;

    const CompleteCodeCommand command(filePath, line, column, projectFilePath);
    qCDebug(log) << ">>>" << command;
    m_ipcSender->completeCode(command);
    m_ipcReceiver.addExpectedCodeCompletedCommand(command.ticketNumber(), assistProcessor);
}