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 (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;
36class TEMPLATES;
37
42typedef std::pair<KIID, wxString> FILE_INFO_PAIR;
43
47enum LAST_PATH_TYPE : unsigned int
48{
60
62};
63
71{
72public:
77 PROJECT_FILE( const wxString& aFullPath );
78
79 virtual ~PROJECT_FILE() = default;
80
81 virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
82
83 bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
84
85 bool SaveAs( const wxString& aDirectory, const wxString& aFile );
86
87 void SetProject( PROJECT* aProject )
88 {
89 m_project = aProject;
90 }
91
92 std::vector<FILE_INFO_PAIR>& GetSheets()
93 {
94 return m_sheets;
95 }
96
97 std::vector<FILE_INFO_PAIR>& GetBoards()
98 {
99 return m_boards;
100 }
101
102 std::shared_ptr<NET_SETTINGS>& NetSettings()
103 {
104 return m_NetSettings;
105 }
106
107protected:
108 wxString getFileExt() const override;
109
110 wxString getLegacyFileExt() const override;
111
115public:
121 std::vector<wxString> m_PinnedSymbolLibs;
122
124 std::vector<wxString> m_PinnedFootprintLibs;
125
126 std::map<wxString, wxString> m_TextVars;
127
132 // Schematic ERC settings: lifecycle managed by SCHEMATIC
134
135 // Schematic editing and misc settings: lifecycle managed by SCHEMATIC
137
138 // Legacy parameters LibDir and LibName, for importing old projects
140
141 wxArrayString m_LegacyLibNames;
142
148 std::vector<wxString> m_EquivalenceFiles;
149
156
158 wxString m_PcbLastPath[LAST_PATH_SIZE];
159
166
174 std::shared_ptr<NET_SETTINGS> m_NetSettings;
175
176
177 std::vector<LAYER_PRESET> m_LayerPresets;
178 std::vector<VIEWPORT> m_Viewports;
179 std::vector<VIEWPORT3D> m_Viewports3D;
180 std::vector<LAYER_PAIR_INFO> m_LayerPairInfos;
181
182 struct IP2581_BOM m_IP2581Bom;
183
184private:
186 std::vector<FILE_INFO_PAIR> m_sheets;
187
189 std::vector<FILE_INFO_PAIR> m_boards;
190
193};
194
195// Specializations to allow directly reading/writing FILE_INFO_PAIRs from JSON
196
197void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair );
198
199void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair );
200
201#endif
Container for design settings for a BOARD object.
Container for ERC settings.
Definition: erc_settings.h:128
virtual wxString getFileExt() const
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:71
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:126
std::vector< LAYER_PAIR_INFO > m_LayerPairInfos
List of stored 3D viewports (view matrixes)
Definition: project_file.h:180
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:133
wxString m_LegacyLibDir
Definition: project_file.h:139
std::vector< FILE_INFO_PAIR > & GetSheets()
Definition: project_file.h:92
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:136
std::vector< FILE_INFO_PAIR > & GetBoards()
Definition: project_file.h:97
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:102
wxString m_BoardDrawingSheetFile
PcbNew params.
Definition: project_file.h:155
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:174
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:192
std::vector< VIEWPORT > m_Viewports
List of stored layer presets.
Definition: project_file.h:178
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
Definition: project_file.h:165
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:148
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:124
void SetProject(PROJECT *aProject)
Definition: project_file.h:87
virtual ~PROJECT_FILE()=default
std::vector< FILE_INFO_PAIR > m_sheets
IPC-2581 BOM settings.
Definition: project_file.h:186
std::vector< LAYER_PRESET > m_LayerPresets
Definition: project_file.h:177
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:189
wxArrayString m_LegacyLibNames
Definition: project_file.h:141
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:121
std::vector< VIEWPORT3D > m_Viewports3D
List of stored viewports (pos + zoom)
Definition: project_file.h:179
Container for project specific data.
Definition: project.h:63
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:48
@ LAST_PATH_PLOT
Definition: project_file.h:58
@ LAST_PATH_SPECCTRADSN
Definition: project_file.h:54
@ LAST_PATH_GENCAD
Definition: project_file.h:55
@ LAST_PATH_SIZE
Definition: project_file.h:61
@ LAST_PATH_2581
Definition: project_file.h:59
@ LAST_PATH_FIRST
Definition: project_file.h:49
@ LAST_PATH_POS_FILES
Definition: project_file.h:56
@ LAST_PATH_IDF
Definition: project_file.h:52
@ LAST_PATH_VRML
Definition: project_file.h:53
@ LAST_PATH_NETLIST
Definition: project_file.h:50
@ LAST_PATH_STEP
Definition: project_file.h:51
@ LAST_PATH_SVG
Definition: project_file.h:57
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:42