workspacelibraryscanner.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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/>.
 */
 
#ifndef LIBREPCB_CORE_WORKSPACELIBRARYSCANNER_H
#define LIBREPCB_CORE_WORKSPACELIBRARYSCANNER_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../fileio/filepath.h"
 
#include <condition_variable>
 
#include <QtCore>
 
#include <memory>
#include <mutex>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class Library;
class SQLiteDatabase;
class WorkspaceLibraryDbWriter;
 
/*******************************************************************************
 *  Class WorkspaceLibraryScanner
 ******************************************************************************/
 
class WorkspaceLibraryScanner final : public QThread {
  Q_OBJECT
 
  enum class State {
    Idle,
    StartRequested,
    Scanning,
    CancelRequested,
    ShutdownRequested,
  };
 
public:
  // Constructors / Destructor
  WorkspaceLibraryScanner(const FilePath& librariesPath,
                          const FilePath& dbFilePath) noexcept;
  WorkspaceLibraryScanner(const WorkspaceLibraryScanner& other) = delete;
  ~WorkspaceLibraryScanner() noexcept;
 
  // Getters
  int getProgressPercent() const noexcept { return mLastProgressPercent; }
 
  // General Methods
  void startScan() noexcept;
  bool cancelScan() noexcept;
 
  // Operator Overloadings
  WorkspaceLibraryScanner& operator=(const WorkspaceLibraryScanner& rhs) =
      delete;
 
signals:
  void scanStarted();
  void scanLibraryListUpdated(int libraryCount);
  void scanProgressUpdate(int percent);
  void scanSucceeded(int elementCount);
  void scanFailed(QString errorMsg);
  void scanFinished();
  void scanInProgressChanged(bool inProgress);
 
private:  // Methods
  void run() noexcept override;
  void scan() noexcept;
  void getLibrariesOfDirectory(const QString& root,
                               QList<std::shared_ptr<Library>>& libs) noexcept;
 
  QHash<FilePath, int> updateLibraries(
      SQLiteDatabase& db, WorkspaceLibraryDbWriter& writer,
      const QList<std::shared_ptr<Library>>& libs);
  template <typename ElementType>
  int addElementsToDb(WorkspaceLibraryDbWriter& writer, const FilePath& libPath,
                      const QStringList& dirs, int libId);
  template <typename ElementType>
  int addElementToDb(WorkspaceLibraryDbWriter& writer, int libId,
                     const ElementType& element);
  template <typename ElementType>
  void addTranslationsToDb(WorkspaceLibraryDbWriter& writer, int elementId,
                           const ElementType& element);
  template <typename ElementType>
  void addToCategories(WorkspaceLibraryDbWriter& writer, int elementId,
                       const ElementType& element);
  template <typename ElementType>
  void addResourcesToDb(WorkspaceLibraryDbWriter& writer, int elementId,
                        const ElementType& element);
  template <typename ElementType>
  std::unique_ptr<ElementType> openAndMigrate(const FilePath& fp);
  bool abortRequested() const noexcept;
 
private:  // Data
  const FilePath mLibrariesPath;  
  const FilePath mDbFilePath;  
  mutable std::mutex mMutex;  
  State mState;  
  std::condition_variable mStateCV;  
  int mLastProgressPercent;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif