LibrePCB

/*
 * 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/>.
 */

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "projectlibrary.h"

#include "../application.h"
#include "../exceptions.h"
#include "../fileio/filepath.h"
#include "../fileio/transactionalfilesystem.h"
#include "../library/cmp/component.h"
#include "../library/dev/device.h"
#include "../library/pkg/package.h"
#include "../library/sym/symbol.h"
#include "project.h"

#include <QtCore>

/*******************************************************************************
 *  Namespace
 ******************************************************************************/
namespace librepcb {

/*******************************************************************************
 *  Constructors / Destructor
 ******************************************************************************/

ProjectLibrary::ProjectLibrary(
    std::unique_ptr<TransactionalDirectory> directory)
  : mDirectory(std::move(directory)) {
  qDebug() << "load project library...";

  try {
    // Load all library elements
    loadElements<Symbol>("sym", "symbols", mSymbols);
    loadElements<Package>("pkg", "packages", mPackages);
    loadElements<Component>("cmp", "components", mComponents);
    loadElements<Device>("dev", "devices", mDevices);
  } catch (const Exception&) {
    qDeleteAll(mAllElements);
    mAllElements.clear();
    throw;
  }

  qDebug() << "project library successfully loaded!";
}

ProjectLibrary::~ProjectLibrary() noexcept {
  // Delete all library elements.
  qDeleteAll(mAllElements);
  mAllElements.clear();
  mElementsToUpgrade.clear();
}

/*******************************************************************************
 *  Getters: Special Queries
 ******************************************************************************/

QHash<Uuid, Device*> ProjectLibrary::getDevicesOfComponent(
    const Uuid& compUuid) const noexcept {
  QHash<Uuid, Device*> list;
  foreach (Device* device, mDevices) {
    if (device->getComponentUuid() == compUuid) {
      list.insert(device->getUuid(), device);
    }
  }
  return list;
}

/*******************************************************************************
 *  Add/Remove Methods
 ******************************************************************************/

void ProjectLibrary::addSymbol(Symbol& s) {
  addElement<Symbol>(s, mSymbols);
}

void ProjectLibrary::addPackage(Package& p) {
  addElement<Package>(p, mPackages);
}

void ProjectLibrary::addComponent(Component& c) {
  addElement<Component>(c, mComponents);
}

void ProjectLibrary::addDevice(Device& d) {
  addElement<Device>(d, mDevices);
}

void ProjectLibrary::removeSymbol(Symbol& s) {
  removeElement<Symbol>(s, mSymbols);
}

void ProjectLibrary::removePackage(Package& p) {
  removeElement<Package>(p, mPackages);
}

void ProjectLibrary::removeComponent(Component& c) {
  removeElement<Component>(c, mComponents);
}

void ProjectLibrary::removeDevice(Device& d) {
  removeElement<Device>(d, mDevices);
}

/*******************************************************************************
 *  General Methods
 ******************************************************************************/

void ProjectLibrary::save() {
  // Save library elements to enforce a file format upgrade, but only once for
  // optimal performance.
  foreach (LibraryBaseElement* element, mElementsToUpgrade) {
    element->save();  // can throw
    mElementsToUpgrade.remove(element);
  }
}

/*******************************************************************************
 *  Private Methods
 ******************************************************************************/

template <typename ElementType>
void ProjectLibrary::loadElements(const QString& dirname, const QString& type,
                                  QHash<Uuid, ElementType*>& elementList) {
  // search all subdirectories which have a valid UUID as directory name
  foreach (const QString& sub, mDirectory->getDirs(dirname)) {
    std::unique_ptr<TransactionalDirectory> dir(
        new TransactionalDirectory(*mDirectory, dirname % "/" % sub));

    // check if directory is a valid library element
    if (!LibraryBaseElement::isValidElementDirectory<ElementType>(*dir, "")) {
      qWarning() << "Found an invalid directory in the library:"
                 << dir->getAbsPath().toNative();
      continue;
    }

    // load the library element
    QScopedPointer<ElementType> element(
        new ElementType(std::move(dir)));  // can throw
    if (elementList.contains(element->getUuid())) {
      throw RuntimeError(__FILE__, __LINE__,
                         QString("There are multiple %1 with the UUID \"%2\"")
                             .arg(type, element->getUuid().toStr()));
    }

    // everything is ok -> update members
    elementList.insert(element->getUuid(), element.data());
    mElementsToUpgrade.insert(element.data());
    mAllElements.insert(element.take());  // Take object from smart pointer!
  }

  qDebug() << "successfully loaded" << elementList.count() << qPrintable(type);
}

template <typename ElementType>
void ProjectLibrary::addElement(ElementType& element,
                                QHash<Uuid, ElementType*>& elementList) {
  if (elementList.contains(element.getUuid())) {
    throw LogicError(__FILE__, __LINE__,
                     QString("There is already an element with the same "
                             "UUID in the project's library: %1")
                         .arg(element.getUuid().toStr()));
  }
  TransactionalDirectory dir(*mDirectory, element.getShortElementName());
  element.saveIntoParentDirectory(dir);  // can throw
  elementList.insert(element.getUuid(), &element);
  mAllElements.insert(&element);
}

template <typename ElementType>
void ProjectLibrary::removeElement(ElementType& element,
                                   QHash<Uuid, ElementType*>& elementList) {
  Q_ASSERT(elementList.value(element.getUuid()) == &element);
  Q_ASSERT(mAllElements.contains(&element));
  TransactionalDirectory dir(
      TransactionalFileSystem::openRW(FilePath::getRandomTempPath()));
  element.moveIntoParentDirectory(dir);  // can throw
  elementList.remove(element.getUuid());
}

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

}  // namespace librepcb