/**************************************************************************** ** ** Copyright (C) 2015 The Qt Company Ltd. ** Contact: http://www.qt.io/licensing/ ** ** This file is part of the QtCore module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL21$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see http://www.qt.io/terms-conditions. For further ** information use the contact form at http://www.qt.io/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 2.1 or version 3 as published by the Free ** Software Foundation and appearing in the file LICENSE.LGPLv21 and ** LICENSE.LGPLv3 included in the packaging of this file. Please review the ** following information to ensure the GNU Lesser General Public License ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** As a special exception, The Qt Company gives you certain additional ** rights. These rights are described in The Qt Company LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qfilesystemwatcher.h" #include "qfilesystemwatcher_p.h" #ifndef QT_NO_FILESYSTEMWATCHER #include #include #include #include #include #include #if defined(Q_OS_LINUX) || (defined(Q_OS_QNX) && !defined(QT_NO_INOTIFY)) #define USE_INOTIFY #endif #include "qfilesystemwatcher_polling_p.h" #if defined(Q_OS_WIN) # include "qfilesystemwatcher_win_p.h" #elif defined(USE_INOTIFY) # include "qfilesystemwatcher_inotify_p.h" #elif defined(Q_OS_FREEBSD) || defined(Q_OS_NETBSD) || defined(Q_OS_IOS) # include "qfilesystemwatcher_kqueue_p.h" #elif defined(Q_OS_OSX) # include "qfilesystemwatcher_fsevents_p.h" #endif QT_BEGIN_NAMESPACE QFileSystemWatcherEngine *QFileSystemWatcherPrivate::createNativeEngine(QObject *parent) { #if defined(Q_OS_WIN) return new QWindowsFileSystemWatcherEngine(parent); #elif defined(USE_INOTIFY) // there is a chance that inotify may fail on Linux pre-2.6.13 (August // 2005), so we can't just new inotify directly. return QInotifyFileSystemWatcherEngine::create(parent); #elif defined(Q_OS_FREEBSD) || defined(Q_OS_NETBSD) || defined(Q_OS_IOS) return QKqueueFileSystemWatcherEngine::create(parent); #elif defined(Q_OS_OSX) return QFseventsFileSystemWatcherEngine::create(parent); #else Q_UNUSED(parent); return 0; #endif } QFileSystemWatcherPrivate::QFileSystemWatcherPrivate() : native(0), poller(0) { } void QFileSystemWatcherPrivate::init() { Q_Q(QFileSystemWatcher); native = createNativeEngine(q); if (native) { QObject::connect(native, SIGNAL(fileChanged(QString,bool)), q, SLOT(_q_fileChanged(QString,bool))); QObject::connect(native, SIGNAL(directoryChanged(QString,bool)), q, SLOT(_q_directoryChanged(QString,bool))); } } void QFileSystemWatcherPrivate::initPollerEngine() { if(poller) return; Q_Q(QFileSystemWatcher); poller = new QPollingFileSystemWatcherEngine(q); // that was a mouthful QObject::connect(poller, SIGNAL(fileChanged(QString,bool)), q, SLOT(_q_fileChanged(QString,bool))); QObject::connect(poller, SIGNAL(directoryChanged(QString,bool)), q, SLOT(_q_directoryChanged(QString,bool))); } void QFileSystemWatcherPrivate::_q_fileChanged(const QString &path, bool removed) { Q_Q(QFileSystemWatcher); if (!files.contains(path)) { // the path was removed after a change was detected, but before we delivered the signal return; } if (removed) files.removeAll(path); emit q->fileChanged(path, QFileSystemWatcher::QPrivateSignal()); } void QFileSystemWatcherPrivate::_q_directoryChanged(const QString &path, bool removed) { Q_Q(QFileSystemWatcher); if (!directories.contains(path)) { // perhaps the path was removed after a change was detected, but before we delivered the signal return; } if (removed) directories.removeAll(path); emit q->directoryChanged(path, QFileSystemWatcher::QPrivateSignal()); } /*! \class QFileSystemWatcher \inmodule QtCore \brief The QFileSystemWatcher class provides an interface for monitoring files and directories for modifications. \ingroup io \since 4.2 \reentrant QFileSystemWatcher monitors the file system for changes to files and directories by watching a list of specified paths. Call addPath() to watch a particular file or directory. Multiple paths can be added using the addPaths() function. Existing paths can be removed by using the removePath() and removePaths() functions. QFileSystemWatcher examines each path added to it. Files that have been added to the QFileSystemWatcher can be accessed using the files() function, and directories using the directories() function. The fileChanged() signal is emitted when a file has been modified, renamed or removed from disk. Similarly, the directoryChanged() signal is emitted when a directory or its contents is modified or removed. Note that QFileSystemWatcher stops monitoring files once they have been renamed or removed from disk, and directories once they have been removed from disk. \note On systems running a Linux kernel without inotify support, file systems that contain watched paths cannot be unmounted. \note Windows CE does not support directory monitoring by default as this depends on the file system driver installed. \note The act of monitoring files and directories for modifications consumes system resources. This implies there is a limit to the number of files and directories your process can monitor simultaneously. On Mac OS X 10.4 and all BSD variants, for example, an open file descriptor is required for each monitored file. Some system limits the number of open file descriptors to 256 by default. This means that addPath() and addPaths() will fail if your process tries to add more than 256 files or directories to the file system monitor. Also note that your process may have other file descriptors open in addition to the ones for files being monitored, and these other open descriptors also count in the total. Mac OS X 10.5 and up use a different backend and do not suffer from this issue. \sa QFile, QDir */ /*! Constructs a new file system watcher object with the given \a parent. */ QFileSystemWatcher::QFileSystemWatcher(QObject *parent) : QObject(*new QFileSystemWatcherPrivate, parent) { d_func()->init(); } /*! Constructs a new file system watcher object with the given \a parent which monitors the specified \a paths list. */ QFileSystemWatcher::QFileSystemWatcher(const QStringList &paths, QObject *parent) : QObject(*new QFileSystemWatcherPrivate, parent) { d_func()->init(); addPaths(paths); } /*! Destroys the file system watcher. */ QFileSystemWatcher::~QFileSystemWatcher() { } /*! Adds \a path to the file system watcher if \a path exists. The path is not added if it does not exist, or if it is already being monitored by the file system watcher. If \a path specifies a directory, the directoryChanged() signal will be emitted when \a path is modified or removed from disk; otherwise the fileChanged() signal is emitted when \a path is modified, renamed or removed. If the watch was successful, true is returned. Reasons for a watch failure are generally system-dependent, but may include the resource not existing, access failures, or the total watch count limit, if the platform has one. \note There may be a system dependent limit to the number of files and directories that can be monitored simultaneously. If this limit is been reached, \a path will not be monitored, and false is returned. \sa addPaths(), removePath() */ bool QFileSystemWatcher::addPath(const QString &path) { if (path.isEmpty()) { qWarning("QFileSystemWatcher::addPath: path is empty"); return true; } QStringList paths = addPaths(QStringList(path)); return paths.isEmpty(); } /*! Adds each path in \a paths to the file system watcher. Paths are not added if they not exist, or if they are already being monitored by the file system watcher. If a path specifies a directory, the directoryChanged() signal will be emitted when the path is modified or removed from disk; otherwise the fileChanged() signal is emitted when the path is modified, renamed, or removed. The return value is a list of paths that could not be watched. Reasons for a watch failure are generally system-dependent, but may include the resource not existing, access failures, or the total watch count limit, if the platform has one. \note There may be a system dependent limit to the number of files and directories that can be monitored simultaneously. If this limit has been reached, the excess \a paths will not be monitored, and they will be added to the returned QStringList. \sa addPath(), removePaths() */ QStringList QFileSystemWatcher::addPaths(const QStringList &paths) { Q_D(QFileSystemWatcher); QStringList p = paths; QMutableListIterator it(p); while (it.hasNext()) { const QString &path = it.next(); if (path.isEmpty()) it.remove(); } if (p.isEmpty()) { qWarning("QFileSystemWatcher::addPaths: list is empty"); return QStringList(); } QFileSystemWatcherEngine *engine = 0; if(!objectName().startsWith(QLatin1String("_qt_autotest_force_engine_"))) { // Normal runtime case - search intelligently for best engine if(d->native) { engine = d->native; } else { d_func()->initPollerEngine(); engine = d->poller; } } else { // Autotest override case - use the explicitly selected engine only QString forceName = objectName().mid(26); if(forceName == QLatin1String("poller")) { qDebug() << "QFileSystemWatcher: skipping native engine, using only polling engine"; d_func()->initPollerEngine(); engine = d->poller; } else if(forceName == QLatin1String("native")) { qDebug() << "QFileSystemWatcher: skipping polling engine, using only native engine"; engine = d->native; } } if(engine) p = engine->addPaths(p, &d->files, &d->directories); return p; } /*! Removes the specified \a path from the file system watcher. If the watch is successfully removed, true is returned. Reasons for watch removal failing are generally system-dependent, but may be due to the path having already been deleted, for example. \sa removePaths(), addPath() */ bool QFileSystemWatcher::removePath(const QString &path) { if (path.isEmpty()) { qWarning("QFileSystemWatcher::removePath: path is empty"); return true; } QStringList paths = removePaths(QStringList(path)); return paths.isEmpty(); } /*! Removes the specified \a paths from the file system watcher. The return value is a list of paths which were not able to be unwatched successfully. Reasons for watch removal failing are generally system-dependent, but may be due to the path having already been deleted, for example. \sa removePath(), addPaths() */ QStringList QFileSystemWatcher::removePaths(const QStringList &paths) { Q_D(QFileSystemWatcher); QStringList p = paths; QMutableListIterator it(p); while (it.hasNext()) { const QString &path = it.next(); if (path.isEmpty()) it.remove(); } if (p.isEmpty()) { qWarning("QFileSystemWatcher::removePaths: list is empty"); return QStringList(); } if (d->native) p = d->native->removePaths(p, &d->files, &d->directories); if (d->poller) p = d->poller->removePaths(p, &d->files, &d->directories); return p; } /*! \fn void QFileSystemWatcher::fileChanged(const QString &path) This signal is emitted when the file at the specified \a path is modified, renamed or removed from disk. \sa directoryChanged() */ /*! \fn void QFileSystemWatcher::directoryChanged(const QString &path) This signal is emitted when the directory at a specified \a path is modified (e.g., when a file is added or deleted) or removed from disk. Note that if there are several changes during a short period of time, some of the changes might not emit this signal. However, the last change in the sequence of changes will always generate this signal. \sa fileChanged() */ /*! \fn QStringList QFileSystemWatcher::directories() const Returns a list of paths to directories that are being watched. \sa files() */ /*! \fn QStringList QFileSystemWatcher::files() const Returns a list of paths to files that are being watched. \sa directories() */ QStringList QFileSystemWatcher::directories() const { Q_D(const QFileSystemWatcher); return d->directories; } QStringList QFileSystemWatcher::files() const { Q_D(const QFileSystemWatcher); return d->files; } QT_END_NAMESPACE #include "moc_qfilesystemwatcher.cpp" #endif // QT_NO_FILESYSTEMWATCHER