cppmodelmanagerinterface.h 4.78 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
32
33
34
35
#ifndef CPPMODELMANAGERINTERFACE_H
#define CPPMODELMANAGERINTERFACE_H

#include <cpptools/cpptools_global.h>
#include <cplusplus/CppDocument.h>
#include <QtCore/QObject>
36
#include <QtCore/QHash>
37
#include <QtCore/QPointer>
38
#include <QtCore/QStringList>
con's avatar
con committed
39
40
41
42
43
44

namespace ProjectExplorer {
    class Project;
}

namespace CppTools {
45

46
class AbstractEditorSupport;
con's avatar
con committed
47

48
class CPPTOOLS_EXPORT CppModelManagerInterface : public QObject
con's avatar
con committed
49
50
51
52
{
    Q_OBJECT

public:
53
    class ProjectInfo
con's avatar
con committed
54
    {
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    public:
        ProjectInfo()
        { }

        ProjectInfo(QPointer<ProjectExplorer::Project> project)
            : project(project)
        { }

        operator bool() const
        { return ! project.isNull(); }

        bool isValid() const
        { return ! project.isNull(); }

        bool isNull() const
        { return project.isNull(); }

    public: // attributes
        QPointer<ProjectExplorer::Project> project;
con's avatar
con committed
74
75
76
77
78
79
80
        QString projectPath;
        QByteArray defines;
        QStringList sourceFiles;
        QStringList includePaths;
        QStringList frameworkPaths;
    };

81
82
83
    class WorkingCopy
    {
    public:
84
85
        void insert(const QString &fileName, const QString &source, unsigned revision = 0)
        { _elements.insert(fileName, qMakePair(source, revision)); }
86
87
88
89
90

        bool contains(const QString &fileName) const
        { return _elements.contains(fileName); }

        QString source(const QString &fileName) const
91
92
93
        { return _elements.value(fileName).first; }

        QPair<QString, unsigned> get(const QString &fileName) const
94
95
96
        { return _elements.value(fileName); }

    private:
97
        typedef QHash<QString, QPair<QString, unsigned> > Table;
98
99
        Table _elements;
    };
100

con's avatar
con committed
101
102
103
104
public:
    CppModelManagerInterface(QObject *parent = 0) : QObject(parent) {}
    virtual ~CppModelManagerInterface() {}

105
106
    static CppModelManagerInterface *instance();

107
    virtual WorkingCopy workingCopy() const = 0;
108
    virtual CPlusPlus::Snapshot snapshot() const = 0;
con's avatar
con committed
109

110
111
112
    virtual QList<ProjectInfo> projectInfos() const = 0;
    virtual ProjectInfo projectInfo(ProjectExplorer::Project *project) const = 0;
    virtual void updateProjectInfo(const ProjectInfo &pinfo) = 0;
113

114
115
    virtual QStringList includesInPath(const QString &path) const = 0;

116
117
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport) = 0;
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport) = 0;
Roberto Raggi's avatar
Roberto Raggi committed
118

119
120
121
122
    virtual QList<int> references(CPlusPlus::Symbol *symbol,
                                  CPlusPlus::Document::Ptr doc,
                                  const CPlusPlus::Snapshot &snapshot) = 0;

123
124
    virtual void renameUsages(CPlusPlus::Symbol *symbol) = 0;
    virtual void findUsages(CPlusPlus::Symbol *symbol) = 0;
125

Christian Kamm's avatar
Christian Kamm committed
126
127
    virtual void findMacroUsages(const CPlusPlus::Macro &macro) = 0;

128
129
130
131
public Q_SLOTS:
    void updateModifiedSourceFiles();
    virtual void updateSourceFiles(const QStringList &sourceFiles) = 0;    
    virtual void GC() = 0;
132
133
134
135
136
};

class CPPTOOLS_EXPORT AbstractEditorSupport
{
public:
137
138
139
    explicit AbstractEditorSupport(CppModelManagerInterface *modelmanager);
    virtual ~AbstractEditorSupport();

140
141
142
    virtual QByteArray contents() const = 0;
    virtual QString fileName() const = 0;

143
144
145
146
147
148
    void updateDocument();

    // TODO: find a better place for common utility functions
    static QString functionAt(const CppModelManagerInterface *mm,
                              const QString &fileName,
                              int line, int column);
149

150
151
    static QString licenseTemplate();

152
153
private:
    CppModelManagerInterface *m_modelmanager;
con's avatar
con committed
154
155
156
157
158
};

} // namespace CppTools

#endif // CPPMODELMANAGERINTERFACE_H