KiCad PCB EDA Suite
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 (C) 2021-2022 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;
35class TEMPLATES;
36
41typedef std::pair<KIID, wxString> FILE_INFO_PAIR;
42
46enum LAST_PATH_TYPE : unsigned int
47{
54
56};
57
65{
66public:
71 PROJECT_FILE( const wxString& aFullPath );
72
73 virtual ~PROJECT_FILE() = default;
74
75 virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
76
77 bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
78
79 bool SaveAs( const wxString& aDirectory, const wxString& aFile );
80
81 void SetProject( PROJECT* aProject )
82 {
83 m_project = aProject;
84 }
85
86 std::vector<FILE_INFO_PAIR>& GetSheets()
87 {
88 return m_sheets;
89 }
90
91 std::vector<FILE_INFO_PAIR>& GetBoards()
92 {
93 return m_boards;
94 }
95
96 std::shared_ptr<NET_SETTINGS>& NetSettings()
97 {
98 return m_NetSettings;
99 }
100
101protected:
102 wxString getFileExt() const override;
103
104 wxString getLegacyFileExt() const override;
105
109public:
115 std::vector<wxString> m_PinnedSymbolLibs;
116
118 std::vector<wxString> m_PinnedFootprintLibs;
119
120 std::map<wxString, wxString> m_TextVars;
121
126 // Schematic ERC settings: lifecycle managed by SCHEMATIC
128
129 // Schematic editing and misc settings: lifecycle managed by SCHEMATIC
131
132 // Legacy parameters LibDir and LibName, for importing old projects
134
135 wxArrayString m_LegacyLibNames;
136
142 std::vector<wxString> m_EquivalenceFiles;
143
150
153
160
168 std::shared_ptr<NET_SETTINGS> m_NetSettings;
169
170
171 std::vector<LAYER_PRESET> m_LayerPresets;
172 std::vector<VIEWPORT> m_Viewports;
173 std::vector<VIEWPORT3D> m_Viewports3D;
174
175private:
177 std::vector<FILE_INFO_PAIR> m_sheets;
178
180 std::vector<FILE_INFO_PAIR> m_boards;
181
184};
185
186// Specializations to allow directly reading/writing FILE_INFO_PAIRs from JSON
187
188void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair );
189
190void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair );
191
192#endif
Container for design settings for a BOARD object.
Container for ERC settings.
Definition: erc_settings.h:114
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:34
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:65
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:120
wxString getFileExt() const override
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:127
wxString m_LegacyLibDir
Definition: project_file.h:133
std::vector< FILE_INFO_PAIR > & GetSheets()
Definition: project_file.h:86
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:130
std::vector< FILE_INFO_PAIR > & GetBoards()
Definition: project_file.h:91
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:96
wxString m_BoardDrawingSheetFile
PcbNew params.
Definition: project_file.h:149
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:168
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
Definition: project_file.h:152
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:183
std::vector< VIEWPORT > m_Viewports
List of stored layer presets.
Definition: project_file.h:172
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
Definition: project_file.h:159
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:142
wxString getLegacyFileExt() const override
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:118
void SetProject(PROJECT *aProject)
Definition: project_file.h:81
virtual ~PROJECT_FILE()=default
std::vector< FILE_INFO_PAIR > m_sheets
List of stored 3D viewports (view matrixes)
Definition: project_file.h:177
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
std::vector< LAYER_PRESET > m_LayerPresets
Definition: project_file.h:171
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:180
wxArrayString m_LegacyLibNames
Definition: project_file.h:135
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:115
std::vector< VIEWPORT3D > m_Viewports3D
List of stored viewports (pos + zoom)
Definition: project_file.h:173
bool SaveToFile(const wxString &aDirectory="", bool aForce=false) override
PROJECT_FILE(const wxString &aFullPath)
Construct the project file for a project.
Container for project specific data.
Definition: project.h:63
These settings were stored in SCH_BASE_FRAME previously.
The common library.
nlohmann::json json
Definition: gerbview.cpp:44
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:47
@ LAST_PATH_SPECCTRADSN
Definition: project_file.h:52
@ LAST_PATH_GENCAD
Definition: project_file.h:53
@ LAST_PATH_SIZE
Definition: project_file.h:55
@ LAST_PATH_IDF
Definition: project_file.h:50
@ LAST_PATH_VRML
Definition: project_file.h:51
@ LAST_PATH_NETLIST
Definition: project_file.h:48
@ LAST_PATH_STEP
Definition: project_file.h:49
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:41