abstracteditorsupport.h 2.45 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32 33 34

#ifndef ABSTRACTEDITORSUPPORT_H
#define ABSTRACTEDITORSUPPORT_H

#include "cpptools_global.h"

35
#include <QString>
36
#include <QObject>
37

38
namespace CppTools {
39
class CppModelManager;
40

41
class CPPTOOLS_EXPORT AbstractEditorSupport : public QObject
42
{
43
    Q_OBJECT
44
public:
45
    explicit AbstractEditorSupport(CppModelManager *modelmanager);
46 47
    virtual ~AbstractEditorSupport();

48
    /// \returns the contents, encoded as UTF-8
49 50 51 52
    virtual QByteArray contents() const = 0;
    virtual QString fileName() const = 0;

    void updateDocument();
53
    unsigned revision() const { return m_revision; }
54 55

    // TODO: find a better place for common utility functions
56
    static QString functionAt(const CppModelManager *mm,
57 58 59 60 61 62
                              const QString &fileName,
                              int line, int column);

    static QString licenseTemplate(const QString &file = QString(), const QString &className = QString());

private:
63
    CppModelManager *m_modelmanager;
64
    unsigned m_revision;
65 66
};

67
} // namespace CppTools
68 69

#endif // ABSTRACTEDITORSUPPORT_H