File indexing completed on 2024-05-19 04:56:02

 /**
  * \file fileproxymodeliterator.h
  * Iterator for FileProxyModel.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 03-Feb-2013
  *
  * Copyright (C) 2013-2024  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * Kid3 is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #pragma once
 
 #include <QObject>
 #include <QStack>
 #include <QPersistentModelIndex>
 #include "iabortable.h"
 #include "kid3api.h"
 
 class FileProxyModel;
 
 /**
  * Iterator for FileProxyModel.
  * This iterator behaves differently than other iterators, e.g. ModelIterator.
  * The file system model is not completely loaded, subdirectories can be
  * fetched later using fetchMore(). This class fetches directories
  * continuously and waits for them to be fetched. Therefore the routine
  * doing the actual work has to be connected with a slot and will be called
  * when file nodes are available. The iteration will also be suspended after
  * some files so that other slots can be processed and the GUI remains
  * responsive. If the iteration shall stop before all files are processed,
  * abort() shall be called.
  */
 class KID3_CORE_EXPORT FileProxyModelIterator : public QObject, public IAbortable {
   Q_OBJECT
 public:
   /**
    * Constructor.
    *
    * @param model file proxy model
    */
   explicit FileProxyModelIterator(FileProxyModel* model);
 
   /**
    * Destructor.
    */
   ~FileProxyModelIterator() override = default;
 
   /**
    * Abort operation.
    */
   void abort() override;
 
   /**
    * Check if operation is aborted.
    *
    * @return true if aborted.
    */
   bool isAborted() const override;
 
   /**
    * Clear state which is reported by isAborted().
    */
   void clearAborted() override;
 
   /**
    * Start iteration.
    *
    * @param rootIdx index of root element
    */
   void start(const QPersistentModelIndex& rootIdx);
 
   /**
    * Start iteration.
    *
    * @param indexes indexes of root directories
    */
   void start(const QList<QPersistentModelIndex>& indexes);
 
   /**
    * Get amount of work to do.
    * @return number of nodes which have to be processed.
    */
   int getWorkToDo() const { return m_nodes.size() + m_rootIndexes.size(); }
 
   /**
    * Get amount of work done.
    * @return number of nodes which have been processed.
    */
   int getWorkDone() const { return m_numDone; }
 
 signals:
   /**
    * Signaled when the next file node is ready to be processed.
    *
    * @param idx file model index
    */
   void nextReady(const QPersistentModelIndex& idx);
 
 private slots:
   /**
    * Called when the gatherer thread has finished to load.
    */
   void onDirectoryLoaded();
 
   /**
    * Fetch next index.
    */
   void fetchNext();
 
 private:
   QList<QPersistentModelIndex> m_rootIndexes;
   QStack<QPersistentModelIndex> m_nodes;
   FileProxyModel* m_model;
   QPersistentModelIndex m_nextIdx;
   int m_numDone;
   bool m_aborted;
 };