project.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_PROJECT_H
#define LIBREPCB_CORE_PROJECT_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../attribute/attribute.h"
#include "../fileio/directorylock.h"
#include "../fileio/transactionaldirectory.h"
#include "../job/outputjob.h"
#include "../types/elementname.h"
#include "../types/fileproofname.h"
#include "../types/uuid.h"
#include "../types/version.h"

#include <QtCore>

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

class Board;
class Circuit;
class ProjectLibrary;
class Schematic;
class StrokeFontPool;

/*******************************************************************************
 *  Class Project
 ******************************************************************************/

class Project final : public QObject {
  Q_OBJECT

public:
  // Constructors / Destructor
  Project() = delete;
  Project(const Project& other) = delete;

  Project(std::unique_ptr<TransactionalDirectory> directory,
          const QString& filename);

  ~Project() noexcept;

  // Getters

  const QString& getFileName() const noexcept { return mFilename; }

  FilePath getFilepath() const noexcept {
    return mDirectory->getAbsPath(mFilename);
  }

  FilePath getPath() const noexcept { return mDirectory->getAbsPath(); }

  const TransactionalDirectory& getDirectory() const noexcept {
    return *mDirectory;
  }

  TransactionalDirectory& getDirectory() noexcept { return *mDirectory; }

  FilePath getCurrentOutputDir() const noexcept {
    return mDirectory->getAbsPath("output/" % *mVersion);
  }

  StrokeFontPool& getStrokeFonts() const noexcept { return *mStrokeFontPool; }

  const Uuid& getUuid() const noexcept { return mUuid; }

  const ElementName& getName() const noexcept { return mName; }

  const QString& getAuthor() const noexcept { return mAuthor; }

  const FileProofName& getVersion() const noexcept { return mVersion; }

  const QDateTime& getCreated() const noexcept { return mCreated; }

  const QDateTime& getDateTime() const noexcept { return mDateTime; }

  const AttributeList& getAttributes() const noexcept { return mAttributes; }

  const QStringList& getLocaleOrder() const noexcept { return mLocaleOrder; }

  const QStringList& getNormOrder() const noexcept { return mNormOrder; }

  const QStringList& getCustomBomAttributes() const noexcept {
    return mCustomBomAttributes;
  }

  bool getDefaultLockComponentAssembly() const noexcept {
    return mDefaultLockComponentAssembly;
  }

  const OutputJobList& getOutputJobs() const noexcept { return mOutputJobs; }
  OutputJobList& getOutputJobs() noexcept { return mOutputJobs; }

  ProjectLibrary& getLibrary() const noexcept { return *mProjectLibrary; }

  Circuit& getCircuit() const noexcept { return *mCircuit; }

  const QSet<SExpression>& getErcMessageApprovals() const noexcept {
    return mErcMessageApprovals;
  }

  const QPointer<Board>& getPrimaryBoard() noexcept { return mPrimaryBoard; }

  // Setters

  void setUuid(const Uuid& newUuid) noexcept;

  void setName(const ElementName& newName) noexcept;

  void setAuthor(const QString& newAuthor) noexcept;

  void setVersion(const FileProofName& newVersion) noexcept;

  void setCreated(const QDateTime& newCreated) noexcept;

  void updateDateTime() noexcept;

  void setAttributes(const AttributeList& newAttributes) noexcept;

  void setLocaleOrder(const QStringList& newLocales) noexcept;

  void setNormOrder(const QStringList& newNorms) noexcept;

  void setCustomBomAttributes(const QStringList& newKeys) noexcept;

  void setDefaultLockComponentAssembly(bool newLock) noexcept;

  bool setErcMessageApprovals(const QSet<SExpression>& approvals) noexcept;

  // Schematic Methods

  int getSchematicIndex(const Schematic& schematic) const noexcept;

  const QList<Schematic*>& getSchematics() const noexcept {
    return mSchematics;
  }

  Schematic* getSchematicByIndex(int index) const noexcept {
    return mSchematics.value(index, nullptr);
  }

  Schematic* getSchematicByUuid(const Uuid& uuid) const noexcept;

  Schematic* getSchematicByName(const QString& name) const noexcept;

  void addSchematic(Schematic& schematic, int newIndex = -1);

  void removeSchematic(Schematic& schematic, bool deleteSchematic = false);

  // Board Methods

  int getBoardIndex(const Board& board) const noexcept;

  const QList<Board*>& getBoards() const noexcept { return mBoards; }

  Board* getBoardByIndex(int index) const noexcept {
    return mBoards.value(index, nullptr);
  }

  Board* getBoardByUuid(const Uuid& uuid) const noexcept;

  Board* getBoardByName(const QString& name) const noexcept;

  void addBoard(Board& board, int newIndex = -1);

  void removeBoard(Board& board, bool deleteBoard = false);

  // General Methods

  void save();

  // Operator Overloadings
  bool operator==(const Project& rhs) noexcept { return (this == &rhs); }
  bool operator!=(const Project& rhs) noexcept { return (this != &rhs); }

  // Static Methods

  static std::unique_ptr<Project> create(
      std::unique_ptr<TransactionalDirectory> directory,
      const QString& filename);
  static bool isFilePathInsideProjectDirectory(const FilePath& fp) noexcept;
  static bool isProjectFile(const FilePath& file) noexcept;
  static bool isProjectDirectory(const FilePath& dir) noexcept;
  static Version getProjectFileFormatVersion(const FilePath& dir);

signals:
  void attributesChanged();

  void normOrderChanged();

  void ercMessageApprovalsChanged(const QSet<SExpression>& approvals);

  void schematicAdded(int newIndex);

  void schematicRemoved(int oldIndex);

  void boardAdded(int newIndex);

  void boardRemoved(int oldIndex);

  void primaryBoardChanged(const QPointer<Board>& board);

private:  // Methods
  void updatePrimaryBoard();

private:  // Data
  std::unique_ptr<TransactionalDirectory> mDirectory;

  QString mFilename;

  QScopedPointer<StrokeFontPool> mStrokeFontPool;

  Uuid mUuid;

  ElementName mName;

  QString mAuthor;

  FileProofName mVersion;

  QDateTime mCreated;

  QDateTime mDateTime;

  AttributeList mAttributes;

  QStringList mLocaleOrder;

  QStringList mNormOrder;

  QStringList mCustomBomAttributes;

  bool mDefaultLockComponentAssembly;

  OutputJobList mOutputJobs;

  QScopedPointer<ProjectLibrary> mProjectLibrary;

  QScopedPointer<Circuit> mCircuit;

  QList<Schematic*> mSchematics;

  QList<Schematic*> mRemovedSchematics;

  QList<Board*> mBoards;

  QList<Board*> mRemovedBoards;

  QSet<SExpression> mErcMessageApprovals;

  // Cached properties
  QPointer<Board> mPrimaryBoard;
};

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

}  // namespace librepcb

#endif