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  SYSTEM
 

Public Member Functions

 COMMON_SETTINGS ()
 
virtual ~COMMON_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
bool Migrate () override
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const 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)
 
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...
 

Public Attributes

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

Protected Member Functions

template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

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

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 37 of file common_settings.cpp.

37  :
39  m_Appearance(),
40  m_Backup(),
41  m_Env(),
42  m_Input(),
43  m_Graphics(),
44  m_System()
45 {
46  // This only effect the first time KiCad is run. The user's setting will be used for all
47  // subsequent runs.
48  // Menu icons are off by default on OSX and on for all other platforms.
49  // Use automatic canvas scaling on OSX, but not on the other platforms (their detection isn't as good).
50 #if defined( __WXMAC__ )
51  bool defaultUseIconsInMenus = false;
52  double canvasScale = 0.0;
53 #else
54  bool defaultUseIconsInMenus = true;
55  double canvasScale = 1.0;
56 #endif
57 
58  m_params.emplace_back( new PARAM<double>( "appearance.canvas_scale",
59  &m_Appearance.canvas_scale, canvasScale ) );
60 
61  m_params.emplace_back( new PARAM<int>( "appearance.icon_scale",
62  &m_Appearance.icon_scale, 0 ) );
63 
64  m_params.emplace_back( new PARAM<bool>( "appearance.use_icons_in_menus",
65  &m_Appearance.use_icons_in_menus, defaultUseIconsInMenus ) );
66 
67  m_params.emplace_back( new PARAM<bool>( "auto_backup.enabled", &m_Backup.enabled, true ) );
68 
69  m_params.emplace_back( new PARAM<bool>(
70  "auto_backup.backup_on_autosave", &m_Backup.backup_on_autosave, false ) );
71 
72  m_params.emplace_back(
73  new PARAM<int>( "auto_backup.limit_total_files", &m_Backup.limit_total_files, 25 ) );
74 
75  m_params.emplace_back( new PARAM<unsigned long long>(
76  "auto_backup.limit_total_size", &m_Backup.limit_total_size, 104857600 ) );
77 
78  m_params.emplace_back(
79  new PARAM<int>( "auto_backup.limit_daily_files", &m_Backup.limit_daily_files, 5 ) );
80 
81  m_params.emplace_back(
82  new PARAM<int>( "auto_backup.min_interval", &m_Backup.min_interval, 300 ) );
83 
84  m_params.emplace_back( new PARAM<bool>( "environment.show_warning_dialog",
85  &m_Env.show_warning_dialog, false ) );
86 
87  m_params.emplace_back( new PARAM_MAP<wxString>( "environment.vars", &m_Env.vars, {} ) );
88 
89  m_params.emplace_back( new PARAM<bool>( "input.auto_pan", &m_Input.auto_pan, false ) );
90 
91  m_params.emplace_back(
92  new PARAM<int>( "input.auto_pan_acceleration", &m_Input.auto_pan_acceleration, 5 ) );
93 
94  m_params.emplace_back(
95  new PARAM<bool>( "input.center_on_zoom", &m_Input.center_on_zoom, true ) );
96 
97  m_params.emplace_back( new PARAM<bool>( "input.immediate_actions",
98  &m_Input.immediate_actions, true ) );
99 
100  m_params.emplace_back( new PARAM<bool>( "input.prefer_select_to_drag",
101  &m_Input.prefer_select_to_drag, true ) );
102 
103  m_params.emplace_back( new PARAM<bool>( "input.warp_mouse_on_move",
104  &m_Input.warp_mouse_on_move, true ) );
105 
106  m_params.emplace_back(
107  new PARAM<bool>( "input.horizontal_pan", &m_Input.horizontal_pan, false ) );
108 
109 #if defined(__WXMAC__) || defined(__WXGTK3__)
110  bool default_zoom_acceleration = false;
111 #else
112  bool default_zoom_acceleration = true;
113 #endif
114 
115  m_params.emplace_back( new PARAM<bool>(
116  "input.zoom_acceleration", &m_Input.zoom_acceleration, default_zoom_acceleration ) );
117 
118 #ifdef __WXMAC__
119  int default_zoom_speed = 5;
120 #else
121  int default_zoom_speed = 1;
122 #endif
123 
124  m_params.emplace_back(
125  new PARAM<int>( "input.zoom_speed", &m_Input.zoom_speed, default_zoom_speed ) );
126 
127  m_params.emplace_back(
128  new PARAM<bool>( "input.zoom_speed_auto", &m_Input.zoom_speed_auto, true ) );
129 
130  m_params.emplace_back(
131  new PARAM<int>( "input.scroll_modifier_zoom", &m_Input.scroll_modifier_zoom, 0 ) );
132 
133  m_params.emplace_back( new PARAM<int>(
134  "input.scroll_modifier_pan_h", &m_Input.scroll_modifier_pan_h, WXK_CONTROL ) );
135 
136  m_params.emplace_back( new PARAM<int>(
137  "input.scroll_modifier_pan_v", &m_Input.scroll_modifier_pan_v, WXK_SHIFT ) );
138 
139  m_params.emplace_back( new PARAM<int>( "input.mouse_middle", &m_Input.drag_middle,
140  static_cast<int>( MOUSE_DRAG_ACTION::PAN ),
141  static_cast<int>( MOUSE_DRAG_ACTION::SELECT ),
142  static_cast<int>( MOUSE_DRAG_ACTION::NONE ) ) );
143 
144  m_params.emplace_back( new PARAM<int>( "input.mouse_right", &m_Input.drag_right,
145  static_cast<int>( MOUSE_DRAG_ACTION::PAN ),
146  static_cast<int>( MOUSE_DRAG_ACTION::SELECT ),
147  static_cast<int>( MOUSE_DRAG_ACTION::NONE ) ) );
148 
149  m_params.emplace_back( new PARAM<int>( "graphics.opengl_antialiasing_mode",
150  &m_Graphics.opengl_aa_mode, 0, 0, 4 ) );
151 
152  m_params.emplace_back( new PARAM<int>( "graphics.cairo_antialiasing_mode",
153  &m_Graphics.cairo_aa_mode, 0, 0, 3 ) );
154 
155  m_params.emplace_back( new PARAM<int>( "system.autosave_interval",
156  &m_System.autosave_interval, 600 ) );
157 
158  m_params.emplace_back( new PARAM<wxString>( "system.editor_name",
159  &m_System.editor_name, "" ) );
160 
161  m_params.emplace_back( new PARAM<int>( "system.file_history_size",
162  &m_System.file_history_size, 9 ) );
163 
164  m_params.emplace_back( new PARAM<wxString>( "system.language",
165  &m_System.language, "Default" ) );
166 
167  m_params.emplace_back( new PARAM<wxString>( "system.pdf_viewer_name",
168  &m_System.pdf_viewer_name, "" ) );
169 
170  m_params.emplace_back( new PARAM<bool>( "system.use_system_pdf_viewer",
171  &m_System.use_system_pdf_viewer, true ) );
172 
173  m_params.emplace_back( new PARAM<wxString>( "system.working_dir",
174  &m_System.working_dir, "" ) );
175 }
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:48
int min_interval
Minimum time, in seconds, between subsequent backups.
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::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_System, 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, 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 96 of file common_settings.h.

96 {}

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

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

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

447 {
448  ValueType val;
449 
450  if( aConfig->Read( aKey, &val ) )
451  {
452  try
453  {
454  ( *this )[PointerFromString( aDest )] = val;
455  }
456  catch( ... )
457  {
458  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
459  return false;
460  }
461 
462  return true;
463  }
464 
465  return false;
466 }
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 505 of file json_settings.cpp.

507 {
508  wxString str;
509 
510  if( aConfig->Read( aKey, &str ) )
511  {
513  color.SetFromWxString( str );
514 
515  try
516  {
517  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
518  ( *this )[PointerFromString( aDest )] = js;
519  }
520  catch( ... )
521  {
522  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
523  return false;
524  }
525 
526  return true;
527  }
528 
529  return false;
530 }
int color
Definition: DXF_plotter.cpp:61
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, and 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 481 of file json_settings.cpp.

483 {
484  wxString str;
485 
486  if( aConfig->Read( aKey, &str ) )
487  {
488  try
489  {
490  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
491  }
492  catch( ... )
493  {
494  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
495  return false;
496  }
497 
498  return true;
499  }
500 
501  return false;
502 }
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 111 of file json_settings.h.

112  {
113  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
114  {
115  try
116  {
117  return ret->get<ValueType>();
118  }
119  catch( ... )
120  {
121  }
122  }
123 
124  return NULLOPT;
125  }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 563 of file json_settings.cpp.

564 {
565  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
566  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
567 
568  return NULLOPT;
569 }
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 217 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 70 of file json_settings.cpp.

71 {
72  return wxString( m_filename + "." + getFileExt() );
73 }
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(), 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 390 of file json_settings.cpp.

391 {
392  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
393 
394  if( this->contains( ptr ) )
395  {
396  try
397  {
398  return OPT<nlohmann::json>{ this->at( ptr ) };
399  }
400  catch( ... )
401  {
402  }
403  }
404 
405  return OPT<nlohmann::json>{};
406 }
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 JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 222 of file json_settings.h.

223  {
224  return wxEmptyString;
225  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 60 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 76 of file json_settings.cpp.

77 {
78  for( auto param : m_params )
79  {
80  try
81  {
82  param->Load( this, m_resetParamsIfMissing );
83  }
84  catch( ... )
85  {
86  // Skip unreadable parameters in file:
87 #ifdef DEBUG
88  wxLogMessage( wxString::Format( "param '%s' load err", param->GetJsonPath().c_str() ) );
89 #endif
90  }
91  }
92 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), JSON_SETTINGS::m_params, and JSON_SETTINGS::m_resetParamsIfMissing.

Referenced by 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 95 of file json_settings.cpp.

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

References 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::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool COMMON_SETTINGS::Migrate ( )
overridevirtual

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Reimplemented from JSON_SETTINGS.

Definition at line 178 of file common_settings.cpp.

179 {
180  bool ret = true;
181  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
182 
183  if( filever == 0 )
184  {
185  ret &= migrateSchema0to1();
186 
187  if( ret )
188  {
189  ( *this )[PointerFromString( "meta.version" )] = 1;
190  }
191  }
192 
193  return ret;
194 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References migrateSchema0to1(), and JSON_SETTINGS::PointerFromString().

◆ 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 240 of file common_settings.cpp.

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

198 {
205  nlohmann::json::json_pointer mwp_pointer( "/input/mousewheel_pan"_json_pointer );
206 
207  bool mwp = false;
208 
209  try
210  {
211  mwp = at( mwp_pointer );
212  at( nlohmann::json::json_pointer( "/input"_json_pointer ) ).erase( "mousewheel_pan" );
213  }
214  catch( ... )
215  {
216  wxLogTrace( traceSettings, "COMMON_SETTINGS::Migrate 0->1: mousewheel_pan not found" );
217  }
218 
219  if( mwp )
220  {
221  ( *this )[nlohmann::json::json_pointer( "/input/horizontal_pan" )] = true;
222 
223  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_h" )] = WXK_SHIFT;
224  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_v" )] = 0;
225  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_zoom" )] = WXK_CONTROL;
226  }
227  else
228  {
229  ( *this )[nlohmann::json::json_pointer( "/input/horizontal_pan" )] = false;
230 
231  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_h" )] = WXK_CONTROL;
232  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_v" )] = WXK_SHIFT;
233  ( *this )[nlohmann::json::json_pointer( "/input/scroll_modifier_zoom" )] = 0;
234  }
235 
236  return true;
237 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by Migrate().

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

425 {
426  std::replace( aPath.begin(), aPath.end(), '.', '/' );
427  aPath.insert( 0, "/" );
428 
429  nlohmann::json::json_pointer p;
430 
431  try
432  {
433  p = nlohmann::json::json_pointer( aPath );
434  }
435  catch( ... )
436  {
437  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
438  }
439 
440  return p;
441 }

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

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

541 {
542  if( !aSettings )
543  return;
544 
545  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
546  [&aSettings]( const JSON_SETTINGS* aPtr ) {
547  return aPtr == aSettings;
548  } );
549 
550  if( it != m_nested_settings.end() )
551  {
552  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
553  ( *it )->SaveToFile();
554  m_nested_settings.erase( it );
555  }
556 
557  aSettings->SetParent( nullptr );
558 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
void SetParent(JSON_SETTINGS *aParent)

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

293 {
294  for( auto param : m_params )
295  param->SetDefault();
296 }
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 299 of file json_settings.cpp.

300 {
301  if( !m_writeFile )
302  return false;
303 
304  // Default PROJECT won't have a filename set
305  if( m_filename.IsEmpty() )
306  return false;
307 
308  wxFileName path;
309 
310  if( aDirectory.empty() )
311  {
312  path.Assign( m_filename );
313  path.SetExt( getFileExt() );
314  }
315  else
316  {
317  wxString dir( aDirectory );
318  path.Assign( dir, m_filename, getFileExt() );
319  }
320 
321  if( !m_createIfMissing && !path.FileExists() )
322  {
323  wxLogTrace( traceSettings,
324  "File for %s doesn't exist and m_createIfMissing == false; not saving",
325  GetFullFilename() );
326  return false;
327  }
328 
329  if( ( path.FileExists() && !path.IsFileWritable() ) ||
330  ( !path.FileExists() && !path.IsDirWritable() ) )
331  {
332  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
333  return false;
334  }
335 
336  bool modified = false;
337 
338  for( auto settings : m_nested_settings )
339  modified |= settings->SaveToFile();
340 
341  modified |= Store();
342 
343  if( !modified && !aForce && path.FileExists() )
344  {
345  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
346  return false;
347  }
348  else if( !modified && !aForce && !m_createIfDefault )
349  {
350  wxLogTrace( traceSettings,
351  "%s contents still default and m_createIfDefault == false; not saving",
352  GetFullFilename() );
353  return false;
354  }
355 
356  if( !path.DirExists() && !path.Mkdir() )
357  {
358  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
359  path.GetPath(), GetFullFilename() );
360  return false;
361  }
362 
363  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
364 
366  bool success = true;
367 
368  try
369  {
370  wxFile file( path.GetFullPath(), wxFile::write );
371 
372  std::stringstream buffer;
373  buffer << std::setw( 2 ) << *this << std::endl;
374 
375  if( !file.IsOpened() || !file.Write( buffer.str().c_str(), buffer.str().size() ) )
376  {
377  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
378  success = false;
379  }
380  }
381  catch( ... )
382  {
383  success = false;
384  }
385 
386  return success;
387 }
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: common.h:216
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.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
const char * traceSettings
Flag to enable settings tracing.
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

References dummy(), 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 135 of file json_settings.h.

136  {
137  ( *this )[PointerFromString( aPath ) ] = aVal;
138  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 572 of file json_settings.cpp.

573 {
574  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
575 }
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 62 of file json_settings.h.

62 { 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 175 of file json_settings.h.

176  {
177  m_manager = aManager;
178  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

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

279 {
280  bool modified = false;
281 
282  for( auto param : m_params )
283  {
284  modified |= !param->MatchesFile( this );
285  param->Store( this );
286  }
287 
288  return modified;
289 }
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 121 of file common_settings.h.

◆ m_3DLibsUrl

wxString COMMON_SETTINGS::m_3DLibsUrl

Definition at line 119 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 249 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 243 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 255 of file json_settings.h.

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

◆ m_Env

ENVIRONMENT COMMON_SETTINGS::m_Env

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

◆ 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 231 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 234 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 264 of file json_settings.h.

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

◆ 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 240 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 267 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 258 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_System

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 252 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().


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