findlocationsofusrs.h 4.35 KB
Newer Older
Marco Bubke's avatar
Marco Bubke committed
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
/****************************************************************************
**
** 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.
**
****************************************************************************/

#pragma once

#include "findcursorusr.h"

#if defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif

#include <clang/AST/ASTContext.h>
#include <clang/AST/RecursiveASTVisitor.h>
#include <clang/Basic/SourceLocation.h>
#include <clang/Index/USRGeneration.h>
#include <llvm/ADT/SmallVector.h>

#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif

#include <vector>

namespace ClangBackEnd {

class FindLocationsOfUSRsASTVisitor : public clang::RecursiveASTVisitor<FindLocationsOfUSRsASTVisitor>
{
public:
    explicit FindLocationsOfUSRsASTVisitor(std::vector<USRName> &unifiedSymbolResolutions)
        : unifiedSymbolResolutions(unifiedSymbolResolutions)
    {
        std::sort(unifiedSymbolResolutions.begin(), unifiedSymbolResolutions.end());
    }

    bool VisitNamedDecl(const clang::NamedDecl *declaration) {
        auto declarationUSR = USROfDeclaration(declaration);

        if (containsUSR(declarationUSR))
Marco Bubke's avatar
Marco Bubke committed
62
            foundLocations.push_back(declaration->getLocation());
Marco Bubke's avatar
Marco Bubke committed
63
64
65
66
67
68
69
70
71
72
73

        return true;
    }

    bool VisitDeclRefExpr(const clang::DeclRefExpr *expression) {
        const auto *declaration = expression->getFoundDecl();

        iterateNestedNameSpecifierLocation(expression->getQualifierLoc());
        auto declarationUSR = USROfDeclaration(declaration);

        if (containsUSR(declarationUSR))
Marco Bubke's avatar
Marco Bubke committed
74
            foundLocations.push_back(expression->getLocation());
Marco Bubke's avatar
Marco Bubke committed
75
76
77
78
79
80
81
82
83

        return true;
    }

    bool VisitMemberExpr(const clang::MemberExpr *expression) {
        const auto *declaration = expression->getFoundDecl().getDecl();
        auto declarationUSR = USROfDeclaration(declaration);

        if (containsUSR(declarationUSR))
Marco Bubke's avatar
Marco Bubke committed
84
            foundLocations.push_back(expression->getMemberLoc());
Marco Bubke's avatar
Marco Bubke committed
85
86
87
88
89
90
91
92
93
94

        return true;
    }

    bool shouldVisitTemplateInstantiations() const
    {
        return true;
    }

    std::vector<clang::SourceLocation> takeFoundLocations() const {
Marco Bubke's avatar
Marco Bubke committed
95
        return std::move(foundLocations);
Marco Bubke's avatar
Marco Bubke committed
96
97
98
99
100
101
102
    }

private:
    void iterateNestedNameSpecifierLocation(clang::NestedNameSpecifierLoc nameLocation) {
        while (nameLocation) {
            const auto *declaration = nameLocation.getNestedNameSpecifier()->getAsNamespace();
            if (declaration && containsUSR(USROfDeclaration(declaration)))
Marco Bubke's avatar
Marco Bubke committed
103
                foundLocations.push_back(nameLocation.getLocalBeginLoc());
Marco Bubke's avatar
Marco Bubke committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

            nameLocation = nameLocation.getPrefix();
        }
    }

    bool containsUSR(const USRName &unifiedSymbolResolution)
    {
        return std::binary_search(unifiedSymbolResolutions.cbegin(),
                                  unifiedSymbolResolutions.cend(),
                                  unifiedSymbolResolution);
    }

private:

    // All the locations of the USR were found.
    std::vector<USRName> unifiedSymbolResolutions;
Marco Bubke's avatar
Marco Bubke committed
120
    std::vector<clang::SourceLocation> foundLocations;
Marco Bubke's avatar
Marco Bubke committed
121
122
123
124
125
126
127
128
129
130
131
132
133
134
};

inline
std::vector<clang::SourceLocation> takeLocationsOfUSRs(std::vector<USRName> &unifiedSymbolResolutions,
                                                     clang::Decl *declartation)
{
  FindLocationsOfUSRsASTVisitor visitor(unifiedSymbolResolutions);

  visitor.TraverseDecl(declartation);

  return visitor.takeFoundLocations();
}

} // namespace ClangBackend