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