Qt 4.8
Public Functions | Static Public Functions | Private Slots | Private Functions | Properties | List of all members
QInotifyFileSystemWatcherEngine Class Reference

#include <qfilesystemwatcher_inotify_p.h>

Inheritance diagram for QInotifyFileSystemWatcherEngine:
QFileSystemWatcherEngine QThread QObject

Public Functions

QStringList addPaths (const QStringList &paths, QStringList *files, QStringList *directories)
 
QStringList removePaths (const QStringList &paths, QStringList *files, QStringList *directories)
 
void run ()
 The starting point for the thread. More...
 
void stop ()
 
 ~QInotifyFileSystemWatcherEngine ()
 
- 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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () 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 >
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 QMetaObjectmetaObject () 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
 
QObjectparent () 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...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Static Public Functions

static QInotifyFileSystemWatcherEnginecreate ()
 
- Static Public Functions inherited from QThread
static QThreadcurrentThread ()
 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 Slots

void readFromInotify ()
 

Private Functions

 QInotifyFileSystemWatcherEngine (int fd)
 

Properties

QHash< int, QStringidToPath
 
int inotifyFd
 
QMutex mutex
 
QHash< QString, int > pathToID
 

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...
 
QObjectsender () 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< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

Definition at line 65 of file qfilesystemwatcher_inotify_p.h.

Constructors and Destructors

◆ ~QInotifyFileSystemWatcherEngine()

QInotifyFileSystemWatcherEngine::~QInotifyFileSystemWatcherEngine ( )

Definition at line 253 of file qfilesystemwatcher_inotify.cpp.

254 {
255  foreach (int id, pathToID)
256  inotify_rm_watch(inotifyFd, id < 0 ? -id : id);
257 
258  ::close(inotifyFd);
259 }

◆ QInotifyFileSystemWatcherEngine()

QInotifyFileSystemWatcherEngine::QInotifyFileSystemWatcherEngine ( int  fd)
private

Definition at line 245 of file qfilesystemwatcher_inotify.cpp.

246  : inotifyFd(fd)
247 {
248  fcntl(inotifyFd, F_SETFD, FD_CLOEXEC);
249 
250  moveToThread(this);
251 }
void moveToThread(QThread *thread)
Changes the thread affinity for this object and its children.
Definition: qobject.cpp:1458
int fcntl(int, int,...)

Functions

◆ addPaths()

QStringList QInotifyFileSystemWatcherEngine::addPaths ( const QStringList paths,
QStringList files,
QStringList directories 
)
virtual

Implements QFileSystemWatcherEngine.

Definition at line 268 of file qfilesystemwatcher_inotify.cpp.

271 {
272  QMutexLocker locker(&mutex);
273 
274  QStringList p = paths;
275  QMutableListIterator<QString> it(p);
276  while (it.hasNext()) {
277  QString path = it.next();
278  QFileInfo fi(path);
279  bool isDir = fi.isDir();
280  if (isDir) {
281  if (directories->contains(path))
282  continue;
283  } else {
284  if (files->contains(path))
285  continue;
286  }
287 
288  int wd = inotify_add_watch(inotifyFd,
289  QFile::encodeName(path),
290  (isDir
291  ? (0
292  | IN_ATTRIB
293  | IN_MOVE
294  | IN_CREATE
295  | IN_DELETE
296  | IN_DELETE_SELF
297  )
298  : (0
299  | IN_ATTRIB
300  | IN_MODIFY
301  | IN_MOVE
302  | IN_MOVE_SELF
303  | IN_DELETE_SELF
304  )));
305  if (wd <= 0) {
306  perror("QInotifyFileSystemWatcherEngine::addPaths: inotify_add_watch failed");
307  continue;
308  }
309 
310  it.remove();
311 
312  int id = isDir ? -wd : wd;
313  if (id < 0) {
314  directories->append(path);
315  } else {
316  files->append(path);
317  }
318 
319  pathToID.insert(path, id);
320  idToPath.insert(id, path);
321  }
322 
323  start();
324 
325  return p;
326 }
#define it(className, varName)
The QString class provides a Unicode character string.
Definition: qstring.h:83
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
void append(const T &t)
Inserts value at the end of the list.
Definition: qlist.h:507
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
QBool contains(const QString &str, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
Returns true if the list contains the string str; otherwise returns false.
Definition: qstringlist.h:172
The QMutexLocker class is a convenience class that simplifies locking and unlocking mutexes...
Definition: qmutex.h:101
void start(Priority=InheritPriority)
Begins execution of the thread by calling run().
static QByteArray encodeName(const QString &fileName)
By default, this function converts fileName to the local 8-bit encoding determined by the user&#39;s loca...
Definition: qfile.cpp:528
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60

◆ create()

QInotifyFileSystemWatcherEngine * QInotifyFileSystemWatcherEngine::create ( )
static

Definition at line 230 of file qfilesystemwatcher_inotify.cpp.

Referenced by QFileSystemWatcherPrivate::initForcedEngine().

231 {
232  register int fd = -1;
233 #ifdef IN_CLOEXEC
234  fd = inotify_init1(IN_CLOEXEC);
235 #endif
236  if (fd == -1) {
237  fd = inotify_init();
238  if (fd == -1)
239  return 0;
240  ::fcntl(fd, F_SETFD, FD_CLOEXEC);
241  }
242  return new QInotifyFileSystemWatcherEngine(fd);
243 }
int fcntl(int, int,...)

◆ readFromInotify

void QInotifyFileSystemWatcherEngine::readFromInotify ( )
privateslot

Definition at line 363 of file qfilesystemwatcher_inotify.cpp.

Referenced by run().

364 {
365  QMutexLocker locker(&mutex);
366 
367  // qDebug() << "QInotifyFileSystemWatcherEngine::readFromInotify";
368 
369  int buffSize = 0;
370  ioctl(inotifyFd, FIONREAD, (char *) &buffSize);
371  QVarLengthArray<char, 4096> buffer(buffSize);
372  buffSize = read(inotifyFd, buffer.data(), buffSize);
373  char *at = buffer.data();
374  char * const end = at + buffSize;
375 
376  QHash<int, inotify_event *> eventForId;
377  while (at < end) {
378  inotify_event *event = reinterpret_cast<inotify_event *>(at);
379 
380  if (eventForId.contains(event->wd))
381  eventForId[event->wd]->mask |= event->mask;
382  else
383  eventForId.insert(event->wd, event);
384 
385  at += sizeof(inotify_event) + event->len;
386  }
387 
389  while (it != eventForId.constEnd()) {
390  const inotify_event &event = **it;
391  ++it;
392 
393  // qDebug() << "inotify event, wd" << event.wd << "mask" << hex << event.mask;
394 
395  int id = event.wd;
396  QString path = idToPath.value(id);
397  if (path.isEmpty()) {
398  // perhaps a directory?
399  id = -id;
400  path = idToPath.value(id);
401  if (path.isEmpty())
402  continue;
403  }
404 
405  // qDebug() << "event for path" << path;
406 
407  if ((event.mask & (IN_DELETE_SELF | IN_MOVE_SELF | IN_UNMOUNT)) != 0) {
408  pathToID.remove(path);
409  idToPath.remove(id);
410  inotify_rm_watch(inotifyFd, event.wd);
411 
412  if (id < 0)
413  emit directoryChanged(path, true);
414  else
415  emit fileChanged(path, true);
416  } else {
417  if (id < 0)
418  emit directoryChanged(path, false);
419  else
420  emit fileChanged(path, false);
421  }
422  }
423 }
The QHash::const_iterator class provides an STL-style const iterator for QHash and QMultiHash...
Definition: qhash.h:395
void fileChanged(const QString &path, bool removed)
int remove(const Key &key)
Removes all the items that have the key from the hash.
Definition: qhash.h:784
#define it(className, varName)
#define at(className, varName)
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QHash class is a template class that provides a hash-table-based dictionary.
Definition: qdatastream.h:66
virtual bool event(QEvent *)
This virtual function receives events to an object and should return true if the event e was recogniz...
Definition: qobject.cpp:1200
bool contains(const Key &key) const
Returns true if the hash contains an item with the key; otherwise returns false.
Definition: qhash.h:872
const T value(const Key &key) const
Returns the value associated with the key.
Definition: qhash.h:606
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
#define emit
Definition: qobjectdefs.h:76
void directoryChanged(const QString &path, bool removed)
const_iterator constBegin() const
Returns a const STL-style iterator pointing to the first item in the hash.
Definition: qhash.h:466
const_iterator constEnd() const
Returns a const STL-style iterator pointing to the imaginary item after the last item in the hash...
Definition: qhash.h:469
The QMutexLocker class is a convenience class that simplifies locking and unlocking mutexes...
Definition: qmutex.h:101
static const KeyPair *const end

◆ removePaths()

QStringList QInotifyFileSystemWatcherEngine::removePaths ( const QStringList paths,
QStringList files,
QStringList directories 
)
virtual

Implements QFileSystemWatcherEngine.

Definition at line 328 of file qfilesystemwatcher_inotify.cpp.

331 {
332  QMutexLocker locker(&mutex);
333 
334  QStringList p = paths;
335  QMutableListIterator<QString> it(p);
336  while (it.hasNext()) {
337  QString path = it.next();
338  int id = pathToID.take(path);
339  QString x = idToPath.take(id);
340  if (x.isEmpty() || x != path)
341  continue;
342 
343  int wd = id < 0 ? -id : id;
344  // qDebug() << "removing watch for path" << path << "wd" << wd;
345  inotify_rm_watch(inotifyFd, wd);
346 
347  it.remove();
348  if (id < 0) {
349  directories->removeAll(path);
350  } else {
351  files->removeAll(path);
352  }
353  }
354 
355  return p;
356 }
#define it(className, varName)
The QString class provides a Unicode character string.
Definition: qstring.h:83
T take(const Key &key)
Removes the item with the key from the hash and returns the value associated with it...
Definition: qhash.h:807
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
The QMutexLocker class is a convenience class that simplifies locking and unlocking mutexes...
Definition: qmutex.h:101
int removeAll(const T &t)
Removes all occurrences of value in the list and returns the number of entries removed.
Definition: qlist.h:770

◆ run()

void QInotifyFileSystemWatcherEngine::run ( void  )
virtual

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 261 of file qfilesystemwatcher_inotify.cpp.

262 {
264  connect(&sn, SIGNAL(activated(int)), SLOT(readFromInotify()));
265  (void) exec();
266 }
#define SLOT(a)
Definition: qobjectdefs.h:226
The QSocketNotifier class provides support for monitoring activity on a file descriptor.
#define SIGNAL(a)
Definition: qobjectdefs.h:227
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 rece...
Definition: qobject.cpp:2580
int exec()
Enters the event loop and waits until exit() is called, returning the value that was passed to exit()...
Definition: qthread.cpp:551

◆ stop()

void QInotifyFileSystemWatcherEngine::stop ( )
virtual

Implements QFileSystemWatcherEngine.

Definition at line 358 of file qfilesystemwatcher_inotify.cpp.

359 {
360  quit();
361 }
void quit()
Tells the thread&#39;s event loop to exit with return code 0 (success).
Definition: qthread.cpp:614

Properties

◆ idToPath

QHash<int, QString> QInotifyFileSystemWatcherEngine::idToPath
private

Definition at line 89 of file qfilesystemwatcher_inotify_p.h.

Referenced by addPaths(), readFromInotify(), and removePaths().

◆ inotifyFd

int QInotifyFileSystemWatcherEngine::inotifyFd
private

◆ mutex

QMutex QInotifyFileSystemWatcherEngine::mutex
private

Definition at line 87 of file qfilesystemwatcher_inotify_p.h.

Referenced by addPaths(), readFromInotify(), and removePaths().

◆ pathToID

QHash<QString, int> QInotifyFileSystemWatcherEngine::pathToID
private

The documentation for this class was generated from the following files: