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 PCB_CALCULATOR_SETTINGS PCBNEW_SETTINGS PL_EDITOR_SETTINGS SYMBOL_EDITOR_SETTINGS BOARD_DESIGN_SETTINGS ERC_SETTINGS NET_SETTINGS PNS::ROUTING_SETTINGS SCHEMATIC_SETTINGS

Public Member Functions

 JSON_SETTINGS (const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
 
 JSON_SETTINGS (const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion, bool aCreateIfMissing, bool aCreateIfDefault, bool aWriteFile)
 
virtual ~JSON_SETTINGS ()
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
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...
 
virtual bool SaveToFile (const wxString &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...
 
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...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present. More...
 

Protected Member Functions

void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
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

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...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 

Detailed Description

Definition at line 53 of file json_settings.h.

Constructor & Destructor Documentation

◆ JSON_SETTINGS() [1/2]

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

Definition at line 56 of file json_settings.h.

56  :
57  JSON_SETTINGS( aFilename, aLocation, aSchemaVersion, true, true, true ) {}
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:56

◆ JSON_SETTINGS() [2/2]

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

Definition at line 41 of file json_settings.cpp.

43  :
45  m_filename( aFilename ),
46  m_legacy_filename( "" ),
47  m_location( aLocation ),
48  m_createIfMissing( aCreateIfMissing ),
49  m_createIfDefault( aCreateIfDefault ),
50  m_writeFile( aWriteFile ),
52  m_resetParamsIfMissing( true ),
53  m_schemaVersion( aSchemaVersion ),
54  m_manager( nullptr )
55 {
56  try
57  {
58  ( *this )[PointerFromString( "meta.filename" )] = GetFullFilename();
59  }
60  catch( ... )
61  {
62  wxLogTrace( traceSettings, "Error: Could not create filename field for %s",
63  GetFullFilename() );
64  }
65 
66 
67  m_params.emplace_back(
68  new PARAM<int>( "meta.version", &m_schemaVersion, m_schemaVersion, true ) );
69 }
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.
wxString m_filename
The filename (not including path) of this settings file (inicode)
wxString 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()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
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, PointerFromString(), and traceSettings.

◆ ~JSON_SETTINGS()

JSON_SETTINGS::~JSON_SETTINGS ( )
virtual

Definition at line 72 of file json_settings.cpp.

73 {
74  for( auto param: m_params )
75  delete param;
76 
77  m_params.clear();
78 }
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 659 of file json_settings.cpp.

660 {
661  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
662  m_nested_settings.push_back( aSettings );
663 }
wxString GetFilename() const
Definition: json_settings.h:64
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

573 {
574  ValueType val;
575 
576  if( aConfig->Read( aKey, &val ) )
577  {
578  try
579  {
580  ( *this )[PointerFromString( aDest )] = val;
581  }
582  catch( ... )
583  {
584  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
585  return false;
586  }
587 
588  return true;
589  }
590 
591  return false;
592 }
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 631 of file json_settings.cpp.

633 {
634  wxString str;
635 
636  if( aConfig->Read( aKey, &str ) )
637  {
639  color.SetFromWxString( str );
640 
641  try
642  {
643  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
644  ( *this )[PointerFromString( aDest )] = js;
645  }
646  catch( ... )
647  {
648  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
649  return false;
650  }
651 
652  return true;
653  }
654 
655  return false;
656 }
int color
Definition: DXF_plotter.cpp:60
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.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

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

609 {
610  wxString str;
611 
612  if( aConfig->Read( aKey, &str ) )
613  {
614  try
615  {
616  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
617  }
618  catch( ... )
619  {
620  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
621  return false;
622  }
623 
624  return true;
625  }
626 
627  return false;
628 }
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(), SYMBOL_EDITOR_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 124 of file json_settings.h.

125  {
126  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
127  {
128  try
129  {
130  return ret->get<ValueType>();
131  }
132  catch( ... )
133  {
134  }
135  }
136 
137  return NULLOPT;
138  }
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< nlohmann::json >::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< nlohmann::json >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 689 of file json_settings.cpp.

690 {
691  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
692  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
693 
694  return NULLOPT;
695 }
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 274 of file json_settings.h.

275  {
276  return wxT( "json" );
277  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

Definition at line 81 of file json_settings.cpp.

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

References getFileExt(), and m_filename.

Referenced by JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), 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 420 of file json_settings.cpp.

421 {
422  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
423 
424  if( this->contains( ptr ) )
425  {
426  try
427  {
428  return OPT<nlohmann::json>{ this->at( ptr ) };
429  }
430  catch( ... )
431  {
432  }
433  }
434 
435  return OPT<nlohmann::json>{};
436 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
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 alg::contains(), and PointerFromString().

Referenced by Get(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< nlohmann::json >::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 279 of file json_settings.h.

280  {
281  return wxEmptyString;
282  }

Referenced by LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inline

Definition at line 70 of file json_settings.h.

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

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inline

◆ Load()

void JSON_SETTINGS::Load ( )
virtual

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

Definition at line 87 of file json_settings.cpp.

88 {
89  for( auto param : m_params )
90  {
91  try
92  {
93  param->Load( this, m_resetParamsIfMissing );
94  }
95  catch( ... )
96  {
97  // Skip unreadable parameters in file
98  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
99  }
100  }
101 }
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()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References m_params, m_resetParamsIfMissing, and traceSettings.

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

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString &  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 104 of file json_settings.cpp.

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

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )

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

Definition at line 448 of file json_settings.cpp.

449 {
450  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
451 
452  while( filever < m_schemaVersion )
453  {
454  if( !m_migrators.count( filever ) )
455  {
456  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
457  typeid( *this ).name(), filever );
458  return false;
459  }
460 
461  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
462 
463  if( pair.second() )
464  {
465  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
466  filever, pair.first );
467  filever = pair.first;
468  ( *this )[PointerFromString( "meta.version" )] = filever;
469  }
470  else
471  {
472  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
473  typeid( *this ).name(), filever, pair.first );
474  return false;
475  }
476  }
477 
478  return true;
479 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
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.

References m_migrators, m_schemaVersion, PointerFromString(), and traceSettings.

Referenced by NESTED_SETTINGS::LoadFromFile(), and 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, PROJECT_FILE, COLOR_SETTINGS, PROJECT_LOCAL_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 482 of file json_settings.cpp.

483 {
484  wxLogTrace( traceSettings,
485  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
486  return false;
487 }
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

491 {
492  std::replace( aPath.begin(), aPath.end(), '.', '/' );
493  aPath.insert( 0, "/" );
494 
495  nlohmann::json::json_pointer p;
496 
497  try
498  {
499  p = nlohmann::json::json_pointer( aPath );
500  }
501  catch( ... )
502  {
503  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
504  }
505 
506  return p;
507 }

Referenced by fromLegacy(), fromLegacyColor(), fromLegacyString(), GetJson(), JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_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(), Set(), and SetIfPresent().

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int  aOldSchemaVersion,
int  aNewSchemaVersion,
std::function< bool(void)>  aMigrator 
)
protected

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 439 of file json_settings.cpp.

441 {
442  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
443  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
444  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
445 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

References m_migrators, and m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

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

667 {
668  if( !aSettings )
669  return;
670 
671  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
672  [&aSettings]( const JSON_SETTINGS* aPtr ) {
673  return aPtr == aSettings;
674  } );
675 
676  if( it != m_nested_settings.end() )
677  {
678  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
679  ( *it )->SaveToFile();
680  m_nested_settings.erase( it );
681  }
682 
683  aSettings->SetParent( nullptr );
684 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
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 313 of file json_settings.cpp.

314 {
315  for( auto param : m_params )
316  param->SetDefault();
317 }
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(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const wxString &  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 320 of file json_settings.cpp.

321 {
322  if( !m_writeFile )
323  return false;
324 
325  // Default PROJECT won't have a filename set
326  if( m_filename.IsEmpty() )
327  return false;
328 
329  wxFileName path;
330 
331  if( aDirectory.empty() )
332  {
333  path.Assign( m_filename );
334  path.SetExt( getFileExt() );
335  }
336  else
337  {
338  wxString dir( aDirectory );
339  path.Assign( dir, m_filename, getFileExt() );
340  }
341 
342  if( !m_createIfMissing && !path.FileExists() )
343  {
344  wxLogTrace( traceSettings,
345  "File for %s doesn't exist and m_createIfMissing == false; not saving",
346  GetFullFilename() );
347  return false;
348  }
349 
350  // Ensure the path exists, and create it if not.
351  if( !path.DirExists() && !path.Mkdir() )
352  {
353  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
354  path.GetPath(), GetFullFilename() );
355  return false;
356  }
357 
358  if( ( path.FileExists() && !path.IsFileWritable() ) ||
359  ( !path.FileExists() && !path.IsDirWritable() ) )
360  {
361  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
362  return false;
363  }
364 
365  bool modified = false;
366 
367  for( auto settings : m_nested_settings )
368  modified |= settings->SaveToFile();
369 
370  modified |= Store();
371 
372  if( !modified && !aForce && path.FileExists() )
373  {
374  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
375  return false;
376  }
377  else if( !modified && !aForce && !m_createIfDefault )
378  {
379  wxLogTrace( traceSettings,
380  "%s contents still default and m_createIfDefault == false; not saving",
381  GetFullFilename() );
382  return false;
383  }
384 
385  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
386 
388  bool success = true;
389 
390  try
391  {
392  std::stringstream buffer;
393  buffer << std::setw( 2 ) << *this << std::endl;
394 
395  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
396 
397  if( !fileStream.IsOk()
398  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
399  {
400  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
401  success = false;
402  }
403  }
404  catch( nlohmann::json::exception& error )
405  {
406  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
407  GetFullFilename(), error.what() );
408  success = false;
409  }
410  catch( ... )
411  {
412  wxLogTrace( traceSettings, "Error: could not save %s." );
413  success = false;
414  }
415 
416  return success;
417 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
wxString m_filename
The filename (not including path) of this settings file (inicode)
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.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
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(), PROJECT_FILE::SaveToFile(), and PGM_BASE::SetLanguage().

◆ 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 148 of file json_settings.h.

149  {
150  ( *this )[PointerFromString( aPath ) ] = aVal;
151  }
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< nlohmann::json >::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 698 of file json_settings.cpp.

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

References PointerFromString().

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename)
inline

Definition at line 68 of file json_settings.h.

68 { m_filename = aFilename; }
wxString m_filename
The filename (not including path) of this settings file (inicode)

References m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
wxString &  aTarget 
)
static

Sets the given string if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 510 of file json_settings.cpp.

512 {
513  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
514 
515  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
516  {
517  aTarget = aObj.at( ptr ).get<wxString>();
518  return true;
519  }
520 
521  return false;
522 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
bool &  aTarget 
)
static

Sets the given bool if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 525 of file json_settings.cpp.

527 {
528  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
529 
530  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
531  {
532  aTarget = aObj.at( ptr ).get<bool>();
533  return true;
534  }
535 
536  return false;
537 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
int &  aTarget 
)
static

Sets the given int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 540 of file json_settings.cpp.

542 {
543  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
544 
545  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
546  {
547  aTarget = aObj.at( ptr ).get<int>();
548  return true;
549  }
550 
551  return false;
552 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
unsigned int &  aTarget 
)
static

Sets the given unsigned int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 555 of file json_settings.cpp.

557 {
558  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
559 
560  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
561  {
562  aTarget = aObj.at( ptr ).get<unsigned int>();
563  return true;
564  }
565 
566  return false;
567 }
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 wxString &  aFilename)
inline

Definition at line 72 of file json_settings.h.

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

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inline

Definition at line 188 of file json_settings.h.

189  {
190  m_manager = aManager;
191  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inline

Definition at line 75 of file json_settings.h.

75 { m_writeFile = !aReadOnly; }
bool m_writeFile
Whether or not the backing store file should be written.

References m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

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

300 {
301  bool modified = false;
302 
303  for( auto param : m_params )
304  {
305  modified |= !param->MatchesFile( this );
306  param->Store( this );
307  }
308 
309  return modified;
310 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References m_params.

Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_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 306 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 300 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 312 of file json_settings.h.

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

◆ m_filename

wxString JSON_SETTINGS::m_filename
protected

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protected

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

Definition at line 288 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 291 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 321 of file json_settings.h.

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

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators
protected

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 327 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

◆ 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 297 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 324 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 315 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 318 of file json_settings.h.

Referenced by JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), LoadFromFile(), Migrate(), registerMigration(), 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 309 of file json_settings.h.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), LoadFromFile(), SaveToFile(), and SetReadOnly().


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