cpppointerdeclarationformatter.h 4.49 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
27 28 29 30
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

31 32
#ifndef CPPPOINTERDECLARATIONFORMATTER_H
#define CPPPOINTERDECLARATIONFORMATTER_H
33 34

#include "cpptools_global.h"
35
#include "cpprefactoringchanges.h"
36

37
#include <cplusplus/Overview.h>
38 39 40 41 42 43 44 45 46

namespace CppTools {

using namespace CPlusPlus;
using namespace CppTools;

/*!
    \class CppTools::PointerDeclarationFormatter

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

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

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

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

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

78
    explicit PointerDeclarationFormatter(const CppRefactoringFilePtr &refactoringFile,
79
                                         Overview &overview,
80 81 82 83 84 85
                                         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
86
    Utils::ChangeSet format(AST *ast)
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    {
        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:
103 104 105 106 107 108 109 110
    class TokenRange {
    public:
        TokenRange() : start(0), end(0) {}
        TokenRange(unsigned start, unsigned end) : start(start), end(end) {}
        unsigned start;
        unsigned end;
    };

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

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

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

} // namespace CppTools

125
#endif // CPPPOINTERDECLARATIONFORMATTER_H