1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/***************************************************************************
* Copyright (C) 2009 by Peter Penz <[email protected]> *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef REVISIONCONTROLPLUGIN_H
#define REVISIONCONTROLPLUGIN_H
#include <libdolphin_export.h>
#include <QString>
/**
* @brief Base class for revision control plugins.
*
* Enables the file manager to show the revision state
* of a revisioned file.
*/
class LIBDOLPHINPRIVATE_EXPORT RevisionControlPlugin
{
public:
enum RevisionState
{
LocalRevision,
LatestRevision
// TODO...
};
enum ItemType
{
Directory,
File
};
RevisionControlPlugin();
virtual ~RevisionControlPlugin();
/**
* Returns the name of the file which stores
* the revision control informations.
* (e. g. .svn, .cvs, .git).
*/
virtual QString fileName() const = 0;
/**
* Is invoked whenever the revision control
* information will get retrieved for the directory
* \p directory. It is assured that the directory
* contains a trailing slash.
*/
virtual bool beginRetrieval(const QString& directory) = 0;
/**
* Is invoked after the revision control information has been
* received. It is assured that
* RevisionControlPlugin::beginInfoRetrieval() has been
* invoked before.
*/
virtual void endRetrieval() = 0;
/**
* Returns the revision state for the file with the name \p fileName.
* It is assured that RevisionControlPlugin::beginInfoRetrieval() has been
* invoked before and that the file is part of the directory specified
* in beginInfoRetrieval().
*/
virtual RevisionState revisionState(const QString& name, ItemType type) = 0;
};
// TODO: This is just a temporary test class. It will be made available as
// plugin outside Dolphin later.
#include <QFileInfoList>
#include <QHash>
class LIBDOLPHINPRIVATE_EXPORT SubversionPlugin : public RevisionControlPlugin
{
public:
SubversionPlugin();
virtual ~SubversionPlugin();
virtual QString fileName() const;
virtual bool beginRetrieval(const QString& directory);
virtual void endRetrieval();
virtual RevisionControlPlugin::RevisionState revisionState(const QString& name, ItemType type);
private:
QString m_directory;
QHash<QString, QFileInfo> m_fileInfoHash;
};
#endif // REVISIONCONTROLPLUGIN_H
|