Files
qt-creator/src/plugins/texteditor/codeassist/iassistprocessor.cpp
Christian Kandeler dc4a8b3866 TextEditor: Allow incremental proposals
... and make use of them with clangd.
This way, users can get immediate feedback when a new proposal entry
has been found, rather than having to wait until all of them have been
collected.

Change-Id: I2adfe0153aa7a058f28eb3bd65c71dd30ea018e0
Reviewed-by: David Schulz <david.schulz@qt.io>
2021-06-18 11:43:08 +00:00

67 lines
2.4 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "iassistprocessor.h"
using namespace TextEditor;
/*!
\class TextEditor::IAssistProcessor
\brief The IAssistProcessor class acts as an interface that actually computes an assist
proposal.
\ingroup CodeAssist
\sa IAssistProposal, IAssistProvider
*/
IAssistProcessor::IAssistProcessor() = default;
IAssistProcessor::~IAssistProcessor() = default;
void IAssistProcessor::setAsyncProposalAvailable(IAssistProposal *proposal)
{
if (m_asyncCompletionsAvailableHandler)
m_asyncCompletionsAvailableHandler(proposal);
}
void IAssistProcessor::setAsyncCompletionAvailableHandler(
const IAssistProcessor::AsyncCompletionsAvailableHandler &handler)
{
m_asyncCompletionsAvailableHandler = handler;
}
/*!
\fn IAssistProposal *TextEditor::IAssistProcessor::perform(const AssistInterface *interface)
Computes a proposal and returns it. Access to the document is made through the \a interface.
If this is an asynchronous processor the \a interface will be detached.
The processor takes ownership of the interface. Also, one should be careful in the case of
sharing data across asynchronous processors since there might be more than one instance of
them computing a proposal at a particular time.
\sa AssistInterface::detach()
*/