mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 10:13:19 +02:00
80 lines
2.3 KiB
C
80 lines
2.3 KiB
C
|
/*
|
||
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
||
|
|
*
|
||
|
|
* Copyright (C) 2020 CERN
|
||
|
|
* @author Jon Evans <jon@craftyjon.com>
|
||
|
|
*
|
||
|
|
* 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>
|
||
|
|
#include <settings/json_settings.h>
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* For files like sheets and boards, a pair of that object KIID and display name
|
||
|
|
* Display name is typically blank for the project root sheet
|
||
|
|
*/
|
||
|
|
typedef std::pair<KIID, wxString> FILE_INFO_PAIR;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* PROJECT_FILE is the backing store for a PROJECT, in JSON format.
|
||
|
|
*
|
||
|
|
* There is either zero or one PROJECT_FILE for every PROJECT
|
||
|
|
* (you can have a dummy PROJECT that has no file)
|
||
|
|
*/
|
||
|
|
class PROJECT_FILE : public JSON_SETTINGS
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Constructs the project file for a project
|
||
|
|
* @param aFullPath is the full disk path to the project
|
||
|
|
*/
|
||
|
|
PROJECT_FILE( const std::string& aFullPath );
|
||
|
|
|
||
|
|
virtual ~PROJECT_FILE() {}
|
||
|
|
|
||
|
|
virtual bool MigrateFromLegacy( wxConfigBase* aLegacyFile ) override;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
wxString getLegacyFileExt() const override;
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
/// An list of schematic sheets in this project
|
||
|
|
std::vector<FILE_INFO_PAIR> m_sheets;
|
||
|
|
|
||
|
|
/// A list of board files in this project
|
||
|
|
std::vector<FILE_INFO_PAIR> m_boards;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stores all K/V pairs migrated from a legacy (.pro) file so that the legacy file can be
|
||
|
|
* removed before these settings are migrated in by PROJECT_SETTINGS objects later.
|
||
|
|
*/
|
||
|
|
std::map<std::string, wxString> m_legacyVars;
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
// 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 );
|
||
|
|
|
||
|
|
#endif
|