cpppointerdeclarationformatter.h 4.25 KB
Newer Older
1 2
/****************************************************************************
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5 6 7 8 9 10 11
**
** 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
12 13 14
** 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.
15
**
16 17 18 19 20 21 22
** 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.
23 24 25
**
****************************************************************************/

26 27
#ifndef CPPPOINTERDECLARATIONFORMATTER_H
#define CPPPOINTERDECLARATIONFORMATTER_H
28 29

#include "cpptools_global.h"
30
#include "cpprefactoringchanges.h"
31

32 33 34 35 36
#include <cplusplus/ASTVisitor.h>

#include <utils/changeset.h>

namespace CPlusPlus { class Overview; }
37 38 39 40 41 42 43 44 45

namespace CppTools {

using namespace CPlusPlus;
using namespace CppTools;

/*!
    \class CppTools::PointerDeclarationFormatter

46 47
    \brief The PointerDeclarationFormatter class rewrites pointer or reference
    declarations to an Overview.
48 49 50

    The following constructs are supported:
    \list
51 52 53
     \li Simple declarations
     \li Parameters and return types of function declarations and definitions
     \li Control flow statements like if, while, for, foreach
54 55 56 57 58 59 60 61 62
    \endlist
*/

class CPPTOOLS_EXPORT PointerDeclarationFormatter: protected ASTVisitor
{
public:
    /*!
        \enum PointerDeclarationFormatter::CursorHandling

Leena Miettinen's avatar
Leena Miettinen committed
63
        This enum type simplifies the QuickFix implementation.
64 65

          \value RespectCursor
Leena Miettinen's avatar
Leena Miettinen committed
66
                 Consider the cursor position or selection of the CppRefactoringFile
67 68 69 70 71 72 73 74 75 76
                 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 };

77
    explicit PointerDeclarationFormatter(const CppRefactoringFilePtr &refactoringFile,
78
                                         Overview &overview,
79 80 81 82 83 84
                                         CursorHandling cursorHandling = IgnoreCursor);

    /*!
        Returns a ChangeSet for applying the formatting changes.
        The ChangeSet is empty if it was not possible to rewrite anything.
    */
Orgad Shaneh's avatar
Orgad Shaneh committed
85
    Utils::ChangeSet format(AST *ast)
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    {
        if (ast)
            accept(ast);
        return m_changeSet;
    }

protected:
    bool visit(SimpleDeclarationAST *ast);
    bool visit(FunctionDefinitionAST *ast);
    bool visit(ParameterDeclarationAST *ast);
    bool visit(IfStatementAST *ast);
    bool visit(WhileStatementAST *ast);
    bool visit(ForStatementAST *ast);
    bool visit(ForeachStatementAST *ast);

private:
102 103 104 105 106 107 108 109
    class TokenRange {
    public:
        TokenRange() : start(0), end(0) {}
        TokenRange(unsigned start, unsigned end) : start(start), end(end) {}
        unsigned start;
        unsigned end;
    };

110
    void processIfWhileForStatement(ExpressionAST *expression, Symbol *symbol);
111 112
    void checkAndRewrite(DeclaratorAST *declarator, Symbol *symbol, TokenRange range,
                         unsigned charactersToRemove = 0);
113
    void printCandidate(AST *ast);
114 115

    const CppRefactoringFilePtr m_cppRefactoringFile;
116
    Overview &m_overview;
117 118
    const CursorHandling m_cursorHandling;

Orgad Shaneh's avatar
Orgad Shaneh committed
119
    Utils::ChangeSet m_changeSet;
120 121 122 123
};

} // namespace CppTools

124
#endif // CPPPOINTERDECLARATIONFORMATTER_H