src/plugins/cpptools/insertionpointlocator.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef INSERTIONPOINTLOCATOR_H
  35 #define INSERTIONPOINTLOCATOR_H
  36
  37 #include "cpptools_global.h"
  38
  39 #include <ASTfwd.h>
  40 #include <CPlusPlusForwardDeclarations.h>
  41 #include <Symbols.h>
  42
  43 #include <cplusplus/CppDocument.h>
  44
  45 namespace CppTools {
  46
  47 class CppRefactoringChanges;
  48
  49 class CPPTOOLS_EXPORT InsertionLocation
  50 {
  51 public:
  52     InsertionLocation();
  53     InsertionLocation(const QString &fileName, const QString &prefix,
  54                       const QString &suffix, unsigned line, unsigned column);
  55
  56     QString fileName() const
  57     { return m_fileName; }
  58
  59     /// \returns The prefix to insert before any other text.
  60     QString prefix() const
  61     { return m_prefix; }
  62
  63     /// \returns The suffix to insert after the other inserted text.
  64     QString suffix() const
  65     { return m_suffix; }
  66
  67     /// \returns The line where to insert. The line number is 1-based.
  68     unsigned line() const
  69     { return m_line; }
  70
  71     /// \returns The column where to insert. The column number is 1-based.
  72     unsigned column() const
  73     { return m_column; }
  74
  75     bool isValid() const
  76     { return !m_fileName.isEmpty() && m_line > 0 && m_column > 0; }
  77
  78 private:
  79     QString m_fileName;
  80     QString m_prefix;
  81     QString m_suffix;
  82     unsigned m_line;
  83     unsigned m_column;
  84 };
  85
  86 class CPPTOOLS_EXPORT InsertionPointLocator
  87 {
  88 public:
  89     enum AccessSpec {
  90         Invalid = -1,
  91         Signals = 0,
  92
  93         Public = 1,
  94         Protected = 2,
  95         Private = 3,
  96
  97         SlotBit = 1 << 2,
  98
  99         PublicSlot    = Public    | SlotBit,
 100         ProtectedSlot = Protected | SlotBit,
 101         PrivateSlot   = Private   | SlotBit
 102     };
 103
 104 public:
 105     InsertionPointLocator(CppRefactoringChanges *refactoringChanges);
 106
 107     InsertionLocation methodDeclarationInClass(const QString &fileName,
 108                                                const CPlusPlus::Class *clazz,
 109                                                AccessSpec xsSpec) const;
 110
 111     QList<InsertionLocation> methodDefinition(CPlusPlus::Declaration *declaration) const;
 112
 113 private:
 114     CppRefactoringChanges *m_refactoringChanges;
 115 };
 116
 117 } // namespace CppTools
 118
 119 #endif // INSERTIONPOINTLOCATOR_H