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_PROJECT_PROJECT_H
#define LIBREPCB_PROJECT_PROJECT_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/common/attributes/attribute.h>
#include <librepcb/common/attributes/attributeprovider.h>
#include <librepcb/common/elementname.h>
#include <librepcb/common/exceptions.h>
#include <librepcb/common/fileio/directorylock.h>
#include <librepcb/common/uuid.h>
#include <librepcb/common/version.h>

#include <QtCore>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
class QPrinter;

namespace librepcb {

class SmartTextFile;
class SmartSExprFile;
class SmartVersionFile;
class StrokeFontPool;

namespace project {

class ProjectMetadata;
class ProjectSettings;
class ProjectLibrary;
class Circuit;
class Schematic;
class SchematicLayerProvider;
class ErcMsgList;
class Board;

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

class Project final : public QObject, public AttributeProvider {
  Q_OBJECT

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

  Project(const FilePath& filepath, bool readOnly, bool interactve)
    : Project(filepath, false, readOnly, interactve) {}

  ~Project() noexcept;

  // Getters: General

  const FilePath& getFilepath() const noexcept { return mFilepath; }

  const FilePath& getPath() const noexcept { return mPath; }

  bool isReadOnly() const noexcept { return mIsReadOnly; }

  bool isRestored() const noexcept { return mIsRestored; }

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

  ProjectMetadata& getMetadata() const noexcept { return *mProjectMetadata; }

  ProjectSettings& getSettings() const noexcept { return *mProjectSettings; }

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

  ErcMsgList& getErcMsgList() const noexcept { return *mErcMsgList; }

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

  // Schematic Methods

  SchematicLayerProvider& getLayers() noexcept {
    return *mSchematicLayerProvider;
  }
  const SchematicLayerProvider& getLayers() const noexcept {
    return *mSchematicLayerProvider;
  }

  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;

  Schematic* createSchematic(const ElementName& name);

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

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

  void exportSchematicsAsPdf(const FilePath& filepath);

  void printSchematicPages(QPrinter& printer, QList<int>& pages);

  // 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;

  Board* createBoard(const ElementName& name);

  Board* createBoard(const Board& other, const ElementName& name);

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

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

  // General Methods

  void save(bool toOriginal);

  // Inherited from AttributeProvider
  QString getUserDefinedAttributeValue(const QString& key) const
      noexcept override;
  QString getBuiltInAttributeValue(const QString& key) const noexcept override;

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

  // Static Methods

  static Project* create(const FilePath& filepath) {
    return new Project(filepath, true, false, false);
  }

  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() override;

  void schematicAdded(int newIndex);

  void schematicRemoved(int oldIndex);

  void boardAdded(int newIndex);

  void boardRemoved(int oldIndex);

private:
  // Private Methods

  explicit Project(const FilePath& filepath, bool create, bool readOnly,
                   bool interactve);

  bool save(bool toOriginal, QStringList& errors) noexcept;

  // Project File (*.lpp)
  FilePath mPath;      
  FilePath mFilepath;  
  QScopedPointer<SmartVersionFile>
                                mVersionFile;  
  QScopedPointer<SmartTextFile> mProjectFile;  
  DirectoryLock mLock;  
  bool mIsRestored;  
  bool mIsReadOnly;  

  // schematic and board list files
  QScopedPointer<SmartSExprFile> mSchematicsFile;  
  QScopedPointer<SmartSExprFile> mBoardsFile;      

  // General
  QScopedPointer<StrokeFontPool>
      mStrokeFontPool;  
  QScopedPointer<ProjectMetadata>
      mProjectMetadata;  
  QScopedPointer<ProjectSettings>
      mProjectSettings;  
  QScopedPointer<ProjectLibrary>
      mProjectLibrary;  
  QScopedPointer<ErcMsgList>
      mErcMsgList;  
  QScopedPointer<Circuit>
      mCircuit;  
  QList<Schematic*> mSchematics;  
  QList<Schematic*>
      mRemovedSchematics;  
  QScopedPointer<SchematicLayerProvider>
                mSchematicLayerProvider;  
  QList<Board*> mBoards;                  
  QList<Board*> mRemovedBoards;  
  QScopedPointer<AttributeList>
      mAttributes;  
};

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

}  // namespace project
}  // namespace librepcb

#endif  // LIBREPCB_PROJECT_PROJECT_H