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  DO_NOT_SHOW_AGAIN
 
struct  ENVIRONMENT
 
struct  GRAPHICS
 
struct  INPUT
 
struct  NETCLASS_PANEL
 
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...
 
void InitializeEnvironment ()
 Creates the built-in environment variables and sets their default values. 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)
 
nlohmann::jsonAt (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally. More...
 
bool Contains (const std::string &aPath) const
 
size_t Count (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
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...
 
bool IsDefault (const std::string &aParamName)
 Checks if the current state of a parameter matches its default value. 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 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
 
DO_NOT_SHOW_AGAIN m_DoNotShowAgain
 
NETCLASS_PANEL m_NetclassPanel
 

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::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...
 
std::unique_ptr< JSON_SETTINGS_INTERNALSm_internals
 

Private Member Functions

bool migrateSchema0to1 ()
 
bool migrateSchema1to2 ()
 

Detailed Description

Definition at line 47 of file common_settings.h.

Constructor & Destructor Documentation

◆ COMMON_SETTINGS()

COMMON_SETTINGS::COMMON_SETTINGS ( )

Definition at line 47 of file common_settings.cpp.

47  :
49  m_Appearance(),
50  m_Backup(),
51  m_Env(),
52  m_Input(),
53  m_Graphics(),
54  m_Session(),
55  m_System(),
57 {
58  // This only effect the first time KiCad is run. The user's setting will be used for all
59  // subsequent runs.
60  // Menu icons are off by default on OSX and on for all other platforms.
61  // Use automatic canvas scaling on OSX, but not on the other platforms (their detection
62  // isn't as good).
63 #if defined( __WXMAC__ )
64  bool defaultUseIconsInMenus = false;
65  double canvasScale = 0.0;
66 #else
67  bool defaultUseIconsInMenus = true;
68  double canvasScale = 1.0;
69 #endif
70 
71  m_params.emplace_back( new PARAM<double>( "appearance.canvas_scale",
72  &m_Appearance.canvas_scale, canvasScale ) );
73 
74  m_params.emplace_back( new PARAM<int>( "appearance.icon_scale",
75  &m_Appearance.icon_scale, 0 ) );
76 
77  m_params.emplace_back( new PARAM_ENUM<ICON_THEME>( "appearance.icon_theme",
79 
80  m_params.emplace_back( new PARAM<bool>( "appearance.use_icons_in_menus",
81  &m_Appearance.use_icons_in_menus, defaultUseIconsInMenus ) );
82 
83  m_params.emplace_back( new PARAM<bool>( "auto_backup.enabled", &m_Backup.enabled, true ) );
84 
85  m_params.emplace_back( new PARAM<bool>( "auto_backup.backup_on_autosave",
86  &m_Backup.backup_on_autosave, false ) );
87 
88  m_params.emplace_back( new PARAM<int>( "auto_backup.limit_total_files",
89  &m_Backup.limit_total_files, 25 ) );
90 
91  m_params.emplace_back( new PARAM<unsigned long long>( "auto_backup.limit_total_size",
92  &m_Backup.limit_total_size, 104857600 ) );
93 
94  m_params.emplace_back( new PARAM<int>( "auto_backup.limit_daily_files",
96 
97  m_params.emplace_back( new PARAM<int>( "auto_backup.min_interval",
98  &m_Backup.min_interval, 300 ) );
99 
100  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "environment.vars",
101  [&]() -> nlohmann::json
102  {
103  nlohmann::json ret = {};
104 
105  for( const std::pair<wxString, ENV_VAR_ITEM> entry : m_Env.vars )
106  {
107  const ENV_VAR_ITEM& var = entry.second;
108 
109  wxASSERT( entry.first == var.GetKey() );
110 
111  // Default values are never persisted
112  if( var.IsDefault() )
113  {
114  wxLogTrace( traceEnvVars,
115  "COMMON_SETTINGS: Env var %s skipping save (default)",
116  var.GetKey() );
117  continue;
118  }
119 
120  wxString value = var.GetValue();
121 
122  // Vars that existed in JSON are persisted, but if they were overridden
123  // externally, we persist the old value (i.e. the one that was loaded from JSON)
124  if( var.GetDefinedExternally() )
125  {
126  if( var.GetDefinedInSettings() )
127  {
128  wxLogTrace( traceEnvVars,
129  "COMMON_SETTINGS: Env var %s was overridden externally, "
130  "saving previously-loaded value %s",
131  var.GetKey(), var.GetSettingsValue() );
132  value = var.GetSettingsValue();
133  }
134  else
135  {
136  wxLogTrace( traceEnvVars,
137  "COMMON_SETTINGS: Env var %s skipping save (external)",
138  var.GetKey() );
139  continue;
140  }
141  }
142 
143  wxLogTrace( traceEnvVars,
144  "COMMON_SETTINGS: Saving env var %s = %s",
145  var.GetKey(), value);
146 
147  std::string key( var.GetKey().ToUTF8() );
148  ret[key] = value;
149  }
150 
151  return ret;
152  },
153  [&]( const nlohmann::json& aJson )
154  {
155  if( !aJson.is_object() )
156  return;
157 
158  for( const auto& entry : aJson.items() )
159  {
160  wxString key = wxString( entry.key().c_str(), wxConvUTF8 );
161  wxString val = entry.value().get<wxString>();
162 
163  if( m_Env.vars.count( key ) )
164  {
165  if( m_Env.vars[key].GetDefinedExternally() )
166  {
167  wxLogTrace( traceEnvVars, "COMMON_SETTINGS: %s is defined externally",
168  key );
169  m_Env.vars[key].SetDefinedInSettings();
170  m_Env.vars[key].SetSettingsValue( val );
171  continue;
172  }
173  else
174  {
175  wxLogTrace( traceEnvVars, "COMMON_SETTINGS: Updating %s: %s -> %s",
176  key, m_Env.vars[key].GetValue(), val );
177  m_Env.vars[key].SetValue( val );
178  }
179  }
180  else
181  {
182  wxLogTrace( traceEnvVars, "COMMON_SETTINGS: Loaded new var: %s = %s",
183  key, val );
184  m_Env.vars[key] = ENV_VAR_ITEM( key, val );
185  }
186 
187  m_Env.vars[key].SetDefinedInSettings();
188  m_Env.vars[key].SetSettingsValue( val );
189  }
190  },
191  {} ) );
192 
193  m_params.emplace_back( new PARAM<bool>( "input.auto_pan", &m_Input.auto_pan, false ) );
194 
195  m_params.emplace_back( new PARAM<int>( "input.auto_pan_acceleration",
197 
198  m_params.emplace_back( new PARAM<bool>( "input.center_on_zoom",
199  &m_Input.center_on_zoom, true ) );
200 
201  m_params.emplace_back( new PARAM<bool>( "input.immediate_actions",
202  &m_Input.immediate_actions, true ) );
203 
204  m_params.emplace_back( new PARAM<bool>( "input.warp_mouse_on_move",
205  &m_Input.warp_mouse_on_move, true ) );
206 
207  m_params.emplace_back( new PARAM<bool>( "input.horizontal_pan",
208  &m_Input.horizontal_pan, false ) );
209 
210  m_params.emplace_back( new PARAM<bool>( "input.zoom_acceleration",
211  &m_Input.zoom_acceleration, false ) );
212 
213 #ifdef __WXMAC__
214  int default_zoom_speed = 5;
215 #else
216  int default_zoom_speed = 1;
217 #endif
218 
219  m_params.emplace_back( new PARAM<int>( "input.zoom_speed",
220  &m_Input.zoom_speed, default_zoom_speed ) );
221 
222  m_params.emplace_back( new PARAM<bool>( "input.zoom_speed_auto",
223  &m_Input.zoom_speed_auto, true ) );
224 
225  m_params.emplace_back( new PARAM<int>( "input.scroll_modifier_zoom",
227 
228  m_params.emplace_back( new PARAM<int>( "input.scroll_modifier_pan_h",
229  &m_Input.scroll_modifier_pan_h, WXK_CONTROL ) );
230 
231  m_params.emplace_back( new PARAM<int>( "input.scroll_modifier_pan_v",
232  &m_Input.scroll_modifier_pan_v, WXK_SHIFT ) );
233 
234  m_params.emplace_back( new PARAM_ENUM<MOUSE_DRAG_ACTION>( "input.mouse_left",
237 
238  m_params.emplace_back( new PARAM_ENUM<MOUSE_DRAG_ACTION>( "input.mouse_middle",
241 
242  m_params.emplace_back( new PARAM_ENUM<MOUSE_DRAG_ACTION>( "input.mouse_right",
245 
246  m_params.emplace_back( new PARAM<int>( "graphics.opengl_antialiasing_mode",
247  &m_Graphics.opengl_aa_mode, 0, 0, 2 ) );
248 
249  m_params.emplace_back( new PARAM<int>( "graphics.cairo_antialiasing_mode",
250  &m_Graphics.cairo_aa_mode, 0, 0, 2 ) );
251 
252  m_params.emplace_back( new PARAM<int>( "system.autosave_interval",
253  &m_System.autosave_interval, 600 ) );
254 
255  m_params.emplace_back( new PARAM<wxString>( "system.editor_name",
256  &m_System.editor_name, "" ) );
257 
258  m_params.emplace_back( new PARAM<int>( "system.file_history_size",
259  &m_System.file_history_size, 9 ) );
260 
261  m_params.emplace_back( new PARAM<wxString>( "system.language",
262  &m_System.language, "Default" ) );
263 
264  m_params.emplace_back( new PARAM<wxString>( "system.pdf_viewer_name",
265  &m_System.pdf_viewer_name, "" ) );
266 
267  m_params.emplace_back( new PARAM<bool>( "system.use_system_pdf_viewer",
268  &m_System.use_system_pdf_viewer, true ) );
269 
270  m_params.emplace_back( new PARAM<wxString>( "system.working_dir",
271  &m_System.working_dir, "" ) );
272 
273  m_params.emplace_back( new PARAM<int>( "system.clear_3d_cache_interval",
275 
276  m_params.emplace_back( new PARAM<bool>( "do_not_show_again.zone_fill_warning",
278 
279  m_params.emplace_back( new PARAM<bool>( "do_not_show_again.env_var_overwrite_warning",
281 
282  m_params.emplace_back( new PARAM<bool>( "do_not_show_again.scaled_3d_models_warning",
284 
285  m_params.emplace_back( new PARAM<bool>( "session.remember_open_files",
286  &m_Session.remember_open_files, false ) );
287 
288  m_params.emplace_back( new PARAM<int>( "netclass_panel.sash_pos",
289  &m_NetclassPanel.sash_pos, 160 ) );
290 
291  registerMigration( 0, 1, std::bind( &COMMON_SETTINGS::migrateSchema0to1, this ) );
292  registerMigration( 1, 2, std::bind( &COMMON_SETTINGS::migrateSchema1to2, this ) );
293 }
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.
MOUSE_DRAG_ACTION drag_left
KiCad uses environment variables internally for determining the base paths for libraries,...
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
Stores an enum as an integer.
Definition: parameters.h:226
nlohmann::json json
Definition: gerbview.cpp:41
MOUSE_DRAG_ACTION drag_right
NETCLASS_PANEL m_NetclassPanel
ENVIRONMENT m_Env
const wxChar *const traceEnvVars
Flag to enable debug output of environment variable operations.
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:63
int min_interval
Minimum time, in seconds, between subsequent backups.
DO_NOT_SHOW_AGAIN m_DoNotShowAgain
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.
MOUSE_DRAG_ACTION drag_middle
int limit_total_files
Maximum number of backup archives to retain.

References AUTO, COMMON_SETTINGS::AUTO_BACKUP::backup_on_autosave, COMMON_SETTINGS::APPEARANCE::canvas_scale, COMMON_SETTINGS::AUTO_BACKUP::enabled, COMMON_SETTINGS::APPEARANCE::icon_scale, COMMON_SETTINGS::APPEARANCE::icon_theme, LIGHT, 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, JSON_SETTINGS::m_params, COMMON_SETTINGS::AUTO_BACKUP::min_interval, traceEnvVars, COMMON_SETTINGS::APPEARANCE::use_icons_in_menus, USER, and COMMON_SETTINGS::ENVIRONMENT::vars.

◆ ~COMMON_SETTINGS()

virtual COMMON_SETTINGS::~COMMON_SETTINGS ( )
inlinevirtual

Definition at line 134 of file common_settings.h.

134 {}

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

754 {
755  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
756  m_nested_settings.push_back( aSettings );
757 }
wxString GetFilename() const
Definition: json_settings.h:71
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().

◆ At()

nlohmann::json & JSON_SETTINGS::At ( const std::string &  aPath)
inherited

Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

Definition at line 110 of file json_settings.cpp.

111 {
112  return m_internals->At( aPath );
113 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string &  aPath) const
inherited

Definition at line 116 of file json_settings.cpp.

117 {
118  return m_internals->contains( JSON_SETTINGS_INTERNALS::PointerFromString( aPath ) );
119 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SETTINGS_MANAGER::SaveColorSettings().

◆ Count()

size_t JSON_SETTINGS::Count ( const std::string &  aPath) const
inherited

Definition at line 122 of file json_settings.cpp.

123 {
125 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().

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

667 {
668  ValueType val;
669 
670  if( aConfig->Read( aKey, &val ) )
671  {
672  try
673  {
674  ( *m_internals )[aDest] = val;
675  }
676  catch( ... )
677  {
678  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
679  return false;
680  }
681 
682  return true;
683  }
684 
685  return false;
686 }

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

727 {
728  wxString str;
729 
730  if( aConfig->Read( aKey, &str ) )
731  {
733  color.SetFromWxString( str );
734 
735  try
736  {
737  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
738  ( *m_internals )[aDest] = js;
739  }
740  catch( ... )
741  {
742  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
743  return false;
744  }
745 
746  return true;
747  }
748 
749  return false;
750 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:41
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References color.

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

703 {
704  wxString str;
705 
706  if( aConfig->Read( aKey, &str ) )
707  {
708  try
709  {
710  ( *m_internals )[aDest] = str.ToUTF8();
711  }
712  catch( ... )
713  {
714  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
715  return false;
716  }
717 
718  return true;
719  }
720 
721  return false;
722 }

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

◆ Get() [1/2]

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

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

505 {
506  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
507  {
508  try
509  {
510  return ret->get<ValueType>();
511  }
512  catch( ... )
513  {
514  }
515  }
516 
517  return NULLOPT;
518 }
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(), 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 783 of file json_settings.cpp.

784 {
785  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
786  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
787 
788  return NULLOPT;
789 }
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 275 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 104 of file json_settings.cpp.

105 {
106  return wxString( m_filename + "." + getFileExt() );
107 }
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 484 of file json_settings.cpp.

485 {
486  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
487 
488  if( m_internals->contains( ptr ) )
489  {
490  try
491  {
492  return OPT<nlohmann::json>{ m_internals->at( ptr ) };
493  }
494  catch( ... )
495  {
496  }
497  }
498 
499  return OPT<nlohmann::json>{};
500 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::m_internals.

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(), PARAM_WXSTRING_MAP::MatchesFile(), SETTINGS_MANAGER::SaveColorSettings(), and NESTED_SETTINGS::SaveToFile().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 280 of file json_settings.h.

281  {
282  return wxEmptyString;
283  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 77 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ InitializeEnvironment()

void COMMON_SETTINGS::InitializeEnvironment ( )

Creates the built-in environment variables and sets their default values.

Definition at line 450 of file common_settings.cpp.

451 {
452  auto addVar =
453  [&]( const wxString& aKey, const wxString& aDefault )
454  {
455  m_Env.vars[aKey] = ENV_VAR_ITEM( aKey, aDefault, aDefault );
456 
457  wxString envValue;
458 
459  if( wxGetEnv( aKey, &envValue ) == true && !envValue.IsEmpty() )
460  {
461  m_Env.vars[aKey].SetValue( envValue );
462  m_Env.vars[aKey].SetDefinedExternally();
463  wxLogTrace( traceEnvVars,
464  "InitializeEnvironment: Entry %s defined externally as %s", aKey,
465  envValue );
466  }
467  else
468  {
469  wxLogTrace( traceEnvVars, "InitializeEnvironment: Setting entry %s to default %s",
470  aKey, aDefault );
471  }
472  };
473 
474  wxFileName basePath( PATHS::GetStockEDALibraryPath(), wxEmptyString );
475 
476  wxFileName path( basePath );
477  path.AppendDir( wxT( "modules" ) );
478  addVar( wxT( "KICAD6_FOOTPRINT_DIR" ), path.GetFullPath() );
479 
480  path = basePath;
481  path.AppendDir( wxT( "3dmodels" ) );
482  addVar( wxT( "KICAD6_3DMODEL_DIR" ), path.GetFullPath() );
483 
484  // We don't have just one default template path, so use this logic that originally was in
485  // PGM_BASE::InitPgm to determine the best default template path
486  {
487  // Attempt to find the best default template path.
488  SEARCH_STACK bases;
489  SEARCH_STACK templatePaths;
490 
491  SystemDirsAppend( &bases );
492 
493  for( unsigned i = 0; i < bases.GetCount(); ++i )
494  {
495  wxFileName fn( bases[i], wxEmptyString );
496 
497  // Add KiCad template file path to search path list.
498  fn.AppendDir( "template" );
499 
500  // Only add path if exists and can be read by the user.
501  if( fn.DirExists() && fn.IsDirReadable() )
502  {
503  wxLogTrace( tracePathsAndFiles, "Checking template path '%s' exists",
504  fn.GetPath() );
505  templatePaths.AddPaths( fn.GetPath() );
506  }
507  }
508 
509  if( templatePaths.IsEmpty() )
510  {
511  path = basePath;
512  path.AppendDir( "template" );
513  }
514  else
515  {
516  // Take the first one. There may be more but this will likely be the best option.
517  path.AssignDir( templatePaths[0] );
518  }
519 
520  addVar( wxT( "KICAD6_TEMPLATE_DIR" ), path.GetFullPath() );
521  }
522 
523  addVar( wxT( "KICAD_USER_TEMPLATE_DIR" ), PATHS::GetUserTemplatesPath() );
524 
525  path = basePath;
526  path.AppendDir( wxT( "library" ) );
527  addVar( wxT( "KICAD6_SYMBOL_DIR" ), path.GetFullPath() );
528 }
KiCad uses environment variables internally for determining the base paths for libraries,...
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
Look for files in a number of paths.
Definition: search_stack.h:41
static wxString GetUserTemplatesPath()
Gets the user path for custom templates.
Definition: paths.cpp:86
void SystemDirsAppend(SEARCH_STACK *aSearchStack)
Append system places to aSearchStack in a platform specific way and pertinent to KiCad programs.
ENVIRONMENT m_Env
const wxChar *const traceEnvVars
Flag to enable debug output of environment variable operations.
static wxString GetStockEDALibraryPath()
Gets the stock (install) EDA library data path, which is the base path for templates,...
Definition: paths.cpp:177
void AddPaths(const wxString &aPaths, int aIndex=-1)
Insert or append path(s).

References SEARCH_STACK::AddPaths(), PATHS::GetStockEDALibraryPath(), PATHS::GetUserTemplatesPath(), m_Env, path, SystemDirsAppend(), traceEnvVars, tracePathsAndFiles, and COMMON_SETTINGS::ENVIRONMENT::vars.

Referenced by PGM_BASE::InitPgm().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 128 of file json_settings.cpp.

129 {
130  return m_internals.get();
131 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsDefault()

bool JSON_SETTINGS::IsDefault ( const std::string &  aParamName)
inherited

Checks if the current state of a parameter matches its default value.

Parameters
aParamNameis the JSON path to the parameter
Returns
true if the given parameter is at its default value

Definition at line 372 of file json_settings.cpp.

373 {
374  for( const PARAM_BASE* param : m_params )
375  {
376  if( param->GetJsonPath() == aParamName )
377  return param->IsDefault();
378  }
379 
380  return false;
381 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 134 of file json_settings.cpp.

135 {
136  for( auto param : m_params )
137  {
138  try
139  {
140  param->Load( this, m_resetParamsIfMissing );
141  }
142  catch( ... )
143  {
144  // Skip unreadable parameters in file
145  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
146  }
147  }
148 }
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 151 of file json_settings.cpp.

152 {
153  // First, load all params to default values
154  m_internals->clear();
155  Load();
156 
157  bool success = true;
158  bool migrated = false;
159  bool legacy_migrated = false;
160 
161  LOCALE_IO locale;
162 
163  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
164  // Backup and restore during migration so that the original can be mutated if convenient
165  bool backed_up = false;
166  wxFileName temp;
167 
168  if( aPath.IsDirWritable() )
169  {
170  temp.AssignTempFileName( aPath.GetFullPath() );
171 
172  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
173  {
174  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
175  GetFullFilename() );
176  }
177  else
178  backed_up = true;
179  }
180 
181  // Silence popups if legacy file is read-only
182  wxLogNull doNotLog;
183 
184  wxConfigBase::DontCreateOnDemand();
185  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
186 
187  // If migrate fails or is not implemented, fall back to built-in defaults that were
188  // already loaded above
189  if( !MigrateFromLegacy( cfg.get() ) )
190  {
191  wxLogTrace( traceSettings,
192  "%s: migrated; not all settings were found in legacy file",
193  GetFullFilename() );
194  }
195  else
196  {
197  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
198  }
199 
200  if( backed_up )
201  {
202  cfg.reset();
203 
204  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
205  {
206  wxLogTrace( traceSettings,
207  "migrate; copy temp file %s to %s failed",
208  temp.GetFullPath(), aPath.GetFullPath() );
209  }
210 
211  if( !wxRemoveFile( temp.GetFullPath() ) )
212  {
213  wxLogTrace( traceSettings,
214  "migrate; failed to remove temp file %s",
215  temp.GetFullPath() );
216  }
217  }
218 
219  // Either way, we want to clean up the old file afterwards
220  legacy_migrated = true;
221  };
222 
223  wxFileName path;
224 
225  if( aDirectory.empty() )
226  {
227  path.Assign( m_filename );
228  path.SetExt( getFileExt() );
229  }
230  else
231  {
232  wxString dir( aDirectory );
233  path.Assign( dir, m_filename, getFileExt() );
234  }
235 
236  if( !path.Exists() )
237  {
238  // Case 1: legacy migration, no .json extension yet
239  path.SetExt( getLegacyFileExt() );
240 
241  if( path.Exists() )
242  {
243  migrateFromLegacy( path );
244  }
245  // Case 2: legacy filename is different from new one
246  else if( !m_legacy_filename.empty() )
247  {
248  path.SetName( m_legacy_filename );
249 
250  if( path.Exists() )
251  migrateFromLegacy( path );
252  }
253  else
254  {
255  success = false;
256  }
257  }
258  else
259  {
260  if( !path.IsFileWritable() )
261  m_writeFile = false;
262 
263  try
264  {
265  FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
266 
267  if( fp )
268  {
269  *static_cast<nlohmann::json*>( m_internals.get() ) =
270  nlohmann::json::parse( fp, nullptr,
271  /* allow_exceptions = */ true,
272  /* ignore_comments = */ true );
273 
274  // If parse succeeds, check if schema migration is required
275  int filever = -1;
276 
277  try
278  {
279  filever = m_internals->Get<int>( "meta.version" );
280  }
281  catch( ... )
282  {
283  wxLogTrace( traceSettings, "%s: file version could not be read!",
284  GetFullFilename() );
285  success = false;
286  }
287 
288  if( filever >= 0 && filever < m_schemaVersion )
289  {
290  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
291  GetFullFilename(), filever, m_schemaVersion );
292 
293  if( Migrate() )
294  {
295  migrated = true;
296  }
297  else
298  {
299  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
300  }
301  }
302  else if( filever > m_schemaVersion )
303  {
304  wxLogTrace( traceSettings,
305  "%s: warning: file version %d is newer than latest (%d)",
306  GetFullFilename(), filever, m_schemaVersion );
307  }
308  }
309  else
310  {
311  wxLogTrace( traceSettings, "%s exists but can't be opened for read",
312  GetFullFilename() );
313  }
314  }
315  catch( nlohmann::json::parse_error& error )
316  {
317  wxLogTrace( traceSettings, "Json parse error reading %s: %s",
318  path.GetFullPath(), error.what() );
319  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
320  migrateFromLegacy( path );
321  }
322  }
323 
324  // Now that we have new data in the JSON structure, load the params again
325  Load();
326 
327  // And finally load any nested settings
328  for( auto settings : m_nested_settings )
329  settings->LoadFromFile();
330 
331  wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
332 
333  // If we migrated, clean up the legacy file (with no extension)
334  if( legacy_migrated || migrated )
335  {
336  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
337  {
338  wxLogTrace( traceSettings, "Warning: could not remove legacy file %s",
339  path.GetFullPath() );
340  }
341 
342  // And write-out immediately so that we don't lose data if the program later crashes.
344  SaveToFile( aDirectory, true );
345  }
346 
347  return success;
348 }
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::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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
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_internals, 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(), path, 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 562 of file json_settings.cpp.

563 {
564  int filever = m_internals->Get<int>( "meta.version" );
565 
566  while( filever < m_schemaVersion )
567  {
568  if( !m_migrators.count( filever ) )
569  {
570  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
571  typeid( *this ).name(), filever );
572  return false;
573  }
574 
575  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
576 
577  if( pair.second() )
578  {
579  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
580  filever, pair.first );
581  filever = pair.first;
582  m_internals->At( "meta.version" ) = filever;
583  }
584  else
585  {
586  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
587  typeid( *this ).name(), filever, pair.first );
588  return false;
589  }
590  }
591 
592  return true;
593 }
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>
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, 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 364 of file common_settings.cpp.

365 {
366  bool ret = true;
367 
368  ret &= fromLegacy<double>( aCfg, "CanvasScale", "appearance.canvas_scale" );
369  ret &= fromLegacy<int>( aCfg, "IconScale", "appearance.icon_scale" );
370  ret &= fromLegacy<bool>( aCfg, "UseIconsInMenus", "appearance.use_icons_in_menus" );
371 
372 // Force OSX to automatically scale the canvas. Before v6, the user setting wasn't used on OSX
373 // and was set to 1.0. In v6, the setting is now used by OSX and should default to automatic
374 // scaling.
375 #ifdef __WXMAC__
376  Set( "appearance.canvas_scale", 0.0 );
377 #endif
378 
379  ret &= fromLegacy<bool>( aCfg, "ShowEnvVarWarningDialog", "environment.show_warning_dialog" );
380 
381  auto load_env_vars = [&] () {
382  wxString key, value;
383  long index = 0;
384  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( "environment.vars" );
385 
386  aCfg->SetPath( "EnvironmentVariables" );
387  ( *m_internals )[ptr] = nlohmann::json( {} );
388 
389  while( aCfg->GetNextEntry( key, index ) )
390  {
391  if( envVarBlacklist.count( key ) )
392  {
393  wxLogTrace( traceSettings, "Migrate Env: %s is blacklisted; skipping.", key );
394  continue;
395  }
396 
397  value = aCfg->Read( key, wxEmptyString );
398 
399  if( !value.IsEmpty() )
400  {
401  ptr.push_back( key.ToStdString() );
402 
403  wxLogTrace( traceSettings, "Migrate Env: %s=%s", ptr.to_string(), value );
404  ( *m_internals )[ptr] = value.ToUTF8();
405 
406  ptr.pop_back();
407  }
408  }
409 
410  aCfg->SetPath( ".." );
411  };
412 
413  load_env_vars();
414 
415  bool mousewheel_pan = false;
416 
417  if( aCfg->Read( "MousewheelPAN", &mousewheel_pan ) && mousewheel_pan )
418  {
419  Set( "input.horizontal_pan", true );
420  Set( "input.scroll_modifier_pan_h", static_cast<int>( WXK_SHIFT ) );
421  Set( "input.scroll_modifier_pan_v", 0 );
422  Set( "input.scroll_modifier_zoom", static_cast<int>( WXK_CONTROL ) );
423  }
424 
425  ret &= fromLegacy<bool>( aCfg, "AutoPAN", "input.auto_pan" );
426  ret &= fromLegacy<bool>( aCfg, "ImmediateActions", "input.immediate_actions" );
427  ret &= fromLegacy<bool>( aCfg, "PreferSelectionToDragging", "input.prefer_select_to_drag" );
428  ret &= fromLegacy<bool>( aCfg, "MoveWarpsCursor", "input.warp_mouse_on_move" );
429  ret &= fromLegacy<bool>( aCfg, "ZoomNoCenter", "input.center_on_zoom" );
430 
431  // This was stored inverted in legacy config
432  if( OPT<bool> value = Get<bool>( "input.center_on_zoom" ) )
433  Set( "input.center_on_zoom", !( *value ) );
434 
435  ret &= fromLegacy<int>( aCfg, "OpenGLAntialiasingMode", "graphics.opengl_antialiasing_mode" );
436  ret &= fromLegacy<int>( aCfg, "CairoAntialiasingMode", "graphics.cairo_antialiasing_mode" );
437 
438  ret &= fromLegacy<int>( aCfg, "AutoSaveInterval", "system.autosave_interval" );
439  ret &= fromLegacyString( aCfg, "Editor", "system.editor_name" );
440  ret &= fromLegacy<int>( aCfg, "FileHistorySize", "system.file_history_size" );
441  ret &= fromLegacyString( aCfg, "LanguageID", "system.language" );
442  ret &= fromLegacyString( aCfg, "PdfBrowserName", "system.pdf_viewer_name" );
443  ret &= fromLegacy<bool>( aCfg, "UseSystemBrowser", "system.use_system_pdf_viewer" );
444  ret &= fromLegacyString( aCfg, "WorkingDir", "system.working_dir" );
445 
446  return ret;
447 }
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
nlohmann::json json
Definition: gerbview.cpp:41
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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 std::set< wxString > envVarBlacklist
! The following environment variables will never be migrated from a previous version
boost::optional< T > OPT
Definition: optional.h:7
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References envVarBlacklist, JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::m_internals, JSON_SETTINGS::Set(), 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 296 of file common_settings.cpp.

297 {
304  nlohmann::json::json_pointer mwp_pointer( "/input/mousewheel_pan"_json_pointer );
305 
306  bool mwp = false;
307 
308  try
309  {
310  mwp = m_internals->at( mwp_pointer );
311  m_internals->At( "input" ).erase( "mousewheel_pan" );
312  }
313  catch( ... )
314  {
315  wxLogTrace( traceSettings, "COMMON_SETTINGS::Migrate 0->1: mousewheel_pan not found" );
316  }
317 
318  if( mwp )
319  {
320  ( *m_internals )[nlohmann::json::json_pointer( "/input/horizontal_pan" )] = true;
321 
322  ( *m_internals )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_h" )] = WXK_SHIFT;
323  ( *m_internals )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_v" )] = 0;
324  ( *m_internals )[nlohmann::json::json_pointer( "/input/scroll_modifier_zoom" )] = WXK_CONTROL;
325  }
326  else
327  {
328  ( *m_internals )[nlohmann::json::json_pointer( "/input/horizontal_pan" )] = false;
329 
330  ( *m_internals )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_h" )] = WXK_CONTROL;
331  ( *m_internals )[nlohmann::json::json_pointer( "/input/scroll_modifier_pan_v" )] = WXK_SHIFT;
332  ( *m_internals )[nlohmann::json::json_pointer( "/input/scroll_modifier_zoom" )] = 0;
333  }
334 
335  return true;
336 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::m_internals, and traceSettings.

◆ migrateSchema1to2()

bool COMMON_SETTINGS::migrateSchema1to2 ( )
private

Definition at line 339 of file common_settings.cpp.

340 {
341  nlohmann::json::json_pointer v1_pointer( "/input/prefer_select_to_drag"_json_pointer );
342 
343  bool prefer_selection = false;
344 
345  try
346  {
347  prefer_selection = m_internals->at( v1_pointer );
348  m_internals->at( nlohmann::json::json_pointer( "/input"_json_pointer ) ).erase( "prefer_select_to_drag" );
349  }
350  catch( ... )
351  {
352  wxLogTrace( traceSettings, "COMMON_SETTINGS::Migrate 1->2: prefer_select_to_drag not found" );
353  }
354 
355  if( prefer_selection )
356  ( *m_internals )[nlohmann::json::json_pointer( "/input/mouse_left" )] = MOUSE_DRAG_ACTION::SELECT;
357  else
358  ( *m_internals )[nlohmann::json::json_pointer( "/input/mouse_left" )] = MOUSE_DRAG_ACTION::DRAG_ANY;
359 
360  return true;
361 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References DRAG_ANY, JSON_SETTINGS::m_internals, SELECT, and traceSettings.

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

555 {
556  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
557  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
558  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
559 }
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(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_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 760 of file json_settings.cpp.

761 {
762  if( !aSettings )
763  return;
764 
765  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
766  [&aSettings]( const JSON_SETTINGS* aPtr ) {
767  return aPtr == aSettings;
768  } );
769 
770  if( it != m_nested_settings.end() )
771  {
772  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
773  ( *it )->SaveToFile();
774  m_nested_settings.erase( it );
775  }
776 
777  aSettings->SetParent( nullptr );
778 }
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
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::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

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

366 {
367  for( auto param : m_params )
368  param->SetDefault();
369 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER_FRAME::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 384 of file json_settings.cpp.

385 {
386  if( !m_writeFile )
387  return false;
388 
389  // Default PROJECT won't have a filename set
390  if( m_filename.IsEmpty() )
391  return false;
392 
393  wxFileName path;
394 
395  if( aDirectory.empty() )
396  {
397  path.Assign( m_filename );
398  path.SetExt( getFileExt() );
399  }
400  else
401  {
402  wxString dir( aDirectory );
403  path.Assign( dir, m_filename, getFileExt() );
404  }
405 
406  if( !m_createIfMissing && !path.FileExists() )
407  {
408  wxLogTrace( traceSettings,
409  "File for %s doesn't exist and m_createIfMissing == false; not saving",
410  GetFullFilename() );
411  return false;
412  }
413 
414  // Ensure the path exists, and create it if not.
415  if( !path.DirExists() && !path.Mkdir() )
416  {
417  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
418  path.GetPath(), GetFullFilename() );
419  return false;
420  }
421 
422  if( ( path.FileExists() && !path.IsFileWritable() ) ||
423  ( !path.FileExists() && !path.IsDirWritable() ) )
424  {
425  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
426  return false;
427  }
428 
429  bool modified = false;
430 
431  for( auto settings : m_nested_settings )
432  modified |= settings->SaveToFile();
433 
434  modified |= Store();
435 
436  if( !modified && !aForce && path.FileExists() )
437  {
438  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
439  return false;
440  }
441  else if( !modified && !aForce && !m_createIfDefault )
442  {
443  wxLogTrace( traceSettings,
444  "%s contents still default and m_createIfDefault == false; not saving",
445  GetFullFilename() );
446  return false;
447  }
448 
449  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
450 
452  bool success = true;
453 
454  try
455  {
456  std::stringstream buffer;
457  buffer << std::setw( 2 ) << *m_internals << std::endl;
458 
459  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
460 
461  if( !fileStream.IsOk()
462  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
463  {
464  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
465  success = false;
466  }
467  }
468  catch( nlohmann::json::exception& error )
469  {
470  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
471  GetFullFilename(), error.what() );
472  success = false;
473  }
474  catch( ... )
475  {
476  wxLogTrace( traceSettings, "Error: could not save %s." );
477  success = false;
478  }
479 
480  return success;
481 }
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
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:71
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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.
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_internals, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, path, 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 >
template void JSON_SETTINGS::Set< const char * > ( const std::string &  aPath,
ValueType  aVal 
)
inherited

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

793 {
794  ( *m_internals )[aPath] = aVal.ToUTF8();
795 }

◆ SetFilename()

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

Definition at line 75 of file json_settings.h.

75 { 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(), and SETTINGS_MANAGER::SaveProjectCopy().

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

606 {
607  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
608 
609  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
610  {
611  aTarget = aObj.at( ptr ).get<wxString>();
612  return true;
613  }
614 
615  return false;
616 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::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 619 of file json_settings.cpp.

621 {
622  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
623 
624  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
625  {
626  aTarget = aObj.at( ptr ).get<bool>();
627  return true;
628  }
629 
630  return false;
631 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::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 634 of file json_settings.cpp.

636 {
637  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
638 
639  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
640  {
641  aTarget = aObj.at( ptr ).get<int>();
642  return true;
643  }
644 
645  return false;
646 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::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 649 of file json_settings.cpp.

651 {
652  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
653 
654  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
655  {
656  aTarget = aObj.at( ptr ).get<unsigned int>();
657  return true;
658  }
659 
660  return false;
661 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 79 of file json_settings.h.

79 { 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 SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 196 of file json_settings.h.

197  {
198  m_manager = aManager;
199  }
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 82 of file json_settings.h.

82 { 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 351 of file json_settings.cpp.

352 {
353  bool modified = false;
354 
355  for( auto param : m_params )
356  {
357  modified |= !param->MatchesFile( this );
358  param->Store( this );
359  }
360 
361  return modified;
362 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ 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 307 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 301 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 313 of file json_settings.h.

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

◆ m_DoNotShowAgain

DO_NOT_SHOW_AGAIN COMMON_SETTINGS::m_DoNotShowAgain

Definition at line 162 of file common_settings.h.

◆ m_Env

ENVIRONMENT COMMON_SETTINGS::m_Env

◆ m_filename

◆ m_Graphics

◆ m_Input

◆ m_internals

◆ 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 289 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 292 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 322 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 325 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 298 of file json_settings.h.

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

◆ m_NetclassPanel

◆ m_params

◆ 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 316 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

SESSION COMMON_SETTINGS::m_Session

◆ m_System

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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