KiCad PCB EDA Suite
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
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 <jon@craftyjon.com>
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;
37class TEMPLATES;
38
43typedef std::pair<KIID, wxString> FILE_INFO_PAIR;
44
48enum LAST_PATH_TYPE : unsigned int
49{
62
64};
65
73{
74public:
79 PROJECT_FILE( const wxString& aFullPath );
80
81 virtual ~PROJECT_FILE() = default;
82
83 virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
84
85 bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
86
87 bool SaveAs( const wxString& aDirectory, const wxString& aFile );
88
89 void SetProject( PROJECT* aProject )
90 {
91 m_project = aProject;
92 }
93
94 std::vector<FILE_INFO_PAIR>& GetSheets()
95 {
96 return m_sheets;
97 }
98
99 std::vector<FILE_INFO_PAIR>& GetBoards()
100 {
101 return m_boards;
102 }
103
104 std::shared_ptr<NET_SETTINGS>& NetSettings()
105 {
106 return m_NetSettings;
107 }
108
109 std::shared_ptr<COMPONENT_CLASS_SETTINGS>& ComponentClassSettings()
110 {
111 return m_ComponentClassSettings;
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:
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
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
163 std::vector<wxString> m_EquivalenceFiles;
164
171
173 wxString m_PcbLastPath[LAST_PATH_SIZE];
174
181
189 std::shared_ptr<NET_SETTINGS> m_NetSettings;
190
194 std::shared_ptr<COMPONENT_CLASS_SETTINGS> m_ComponentClassSettings;
195
196 std::vector<LAYER_PRESET> m_LayerPresets;
197 std::vector<VIEWPORT> m_Viewports;
198 std::vector<VIEWPORT3D> m_Viewports3D;
199 std::vector<LAYER_PAIR_INFO> m_LayerPairInfos;
200
201 struct IP2581_BOM m_IP2581Bom;
202
203private:
209 bool migrateSchema1To2();
210
214 bool migrateSchema2To3();
215
217 std::vector<FILE_INFO_PAIR> m_sheets;
218
220 std::vector<FILE_INFO_PAIR> m_boards;
221
224
226};
227
228// Specializations to allow directly reading/writing FILE_INFO_PAIRs from JSON
229
230void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair );
231
232void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair );
233
234#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.
Definition: erc_settings.h:135
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.
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.
Definition: net_settings.h:39
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:73
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:141
std::vector< LAYER_PAIR_INFO > m_LayerPairInfos
List of stored 3D viewports (view matrixes)
Definition: project_file.h:199
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:148
wxString m_LegacyLibDir
Definition: project_file.h:154
std::vector< FILE_INFO_PAIR > & GetSheets()
Definition: project_file.h:94
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:151
std::vector< FILE_INFO_PAIR > & GetBoards()
Definition: project_file.h:99
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:104
wxString m_BoardDrawingSheetFile
PcbNew params.
Definition: project_file.h:170
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:189
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:223
std::vector< VIEWPORT > m_Viewports
List of stored layer presets.
Definition: project_file.h:197
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
Definition: project_file.h:180
std::vector< wxString > m_PinnedDesignBlockLibs
The list of pinned design block libraries.
Definition: project_file.h:139
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:163
std::shared_ptr< COMPONENT_CLASS_SETTINGS > & ComponentClassSettings()
Definition: project_file.h:109
bool ShouldAutoSave() const
Definition: project_file.h:117
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:136
void SetProject(PROJECT *aProject)
Definition: project_file.h:89
virtual ~PROJECT_FILE()=default
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
Definition: project_file.h:217
bool m_wasMigrated
Definition: project_file.h:225
std::vector< LAYER_PRESET > m_LayerPresets
Definition: project_file.h:196
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:220
wxArrayString m_LegacyLibNames
Definition: project_file.h:156
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:133
std::vector< VIEWPORT3D > m_Viewports3D
List of stored viewports (pos + zoom)
Definition: project_file.h:198
std::shared_ptr< COMPONENT_CLASS_SETTINGS > m_ComponentClassSettings
Component class settings for the project (owned here)
Definition: project_file.h:194
Container for project specific data.
Definition: project.h:64
These are loaded from Eeschema settings but then overwritten by the project settings.
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.
Definition: project_file.h:49
@ LAST_PATH_PLOT
Definition: project_file.h:59
@ LAST_PATH_SPECCTRADSN
Definition: project_file.h:55
@ LAST_PATH_ODBPP
Definition: project_file.h:61
@ LAST_PATH_GENCAD
Definition: project_file.h:56
@ LAST_PATH_SIZE
Definition: project_file.h:63
@ LAST_PATH_2581
Definition: project_file.h:60
@ LAST_PATH_FIRST
Definition: project_file.h:50
@ LAST_PATH_POS_FILES
Definition: project_file.h:57
@ LAST_PATH_IDF
Definition: project_file.h:53
@ LAST_PATH_VRML
Definition: project_file.h:54
@ LAST_PATH_NETLIST
Definition: project_file.h:51
@ LAST_PATH_STEP
Definition: project_file.h:52
@ LAST_PATH_SVG
Definition: project_file.h:58
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...
Definition: project_file.h:43