CFileListProviderComp.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QFileSystemWatcher>
#include <QtCore/QDir>
 
// ACF includes
#include <imod/IModel.h>
#include <imod/CSingleModelObserverBase.h>
#include <ilog/TLoggerCompWrap.h>
#include <ifile/IFileListProvider.h>
#include <ifile/IFileNameParam.h>
#include <ifile/IFileTypeInfo.h>
 
 
namespace ifile
{
 
 
class CFileListProviderComp:
                     public QObject,
                     public ilog::CLoggerComponentBase,
                     virtual public ifile::IFileListProvider,
                     protected imod::CSingleModelObserverBase
{
       Q_OBJECT
public:
       typedef ilog::CLoggerComponentBase BaseClass;
 
       I_BEGIN_COMPONENT(CFileListProviderComp);
              I_REGISTER_INTERFACE(istd::IChangeable);
              I_REGISTER_INTERFACE(ifile::IFileListProvider);
              I_ASSIGN(m_dirParamCompPtr, "DirParam", "Parameter storing root directory", true, "DirParam");
              I_ASSIGN_TO(m_dirParamModelCompPtr, m_dirParamCompPtr, false);
              I_ASSIGN(m_fileTypeInfoCompPtr, "FileTypeInfo", "File type info used to create file filters", false, "FileTypeInfo");
              I_ASSIGN_MULTI_0(m_filtersAttrPtr, "Filters", "List of filters if no loader is specified", false);
              I_ASSIGN(m_minRecurDepthAttrPtr, "MinRecurDepth", "Minimal recursion depth for file search", true, 0);
              I_ASSIGN(m_maxRecurDepthAttrPtr, "MaxRecurDepth", "Maximal recursion depth for file search, negative value means no depth limit", true, 0);
       I_END_COMPONENT;
 
       // reimplemented (ifile::IFileListProvider)
       virtual const QFileInfoList& GetFileList() const override;
 
       static bool CreateFileList(const QDir& root,
                            int minRecursionDepth,
                            int maxRecursionDepth,
                            const QStringList& nameFilters,
                            QDir::SortFlags sortSpec,
                            QFileInfoList& fileList,
                            istd::ILogger* loggerPtr = NULL);
       static bool CreateDirectoryList(const QDir& root,
                            int minRecursionDepth,
                            int maxRecursionDepth,
                            const QStringList& nameFilters,
                            QDir::SortFlags sortSpec,
                            QFileInfoList& directoryList,
                            istd::ILogger* loggerPtr = NULL);
protected:
       // reimplemented (imod::CSingleModelObserverBase)
       virtual void OnUpdate(const istd::IChangeable::ChangeSet& changeSet) override;
 
       // reimplemented (icomp::CComponentBase)
       virtual void OnComponentCreated() override;
       virtual void OnComponentDestroyed() override;
 
private Q_SLOTS:
       void OnDirectoryContentChanged(const QString& directoryPath);
 
private:
       static void EnumerateDirectory(
                            const QDir& root,
                            int minRecursionDepth,
                            int maxRecursionDepth,
                            const QStringList& nameFilters,
                            QDir::SortFlags sortSpec,
                            QFileInfoList& directoryList);
 
private:
       I_REF(ifile::IFileNameParam, m_dirParamCompPtr);
       I_REF(imod::IModel, m_dirParamModelCompPtr);
       I_REF(ifile::IFileTypeInfo, m_fileTypeInfoCompPtr);
       I_MULTIATTR(QString, m_filtersAttrPtr);
       I_ATTR(int, m_minRecurDepthAttrPtr);
       I_ATTR(int, m_maxRecurDepthAttrPtr);
 
       QFileInfoList m_fileList;
 
       QFileSystemWatcher m_directoryWatcher;
};
 
 
} // namespace ifile