KiCad PCB EDA Suite
COMMON_SETTINGS Class Reference

#include <common_settings.h>

Inheritance diagram for COMMON_SETTINGS:
JSON_SETTINGS

Classes

struct  APPEARANCE
 
struct  AUTO_BACKUP
 
struct  ENVIRONMENT
 
struct  GRAPHICS
 
struct  INPUT
 
struct  SESSION
 
struct  SYSTEM
 

Public Member Functions

 COMMON_SETTINGS ()
 
virtual ~COMMON_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
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<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 
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...
 

Public Attributes

APPEARANCE m_Appearance
 
AUTO_BACKUP m_Backup
 
ENVIRONMENT m_Env
 
INPUT m_Input
 
GRAPHICS m_Graphics
 
SESSION m_Session
 
SYSTEM m_System
 
wxString m_3DLibsUrl
 
wxString m_3DLibsDownloadPath
 

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

Private Member Functions

bool migrateSchema0to1 ()
 

Detailed Description

Definition at line 27 of file common_settings.h.

Constructor & Destructor Documentation

◆ COMMON_SETTINGS()

COMMON_SETTINGS::COMMON_SETTINGS ( )

Definition at line 34 of file common_settings.cpp.

34  :
36  m_Appearance(),
37  m_Backup(),
38  m_Env(),
39  m_Input(),
40  m_Graphics(),
41  m_Session(),
42  m_System()
43 {
44  // This only effect the first time KiCad is run. The user's setting will be used for all
45  // subsequent runs.
46  // Menu icons are off by default on OSX and on for all other platforms.
47  // Use automatic canvas scaling on OSX, but not on the other platforms (their detection isn't as good).
48 #if defined( __WXMAC__ )
49  bool defaultUseIconsInMenus = false;
50  double canvasScale = 0.0;
51 #else
52  bool defaultUseIconsInMenus = true;
53  double canvasScale = 1.0;
54 #endif
55 
56  m_params.emplace_back( new PARAM<double>( "appearance.canvas_scale",
57  &m_Appearance.canvas_scale, canvasScale ) );
58 
59  m_params.emplace_back( new PARAM<int>( "appearance.icon_scale",
60  &m_Appearance.icon_scale, 0 ) );
61 
62  m_params.emplace_back( new PARAM<bool>( "appearance.use_icons_in_menus",
63  &m_Appearance.use_icons_in_menus, defaultUseIconsInMenus ) );
64 
65  m_params.emplace_back( new PARAM<bool>( "auto_backup.enabled", &m_Backup.enabled, true ) );
66 
67  m_params.emplace_back( new PARAM<bool>(
68  "auto_backup.backup_on_autosave", &m_Backup.backup_on_autosave, false ) );
69 
70  m_params.emplace_back(
71  new PARAM<int>( "auto_backup.limit_total_files", &m_Backup.limit_total_files, 25 ) );
72 
73  m_params.emplace_back( new PARAM<unsigned long long>(
74  "auto_backup.limit_total_size", &m_Backup.limit_total_size, 104857600 ) );
75 
76  m_params.emplace_back(
77  new PARAM<int>( "auto_backup.limit_daily_files", &m_Backup.limit_daily_files, 5 ) );
78 
79  m_params.emplace_back(
80  new PARAM<int>( "auto_backup.min_interval", &m_Backup.min_interval, 300 ) );
81 
82  m_params.emplace_back( new PARAM<bool>( "environment.show_warning_dialog",
83  &m_Env.show_warning_dialog, false ) );
84 
85  m_params.emplace_back( new PARAM_MAP<wxString>( "environment.vars", &m_Env.vars, {} ) );
86 
87  m_params.emplace_back( new PARAM<bool>( "input.auto_pan", &m_Input.auto_pan, false ) );
88 
89  m_params.emplace_back(
90  new PARAM<int>( "input.auto_pan_acceleration", &m_Input.auto_pan_acceleration, 5 ) );
91 
92  m_params.emplace_back(
93  new PARAM<bool>( "input.center_on_zoom", &m_Input.center_on_zoom, true ) );
94 
95  m_params.emplace_back( new PARAM<bool>( "input.immediate_actions",
96  &m_Input.immediate_actions, true ) );
97 
98  m_params.emplace_back( new PARAM<bool>( "input.prefer_select_to_drag",
99  &m_Input.prefer_select_to_drag, false ) );
100 
101  m_params.emplace_back( new PARAM<bool>( "input.warp_mouse_on_move",
102  &m_Input.warp_mouse_on_move, true ) );
103 
104  m_params.emplace_back(
105  new PARAM<bool>( "input.horizontal_pan", &m_Input.horizontal_pan, false ) );
106 
107 #if defined(__WXMAC__) || defined(__WXGTK3__)
108  bool default_zoom_acceleration = false;
109 #else
110  bool default_zoom_acceleration = true;
111 #endif
112 
113  m_params.emplace_back( new PARAM<bool>(
114  "input.zoom_acceleration", &m_Input.zoom_acceleration, default_zoom_acceleration ) );
115 
116 #ifdef __WXMAC__
117  int default_zoom_speed = 5;
118 #else
119  int default_zoom_speed = 1;
120 #endif
121 
122  m_params.emplace_back(
123  new PARAM<int>( "input.zoom_speed", &m_Input.zoom_speed, default_zoom_speed ) );
124 
125  m_params.emplace_back(
126  new PARAM<bool>( "input.zoom_speed_auto", &m_Input.zoom_speed_auto, true ) );
127 
128  m_params.emplace_back(
129  new PARAM<int>( "input.scroll_modifier_zoom", &m_Input.scroll_modifier_zoom, 0 ) );
130 
131  m_params.emplace_back( new PARAM<int>(
132  "input.scroll_modifier_pan_h", &m_Input.scroll_modifier_pan_h, WXK_CONTROL ) );
133 
134  m_params.emplace_back( new PARAM<int>(
135  "input.scroll_modifier_pan_v", &m_Input.scroll_modifier_pan_v, WXK_SHIFT ) );
136 
137  m_params.emplace_back( new PARAM<int>( "input.mouse_middle", &m_Input.drag_middle,
138  static_cast<int>( MOUSE_DRAG_ACTION::PAN ),
139  static_cast<int>( MOUSE_DRAG_ACTION::SELECT ),
140  static_cast<int>( MOUSE_DRAG_ACTION::NONE ) ) );
141 
142  m_params.emplace_back( new PARAM<int>( "input.mouse_right", &m_Input.drag_right,
143  static_cast<int>( MOUSE_DRAG_ACTION::PAN ),
144  static_cast<int>( MOUSE_DRAG_ACTION::SELECT ),
145  static_cast<int>( MOUSE_DRAG_ACTION::NONE ) ) );
146 
147  m_params.emplace_back( new PARAM<int>( "graphics.opengl_antialiasing_mode",
148  &m_Graphics.opengl_aa_mode, 0, 0, 4 ) );
149 
150  m_params.emplace_back( new PARAM<int>( "graphics.cairo_antialiasing_mode",
151  &m_Graphics.cairo_aa_mode, 0, 0, 3 ) );
152 
153  m_params.emplace_back( new PARAM<int>( "system.autosave_interval",
154  &m_System.autosave_interval, 600 ) );
155 
156  m_params.emplace_back( new PARAM<wxString>( "system.editor_name",
157  &m_System.editor_name, "" ) );
158 
159  m_params.emplace_back( new PARAM<int>( "system.file_history_size",
160  &m_System.file_history_size, 9 ) );
161 
162  m_params.emplace_back( new PARAM<wxString>( "system.language",
163  &m_System.language, "Default" ) );
164 
165  m_params.emplace_back( new PARAM<wxString>( "system.pdf_viewer_name",
166  &m_System.pdf_viewer_name, "" ) );
167 
168  m_params.emplace_back( new PARAM<bool>( "system.use_system_pdf_viewer",
169  &m_System.use_system_pdf_viewer, true ) );
170 
171  m_params.emplace_back( new PARAM<wxString>( "system.working_dir",
172  &m_System.working_dir, "" ) );
173 
174  m_params.emplace_back( new PARAM<int>( "system.clear_3d_cache_interval",
176 
177  m_params.emplace_back( new PARAM<bool>( "session.remember_open_files",
178  &m_Session.remember_open_files, false ) );
179 
180  registerMigration( 0, 1, std::bind( &COMMON_SETTINGS::migrateSchema0to1, this ) );
181 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
unsigned long long limit_total_size
Maximum total size of backups (bytes), 0 for unlimited.
Represents a map of <std::string, Value>.
Definition: parameters.h:643
const int commonSchemaVersion
! Update the schema version whenever a migration is required
bool enabled
Automatically back up the project when files are saved.
AUTO_BACKUP m_Backup
APPEARANCE m_Appearance
std::map< std::string, wxString > vars
ENVIRONMENT m_Env
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:56
int min_interval
Minimum time, in seconds, between subsequent backups.
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
The main config directory (e.g. ~/.config/kicad/)
bool backup_on_autosave
Trigger a backup on autosave.
int limit_daily_files
Maximum files to keep per day, 0 for unlimited.
int limit_total_files
Maximum number of backup archives to retain.

References COMMON_SETTINGS::INPUT::auto_pan, COMMON_SETTINGS::INPUT::auto_pan_acceleration, COMMON_SETTINGS::SYSTEM::autosave_interval, COMMON_SETTINGS::AUTO_BACKUP::backup_on_autosave, COMMON_SETTINGS::GRAPHICS::cairo_aa_mode, COMMON_SETTINGS::APPEARANCE::canvas_scale, COMMON_SETTINGS::INPUT::center_on_zoom, COMMON_SETTINGS::SYSTEM::clear_3d_cache_interval, COMMON_SETTINGS::INPUT::drag_middle, COMMON_SETTINGS::INPUT::drag_right, COMMON_SETTINGS::SYSTEM::editor_name, COMMON_SETTINGS::AUTO_BACKUP::enabled, COMMON_SETTINGS::SYSTEM::file_history_size, COMMON_SETTINGS::INPUT::horizontal_pan, COMMON_SETTINGS::APPEARANCE::icon_scale, COMMON_SETTINGS::INPUT::immediate_actions, COMMON_SETTINGS::SYSTEM::language, COMMON_SETTINGS::AUTO_BACKUP::limit_daily_files, COMMON_SETTINGS::AUTO_BACKUP::limit_total_files, COMMON_SETTINGS::AUTO_BACKUP::limit_total_size, m_Appearance, m_Backup, m_Env, m_Graphics, m_Input, JSON_SETTINGS::m_params, m_Session, m_System, migrateSchema0to1(), COMMON_SETTINGS::AUTO_BACKUP::min_interval, KIGFX::NONE, COMMON_SETTINGS::GRAPHICS::opengl_aa_mode, COMMON_SETTINGS::SYSTEM::pdf_viewer_name, COMMON_SETTINGS::INPUT::prefer_select_to_drag, JSON_SETTINGS::registerMigration(), COMMON_SETTINGS::SESSION::remember_open_files, COMMON_SETTINGS::INPUT::scroll_modifier_pan_h, COMMON_SETTINGS::INPUT::scroll_modifier_pan_v, COMMON_SETTINGS::INPUT::scroll_modifier_zoom, COMMON_SETTINGS::ENVIRONMENT::show_warning_dialog, COMMON_SETTINGS::APPEARANCE::use_icons_in_menus, COMMON_SETTINGS::SYSTEM::use_system_pdf_viewer, USER, COMMON_SETTINGS::ENVIRONMENT::vars, COMMON_SETTINGS::INPUT::warp_mouse_on_move, COMMON_SETTINGS::SYSTEM::working_dir, COMMON_SETTINGS::INPUT::zoom_acceleration, COMMON_SETTINGS::INPUT::zoom_speed, and COMMON_SETTINGS::INPUT::zoom_speed_auto.

◆ ~COMMON_SETTINGS()

virtual COMMON_SETTINGS::~COMMON_SETTINGS ( )
inlinevirtual

Definition at line 102 of file common_settings.h.

102 {}

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

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

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

Definition at line 656 of file json_settings.cpp.

657 {
658  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
659  m_nested_settings.push_back( aSettings );
660 }
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 JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ fromLegacy()

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

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

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

Definition at line 568 of file json_settings.cpp.

570 {
571  ValueType val;
572 
573  if( aConfig->Read( aKey, &val ) )
574  {
575  try
576  {
577  ( *this )[PointerFromString( aDest )] = val;
578  }
579  catch( ... )
580  {
581  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
582  return false;
583  }
584 
585  return true;
586  }
587 
588  return false;
589 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

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

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

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

Definition at line 628 of file json_settings.cpp.

630 {
631  wxString str;
632 
633  if( aConfig->Read( aKey, &str ) )
634  {
636  color.SetFromWxString( str );
637 
638  try
639  {
640  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
641  ( *this )[PointerFromString( aDest )] = js;
642  }
643  catch( ... )
644  {
645  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
646  return false;
647  }
648 
649  return true;
650  }
651 
652  return false;
653 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:39
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:100

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 604 of file json_settings.cpp.

606 {
607  wxString str;
608 
609  if( aConfig->Read( aKey, &str ) )
610  {
611  try
612  {
613  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
614  }
615  catch( ... )
616  {
617  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
618  return false;
619  }
620 
621  return true;
622  }
623 
624  return false;
625 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 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 JSON_SETTINGS::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
inherited

Definition at line 686 of file json_settings.cpp.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

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 JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 79 of file json_settings.cpp.

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

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

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

◆ GetJson()

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

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

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

Definition at line 417 of file json_settings.cpp.

418 {
419  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
420 
421  if( this->contains( ptr ) )
422  {
423  try
424  {
425  return OPT<nlohmann::json>{ this->at( ptr ) };
426  }
427  catch( ... )
428  {
429  }
430  }
431 
432  return OPT<nlohmann::json>{};
433 }
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 JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::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
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 279 of file json_settings.h.

280  {
281  return wxEmptyString;
282  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 85 of file json_settings.cpp.

86 {
87  for( auto param : m_params )
88  {
89  try
90  {
91  param->Load( this, m_resetParamsIfMissing );
92  }
93  catch( ... )
94  {
95  // Skip unreadable parameters in file
96  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
97  }
98  }
99 }
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 JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

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

◆ LoadFromFile()

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

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

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

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 102 of file json_settings.cpp.

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

446 {
447  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
448 
449  while( filever < m_schemaVersion )
450  {
451  if( !m_migrators.count( filever ) )
452  {
453  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
454  typeid( *this ).name(), filever );
455  return false;
456  }
457 
458  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
459 
460  if( pair.second() )
461  {
462  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
463  filever, pair.first );
464  filever = pair.first;
465  ( *this )[PointerFromString( "meta.version" )] = filever;
466  }
467  else
468  {
469  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
470  typeid( *this ).name(), filever, pair.first );
471  return false;
472  }
473  }
474 
475  return true;
476 }
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 JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

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

◆ MigrateFromLegacy()

bool COMMON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

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

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

Reimplemented from JSON_SETTINGS.

Definition at line 227 of file common_settings.cpp.

228 {
229  bool ret = true;
230 
231  ret &= fromLegacy<double>( aCfg, "CanvasScale", "appearance.canvas_scale" );
232  ret &= fromLegacy<int>( aCfg, "IconScale", "appearance.icon_scale" );
233  ret &= fromLegacy<bool>( aCfg, "UseIconsInMenus", "appearance.use_icons_in_menus" );
234 
235 // Force OSX to automatically scale the canvas. Before v6, the user setting wasn't used on OSX and was
236 // set to 1.0. In v6, the setting is now used by OSX and should default to automatic scaling.
237 #ifdef __WXMAC__
238  ( *this )[PointerFromString( "appearance.canvas_scale" )] = 0.0;
239 #endif
240 
241  ret &= fromLegacy<bool>( aCfg, "ShowEnvVarWarningDialog", "environment.show_warning_dialog" );
242 
243  auto load_env_vars = [&] () {
244  wxString key, value;
245  long index = 0;
246  nlohmann::json::json_pointer ptr = PointerFromString( "environment.vars" );
247 
248  aCfg->SetPath( "EnvironmentVariables" );
249  ( *this )[ptr] = nlohmann::json( {} );
250 
251  while( aCfg->GetNextEntry( key, index ) )
252  {
253  value = aCfg->Read( key, wxEmptyString );
254 
255  if( !value.IsEmpty() )
256  {
257  ptr.push_back( key.ToStdString() );
258 
259  wxLogTrace( traceSettings, "Migrate Env: %s=%s", ptr.to_string(), value );
260  ( *this )[ptr] = value.ToUTF8();
261 
262  ptr.pop_back();
263  }
264  }
265 
266  aCfg->SetPath( ".." );
267  };
268 
269  load_env_vars();
270 
271  bool mousewheel_pan = false;
272 
273  if( aCfg->Read( "MousewheelPAN", &mousewheel_pan ) && mousewheel_pan )
274  {
275  ( *this )[PointerFromString( "input.horizontal_pan" )] = true;
276 
277  ( *this )[PointerFromString( "input.scroll_modifier_pan_h" )] = WXK_SHIFT;
278  ( *this )[PointerFromString( "input.scroll_modifier_pan_v" )] = 0;
279  ( *this )[PointerFromString( "input.scroll_modifier_zoom" )] = WXK_CONTROL;
280  }
281 
282  ret &= fromLegacy<bool>( aCfg, "AutoPAN", "input.auto_pan" );
283  ret &= fromLegacy<bool>( aCfg, "ImmediateActions", "input.immediate_actions" );
284  ret &= fromLegacy<bool>( aCfg, "PreferSelectionToDragging", "input.prefer_select_to_drag" );
285  ret &= fromLegacy<bool>( aCfg, "MoveWarpsCursor", "input.warp_mouse_on_move" );
286  ret &= fromLegacy<bool>( aCfg, "ZoomNoCenter", "input.center_on_zoom" );
287 
288  // This was stored inverted in legacy config
289  if( ret )
290  {
291  auto p = PointerFromString( "input.center_on_zoom" );
292  ( *this )[p] = !( *this )[p];
293  }
294 
295  ret &= fromLegacy<int>( aCfg, "OpenGLAntialiasingMode", "graphics.opengl_antialiasing_mode" );
296  ret &= fromLegacy<int>( aCfg, "CairoAntialiasingMode", "graphics.cairo_antialiasing_mode" );
297 
298  ret &= fromLegacy<int>( aCfg, "AutoSaveInterval", "system.autosave_interval" );
299  ret &= fromLegacyString( aCfg, "Editor", "system.editor_name" );
300  ret &= fromLegacy<int>( aCfg, "FileHistorySize", "system.file_history_size" );
301  ret &= fromLegacyString( aCfg, "LanguageID", "system.language" );
302  ret &= fromLegacyString( aCfg, "PdfBrowserName", "system.pdf_viewer_name" );
303  ret &= fromLegacy<bool>( aCfg, "UseSystemBrowser", "system.use_system_pdf_viewer" );
304  ret &= fromLegacyString( aCfg, "WorkingDir", "system.working_dir" );
305 
306  return ret;
307 }
nlohmann::json json
Definition: gerbview.cpp:39
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
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.

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

◆ migrateSchema0to1()

bool COMMON_SETTINGS::migrateSchema0to1 ( )
private

Schema version 0 to 1:

mousewheel_pan is replaced by explicit settings for scroll wheel behavior

Definition at line 184 of file common_settings.cpp.

185 {
192  nlohmann::json::json_pointer mwp_pointer( "/input/mousewheel_pan"_json_pointer );
193 
194  bool mwp = false;
195 
196  try
197  {
198  mwp = at( mwp_pointer );
199  at( nlohmann::json::json_pointer( "/input"_json_pointer ) ).erase( "mousewheel_pan" );
200  }
201  catch( ... )
202  {
203  wxLogTrace( traceSettings, "COMMON_SETTINGS::Migrate 0->1: mousewheel_pan not found" );
204  }
205 
206  if( mwp )
207  {
208  ( *this )[nlohmann::json::json_pointer( "/input/horizontal_pan" )] = true;
209 
210  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_h" )] = WXK_SHIFT;
211  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_v" )] = 0;
212  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_zoom" )] = WXK_CONTROL;
213  }
214  else
215  {
216  ( *this )[nlohmann::json::json_pointer( "/input/horizontal_pan" )] = false;
217 
218  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_h" )] = WXK_CONTROL;
219  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_v" )] = WXK_SHIFT;
220  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_zoom" )] = 0;
221  }
222 
223  return true;
224 }
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References traceSettings.

Referenced by COMMON_SETTINGS().

◆ PointerFromString()

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

Builds a JSON pointer based on a given string.

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

Definition at line 487 of file json_settings.cpp.

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

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

◆ registerMigration()

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

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

438 {
439  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
440  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
441  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
442 }
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 JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.

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

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 663 of file json_settings.cpp.

664 {
665  if( !aSettings )
666  return;
667 
668  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
669  [&aSettings]( const JSON_SETTINGS* aPtr ) {
670  return aPtr == aSettings;
671  } );
672 
673  if( it != m_nested_settings.end() )
674  {
675  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
676  ( *it )->SaveToFile();
677  m_nested_settings.erase( it );
678  }
679 
680  aSettings->SetParent( nullptr );
681 }
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 JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 311 of file json_settings.cpp.

312 {
313  for( auto param : m_params )
314  param->SetDefault();
315 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
virtualinherited
   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 318 of file json_settings.cpp.

319 {
320  if( !m_writeFile )
321  return false;
322 
323  // Default PROJECT won't have a filename set
324  if( m_filename.IsEmpty() )
325  return false;
326 
327  wxFileName path;
328 
329  if( aDirectory.empty() )
330  {
331  path.Assign( m_filename );
332  path.SetExt( getFileExt() );
333  }
334  else
335  {
336  wxString dir( aDirectory );
337  path.Assign( dir, m_filename, getFileExt() );
338  }
339 
340  if( !m_createIfMissing && !path.FileExists() )
341  {
342  wxLogTrace( traceSettings,
343  "File for %s doesn't exist and m_createIfMissing == false; not saving",
344  GetFullFilename() );
345  return false;
346  }
347 
348  // Ensure the path exists, and create it if not.
349  if( !path.DirExists() && !path.Mkdir() )
350  {
351  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
352  path.GetPath(), GetFullFilename() );
353  return false;
354  }
355 
356  if( ( path.FileExists() && !path.IsFileWritable() ) ||
357  ( !path.FileExists() && !path.IsDirWritable() ) )
358  {
359  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
360  return false;
361  }
362 
363  bool modified = false;
364 
365  for( auto settings : m_nested_settings )
366  modified |= settings->SaveToFile();
367 
368  modified |= Store();
369 
370  if( !modified && !aForce && path.FileExists() )
371  {
372  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
373  return false;
374  }
375  else if( !modified && !aForce && !m_createIfDefault )
376  {
377  wxLogTrace( traceSettings,
378  "%s contents still default and m_createIfDefault == false; not saving",
379  GetFullFilename() );
380  return false;
381  }
382 
383  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
384 
386  bool success = true;
387 
388  try
389  {
390  std::stringstream buffer;
391  buffer << std::setw( 2 ) << *this << std::endl;
392 
393  wxFile file( path.GetFullPath(), wxFile::write );
394 
395  if( !file.IsOpened() || !file.Write( buffer.str().c_str(), buffer.str().size() ) )
396  {
397  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
398  success = false;
399  }
400  }
401  catch( nlohmann::json::exception& error )
402  {
403  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
404  GetFullFilename(), error.what() );
405  success = false;
406  }
407  catch( ... )
408  {
409  wxLogTrace( traceSettings, "Error: could not save %s." );
410  success = false;
411  }
412 
413  return success;
414 }
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(), JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::m_createIfDefault, JSON_SETTINGS::m_createIfMissing, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Store(), and traceSettings.

Referenced by JSON_SETTINGS::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 
)
inlineinherited

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

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

Definition at line 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 JSON_SETTINGS::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 
)
inherited

◆ Set() [3/3]

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

Definition at line 695 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

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

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 JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/4]

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

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

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

References JSON_SETTINGS::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 
)
staticinherited

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

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

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

554 {
555  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
556 
557  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
558  {
559  aTarget = aObj.at( ptr ).get<unsigned int>();
560  return true;
561  }
562 
563  return false;
564 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 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 JSON_SETTINGS::m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

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

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

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 JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 297 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_3DLibsDownloadPath

wxString COMMON_SETTINGS::m_3DLibsDownloadPath

Definition at line 127 of file common_settings.h.

◆ m_3DLibsUrl

wxString COMMON_SETTINGS::m_3DLibsUrl

Definition at line 125 of file common_settings.h.

◆ m_Appearance

◆ m_Backup

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

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

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 306 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

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

Definition at line 300 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 312 of file json_settings.h.

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

◆ m_Env

ENVIRONMENT COMMON_SETTINGS::m_Env

◆ m_filename

◆ m_Graphics

◆ m_Input

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 288 of file json_settings.h.

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 291 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 321 of file json_settings.h.

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

◆ m_migrators

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

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 JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_nested_settings

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

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

Definition at line 297 of file json_settings.h.

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

◆ m_params

◆ m_preserved_paths

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

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

Definition at line 324 of file json_settings.h.

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

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

Definition at line 315 of file json_settings.h.

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_Session

◆ m_System

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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