Files
qt-creator/src/plugins/cpptools/insertionpointlocator.h
Christian Kamm 8a6d767a8f Refactoring changes: Cleanup and improvements.
Previously RefactoringFiles were usually passed around by value.
However, since a RefactoringFile may sometimes own a QTextDocument
(when it was read from a file), that's not great and caused the
file to be reread after every copy.

With this change RefactoringFile becomes noncopyable and is always
owned by a shared pointer.

This change also allowed having const RefactoringFiles which is
useful because they can be safely used from other threads. See
CppRefactoringChanges::fileNoEditor.

Change-Id: I9045921d6d0f6349f9558ff2a3d8317ea172193b
Reviewed-on: http://codereview.qt.nokia.com/3084
Reviewed-by: Leandro T. C. Melo <leandro.melo@nokia.com>
2011-08-19 11:12:09 +02:00

117 lines
3.3 KiB
C++

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
**************************************************************************/
#ifndef INSERTIONPOINTLOCATOR_H
#define INSERTIONPOINTLOCATOR_H
#include "cpptools_global.h"
#include <ASTfwd.h>
#include <CPlusPlusForwardDeclarations.h>
#include <cplusplus/CppDocument.h>
#include <cpptools/cpprefactoringchanges.h>
namespace CppTools {
class CPPTOOLS_EXPORT InsertionLocation
{
public:
InsertionLocation();
InsertionLocation(const QString &fileName, const QString &prefix,
const QString &suffix, unsigned line, unsigned column);
QString fileName() const
{ return m_fileName; }
/// \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.
unsigned line() const
{ return m_line; }
/// \returns The column where to insert. The column number is 1-based.
unsigned column() const
{ return m_column; }
bool isValid() const
{ return !m_fileName.isEmpty() && m_line > 0 && m_column > 0; }
private:
QString m_fileName;
QString m_prefix;
QString m_suffix;
unsigned m_line;
unsigned m_column;
};
class CPPTOOLS_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
};
public:
InsertionPointLocator(const CppRefactoringChanges &refactoringChanges);
InsertionLocation methodDeclarationInClass(const QString &fileName,
const CPlusPlus::Class *clazz,
AccessSpec xsSpec) const;
QList<InsertionLocation> methodDefinition(CPlusPlus::Declaration *declaration) const;
private:
CppRefactoringChanges m_refactoringChanges;
};
} // namespace CppTools
#endif // INSERTIONPOINTLOCATOR_H