src/plugins/cpptools/abstracteditorsupport.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 ABSTRACTEDITORSUPPORT_H
  35 #define ABSTRACTEDITORSUPPORT_H
  36
  37 #include "cpptools_global.h"
  38
  39 #include <cplusplus/ModelManagerInterface.h>
  40
  41 namespace CppTools {
  42
  43 class CPPTOOLS_EXPORT AbstractEditorSupport
  44 {
  45 public:
  46     explicit AbstractEditorSupport(CPlusPlus::CppModelManagerInterface *modelmanager);
  47     virtual ~AbstractEditorSupport();
  48
  49     virtual QByteArray contents() const = 0;
  50     virtual QString fileName() const = 0;
  51
  52     void updateDocument();
  53
  54     // TODO: find a better place for common utility functions
  55     static QString functionAt(const CPlusPlus::CppModelManagerInterface *mm,
  56                               const QString &fileName,
  57                               int line, int column);
  58
  59     static QString licenseTemplate(const QString &file = QString(), const QString &className = QString());
  60
  61 private:
  62     CPlusPlus::CppModelManagerInterface *m_modelmanager;
  63 };
  64
  65 }
  66
  67 #endif // ABSTRACTEDITORSUPPORT_H