projecteditor.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_PROJECTEDITOR_H
#define LIBREPCB_EDITOR_PROJECTEDITOR_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../utils/uiobjectlist.h"
#include "appwindow.h"
 
#include <librepcb/core/serialization/fileformatmigration.h>
#include <librepcb/core/serialization/sexpression.h>
#include <librepcb/core/utils/signalslot.h>
 
#include <QtCore>
 
#include <memory>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class Board;
class NetSignal;
class Project;
class Workspace;
 
namespace editor {
 
class BoardEditor;
class GuiApplication;
class RuleCheckMessagesModel;
class SchematicEditor;
class SchematicTab;
class UndoStack;
 
/*******************************************************************************
 *  Class ProjectEditor
 ******************************************************************************/
 
class ProjectEditor final : public QObject {
  Q_OBJECT
 
public:
  // Signals
  Signal<ProjectEditor> onUiDataChanged;
 
  // Constructors / Destructor
  ProjectEditor() = delete;
  ProjectEditor(const ProjectEditor& other) = delete;
  explicit ProjectEditor(
      GuiApplication& app, std::unique_ptr<Project> project, int uiIndex,
      const std::optional<QList<FileFormatMigration::Message>>& upgradeMessages,
      QObject* parent = nullptr) noexcept;
  ~ProjectEditor() noexcept;
 
  // General Methods
  GuiApplication& getApp() noexcept { return mApp; }
  Workspace& getWorkspace() noexcept { return mWorkspace; }
  Project& getProject() noexcept { return *mProject; }
  UndoStack& getUndoStack() noexcept { return *mUndoStack; }
  const QVector<std::shared_ptr<SchematicEditor>>& getSchematics() noexcept {
    return mSchematics->values();
  }
  const QVector<std::shared_ptr<BoardEditor>>& getBoards() noexcept {
    return mBoards->values();
  }
  int getUiIndex() const noexcept { return mUiIndex; }
  void setUiIndex(int index) noexcept;
  ui::ProjectData getUiData() const noexcept;
  void setUiData(const ui::ProjectData& data) noexcept;
  void trigger(ui::ProjectAction a) noexcept;
  bool getUseIeee315Symbols() const noexcept { return mUseIeee315Symbols; }
  std::shared_ptr<const QSet<const NetSignal*>> getHighlightedNetSignals()
      const noexcept {
    return mHighlightedNetSignals;
  }
  void setHighlightedNetSignals(
      const QSet<const NetSignal*>& netSignals) noexcept;
 
  bool hasUnsavedChanges() const noexcept;
 
  void undo() noexcept;
  void redo() noexcept;
 
  bool requestClose() noexcept;
 
  bool saveProject() noexcept;
 
  bool autosaveProject() noexcept;
 
  void setManualModificationsMade() noexcept;
 
  void execSetupDialog() noexcept;
 
  void execOutputJobsDialog(const QString& typeName = QString()) noexcept;
 
  void execBomGeneratorDialog(const Board* board) noexcept;
 
  void execLppzExportDialog(QWidget* parent) noexcept;
 
  std::shared_ptr<SchematicEditor> execNewSheetDialog() noexcept;
  void execRenameSheetDialog(int index) noexcept;
  void execDeleteSheetDialog(int index) noexcept;
 
  std::shared_ptr<BoardEditor> execNewBoardDialog(
      std::optional<int> copyFromIndex) noexcept;
  void execDeleteBoardDialog(int index) noexcept;
 
  void registerActiveSchematicTab(SchematicTab* tab) noexcept;
  void unregisterActiveSchematicTab(SchematicTab* tab) noexcept;
 
  // Operator Overloadings
  ProjectEditor& operator=(const ProjectEditor& rhs) = delete;
 
signals:
  void uiIndexChanged();
  void manualModificationsMade();
  void projectAboutToBeSaved();
  void projectSavedToDisk();
  void ercUnapprovedCountChanged();
  void highlightedNetSignalsChanged();
  void projectLibraryUpdaterRequested(const FilePath& fp);
  void statusBarMessageChanged(const QString& message, int timeoutMs);
 
  void abortBlockingToolsInOtherEditors(const void* source);
 
private:
  void showUpgradeMessages() noexcept;
  void scheduleErcRun() noexcept;
  void runErc() noexcept;
  void projectSettingsChanged() noexcept;
 
private:
  GuiApplication& mApp;
  Workspace& mWorkspace;
  std::unique_ptr<Project> mProject;
  int mUiIndex;
  bool mUseIeee315Symbols;
  QList<FileFormatMigration::Message> mUpgradeMessages;
  std::shared_ptr<UiObjectList<SchematicEditor, ui::SchematicData>> mSchematics;
  std::shared_ptr<UiObjectList<BoardEditor, ui::BoardData>> mBoards;
  std::unique_ptr<UndoStack> mUndoStack;
 
  std::shared_ptr<QSet<const NetSignal*>> mHighlightedNetSignals;
  QVector<QPointer<SchematicTab>> mActiveSchematicTabs;
 
  // ERC
  std::shared_ptr<RuleCheckMessagesModel> mErcMessages;  // Lazy initialized
  QSet<SExpression> mSupportedErcApprovals;
  QSet<SExpression> mDisappearedErcApprovals;
  QString mErcExecutionError;
  QTimer mErcTimer;
 
  bool mManualModificationsMade;
 
  uint mLastAutosaveStateId;
 
  QTimer mAutoSaveTimer;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif