aboutsummaryrefslogtreecommitdiffstats
path: root/src/tools/clangbackend/ipcsource/clangfollowsymboljob.h
blob: 2d56e2ca101898f1f6b7be16201ae8dbc915a6a6 (plain)
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/****************************************************************************
**
** Copyright (C) 2017 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.
**
****************************************************************************/

#pragma once

#include "clangasyncjob.h"
#include "clangdocument.h"

#include <clangbackendipc/sourcerangecontainer.h>

namespace ClangBackEnd {

class FollowSymbolResult
{
public:
    FollowSymbolResult() = default;
    FollowSymbolResult(const SourceRangeContainer &range, bool failedToFollow = false)
        : range(range)
        , failedToFollow(failedToFollow)
    {}

    friend bool operator==(const FollowSymbolResult &first, const FollowSymbolResult &second)
    {
        return first.range == second.range
                && first.failedToFollow == second.failedToFollow;
    }

    SourceRangeContainer range;
    bool failedToFollow = false;
};

class FollowSymbolJob : public AsyncJob<FollowSymbolResult>
{
public:
    using AsyncResult = FollowSymbolResult;

    AsyncPrepareResult prepareAsyncRun() override;
    void finalizeAsyncRun() override;

private:
    Document m_pinnedDocument;
    FileContainer m_pinnedFileContainer;
};
} // namespace ClangBackEnd