aboutsummaryrefslogtreecommitdiffstats
path: root/src/tools/clangrefactoringbackend/source/findcursorusr.h
blob: 06777d8611e4e3be112eeab70b1af062c8eb6c13 (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/****************************************************************************
**
** 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 "clangrefactoringbackend_global.h"

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

#include <vector>

namespace ClangBackEnd {

class FindNamedDeclarationASTVisitor : public clang::RecursiveASTVisitor<FindNamedDeclarationASTVisitor>
{
public:
    explicit FindNamedDeclarationASTVisitor(const clang::SourceManager &sourceManager,
                                            const clang::SourceLocation cursorSourceLocation)
        : m_sourceManager(sourceManager),
          m_cursorSourceLocation(cursorSourceLocation)
    {
    }

    bool shouldVisitTemplateInstantiations() const
    {
        return true;
    }

    bool VisitNamedDecl(const clang::NamedDecl *declaration)
    {
        auto name = declaration->getNameAsString();

        setResultIfCursorIsInBetween(declaration,
                                     declaration->getLocation(),
                                     declaration->getNameAsString().length());

        return true;
    }

    bool VisitDeclRefExpr(const clang::DeclRefExpr *expression)
    {
        if (!iterateNestedNameSpecifierLocation(expression->getQualifierLoc()))
            return false;

        const auto *declaration = expression->getFoundDecl();
        return setResultIfCursorIsInBetween(declaration,
                                            expression->getLocation(),
                                            declaration->getNameAsString().length());
    }

    bool VisitMemberExpr(const clang::MemberExpr *expression)
    {
        const auto *declaration = expression->getFoundDecl().getDecl();
        return setResultIfCursorIsInBetween(declaration,
                                            expression->getMemberLoc(),
                                            declaration->getNameAsString().length());
    }

    std::vector<const clang::NamedDecl*> takeNamedDecl()
    {
        return std::move(m_namedDeclarations);
    }

private:
    bool canSetResult(const clang::NamedDecl *declaration,
                      clang::SourceLocation location)
    {
        return declaration
            && !setResultIfCursorIsInBetween(declaration,
                                                 location,
                                                 declaration->getNameAsString().length());
    }

    bool iterateNestedNameSpecifierLocation(clang::NestedNameSpecifierLoc nameLocation) {
        while (nameLocation) {
            const auto *declaration = nameLocation.getNestedNameSpecifier()->getAsNamespace();
            if (canSetResult(declaration, nameLocation.getLocalBeginLoc()))
                return false;

            nameLocation = nameLocation.getPrefix();
        }

        return true;
    }

    bool isValidLocationWithCursorInside(clang::SourceLocation startLocation,
                                         clang::SourceLocation endLocation)
    {
        return startLocation.isValid()
                && startLocation.isFileID()
                && endLocation.isValid()
                && endLocation.isFileID()
                && isCursorLocationBetween(startLocation, endLocation);
    }

    bool setResultIfCursorIsInBetween(const clang::NamedDecl *declaration,
                                      clang::SourceLocation startLocation,
                                      clang::SourceLocation endLocation)
    {
        bool isValid = isValidLocationWithCursorInside(startLocation, endLocation);

        if (isValid)
            m_namedDeclarations.push_back(declaration);

        return !isValid;
    }

    bool setResultIfCursorIsInBetween(const clang::NamedDecl *declaration,
                                      clang::SourceLocation location,
                                      uint offset) {
        return offset == 0
            || setResultIfCursorIsInBetween(declaration, location, location.getLocWithOffset(offset - 1));
    }

    bool isCursorLocationBetween(const clang::SourceLocation startLocation,
                                 const clang::SourceLocation endLocation)
    {
        return m_cursorSourceLocation == startLocation
            || m_cursorSourceLocation == endLocation
            || (m_sourceManager.isBeforeInTranslationUnit(startLocation, m_cursorSourceLocation)
             && m_sourceManager.isBeforeInTranslationUnit(m_cursorSourceLocation, endLocation));
    }

    std::vector<const clang::NamedDecl*> m_namedDeclarations;
    const clang::SourceManager &m_sourceManager;
    const clang::SourceLocation m_cursorSourceLocation;
};

inline
std::vector<const clang::NamedDecl *> namedDeclarationsAt(const clang::ASTContext &Context,
                                                          const clang::SourceLocation cursorSourceLocation)
{
    const auto &sourceManager = Context.getSourceManager();
    const auto currentFile = sourceManager.getFilename(cursorSourceLocation);

    FindNamedDeclarationASTVisitor visitor(sourceManager, cursorSourceLocation);

    auto declarations = Context.getTranslationUnitDecl()->decls();
    for (auto &currentDeclation : declarations) {
        const auto &fileLocation = currentDeclation->getBeginLoc();
        const auto &fileName = sourceManager.getFilename(fileLocation);
        if (fileName == currentFile) {
            visitor.TraverseDecl(currentDeclation);
            const auto &namedDeclarations = visitor.takeNamedDecl();

            if (!namedDeclarations.empty())
                return namedDeclarations;
        }
    }

    return std::vector<const clang::NamedDecl *>();
}

inline
USRName USROfDeclaration(const clang::Decl *declaration)
{
    USRName buffer;

    if (declaration == nullptr || clang::index::generateUSRForDecl(declaration, buffer))
        return buffer;

    return buffer;
}

} // namespace ClangBackend