#include <qfilesystemwatcher_fsevents_p.h>

Inheritance diagram for QFSEventsFileSystemWatcherEngine:

Public Functions
QStringList	addPaths (const QStringList &paths, QStringList files, QStringList directories)

QStringList	removePaths (const QStringList &paths, QStringList files, QStringList directories)

void	stop ()

	~QFSEventsFileSystemWatcherEngine ()

Public Functions inherited from QThread
void	exit (int retcode=0)
	Tells the thread's event loop to exit with a return code. More...

bool	isFinished () const
	Returns true if the thread is finished; otherwise returns false. More...

bool	isRunning () const
	Returns true if the thread is running; otherwise returns false. More...

Priority	priority () const
	Returns the priority for a running thread. More...

	QThread (QObject *parent=0)
	Constructs a new QThread to manage a new thread. More...

void	setPriority (Priority priority)
	This function sets the priority for a running thread. More...

void	setStackSize (uint stackSize)
	Sets the maximum stack size for the thread to stackSize. More...

uint	stackSize () const
	Returns the maximum stack size for the thread (if set with setStackSize()); otherwise returns zero. More...

bool	wait (unsigned long time=ULONG_MAX)
	Blocks the thread until either of these conditions is met: More...

	~QThread ()
	Destroys the QThread. More...

Public Functions inherited from QObject
bool	blockSignals (bool b)
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...

const QObjectList &	children () const
	Returns a list of child objects. More...

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectInfo ()
	Dumps information about signal connections, etc. More...

void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...

QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...

virtual bool	event (QEvent *)
	This virtual function receives events to an object and should return true if the event e was recognized and processed. More...

virtual bool	eventFilter (QObject , QEvent )
	Filters events if this object has been installed as an event filter for the watched object. More...

template<typename T >
T	findChild (const QString &aName=QString()) const
	Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...

void	installEventFilter (QObject *)
	Installs an event filter filterObj on this object. More...

bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false. More...

void	killTimer (int id)
	Kills the timer with timer identifier, id. More...

virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children. More...

QString	objectName () const

QObject *	parent () const
	Returns a pointer to the parent object. More...

QVariant	property (const char *name) const
	Returns the value of the object's name property. More...

Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...

void	removeEventFilter (QObject *)
	Removes an event filter object obj from this object. More...

void	setObjectName (const QString &name)

void	setParent (QObject *)
	Makes the object a child of parent. More...

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value. More...

void	setUserData (uint id, QObjectUserData *data)

bool	signalsBlocked () const
	Returns true if signals are blocked; otherwise returns false. More...

int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...

QThread *	thread () const
	Returns the thread in which the object lives. More...

QObjectUserData *	userData (uint id) const

virtual	~QObject ()
	Destroys the object, deleting all its child objects. More...

Static Public Functions
static QFSEventsFileSystemWatcherEngine *	create ()

Static Public Functions inherited from QThread
static QThread *	currentThread ()
	Returns a pointer to a QThread which manages the currently executing thread. More...

static Qt::HANDLE	currentThreadId ()
	Returns the thread handle of the currently executing thread. More...

static int	idealThreadCount ()
	Returns the ideal number of threads that can be run on the system. More...

static void	yieldCurrentThread ()
	Yields execution of the current thread to another runnable thread, if any. More...

Static Public Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	Disconnects signal in object sender from method in object receiver. More...

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

static QString	tr (const char sourceText, const char comment=0, int n=-1)

static QString	trUtf8 (const char sourceText, const char comment=0, int n=-1)

Private Functions
	QFSEventsFileSystemWatcherEngine ()

void	run ()
	The starting point for the thread. More...

void	updateFiles ()

void	warmUpFSEvents ()

Static Private Functions
static void	fseventsCallback (ConstFSEventStreamRef streamRef, void clientCallBackInfo, size_t numEvents, void eventPaths, const FSEventStreamEventFlags eventFlags[], const FSEventStreamEventId eventIds[])

Properties
FSEventStreamRef	fsStream

QMutex	mutex

CFArrayRef	pathsToWatch

CFRunLoopRef	threadsRunLoop

QWaitCondition	waitCondition

QWaitCondition	waitForStop

Additional Inherited Members
Public Types inherited from QThread
enum	Priority { IdlePriority, LowestPriority, LowPriority, NormalPriority, HighPriority, HighestPriority, TimeCriticalPriority, InheritPriority }
	This enum type indicates how the operating system should schedule newly created threads. More...

Public Slots inherited from QThread
void	quit ()
	Tells the thread's event loop to exit with return code 0 (success). More...

void	start (Priority=InheritPriority)
	Begins execution of the thread by calling run(). More...

void	terminate ()
	Terminates the execution of the thread. More...

Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...

Signals inherited from QFileSystemWatcherEngine
void	directoryChanged (const QString &path, bool removed)

void	fileChanged (const QString &path, bool removed)

Signals inherited from QThread
void	finished ()
	This signal is emitted when the thread has finished executing. More...

void	started ()
	This signal is emitted when the thread starts executing. More...

void	terminated ()
	This signal is emitted when the thread is terminated. More...

Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...

Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...

Protected Functions inherited from QFileSystemWatcherEngine
	QFileSystemWatcherEngine (bool move=true)

Protected Functions inherited from QThread
int	exec ()
	Enters the event loop and waits until exit() is called, returning the value that was passed to exit(). More...

	QThread (QThreadPrivate &dd, QObject *parent=0)

Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...

virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...

virtual void	customEvent (QEvent *)
	This event handler can be reimplemented in a subclass to receive custom events. More...

virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...

	QObject (QObjectPrivate &dd, QObject *parent=0)

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal. More...

QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *)
	This event handler can be reimplemented in a subclass to receive timer events for the object. More...

Static Protected Functions inherited from QThread
static void	msleep (unsigned long)
	Forces the current thread to sleep for msecs milliseconds. More...

static void	setTerminationEnabled (bool enabled=true)
	Enables or disables termination of the current thread based on the enabled parameter. More...

static void	sleep (unsigned long)
	Forces the current thread to sleep for secs seconds. More...

static void	usleep (unsigned long)
	Forces the current thread to sleep for usecs microseconds. More...

Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject

Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()

T *	qobject_cast (QObject *object)

	QObjectList

void *	qt_find_obj_child (QObject parent, const char type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

Definition at line 92 of file qfilesystemwatcher_fsevents_p.h.

Constructors and Destructors

◆ ~QFSEventsFileSystemWatcherEngine()

QFSEventsFileSystemWatcherEngine::~QFSEventsFileSystemWatcherEngine ( )

Definition at line 155 of file qfilesystemwatcher_fsevents.cpp.

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     // I assume that at this point, QFileSystemWatcher has already called stop
     // on me, so I don't need to invalidate or stop my stream, simply
     // release it.
     cleanupFSStream(fsStream);
     if (pathsToWatch)
         CFRelease(pathsToWatch);
 #endif
 }

◆ QFSEventsFileSystemWatcherEngine()

QFSEventsFileSystemWatcherEngine::QFSEventsFileSystemWatcherEngine ( )

private

Definition at line 150 of file qfilesystemwatcher_fsevents.cpp.

Referenced by create().

     : fsStream(0), pathsToWatch(0), threadsRunLoop(0)
 {
 }

Functions

◆ addPaths()

QStringList QFSEventsFileSystemWatcherEngine::addPaths	(	const QStringList &	paths,
		QStringList *	files,
		QStringList *	directories
	)

virtual

Implements QFileSystemWatcherEngine.

Definition at line 172 of file qfilesystemwatcher_fsevents.cpp.

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     stop();
     wait();
     QMutexLocker locker(&mutex);
     QStringList failedToAdd;
     // if we have a running FSStreamEvent, we have to kill it, we'll re-add the stream soon.
     FSEventStreamEventId idToCheck;
     if (fsStream) {
         idToCheck = FSEventStreamGetLatestEventId(fsStream);
         cleanupFSStream(fsStream);
     } else {
         idToCheck = kFSEventStreamEventIdSinceNow;
     }
 
     // Brain-dead approach, but works. FSEvents actually can already read sub-trees, but since it's
     // work to figure out if we are doing a double register, we just register it twice as FSEvents
     // seems smart enough to only deliver one event. We also duplicate directory entries in here
     // (e.g., if you watch five files in the same directory, you get that directory included in the
     // array 5 times). This stupidity also makes remove work correctly though. I'll freely admit
     // that we could make this a bit smarter. If you do, check the auto-tests, they should catch at
     // least a couple of the issues.
     QCFType<CFMutableArrayRef> tmpArray = CFArrayCreateMutable(kCFAllocatorDefault, 0, &kCFTypeArrayCallBacks);
     for (int i = 0; i < paths.size(); ++i) {
         const QString &path = paths.at(i);
 
         QFileInfo fileInfo(path);
         if (!fileInfo.exists()) {
             failedToAdd.append(path);
             continue;
         }
 
         if (fileInfo.isDir()) {
             if (directories->contains(path)) {
                 failedToAdd.append(path);
                 continue;
             } else {
                 directories->append(path);
                 // Full file path for dirs.
                 QCFString cfpath(createFSStreamPath(fileInfo.canonicalFilePath()));
                 addPathToHash(dirPathInfoHash, cfpath, fileInfo, path);
                 CFArrayAppendValue(tmpArray, cfpath);
             }
         } else {
             if (files->contains(path)) {
                 failedToAdd.append(path);
                 continue;
             } else {
                 // Just the absolute path (minus it's filename) for files.
                 QCFString cfpath(createFSStreamPath(fileInfo.canonicalPath()));
                 files->append(path);
                 addPathToHash(filePathInfoHash, cfpath, fileInfo, path);
                 CFArrayAppendValue(tmpArray, cfpath);
             }
         }
     }
 
     if (!pathsToWatch && failedToAdd.size() == paths.size()) {
         return failedToAdd;
     }
 
     if (CFArrayGetCount(tmpArray) > 0) {
         if (pathsToWatch) {
             CFArrayAppendArray(tmpArray, pathsToWatch, CFRangeMake(0, CFArrayGetCount(pathsToWatch)));
             CFRelease(pathsToWatch);
         }
         pathsToWatch = CFArrayCreateCopy(kCFAllocatorDefault, tmpArray);
     }
 
     FSEventStreamContext context = { 0, this, 0, 0, 0 };
     fsStream = FSEventStreamCreate(kCFAllocatorDefault,
                                    QFSEventsFileSystemWatcherEngine::fseventsCallback,
                                    &context, pathsToWatch,
                                    idToCheck, Latency, QtFSEventFlags);
     warmUpFSEvents();
 
     return failedToAdd;
 #else
     Q_UNUSED(paths);
     Q_UNUSED(files);
     Q_UNUSED(directories);
     return QStringList();
 #endif
 }

◆ create()

QFSEventsFileSystemWatcherEngine * QFSEventsFileSystemWatcherEngine::create ( )

static

Definition at line 167 of file qfilesystemwatcher_fsevents.cpp.

 {
     return new QFSEventsFileSystemWatcherEngine();
 }

◆ fseventsCallback()

void QFSEventsFileSystemWatcherEngine::fseventsCallback	(	ConstFSEventStreamRef	streamRef,
		void *	clientCallBackInfo,
		size_t	numEvents,
		void *	eventPaths,
		const FSEventStreamEventFlags	eventFlags[],
		const FSEventStreamEventId	eventIds[]
	)

staticprivate

Definition at line 395 of file qfilesystemwatcher_fsevents.cpp.

Referenced by addPaths(), and removePaths().

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     QFSEventsFileSystemWatcherEngine *watcher = static_cast<QFSEventsFileSystemWatcherEngine *>(clientCallBackInfo);
     QMutexLocker locker(&watcher->mutex);
     CFArrayRef paths = static_cast<CFArrayRef>(eventPaths);
     for (size_t i = 0; i < numEvents; ++i) {
         const QString path = QCFString::toQString(
                                     static_cast<CFStringRef>(CFArrayGetValueAtIndex(paths, i)));
         const FSEventStreamEventFlags pathFlags = eventFlags[i];
         // There are several flags that may be passed, but we really don't care about them ATM.
         // Here they are and why we don't care.
         // kFSEventStreamEventFlagHistoryDone--(very unlikely to be gotten, but even then, not much changes).
         // kFSEventStreamEventFlagMustScanSubDirs--Likely means the data is very much out of date, we
         //            aren't coalescing our directories, so again not so much of an issue
         // kFSEventStreamEventFlagRootChanged | kFSEventStreamEventFlagMount | kFSEventStreamEventFlagUnmount--
         // These three flags indicate something has changed, but the stat will likely show this, so
         // there's not really much to worry about.
         // (btw, FSEvents is not the correct way of checking for mounts/unmounts,
         //  there are real CarbonCore events for that.)
         Q_UNUSED(pathFlags);
         if (watcher->filePathInfoHash.contains(path))
             watcher->updateList(watcher->filePathInfoHash[path], false, true);
 
         if (watcher->dirPathInfoHash.contains(path))
             watcher->updateList(watcher->dirPathInfoHash[path], true, true);
     }
 #else
     Q_UNUSED(clientCallBackInfo);
     Q_UNUSED(numEvents);
     Q_UNUSED(eventPaths);
     Q_UNUSED(eventFlags);
 #endif
 }

◆ removePaths()

QStringList QFSEventsFileSystemWatcherEngine::removePaths	(	const QStringList &	paths,
		QStringList *	files,
		QStringList *	directories
	)

virtual

Implements QFileSystemWatcherEngine.

Definition at line 270 of file qfilesystemwatcher_fsevents.cpp.

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     stop();
     wait();
     QMutexLocker locker(&mutex);
     // short circuit for smarties that call remove before add and we have nothing.
     if (pathsToWatch == 0)
         return paths;
     QStringList failedToRemove;
     // if we have a running FSStreamEvent, we have to stop it, we'll re-add the stream soon.
     FSEventStreamEventId idToCheck;
     if (fsStream) {
         idToCheck = FSEventStreamGetLatestEventId(fsStream);
         cleanupFSStream(fsStream);
         fsStream = 0;
     } else {
         idToCheck = kFSEventStreamEventIdSinceNow;
     }
 
     CFIndex itemCount = CFArrayGetCount(pathsToWatch);
     QCFType<CFMutableArrayRef> tmpArray = CFArrayCreateMutableCopy(kCFAllocatorDefault, itemCount,
                                                                    pathsToWatch);
     CFRelease(pathsToWatch);
     pathsToWatch = 0;
     for (int i = 0; i < paths.size(); ++i) {
         // Get the itemCount at the beginning to avoid any overruns during the iteration.
         itemCount = CFArrayGetCount(tmpArray);
         const QString &path = paths.at(i);
         QFileInfo fi(path);
         QCFString cfpath(createFSStreamPath(fi.canonicalPath()));
 
         CFIndex index = CFArrayGetFirstIndexOfValue(tmpArray, CFRangeMake(0, itemCount), cfpath);
         if (index != -1) {
             CFArrayRemoveValueAtIndex(tmpArray, index);
             files->removeAll(path);
             removePathFromHash(filePathInfoHash, cfpath, path);
         } else {
             // Could be a directory we are watching instead.
             QCFString cfdirpath(createFSStreamPath(fi.canonicalFilePath()));
             index = CFArrayGetFirstIndexOfValue(tmpArray, CFRangeMake(0, itemCount), cfdirpath);
             if (index != -1) {
                 CFArrayRemoveValueAtIndex(tmpArray, index);
                 directories->removeAll(path);
                 removePathFromHash(dirPathInfoHash, cfpath, path);
             } else {
                 failedToRemove.append(path);
             }
         }
     }
     itemCount = CFArrayGetCount(tmpArray);
     if (itemCount != 0) {
         pathsToWatch = CFArrayCreateCopy(kCFAllocatorDefault, tmpArray);
 
         FSEventStreamContext context = { 0, this, 0, 0, 0 };
         fsStream = FSEventStreamCreate(kCFAllocatorDefault,
                                        QFSEventsFileSystemWatcherEngine::fseventsCallback,
                                        &context, pathsToWatch, idToCheck, Latency, QtFSEventFlags);
         warmUpFSEvents();
     }
     return failedToRemove;
 #else
     Q_UNUSED(paths);
     Q_UNUSED(files);
     Q_UNUSED(directories);
     return QStringList();
 #endif
 }

◆ run()

void QFSEventsFileSystemWatcherEngine::run ( void )

privatevirtual

The starting point for the thread.

After calling start(), the newly created thread calls this function. The default implementation simply calls exec().

You can reimplement this function to facilitate advanced thread management. Returning from this method will end the execution of the thread.

See also: start() wait()

Reimplemented from QThread.

Definition at line 470 of file qfilesystemwatcher_fsevents.cpp.

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     threadsRunLoop = CFRunLoopGetCurrent();
     FSEventStreamScheduleWithRunLoop(fsStream, threadsRunLoop, kCFRunLoopDefaultMode);
     bool startedOK = FSEventStreamStart(fsStream);
     // It's recommended by Apple that you only update the files after you've started
     // the stream, because otherwise you might miss an update in between starting it.
     updateFiles();
 #ifdef QT_NO_DEBUG
     Q_UNUSED(startedOK);
 #else
     Q_ASSERT(startedOK);
 #endif
     // If for some reason we called stop up above (and invalidated our stream), this call will return
     // immediately.
     CFRunLoopRun();
     threadsRunLoop = 0;
     QMutexLocker locker(&mutex);
     waitForStop.wakeAll();
 #endif
 }

◆ stop()

void QFSEventsFileSystemWatcherEngine::stop ( )

virtual

Implements QFileSystemWatcherEngine.

Definition at line 434 of file qfilesystemwatcher_fsevents.cpp.

Referenced by addPaths(), and removePaths().

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     QMutexLocker locker(&mutex);
     stopFSStream(fsStream);
     if (threadsRunLoop) {
         CFRunLoopStop(threadsRunLoop);
         waitForStop.wait(&mutex);
     }
 #endif
 }

◆ updateFiles()

void QFSEventsFileSystemWatcherEngine::updateFiles ( )

private

Definition at line 446 of file qfilesystemwatcher_fsevents.cpp.

Referenced by run().

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     QMutexLocker locker(&mutex);
     updateHash(filePathInfoHash);
     updateHash(dirPathInfoHash);
     if (filePathInfoHash.isEmpty() && dirPathInfoHash.isEmpty()) {
         // Everything disappeared before we got to start, don't bother.
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
         // Code duplicated from stop(), with the exception that we
         // don't wait on waitForStop here. Doing this will lead to
         // a deadlock since this function is called from the worker
         // thread. (waitForStop.wakeAll() is only called from the
         // end of run()).
         stopFSStream(fsStream);
         if (threadsRunLoop)
             CFRunLoopStop(threadsRunLoop);
 #endif
         cleanupFSStream(fsStream);
     }
     waitCondition.wakeAll();
 #endif
 }

◆ warmUpFSEvents()

void QFSEventsFileSystemWatcherEngine::warmUpFSEvents ( )

private

Definition at line 260 of file qfilesystemwatcher_fsevents.cpp.

Referenced by addPaths(), and removePaths().

 {
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && !defined(Q_OS_IOS)
     // This function assumes that the mutex has already been grabbed before calling it.
     // It exits with the mutex still locked (Q_ASSERT(mutex.isLocked()) ;-).
     start();
     waitCondition.wait(&mutex);
 #endif
 }