kicadlibraryimportwizardcontext.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_EDITOR_KICADLIBRARYIMPORTWIZARDCONTEXT_H
#define LIBREPCB_EDITOR_KICADLIBRARYIMPORTWIZARDCONTEXT_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/core/fileio/filepath.h>
#include <librepcb/core/types/uuid.h>
 
#include <QtCore>
 
#include <optional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class MessageLogger;
class Workspace;
 
namespace kicadimport {
class KiCadLibraryImport;
}
 
namespace editor {
 
/*******************************************************************************
 *  Class KiCadLibraryImportWizardContext
 ******************************************************************************/
 
class KiCadLibraryImportWizardContext final : public QObject {
  Q_OBJECT
 
public:
  static constexpr const char* NAME_PREFIX = "KICAD_";
 
  // Constructors / Destructor
  KiCadLibraryImportWizardContext() = delete;
  KiCadLibraryImportWizardContext(
      const KiCadLibraryImportWizardContext& other) = delete;
  KiCadLibraryImportWizardContext(Workspace& workspace,
                                  const FilePath& dstLibFp,
                                  QObject* parent = nullptr) noexcept;
  ~KiCadLibraryImportWizardContext() noexcept;
 
  // Getters
  Workspace& getWorkspace() const noexcept { return mWorkspace; }
  const FilePath& getLibsPath() const noexcept { return mLibsPath; }
  const FilePath& getShapes3dPath() const noexcept { return mShapes3dPath; }
  bool getAddNamePrefix() const noexcept { return mAddNamePrefix; }
  const std::optional<Uuid>& getComponentCategory() const noexcept {
    return mComponentCategoryUuid;
  }
  const std::optional<Uuid>& getPackageCategory() const noexcept {
    return mPackageCategoryUuid;
  }
  kicadimport::KiCadLibraryImport& getImport() const noexcept {
    return *mImport;
  }
 
  // Setters
  void setLibsPath(const QString& libsPath, const QString& shapes3dPath,
                   std::shared_ptr<MessageLogger> log) noexcept;
  void setAddNamePrefix(bool add) noexcept;
  void setComponentCategory(const std::optional<Uuid>& uuid) noexcept;
  void setPackageCategory(const std::optional<Uuid>& uuid) noexcept;
 
  // Operator Overloadings
  KiCadLibraryImportWizardContext& operator=(
      const KiCadLibraryImportWizardContext& rhs) = delete;
 
signals:
  void scanFinished();
 
private:  // Data
  Workspace& mWorkspace;
  FilePath mLibsPath;
  FilePath mShapes3dPath;
  bool mAddNamePrefix;
  std::optional<Uuid> mComponentCategoryUuid;
  std::optional<Uuid> mPackageCategoryUuid;
  QScopedPointer<kicadimport::KiCadLibraryImport> mImport;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif