1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QFILESYSTEMWATCHER_P_H
41 #define QFILESYSTEMWATCHER_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API. It exists purely as an
48 // implementation detail. This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include "qfilesystemwatcher.h"
55 
56 QT_REQUIRE_CONFIG(filesystemwatcher);
57 
58 #include <private/qobject_p.h>
59 
60 #include <QtCore/qstringlist.h>
61 #include <QtCore/qhash.h>
62 
63 QT_BEGIN_NAMESPACE
64 
65 class QFileSystemWatcherEngine : public QObject
66 {
67     Q_OBJECT
68 
69 protected:
QFileSystemWatcherEngine(QObject * parent)70     inline QFileSystemWatcherEngine(QObject *parent)
71         : QObject(parent)
72     {
73     }
74 
75 public:
76     // fills \a files and \a directories with the \a paths it could
77     // watch, and returns a list of paths this engine could not watch
78     virtual QStringList addPaths(const QStringList &paths,
79                                  QStringList *files,
80                                  QStringList *directories) = 0;
81     // removes \a paths from \a files and \a directories, and returns
82     // a list of paths this engine does not know about (either addPath
83     // failed or wasn't called)
84     virtual QStringList removePaths(const QStringList &paths,
85                                     QStringList *files,
86                                     QStringList *directories) = 0;
87 
88 Q_SIGNALS:
89     void fileChanged(const QString &path, bool removed);
90     void directoryChanged(const QString &path, bool removed);
91 };
92 
93 class QFileSystemWatcherPrivate : public QObjectPrivate
94 {
95     Q_DECLARE_PUBLIC(QFileSystemWatcher)
96 
97     static QFileSystemWatcherEngine *createNativeEngine(QObject *parent);
98 
99 public:
100     QFileSystemWatcherPrivate();
101     void init();
102     void initPollerEngine();
103 
104     QFileSystemWatcherEngine *native, *poller;
105     QStringList files, directories;
106 
107     // private slots
108     void _q_fileChanged(const QString &path, bool removed);
109     void _q_directoryChanged(const QString &path, bool removed);
110 
111 #if defined(Q_OS_WIN) && !defined(Q_OS_WINRT)
112     void _q_winDriveLockForRemoval(const QString &);
113     void _q_winDriveLockForRemovalFailed(const QString &);
114     void _q_winDriveRemoved(const QString &);
115 
116 private:
117     QHash<QChar, QStringList> temporarilyRemovedPaths;
118 #endif // Q_OS_WIN && !Q_OS_WINRT
119 };
120 
121 
122 QT_END_NAMESPACE
123 #endif // QFILESYSTEMWATCHER_P_H
124