project_file.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Jon Evans <[email protected]>
 *
 * 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 KICAD_PROJECT_FILE_H
#define KICAD_PROJECT_FILE_H
 
#include <common.h> // needed for wxstring hash template
#include <kiid.h>
#include <project/board_project_settings.h>
#include <settings/json_settings.h>
#include <settings/nested_settings.h>
 
class BOARD_DESIGN_SETTINGS;
class ERC_SETTINGS;
class NET_SETTINGS;
class COMPONENT_CLASS_SETTINGS;
class TUNING_PROFILES;
class LAYER_PAIR_SETTINGS;
class SCHEMATIC_SETTINGS;
class TEMPLATES;

typedef std::pair<KIID, wxString> FILE_INFO_PAIR;

struct TOP_LEVEL_SHEET_INFO
{
    KIID     uuid;          
    wxString name;          
    wxString filename;      
 
    TOP_LEVEL_SHEET_INFO() = default;
 
    TOP_LEVEL_SHEET_INFO( const KIID& aUuid, const wxString& aName, const wxString& aFilename )
        : uuid( aUuid ), name( aName ), filename( aFilename )
    {}
 
    bool operator==( const TOP_LEVEL_SHEET_INFO& aOther ) const
    {
        return uuid == aOther.uuid && name == aOther.name && filename == aOther.filename;
    }
 
    bool operator!=( const TOP_LEVEL_SHEET_INFO& aOther ) const
    {
        return !( *this == aOther );
    }
};

enum LAST_PATH_TYPE : unsigned int
{
    LAST_PATH_FIRST = 0,
    LAST_PATH_NETLIST = LAST_PATH_FIRST,
    LAST_PATH_IDF,
    LAST_PATH_VRML,
    LAST_PATH_SPECCTRADSN,
    LAST_PATH_PLOT,
 
    LAST_PATH_SIZE
};

class KICOMMON_API PROJECT_FILE : public JSON_SETTINGS
{
public:
    PROJECT_FILE( const wxString& aFullPath );
 
    virtual ~PROJECT_FILE() = default;
 
    virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
 
    bool LoadFromFile( const wxString& aDirectory = "" ) override;
 
    bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
 
    bool SaveAs( const wxString& aDirectory, const wxString& aFile );
 
    void SetProject( PROJECT* aProject )
    {
        m_project = aProject;
    }
 
    std::vector<FILE_INFO_PAIR>& GetSheets()
    {
        return m_sheets;
    }
 
    std::vector<FILE_INFO_PAIR>& GetBoards()
    {
        return m_boards;
    }
 
    std::vector<TOP_LEVEL_SHEET_INFO>& GetTopLevelSheets()
    {
        return m_topLevelSheets;
    }
 
    const std::vector<TOP_LEVEL_SHEET_INFO>& GetTopLevelSheets() const
    {
        return m_topLevelSheets;
    }
 
    std::shared_ptr<NET_SETTINGS>& NetSettings()
    {
        return m_NetSettings;
    }
 
    std::shared_ptr<COMPONENT_CLASS_SETTINGS>& ComponentClassSettings()
    {
        return m_ComponentClassSettings;
    }
 
    std::shared_ptr<TUNING_PROFILES>& TuningProfileParameters() { return m_tuningProfileParameters; }

    bool ShouldAutoSave() const { return !m_wasMigrated && !m_isFutureFormat; }
 
protected:
    wxString getFileExt() const override;
 
    wxString getLegacyFileExt() const override;

public:

    std::vector<wxString> m_PinnedSymbolLibs;

    std::vector<wxString> m_PinnedFootprintLibs;

    std::vector<wxString> m_PinnedDesignBlockLibs;
 
    std::map<wxString, wxString> m_TextVars;

 
    // Schematic ERC settings: lifecycle managed by SCHEMATIC
    ERC_SETTINGS* m_ErcSettings;
 
    // Schematic editing and misc settings: lifecycle managed by SCHEMATIC
    SCHEMATIC_SETTINGS* m_SchematicSettings;
 
    // Legacy parameters LibDir and LibName, for importing old projects
    wxString m_LegacyLibDir;
 
    wxArrayString m_LegacyLibNames;

    std::map<wxString, std::vector<wxString>> m_BusAliases;


    std::vector<wxString> m_EquivalenceFiles;


    wxString m_BoardDrawingSheetFile;

    wxString m_PcbLastPath[LAST_PATH_SIZE];

    BOARD_DESIGN_SETTINGS* m_BoardSettings;

    std::shared_ptr<NET_SETTINGS> m_NetSettings;
 
 

    std::shared_ptr<COMPONENT_CLASS_SETTINGS> m_ComponentClassSettings;

    std::shared_ptr<TUNING_PROFILES> m_tuningProfileParameters;
 
    std::vector<LAYER_PRESET>     m_LayerPresets;   
    std::vector<VIEWPORT>         m_Viewports;      
    std::vector<VIEWPORT3D>       m_Viewports3D;    
    std::vector<LAYER_PAIR_INFO>  m_LayerPairInfos; 
 
    struct IP2581_BOM             m_IP2581Bom;      
 
private:
    bool migrateSchema1To2();

    bool migrateSchema2To3();

    std::vector<FILE_INFO_PAIR> m_sheets;

    std::vector<TOP_LEVEL_SHEET_INFO> m_topLevelSheets;

    std::vector<FILE_INFO_PAIR> m_boards;

    PROJECT* m_project;
 
    bool m_wasMigrated;
};
 
// Specializations to allow directly reading/writing FILE_INFO_PAIRs from JSON
 
void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair );
 
void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair );
 
// Specializations to allow directly reading/writing TOP_LEVEL_SHEET_INFO from JSON
 
void to_json( nlohmann::json& aJson, const TOP_LEVEL_SHEET_INFO& aInfo );
 
void from_json( const nlohmann::json& aJson, TOP_LEVEL_SHEET_INFO& aInfo );
 
#endif