LibrePCB

/*
 * 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_FILEFORMATMIGRATIONV01_H
#define LIBREPCB_CORE_FILEFORMATMIGRATIONV01_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../types/alignment.h"
#include "../types/angle.h"
#include "../types/point.h"
#include "../types/uuid.h"
#include "fileformatmigration.h"

#include <QtCore>

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

class SExpression;

/*******************************************************************************
 *  Class FileFormatMigrationV01
 ******************************************************************************/

/**
 * @brief Migration to upgrade file format v0.1
 */
class FileFormatMigrationV01 : public FileFormatMigration {
  Q_OBJECT

protected:
  struct Text {
    Uuid uuid;
    QString layerName;
    QString text;
    Point position;
    Angle rotation;
    PositiveLength height;
    Alignment align;
  };

  struct Symbol {
    QList<Text> texts;
  };

  struct Gate {
    Uuid uuid;
    Uuid symbolUuid;
  };

  struct ComponentSymbolVariant {
    Uuid uuid;
    QList<Gate> gates;
  };

  struct Component {
    bool schematicOnly;
    QList<ComponentSymbolVariant> symbolVariants;
  };

  struct ComponentInstance {
    Uuid libCmpUuid;
    Uuid libSymbVarUuid;
  };

  struct ProjectContext {
    // Project library.
    QHash<Uuid, Symbol> symbols;
    QHash<Uuid, Component> components;
    QMap<Uuid, ComponentInstance> componentInstances;
    QMap<Uuid, QSet<Uuid>> devicesUsedInBoards;

    // Project.
    QString projectUuid;

    // Counters for emitting messages.
    int removedErcApprovals = 0;
    int holesCount = 0;
    int nonRoundViaCount = 0;
    int planeCount = 0;
    int planeConnectNoneCount = 0;
    int footprintBoardOutlinesObjectCount = 0;
    int topLevelBoardOutlinesObjectCount = 0;
    int componentsWithAssemblyOptions = 0;
  };

public:
  // Constructors / Destructor
  explicit FileFormatMigrationV01(QObject* parent = nullptr) noexcept;
  FileFormatMigrationV01(const FileFormatMigrationV01& other) = delete;
  ~FileFormatMigrationV01() noexcept override;

  // General Methods
  void upgradeComponentCategory(TransactionalDirectory& dir) override;
  void upgradePackageCategory(TransactionalDirectory& dir) override;
  void upgradeSymbol(TransactionalDirectory& dir) override;
  void upgradePackage(TransactionalDirectory& dir) override;
  void upgradeComponent(TransactionalDirectory& dir) override;
  void upgradeDevice(TransactionalDirectory& dir) override;
  void upgradeOrganization(TransactionalDirectory& dir) override;
  void upgradeLibrary(TransactionalDirectory& dir) override;
  void upgradeProject(TransactionalDirectory& dir,
                      QList<Message>& messages) override;
  void upgradeWorkspaceData(TransactionalDirectory& dir) override;

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

protected:  // Methods
  virtual void createOutputJobs(TransactionalDirectory& dir);
  virtual void upgradeMetadata(SExpression& root);
  virtual void upgradeSettings(SExpression& root);
  virtual void upgradeCircuit(SExpression& root, ProjectContext& context);
  virtual void upgradeErc(SExpression& root, ProjectContext& context);
  virtual void upgradeSchematic(SExpression& root, ProjectContext& context);
  virtual void upgradeBoard(SExpression& root, ProjectContext& context);
  virtual void upgradeBoardUserSettings(SExpression& root);
  virtual void upgradeBoardDesignRules(SExpression& root);
  virtual void upgradeBoardDrcSettings(SExpression& root);
  virtual void upgradeGrid(SExpression& node);
  virtual void upgradeCutouts(SExpression& node, ProjectContext* context);
  virtual void upgradeHoles(SExpression& node, bool isBoardHole);
  virtual void upgradeLayers(SExpression& node);
  virtual void upgradeInversionCharacters(SExpression& root,
                                          const QString& childName,
                                          const QString& valuePath);
  virtual void upgradeStrings(SExpression& root);
  virtual void replaceStrings(SExpression& root,
                              const QMap<QString, QString>& replacements);
  static QString toFileProofName(const QString& name,
                                 const QString& fallback) noexcept;
};

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

}  // namespace librepcb

#endif