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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "cppeditor_global.h"
#include "cpprefactoringchanges.h"
#include <utils/filepath.h>
namespace CPlusPlus {
class Namespace;
class NamespaceAST;
class Symbol;
} // namespace CPlusPlus
namespace CppEditor {
class CPPEDITOR_EXPORT InsertionLocation
{
public:
InsertionLocation();
InsertionLocation(const Utils::FilePath &filePath, const QString &prefix,
const QString &suffix, int line, int column);
const Utils::FilePath &filePath() const { return m_filePath; }
/// Returns the prefix to insert before any other text.
QString prefix() const { return m_prefix; }
/// Returns the suffix to insert after the other inserted text.
QString suffix() const { return m_suffix; }
/// Returns the line where to insert. The line number is 1-based.
int line() const { return m_line; }
/// Returns the column where to insert. The column number is 1-based.
int column() const { return m_column; }
bool isValid() const { return !m_filePath.isEmpty() && m_line > 0 && m_column > 0; }
private:
Utils::FilePath m_filePath;
QString m_prefix;
QString m_suffix;
int m_line = 0;
int m_column = 0;
};
class CPPEDITOR_EXPORT InsertionPointLocator
{
public:
enum AccessSpec {
Invalid = -1,
Signals = 0,
Public = 1,
Protected = 2,
Private = 3,
SlotBit = 1 << 2,
PublicSlot = Public | SlotBit,
ProtectedSlot = Protected | SlotBit,
PrivateSlot = Private | SlotBit
};
static QString accessSpecToString(InsertionPointLocator::AccessSpec xsSpec);
enum Position {
AccessSpecBegin,
AccessSpecEnd,
};
enum class ForceAccessSpec { Yes, No };
public:
explicit InsertionPointLocator(const CppRefactoringChanges &refactoringChanges);
InsertionLocation methodDeclarationInClass(const Utils::FilePath &fileName,
const CPlusPlus::Class *clazz,
AccessSpec xsSpec,
ForceAccessSpec forceAccessSpec = ForceAccessSpec::No
) const;
InsertionLocation methodDeclarationInClass(
const CPlusPlus::TranslationUnit *tu,
const CPlusPlus::ClassSpecifierAST *clazz,
AccessSpec xsSpec,
Position positionInAccessSpec = AccessSpecEnd,
ForceAccessSpec forceAccessSpec = ForceAccessSpec::No
) const;
InsertionLocation constructorDeclarationInClass(const CPlusPlus::TranslationUnit *tu,
const CPlusPlus::ClassSpecifierAST *clazz,
AccessSpec xsSpec,
int constructorArgumentCount) const;
const QList<InsertionLocation> methodDefinition(CPlusPlus::Symbol *declaration,
bool useSymbolFinder = true,
const Utils::FilePath &destinationFile = {}) const;
private:
CppRefactoringChanges m_refactoringChanges;
};
// TODO: We should use the "CreateMissing" approach everywhere.
enum class NamespaceHandling { CreateMissing, Ignore };
InsertionLocation CPPEDITOR_EXPORT
insertLocationForMethodDefinition(CPlusPlus::Symbol *symbol,
const bool useSymbolFinder,
NamespaceHandling namespaceHandling,
const CppRefactoringChanges &refactoring,
const Utils::FilePath &fileName,
QStringList *insertedNamespaces = nullptr);
namespace Internal {
class NSVisitor : public CPlusPlus::ASTVisitor
{
public:
NSVisitor(const CppRefactoringFile *file, const QStringList &namespaces, int symbolPos);
const QStringList remainingNamespaces() const { return m_remainingNamespaces; }
const CPlusPlus::NamespaceAST *firstNamespace() const { return m_firstNamespace; }
const CPlusPlus::AST *firstToken() const { return m_firstToken; }
const CPlusPlus::NamespaceAST *enclosingNamespace() const { return m_enclosingNamespace; }
private:
bool preVisit(CPlusPlus::AST *ast) override;
bool visit(CPlusPlus::NamespaceAST *ns) override;
void postVisit(CPlusPlus::AST *ast) override;
const CppRefactoringFile * const m_file;
const CPlusPlus::NamespaceAST *m_enclosingNamespace = nullptr;
const CPlusPlus::NamespaceAST *m_firstNamespace = nullptr;
const CPlusPlus::AST *m_firstToken = nullptr;
QStringList m_remainingNamespaces;
const int m_symbolPos;
bool m_done = false;
};
class NSCheckerVisitor : public CPlusPlus::ASTVisitor
{
public:
NSCheckerVisitor(const CppRefactoringFile *file, const QStringList &namespaces, int symbolPos);
/**
* @brief returns the names of the namespaces that are additionally needed at the symbolPos
* @return A list of namespace names, the outermost namespace at index 0 and the innermost
* at the last index
*/
const QStringList remainingNamespaces() const { return m_remainingNamespaces; }
private:
bool preVisit(CPlusPlus::AST *ast) override;
void postVisit(CPlusPlus::AST *ast) override;
bool visit(CPlusPlus::NamespaceAST *ns) override;
bool visit(CPlusPlus::UsingDirectiveAST *usingNS) override;
void endVisit(CPlusPlus::NamespaceAST *ns) override;
void endVisit(CPlusPlus::TranslationUnitAST *) override;
QString getName(CPlusPlus::NamespaceAST *ns);
CPlusPlus::NamespaceAST *currentNamespace();
const CppRefactoringFile *const m_file;
QStringList m_remainingNamespaces;
const int m_symbolPos;
std::vector<CPlusPlus::NamespaceAST *> m_enteredNamespaces;
// track 'using namespace ...' statements
std::unordered_map<CPlusPlus::NamespaceAST *, QStringList> m_usingsPerNamespace;
bool m_done = false;
};
QStringList getNamespaceNames(const CPlusPlus::Namespace *firstNamespace);
QStringList getNamespaceNames(const CPlusPlus::Symbol *symbol);
} // namespace Internal
} // namespace CppEditor
|
