Skip to content

Commit

Permalink
autorefresh browser dirs using system notification
Browse files Browse the repository at this point in the history
  • Loading branch information
@blazek
blazek committed Dec 15, 2014
1 parent da887bc commit e7dcd48
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 29 deletions.
117 changes: 99 additions & 18 deletions src/core/qgsdataitem.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ QgsDataItem::QgsDataItem( QgsDataItem::Type type, QgsDataItem* parent, QString n
, mName( name )
, mPath( path )
, mDeferredDelete( false )
, mWatcher( 0 )
, mFutureWatcher( 0 )
{
Q_UNUSED( parent );
}
Expand All @@ -182,12 +182,12 @@ QgsDataItem::~QgsDataItem()
}
mChildren.clear();

if ( mWatcher && !mWatcher->isFinished() )
if ( mFutureWatcher && !mFutureWatcher->isFinished() )
{
// this should not usually happen (until the item was deleted directly when createChildren was running)
QgsDebugMsg( "mWatcher not finished (should not happen) -> waitForFinished()" );
QgsDebugMsg( "mFutureWatcher not finished (should not happen) -> waitForFinished()" );
mDeferredDelete = true;
mWatcher->waitForFinished();
mFutureWatcher->waitForFinished();
}
}

Expand All @@ -203,9 +203,9 @@ void QgsDataItem::deleteLater()
}
mChildren.clear();

if ( mWatcher && !mWatcher->isFinished() )
if ( mFutureWatcher && !mFutureWatcher->isFinished() )
{
QgsDebugMsg( "mWatcher not finished -> schedule to delete later" );
QgsDebugMsg( "mFutureWatcher not finished -> schedule to delete later" );
mDeferredDelete = true;
}
else
Expand All @@ -214,6 +214,17 @@ void QgsDataItem::deleteLater()
}
}

void QgsDataItem::deleteLater( QVector<QgsDataItem*> &items )
{
foreach ( QgsDataItem *item, items )
{
if ( !item ) // should not happen
continue;
item->deleteLater();
}
items.clear();
}

QIcon QgsDataItem::icon()
{
if ( state() == Populating )
Expand Down Expand Up @@ -283,12 +294,12 @@ void QgsDataItem::populate()
{
setState( Populating );
// The watcher must not be created with item (in constructor) because the item may be created in thread and the watcher created in thread does not work correctly.
if ( !mWatcher )
if ( !mFutureWatcher )
{
mWatcher = new QFutureWatcher< QVector <QgsDataItem*> >( this );
mFutureWatcher = new QFutureWatcher< QVector <QgsDataItem*> >( this );
}
connect( mWatcher, SIGNAL( finished() ), SLOT( childrenCreated() ) );
mWatcher->setFuture( QtConcurrent::run( runCreateChildren, this ) );
connect( mFutureWatcher, SIGNAL( finished() ), SLOT( childrenCreated() ) );
mFutureWatcher->setFuture( QtConcurrent::run( runCreateChildren, this ) );
}
}

Expand Down Expand Up @@ -317,7 +328,7 @@ QVector<QgsDataItem*> QgsDataItem::runCreateChildren( QgsDataItem* item )

void QgsDataItem::childrenCreated()
{
QgsDebugMsg( QString( "path = %1 children.size() = %2" ).arg( path() ).arg( mWatcher->result().size() ) );
QgsDebugMsg( QString( "path = %1 children.size() = %2" ).arg( path() ).arg( mFutureWatcher->result().size() ) );

if ( deferredDelete() )
{
Expand All @@ -328,13 +339,13 @@ void QgsDataItem::childrenCreated()

if ( mChildren.size() == 0 ) // usually populating but may also be refresh if originaly there were no children
{
populate( mWatcher->result() );
populate( mFutureWatcher->result() );
}
else // refreshing
{
refresh( mWatcher->result() );
refresh( mFutureWatcher->result() );
}
disconnect( mWatcher, SIGNAL( finished() ), this, SLOT( childrenCreated() ) );
disconnect( mFutureWatcher, SIGNAL( finished() ), this, SLOT( childrenCreated() ) );
emit dataChanged( this ); // to replace loading icon by normal icon
}

Expand Down Expand Up @@ -379,12 +390,12 @@ void QgsDataItem::refresh()
else
{
setState( Populating );
if ( !mWatcher )
if ( !mFutureWatcher )
{
mWatcher = new QFutureWatcher< QVector <QgsDataItem*> >( this );
mFutureWatcher = new QFutureWatcher< QVector <QgsDataItem*> >( this );
}
connect( mWatcher, SIGNAL( finished() ), SLOT( childrenCreated() ) );
mWatcher->setFuture( QtConcurrent::run( runCreateChildren, this ) );
connect( mFutureWatcher, SIGNAL( finished() ), SLOT( childrenCreated() ) );
mFutureWatcher->setFuture( QtConcurrent::run( runCreateChildren, this ) );
}
}

Expand Down Expand Up @@ -676,6 +687,8 @@ QVector<QLibrary*> QgsDirectoryItem::mLibraries = QVector<QLibrary*>();
QgsDirectoryItem::QgsDirectoryItem( QgsDataItem* parent, QString name, QString path )
: QgsDataCollectionItem( parent, name, path )
, mDirPath( path )
, mFileSystemWatcher( 0 )
, mRefreshLater( false )
{
mType = Directory;
init();
Expand All @@ -684,6 +697,8 @@ QgsDirectoryItem::QgsDirectoryItem( QgsDataItem* parent, QString name, QString p
QgsDirectoryItem::QgsDirectoryItem( QgsDataItem* parent, QString name, QString dirPath, QString path )
: QgsDataCollectionItem( parent, name, path )
, mDirPath( dirPath )
, mFileSystemWatcher( 0 )
, mRefreshLater( false )
{
mType = Directory;
init();
Expand Down Expand Up @@ -746,6 +761,11 @@ QVector<QgsDataItem*> QgsDirectoryItem::createChildren()
QStringList entries = dir.entryList( QDir::AllDirs | QDir::NoDotAndDotDot, QDir::Name | QDir::IgnoreCase );
foreach ( QString subdir, entries )
{
if ( mRefreshLater )
{
deleteLater( children );
return children;
}
QString subdirPath = dir.absoluteFilePath( subdir );
QgsDebugMsgLevel( QString( "creating subdir: %1" ).arg( subdirPath ), 2 );

Expand All @@ -759,6 +779,12 @@ QVector<QgsDataItem*> QgsDirectoryItem::createChildren()
QStringList fileEntries = dir.entryList( QDir::Dirs | QDir::NoDotAndDotDot | QDir::Files, QDir::Name );
foreach ( QString name, fileEntries )
{
if ( mRefreshLater )
{
deleteLater( children );
return children;
}

QString path = dir.absoluteFilePath( name );
QFileInfo fileInfo( path );

Expand Down Expand Up @@ -810,6 +836,61 @@ QVector<QgsDataItem*> QgsDirectoryItem::createChildren()
return children;
}

void QgsDirectoryItem::setState( State state )
{
QgsDebugMsg( "Entered" );
QgsDataCollectionItem::setState( state );

if ( state == Populated )
{
if ( !mFileSystemWatcher )
{
mFileSystemWatcher = new QFileSystemWatcher( this );
mFileSystemWatcher->addPath( mDirPath );
connect( mFileSystemWatcher, SIGNAL( directoryChanged( const QString & ) ), SLOT( directoryChanged() ) );
}
}
else if ( state == NotPopulated )
{
if ( mFileSystemWatcher )
{
delete mFileSystemWatcher;
mFileSystemWatcher = 0;
}
}
}

void QgsDirectoryItem::directoryChanged()
{
QgsDebugMsg( "Entered" );
if ( state() == Populating )
{
// schedule to refresh later, because refres() simply returns if Populating
mRefreshLater = true;
}
else
{
refresh();
}
}

void QgsDirectoryItem::childrenCreated()
{
QgsDebugMsg( QString( "mRefreshLater = %1" ).arg( mRefreshLater ) );

if ( mRefreshLater )
{
QgsDebugMsg( "directory changed during createChidren() -> refresh() again" );
mRefreshLater = false;
setState( Populated );
refresh();
}
else
{
QgsDataCollectionItem::childrenCreated();
}
}

bool QgsDirectoryItem::equal( const QgsDataItem *other )
{
//QgsDebugMsg ( mPath + " x " + other->mPath );
Expand Down
37 changes: 26 additions & 11 deletions src/core/qgsdataitem.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
#ifndef QGSDATAITEM_H
#define QGSDATAITEM_H

#include <QFileSystemWatcher>
#include <QFutureWatcher>
#include <QIcon>
#include <QLibrary>
Expand Down Expand Up @@ -62,18 +63,10 @@ class CORE_EXPORT QgsDataItem : public QObject

int rowCount();

virtual void refresh();

/** Create children. Children are not expected to have parent set.
* This method MUST BE THREAD SAFE. */
virtual QVector<QgsDataItem*> createChildren();

// Populate children using children vector created by createChildren()
virtual void populate();

/** Remove children recursively and set as not populated. This is used when refreshing collapsed items. */
virtual void depopulate();

enum State
{
NotPopulated, //!< Children not yet created
Expand All @@ -85,7 +78,7 @@ class CORE_EXPORT QgsDataItem : public QObject

/** Set item state. It also take care about starting/stopping loading icon animation.
* @param state */
void setState( State state );
virtual void setState( State state );

//! @deprecated in 2.8, use state()
bool isPopulated() { return state() == Populated; }
Expand Down Expand Up @@ -163,6 +156,9 @@ class CORE_EXPORT QgsDataItem : public QObject
void setToolTip( QString msg ) { mToolTip = msg; }
QString toolTip() const { return mToolTip; }

// deleteLater() items anc clear the vector
static void deleteLater( QVector<QgsDataItem*> &items );

protected:
virtual void populate( QVector<QgsDataItem*> children );
virtual void refresh( QVector<QgsDataItem*> children );
Expand Down Expand Up @@ -202,14 +198,23 @@ class CORE_EXPORT QgsDataItem : public QObject
* - calls QObject::deleteLater()
*/
virtual void deleteLater();

// Populate children using children vector created by createChildren()
virtual void populate();

/** Remove children recursively and set as not populated. This is used when refreshing collapsed items. */
virtual void depopulate();

virtual void refresh();

void emitBeginInsertItems( QgsDataItem* parent, int first, int last );
void emitEndInsertItems();
void emitBeginRemoveItems( QgsDataItem* parent, int first, int last );
void emitEndRemoveItems();
void emitDataChanged( QgsDataItem* item );
void emitDataChanged( );
void emitStateChanged( QgsDataItem* item, QgsDataItem::State oldState );
void childrenCreated();
virtual void childrenCreated();
void setPopulatingIcon();

signals:
Expand All @@ -225,7 +230,7 @@ class CORE_EXPORT QgsDataItem : public QObject

// Set to true if object has to be deleted when possible (nothing running in threads)
bool mDeferredDelete;
QFutureWatcher< QVector <QgsDataItem*> > *mWatcher;
QFutureWatcher< QVector <QgsDataItem*> > *mFutureWatcher;
// number of items currently in loading (populating) state
static int mPopulatingCount;
static QMovie * mPopulatingMovie;
Expand Down Expand Up @@ -327,6 +332,8 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem
QgsDirectoryItem( QgsDataItem* parent, QString name, QString dirPath, QString path );
~QgsDirectoryItem();

virtual void setState( State state );

QVector<QgsDataItem*> createChildren();

QString dirPath() const { return mDirPath; }
Expand All @@ -338,9 +345,17 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem
//! @note not available via python bindings
static QVector<QLibrary*> mLibraries;

public slots:
virtual void childrenCreated();
void directoryChanged();

protected:
void init();
QString mDirPath;

private:
QFileSystemWatcher * mFileSystemWatcher;
bool mRefreshLater;
};

/**
Expand Down

0 comments on commit e7dcd48

Please sign in to comment.