Qt 4.8
Classes | Public Functions | Private Slots | Properties | List of all members
QPollingFileSystemWatcherEngine Class Reference
Inheritance diagram for QPollingFileSystemWatcherEngine:
QFileSystemWatcherEngine QThread QObject

Classes

class  FileInfo
 

Public Functions

QStringList addPaths (const QStringList &paths, QStringList *files, QStringList *directories)
 
 QPollingFileSystemWatcherEngine ()
 
QStringList removePaths (const QStringList &paths, QStringList *files, QStringList *directories)
 
void run ()
 The starting point for the thread. More...
 
void stop ()
 
- 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...
 

Private Slots

void timeout ()
 

Properties

QHash< QString, FileInfodirectories
 
QHash< QString, FileInfofiles
 
QMutex mutex
 

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 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)
 
- 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 75 of file qfilesystemwatcher.cpp.

Constructors and Destructors

◆ QPollingFileSystemWatcherEngine()

QPollingFileSystemWatcherEngine::QPollingFileSystemWatcherEngine ( )

Definition at line 132 of file qfilesystemwatcher.cpp.

133 {
134 #ifndef QT_NO_THREAD
135  moveToThread(this);
136 #endif
137 }
void moveToThread(QThread *thread)
Changes the thread affinity for this object and its children.
Definition: qobject.cpp:1458

Functions

◆ addPaths()

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

Implements QFileSystemWatcherEngine.

Definition at line 147 of file qfilesystemwatcher.cpp.

150 {
151  QMutexLocker locker(&mutex);
152  QStringList p = paths;
153  QMutableListIterator<QString> it(p);
154  while (it.hasNext()) {
155  QString path = it.next();
156  QFileInfo fi(path);
157  if (!fi.exists())
158  continue;
159  if (fi.isDir()) {
160  if (!directories->contains(path))
161  directories->append(path);
162  if (!path.endsWith(QLatin1Char('/')))
163  fi = QFileInfo(path + QLatin1Char('/'));
164  this->directories.insert(path, fi);
165  } else {
166  if (!files->contains(path))
167  files->append(path);
168  this->files.insert(path, fi);
169  }
170  it.remove();
171  }
172  start();
173  return p;
174 }
#define it(className, varName)
void insert(int i, const T &t)
Inserts value at index position i in the list.
Definition: qlist.h:575
The QString class provides a Unicode character string.
Definition: qstring.h:83
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().
bool endsWith(const QString &s, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
Returns true if the string ends with s; otherwise returns false.
Definition: qstring.cpp:3796
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60
The QLatin1Char class provides an 8-bit ASCII/Latin-1 character.
Definition: qchar.h:55

◆ removePaths()

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

Implements QFileSystemWatcherEngine.

Definition at line 176 of file qfilesystemwatcher.cpp.

179 {
180  QMutexLocker locker(&mutex);
181  QStringList p = paths;
182  QMutableListIterator<QString> it(p);
183  while (it.hasNext()) {
184  QString path = it.next();
185  if (this->directories.remove(path)) {
186  directories->removeAll(path);
187  it.remove();
188  } else if (this->files.remove(path)) {
189  files->removeAll(path);
190  it.remove();
191  }
192  }
193  if (this->files.isEmpty() && this->directories.isEmpty()) {
194  locker.unlock();
195  stop();
196  wait();
197  }
198  return p;
199 }
#define it(className, varName)
The QString class provides a Unicode character string.
Definition: qstring.h:83
bool isEmpty() const
Returns true if the list contains no items; otherwise returns false.
Definition: qlist.h:152
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
bool wait(unsigned long time=ULONG_MAX)
Blocks the thread until either of these conditions is met:
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 QPollingFileSystemWatcherEngine::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 139 of file qfilesystemwatcher.cpp.

140 {
141  QTimer timer;
142  connect(&timer, SIGNAL(timeout()), SLOT(timeout()));
143  timer.start(PollingInterval);
144  (void) exec();
145 }
#define SLOT(a)
Definition: qobjectdefs.h:226
EventLoopTimerRef timer
#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
The QTimer class provides repetitive and single-shot timers.
Definition: qtimer.h:56
void start(int msec)
Starts or restarts the timer with a timeout interval of msec milliseconds.
Definition: qtimer.cpp:249

◆ stop()

void QPollingFileSystemWatcherEngine::stop ( )
virtual

Implements QFileSystemWatcherEngine.

Definition at line 201 of file qfilesystemwatcher.cpp.

Referenced by removePaths().

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

◆ timeout

void QPollingFileSystemWatcherEngine::timeout ( )
privateslot

Definition at line 206 of file qfilesystemwatcher.cpp.

Referenced by run().

207 {
208  QMutexLocker locker(&mutex);
209  QMutableHashIterator<QString, FileInfo> fit(files);
210  while (fit.hasNext()) {
211  QHash<QString, FileInfo>::iterator x = fit.next();
212  QString path = x.key();
213  QFileInfo fi(path);
214  if (!fi.exists()) {
215  fit.remove();
216  emit fileChanged(path, true);
217  } else if (x.value() != fi) {
218  x.value() = fi;
219  emit fileChanged(path, false);
220  }
221  }
222  QMutableHashIterator<QString, FileInfo> dit(directories);
223  while (dit.hasNext()) {
224  QHash<QString, FileInfo>::iterator x = dit.next();
225  QString path = x.key();
226  QFileInfo fi(path);
227  if (!path.endsWith(QLatin1Char('/')))
228  fi = QFileInfo(path + QLatin1Char('/'));
229  if (!fi.exists()) {
230  dit.remove();
231  emit directoryChanged(path, true);
232  } else if (x.value() != fi) {
233  fi.refresh();
234  if (!fi.exists()) {
235  dit.remove();
236  emit directoryChanged(path, true);
237  } else {
238  x.value() = fi;
239  emit directoryChanged(path, false);
240  }
241  }
242 
243  }
244 }
void fileChanged(const QString &path, bool removed)
QHash< QString, FileInfo > files
T & value() const
Returns a modifiable reference to the current item&#39;s value.
Definition: qhash.h:348
The QString class provides a Unicode character string.
Definition: qstring.h:83
QHash< QString, FileInfo > directories
#define emit
Definition: qobjectdefs.h:76
const Key & key() const
Returns the current item&#39;s key as a const reference.
Definition: qhash.h:347
void directoryChanged(const QString &path, bool removed)
The QMutexLocker class is a convenience class that simplifies locking and unlocking mutexes...
Definition: qmutex.h:101
The QHash::iterator class provides an STL-style non-const iterator for QHash and QMultiHash.
Definition: qhash.h:330
bool endsWith(const QString &s, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
Returns true if the string ends with s; otherwise returns false.
Definition: qstring.cpp:3796
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60
The QLatin1Char class provides an 8-bit ASCII/Latin-1 character.
Definition: qchar.h:55

Properties

◆ directories

QHash<QString, FileInfo> QPollingFileSystemWatcherEngine::directories
private

Definition at line 116 of file qfilesystemwatcher.cpp.

Referenced by timeout().

◆ files

QHash<QString, FileInfo> QPollingFileSystemWatcherEngine::files
private

Definition at line 116 of file qfilesystemwatcher.cpp.

Referenced by timeout().

◆ mutex

QMutex QPollingFileSystemWatcherEngine::mutex
mutableprivate

Definition at line 115 of file qfilesystemwatcher.cpp.

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


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