1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of Qt Creator. 7 ** 8 ** Commercial License Usage 9 ** Licensees holding valid commercial Qt licenses may use this file in 10 ** accordance with the commercial license agreement provided with the 11 ** Software or, alternatively, in accordance with the terms contained in 12 ** a written agreement between you and The Qt Company. For licensing terms 13 ** and conditions see https://www.qt.io/terms-conditions. For further 14 ** information use the contact form at https://www.qt.io/contact-us. 15 ** 16 ** GNU General Public License Usage 17 ** Alternatively, this file may be used under the terms of the GNU 18 ** General Public License version 3 as published by the Free Software 19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT 20 ** included in the packaging of this file. Please review the following 21 ** information to ensure the GNU General Public License requirements will 22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html. 23 ** 24 ****************************************************************************/ 25 26 #include "iassistprocessor.h" 27 28 using namespace TextEditor; 29 30 /*! 31 \class TextEditor::IAssistProcessor 32 \brief The IAssistProcessor class acts as an interface that actually computes an assist 33 proposal. 34 \ingroup CodeAssist 35 36 \sa IAssistProposal, IAssistProvider 37 */ 38 39 IAssistProcessor::IAssistProcessor() = default; 40 41 IAssistProcessor::~IAssistProcessor() = default; 42 setAsyncProposalAvailable(IAssistProposal * proposal)43void IAssistProcessor::setAsyncProposalAvailable(IAssistProposal *proposal) 44 { 45 if (m_asyncCompletionsAvailableHandler) 46 m_asyncCompletionsAvailableHandler(proposal); 47 } 48 setAsyncCompletionAvailableHandler(const IAssistProcessor::AsyncCompletionsAvailableHandler & handler)49void IAssistProcessor::setAsyncCompletionAvailableHandler( 50 const IAssistProcessor::AsyncCompletionsAvailableHandler &handler) 51 { 52 m_asyncCompletionsAvailableHandler = handler; 53 } 54 55 /*! 56 \fn IAssistProposal *TextEditor::IAssistProcessor::perform(const AssistInterface *interface) 57 58 Computes a proposal and returns it. Access to the document is made through the \a interface. 59 If this is an asynchronous processor the \a interface will be detached. 60 61 The processor takes ownership of the interface. Also, one should be careful in the case of 62 sharing data across asynchronous processors since there might be more than one instance of 63 them computing a proposal at a particular time. 64 65 \sa AssistInterface::detach() 66 */ 67