workspacesettings.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_WORKSPACESETTINGS_H
#define LIBREPCB_CORE_WORKSPACESETTINGS_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../exceptions.h"
#include "../types/lengthunit.h"
#include "workspacesettingsitem_genericvalue.h"
#include "workspacesettingsitem_genericvaluelist.h"
#include "workspacesettingsitem_keyboardshortcuts.h"
#include "workspacesettingsitem_themes.h"
 
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class SExpression;
class Version;
 
/*******************************************************************************
 *  Class WorkspaceSettings
 ******************************************************************************/
 
class WorkspaceSettings final : public QObject {
  Q_OBJECT
 
public:
  // Types
  struct ApiEndpoint {
    QUrl url;
    bool useForLibraries = false;  
    bool useForPartsInfo = false;  
    bool useForOrder = false;  
 
    bool operator==(const ApiEndpoint& rhs) const noexcept = default;
  };
 
  // Constructors / Destructor
  WorkspaceSettings(const WorkspaceSettings& other) = delete;
  explicit WorkspaceSettings(QObject* parent = nullptr);
  ~WorkspaceSettings() noexcept;
 
  void load(const SExpression& node, const Version& fileFormat);
 
  void restoreDefaults() noexcept;
 
  std::unique_ptr<SExpression> serialize();
 
  std::optional<ApiEndpoint> getApiEndpointForPartsInfo() const noexcept;
 
  std::optional<ApiEndpoint> getApiEndpointForOrder() const noexcept;
 
  // Operator Overloadings
  WorkspaceSettings& operator=(const WorkspaceSettings& rhs) = delete;
 
private:  // Methods
  QList<WorkspaceSettingsItem*> getAllItems() const noexcept;
 
private:  // Data
  QMap<QString, SExpression> mFileContent;
 
  bool mUpgradeRequired;
 
public:
  // All settings item objects below. The order is not relevant for saving,
  // it should be ordered logically.
  //
  // Note: Generally we don't make member variables public, but in this case
  //       it would create a lot of boilerplate to wrap all objects with
  //       both const- and non-const methods, and it's totally safe to access
  //       them directly.
 
  WorkspaceSettingsItem_GenericValue<QString> userName;
 
  WorkspaceSettingsItem_GenericValue<QString> applicationLocale;
 
  WorkspaceSettingsItem_GenericValue<LengthUnit> defaultLengthUnit;
 
  WorkspaceSettingsItem_GenericValue<uint> projectAutosaveIntervalSeconds;
 
  WorkspaceSettingsItem_GenericValue<bool> useOpenGl;
 
  WorkspaceSettingsItem_GenericValueList<QStringList> libraryLocaleOrder;
 
  WorkspaceSettingsItem_GenericValueList<QStringList> libraryNormOrder;
 
  WorkspaceSettingsItem_GenericValueList<QList<ApiEndpoint>, true> apiEndpoints;
 
  WorkspaceSettingsItem_GenericValue<bool> autofetchLivePartInformation;
 
  WorkspaceSettingsItem_GenericValueList<QStringList>
      externalWebBrowserCommands;
 
  WorkspaceSettingsItem_GenericValueList<QStringList>
      externalFileManagerCommands;
 
  WorkspaceSettingsItem_GenericValueList<QStringList> externalPdfReaderCommands;
 
  WorkspaceSettingsItem_KeyboardShortcuts keyboardShortcuts;
 
  WorkspaceSettingsItem_Themes themes;
 
  WorkspaceSettingsItem_GenericValueList<QSet<QString>> dismissedMessages;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif