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 <librepcb/core/library/resource.h>
#include <librepcb/core/project/circuit/netsignal.h>
#include <librepcb/core/rulecheck/rulecheckmessage.h>
#include <librepcb/core/serialization/fileformatmigration.h>
 
#include <QtCore>
#include <QtWidgets>
 
#include <memory>
#include <optional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
 
class QMainWindow;
 
namespace librepcb {
 
class Board;
class ComponentInstance;
class FilePath;
class LengthUnit;
class Project;
class Workspace;
 
namespace editor {
 
class BoardEditor;
class MenuBuilder;
class SchematicEditor;
class UndoStack;
 
/*******************************************************************************
 *  Class ProjectEditor
 ******************************************************************************/
 
class ProjectEditor final : public QObject {
  Q_OBJECT
 
public:
  // Constructors / Destructor
  ProjectEditor() = delete;
  ProjectEditor(const Project& other) = delete;
 
  ProjectEditor(Workspace& workspace, Project& project,
                const std::optional<QList<FileFormatMigration::Message>>&
                    upgradeMessages);
 
  ~ProjectEditor() noexcept;
 
  // Getters: General
 
  Workspace& getWorkspace() const noexcept { return mWorkspace; }
  Project& getProject() const noexcept { return mProject; }
  const QString& getUpgradeMessageLabelText() const noexcept {
    return mUpgradeMessageLabelText;
  }
  const LengthUnit& getDefaultLengthUnit() const noexcept;
 
  UndoStack& getUndoStack() const noexcept { return *mUndoStack; }
 
  ResourceList getComponentResources(
      const ComponentInstance& cmp,
      const std::optional<Uuid>& filterDev = std::nullopt) const noexcept;
 
  // General Methods
 
  void addResourcesToMenu(MenuBuilder& mb, const ComponentInstance& cmp,
                          const std::optional<Uuid>& filterDev,
                          QPointer<QWidget> editor, QMenu* root) const noexcept;
 
  void abortBlockingToolsInOtherEditors(QWidget* editor) noexcept;
 
  bool windowIsAboutToClose(QMainWindow& window) noexcept;
 
  // Operator Overloadings
  ProjectEditor& operator=(const Project& rhs) = delete;
 
public slots:
 
  void showUpgradeMessages(QWidget* parent) noexcept;
 
  void showAllRequiredEditors() noexcept;
 
  void showSchematicEditor() noexcept;
 
  void showBoardEditor() noexcept;
 
  void execLppzExportDialog(QWidget* parent = nullptr) noexcept;
 
  void execOrderPcbDialog(QWidget* parent = nullptr) noexcept;
 
  bool saveProject() noexcept;
 
  bool autosaveProject() noexcept;
 
  bool closeAndDestroy(bool askForSave, QWidget* msgBoxParent = 0) noexcept;
 
  void setManualModificationsMade() noexcept {
    mManualModificationsMade = true;
  }
 
  void setErcMessageApproved(const RuleCheckMessage& msg,
                             bool approve) noexcept;
 
  std::shared_ptr<const QSet<const NetSignal*>> getHighlightedNetSignals()
      const noexcept {
    return mHighlightedNetSignals;
  }
  void setHighlightedNetSignals(
      const QSet<const NetSignal*>& netSignals) noexcept;
  void clearHighlightedNetSignals() noexcept;
 
signals:
  void ercFinished(const RuleCheckMessageList& messages);
  void highlightedNetSignalsChanged();
  void projectAboutToBeSaved();
  void projectSavedToDisk();
  void showControlPanelClicked();
  void openProjectLibraryUpdaterClicked(const FilePath& fp);
  void projectEditorClosed();
  void showTemporaryStatusBarMessage(const QString& message, int timeoutMs);
 
private:  // Methods
  void runErc() noexcept;
  void saveErcMessageApprovals(const QSet<SExpression>& approvals) noexcept;
  int getCountOfVisibleEditorWindows() const noexcept;
  void searchAndOpenDatasheet(const QString& mpn, const QString& manufacturer,
                              QPointer<QWidget> parent) const noexcept;
 
private:  // Data
  Workspace& mWorkspace;
  Project& mProject;
  QList<FileFormatMigration::Message> mUpgradeMessages;
  QString mUpgradeMessageLabelText;
 
  QTimer mAutoSaveTimer;
 
  QSet<SExpression> mSupportedErcApprovals;
  QSet<SExpression> mDisappearedErcApprovals;
  RuleCheckMessageList mErcMessages;
 
  std::shared_ptr<QSet<const NetSignal*>> mHighlightedNetSignals;
 
  UndoStack* mUndoStack;  
  SchematicEditor* mSchematicEditor;  
  BoardEditor* mBoardEditor;  
 
  uint mLastAutosaveStateId;
 
  bool mManualModificationsMade;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif