KiCad PCB EDA Suite
PROJECT_FILE Class Reference

PROJECT_FILE is the backing store for a PROJECT, in JSON format. More...

#include <project_file.h>

Inheritance diagram for PROJECT_FILE:
JSON_SETTINGS

Public Member Functions

 PROJECT_FILE (const wxString &aFullPath)
 Constructs the project file for a project. More...
 
virtual ~PROJECT_FILE ()=default
 
virtual bool MigrateFromLegacy (wxConfigBase *aCfg) override
 Migrates from wxConfig to JSON-based configuration. More...
 
bool SaveToFile (const wxString &aDirectory="", bool aForce=false) override
 
void SetProject (PROJECT *aProject)
 
std::vector< FILE_INFO_PAIR > & GetSheets ()
 
std::vector< FILE_INFO_PAIR > & GetBoards ()
 
NET_SETTINGSNetSettings ()
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
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 library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
virtual bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 

Public Attributes

std::vector< wxString > m_PinnedSymbolLibs
 Below are project-level settings that have not been moved to a dedicated file. More...
 
std::vector< wxString > m_PinnedFootprintLibs
 The list of pinned footprint libraries. More...
 
std::map< wxString, wxString > m_TextVars
 
ERC_SETTINGSm_ErcSettings
 Eeschema params. More...
 
SCHEMATIC_SETTINGSm_SchematicSettings
 
TEMPLATESm_TemplateFieldNames
 A pointer to the template fieldnames object owned by the parent SCH_BASE_FRAME. More...
 
wxString m_LegacyLibDir
 
wxArrayString m_LegacyLibNames
 
std::vector< wxString > m_EquivalenceFiles
 CvPcb params. More...
 
wxString m_BoardPageLayoutDescrFile
 PcbNew params. More...
 
wxString m_PcbLastPath [LAST_PATH_SIZE]
 MRU path storage. More...
 
BOARD_DESIGN_SETTINGSm_BoardSettings
 Board design settings for this project's board. More...
 
std::shared_ptr< NET_SETTINGSm_NetSettings
 Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board. More...
 
std::vector< LAYER_PRESETm_LayerPresets
 List of stored layer presets. More...
 

Protected Member Functions

wxString getFileExt () const override
 
wxString getLegacyFileExt () const override
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 

Private Attributes

std::vector< FILE_INFO_PAIRm_sheets
 An list of schematic sheets in this project. More...
 
std::vector< FILE_INFO_PAIRm_boards
 A list of board files in this project. More...
 
PROJECTm_project
 A link to the owning PROJECT. More...
 

Detailed Description

PROJECT_FILE is the backing store for a PROJECT, in JSON format.

There is either zero or one PROJECT_FILE for every PROJECT (you can have a dummy PROJECT that has no file)

Definition at line 62 of file project_file.h.

Constructor & Destructor Documentation

◆ PROJECT_FILE()

PROJECT_FILE::PROJECT_FILE ( const wxString &  aFullPath)

Constructs the project file for a project.

Parameters
aFullPathis the full disk path to the project

Definition at line 37 of file project_file.cpp.

37  :
39  m_sheets(),
40  m_boards(),
41  m_project( nullptr ),
42  m_ErcSettings( nullptr ),
43  m_SchematicSettings( nullptr ),
44  m_TemplateFieldNames( 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_BoardPageLayoutDescrFile, "" ) );
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.vmrl", &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_LAMBDA<nlohmann::json>( "board.layer_presets",
112  [&]() -> nlohmann::json
113  {
114  nlohmann::json ret = nlohmann::json::array();
115 
116  for( const LAYER_PRESET& preset : m_LayerPresets )
117  {
118  nlohmann::json js = {
119  { "name", preset.name },
120  { "activeLayer", preset.activeLayer }
121  };
122 
123  nlohmann::json layers = nlohmann::json::array();
124 
125  for( PCB_LAYER_ID layer : preset.layers.Seq() )
126  layers.push_back( static_cast<int>( layer ) );
127 
128  js["layers"] = layers;
129 
130  nlohmann::json renderLayers = nlohmann::json::array();
131 
132  for( GAL_LAYER_ID layer : preset.renderLayers.Seq() )
133  renderLayers.push_back( static_cast<int>( layer ) );
134 
135  js["renderLayers"] = renderLayers;
136 
137  ret.push_back( js );
138  }
139 
140  return ret;
141  },
142  [&]( const nlohmann::json& aVal )
143  {
144  if( aVal.empty() || !aVal.is_array() )
145  return;
146 
147  m_LayerPresets.clear();
148 
149  for( const nlohmann::json& preset : aVal )
150  {
151  if( preset.contains( "name" ) )
152  {
153  LAYER_PRESET p( preset.at( "name" ).get<wxString>() );
154 
155  if( preset.contains( "activeLayer" ) &&
156  preset.at( "activeLayer" ).is_number_integer() )
157  {
158  int active = preset.at( "activeLayer" ).get<int>();
159 
160  if( active >= 0 && active < PCB_LAYER_ID_COUNT )
161  p.activeLayer = static_cast<PCB_LAYER_ID>( active );
162  }
163 
164  if( preset.contains( "layers" ) && preset.at( "layers" ).is_array() )
165  {
166  for( const nlohmann::json& layer : preset.at( "layers" ) )
167  {
168  if( layer.is_number_integer() )
169  {
170  int layerNum = layer.get<int>();
171 
172  if( layerNum >= 0 && layerNum < PCB_LAYER_ID_COUNT )
173  p.layers.set( layerNum );
174  }
175  }
176  }
177 
178  if( preset.contains( "renderLayers" )
179  && preset.at( "renderLayers" ).is_array() )
180  {
181  for( const nlohmann::json& layer : preset.at( "renderLayers" ) )
182  {
183  if( layer.is_number_integer() )
184  {
185  int layerNum = layer.get<int>();
186 
187  if( layerNum >= GAL_LAYER_ID_START
188  && layerNum < GAL_LAYER_ID_END )
189  p.layers.set( layerNum );
190  }
191  }
192  }
193 
194  m_LayerPresets.emplace_back( p );
195  }
196  }
197  },
198  {} ) );
199 }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:111
A saved set of layers that are visible.
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:128
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:123
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:126
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:296
wxArrayString m_LegacyLibNames
Definition: project_file.h:154
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
Definition: project_file.h:105
const int projectFileSchemaVersion
! Update the schema version whenever a migration is required
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Add new GAL layers here.
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
Definition: project_file.h:171
nlohmann::json json
Definition: gerbview.cpp:40
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
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here) NOTE: If we go multi-board in the future,...
Definition: project_file.h:186
PCB_LAYER_ID
A quick note on layer IDs:
wxString m_BoardPageLayoutDescrFile
PcbNew params.
Definition: project_file.h:168
The settings directory inside a project folder.
TEMPLATES * m_TemplateFieldNames
A pointer to the template fieldnames object owned by the parent SCH_BASE_FRAME.
Definition: project_file.h:149
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:161
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:135
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:138
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:48
A helper for <wxString, wxString> maps.
Definition: parameters.h:724
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
Definition: project_file.h:178
wxString m_LegacyLibDir
Definition: project_file.h:152
std::vector< LAYER_PRESET > m_LayerPresets
List of stored layer presets.
Definition: project_file.h:189
Represents a list of strings holding directory paths.
Definition: parameters.h:560
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:108

References LAYER_PRESET::activeLayer, GAL_LAYER_ID_END, GAL_LAYER_ID_START, LAST_PATH_GENCAD, LAST_PATH_IDF, LAST_PATH_NETLIST, LAST_PATH_SPECCTRADSN, LAST_PATH_STEP, LAST_PATH_VRML, LAYER_PRESET::layers, m_BoardPageLayoutDescrFile, m_boards, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_EquivalenceFiles, m_LayerPresets, m_LegacyLibDir, m_LegacyLibNames, m_NetSettings, JSON_SETTINGS::m_params, m_PcbLastPath, m_PinnedFootprintLibs, m_PinnedSymbolLibs, m_sheets, m_TextVars, and PCB_LAYER_ID_COUNT.

◆ ~PROJECT_FILE()

virtual PROJECT_FILE::~PROJECT_FILE ( )
virtualdefault

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 533 of file json_settings.cpp.

534 {
535  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
536  m_nested_settings.push_back( aSettings );
537 }
wxString GetFilename() const
Definition: json_settings.h:56
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ fromLegacy()

template<typename ValueType >
template bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 445 of file json_settings.cpp.

447 {
448  ValueType val;
449 
450  if( aConfig->Read( aKey, &val ) )
451  {
452  try
453  {
454  ( *this )[PointerFromString( aDest )] = val;
455  }
456  catch( ... )
457  {
458  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
459  return false;
460  }
461 
462  return true;
463  }
464 
465  return false;
466 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 505 of file json_settings.cpp.

507 {
508  wxString str;
509 
510  if( aConfig->Read( aKey, &str ) )
511  {
513  color.SetFromWxString( str );
514 
515  try
516  {
517  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
518  ( *this )[PointerFromString( aDest )] = js;
519  }
520  catch( ... )
521  {
522  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
523  return false;
524  }
525 
526  return true;
527  }
528 
529  return false;
530 }
int color
Definition: DXF_plotter.cpp:61
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 481 of file json_settings.cpp.

483 {
484  wxString str;
485 
486  if( aConfig->Read( aKey, &str ) )
487  {
488  try
489  {
490  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
491  }
492  catch( ... )
493  {
494  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
495  return false;
496  }
497 
498  return true;
499  }
500 
501  return false;
502 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), LIBEDIT_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

template<typename ValueType >
OPT<ValueType> JSON_SETTINGS::Get ( const std::string &  aPath) const
inlineinherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 111 of file json_settings.h.

112  {
113  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
114  {
115  try
116  {
117  return ret->get<ValueType>();
118  }
119  catch( ... )
120  {
121  }
122  }
123 
124  return NULLOPT;
125  }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

OPT< wxString > JSON_SETTINGS::Get ( const std::string &  aPath) const
inherited

Definition at line 563 of file json_settings.cpp.

564 {
565  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
566  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
567 
568  return NULLOPT;
569 }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ GetBoards()

std::vector<FILE_INFO_PAIR>& PROJECT_FILE::GetBoards ( )
inline

Definition at line 87 of file project_file.h.

88  {
89  return m_boards;
90  }
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:108

References m_boards.

◆ getFileExt()

wxString PROJECT_FILE::getFileExt ( ) const
overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 644 of file project_file.cpp.

645 {
646  return ProjectFileExtension;
647 }
const std::string ProjectFileExtension

References ProjectFileExtension.

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 70 of file json_settings.cpp.

71 {
72  return wxString( m_filename + "." + getFileExt() );
73 }
wxString m_filename
The filename (not including path) of this settings file (inicode)
virtual wxString getFileExt() const

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetJson()

OPT< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string &  aPath) const
inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters
aPathis a string containing one or more keys separated by '.'
Returns
a JSON object from within this one

Definition at line 390 of file json_settings.cpp.

391 {
392  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
393 
394  if( this->contains( ptr ) )
395  {
396  try
397  {
398  return OPT<nlohmann::json>{ this->at( ptr ) };
399  }
400  catch( ... )
401  {
402  }
403  }
404 
405  return OPT<nlohmann::json>{};
406 }
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

wxString PROJECT_FILE::getLegacyFileExt ( ) const
overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 650 of file project_file.cpp.

651 {
653 }
const std::string LegacyProjectFileExtension

References LegacyProjectFileExtension.

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 60 of file json_settings.h.

60 { return m_location; }
SETTINGS_LOC m_location
The location of this settings file (.

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetSheets()

std::vector<FILE_INFO_PAIR>& PROJECT_FILE::GetSheets ( )
inline

Definition at line 82 of file project_file.h.

83  {
84  return m_sheets;
85  }
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
Definition: project_file.h:105

References m_sheets.

Referenced by PROJECT::GetSheetName(), and SCH_EDIT_FRAME::SaveProject().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 76 of file json_settings.cpp.

77 {
78  for( auto param : m_params )
79  {
80  try
81  {
82  param->Load( this, m_resetParamsIfMissing );
83  }
84  catch( ... )
85  {
86  // Skip unreadable parameters in file:
87 #ifdef DEBUG
88  wxLogMessage( wxString::Format( "param '%s' load err", param->GetJsonPath().c_str() ) );
89 #endif
90  }
91  }
92 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), JSON_SETTINGS::m_params, and JSON_SETTINGS::m_resetParamsIfMissing.

Referenced by NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString &  aDirectory = "")
virtualinherited

Loads the backing file from disk and then calls Load()

Parameters
aDirectoryis the path to the file
Returns
true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 95 of file json_settings.cpp.

96 {
97  // First, load all params to default values
98  clear();
99  Load();
100 
101  bool success = true;
102  bool migrated = false;
103  bool legacy_migrated = false;
104 
105  LOCALE_IO locale;
106 
107  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
108  // Backup and restore during migration so that the original can be mutated if convenient
109  bool backed_up = false;
110  wxFileName temp;
111 
112  if( aPath.IsDirWritable() )
113  {
114  temp.AssignTempFileName( aPath.GetFullPath() );
115 
116  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
117  {
118  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
119  GetFullFilename() );
120  }
121  else
122  backed_up = true;
123  }
124 
125  wxConfigBase::DontCreateOnDemand();
126  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
127 
128  // If migrate fails or is not implemented, fall back to built-in defaults that were
129  // already loaded above
130  if( !MigrateFromLegacy( cfg.get() ) )
131  {
132  wxLogTrace( traceSettings,
133  "%s: migrated; not all settings were found in legacy file",
134  GetFullFilename() );
135  }
136  else
137  {
138  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
139  }
140 
141  if( backed_up )
142  {
143  cfg.reset();
144 
145  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
146  {
147  wxLogTrace( traceSettings,
148  "migrate; copy temp file %s to %s failed",
149  temp.GetFullPath(), aPath.GetFullPath() );
150  }
151 
152  if( !wxRemoveFile( temp.GetFullPath() ) )
153  {
154  wxLogTrace( traceSettings,
155  "migrate; failed to remove temp file %s",
156  temp.GetFullPath() );
157  }
158  }
159 
160  // Either way, we want to clean up the old file afterwards
161  legacy_migrated = true;
162  };
163 
164  wxFileName path;
165 
166  if( aDirectory.empty() )
167  {
168  path.Assign( m_filename );
169  path.SetExt( getFileExt() );
170  }
171  else
172  {
173  wxString dir( aDirectory );
174  path.Assign( dir, m_filename, getFileExt() );
175  }
176 
177  if( !path.Exists() )
178  {
179  // Case 1: legacy migration, no .json extension yet
180  path.SetExt( getLegacyFileExt() );
181 
182  if( path.Exists() )
183  {
184  migrateFromLegacy( path );
185  }
186  // Case 2: legacy filename is different from new one
187  else if( !m_legacy_filename.empty() )
188  {
189  path.SetName( m_legacy_filename );
190 
191  if( path.Exists() )
192  migrateFromLegacy( path );
193  }
194  else
195  {
196  success = false;
197  }
198  }
199  else
200  {
201  try
202  {
203  FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
204  *static_cast<nlohmann::json*>( this ) = nlohmann::json::parse( fp, nullptr,
205  /* allow_exceptions = */ true,
206  /* ignore_comments = */ true );
207 
208  // If parse succeeds, check if schema migration is required
209  int filever = -1;
210 
211  try
212  {
213  filever = at( PointerFromString( "meta.version" ) ).get<int>();
214  }
215  catch( ... )
216  {
217  wxLogTrace(
218  traceSettings, "%s: file version could not be read!", GetFullFilename() );
219  success = false;
220  }
221 
222  if( filever >= 0 && filever < m_schemaVersion )
223  {
224  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
225  GetFullFilename(), filever, m_schemaVersion );
226 
227  if( Migrate() )
228  {
229  migrated = true;
230  }
231  else
232  {
233  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
234  }
235  }
236  else if( filever > m_schemaVersion )
237  {
238  wxLogTrace( traceSettings,
239  "%s: warning: file version %d is newer than latest (%d)", GetFullFilename(),
240  filever, m_schemaVersion );
241  }
242  }
243  catch( nlohmann::json::parse_error& error )
244  {
245  wxLogTrace(
246  traceSettings, "Parse error reading %s: %s", path.GetFullPath(), error.what() );
247  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
248  migrateFromLegacy( path );
249  }
250  }
251 
252  // Now that we have new data in the JSON structure, load the params again
253  Load();
254 
255  // And finally load any nested settings
256  for( auto settings : m_nested_settings )
257  settings->LoadFromFile();
258 
259  wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
260 
261  // If we migrated, clean up the legacy file (with no extension)
262  if( legacy_migrated || migrated )
263  {
264  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
265  {
266  wxLogTrace(
267  traceSettings, "Warning: could not remove legacy file %s", path.GetFullPath() );
268  }
269 
270  // And write-out immediately so that we don't lose data if the program later crashes.
271  SaveToFile( aDirectory );
272  }
273 
274  return success;
275 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
virtual wxString getLegacyFileExt() const
bool parse(std::istream &aStream, bool aVerbose)
Parse a PCB or footprint file from the given input stream.
wxString GetFullFilename() const
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
wxString m_filename
The filename (not including path) of this settings file (inicode)
virtual bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
virtual wxString getFileExt() const
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.

References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtualinherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Reimplemented in COMMON_SETTINGS, COLOR_SETTINGS, and FOOTPRINT_EDITOR_SETTINGS.

Definition at line 409 of file json_settings.cpp.

410 {
411  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
412  return false;
413 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ MigrateFromLegacy()

bool PROJECT_FILE::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented from JSON_SETTINGS.

Definition at line 202 of file project_file.cpp.

203 {
204  bool ret = true;
205  wxString str;
206  long index = 0;
207 
208  std::set<wxString> group_blacklist;
209 
210  // Legacy files don't store board info; they assume board matches project name
211  // We will leave m_boards empty here so it can be populated with other code
212 
213  // First handle migration of data that will be stored locally in this object
214 
215  auto loadPinnedLibs =
216  [&]( const std::string& aDest )
217  {
218  int libIndex = 1;
219  wxString libKey = wxT( "PinnedItems" );
220  libKey << libIndex;
221 
222  nlohmann::json libs = nlohmann::json::array();
223 
224  while( aCfg->Read( libKey, &str ) )
225  {
226  libs.push_back( str );
227 
228  aCfg->DeleteEntry( libKey, true );
229 
230  libKey = wxT( "PinnedItems" );
231  libKey << ++libIndex;
232  }
233 
234  ( *this )[PointerFromString( aDest )] = libs;
235  };
236 
237  aCfg->SetPath( wxT( "/LibeditFrame" ) );
238  loadPinnedLibs( "libraries.pinned_symbol_libs" );
239 
240  aCfg->SetPath( wxT( "/ModEditFrame" ) );
241  loadPinnedLibs( "libraries.pinned_footprint_libs" );
242 
243  aCfg->SetPath( wxT( "/cvpcb/equfiles" ) );
244 
245  {
246  int eqIdx = 1;
247  wxString eqKey = wxT( "EquName" );
248  eqKey << eqIdx;
249 
250  nlohmann::json eqs = nlohmann::json::array();
251 
252  while( aCfg->Read( eqKey, &str ) )
253  {
254  eqs.push_back( str );
255 
256  eqKey = wxT( "EquName" );
257  eqKey << ++eqIdx;
258  }
259 
260  ( *this )[PointerFromString( "cvpcb.equivalence_files" )] = eqs;
261  }
262 
263  // All CvPcb params that we want to keep have been migrated above
264  group_blacklist.insert( wxT( "/cvpcb" ) );
265 
266  aCfg->SetPath( wxT( "/eeschema" ) );
267  fromLegacyString( aCfg, "LibDir", "schematic.legacy_lib_dir" );
268 
269  aCfg->SetPath( wxT( "/eeschema/libraries" ) );
270 
271  {
272  int libIdx = 1;
273  wxString libKey = wxT( "LibName" );
274  libKey << libIdx;
275 
276  nlohmann::json libs = nlohmann::json::array();
277 
278  while( aCfg->Read( libKey, &str ) )
279  {
280  libs.push_back( str );
281 
282  libKey = wxT( "LibName" );
283  libKey << ++libIdx;
284  }
285 
286  ( *this )[PointerFromString( "schematic.legacy_lib_list" )] = libs;
287  }
288 
289  group_blacklist.insert( wxT( "/eeschema" ) );
290 
291  aCfg->SetPath( wxT( "/text_variables" ) );
292 
293  {
294  int txtIdx = 1;
295  wxString txtKey;
296  txtKey << txtIdx;
297 
299 
300  while( aCfg->Read( txtKey, &str ) )
301  {
302  wxArrayString tokens = wxSplit( str, ':' );
303 
304  if( tokens.size() == 2 )
305  vars[ tokens[0].ToStdString() ] = tokens[1];
306 
307  txtKey.clear();
308  txtKey << ++txtIdx;
309  }
310 
311  ( *this )[PointerFromString( "text_variables" )] = vars;
312  }
313 
314  group_blacklist.insert( wxT( "/text_variables" ) );
315 
316  aCfg->SetPath( wxT( "/schematic_editor" ) );
317 
318  fromLegacyString( aCfg, "PageLayoutDescrFile", "schematic.page_layout_descr_file" );
319  fromLegacyString( aCfg, "PlotDirectoryName", "schematic.plot_directory" );
320  fromLegacyString( aCfg, "NetFmtName", "schematic.net_format_name" );
321  fromLegacy<bool>( aCfg, "SpiceAjustPassiveValues", "schematic.spice_adjust_passive_values" );
322  fromLegacy<int>( aCfg, "SubpartIdSeparator", "schematic.subpart_id_separator" );
323  fromLegacy<int>( aCfg, "SubpartFirstId", "schematic.subpart_first_id" );
324 
325  fromLegacy<int>( aCfg, "LineThickness", "schematic.drawing.default_line_thickness" );
326  fromLegacy<int>( aCfg, "WireThickness", "schematic.drawing.default_wire_thickness" );
327  fromLegacy<int>( aCfg, "BusThickness", "schematic.drawing.default_bus_thickness" );
328  fromLegacy<int>( aCfg, "LabSize", "schematic.drawing.default_text_size" );
329  fromLegacy<int>( aCfg, "PinSymbolSize", "schematic.drawing.pin_symbol_size" );
330  fromLegacy<int>( aCfg, "JunctionSize", "schematic.drawing.default_junction_size" );
331 
332  fromLegacyString( aCfg, "FieldNameTemplates", "schematic.drawing.field_names" );
333  fromLegacy<double>( aCfg, "TextOffsetRatio", "schematic.drawing.text_offset_ratio" );
334 
335  // All schematic_editor keys we keep are migrated above
336  group_blacklist.insert( wxT( "/schematic_editor" ) );
337 
338  aCfg->SetPath( wxT( "/pcbnew" ) );
339 
340  fromLegacyString( aCfg, "PageLayoutDescrFile", "pcbnew.page_layout_descr_file" );
341  fromLegacyString( aCfg, "LastNetListRead", "pcbnew.last_paths.netlist" );
342  fromLegacyString( aCfg, "LastSTEPExportPath", "pcbnew.last_paths.step" );
343  fromLegacyString( aCfg, "LastIDFExportPath", "pcbnew.last_paths.idf" );
344  fromLegacyString( aCfg, "LastVRMLExportPath", "pcbnew.last_paths.vmrl" );
345  fromLegacyString( aCfg, "LastSpecctraDSNExportPath", "pcbnew.last_paths.specctra_dsn" );
346  fromLegacyString( aCfg, "LastGenCADExportPath", "pcbnew.last_paths.gencad" );
347 
348  std::string bp = "board.design_settings.";
349 
350  {
351  int idx = 1;
352  wxString key = wxT( "DRCExclusion" );
353  key << idx;
354 
355  nlohmann::json exclusions = nlohmann::json::array();
356 
357  while( aCfg->Read( key, &str ) )
358  {
359  exclusions.push_back( str );
360 
361  key = wxT( "DRCExclusion" );
362  key << ++idx;
363  }
364 
365  ( *this )[PointerFromString( bp + "drc_exclusions" )] = exclusions;
366  }
367 
368  fromLegacy<bool>( aCfg, "AllowMicroVias", bp + "rules.allow_microvias" );
369  fromLegacy<bool>( aCfg, "AllowBlindVias", bp + "rules.allow_blind_buried_vias" );
370  fromLegacy<double>( aCfg, "MinClearance", bp + "rules.min_clearance" );
371  fromLegacy<double>( aCfg, "MinTrackWidth", bp + "rules.min_track_width" );
372  fromLegacy<double>( aCfg, "MinViaAnnulus", bp + "rules.min_via_annulus" );
373  fromLegacy<double>( aCfg, "MinViaDiameter", bp + "rules.min_via_diameter" );
374 
375  if( !fromLegacy<double>( aCfg, "MinThroughDrill", bp + "rules.min_through_hole_diameter" ) )
376  fromLegacy<double>( aCfg, "MinViaDrill", bp + "rules.min_through_hole_diameter" );
377 
378  fromLegacy<double>( aCfg, "MinMicroViaDiameter", bp + "rules.min_microvia_diameter" );
379  fromLegacy<double>( aCfg, "MinMicroViaDrill", bp + "rules.min_microvia_drill" );
380  fromLegacy<double>( aCfg, "MinHoleToHole", bp + "rules.min_hole_to_hole" );
381  fromLegacy<double>( aCfg, "CopperEdgeClearance", bp + "rules.min_copper_edge_clearance" );
382  fromLegacy<double>( aCfg, "SolderMaskClearance", bp + "rules.solder_mask_clearance" );
383  fromLegacy<double>( aCfg, "SolderMaskMinWidth", bp + "rules.solder_mask_min_width" );
384  fromLegacy<double>( aCfg, "SolderPasteClearance", bp + "rules.solder_paste_clearance" );
385  fromLegacy<double>( aCfg, "SolderPasteRatio", bp + "rules.solder_paste_margin_ratio" );
386 
387  if( !fromLegacy<double>( aCfg, "SilkLineWidth", bp + "defaults.silk_line_width" ) )
388  fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.silk_line_width" );
389 
390  if( !fromLegacy<double>( aCfg, "SilkTextSizeV", bp + "defaults.silk_text_size_v" ) )
391  fromLegacy<double>( aCfg, "ModuleTextSizeV", bp + "defaults.silk_text_size_v" );
392 
393  if( !fromLegacy<double>( aCfg, "SilkTextSizeH", bp + "defaults.silk_text_size_h" ) )
394  fromLegacy<double>( aCfg, "ModuleTextSizeH", bp + "defaults.silk_text_size_h" );
395 
396  if( !fromLegacy<double>( aCfg, "SilkTextSizeThickness", bp + "defaults.silk_text_thickness" ) )
397  fromLegacy<double>( aCfg, "ModuleTextSizeThickness", bp + "defaults.silk_text_thickness" );
398 
399  fromLegacy<bool>( aCfg, "SilkTextItalic", bp + "defaults.silk_text_italic" );
400  fromLegacy<bool>( aCfg, "SilkTextUpright", bp + "defaults.silk_text_upright" );
401 
402  if( !fromLegacy<double>( aCfg, "CopperLineWidth", bp + "defaults.copper_line_width" ) )
403  fromLegacy<double>( aCfg, "DrawSegmentWidth", bp + "defaults.copper_line_width" );
404 
405  if( !fromLegacy<double>( aCfg, "CopperTextSizeV", bp + "defaults.copper_text_size_v" ) )
406  fromLegacy<double>( aCfg, "PcbTextSizeV", bp + "defaults.copper_text_size_v" );
407 
408  if( !fromLegacy<double>( aCfg, "CopperTextSizeH", bp + "defaults.copper_text_size_h" ) )
409  fromLegacy<double>( aCfg, "PcbTextSizeH", bp + "defaults.copper_text_size_h" );
410 
411  if( !fromLegacy<double>( aCfg, "CopperTextThickness", bp + "defaults.copper_text_thickness" ) )
412  fromLegacy<double>( aCfg, "PcbTextThickness", bp + "defaults.copper_text_thickness" );
413 
414  fromLegacy<bool>( aCfg, "CopperTextItalic", bp + "defaults.copper_text_italic" );
415  fromLegacy<bool>( aCfg, "CopperTextUpright", bp + "defaults.copper_text_upright" );
416 
417  if( !fromLegacy<double>( aCfg, "EdgeCutLineWidth", bp + "defaults.board_outline_line_width" ) )
418  fromLegacy<double>(
419  aCfg, "BoardOutlineThickness", bp + "defaults.board_outline_line_width" );
420 
421  fromLegacy<double>( aCfg, "CourtyardLineWidth", bp + "defaults.courtyard_line_width" );
422 
423  fromLegacy<double>( aCfg, "FabLineWidth", bp + "defaults.fab_line_width" );
424  fromLegacy<double>( aCfg, "FabTextSizeV", bp + "defaults.fab_text_size_v" );
425  fromLegacy<double>( aCfg, "FabTextSizeH", bp + "defaults.fab_text_size_h" );
426  fromLegacy<double>( aCfg, "FabTextSizeThickness", bp + "defaults.fab_text_thickness" );
427  fromLegacy<bool>( aCfg, "FabTextItalic", bp + "defaults.fab_text_italic" );
428  fromLegacy<bool>( aCfg, "FabTextUpright", bp + "defaults.fab_text_upright" );
429 
430  if( !fromLegacy<double>( aCfg, "OthersLineWidth", bp + "defaults.other_line_width" ) )
431  fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.other_line_width" );
432 
433  fromLegacy<double>( aCfg, "OthersTextSizeV", bp + "defaults.other_text_size_v" );
434  fromLegacy<double>( aCfg, "OthersTextSizeH", bp + "defaults.other_text_size_h" );
435  fromLegacy<double>( aCfg, "OthersTextSizeThickness", bp + "defaults.other_text_thickness" );
436  fromLegacy<bool>( aCfg, "OthersTextItalic", bp + "defaults.other_text_italic" );
437  fromLegacy<bool>( aCfg, "OthersTextUpright", bp + "defaults.other_text_upright" );
438 
439  fromLegacy<int>( aCfg, "DimensionUnits", bp + "defaults.dimension_units" );
440  fromLegacy<int>( aCfg, "DimensionPrecision", bp + "defaults.dimension_precision" );
441 
442  std::string sev = bp + "rule_severities";
443 
444  fromLegacy<bool>(
445  aCfg, "RequireCourtyardDefinitions", sev + "legacy_no_courtyard_defined" );
446 
447  fromLegacy<bool>( aCfg, "ProhibitOverlappingCourtyards", sev + "legacy_courtyards_overlap" );
448 
449  {
450  int idx = 1;
451  wxString keyBase = "TrackWidth";
452  wxString key = keyBase;
453  double val;
454 
455  nlohmann::json widths = nlohmann::json::array();
456 
457  key << idx;
458 
459  while( aCfg->Read( key, &val ) )
460  {
461  widths.push_back( val );
462  key = keyBase;
463  key << ++idx;
464  }
465 
466  ( *this )[PointerFromString( bp + "track_widths" )] = widths;
467  }
468 
469  {
470  int idx = 1;
471  wxString keyBase = "ViaDiameter";
472  wxString key = keyBase;
473  double diameter;
474  double drill = 1.0;
475 
476  nlohmann::json vias = nlohmann::json::array();
477 
478  key << idx;
479 
480  while( aCfg->Read( key, &diameter ) )
481  {
482  key = "ViaDrill";
483  aCfg->Read( key << idx, &drill );
484 
485  nlohmann::json via = { { "diameter", diameter }, { "drill", drill } };
486  vias.push_back( via );
487 
488  key = keyBase;
489  key << ++idx;
490  }
491 
492  ( *this )[PointerFromString( bp + "via_dimensions" )] = vias;
493  }
494 
495  {
496  int idx = 1;
497  wxString keyBase = "dPairWidth";
498  wxString key = keyBase;
499  double width;
500  double gap = 1.0;
501  double via_gap = 1.0;
502 
503  nlohmann::json pairs = nlohmann::json::array();
504 
505  key << idx;
506 
507  while( aCfg->Read( key, &width ) )
508  {
509  key = "dPairGap";
510  aCfg->Read( key << idx, &gap );
511 
512  key = "dPairViaGap";
513  aCfg->Read( key << idx, &via_gap );
514 
515  nlohmann::json pair = { { "width", width }, { "gap", gap }, { "via_gap", via_gap } };
516  pairs.push_back( pair );
517 
518  key = keyBase;
519  key << ++idx;
520  }
521 
522  ( *this )[PointerFromString( bp + "diff_pair_dimensions" )] = pairs;
523  }
524 
525  group_blacklist.insert( wxT( "/pcbnew" ) );
526 
527  // General group is unused these days, we can throw it away
528  group_blacklist.insert( wxT( "/general" ) );
529 
530  // Next load sheet names and put all other legacy data in the legacy dict
531  aCfg->SetPath( wxT( "/" ) );
532 
533  auto loadSheetNames =
534  [&]() -> bool
535  {
536  int sheet = 1;
537  wxString entry;
538  nlohmann::json arr = nlohmann::json::array();
539 
540  wxLogTrace( traceSettings, "Migrating sheet names" );
541 
542  aCfg->SetPath( wxT( "/sheetnames" ) );
543 
544  while( aCfg->Read( wxString::Format( "%d", sheet++ ), &entry ) )
545  {
546  wxArrayString tokens = wxSplit( entry, ':' );
547 
548  if( tokens.size() == 2 )
549  {
550  wxLogTrace( traceSettings, "%d: %s = %s", sheet, tokens[0], tokens[1] );
551  arr.push_back( nlohmann::json::array( { tokens[0], tokens[1] } ) );
552  }
553  }
554 
555  ( *this )[PointerFromString( "sheets" )] = arr;
556 
557  aCfg->SetPath( "/" );
558 
559  // TODO: any reason we want to fail on this?
560  return true;
561  };
562 
563  std::vector<wxString> groups;
564 
565  groups.emplace_back( "" );
566 
567  auto loadLegacyPairs =
568  [&]( const std::string& aGroup ) -> bool
569  {
570  wxLogTrace( traceSettings, "Migrating group %s", aGroup );
571  bool success = true;
572  wxString keyStr;
573  wxString val;
574 
575  index = 0;
576 
577  while( aCfg->GetNextEntry( keyStr, index ) )
578  {
579  if( !aCfg->Read( keyStr, &val ) )
580  continue;
581 
582  std::string key( keyStr.ToUTF8() );
583 
584  wxLogTrace( traceSettings, " %s = %s", key, val );
585 
586  try
587  {
588  nlohmann::json::json_pointer ptr( "/legacy" + aGroup + "/" + key );
589  ( *this )[ptr] = val;
590  }
591  catch( ... )
592  {
593  success = false;
594  }
595  }
596 
597  return success;
598  };
599 
600  for( size_t i = 0; i < groups.size(); i++ )
601  {
602  aCfg->SetPath( groups[i] );
603 
604  if( groups[i] == wxT( "/sheetnames" ) )
605  {
606  ret |= loadSheetNames();
607  continue;
608  }
609 
610  aCfg->DeleteEntry( wxT( "last_client" ), true );
611  aCfg->DeleteEntry( wxT( "update" ), true );
612  aCfg->DeleteEntry( wxT( "version" ), true );
613 
614  ret &= loadLegacyPairs( groups[i].ToStdString() );
615 
616  index = 0;
617 
618  while( aCfg->GetNextGroup( str, index ) )
619  {
620  wxString group = groups[i] + "/" + str;
621 
622  if( !group_blacklist.count( group ) )
623  groups.emplace_back( group );
624  }
625 
626  aCfg->SetPath( "/" );
627  }
628 
629  return ret;
630 }
nlohmann::json json
Definition: gerbview.cpp:40
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
const char * traceSettings
Flag to enable settings tracing.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References Format(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::PointerFromString(), and traceSettings.

◆ NetSettings()

NET_SETTINGS& PROJECT_FILE::NetSettings ( )
inline

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string  aPath)
staticinherited

Builds a JSON pointer based on a given string.

Parameters
aPathis the path in the form "key1.key2.key3"
Returns
a JSON pointer that can be used to index into a JSON object

Definition at line 424 of file json_settings.cpp.

425 {
426  std::replace( aPath.begin(), aPath.end(), '.', '/' );
427  aPath.insert( 0, "/" );
428 
429  nlohmann::json::json_pointer p;
430 
431  try
432  {
433  p = nlohmann::json::json_pointer( aPath );
434  }
435  catch( ... )
436  {
437  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
438  }
439 
440  return p;
441 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), FOOTPRINT_EDITOR_SETTINGS::Migrate(), COLOR_SETTINGS::Migrate(), COMMON_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SaveToFile(), and JSON_SETTINGS::Set().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 540 of file json_settings.cpp.

541 {
542  if( !aSettings )
543  return;
544 
545  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
546  [&aSettings]( const JSON_SETTINGS* aPtr ) {
547  return aPtr == aSettings;
548  } );
549 
550  if( it != m_nested_settings.end() )
551  {
552  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
553  ( *it )->SaveToFile();
554  m_nested_settings.erase( it );
555  }
556 
557  aSettings->SetParent( nullptr );
558 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
void SetParent(JSON_SETTINGS *aParent)

References JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOARD::ClearProject(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 292 of file json_settings.cpp.

293 {
294  for( auto param : m_params )
295  param->SetDefault();
296 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveToFile()

bool PROJECT_FILE::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
overridevirtual
   Calls Store() and then writes the contents of the JSON document to a file
   @param aDirectory is the directory to save to, including trailing separator

c *

Returns
true if the file was saved

Reimplemented from JSON_SETTINGS.

Definition at line 633 of file project_file.cpp.

634 {
635  wxASSERT( m_project );
636 
637  ( *this )[PointerFromString( "meta.filename" )] =
639 
640  return JSON_SETTINGS::SaveToFile( aDirectory, aForce );
641 }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:111
const std::string ProjectFileExtension
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
VTBL_ENTRY const wxString GetProjectName() const
Function GetProjectName returns the short name of the project.
Definition: project.cpp:129
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References PROJECT::GetProjectName(), m_project, JSON_SETTINGS::PointerFromString(), ProjectFileExtension, and JSON_SETTINGS::SaveToFile().

Referenced by SETTINGS_MANAGER::SaveProject().

◆ Set() [1/3]

template<typename ValueType >
void JSON_SETTINGS::Set ( const std::string &  aPath,
ValueType  aVal 
)
inlineinherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 135 of file json_settings.h.

136  {
137  ( *this )[PointerFromString( aPath ) ] = aVal;
138  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

◆ Set() [3/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

Definition at line 572 of file json_settings.cpp.

573 {
574  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
575 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename)
inlineinherited

Definition at line 62 of file json_settings.h.

62 { m_legacy_filename = aFilename; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 175 of file json_settings.h.

176  {
177  m_manager = aManager;
178  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetProject()

void PROJECT_FILE::SetProject ( PROJECT aProject)
inline

Definition at line 77 of file project_file.h.

78  {
79  m_project = aProject;
80  }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:111

References m_project.

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document was updated

Definition at line 278 of file json_settings.cpp.

279 {
280  bool modified = false;
281 
282  for( auto param : m_params )
283  {
284  modified |= !param->MatchesFile( this );
285  param->Store( this );
286  }
287 
288  return modified;
289 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by PANEL_MODEDIT_COLOR_SETTINGS::PANEL_MODEDIT_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_BoardPageLayoutDescrFile

wxString PROJECT_FILE::m_BoardPageLayoutDescrFile

PcbNew params.

Page layout description file

Definition at line 168 of file project_file.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_boards

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_boards
private

A list of board files in this project.

Definition at line 108 of file project_file.h.

Referenced by GetBoards(), and PROJECT_FILE().

◆ m_BoardSettings

BOARD_DESIGN_SETTINGS* PROJECT_FILE::m_BoardSettings

Board design settings for this project's board.

This will be initialized by PcbNew after loading a board so that BOARD_DESIGN_SETTINGS doesn't need to live in common for now. Owned by the BOARD; may be null if a board isn't loaded: be careful

Definition at line 178 of file project_file.h.

Referenced by BOARD::ClearProject(), and BOARD::SetProject().

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 249 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 243 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 255 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and PROJECT_FILE().

◆ m_EquivalenceFiles

std::vector<wxString> PROJECT_FILE::m_EquivalenceFiles

CvPcb params.

List of equivalence (equ) files used in the project

Definition at line 161 of file project_file.h.

Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DIALOG_CONFIG_EQUFILES::Init(), DIALOG_CONFIG_EQUFILES::OnOkClick(), and PROJECT_FILE().

◆ m_ErcSettings

ERC_SETTINGS* PROJECT_FILE::m_ErcSettings

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

◆ m_LayerPresets

std::vector<LAYER_PRESET> PROJECT_FILE::m_LayerPresets

List of stored layer presets.

Definition at line 189 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 231 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SetLegacyFilename().

◆ m_LegacyLibDir

wxString PROJECT_FILE::m_LegacyLibDir

Definition at line 152 of file project_file.h.

Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().

◆ m_LegacyLibNames

wxArrayString PROJECT_FILE::m_LegacyLibNames

Definition at line 154 of file project_file.h.

Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 234 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 264 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::SetManager().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 240 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().

◆ m_NetSettings

std::shared_ptr<NET_SETTINGS> PROJECT_FILE::m_NetSettings

Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board.

Right now I think global makes more sense (one set of schematics, one netlist partitioned into multiple boards)

Definition at line 186 of file project_file.h.

Referenced by NetSettings(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), PROJECT_FILE(), and BOARD::SynchronizeNetsAndNetClasses().

◆ m_params

◆ m_PcbLastPath

wxString PROJECT_FILE::m_PcbLastPath[LAST_PATH_SIZE]

MRU path storage.

Definition at line 171 of file project_file.h.

Referenced by PCB_EDIT_FRAME::GetLastPath(), PROJECT_FILE(), and PCB_EDIT_FRAME::SetLastPath().

◆ m_PinnedFootprintLibs

std::vector<wxString> PROJECT_FILE::m_PinnedFootprintLibs

The list of pinned footprint libraries.

Definition at line 126 of file project_file.h.

Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().

◆ m_PinnedSymbolLibs

std::vector<wxString> PROJECT_FILE::m_PinnedSymbolLibs

Below are project-level settings that have not been moved to a dedicated file.

Shared params, used by more than one applicationThe list of pinned symbol libraries

Definition at line 123 of file project_file.h.

Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths
protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 267 of file json_settings.h.

◆ m_project

PROJECT* PROJECT_FILE::m_project
private

A link to the owning PROJECT.

Definition at line 111 of file project_file.h.

Referenced by SaveToFile(), and SetProject().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 258 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_SchematicSettings

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_sheets

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_sheets
private

An list of schematic sheets in this project.

Definition at line 105 of file project_file.h.

Referenced by GetSheets(), and PROJECT_FILE().

◆ m_TemplateFieldNames

TEMPLATES* PROJECT_FILE::m_TemplateFieldNames

A pointer to the template fieldnames object owned by the parent SCH_BASE_FRAME.

Note that this coupling is unfortunate; but the TEMPLATES object has to outlive any SCHEMATIC_SETTINGS object because it holds both global and project field names. This will be null if the project is opened outside a SCH_BASE_FRAME. It is placed here instead of in SCHEMATIC_SETTINGS because SCHEMATIC_SETTINGS objects are created and destroyed when schematics are loaded, and it's inconvenient to make sure this pointer is set early so that load of the SCHEMATIC_SETTINGS works.

Definition at line 149 of file project_file.h.

Referenced by SCHEMATIC::SetProject(), and SCHEMATIC::SetTemplateFieldNames().

◆ m_TextVars

std::map<wxString, wxString> PROJECT_FILE::m_TextVars

Definition at line 128 of file project_file.h.

Referenced by PROJECT::GetTextVars(), and PROJECT_FILE().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 252 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().


The documentation for this class was generated from the following files: