KiCad PCB EDA Suite
project_file.cpp
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 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 #include <config_params.h>
23 #include <project.h>
24 #include <project/net_settings.h>
26 #include <project/project_file.h>
28 #include <settings/parameters.h>
30 #include <wx/config.h>
31 #include <wx/log.h>
32 
33 
36 
37 
38 PROJECT_FILE::PROJECT_FILE( const wxString& aFullPath ) :
40  m_ErcSettings( nullptr ),
41  m_SchematicSettings( nullptr ),
42  m_BoardSettings(),
43  m_sheets(),
44  m_boards(),
45  m_project( nullptr )
46 {
47  // Keep old files around
49 
50  m_params.emplace_back( new PARAM_LIST<FILE_INFO_PAIR>( "sheets", &m_sheets, {} ) );
51 
52  m_params.emplace_back( new PARAM_LIST<FILE_INFO_PAIR>( "boards", &m_boards, {} ) );
53 
54  m_params.emplace_back( new PARAM_WXSTRING_MAP( "text_variables", &m_TextVars, {} ) );
55 
56  m_params.emplace_back(
57  new PARAM_LIST<wxString>( "libraries.pinned_symbol_libs", &m_PinnedSymbolLibs, {} ) );
58 
59  m_params.emplace_back( new PARAM_LIST<wxString>(
60  "libraries.pinned_footprint_libs", &m_PinnedFootprintLibs, {} ) );
61 
62  m_params.emplace_back(
63  new PARAM_PATH_LIST( "cvpcb.equivalence_files", &m_EquivalenceFiles, {} ) );
64 
65  m_params.emplace_back(
66  new PARAM_PATH( "pcbnew.page_layout_descr_file", &m_BoardDrawingSheetFile, "" ) );
67 
68  m_params.emplace_back(
69  new PARAM_PATH( "pcbnew.last_paths.netlist", &m_PcbLastPath[LAST_PATH_NETLIST], "" ) );
70 
71  m_params.emplace_back(
72  new PARAM_PATH( "pcbnew.last_paths.step", &m_PcbLastPath[LAST_PATH_STEP], "" ) );
73 
74  m_params.emplace_back(
75  new PARAM_PATH( "pcbnew.last_paths.idf", &m_PcbLastPath[LAST_PATH_IDF], "" ) );
76 
77  m_params.emplace_back(
78  new PARAM_PATH( "pcbnew.last_paths.vrml", &m_PcbLastPath[LAST_PATH_VRML], "" ) );
79 
80  m_params.emplace_back( new PARAM_PATH(
81  "pcbnew.last_paths.specctra_dsn", &m_PcbLastPath[LAST_PATH_SPECCTRADSN], "" ) );
82 
83  m_params.emplace_back(
84  new PARAM_PATH( "pcbnew.last_paths.gencad", &m_PcbLastPath[LAST_PATH_GENCAD], "" ) );
85 
86  m_params.emplace_back( new PARAM<wxString>( "schematic.legacy_lib_dir", &m_LegacyLibDir, "" ) );
87 
88  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "schematic.legacy_lib_list",
89  [&]() -> nlohmann::json
90  {
91  nlohmann::json ret = nlohmann::json::array();
92 
93  for( const wxString& libName : m_LegacyLibNames )
94  ret.push_back( libName );
95 
96  return ret;
97  },
98  [&]( const nlohmann::json& aJson )
99  {
100  if( aJson.empty() || !aJson.is_array() )
101  return;
102 
103  m_LegacyLibNames.clear();
104 
105  for( const nlohmann::json& entry : aJson )
106  m_LegacyLibNames.push_back( entry.get<wxString>() );
107  }, {} ) );
108 
109  m_NetSettings = std::make_shared<NET_SETTINGS>( this, "net_settings" );
110 
111  m_params.emplace_back( new PARAM_LAYER_PRESET( "board.layer_presets", &m_LayerPresets ) );
112 }
113 
114 
115 bool PROJECT_FILE::MigrateFromLegacy( wxConfigBase* aCfg )
116 {
117  bool ret = true;
118  wxString str;
119  long index = 0;
120 
121  std::set<wxString> group_blacklist;
122 
123  // Legacy files don't store board info; they assume board matches project name
124  // We will leave m_boards empty here so it can be populated with other code
125 
126  // First handle migration of data that will be stored locally in this object
127 
128  auto loadPinnedLibs =
129  [&]( const std::string& aDest )
130  {
131  int libIndex = 1;
132  wxString libKey = wxT( "PinnedItems" );
133  libKey << libIndex;
134 
135  nlohmann::json libs = nlohmann::json::array();
136 
137  while( aCfg->Read( libKey, &str ) )
138  {
139  libs.push_back( str );
140 
141  aCfg->DeleteEntry( libKey, true );
142 
143  libKey = wxT( "PinnedItems" );
144  libKey << ++libIndex;
145  }
146 
147  Set( aDest, libs );
148  };
149 
150  aCfg->SetPath( wxT( "/LibeditFrame" ) );
151  loadPinnedLibs( "libraries.pinned_symbol_libs" );
152 
153  aCfg->SetPath( wxT( "/ModEditFrame" ) );
154  loadPinnedLibs( "libraries.pinned_footprint_libs" );
155 
156  aCfg->SetPath( wxT( "/cvpcb/equfiles" ) );
157 
158  {
159  int eqIdx = 1;
160  wxString eqKey = wxT( "EquName" );
161  eqKey << eqIdx;
162 
163  nlohmann::json eqs = nlohmann::json::array();
164 
165  while( aCfg->Read( eqKey, &str ) )
166  {
167  eqs.push_back( str );
168 
169  eqKey = wxT( "EquName" );
170  eqKey << ++eqIdx;
171  }
172 
173  Set( "cvpcb.equivalence_files", eqs );
174  }
175 
176  // All CvPcb params that we want to keep have been migrated above
177  group_blacklist.insert( wxT( "/cvpcb" ) );
178 
179  aCfg->SetPath( wxT( "/eeschema" ) );
180  fromLegacyString( aCfg, "LibDir", "schematic.legacy_lib_dir" );
181 
182  aCfg->SetPath( wxT( "/eeschema/libraries" ) );
183 
184  {
185  int libIdx = 1;
186  wxString libKey = wxT( "LibName" );
187  libKey << libIdx;
188 
189  nlohmann::json libs = nlohmann::json::array();
190 
191  while( aCfg->Read( libKey, &str ) )
192  {
193  libs.push_back( str );
194 
195  libKey = wxT( "LibName" );
196  libKey << ++libIdx;
197  }
198 
199  Set( "schematic.legacy_lib_list", libs );
200  }
201 
202  group_blacklist.insert( wxT( "/eeschema" ) );
203 
204  aCfg->SetPath( wxT( "/text_variables" ) );
205 
206  {
207  int txtIdx = 1;
208  wxString txtKey;
209  txtKey << txtIdx;
210 
212 
213  while( aCfg->Read( txtKey, &str ) )
214  {
215  wxArrayString tokens = wxSplit( str, ':' );
216 
217  if( tokens.size() == 2 )
218  vars[ tokens[0].ToStdString() ] = tokens[1];
219 
220  txtKey.clear();
221  txtKey << ++txtIdx;
222  }
223 
224  Set( "text_variables", vars );
225  }
226 
227  group_blacklist.insert( wxT( "/text_variables" ) );
228 
229  aCfg->SetPath( wxT( "/schematic_editor" ) );
230 
231  fromLegacyString( aCfg, "PageLayoutDescrFile", "schematic.page_layout_descr_file" );
232  fromLegacyString( aCfg, "PlotDirectoryName", "schematic.plot_directory" );
233  fromLegacyString( aCfg, "NetFmtName", "schematic.net_format_name" );
234  fromLegacy<bool>( aCfg, "SpiceAjustPassiveValues", "schematic.spice_adjust_passive_values" );
235  fromLegacy<int>( aCfg, "SubpartIdSeparator", "schematic.subpart_id_separator" );
236  fromLegacy<int>( aCfg, "SubpartFirstId", "schematic.subpart_first_id" );
237 
238  fromLegacy<int>( aCfg, "LineThickness", "schematic.drawing.default_line_thickness" );
239  fromLegacy<int>( aCfg, "WireThickness", "schematic.drawing.default_wire_thickness" );
240  fromLegacy<int>( aCfg, "BusThickness", "schematic.drawing.default_bus_thickness" );
241  fromLegacy<int>( aCfg, "LabSize", "schematic.drawing.default_text_size" );
242  fromLegacy<int>( aCfg, "PinSymbolSize", "schematic.drawing.pin_symbol_size" );
243  fromLegacy<int>( aCfg, "JunctionSize", "schematic.drawing.default_junction_size" );
244 
245  fromLegacyString( aCfg, "FieldNameTemplates", "schematic.drawing.field_names" );
246  fromLegacy<double>( aCfg, "TextOffsetRatio", "schematic.drawing.text_offset_ratio" );
247 
248  // All schematic_editor keys we keep are migrated above
249  group_blacklist.insert( wxT( "/schematic_editor" ) );
250 
251  aCfg->SetPath( wxT( "/pcbnew" ) );
252 
253  fromLegacyString( aCfg, "PageLayoutDescrFile", "pcbnew.page_layout_descr_file" );
254  fromLegacyString( aCfg, "LastNetListRead", "pcbnew.last_paths.netlist" );
255  fromLegacyString( aCfg, "LastSTEPExportPath", "pcbnew.last_paths.step" );
256  fromLegacyString( aCfg, "LastIDFExportPath", "pcbnew.last_paths.idf" );
257  fromLegacyString( aCfg, "LastVRMLExportPath", "pcbnew.last_paths.vmrl" );
258  fromLegacyString( aCfg, "LastSpecctraDSNExportPath", "pcbnew.last_paths.specctra_dsn" );
259  fromLegacyString( aCfg, "LastGenCADExportPath", "pcbnew.last_paths.gencad" );
260 
261  std::string bp = "board.design_settings.";
262 
263  {
264  int idx = 1;
265  wxString key = wxT( "DRCExclusion" );
266  key << idx;
267 
268  nlohmann::json exclusions = nlohmann::json::array();
269 
270  while( aCfg->Read( key, &str ) )
271  {
272  exclusions.push_back( str );
273 
274  key = wxT( "DRCExclusion" );
275  key << ++idx;
276  }
277 
278  Set( bp + "drc_exclusions", exclusions );
279  }
280 
281  fromLegacy<bool>( aCfg, "AllowMicroVias", bp + "rules.allow_microvias" );
282  fromLegacy<bool>( aCfg, "AllowBlindVias", bp + "rules.allow_blind_buried_vias" );
283  fromLegacy<double>( aCfg, "MinClearance", bp + "rules.min_clearance" );
284  fromLegacy<double>( aCfg, "MinTrackWidth", bp + "rules.min_track_width" );
285  fromLegacy<double>( aCfg, "MinViaAnnulus", bp + "rules.min_via_annulus" );
286  fromLegacy<double>( aCfg, "MinViaDiameter", bp + "rules.min_via_diameter" );
287 
288  if( !fromLegacy<double>( aCfg, "MinThroughDrill", bp + "rules.min_through_hole_diameter" ) )
289  fromLegacy<double>( aCfg, "MinViaDrill", bp + "rules.min_through_hole_diameter" );
290 
291  fromLegacy<double>( aCfg, "MinMicroViaDiameter", bp + "rules.min_microvia_diameter" );
292  fromLegacy<double>( aCfg, "MinMicroViaDrill", bp + "rules.min_microvia_drill" );
293  fromLegacy<double>( aCfg, "MinHoleToHole", bp + "rules.min_hole_to_hole" );
294  fromLegacy<double>( aCfg, "CopperEdgeClearance", bp + "rules.min_copper_edge_clearance" );
295  fromLegacy<double>( aCfg, "SolderMaskClearance", bp + "rules.solder_mask_clearance" );
296  fromLegacy<double>( aCfg, "SolderMaskMinWidth", bp + "rules.solder_mask_min_width" );
297  fromLegacy<double>( aCfg, "SolderPasteClearance", bp + "rules.solder_paste_clearance" );
298  fromLegacy<double>( aCfg, "SolderPasteRatio", bp + "rules.solder_paste_margin_ratio" );
299 
300  if( !fromLegacy<double>( aCfg, "SilkLineWidth", bp + "defaults.silk_line_width" ) )
301  fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.silk_line_width" );
302 
303  if( !fromLegacy<double>( aCfg, "SilkTextSizeV", bp + "defaults.silk_text_size_v" ) )
304  fromLegacy<double>( aCfg, "ModuleTextSizeV", bp + "defaults.silk_text_size_v" );
305 
306  if( !fromLegacy<double>( aCfg, "SilkTextSizeH", bp + "defaults.silk_text_size_h" ) )
307  fromLegacy<double>( aCfg, "ModuleTextSizeH", bp + "defaults.silk_text_size_h" );
308 
309  if( !fromLegacy<double>( aCfg, "SilkTextSizeThickness", bp + "defaults.silk_text_thickness" ) )
310  fromLegacy<double>( aCfg, "ModuleTextSizeThickness", bp + "defaults.silk_text_thickness" );
311 
312  fromLegacy<bool>( aCfg, "SilkTextItalic", bp + "defaults.silk_text_italic" );
313  fromLegacy<bool>( aCfg, "SilkTextUpright", bp + "defaults.silk_text_upright" );
314 
315  if( !fromLegacy<double>( aCfg, "CopperLineWidth", bp + "defaults.copper_line_width" ) )
316  fromLegacy<double>( aCfg, "DrawSegmentWidth", bp + "defaults.copper_line_width" );
317 
318  if( !fromLegacy<double>( aCfg, "CopperTextSizeV", bp + "defaults.copper_text_size_v" ) )
319  fromLegacy<double>( aCfg, "PcbTextSizeV", bp + "defaults.copper_text_size_v" );
320 
321  if( !fromLegacy<double>( aCfg, "CopperTextSizeH", bp + "defaults.copper_text_size_h" ) )
322  fromLegacy<double>( aCfg, "PcbTextSizeH", bp + "defaults.copper_text_size_h" );
323 
324  if( !fromLegacy<double>( aCfg, "CopperTextThickness", bp + "defaults.copper_text_thickness" ) )
325  fromLegacy<double>( aCfg, "PcbTextThickness", bp + "defaults.copper_text_thickness" );
326 
327  fromLegacy<bool>( aCfg, "CopperTextItalic", bp + "defaults.copper_text_italic" );
328  fromLegacy<bool>( aCfg, "CopperTextUpright", bp + "defaults.copper_text_upright" );
329 
330  if( !fromLegacy<double>( aCfg, "EdgeCutLineWidth", bp + "defaults.board_outline_line_width" ) )
331  fromLegacy<double>( aCfg, "BoardOutlineThickness", bp + "defaults.board_outline_line_width" );
332 
333  fromLegacy<double>( aCfg, "CourtyardLineWidth", bp + "defaults.courtyard_line_width" );
334 
335  fromLegacy<double>( aCfg, "FabLineWidth", bp + "defaults.fab_line_width" );
336  fromLegacy<double>( aCfg, "FabTextSizeV", bp + "defaults.fab_text_size_v" );
337  fromLegacy<double>( aCfg, "FabTextSizeH", bp + "defaults.fab_text_size_h" );
338  fromLegacy<double>( aCfg, "FabTextSizeThickness", bp + "defaults.fab_text_thickness" );
339  fromLegacy<bool>( aCfg, "FabTextItalic", bp + "defaults.fab_text_italic" );
340  fromLegacy<bool>( aCfg, "FabTextUpright", bp + "defaults.fab_text_upright" );
341 
342  if( !fromLegacy<double>( aCfg, "OthersLineWidth", bp + "defaults.other_line_width" ) )
343  fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.other_line_width" );
344 
345  fromLegacy<double>( aCfg, "OthersTextSizeV", bp + "defaults.other_text_size_v" );
346  fromLegacy<double>( aCfg, "OthersTextSizeH", bp + "defaults.other_text_size_h" );
347  fromLegacy<double>( aCfg, "OthersTextSizeThickness", bp + "defaults.other_text_thickness" );
348  fromLegacy<bool>( aCfg, "OthersTextItalic", bp + "defaults.other_text_italic" );
349  fromLegacy<bool>( aCfg, "OthersTextUpright", bp + "defaults.other_text_upright" );
350 
351  fromLegacy<int>( aCfg, "DimensionUnits", bp + "defaults.dimension_units" );
352  fromLegacy<int>( aCfg, "DimensionPrecision", bp + "defaults.dimension_precision" );
353 
354  std::string sev = bp + "rule_severities";
355 
356  fromLegacy<bool>( aCfg, "RequireCourtyardDefinitions", sev + "legacy_no_courtyard_defined" );
357 
358  fromLegacy<bool>( aCfg, "ProhibitOverlappingCourtyards", sev + "legacy_courtyards_overlap" );
359 
360  {
361  int idx = 1;
362  wxString keyBase = "TrackWidth";
363  wxString key = keyBase;
364  double val;
365 
366  nlohmann::json widths = nlohmann::json::array();
367 
368  key << idx;
369 
370  while( aCfg->Read( key, &val ) )
371  {
372  widths.push_back( val );
373  key = keyBase;
374  key << ++idx;
375  }
376 
377  Set( bp + "track_widths", widths );
378  }
379 
380  {
381  int idx = 1;
382  wxString keyBase = "ViaDiameter";
383  wxString key = keyBase;
384  double diameter;
385  double drill = 1.0;
386 
387  nlohmann::json vias = nlohmann::json::array();
388 
389  key << idx;
390 
391  while( aCfg->Read( key, &diameter ) )
392  {
393  key = "ViaDrill";
394  aCfg->Read( key << idx, &drill );
395 
396  nlohmann::json via = { { "diameter", diameter }, { "drill", drill } };
397  vias.push_back( via );
398 
399  key = keyBase;
400  key << ++idx;
401  }
402 
403  Set( bp + "via_dimensions", vias );
404  }
405 
406  {
407  int idx = 1;
408  wxString keyBase = "dPairWidth";
409  wxString key = keyBase;
410  double width;
411  double gap = 1.0;
412  double via_gap = 1.0;
413 
414  nlohmann::json pairs = nlohmann::json::array();
415 
416  key << idx;
417 
418  while( aCfg->Read( key, &width ) )
419  {
420  key = "dPairGap";
421  aCfg->Read( key << idx, &gap );
422 
423  key = "dPairViaGap";
424  aCfg->Read( key << idx, &via_gap );
425 
426  nlohmann::json pair = { { "width", width }, { "gap", gap }, { "via_gap", via_gap } };
427  pairs.push_back( pair );
428 
429  key = keyBase;
430  key << ++idx;
431  }
432 
433  Set( bp + "diff_pair_dimensions", pairs );
434  }
435 
436  group_blacklist.insert( wxT( "/pcbnew" ) );
437 
438  // General group is unused these days, we can throw it away
439  group_blacklist.insert( wxT( "/general" ) );
440 
441  // Next load sheet names and put all other legacy data in the legacy dict
442  aCfg->SetPath( wxT( "/" ) );
443 
444  auto loadSheetNames =
445  [&]() -> bool
446  {
447  int sheet = 1;
448  wxString entry;
449  nlohmann::json arr = nlohmann::json::array();
450 
451  wxLogTrace( traceSettings, "Migrating sheet names" );
452 
453  aCfg->SetPath( wxT( "/sheetnames" ) );
454 
455  while( aCfg->Read( wxString::Format( "%d", sheet++ ), &entry ) )
456  {
457  wxArrayString tokens = wxSplit( entry, ':' );
458 
459  if( tokens.size() == 2 )
460  {
461  wxLogTrace( traceSettings, "%d: %s = %s", sheet, tokens[0], tokens[1] );
462  arr.push_back( nlohmann::json::array( { tokens[0], tokens[1] } ) );
463  }
464  }
465 
466  Set( "sheets", arr );
467 
468  aCfg->SetPath( "/" );
469 
470  // TODO: any reason we want to fail on this?
471  return true;
472  };
473 
474  std::vector<wxString> groups;
475 
476  groups.emplace_back( "" );
477 
478  auto loadLegacyPairs =
479  [&]( const std::string& aGroup ) -> bool
480  {
481  wxLogTrace( traceSettings, "Migrating group %s", aGroup );
482  bool success = true;
483  wxString keyStr;
484  wxString val;
485 
486  index = 0;
487 
488  while( aCfg->GetNextEntry( keyStr, index ) )
489  {
490  if( !aCfg->Read( keyStr, &val ) )
491  continue;
492 
493  std::string key( keyStr.ToUTF8() );
494 
495  wxLogTrace( traceSettings, " %s = %s", key, val );
496 
497  try
498  {
499  Set( "legacy." + aGroup + "." + key, val );
500  }
501  catch( ... )
502  {
503  success = false;
504  }
505  }
506 
507  return success;
508  };
509 
510  for( size_t i = 0; i < groups.size(); i++ )
511  {
512  aCfg->SetPath( groups[i] );
513 
514  if( groups[i] == wxT( "/sheetnames" ) )
515  {
516  ret |= loadSheetNames();
517  continue;
518  }
519 
520  aCfg->DeleteEntry( wxT( "last_client" ), true );
521  aCfg->DeleteEntry( wxT( "update" ), true );
522  aCfg->DeleteEntry( wxT( "version" ), true );
523 
524  ret &= loadLegacyPairs( groups[i].ToStdString() );
525 
526  index = 0;
527 
528  while( aCfg->GetNextGroup( str, index ) )
529  {
530  wxString group = groups[i] + "/" + str;
531 
532  if( !group_blacklist.count( group ) )
533  groups.emplace_back( group );
534  }
535 
536  aCfg->SetPath( "/" );
537  }
538 
539  return ret;
540 }
541 
542 
543 bool PROJECT_FILE::SaveToFile( const wxString& aDirectory, bool aForce )
544 {
545  wxASSERT( m_project );
546 
547  Set( "meta.filename", m_project->GetProjectName() + "." + ProjectFileExtension );
548 
549  return JSON_SETTINGS::SaveToFile( aDirectory, aForce );
550 }
551 
552 
553 wxString PROJECT_FILE::getFileExt() const
554 {
555  return ProjectFileExtension;
556 }
557 
558 
560 {
562 }
563 
564 
565 void to_json( nlohmann::json& aJson, const FILE_INFO_PAIR& aPair )
566 {
567  aJson = nlohmann::json::array( { aPair.first.AsString().ToUTF8(), aPair.second.ToUTF8() } );
568 }
569 
570 
571 void from_json( const nlohmann::json& aJson, FILE_INFO_PAIR& aPair )
572 {
573  wxCHECK( aJson.is_array() && aJson.size() == 2, /* void */ );
574  aPair.first = KIID( wxString( aJson[0].get<std::string>().c_str(), wxConvUTF8 ) );
575  aPair.second = wxString( aJson[1].get<std::string>().c_str(), wxConvUTF8 );
576 }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:179
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:118
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:113
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:116
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
Container for project specific data.
Definition: project.h:62
const std::string ProjectFileExtension
wxArrayString m_LegacyLibNames
Definition: project_file.h:133
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
Definition: project_file.h:173
const int projectFileSchemaVersion
! Update the schema version whenever a migration is required
wxString getLegacyFileExt() const override
bool SaveToFile(const wxString &aDirectory="", bool aForce=false) override
SETTINGS_LOC
Definition: json_settings.h:46
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
Definition: project_file.h:150
nlohmann::json json
Definition: gerbview.cpp:41
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
Stores a path as a string with directory separators normalized to unix-style.
Definition: parameters.h:173
Definition: kiid.h:44
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:35
wxString m_BoardDrawingSheetFile
PcbNew params.
Definition: project_file.h:147
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:166
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:140
Definition of file extensions used in Kicad.
wxString getFileExt() const override
const std::string LegacyProjectFileExtension
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
A helper for <wxString, wxString> maps.
Definition: parameters.h:579
void to_json(nlohmann::json &aJson, const FILE_INFO_PAIR &aPair)
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
void from_json(const nlohmann::json &aJson, FILE_INFO_PAIR &aPair)
wxString m_LegacyLibDir
Definition: project_file.h:131
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:129
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
std::vector< LAYER_PRESET > m_LayerPresets
List of stored layer presets.
Definition: project_file.h:169
Represents a list of strings holding directory paths.
Definition: parameters.h:483
PROJECT_FILE(const wxString &aFullPath)
Construct the project file for a project.
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:176