KiCad PCB EDA Suite
Loading...
Searching...
No Matches
project_file.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2020 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Jon Evans <[email protected]>
7 *
8 * This program is free software: you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef KICAD_PROJECT_FILE_H
23#define KICAD_PROJECT_FILE_H
24
25#include <common.h> // needed for wxstring hash template
26#include <kiid.h>
30
32class ERC_SETTINGS;
33class NET_SETTINGS;
38class TEMPLATES;
39
44typedef std::pair<KIID, wxString> FILE_INFO_PAIR;
45
60
68{
69public:
74 PROJECT_FILE( const wxString& aFullPath );
75
76 virtual ~PROJECT_FILE() = default;
77
78 virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
79
80 bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
81
82 bool SaveAs( const wxString& aDirectory, const wxString& aFile );
83
84 void SetProject( PROJECT* aProject )
85 {
86 m_project = aProject;
87 }
88
89 std::vector<FILE_INFO_PAIR>& GetSheets()
90 {
91 return m_sheets;
92 }
93
94 std::vector<FILE_INFO_PAIR>& GetBoards()
95 {
96 return m_boards;
97 }
98
99 std::shared_ptr<NET_SETTINGS>& NetSettings()
100 {
101 return m_NetSettings;
102 }
103
104 std::shared_ptr<COMPONENT_CLASS_SETTINGS>& ComponentClassSettings()
105 {
107 }
108
109 std::shared_ptr<TIME_DOMAIN_PARAMETERS>& TimeDomainParameters()
110 {
112 }
113
117 bool ShouldAutoSave() const { return !m_wasMigrated && !m_isFutureFormat; }
118
119protected:
120 wxString getFileExt() const override;
121
122 wxString getLegacyFileExt() const override;
123
127public:
131
133 std::vector<wxString> m_PinnedSymbolLibs;
134
136 std::vector<wxString> m_PinnedFootprintLibs;
137
139 std::vector<wxString> m_PinnedDesignBlockLibs;
140
141 std::map<wxString, wxString> m_TextVars;
142
146
147 // Schematic ERC settings: lifecycle managed by SCHEMATIC
149
150 // Schematic editing and misc settings: lifecycle managed by SCHEMATIC
152
153 // Legacy parameters LibDir and LibName, for importing old projects
155
156 wxArrayString m_LegacyLibNames;
157
161
163 std::vector<wxString> m_EquivalenceFiles;
164
168
171
174
181
189 std::shared_ptr<NET_SETTINGS> m_NetSettings;
190
191
192
196 std::shared_ptr<COMPONENT_CLASS_SETTINGS> m_ComponentClassSettings;
197
201 std::shared_ptr<TIME_DOMAIN_PARAMETERS> m_timeDomainParameters;
202
203 std::vector<LAYER_PRESET> m_LayerPresets;
204 std::vector<VIEWPORT> m_Viewports;
205 std::vector<VIEWPORT3D> m_Viewports3D;
206 std::vector<LAYER_PAIR_INFO> m_LayerPairInfos;
207
209
210private:
216 bool migrateSchema1To2();
217
221 bool migrateSchema2To3();
222
224 std::vector<FILE_INFO_PAIR> m_sheets;
225
227 std::vector<FILE_INFO_PAIR> m_boards;
228
231
233};
234
235// Specializations to allow directly reading/writing FILE_INFO_PAIRs from JSON
236
237void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair );
238
239void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair );
240
241#endif
Container for design settings for a BOARD object.
COMPONENT_CLASS_SETTINGS stores data for component classes, including rules for automatic generation ...
Container for ERC settings.
virtual wxString getFileExt() const
bool m_isFutureFormat
Set to true if this settings is loaded from a file with a newer schema version than is known.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
Calls Store() and then writes the contents of the JSON document to a file.
virtual wxString getLegacyFileExt() const
Management class for layer pairs in a PCB.
Definition layer_pairs.h:47
NET_SETTINGS stores various net-related settings in a project context.
std::map< wxString, wxString > m_TextVars
std::vector< LAYER_PAIR_INFO > m_LayerPairInfos
List of stored 3D viewports (view matrixes)
ERC_SETTINGS * m_ErcSettings
Eeschema params.
wxString m_LegacyLibDir
std::vector< FILE_INFO_PAIR > & GetSheets()
SCHEMATIC_SETTINGS * m_SchematicSettings
std::vector< FILE_INFO_PAIR > & GetBoards()
bool migrateSchema1To2()
IPC-2581 BOM settings.
std::shared_ptr< NET_SETTINGS > & NetSettings()
wxString m_BoardDrawingSheetFile
PcbNew params.
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
struct IP2581_BOM m_IP2581Bom
Layer pair list for the board.
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
PROJECT * m_project
A link to the owning PROJECT.
std::shared_ptr< TIME_DOMAIN_PARAMETERS > m_timeDomainParameters
Time domain parameters for this project.
std::vector< VIEWPORT > m_Viewports
List of stored layer presets.
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
std::vector< wxString > m_PinnedDesignBlockLibs
The list of pinned design block libraries.
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
bool migrateSchema2To3()
Schema version 3: move layer presets to use named render layers.
std::shared_ptr< COMPONENT_CLASS_SETTINGS > & ComponentClassSettings()
bool ShouldAutoSave() const
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
void SetProject(PROJECT *aProject)
virtual ~PROJECT_FILE()=default
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
std::vector< LAYER_PRESET > m_LayerPresets
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
wxArrayString m_LegacyLibNames
std::shared_ptr< TIME_DOMAIN_PARAMETERS > & TimeDomainParameters()
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
std::vector< VIEWPORT3D > m_Viewports3D
List of stored viewports (pos + zoom)
PROJECT_FILE(const wxString &aFullPath)
Construct the project file for a project.
std::shared_ptr< COMPONENT_CLASS_SETTINGS > m_ComponentClassSettings
Component class settings for the project (owned here)
Container for project specific data.
Definition project.h:65
These are loaded from Eeschema settings but then overwritten by the project settings.
TIME_DOMAIN_PARAMETERS stores the configuration for time-domain tuning.
The common library.
#define KICOMMON_API
Definition kicommon.h:28
void to_json(nlohmann::json &aJson, const FILE_INFO_PAIR &aPair)
void from_json(const nlohmann::json &aJson, FILE_INFO_PAIR &aPair)
LAST_PATH_TYPE
For storing PcbNew MRU paths of various types.
@ LAST_PATH_PLOT
@ LAST_PATH_SPECCTRADSN
@ LAST_PATH_SIZE
@ LAST_PATH_FIRST
@ LAST_PATH_IDF
@ LAST_PATH_VRML
@ LAST_PATH_NETLIST
std::pair< KIID, wxString > FILE_INFO_PAIR
For files like sheets and boards, a pair of that object KIID and display name Display name is typical...