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
|
/****************************************************************************
**
** 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 "cppeditor_global.h"
#include "cpprefactoringchanges.h"
#include <cplusplus/ASTVisitor.h>
#include <utils/changeset.h>
namespace CPlusPlus { class Overview; }
namespace CppEditor {
using namespace CPlusPlus;
/*!
\class CppEditor::PointerDeclarationFormatter
\brief The PointerDeclarationFormatter class rewrites pointer or reference
declarations to an Overview.
The following constructs are supported:
\list
\li Simple declarations
\li Parameters and return types of function declarations and definitions
\li Control flow statements like if, while, for, foreach
\endlist
*/
class CPPEDITOR_EXPORT PointerDeclarationFormatter: protected ASTVisitor
{
public:
/*!
\enum PointerDeclarationFormatter::CursorHandling
This enum type simplifies the QuickFix implementation.
\value RespectCursor
Consider the cursor position or selection of the CppRefactoringFile
for rejecting edit operation candidates for the resulting ChangeSet.
If there is a selection, the range of the edit operation candidate
should be inside the selection. If there is no selection, the cursor
position should be within the range of the edit operation candidate.
\value IgnoreCursor
Cursor position or selection of the CppRefactoringFile will
_not_ be considered for aborting.
*/
enum CursorHandling { RespectCursor, IgnoreCursor };
explicit PointerDeclarationFormatter(const CppRefactoringFilePtr &refactoringFile,
Overview &overview,
CursorHandling cursorHandling = IgnoreCursor);
/*!
Returns a ChangeSet for applying the formatting changes.
The ChangeSet is empty if it was not possible to rewrite anything.
*/
Utils::ChangeSet format(AST *ast)
{
if (ast)
accept(ast);
return m_changeSet;
}
protected:
bool visit(SimpleDeclarationAST *ast) override;
bool visit(FunctionDefinitionAST *ast) override;
bool visit(ParameterDeclarationAST *ast) override;
bool visit(IfStatementAST *ast) override;
bool visit(WhileStatementAST *ast) override;
bool visit(ForStatementAST *ast) override;
bool visit(ForeachStatementAST *ast) override;
private:
class TokenRange {
public:
TokenRange() = default;
TokenRange(int start, int end) : start(start), end(end) {}
int start = 0;
int end = 0;
};
void processIfWhileForStatement(ExpressionAST *expression, Symbol *symbol);
void checkAndRewrite(DeclaratorAST *declarator, Symbol *symbol, TokenRange range,
unsigned charactersToRemove = 0);
void printCandidate(AST *ast);
const CppRefactoringFilePtr m_cppRefactoringFile;
Overview &m_overview;
const CursorHandling m_cursorHandling;
Utils::ChangeSet m_changeSet;
};
} // namespace CppEditor
|
