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;
35class TEMPLATES;
36
41typedef std::pair<KIID, wxString> FILE_INFO_PAIR;
42
46enum LAST_PATH_TYPE : unsigned int
47{
58
60};
61
69{
70public:
75 PROJECT_FILE( const wxString& aFullPath );
76
77 virtual ~PROJECT_FILE() = default;
78
79 virtual bool MigrateFromLegacy( wxConfigBase* aCfg ) override;
80
81 bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
82
83 bool SaveAs( const wxString& aDirectory, const wxString& aFile );
84
85 void SetProject( PROJECT* aProject )
86 {
87 m_project = aProject;
88 }
89
90 std::vector<FILE_INFO_PAIR>& GetSheets()
91 {
92 return m_sheets;
93 }
94
95 std::vector<FILE_INFO_PAIR>& GetBoards()
96 {
97 return m_boards;
98 }
99
100 std::shared_ptr<NET_SETTINGS>& NetSettings()
101 {
102 return m_NetSettings;
103 }
104
105protected:
106 wxString getFileExt() const override;
107
108 wxString getLegacyFileExt() const override;
109
113public:
119 std::vector<wxString> m_PinnedSymbolLibs;
120
122 std::vector<wxString> m_PinnedFootprintLibs;
123
124 std::map<wxString, wxString> m_TextVars;
125
130 // Schematic ERC settings: lifecycle managed by SCHEMATIC
132
133 // Schematic editing and misc settings: lifecycle managed by SCHEMATIC
135
136 // Legacy parameters LibDir and LibName, for importing old projects
138
139 wxArrayString m_LegacyLibNames;
140
146 std::vector<wxString> m_EquivalenceFiles;
147
154
157
164
172 std::shared_ptr<NET_SETTINGS> m_NetSettings;
173
174
175 std::vector<LAYER_PRESET> m_LayerPresets;
176 std::vector<VIEWPORT> m_Viewports;
177 std::vector<VIEWPORT3D> m_Viewports3D;
178
179private:
181 std::vector<FILE_INFO_PAIR> m_sheets;
182
184 std::vector<FILE_INFO_PAIR> m_boards;
185
188};
189
190// Specializations to allow directly reading/writing FILE_INFO_PAIRs from JSON
191
192void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair );
193
194void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair );
195
196#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:69
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:124
wxString getFileExt() const override
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:131
wxString m_LegacyLibDir
Definition: project_file.h:137
std::vector< FILE_INFO_PAIR > & GetSheets()
Definition: project_file.h:90
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:134
std::vector< FILE_INFO_PAIR > & GetBoards()
Definition: project_file.h:95
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:100
wxString m_BoardDrawingSheetFile
PcbNew params.
Definition: project_file.h:153
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:172
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
Definition: project_file.h:156
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:187
std::vector< VIEWPORT > m_Viewports
List of stored layer presets.
Definition: project_file.h:176
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
Definition: project_file.h:163
bool SaveAs(const wxString &aDirectory, const wxString &aFile)
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:146
wxString getLegacyFileExt() const override
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:122
void SetProject(PROJECT *aProject)
Definition: project_file.h:85
virtual ~PROJECT_FILE()=default
std::vector< FILE_INFO_PAIR > m_sheets
List of stored 3D viewports (view matrixes)
Definition: project_file.h:181
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
std::vector< LAYER_PRESET > m_LayerPresets
Definition: project_file.h:175
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:184
wxArrayString m_LegacyLibNames
Definition: project_file.h:139
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:119
std::vector< VIEWPORT3D > m_Viewports3D
List of stored viewports (pos + zoom)
Definition: project_file.h:177
bool SaveToFile(const wxString &aDirectory="", bool aForce=false) override
Container for project specific data.
Definition: project.h:62
These settings were stored in SCH_BASE_FRAME previously.
The common library.
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_PLOT
Definition: project_file.h:57
@ LAST_PATH_SPECCTRADSN
Definition: project_file.h:53
@ LAST_PATH_GENCAD
Definition: project_file.h:54
@ LAST_PATH_SIZE
Definition: project_file.h:59
@ LAST_PATH_FIRST
Definition: project_file.h:48
@ LAST_PATH_POS_FILES
Definition: project_file.h:55
@ LAST_PATH_IDF
Definition: project_file.h:51
@ LAST_PATH_VRML
Definition: project_file.h:52
@ LAST_PATH_NETLIST
Definition: project_file.h:49
@ LAST_PATH_STEP
Definition: project_file.h:50
@ LAST_PATH_SVG
Definition: project_file.h:56
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