libraryelementcache.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_LIBRARY_LIBRARYELEMENTCACHE_H
#define LIBREPCB_LIBRARY_LIBRARYELEMENTCACHE_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/common/fileio/filepath.h>
#include <librepcb/common/uuid.h>

#include <QtCore>

#include <memory>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {

namespace workspace {
class WorkspaceLibraryDb;
}

namespace library {

class ComponentCategory;
class PackageCategory;
class Symbol;
class Package;
class Component;
class Device;

/*******************************************************************************
 *  Class LibraryElementCache
 ******************************************************************************/

class LibraryElementCache final {
  Q_DECLARE_TR_FUNCTIONS(LibraryElementCache)

public:
  // Constructors / Destructor
  LibraryElementCache()                                 = delete;
  LibraryElementCache(const LibraryElementCache& other) = delete;
  explicit LibraryElementCache(
      const workspace::WorkspaceLibraryDb& db) noexcept;
  ~LibraryElementCache() noexcept;

  // Getters
  std::shared_ptr<const ComponentCategory> getComponentCategory(
      const Uuid& uuid) const noexcept;
  std::shared_ptr<const PackageCategory> getPackageCategory(
      const Uuid& uuid) const noexcept;
  std::shared_ptr<const Symbol>    getSymbol(const Uuid& uuid) const noexcept;
  std::shared_ptr<const Package>   getPackage(const Uuid& uuid) const noexcept;
  std::shared_ptr<const Component> getComponent(const Uuid& uuid) const
      noexcept;
  std::shared_ptr<const Device> getDevice(const Uuid& uuid) const noexcept;

  // Operator Overloadings
  LibraryElementCache& operator=(const LibraryElementCache& rhs) = delete;

private:  // Methods
  template <typename T>
  std::shared_ptr<const T> getElement(
      FilePath (workspace::WorkspaceLibraryDb::*getter)(const Uuid&) const,
      QHash<Uuid, std::shared_ptr<const T>>& container, const Uuid& uuid) const
      noexcept;

private:  // Data
  QPointer<const workspace::WorkspaceLibraryDb>                 mDb;
  mutable QHash<Uuid, std::shared_ptr<const ComponentCategory>> mCmpCat;
  mutable QHash<Uuid, std::shared_ptr<const PackageCategory>>   mPkgCat;
  mutable QHash<Uuid, std::shared_ptr<const Symbol>>            mSym;
  mutable QHash<Uuid, std::shared_ptr<const Package>>           mPkg;
  mutable QHash<Uuid, std::shared_ptr<const Component>>         mCmp;
  mutable QHash<Uuid, std::shared_ptr<const Device>>            mDev;
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace library
}  // namespace librepcb

#endif  // LIBREPCB_LIBRARY_LIBRARYELEMENTCACHE_H