KiCad PCB EDA Suite
JSON_SETTINGS Class Reference

#include <json_settings.h>

Inheritance diagram for JSON_SETTINGS:
APP_SETTINGS_BASE COLOR_SETTINGS COMMON_SETTINGS NESTED_SETTINGS PROJECT_FILE PROJECT_LOCAL_SETTINGS BITMAP2CMP_SETTINGS CVPCB_SETTINGS EDA_3D_VIEWER_SETTINGS EESCHEMA_SETTINGS FOOTPRINT_EDITOR_SETTINGS GERBVIEW_SETTINGS KICAD_SETTINGS LIBEDIT_SETTINGS PCB_CALCULATOR_SETTINGS PCBNEW_SETTINGS PL_EDITOR_SETTINGS BOARD_DESIGN_SETTINGS ERC_SETTINGS NET_SETTINGS PNS::ROUTING_SETTINGS SCHEMATIC_SETTINGS

Public Member Functions

 JSON_SETTINGS (const std::string &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
 
 JSON_SETTINGS (const std::string &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion, bool aCreateIfMissing, bool aCreateIfDefault, bool aWriteFile)
 
virtual ~JSON_SETTINGS ()
 
std::string GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const std::string &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 std::string &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const std::string &aDirectory="", bool aForce=false)
 
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<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...
 
virtual bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig)
 Migrates from wxConfig to JSON-based configuration. 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)
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 

Static Public Member Functions

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

Protected Member Functions

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...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

std::string m_filename
 The filename (not including path) of this settings file. More...
 
std::string 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...
 

Detailed Description

Definition at line 45 of file json_settings.h.

Constructor & Destructor Documentation

◆ JSON_SETTINGS() [1/2]

JSON_SETTINGS::JSON_SETTINGS ( const std::string &  aFilename,
SETTINGS_LOC  aLocation,
int  aSchemaVersion 
)
inline

Definition at line 48 of file json_settings.h.

48  :
49  JSON_SETTINGS( aFilename, aLocation, aSchemaVersion, true, true, true ) {}
JSON_SETTINGS(const std::string &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:48

◆ JSON_SETTINGS() [2/2]

JSON_SETTINGS::JSON_SETTINGS ( const std::string &  aFilename,
SETTINGS_LOC  aLocation,
int  aSchemaVersion,
bool  aCreateIfMissing,
bool  aCreateIfDefault,
bool  aWriteFile 
)

Definition at line 38 of file json_settings.cpp.

40  :
42  m_filename( aFilename ),
43  m_legacy_filename( "" ),
44  m_location( aLocation ),
45  m_createIfMissing( aCreateIfMissing ),
46  m_createIfDefault( aCreateIfDefault ),
47  m_writeFile( aWriteFile ),
49  m_resetParamsIfMissing( true ),
50  m_schemaVersion( aSchemaVersion ),
51  m_manager( nullptr )
52 {
53  ( *this )[PointerFromString( "meta.filename" )] = GetFullFilename();
54 
55  m_params.emplace_back(
56  new PARAM<int>( "meta.version", &m_schemaVersion, m_schemaVersion, true ) );
57 }
std::string m_filename
The filename (not including path) of this settings file.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
nlohmann::json json
Definition: gerbview.cpp:40
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
std::string m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)
SETTINGS_LOC m_location
The location of this settings file (.
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.
bool m_writeFile
Whether or not the backing store file should be written.

References GetFullFilename(), m_params, m_schemaVersion, and PointerFromString().

◆ ~JSON_SETTINGS()

JSON_SETTINGS::~JSON_SETTINGS ( )
virtual

Definition at line 60 of file json_settings.cpp.

61 {
62  for( auto param: m_params )
63  delete param;
64 
65  m_params.clear();
66 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References m_params.

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)

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 501 of file json_settings.cpp.

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

References GetFilename(), 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 
)
protected

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 413 of file json_settings.cpp.

415 {
416  ValueType val;
417 
418  if( aConfig->Read( aKey, &val ) )
419  {
420  try
421  {
422  ( *this )[PointerFromString( aDest )] = val;
423  }
424  catch( ... )
425  {
426  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
427  return false;
428  }
429 
430  return true;
431  }
432 
433  return false;
434 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References PointerFromString().

◆ fromLegacyColor()

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

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 473 of file json_settings.cpp.

475 {
476  wxString str;
477 
478  if( aConfig->Read( aKey, &str ) )
479  {
481  color.SetFromWxString( str );
482 
483  try
484  {
485  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
486  ( *this )[PointerFromString( aDest )] = js;
487  }
488  catch( ... )
489  {
490  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
491  return false;
492  }
493 
494  return true;
495  }
496 
497  return false;
498 }
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 PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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 449 of file json_settings.cpp.

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

References PointerFromString().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), LIBEDIT_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::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
inline

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 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

Definition at line 531 of file json_settings.cpp.

532 {
533  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
534  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
535 
536  return NULLOPT;
537 }
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 GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtual

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 217 of file json_settings.h.

218  {
219  return wxT( "json" );
220  }

Referenced by GetFullFilename(), LoadFromFile(), and SaveToFile().

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

Definition at line 69 of file json_settings.cpp.

70 {
71  return wxString( m_filename.c_str(), wxConvUTF8 ) + "." + getFileExt();
72 }
std::string m_filename
The filename (not including path) of this settings file.
virtual wxString getFileExt() const

References getFileExt(), and m_filename.

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

◆ GetJson()

OPT< nlohmann::json > JSON_SETTINGS::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.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 358 of file json_settings.cpp.

359 {
360  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
361 
362  if( this->contains( ptr ) )
363  {
364  try
365  {
366  return OPT<nlohmann::json>{ this->at( ptr ) };
367  }
368  catch( ... )
369  {
370  }
371  }
372 
373  return OPT<nlohmann::json>{};
374 }
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 PointerFromString().

Referenced by 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()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtual

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 222 of file json_settings.h.

223  {
224  return wxEmptyString;
225  }

Referenced by LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inline

Definition at line 60 of file json_settings.h.

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

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Load()

void JSON_SETTINGS::Load ( )
virtual

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

Definition at line 75 of file json_settings.cpp.

76 {
77  for( auto param : m_params )
78  {
79  try
80  {
81  param->Load( this, m_resetParamsIfMissing );
82  }
83  catch( ... )
84  {
85  // Skip unreadable parameters in file:
86 #ifdef DEBUG
87  wxLogMessage( wxString::Format( "param '%s' load err", param->GetJsonPath().c_str() ) );
88 #endif
89  }
90  }
91 }
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(), m_params, and m_resetParamsIfMissing.

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

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const std::string &  aDirectory = "")
virtual

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 94 of file json_settings.cpp.

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtual

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 377 of file json_settings.cpp.

378 {
379  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
380  return false;
381 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by LoadFromFile().

◆ MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
virtual

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 in PCBNEW_SETTINGS, EESCHEMA_SETTINGS, APP_SETTINGS_BASE, PCB_CALCULATOR_SETTINGS, COMMON_SETTINGS, EDA_3D_VIEWER_SETTINGS, COLOR_SETTINGS, PROJECT_FILE, LIBEDIT_SETTINGS, PROJECT_LOCAL_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 384 of file json_settings.cpp.

385 {
386  wxLogTrace( traceSettings,
387  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
388  return false;
389 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by LoadFromFile().

◆ PointerFromString()

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

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 392 of file json_settings.cpp.

393 {
394  std::replace( aPath.begin(), aPath.end(), '.', '/' );
395  aPath.insert( 0, "/" );
396 
397  nlohmann::json::json_pointer p;
398 
399  try
400  {
401  p = nlohmann::json::json_pointer( aPath );
402  }
403  catch( ... )
404  {
405  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
406  }
407 
408  return p;
409 }

Referenced by fromLegacy(), fromLegacyColor(), fromLegacyString(), GetJson(), JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), 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(), PROJECT_FILE::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(), PROJECT_FILE::SaveToFile(), and Set().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)

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 508 of file json_settings.cpp.

509 {
510  if( !aSettings )
511  return;
512 
513  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
514  [&aSettings]( const JSON_SETTINGS* aPtr ) {
515  return aPtr == aSettings;
516  } );
517 
518  if( it != m_nested_settings.end() )
519  {
520  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
521  ( *it )->SaveToFile();
522  m_nested_settings.erase( it );
523  }
524 
525  aSettings->SetParent( nullptr );
526 }
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 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 ( )

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 273 of file json_settings.cpp.

274 {
275  for( auto param : m_params )
276  param->SetDefault();
277 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions().

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const std::string &  aDirectory = "",
bool  aForce = false 
)
virtual
   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 in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 280 of file json_settings.cpp.

281 {
282  if( !m_writeFile )
283  return false;
284 
285  // Default PROJECT won't have a filename set
286  if( m_filename.empty() )
287  return false;
288 
289  wxFileName path;
290 
291  if( aDirectory.empty() )
292  {
293  path.Assign( m_filename );
294  path.SetExt( getFileExt() );
295  }
296  else
297  {
298  wxString dir( aDirectory.c_str(), wxConvUTF8 );
299  path.Assign( dir, m_filename, getFileExt() );
300  }
301 
302  if( !m_createIfMissing && !path.FileExists() )
303  {
304  wxLogTrace( traceSettings,
305  "File for %s doesn't exist and m_createIfMissing == false; not saving",
306  GetFullFilename() );
307  return false;
308  }
309 
310  bool modified = false;
311 
312  for( auto settings : m_nested_settings )
313  modified |= settings->SaveToFile();
314 
315  modified |= Store();
316 
317  if( !modified && !aForce && path.FileExists() )
318  {
319  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
320  return false;
321  }
322  else if( !modified && !aForce && !m_createIfDefault )
323  {
324  wxLogTrace( traceSettings,
325  "%s contents still default and m_createIfDefault == false; not saving",
326  GetFullFilename() );
327  return false;
328  }
329 
330  if( !path.DirExists() && !path.Mkdir() )
331  {
332  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
333  path.GetPath(), GetFullFilename() );
334  return false;
335  }
336 
337  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
338 
340 
341  try
342  {
343  std::ofstream file( path.GetFullPath().ToUTF8() );
344  file << std::setw( 2 ) << *this << std::endl;
345  }
346  catch( const std::exception& e )
347  {
348  wxLogTrace( traceSettings, "Warning: could not save %s: %s", GetFullFilename(), e.what() );
349  }
350  catch( ... )
351  {
352  }
353 
354  return true;
355 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
std::string m_filename
The filename (not including path) of this settings file.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
const char * traceSettings
Flag to enable settings tracing.
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

References dummy(), getFileExt(), GetFullFilename(), m_createIfDefault, m_createIfMissing, m_filename, m_nested_settings, m_writeFile, Store(), and traceSettings.

Referenced by LoadFromFile(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_LOCAL_SETTINGS::SaveToFile(), and PROJECT_FILE::SaveToFile().

◆ Set() [1/3]

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

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 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 
)

◆ Set() [3/3]

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

Definition at line 540 of file json_settings.cpp.

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

References PointerFromString().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const std::string &  aFilename)
inline

Definition at line 62 of file json_settings.h.

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

References m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inline

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 m_manager.

◆ Store()

bool JSON_SETTINGS::Store ( )
virtual

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 259 of file json_settings.cpp.

260 {
261  bool modified = false;
262 
263  for( auto param : m_params )
264  {
265  modified |= !param->MatchesFile( this );
266  param->Store( this );
267  }
268 
269  return modified;
270 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References m_params.

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

Member Data Documentation

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protected

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 SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protected

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 SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protected

Whether or not to delete legacy file after migration.

Definition at line 255 of file json_settings.h.

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

◆ m_filename

std::string JSON_SETTINGS::m_filename
protected

◆ m_legacy_filename

std::string JSON_SETTINGS::m_legacy_filename
protected

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

Definition at line 231 of file json_settings.h.

Referenced by LoadFromFile(), and SetLegacyFilename().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protected

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 234 of file json_settings.h.

Referenced by GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protected

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 SetManager().

◆ m_nested_settings

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

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

Definition at line 240 of file json_settings.h.

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

◆ m_params

◆ m_preserved_paths

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

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_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protected

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 Load().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protected

Version of this settings schema.

Definition at line 261 of file json_settings.h.

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

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protected

Whether or not the backing store file should be written.

Definition at line 252 of file json_settings.h.

Referenced by SaveToFile().


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