Chris@538
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
Chris@538
|
2
|
Chris@538
|
3 /*
|
Chris@538
|
4 EasyMercurial
|
Chris@538
|
5
|
Chris@538
|
6 Based on HgExplorer by Jari Korhonen
|
Chris@538
|
7 Copyright (c) 2010 Jari Korhonen
|
Chris@560
|
8 Copyright (c) 2012 Chris Cannam
|
Chris@560
|
9 Copyright (c) 2012 Queen Mary, University of London
|
Chris@538
|
10
|
Chris@538
|
11 This program is free software; you can redistribute it and/or
|
Chris@538
|
12 modify it under the terms of the GNU General Public License as
|
Chris@538
|
13 published by the Free Software Foundation; either version 2 of the
|
Chris@538
|
14 License, or (at your option) any later version. See the file
|
Chris@538
|
15 COPYING included with this distribution for more information.
|
Chris@538
|
16 */
|
Chris@538
|
17
|
Chris@538
|
18 #ifndef FSWATCHER_H
|
Chris@538
|
19 #define FSWATCHER_H
|
Chris@538
|
20
|
Chris@538
|
21 #include <QObject>
|
Chris@538
|
22 #include <QMutex>
|
Chris@538
|
23 #include <QString>
|
Chris@538
|
24 #include <QSet>
|
Chris@538
|
25 #include <QHash>
|
Chris@538
|
26 #include <QMap>
|
Chris@538
|
27 #include <QStringList>
|
Chris@584
|
28
|
Chris@584
|
29 #ifndef Q_OS_MAC
|
Chris@584
|
30 // We don't use QFileSystemWatcher on OS/X.
|
Chris@584
|
31 // See comments at top of fswatcher.cpp for an explanation.
|
Chris@538
|
32 #include <QFileSystemWatcher>
|
Chris@584
|
33 #endif
|
Chris@538
|
34
|
Chris@538
|
35 class FsWatcher : public QObject
|
Chris@538
|
36 {
|
Chris@538
|
37 Q_OBJECT
|
Chris@538
|
38
|
Chris@538
|
39 public:
|
Chris@538
|
40 FsWatcher();
|
Chris@538
|
41 virtual ~FsWatcher();
|
Chris@538
|
42
|
Chris@538
|
43 /**
|
Chris@539
|
44 * Set the root path of the work directory to be monitored. This
|
Chris@539
|
45 * directory and all its subdirectories (recursively) will be
|
Chris@539
|
46 * monitored for changes.
|
Chris@539
|
47 *
|
Chris@541
|
48 * If this path differs from the currently set work dir path, then
|
Chris@541
|
49 * the tracked file paths will also be cleared. Call
|
Chris@539
|
50 * setTrackedFilePaths afterwards to ensure non-directory files
|
Chris@539
|
51 * are monitored.
|
Chris@538
|
52 */
|
Chris@538
|
53 void setWorkDirPath(QString path);
|
Chris@538
|
54
|
Chris@538
|
55 /**
|
Chris@539
|
56 * Provide a set of paths for files which should be tracked. These
|
Chris@542
|
57 * will be the only non-directory files monitored for changes. The
|
Chris@542
|
58 * paths should be relative to the work directory.
|
Chris@539
|
59 */
|
Chris@539
|
60 void setTrackedFilePaths(QStringList paths);
|
Chris@539
|
61
|
Chris@539
|
62 /**
|
Chris@538
|
63 * Provide a set of prefixes to ignore. Files whose names start
|
Chris@538
|
64 * with a prefix in this set will be ignored when they change.
|
Chris@538
|
65 */
|
Chris@538
|
66 void setIgnoredFilePrefixes(QStringList prefixes);
|
Chris@538
|
67
|
Chris@538
|
68 /**
|
Chris@538
|
69 * Provide a set of suffixes to ignore. Files whose names end
|
Chris@538
|
70 * with a suffix in this set will be ignored when they change.
|
Chris@538
|
71 */
|
Chris@538
|
72 void setIgnoredFileSuffixes(QStringList suffixes);
|
Chris@538
|
73
|
Chris@538
|
74 /**
|
Chris@538
|
75 * Return a token to identify the current caller in subsequent
|
Chris@538
|
76 * calls to getChangedPaths(). Only changes that occur after this
|
Chris@538
|
77 * has been called can be detected by the caller.
|
Chris@538
|
78 */
|
Chris@538
|
79 int getNewToken();
|
Chris@538
|
80
|
Chris@538
|
81 /**
|
Chris@538
|
82 * Return a list of all non-ignored file paths that have been
|
Chris@538
|
83 * observed to have changed since the last call to getChangedPaths
|
Chris@538
|
84 * with the same token.
|
Chris@538
|
85 */
|
Chris@538
|
86 QSet<QString> getChangedPaths(int token);
|
Chris@538
|
87
|
Chris@538
|
88 signals:
|
Chris@538
|
89 /**
|
Chris@538
|
90 * Emitted when something has changed. Use the asynchronous
|
Chris@538
|
91 * interface to find out what.
|
Chris@538
|
92 */
|
Chris@538
|
93 void changed();
|
Chris@538
|
94
|
Chris@585
|
95 public slots:
|
Chris@538
|
96 void fsDirectoryChanged(QString);
|
Chris@538
|
97 void fsFileChanged(QString);
|
Chris@538
|
98
|
Chris@538
|
99 private:
|
Chris@538
|
100 // call with lock already held
|
Chris@584
|
101 void clearWatchedPaths();
|
Chris@584
|
102
|
Chris@584
|
103 // call with lock already held
|
Chris@538
|
104 void addWorkDirectory(QString path);
|
Chris@538
|
105
|
Chris@538
|
106 // call with lock already held
|
Chris@538
|
107 bool shouldIgnore(QString path);
|
Chris@538
|
108
|
Chris@540
|
109 // call with lock already held. Returns set of non-ignored files in dir
|
Chris@540
|
110 QSet<QString> scanDirectory(QString path);
|
Chris@540
|
111
|
Chris@540
|
112 // call with lock already held
|
Chris@540
|
113 void debugPrint();
|
Chris@540
|
114
|
Chris@538
|
115 private:
|
Chris@538
|
116 /**
|
Chris@538
|
117 * A change associates a filename with a counter (the
|
Chris@538
|
118 * size_t). Each time a file is changed, its counter is assigned
|
Chris@538
|
119 * from m_lastCounter and m_lastCounter is incremented.
|
Chris@538
|
120 *
|
Chris@538
|
121 * This is not especially efficient -- we often want to find "all
|
Chris@538
|
122 * files whose counter is greater than X" which involves a
|
Chris@538
|
123 * traversal. Maybe something better later.
|
Chris@538
|
124 */
|
Chris@538
|
125 QHash<QString, size_t> m_changes;
|
Chris@538
|
126
|
Chris@538
|
127 /**
|
Chris@538
|
128 * Associates a token (the client identifier) with a counter. The
|
Chris@538
|
129 * counter represents the value of m_lastCounter at the moment
|
Chris@538
|
130 * getChangedPaths last completed for that token. Any files in
|
Chris@538
|
131 * m_changes whose counters are larger must have been modified.
|
Chris@538
|
132 */
|
Chris@538
|
133 QMap<int, size_t> m_tokenMap;
|
Chris@538
|
134
|
Chris@540
|
135 /**
|
Chris@540
|
136 * Associates a directory path with a list of all the files in it
|
Chris@540
|
137 * that do not match our ignore patterns. When a directory is
|
Chris@540
|
138 * signalled as having changed, then we need to rescan it and
|
Chris@540
|
139 * compare against this list before we can determine whether to
|
Chris@540
|
140 * notify about the change or not.
|
Chris@540
|
141 */
|
Chris@540
|
142 QHash<QString, QSet<QString> > m_dirContents;
|
Chris@540
|
143
|
Chris@538
|
144 QStringList m_ignoredPrefixes;
|
Chris@538
|
145 QStringList m_ignoredSuffixes;
|
Chris@538
|
146
|
Chris@538
|
147 /// Everything in this class is synchronised.
|
Chris@538
|
148 QMutex m_mutex;
|
Chris@538
|
149
|
Chris@538
|
150 QString m_workDirPath;
|
Chris@538
|
151 int m_lastToken;
|
Chris@538
|
152 size_t m_lastCounter;
|
Chris@584
|
153
|
Chris@584
|
154 #ifdef Q_OS_MAC
|
Chris@584
|
155 void *m_stream;
|
Chris@584
|
156 #else
|
Chris@538
|
157 QFileSystemWatcher m_watcher;
|
Chris@584
|
158 #endif
|
Chris@538
|
159 };
|
Chris@538
|
160
|
Chris@538
|
161 #endif
|