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 <core/wx_stl_compat.h>
25 
26 #include <utility>
27 #include <wx/string.h>
28 
29 #include <core/optional.h>
30 #include <nlohmann/json_fwd.hpp>
31 
32 class wxConfigBase;
33 class NESTED_SETTINGS;
34 class PARAM_BASE;
35 class SETTINGS_MANAGER;
36 
44 extern const wxChar* const traceSettings;
45 
46 enum class SETTINGS_LOC {
47  USER,
48  PROJECT,
49  COLORS,
50  NESTED,
51  NONE,
52 };
53 
54 
57 
59 {
60 public:
61  friend class NESTED_SETTINGS;
62 
63  JSON_SETTINGS( const wxString& aFilename, SETTINGS_LOC aLocation, int aSchemaVersion ) :
64  JSON_SETTINGS( aFilename, aLocation, aSchemaVersion, true, true, true )
65  {}
66 
67  JSON_SETTINGS( const wxString& aFilename, SETTINGS_LOC aLocation, int aSchemaVersion,
68  bool aCreateIfMissing, bool aCreateIfDefault, bool aWriteFile );
69 
70  virtual ~JSON_SETTINGS();
71 
72  wxString GetFilename() const { return m_filename; }
73 
74  wxString GetFullFilename() const;
75 
76  void SetFilename( const wxString& aFilename ) { m_filename = aFilename; }
77 
78  SETTINGS_LOC GetLocation() const { return m_location; }
79 
80  void SetLegacyFilename( const wxString& aFilename ) { m_legacy_filename = aFilename; }
81 
82  bool IsReadOnly() const { return !m_writeFile; }
83  void SetReadOnly( bool aReadOnly ) { m_writeFile = !aReadOnly; }
84 
90  nlohmann::json& At( const std::string& aPath );
91  bool Contains( const std::string& aPath ) const;
92  size_t Count( const std::string& aPath ) const;
93 
95 
99  virtual void Load();
100 
106  virtual bool Store();
107 
113  virtual bool LoadFromFile( const wxString& aDirectory = "" );
114 
120  virtual bool SaveToFile( const wxString& aDirectory = "", bool aForce = false );
121 
125  void ResetToDefaults();
126 
133  OPT<nlohmann::json> GetJson( const std::string& aPath ) const;
134 
142  template<typename ValueType>
143  OPT<ValueType> Get( const std::string& aPath ) const;
144 
152  template<typename ValueType>
153  void Set( const std::string& aPath, ValueType aVal );
154 
164  bool Migrate();
165 
172  virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig );
173 
182  void AddNestedSettings( NESTED_SETTINGS* aSettings );
183 
188  void ReleaseNestedSettings( NESTED_SETTINGS* aSettings );
189 
190  void SetManager( SETTINGS_MANAGER* aManager )
191  {
192  m_manager = aManager;
193  }
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 
238  void registerMigration( int aOldSchemaVersion, int aNewSchemaVersion,
239  std::function<bool(void)> aMigrator );
240 
248  template<typename ValueType>
249  bool fromLegacy( wxConfigBase* aConfig, const std::string& aKey, const std::string& aDest );
250 
257  bool fromLegacyString( wxConfigBase* aConfig, const std::string& aKey,
258  const std::string& aDest );
259 
266  bool fromLegacyColor( wxConfigBase* aConfig, const std::string& aKey,
267  const std::string& aDest );
268 
269  virtual wxString getFileExt() const
270  {
271  return wxT( "json" );
272  }
273 
274  virtual wxString getLegacyFileExt() const
275  {
276  return wxEmptyString;
277  }
278 
280  wxString m_filename;
281 
284 
287 
289  std::vector<PARAM_BASE*> m_params;
290 
292  std::vector<NESTED_SETTINGS*> m_nested_settings;
293 
296 
302 
305 
308 
311 
314 
317 
319  std::map<int, std::pair<int, std::function<bool()>>> m_migrators;
320 
321  std::unique_ptr<JSON_SETTINGS_INTERNALS> m_internals;
322 };
323 
324 // Specializations to allow conversion between wxString and std::string via JSON_SETTINGS API
325 
326 template<> OPT<wxString> JSON_SETTINGS::Get( const std::string& aPath ) const;
327 
328 template<> void JSON_SETTINGS::Set<wxString>( const std::string& aPath, wxString aVal );
329 
330 // Specializations to allow directly reading/writing wxStrings from JSON
331 
332 void to_json( nlohmann::json& aJson, const wxString& aString );
333 
334 void from_json( const nlohmann::json& aJson, wxString& aString );
335 
336 #endif
void ResetToDefaults()
Resets all parameters to default values.
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...
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
JSON_SETTINGS_INTERNALS * Internals()
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.
void SetReadOnly(bool aReadOnly)
Definition: json_settings.h:83
wxString GetFilename() const
Definition: json_settings.h:72
virtual wxString getLegacyFileExt() const
SETTINGS_LOC
Definition: json_settings.h:46
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:41
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
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.
void to_json(nlohmann::json &aJson, const wxString &aString)
The color scheme directory (e.g. ~/.config/kicad/colors/)
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>
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.
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)
The settings directory inside a project folder.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
SETTINGS_LOC GetLocation() const
Definition: json_settings.h:78
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:63
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.
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
OPT< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
The main config directory (e.g. ~/.config/kicad/)
bool IsReadOnly() const
Definition: json_settings.h:82
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.
bool Contains(const std::string &aPath) const
virtual ~JSON_SETTINGS()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
void SetFilename(const wxString &aFilename)
Definition: json_settings.h:76
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
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
void SetLegacyFilename(const wxString &aFilename)
Definition: json_settings.h:80
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
size_t Count(const std::string &aPath) const
bool m_writeFile
Whether or not the backing store file should be written.