blob: 40fa0c00f725b199dc8a617438b52ae6b8ef5ae3 (
plain)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/*
* Copyright (C) by Duncan Mac-Vicar P. <duncan@kde.org>
*
* 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.
*/
#ifndef MIRALL_FOLDERWATCHER_H
#define MIRALL_FOLDERWATCHER_H
#include "config.h"
#include "mirall/folder.h"
#include <QList>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QTime>
#include <QHash>
class QTimer;
namespace Mirall {
class FolderWatcherPrivate;
/**
* Watches a folder and sub folders for changes
*
* Will notify changed files relative to the root()
* directory.
*
* If too many changes happen in a short time interval,
* it will accumulate and be fired together later.
*/
class FolderWatcher : public QObject
{
Q_OBJECT
public:
/**
* @param root Path of the root of the folder
*/
FolderWatcher(const QString &root, QObject *parent = 0L);
~FolderWatcher();
/**
* Root path being monitored
*/
QString root() const;
/**
* Set a file name to load a file with ignore patterns.
*/
void setIgnoreListFile( const QString& );
/**
* Add an ignore pattern that will not be
* notified
*
* You can use wildcards
*/
void addIgnore(const QString &pattern);
/**
* If true, folderChanged() events are sent
* at least as often as eventInterval() seconds.
*/
bool eventsEnabled() const;
/**
* Clear all pending events
*/
void clearPendingEvents();
/**
* The minimum amounts of seconds that will separate
* folderChanged() intervals
*/
int eventInterval() const;
/**
* Sets minimum amounts of seconds that will separate
* folderChanged() intervals
*/
void setEventInterval(int seconds);
QStringList ignores() const;
public slots:
/**
* Enabled or disables folderChanged() events.
* If disabled, events are accumulated and emptied
* the next time a folderChanged() event happens.
*/
void setEventsEnabled(bool enabled=true);
/**
* @brief setEventsEnabledDelayed - start event logging after a while
* @param delay - delay time in milliseconds
* @param enabled - enable the events.
*/
void setEventsEnabledDelayed( int );
signals:
/**
* Emitted when one of the paths is changed
*/
void folderChanged(const QStringList &pathList);
protected:
void setProcessTimer();
protected slots:
// called when the manually process timer triggers
void slotProcessTimerTimeout();
void changeDetected(const QString &f);
protected:
QHash<QString, int> _pendingPathes;
private:
bool _eventsEnabled;
int _eventInterval;
FolderWatcherPrivate *_d;
QString _root;
// paths pending to notified
// QStringList _pendingPaths;
QTimer *_processTimer;
QStringList _ignores;
// for the initial synchronization, without
// any file changed
bool _initialSyncDone;
friend class FolderWatcherPrivate;
};
}
#endif
|
