workspace.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_WORKSPACE_H
#define LIBREPCB_CORE_WORKSPACE_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../fileio/directorylock.h"
#include "../types/version.h"

#include <QtCore>

#include <memory>

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

class Library;
class Project;
class TransactionalFileSystem;
class WorkspaceLibraryDb;
class WorkspaceSettings;

/*******************************************************************************
 *  Class Workspace
 ******************************************************************************/

class Workspace final : public QObject {
  Q_OBJECT

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

  explicit Workspace(const FilePath& wsPath, const QString& dataDirName,
                     DirectoryLock::LockHandlerCallback lockCallback = nullptr);

  ~Workspace() noexcept;

  // Getters

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

  const FilePath& getProjectsPath() const { return mProjectsPath; }

  const FilePath& getDataPath() const { return mDataPath; }

  const FilePath& getLibrariesPath() const { return mLibrariesPath; }

  FilePath getLocalLibrariesPath() const {
    return mLibrariesPath.getPathTo("local");
  }

  FilePath getRemoteLibrariesPath() const {
    return mLibrariesPath.getPathTo("remote");
  }

  WorkspaceSettings& getSettings() { return *mWorkspaceSettings; }

  const WorkspaceSettings& getSettings() const { return *mWorkspaceSettings; }

  WorkspaceLibraryDb& getLibraryDb() const { return *mLibraryDb; }

  // General Methods

  void saveSettings();

  // Operator Overloadings
  Workspace& operator=(const Workspace& rhs) = delete;

  // Static Methods

  static bool checkCompatibility(const FilePath& wsRoot,
                                 QString* errorMsg = nullptr);

  static QMap<QString, Version> findDataDirectories(const FilePath& wsRoot);

  static QString determineDataDirectory(const QMap<QString, Version>& dataDirs,
                                        QString& copyFromDir,
                                        QString& copyToDir) noexcept;

  static void createNewWorkspace(const FilePath& path);

  static FilePath getMostRecentlyUsedWorkspacePath() noexcept;

  static void setMostRecentlyUsedWorkspacePath(const FilePath& path) noexcept;

  static Version FILE_FORMAT_VERSION() noexcept {
    return Version::fromString("0.1");
  }

private:  // Methods
  void saveSettingsToTransactionalFileSystem();

private:  // Data
  FilePath mPath;

  FilePath mProjectsPath;

  FilePath mDataPath;

  FilePath mLibrariesPath;

  std::shared_ptr<TransactionalFileSystem> mFileSystem;

  QScopedPointer<WorkspaceSettings> mWorkspaceSettings;

  QScopedPointer<WorkspaceLibraryDb> mLibraryDb;
};

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

}  // namespace librepcb

#endif