KiCad PCB EDA Suite
json_settings.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
5  * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software: you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation, either version 3 of the License, or (at your
10  * option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef _JSON_SETTINGS_H
22 #define _JSON_SETTINGS_H
23 
24 #include <nlohmann/json.hpp>
25 #include <utility>
26 #include <wx/string.h>
27 
28 #include <core/optional.h>
29 
30 class wxConfigBase;
31 class NESTED_SETTINGS;
32 class PARAM_BASE;
33 class SETTINGS_MANAGER;
34 
42 extern const wxChar* const traceSettings;
43 
44 enum class SETTINGS_LOC {
45  USER,
46  PROJECT,
47  COLORS,
48  NESTED,
49  NONE,
50 };
51 
52 
54 {
55 public:
56  JSON_SETTINGS( const wxString& aFilename, SETTINGS_LOC aLocation, int aSchemaVersion ) :
57  JSON_SETTINGS( aFilename, aLocation, aSchemaVersion, true, true, true ) {}
58 
59  JSON_SETTINGS( const wxString& aFilename, SETTINGS_LOC aLocation, int aSchemaVersion,
60  bool aCreateIfMissing, bool aCreateIfDefault, bool aWriteFile );
61 
62  virtual ~JSON_SETTINGS();
63 
64  wxString GetFilename() const { return m_filename; }
65 
66  wxString GetFullFilename() const;
67 
68  SETTINGS_LOC GetLocation() const { return m_location; }
69 
70  void SetLegacyFilename( const wxString& aFilename ) { m_legacy_filename = aFilename; }
71 
75  virtual void Load();
76 
82  virtual bool Store();
83 
89  virtual bool LoadFromFile( const wxString& aDirectory = "" );
90 
96  virtual bool SaveToFile( const wxString& aDirectory = "", bool aForce = false );
97 
101  void ResetToDefaults();
102 
109  OPT<nlohmann::json> GetJson( const std::string& aPath ) const;
110 
118  template<typename ValueType>
119  OPT<ValueType> Get( const std::string& aPath ) const
120  {
121  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
122  {
123  try
124  {
125  return ret->get<ValueType>();
126  }
127  catch( ... )
128  {
129  }
130  }
131 
132  return NULLOPT;
133  }
134 
142  template<typename ValueType>
143  void Set( const std::string& aPath, ValueType aVal )
144  {
145  ( *this )[PointerFromString( aPath ) ] = aVal;
146  }
147 
157  virtual bool Migrate();
158 
165  virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig );
166 
175  void AddNestedSettings( NESTED_SETTINGS* aSettings );
176 
181  void ReleaseNestedSettings( NESTED_SETTINGS* aSettings );
182 
183  void SetManager( SETTINGS_MANAGER* aManager )
184  {
185  m_manager = aManager;
186  }
187 
193  static nlohmann::json::json_pointer PointerFromString( std::string aPath );
194 
201  static bool SetIfPresent( const nlohmann::json& aObj, const std::string& aPath,
202  wxString& aTarget );
203 
210  static bool SetIfPresent( const nlohmann::json& aObj, const std::string& aPath, bool& aTarget );
211 
218  static bool SetIfPresent( const nlohmann::json& aObj, const std::string& aPath, int& aTarget );
219 
226  static bool SetIfPresent( const nlohmann::json& aObj, const std::string& aPath,
227  unsigned int& aTarget );
228 protected:
229 
237  template<typename ValueType>
238  bool fromLegacy( wxConfigBase* aConfig, const std::string& aKey, const std::string& aDest );
239 
246  bool fromLegacyString( wxConfigBase* aConfig, const std::string& aKey,
247  const std::string& aDest );
248 
255  bool fromLegacyColor( wxConfigBase* aConfig, const std::string& aKey,
256  const std::string& aDest );
257 
258  virtual wxString getFileExt() const
259  {
260  return wxT( "json" );
261  }
262 
263  virtual wxString getLegacyFileExt() const
264  {
265  return wxEmptyString;
266  }
267 
269  wxString m_filename;
270 
273 
276 
278  std::vector<PARAM_BASE*> m_params;
279 
281  std::vector<NESTED_SETTINGS*> m_nested_settings;
282 
285 
291 
294 
297 
300 
303 
306 
308  std::vector<nlohmann::json::json_pointer> m_preserved_paths;
309 };
310 
311 // Specializations to allow conversion between wxString and std::string via JSON_SETTINGS API
312 
313 template<> OPT<wxString> JSON_SETTINGS::Get( const std::string& aPath ) const;
314 
315 template<> void JSON_SETTINGS::Set<wxString>( const std::string& aPath, wxString aVal );
316 
317 // Specializations to allow directly reading/writing wxStrings from JSON
318 
319 void to_json( nlohmann::json& aJson, const wxString& aString );
320 
321 void from_json( const nlohmann::json& aJson, wxString& aString );
322 
323 #endif
void ResetToDefaults()
Resets all parameters to default values.
std::vector< nlohmann::json::json_pointer > m_preserved_paths
A list of JSON pointers that are preserved during a read-update-write to disk.
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void from_json(const nlohmann::json &aJson, wxString &aString)
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFilename() const
Definition: json_settings.h:64
virtual wxString getLegacyFileExt() const
SETTINGS_LOC
Definition: json_settings.h:44
virtual bool LoadFromFile(const wxString &aDirectory="")
Loads the backing file from disk and then calls Load()
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....
wxString GetFullFilename() const
nlohmann::json json
Definition: gerbview.cpp:40
void AddNestedSettings(NESTED_SETTINGS *aSettings)
Transfers ownership of a given NESTED_SETTINGS to this object.
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
OPT< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
void to_json(nlohmann::json &aJson, const wxString &aString)
The color scheme directory (e.g. ~/.config/kicad/colors/)
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.
NESTED_SETTINGS is a JSON_SETTINGS that lives inside a JSON_SETTINGS.
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)
const auto NULLOPT
Definition: optional.h:9
The settings directory inside a project folder.
SETTINGS_LOC GetLocation() const
Definition: json_settings.h:68
static bool SetIfPresent(const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
Sets the given string if the given key/path is present.
void SetManager(SETTINGS_MANAGER *aManager)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
No directory prepended, full path in filename (used for PROJECT_FILE)
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:56
SETTINGS_LOC m_location
The location of this settings file (.
Not stored in a file, but inside another JSON_SETTINGS.
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
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.
The main config directory (e.g. ~/.config/kicad/)
boost::optional< T > OPT
Definition: optional.h:7
bool fromLegacy(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig value to a given JSON pointer value.
virtual ~JSON_SETTINGS()
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 ...
void ReleaseNestedSettings(NESTED_SETTINGS *aSettings)
Saves and frees a nested settings object, if it exists within this one.
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
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.
void SetLegacyFilename(const wxString &aFilename)
Definition: json_settings.h:70
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
bool m_writeFile
Whether or not the backing store file should be written.