KiCad PCB EDA Suite
EESCHEMA_SETTINGS Class Reference

#include <eeschema_settings.h>

Inheritance diagram for EESCHEMA_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  APPEARANCE
 
struct  AUI_PANELS
 
struct  AUTOPLACE_FIELDS
 
struct  BOM_PLUGIN_SETTINGS
 
struct  DRAWING
 
struct  FIND_REPLACE_EXTRA
 
struct  INPUT
 
struct  NETLIST_PLUGIN_SETTINGS
 
struct  PAGE_SETTINGS
 
struct  PANEL_ANNOTATE
 
struct  PANEL_BOM
 
struct  PANEL_FIELD_EDITOR
 
struct  PANEL_LIB_VIEW
 
struct  PANEL_NETLIST
 
struct  PANEL_PLOT
 
struct  PANEL_SYM_CHOOSER
 
struct  SELECTION
 
struct  SIMULATOR
 

Public Member Functions

 EESCHEMA_SETTINGS ()
 
virtual ~EESCHEMA_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
virtual const std::vector< wxString > DefaultGridSizeList () const
 By default, this returns the list of grids available in PcbNew-based applications. More...
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
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
 
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...
 
std::optional< 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 >
std::optional< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
std::optional< 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)
 
const std::string FormatAsString () const
 
bool LoadFromRawFile (const wxString &aPath)
 

Static Public Member Functions

static std::vector< BOM_PLUGIN_SETTINGSDefaultBomPlugins ()
 
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
 
AUTOPLACE_FIELDS m_AutoplaceFields
 
AUI_PANELS m_AuiPanels
 
DRAWING m_Drawing
 
FIND_REPLACE_EXTRA m_FindReplaceExtra
 
INPUT m_Input
 
PAGE_SETTINGS m_PageSettings
 
PANEL_ANNOTATE m_AnnotatePanel
 
PANEL_BOM m_BomPanel
 
PANEL_FIELD_EDITOR m_FieldEditorPanel
 
PANEL_LIB_VIEW m_LibViewPanel
 
PANEL_NETLIST m_NetlistPanel
 
PANEL_PLOT m_PlotPanel
 
PANEL_SYM_CHOOSER m_SymChooserPanel
 
SELECTION m_Selection
 
SIMULATOR m_Simulator
 
bool m_RescueNeverShow
 
wxString m_lastSymbolLibDir
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name. More...
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings More...
 

Protected Member Functions

virtual std::string getLegacyFrameName () const override
 
void migrateFindReplace (wxConfigBase *aCfg)
 ! Migrates the find/replace history string lists More...
 
bool migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
 Migrates legacy window settings into the JSON document. More...
 
void addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
 Adds parameters for the given window object. More...
 
bool migrateLibTreeWidth ()
 Migrates the library tree width setting from a single column (Item) to multi-column. More...
 
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
 

Static Protected Member Functions

template<typename ResultType >
static ResultType fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
 Helper to retrieve a value from a JSON object (dictionary) as a certain result type. More...
 

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 migrateBomSettings ()
 
nlohmann::json bomSettingsToJson () const
 
nlohmann::json netlistSettingsToJson () const
 

Static Private Member Functions

static std::vector< BOM_PLUGIN_SETTINGSbomSettingsFromJson (const nlohmann::json &aObj)
 
static std::vector< NETLIST_PLUGIN_SETTINGSnetlistSettingsFromJson (const nlohmann::json &aObj)
 

Detailed Description

Definition at line 43 of file eeschema_settings.h.

Constructor & Destructor Documentation

◆ EESCHEMA_SETTINGS()

EESCHEMA_SETTINGS::EESCHEMA_SETTINGS ( )

Definition at line 63 of file eeschema_settings.cpp.

63 :
67 m_Drawing(),
69 m_Input(),
72 m_BomPanel(),
80 m_RescueNeverShow( false )
81{
82 m_params.emplace_back( new PARAM<wxString>( "appearance.edit_symbol_visible_columns",
83 &m_Appearance.edit_symbol_visible_columns, "0 1 2 3 4 5 6 7" ) );
84
85 m_params.emplace_back( new PARAM<wxString>( "appearance.edit_sheet_visible_columns",
86 &m_Appearance.edit_sheet_visible_columns, "0 1 2 3 4 5 6 7" ) );
87
88 m_params.emplace_back( new PARAM<wxString>( "appearance.edit_label_visible_columns",
89 &m_Appearance.edit_label_visible_columns, "0 1 2 3 4 5 6 7" ) );
90
91 m_params.emplace_back( new PARAM<int>( "appearance.erc_severities",
93
94 m_params.emplace_back( new PARAM<bool>( "appearance.footprint_preview",
96
97 m_params.emplace_back( new PARAM<bool>( "appearance.print_sheet_reference",
99
100 m_params.emplace_back( new PARAM<wxString>( "appearance.default_font",
101 &m_Appearance.default_font, "KiCad Font" ) );
102
103 m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_pins",
104 &m_Appearance.show_hidden_pins, false ) );
105
106 m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_fields",
108
109 m_params.emplace_back( new PARAM<bool>( "appearance.show_erc_warnings",
111
112 m_params.emplace_back( new PARAM<bool>( "appearance.show_erc_errors",
113 &m_Appearance.show_erc_errors, true ) );
114
115 m_params.emplace_back( new PARAM<bool>( "appearance.show_erc_exclusions",
117
118 m_params.emplace_back( new PARAM<bool>( "appearance.show_illegal_symbol_lib_dialog",
120
121 m_params.emplace_back( new PARAM<bool>( "appearance.show_page_limits",
123
124 m_params.emplace_back( new PARAM<bool>( "appearance.show_sexpr_file_convert_warning",
126
127 m_params.emplace_back(
128 new PARAM<bool>( "appearance.show_sheet_filename_case_sensitivity_dialog",
130
131 m_params.emplace_back( new PARAM<bool>( "aui.show_schematic_hierarchy",
133
134 m_params.emplace_back( new PARAM<int>( "aui.hierarchy_panel_docked_width",
136
137 m_params.emplace_back( new PARAM<int>( "aui.hierarchy_panel_float_width",
139
140 m_params.emplace_back( new PARAM<int>( "aui.hierarchy_panel_float_height",
142
143 m_params.emplace_back( new PARAM<bool>( "aui.schematic_hierarchy_float",
145
146 m_params.emplace_back( new PARAM<bool>( "autoplace_fields.enable",
147 &m_AutoplaceFields.enable, true ) );
148
149 m_params.emplace_back( new PARAM<bool>( "autoplace_fields.allow_rejustify",
151
152 m_params.emplace_back( new PARAM<bool>( "autoplace_fields.align_to_grid",
154
155 m_params.emplace_back( new PARAM<int>( "drawing.default_bus_thickness",
157
158 m_params.emplace_back( new PARAM<int>( "drawing.default_junction_size",
160
161 m_params.emplace_back( new PARAM<int>( "drawing.pin_symbol_size",
163
164 m_params.emplace_back( new PARAM<double>( "drawing.text_offset_ratio",
165 &m_Drawing.text_offset_ratio, 0.08 ) );
166
167 m_params.emplace_back( new PARAM<int>( "drawing.default_line_thickness",
169
170 m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_x",
172
173 m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_y",
175
176 m_params.emplace_back( new PARAM<int>( "drawing.default_wire_thickness",
178
179 m_params.emplace_back( new PARAM<int>( "drawing.default_text_size",
181
182 m_params.emplace_back( new PARAM<wxString>( "drawing.field_names",
183 &m_Drawing.field_names, "" ) );
184
185 m_params.emplace_back( new PARAM<int>( "drawing.line_mode", &m_Drawing.line_mode,
187
188 m_params.emplace_back( new PARAM<bool>( "drawing.auto_start_wires",
189 &m_Drawing.auto_start_wires, true ) );
190
191 m_params.emplace_back( new PARAM<int>( "drawing.repeat_label_increment",
193
194 m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_border_color",
195 &m_Drawing.default_sheet_border_color, COLOR4D::UNSPECIFIED ) );
196
197 m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_background_color",
198 &m_Drawing.default_sheet_background_color, COLOR4D::UNSPECIFIED ) );
199
200 m_params.emplace_back( new PARAM_LIST<double>( "drawing.junction_size_mult_list",
201 &m_Drawing.junction_size_mult_list, { 0.0, 1.7, 4.0, 6.0, 9.0, 12.0 } ) );
202
203 m_params.emplace_back(new PARAM <int>( "drawing.junction_size_choice",
205
206 m_params.emplace_back( new PARAM<bool>( "find_replace.search_all_fields",
208
209 m_params.emplace_back( new PARAM<bool>( "find_replace.search_all_pins",
211
212 m_params.emplace_back( new PARAM<bool>( "find_replace.search_current_sheet_only",
214 false ) );
215
216 m_params.emplace_back( new PARAM<bool>( "find_replace.replace_references",
218
219 m_params.emplace_back( new PARAM<bool>( "input.drag_is_move",
220 &m_Input.drag_is_move, false ) );
221
222 m_params.emplace_back( new PARAM<bool>( "input.esc_clears_net_highlight",
224
225 m_params.emplace_back( new PARAM<int>( "selection.thickness",
227
228 m_params.emplace_back( new PARAM<int>( "selection.highlight_thickness",
230
231 m_params.emplace_back( new PARAM<bool>( "selection.draw_selected_children",
233
234 m_params.emplace_back( new PARAM<bool>( "selection.fill_shapes",
235 &m_Selection.fill_shapes, false ) );
236
237 m_params.emplace_back( new PARAM<bool>( "selection.select_pin_selects_symbol",
239
240 m_params.emplace_back( new PARAM<bool>( "annotation.automatic",
241 &m_AnnotatePanel.automatic, true ) );
242
243 m_params.emplace_back( new PARAM<bool>( "annotation.recursive",
244 &m_AnnotatePanel.recursive, true ) );
245
246 m_params.emplace_back( new PARAM<int>( "annotation.method",
247 &m_AnnotatePanel.method, 0, 0, 2 ) );
248
249 m_params.emplace_back( new PARAM<int>( "annotation.scope",
250 &m_AnnotatePanel.scope, 0, 0, 2 ) );
251
252 m_params.emplace_back( new PARAM<int>( "annotation.options",
253 &m_AnnotatePanel.options, 0, 0, 2 ) );
254
255 m_params.emplace_back( new PARAM<int>( "annotation.messages_filter",
257
258 m_params.emplace_back( new PARAM<int>( "annotation.sort_order",
259 &m_AnnotatePanel.sort_order, 0, 0, 1 ) );
260
261 m_params.emplace_back( new PARAM<wxString>( "bom.selected_plugin",
263
264 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "bom.plugins",
265 std::bind( &EESCHEMA_SETTINGS::bomSettingsToJson, this ),
266 [&]( const nlohmann::json& aObj )
267 {
268 if( !aObj.is_array() )
269 return;
270
271 const nlohmann::json& list = aObj.empty() ? defaultBomPlugins : aObj;
272
274 },
276
277 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "netlist.plugins",
279 [&]( const nlohmann::json& aObj )
280 {
281 if( !aObj.is_array() )
282 return;
283
284 if( aObj.empty() )
285 return;
286
287 const nlohmann::json& list = aObj;
288
290 },
291 nullptr ) );
292
293 m_params.emplace_back( new PARAM<bool>( "page_settings.export_paper",
294 &m_PageSettings.export_paper, false ) );
295
296 m_params.emplace_back( new PARAM<bool>( "page_settings.export_revision",
298
299 m_params.emplace_back( new PARAM<bool>( "page_settings.export_date",
300 &m_PageSettings.export_date, false ) );
301
302 m_params.emplace_back( new PARAM<bool>( "page_settings.export_title",
303 &m_PageSettings.export_title, false ) );
304
305 m_params.emplace_back( new PARAM<bool>( "page_settings.export_company",
306 &m_PageSettings.export_company, false ) );
307
308 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment1",
310
311 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment2",
313
314 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment3",
316
317 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment4",
319
320 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment5",
322
323 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment6",
325
326 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment7",
328
329 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment8",
331
332 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment9",
334
335 m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_show",
337
338 m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_group_by",
340
341 m_params.emplace_back( new PARAM_MAP<int>( "field_editor.column_widths",
343
344 m_params.emplace_back( new PARAM<bool>( "plot.background_color",
345 &m_PlotPanel.background_color, false ) );
346
347 m_params.emplace_back( new PARAM<bool>( "plot.color",
348 &m_PlotPanel.color, true ) );
349
350 m_params.emplace_back( new PARAM<wxString>( "plot.color_theme",
351 &m_PlotPanel.color_theme, wxT( "user" ) ) );
352
353 m_params.emplace_back( new PARAM<int>( "plot.format",
354 &m_PlotPanel.format, 0 ) );
355
356 m_params.emplace_back( new PARAM<bool>( "plot.frame_reference",
357 &m_PlotPanel.frame_reference, true ) );
358
359 m_params.emplace_back( new PARAM<int>( "plot.hpgl_paper_size",
361
362 m_params.emplace_back( new PARAM<double>( "plot.hpgl_pen_size",
363 &m_PlotPanel.hpgl_pen_size, 0.5 ) );
364
365 m_params.emplace_back( new PARAM<int>( "plot.hpgl_origin",
366 &m_PlotPanel.hpgl_origin, 0 ) );
367
368 m_params.emplace_back( new PARAM<bool>( "plot.other_open_file_after_plot",
370
371 m_params.emplace_back( new PARAM<int>( "simulator.window.pos_x",
373
374 m_params.emplace_back( new PARAM<int>( "simulator.window.pos_y",
376
377 m_params.emplace_back( new PARAM<int>( "simulator.window.size_x",
378 &m_Simulator.window.state.size_x, 500 ) );
379
380 m_params.emplace_back( new PARAM<int>( "simulator.window.size_y",
381 &m_Simulator.window.state.size_y, 400 ) );
382
383 m_params.emplace_back( new PARAM<unsigned int>( "simulator.window.display",
385
386 m_params.emplace_back( new PARAM<bool>( "simulator.window.maximized",
387 &m_Simulator.window.state.maximized, false ) );
388
389 m_params.emplace_back( new PARAM<wxString>( "simulator.window.perspective",
391
392 m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_width",
394
395 m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_height",
397
398 m_params.emplace_back( new PARAM<int>( "simulator.signal_panel_height",
400
401 m_params.emplace_back( new PARAM<int>( "simulator.cursors_panel_height",
403
404 m_params.emplace_back( new PARAM<bool>( "simulator.white_background",
405 &m_Simulator.white_background, false ) );
406
407 m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_h",
409
410 m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_v",
412
413 m_params.emplace_back( new PARAM<int>( "symbol_chooser.width",
414 &m_SymChooserPanel.width, -1 ) );
415
416 m_params.emplace_back( new PARAM<int>( "symbol_chooser.height",
417 &m_SymChooserPanel.height, -1 ) );
418
419 m_params.emplace_back( new PARAM<bool>( "symbol_chooser.keep_symbol",
420 &m_SymChooserPanel.keep_symbol, false ) );
421
422 m_params.emplace_back( new PARAM<bool>( "symbol_chooser.place_all_units",
424
425 m_params.emplace_back( new PARAM<bool>( "system.never_show_rescue_dialog",
426 &m_RescueNeverShow, false ) );
427
428 m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_x",
430
431 m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_y",
433
434 m_params.emplace_back( new PARAM<int>( "lib_view.window.size_x",
436
437 m_params.emplace_back( new PARAM<int>( "lib_view.window.size_y",
439
440 m_params.emplace_back( new PARAM<unsigned int>( "lib_view.window.display",
442
443 m_params.emplace_back( new PARAM<bool>( "lib_view.window.maximized",
445
446 m_params.emplace_back( new PARAM<wxString>( "lib_view.window.perspective",
448
449 m_params.emplace_back( new PARAM<int>( "lib_view.lib_list_width",
451
452 m_params.emplace_back( new PARAM<int>( "lib_view.cmp_list_width",
454
455 m_params.emplace_back( new PARAM<bool>( "lib_view.show_pin_electrical_type",
457
458 m_params.emplace_back( new PARAM<wxString>( "system.last_symbol_lib_dir",
459 &m_lastSymbolLibDir, "" ) );
460
461
462 // Migrations
463
464 registerMigration( 0, 1,
465 [&]() -> bool
466 {
467 // Version 0 to 1: BOM plugin settings moved from sexpr to JSON
468 return migrateBomSettings();
469 } );
470
471
472 registerMigration( 1, 2,
473 [&]() -> bool
474 {
475 // We used to have a bug on GTK which would set the lib tree column width way
476 // too narrow.
477 if( std::optional<int> optval = Get<int>( "lib_tree.column_width" ) )
478 {
479 if( optval < 150 )
480 Set( "lib_tree.column_width", 300 );
481 }
482
483 return true;
484 } );
485
486 registerMigration( 2, 3,
487 [&]() -> bool
488 {
489 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
490 return migrateLibTreeWidth();
491 } );
492}
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
bool migrateLibTreeWidth()
Migrates the library tree width setting from a single column (Item) to multi-column.
PANEL_ANNOTATE m_AnnotatePanel
PANEL_NETLIST m_NetlistPanel
nlohmann::json bomSettingsToJson() const
nlohmann::json netlistSettingsToJson() const
PANEL_SYM_CHOOSER m_SymChooserPanel
PAGE_SETTINGS m_PageSettings
static std::vector< BOM_PLUGIN_SETTINGS > bomSettingsFromJson(const nlohmann::json &aObj)
FIND_REPLACE_EXTRA m_FindReplaceExtra
PANEL_LIB_VIEW m_LibViewPanel
AUTOPLACE_FIELDS m_AutoplaceFields
static std::vector< NETLIST_PLUGIN_SETTINGS > netlistSettingsFromJson(const nlohmann::json &aObj)
PANEL_FIELD_EDITOR m_FieldEditorPanel
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
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...
Represents a map of <std::string, Value>.
Definition: parameters.h:548
#define DEFAULT_BUS_WIDTH_MILS
The default noconnect size in mils.
#define DEFAULT_JUNCTION_DIAM
The default bus and wire entry size in mils.
#define DEFAULT_WIRE_WIDTH_MILS
The default bus width in mils. (can be changed in preference menu)
#define DEFAULT_LINE_WIDTH_MILS
The default wire width in mils. (can be changed in preference menu)
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
const nlohmann::json defaultBomPlugins
Default value for bom.plugins.
const int eeschemaSchemaVersion
! Update the schema version whenever a migration is required
@ LINE_MODE_90
nlohmann::json json
Definition: gerbview.cpp:44
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
std::vector< double > junction_size_mult_list
std::vector< BOM_PLUGIN_SETTINGS > plugins
std::map< std::string, bool > fields_show
std::map< std::string, int > column_widths
std::map< std::string, bool > fields_group_by
std::vector< NETLIST_PLUGIN_SETTINGS > plugins
WINDOW_STATE state
Definition: app_settings.h:84
wxString perspective
Definition: app_settings.h:86
unsigned int display
Definition: app_settings.h:76

References EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::align_to_grid, EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::allow_rejustify, EESCHEMA_SETTINGS::DRAWING::auto_start_wires, EESCHEMA_SETTINGS::PANEL_ANNOTATE::automatic, EESCHEMA_SETTINGS::PANEL_PLOT::background_color, bomSettingsFromJson(), bomSettingsToJson(), EESCHEMA_SETTINGS::PANEL_LIB_VIEW::cmp_list_width, EESCHEMA_SETTINGS::PANEL_PLOT::color, EESCHEMA_SETTINGS::PANEL_PLOT::color_theme, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::column_widths, EESCHEMA_SETTINGS::SIMULATOR::cursors_panel_height, EESCHEMA_SETTINGS::DRAWING::default_bus_thickness, DEFAULT_BUS_WIDTH_MILS, EESCHEMA_SETTINGS::APPEARANCE::default_font, DEFAULT_JUNCTION_DIAM, EESCHEMA_SETTINGS::DRAWING::default_junction_size, EESCHEMA_SETTINGS::DRAWING::default_line_thickness, DEFAULT_LINE_WIDTH_MILS, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_x, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_y, EESCHEMA_SETTINGS::DRAWING::default_sheet_background_color, EESCHEMA_SETTINGS::DRAWING::default_sheet_border_color, DEFAULT_TEXT_SIZE, EESCHEMA_SETTINGS::DRAWING::default_text_size, EESCHEMA_SETTINGS::DRAWING::default_wire_thickness, DEFAULT_WIRE_WIDTH_MILS, defaultBomPlugins, WINDOW_STATE::display, EESCHEMA_SETTINGS::INPUT::drag_is_move, EESCHEMA_SETTINGS::SELECTION::draw_selected_children, EESCHEMA_SETTINGS::APPEARANCE::edit_label_visible_columns, EESCHEMA_SETTINGS::APPEARANCE::edit_sheet_visible_columns, EESCHEMA_SETTINGS::APPEARANCE::edit_symbol_visible_columns, EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, EESCHEMA_SETTINGS::APPEARANCE::erc_severities, EESCHEMA_SETTINGS::INPUT::esc_clears_net_highlight, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment1, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment2, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment3, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment4, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment5, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment6, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment7, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment8, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_comment9, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_company, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_date, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_paper, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_revision, EESCHEMA_SETTINGS::PAGE_SETTINGS::export_title, EESCHEMA_SETTINGS::DRAWING::field_names, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_group_by, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_show, EESCHEMA_SETTINGS::SELECTION::fill_shapes, EESCHEMA_SETTINGS::APPEARANCE::footprint_preview, EESCHEMA_SETTINGS::PANEL_PLOT::format, EESCHEMA_SETTINGS::PANEL_PLOT::frame_reference, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::height, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_docked_width, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_float_height, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_float_width, EESCHEMA_SETTINGS::SELECTION::highlight_thickness, EESCHEMA_SETTINGS::PANEL_PLOT::hpgl_origin, EESCHEMA_SETTINGS::PANEL_PLOT::hpgl_paper_size, EESCHEMA_SETTINGS::PANEL_PLOT::hpgl_pen_size, EESCHEMA_SETTINGS::DRAWING::junction_size_choice, EESCHEMA_SETTINGS::DRAWING::junction_size_mult_list, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::keep_symbol, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::lib_list_width, EESCHEMA_SETTINGS::DRAWING::line_mode, LINE_MODE_90, m_AnnotatePanel, m_Appearance, m_AuiPanels, m_AutoplaceFields, m_BomPanel, m_Drawing, m_FieldEditorPanel, m_FindReplaceExtra, m_Input, m_lastSymbolLibDir, m_LibViewPanel, m_NetlistPanel, m_PageSettings, JSON_SETTINGS::m_params, m_PlotPanel, m_RescueNeverShow, m_Selection, m_Simulator, m_SymChooserPanel, WINDOW_STATE::maximized, EESCHEMA_SETTINGS::PANEL_ANNOTATE::messages_filter, EESCHEMA_SETTINGS::PANEL_ANNOTATE::method, migrateBomSettings(), APP_SETTINGS_BASE::migrateLibTreeWidth(), netlistSettingsFromJson(), netlistSettingsToJson(), EESCHEMA_SETTINGS::PANEL_PLOT::open_file_after_plot, EESCHEMA_SETTINGS::PANEL_ANNOTATE::options, WINDOW_SETTINGS::perspective, EESCHEMA_SETTINGS::DRAWING::pin_symbol_size, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::place_all_units, EESCHEMA_SETTINGS::SIMULATOR::plot_panel_height, EESCHEMA_SETTINGS::SIMULATOR::plot_panel_width, EESCHEMA_SETTINGS::PANEL_BOM::plugins, EESCHEMA_SETTINGS::PANEL_NETLIST::plugins, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, EESCHEMA_SETTINGS::APPEARANCE::print_sheet_reference, EESCHEMA_SETTINGS::PANEL_ANNOTATE::recursive, JSON_SETTINGS::registerMigration(), EESCHEMA_SETTINGS::DRAWING::repeat_label_increment, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::replace_references, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_h, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_v, EESCHEMA_SETTINGS::AUI_PANELS::schematic_hierarchy_float, EESCHEMA_SETTINGS::PANEL_ANNOTATE::scope, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::search_all_fields, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::search_all_pins, EESCHEMA_SETTINGS::FIND_REPLACE_EXTRA::search_current_sheet_only, EESCHEMA_SETTINGS::SELECTION::select_pin_selects_symbol, EESCHEMA_SETTINGS::PANEL_BOM::selected_plugin, EESCHEMA_SETTINGS::SELECTION::selection_thickness, JSON_SETTINGS::Set(), EESCHEMA_SETTINGS::APPEARANCE::show_erc_errors, EESCHEMA_SETTINGS::APPEARANCE::show_erc_exclusions, EESCHEMA_SETTINGS::APPEARANCE::show_erc_warnings, EESCHEMA_SETTINGS::APPEARANCE::show_hidden_fields, EESCHEMA_SETTINGS::APPEARANCE::show_hidden_pins, EESCHEMA_SETTINGS::APPEARANCE::show_illegal_symbol_lib_dialog, EESCHEMA_SETTINGS::APPEARANCE::show_page_limits, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::show_pin_electrical_type, EESCHEMA_SETTINGS::AUI_PANELS::show_schematic_hierarchy, EESCHEMA_SETTINGS::APPEARANCE::show_sexpr_file_convert_warning, EESCHEMA_SETTINGS::APPEARANCE::show_sheet_filename_case_sensitivity_dialog, EESCHEMA_SETTINGS::SIMULATOR::signal_panel_height, WINDOW_STATE::size_x, WINDOW_STATE::size_y, EESCHEMA_SETTINGS::PANEL_ANNOTATE::sort_order, WINDOW_SETTINGS::state, EESCHEMA_SETTINGS::DRAWING::text_offset_ratio, EESCHEMA_SETTINGS::SIMULATOR::white_background, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::width, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::window, and EESCHEMA_SETTINGS::SIMULATOR::window.

◆ ~EESCHEMA_SETTINGS()

virtual EESCHEMA_SETTINGS::~EESCHEMA_SETTINGS ( )
inlinevirtual

Definition at line 252 of file eeschema_settings.h.

252{}

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

784{
785 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
786 m_nested_settings.push_back( aSettings );
787}
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
wxString GetFilename() const
Definition: json_settings.h:73
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().

◆ addParamsForWindow()

void APP_SETTINGS_BASE::addParamsForWindow ( WINDOW_SETTINGS aWindow,
const std::string &  aJsonPath 
)
protectedinherited

Adds parameters for the given window object.

Parameters
aWindowis the target window settings object
aJsonPathis the path to read parameters from

Definition at line 292 of file app_settings.cpp.

293{
294 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
295 &aWindow->state.maximized, false ) );
296
297 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
298 &aWindow->mru_path, "" ) );
299
300 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
301
302 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
303
304 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
305 &aWindow->perspective, "" ) );
306
307 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
308
309 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
310
311 m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
312
313 m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
314 &aWindow->zoom_factors, {} ) );
315
316 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
317 &aWindow->grid.axes_enabled, false ) );
318
319 m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
320 &aWindow->grid.sizes, DefaultGridSizeList() ) );
321
322 int defaultGridIdx;
323
324 if( m_filename == "eeschema" || m_filename == "symbol_editor" || m_filename == "pl_editor" )
325 defaultGridIdx = 1;
326 else
327 defaultGridIdx = 4;
328
329 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
330 &aWindow->grid.last_size_idx, defaultGridIdx ) );
331
332 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
333 &aWindow->grid.fast_grid_1, defaultGridIdx ) );
334
335 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
336 &aWindow->grid.fast_grid_2, defaultGridIdx + 1 ) );
337
338 // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
339 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
340 &aWindow->grid.user_grid_x, "10 mil" ) );
341 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
342 &aWindow->grid.user_grid_y, "10 mil" ) );
343
344 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
345 &aWindow->grid.line_width, 1.0 ) );
346
347 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
348 &aWindow->grid.min_spacing, 10 ) );
349
350 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
351 &aWindow->grid.show, true ) );
352
353 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
354 &aWindow->grid.style, 0 ) );
355
356 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
357 &aWindow->grid.snap, 0 ) );
358
359 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
360 &aWindow->cursor.always_show_cursor, true ) );
361
362 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
363 &aWindow->cursor.fullscreen_cursor, false ) );
364}
virtual const std::vector< wxString > DefaultGridSizeList() const
By default, this returns the list of grids available in PcbNew-based applications.
wxString m_filename
The filename (not including path) of this settings file (inicode)
bool always_show_cursor
Definition: app_settings.h:43
bool fullscreen_cursor
Definition: app_settings.h:44
wxString user_grid_x
Definition: app_settings.h:54
double line_width
Definition: app_settings.h:59
wxString user_grid_y
Definition: app_settings.h:55
double min_spacing
Definition: app_settings.h:60
std::vector< wxString > sizes
Definition: app_settings.h:53
CURSOR_SETTINGS cursor
Definition: app_settings.h:89
GRID_SETTINGS grid
Definition: app_settings.h:90
wxString mru_path
Definition: app_settings.h:85
std::vector< double > zoom_factors
Definition: app_settings.h:87

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, APP_SETTINGS_BASE::DefaultGridSizeList(), WINDOW_STATE::display, GRID_SETTINGS::fast_grid_1, GRID_SETTINGS::fast_grid_2, CURSOR_SETTINGS::fullscreen_cursor, WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, GRID_SETTINGS::line_width, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_params, WINDOW_STATE::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, GRID_SETTINGS::show, WINDOW_STATE::size_x, WINDOW_STATE::size_y, GRID_SETTINGS::sizes, GRID_SETTINGS::snap, WINDOW_SETTINGS::state, GRID_SETTINGS::style, GRID_SETTINGS::user_grid_x, GRID_SETTINGS::user_grid_y, and WINDOW_SETTINGS::zoom_factors.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), CVPCB_SETTINGS::CVPCB_SETTINGS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

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

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

References JSON_SETTINGS::m_internals.

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

◆ bomSettingsFromJson()

std::vector< EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::bomSettingsFromJson ( const nlohmann::json aObj)
staticprivate

Definition at line 827 of file eeschema_settings.cpp.

829{
830 std::vector<EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS> ret;
831
832 wxASSERT( aObj.is_array() );
833
834 for( const nlohmann::json& entry : aObj )
835 {
836 if( entry.empty() || !entry.is_object() )
837 continue;
838
839 if( !entry.contains( "name" ) || !entry.contains( "path" ) )
840 continue;
841
842 BOM_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
843 entry.at( "path" ).get<wxString>() );
844
845 if( entry.contains( "command" ) )
846 plugin.command = entry.at( "command" ).get<wxString>();
847
848 ret.emplace_back( plugin );
849 }
850
851 return ret;
852}

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command.

Referenced by DefaultBomPlugins(), and EESCHEMA_SETTINGS().

◆ bomSettingsToJson()

nlohmann::json EESCHEMA_SETTINGS::bomSettingsToJson ( ) const
private

Definition at line 808 of file eeschema_settings.cpp.

809{
810 nlohmann::json js = nlohmann::json::array();
811
812 for( const BOM_PLUGIN_SETTINGS& plugin : m_BomPanel.plugins )
813 {
814 nlohmann::json pluginJson;
815
816 pluginJson["name"] = plugin.name.ToUTF8();
817 pluginJson["path"] = plugin.path.ToUTF8();
818 pluginJson["command"] = plugin.command.ToUTF8();
819
820 js.push_back( pluginJson );
821 }
822
823 return js;
824}

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command, m_BomPanel, EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::name, EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::path, and EESCHEMA_SETTINGS::PANEL_BOM::plugins.

Referenced by EESCHEMA_SETTINGS(), and migrateBomSettings().

◆ Contains()

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

◆ DefaultBomPlugins()

std::vector< EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::DefaultBomPlugins ( )
static

Definition at line 777 of file eeschema_settings.cpp.

778{
780}

References bomSettingsFromJson(), and defaultBomPlugins.

Referenced by DIALOG_BOM::DIALOG_BOM().

◆ DefaultGridSizeList()

const std::vector< wxString > APP_SETTINGS_BASE::DefaultGridSizeList ( ) const
virtualinherited

By default, this returns the list of grids available in PcbNew-based applications.

Eeschema does not allow customization of the grid. If it ever does, override this in Eeschema settings to provide a different set of defaults.

Returns
a default value for the window.grid.sizes parameter

Definition at line 367 of file app_settings.cpp.

368{
369 return { "1000 mil",
370 "500 mil",
371 "250 mil",
372 "200 mil",
373 "100 mil",
374 "50 mil",
375 "25 mil",
376 "20 mil",
377 "10 mil",
378 "5 mil",
379 "2 mil",
380 "1 mil",
381 "5.0 mm",
382 "2.5 mm",
383 "1.0 mm",
384 "0.5 mm",
385 "0.25 mm",
386 "0.2 mm",
387 "0.1 mm",
388 "0.05 mm",
389 "0.025 mm",
390 "0.01 mm" };
391}

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), and DIALOG_GRID_SETTINGS::TransferDataToWindow().

◆ fetchOrDefault()

template<typename ResultType >
template bool JSON_SETTINGS::fetchOrDefault ( const nlohmann::json aJson,
const std::string &  aKey,
ResultType  aDefault = ResultType() 
)
staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 842 of file json_settings.cpp.

844{
845 ResultType ret = aDefault;
846
847 try
848 {
849 if( aJson.contains( aKey ) )
850 ret = aJson.at( aKey ).get<ResultType>();
851 }
852 catch( ... )
853 {
854 }
855
856 return ret;
857}

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( ) const
inherited

Definition at line 471 of file json_settings.cpp.

472{
474
475 std::stringstream buffer;
476 buffer << std::setw( 2 ) << *m_internals << std::endl;
477
478 return buffer.str();
479}
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:74

References dummy(), and JSON_SETTINGS::m_internals.

Referenced by ROUTER_TOOL::saveRouterDebugLog().

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

697{
698 ValueType val;
699
700 if( aConfig->Read( aKey, &val ) )
701 {
702 try
703 {
704 ( *m_internals )[aDest] = val;
705 }
706 catch( ... )
707 {
708 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
709 return false;
710 }
711
712 return true;
713 }
714
715 return false;
716}

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

757{
758 wxString str;
759
760 if( aConfig->Read( aKey, &str ) )
761 {
763 color.SetFromWxString( str );
764
765 try
766 {
767 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
768 ( *m_internals )[aDest] = js;
769 }
770 catch( ... )
771 {
772 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
773 return false;
774 }
775
776 return true;
777 }
778
779 return false;
780}
int color
Definition: DXF_plotter.cpp:57
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104

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

733{
734 wxString str;
735
736 if( aConfig->Read( aKey, &str ) )
737 {
738 try
739 {
740 ( *m_internals )[aDest] = str.ToUTF8();
741 }
742 catch( ... )
743 {
744 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
745 return false;
746 }
747
748 return true;
749 }
750
751 return false;
752}

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

◆ Get() [1/2]

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

Definition at line 813 of file json_settings.cpp.

814{
815 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
816 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
817
818 return std::nullopt;
819}
std::optional< 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....

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

template<typename ValueType >
template std::optional< 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 534 of file json_settings.cpp.

535{
536 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
537 {
538 try
539 {
540 return ret->get<ValueType>();
541 }
542 catch( ... )
543 {
544 }
545 }
546
547 return std::nullopt;
548}

References JSON_SETTINGS::GetJson().

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

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, 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 105 of file json_settings.cpp.

106{
107 return wxString( m_filename + "." + getFileExt() );
108}
virtual wxString getFileExt() const

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

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

◆ GetJson()

std::optional< 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 514 of file json_settings.cpp.

515{
516 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
517
518 if( m_internals->contains( ptr ) )
519 {
520 try
521 {
522 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
523 }
524 catch( ... )
525 {
526 }
527 }
528
529 return std::optional<nlohmann::json>{};
530}

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_SET< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_SET< Type >::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().

◆ getLegacyFrameName()

virtual std::string EESCHEMA_SETTINGS::getLegacyFrameName ( ) const
inlineoverrideprotectedvirtual

Reimplemented from APP_SETTINGS_BASE.

Definition at line 260 of file eeschema_settings.h.

260{ return "SchematicFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 80 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 123 of file json_settings.cpp.

124{
125 return m_internals.get();
126}

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 129 of file json_settings.cpp.

130{
131 for( auto param : m_params )
132 {
133 try
134 {
135 param->Load( this, m_resetParamsIfMissing );
136 }
137 catch( ... )
138 {
139 // Skip unreadable parameters in file
140 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
141 }
142 }
143}
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), 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 146 of file json_settings.cpp.

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

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::LoadProject(), SETTINGS_MANAGER::loadProjectFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString &  aPath)
inherited

Definition at line 482 of file json_settings.cpp.

483{
484 try
485 {
486 wxFFileInputStream fp( aPath, wxT( "rt" ) );
487 wxStdInputStream fstream( fp );
488
489 if( fp.IsOk() )
490 {
491 *static_cast<nlohmann::json*>( m_internals.get() ) =
492 nlohmann::json::parse( fstream, nullptr,
493 /* allow_exceptions = */ true,
494 /* ignore_comments = */ true );
495 }
496 else
497 {
498 return false;
499 }
500 }
501 catch( nlohmann::json::parse_error& error )
502 {
503 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
504
505 return false;
506 }
507
508 // Now that we have new data in the JSON structure, load the params again
509 Load();
510 return true;
511}

References JSON_SETTINGS::Load(), JSON_SETTINGS::m_internals, parse(), and traceSettings.

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

593{
594 int filever = m_internals->Get<int>( "meta.version" );
595
596 while( filever < m_schemaVersion )
597 {
598 if( !m_migrators.count( filever ) )
599 {
600 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
601 typeid( *this ).name(), filever );
602 return false;
603 }
604
605 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
606
607 if( pair.second() )
608 {
609 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
610 filever, pair.first );
611 filever = pair.first;
612 m_internals->At( "meta.version" ) = filever;
613 }
614 else
615 {
616 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
617 typeid( *this ).name(), filever, pair.first );
618 return false;
619 }
620 }
621
622 return true;
623}
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>

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, and traceSettings.

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

◆ migrateBomSettings()

bool EESCHEMA_SETTINGS::migrateBomSettings ( )
private

Definition at line 783 of file eeschema_settings.cpp.

784{
785 if( !Contains( "bom.plugins" ) )
786 return false;
787
788 wxString list = *Get<wxString>( "bom.plugins" );
789
790 BOM_CFG_PARSER cfg_parser( &m_BomPanel.plugins, TO_UTF8( list ), wxT( "plugins" ) );
791
792 try
793 {
794 cfg_parser.Parse();
795 }
796 catch( const IO_ERROR& )
797 {
798 return false;
799 }
800
801 // Parser will have loaded up our array, let's dump it out to JSON
802 At( "bom.plugins" ) = bomSettingsToJson();
803
804 return true;
805}
Used for parsing legacy-format bom plugin configurations.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:76
bool Contains(const std::string &aPath) const
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96

References JSON_SETTINGS::At(), bomSettingsToJson(), JSON_SETTINGS::Contains(), m_BomPanel, BOM_CFG_PARSER::Parse(), EESCHEMA_SETTINGS::PANEL_BOM::plugins, and TO_UTF8.

Referenced by EESCHEMA_SETTINGS(), and MigrateFromLegacy().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 232 of file app_settings.cpp.

233{
234 const int find_replace_history_size = 10;
235 nlohmann::json find_history = nlohmann::json::array();
236 nlohmann::json replace_history = nlohmann::json::array();
237 wxString tmp, find_key, replace_key;
238
239 for( int i = 0; i < find_replace_history_size; ++i )
240 {
241 find_key.Printf( "FindStringHistoryList%d", i );
242 replace_key.Printf( "ReplaceStringHistoryList%d", i );
243
244 if( aCfg->Read( find_key, &tmp ) )
245 find_history.push_back( tmp.ToStdString() );
246
247 if( aCfg->Read( replace_key, &tmp ) )
248 replace_history.push_back( tmp.ToStdString() );
249 }
250
251 Set( "find_replace.find_history", find_history );
252 Set( "find_replace.replace_history", replace_history );
253}

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool EESCHEMA_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 APP_SETTINGS_BASE.

Definition at line 495 of file eeschema_settings.cpp.

496{
497 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
498
499 // Now modify the loaded grid selection, because in earlier versions the grids index was shared
500 // between all applications and started at 1000 mils. There is a 4-position offset between
501 // this index and the possible eeschema grids list that we have to subtract.
502 std::string gridSizePtr = "window.grid.last_size";
503
504 if( std::optional<int> currentSize = Get<int>( gridSizePtr ) )
505 {
506 Set( gridSizePtr, *currentSize - 4 );
507 }
508 else
509 {
510 // Otherwise, default grid size should be 50 mils; index 1
511 Set( gridSizePtr, 1 );
512 }
513
514 ret &= fromLegacy<bool>( aCfg, "FootprintPreview", "appearance.footprint_preview" );
515 ret &= fromLegacy<bool>( aCfg, "NavigatorStaysOpen", "appearance.navigator_stays_open" );
516 ret &= fromLegacy<bool>( aCfg, "PrintSheetReferenceAndTitleBlock",
517 "appearance.print_sheet_reference" );
518 ret &= fromLegacy<bool>( aCfg, "ShowHiddenPins", "appearance.show_hidden_pins" );
519 ret &= fromLegacy<bool>( aCfg, "ShowIllegalSymbolLibDialog",
520 "appearance.show_illegal_symbol_lib_dialog" );
521 ret &= fromLegacy<bool>( aCfg, "ShowPageLimits", "appearance.show_page_limits" );
522 ret &= fromLegacy<bool>( aCfg, "ShowSheetFileNameCaseSensitivityDlg",
523 "appearance.show_sheet_filename_case_sensitivity_dialog" );
524
525 ret &= fromLegacy<bool>( aCfg, "AutoplaceFields", "autoplace_fields.enable" );
526 ret &= fromLegacy<bool>( aCfg, "AutoplaceJustify", "autoplace_fields.allow_rejustify" );
527 ret &= fromLegacy<bool>( aCfg, "AutoplaceAlign", "autoplace_fields.align_to_grid" );
528
529 ret &= fromLegacy<int>( aCfg, "DefaultBusWidth", "drawing.default_bus_thickness" );
530 ret &= fromLegacy<int>( aCfg, "DefaultJunctionSize", "drawing.default_junction_size" );
531 ret &= fromLegacy<int>( aCfg, "DefaultDrawLineWidth", "drawing.default_line_thickness" );
532 ret &= fromLegacy<int>( aCfg, "RepeatStepX", "drawing.default_repeat_offset_x" );
533 ret &= fromLegacy<int>( aCfg, "RepeatStepY", "drawing.default_repeat_offset_y" );
534 ret &= fromLegacy<int>( aCfg, "DefaultWireWidth", "drawing.default_wire_thickness" );
535 ret &= fromLegacyString( aCfg, "FieldNames", "drawing.field_names" );
536 ret &= fromLegacy<bool>( aCfg, "HorizVertLinesOnly", "drawing.line_mode" );
537 ret &= fromLegacy<int>( aCfg, "RepeatLabelIncrement", "drawing.repeat_label_increment" );
538
539 ret &= fromLegacy<bool>( aCfg, "DragActionIsMove", "input.drag_is_move" );
540
541 ret &= fromLegacy<int>( aCfg, "SelectionThickness", "selection.thickness" );
542 ret &= fromLegacy<bool>( aCfg, "SelectionDrawChildItems", "selection.draw_selected_children" );
543 ret &= fromLegacy<bool>( aCfg, "SelectionFillShapes", "selection.fill_shapes" );
544 ret &= fromLegacy<bool>( aCfg, "SelectPinSelectSymbolOpt",
545 "selection.select_pin_selects_symbol" );
546
547 ret &= fromLegacy<int>( aCfg, "AnnotateAlgoOption", "annotation.method" );
548 ret &= fromLegacy<int>( aCfg, "AnnotateFilterMsg", "annotation.messages_filter" );
549 ret &= fromLegacy<int>( aCfg, "AnnotateSortOption", "annotation.sort_order" );
550
551 ret &= fromLegacyString( aCfg, "bom_plugin_selected", "bom.selected_plugin" );
552 ret &= fromLegacyString( aCfg, "bom_plugins", "bom.plugins" );
553
555
556 ret &= fromLegacyString( aCfg, "SymbolFieldsShownColumns",
557 "edit_sch_component.visible_columns" );
558
559 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportRevision", "page_settings.export_revision" );
560 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportDate", "page_settings.export_date" );
561 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportTitle", "page_settings.export_title" );
562 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportCompany", "page_settings.export_company" );
563 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment1", "page_settings.export_comment1" );
564 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment2", "page_settings.export_comment2" );
565 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment3", "page_settings.export_comment3" );
566 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment4", "page_settings.export_comment4" );
567 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment5", "page_settings.export_comment5" );
568 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment6", "page_settings.export_comment6" );
569 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment7", "page_settings.export_comment7" );
570 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment8", "page_settings.export_comment8" );
571 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment9", "page_settings.export_comment9" );
572
573 #if 0 // To do: move this code to the new netlist plugin management in settings
574 {
575 constexpr int max_custom_commands = 8; // from DIALOG_NETLIST
576 nlohmann::json js_cmd = nlohmann::json::array();
577 nlohmann::json js_title = nlohmann::json::array();
578 wxString cmd_key, title_key, cmd, title;
579
580 for( int i = 1; i <= max_custom_commands; ++i )
581 {
582 // Only migrate if both title and command are specified
583 cmd_key.Printf( "CustomNetlistCommand%d", i );
584 title_key.Printf( "CustomNetlistTitle%d", i );
585
586 if( aCfg->Read( cmd_key, &cmd ) && aCfg->Read( title_key, &title )
587 && !cmd.IsEmpty() && !title.IsEmpty() )
588 {
589 js_cmd.push_back( cmd.ToUTF8() );
590 js_title.push_back( title.ToUTF8() );
591 }
592 }
593
594 Set( "netlist.custom_command_titles", js_title );
595 Set( "netlist.custom_command_paths", js_cmd );
596 }
597 #endif
598
599 {
600 // NOTE(JE) These parameters should move to project-local storage before V6, but we are
601 // migrating them here in order to preserve data. There is a bug here that is preserved:
602 // keys are taken directly from the (translated) UI and stored in the config, so if the user
603 // changes languages the keys will no longer work.
604 aCfg->SetPath( "SymbolFieldEditor/Show/" );
605
607 wxString key;
608 bool value = false;
609 long index = 0;
610
611 while( aCfg->GetNextEntry( key, index ) )
612 {
613 if( aCfg->Read( key, &value ) )
614 {
615 std::string key_utf( key.ToUTF8() );
616
617 try
618 {
619 js[key_utf] = value;
620 }
621 catch(...)
622 {
623 continue;
624 }
625 }
626 }
627
628 Set( "field_editor.fields_show", js );
629
630 aCfg->SetPath( "../GroupBy" );
631
632 while( aCfg->GetNextEntry( key, index ) )
633 {
634 if( aCfg->Read( key, &value ) )
635 {
636 std::string key_utf( key.ToUTF8() );
637
638 try
639 {
640 js[key_utf] = value;
641 }
642 catch(...)
643 {
644 continue;
645 }
646 }
647 }
648
649 Set( "field_editor.fields_group_by", js );
650
651 aCfg->SetPath( "../.." );
652 }
653
654 ret &= fromLegacy<bool>( aCfg, "PlotModeColor", "plot.color" );
655 ret &= fromLegacy<int>( aCfg, "PlotFormat", "plot.format" );
656 ret &= fromLegacy<bool>( aCfg, "PlotFrameRef", "plot.frame_reference" );
657 ret &= fromLegacy<bool>( aCfg, "PlotHPGLOrg", "plot.hpgl_origin" );
658 ret &= fromLegacy<int>( aCfg, "PlotHPGLPaperSize", "plot.hpgl_paper_size" );
659 ret &= fromLegacy<double>( aCfg, "PlotHPGLPenSize", "plot.hpgl_pen_size" );
660
661 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMEPos_x", "simulator.window.pos_x" );
662 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMEPos_y", "simulator.window.pos_y" );
663 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMESize_x", "simulator.window.size_x" );
664 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMESize_y", "simulator.window.size_y" );
665 ret &= fromLegacy<bool>( aCfg, "SIM_PLOT_FRAMEMaximized", "simulator.window.maximized" );
666 ret &= fromLegacyString( aCfg, "SIM_PLOT_FRAMEPerspective", "simulator.window.perspective" );
667 ret &= fromLegacyString( aCfg, "SIM_PLOT_FRAMEMostRecentlyUsedPath", "simulator.mru_path" );
668 ret &= fromLegacy<int>( aCfg, "SimPlotPanelWidth", "simulator.plot_panel_width" );
669 ret &= fromLegacy<int>( aCfg, "SimPlotPanelHeight", "simulator.plot_panel_height" );
670 ret &= fromLegacy<int>( aCfg, "SimSignalPanelHeight", "simulator.signal_panel_height" );
671 ret &= fromLegacy<int>( aCfg, "SimCursorsPanelHeight", "simulator.cursors_panel_height" );
672 ret &= fromLegacy<bool>( aCfg, "SimPlotWhiteBg", "simulator.white_background" );
673
674 ret &= fromLegacy<int>( aCfg, "SymbolChooserHSashPosition", "symbol_chooser.sash_pos_h" );
675 ret &= fromLegacy<int>( aCfg, "SymbolChooserVSashPosition", "symbol_chooser.sash_pos_v" );
676 ret &= fromLegacy<int>( aCfg, "SymbolChooserWidth", "symbol_chooser.width" );
677 ret &= fromLegacy<int>( aCfg, "SymbolChooserHeight", "symbol_chooser.height" );
678 ret &= fromLegacy<bool>( aCfg, "SymbolChooserKeepSymbol", "symbol_chooser.keep_symbol" );
679 ret &= fromLegacy<bool>( aCfg, "SymbolChooserUseUnits", "symbol_chooser.place_all_units" );
680
681 const std::string vlf = "ViewlibFrame";
682 ret &= fromLegacy<bool>( aCfg, vlf + "Maximized", "lib_view.window.maximized" );
683 ret &= fromLegacyString( aCfg, vlf + "MostRecentlyUsedPath", "lib_view.window.mru_path" );
684 ret &= fromLegacy<int>( aCfg, vlf + "Size_x", "lib_view.window.size_x" );
685 ret &= fromLegacy<int>( aCfg, vlf + "Size_y", "lib_view.window.size_y" );
686 ret &= fromLegacyString( aCfg, vlf + "Perspective", "lib_view.window.perspective" );
687 ret &= fromLegacy<int>( aCfg, vlf + "Pos_x", "lib_view.window.pos_x" );
688 ret &= fromLegacy<int>( aCfg, vlf + "Pos_y", "lib_view.window.pos_y" );
689 ret &= fromLegacy<int>( aCfg, "ViewLiblistWidth", "lib_view.lib_list_width" );
690 ret &= fromLegacy<int>( aCfg, "ViewCmplistWidth", "lib_view.cmp_list_width" );
691 ret &= fromLegacy<bool>( aCfg,
692 "ViewCmpShowPinElectricalType", "lib_view.show_pin_electrical_type" );
693 ret &= fromLegacy<bool>( aCfg, vlf + "ShowGrid", "lib_view.grid.show" );
694 ret &= fromLegacy<int>( aCfg, vlf + "_LastGridSize", "lib_view.grid.last_size" );
695
696 ret &= fromLegacy<bool>( aCfg, "RescueNeverShow", "system.never_show_rescue_dialog" );
697
698 // Legacy version stored this setting in eeschema, so move it to common if it exists
699 bool tmp;
700
701 if( aCfg->Read( "MoveWarpsCursor", &tmp ) )
702 Pgm().GetCommonSettings()->m_Input.warp_mouse_on_move = tmp;
703
704 COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetMigratedColorSettings();
705
706 auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
707 wxString str;
708
709 if( aCfg->Read( aKey, &str ) )
710 cs->SetColor( aLayerId, COLOR4D( str ) );
711 };
712
713 migrateLegacyColor( "Color4DBgCanvasEx", LAYER_SCHEMATIC_BACKGROUND );
714 migrateLegacyColor( "Color4DBodyBgEx", LAYER_DEVICE_BACKGROUND );
715 migrateLegacyColor( "Color4DBodyEx", LAYER_DEVICE );
716 migrateLegacyColor( "Color4DBrightenedEx", LAYER_BRIGHTENED );
717 migrateLegacyColor( "Color4DBusEx", LAYER_BUS );
718 migrateLegacyColor( "Color4DConnEx", LAYER_JUNCTION );
719 migrateLegacyColor( "Color4DCursorEx", LAYER_SCHEMATIC_CURSOR );
720 migrateLegacyColor( "Color4DErcEEx", LAYER_ERC_ERR );
721 migrateLegacyColor( "Color4DErcWEx", LAYER_ERC_WARN );
722 migrateLegacyColor( "Color4DFieldEx", LAYER_FIELDS );
723 migrateLegacyColor( "Color4DGLabelEx", LAYER_GLOBLABEL );
724 migrateLegacyColor( "Color4DGridEx", LAYER_SCHEMATIC_GRID );
725 migrateLegacyColor( "Color4DHLabelEx", LAYER_HIERLABEL );
726 migrateLegacyColor( "Color4DHiddenEx", LAYER_HIDDEN );
727 migrateLegacyColor( "Color4DLLabelEx", LAYER_LOCLABEL );
728 migrateLegacyColor( "Color4DNoConnectEx", LAYER_NOCONNECT );
729 migrateLegacyColor( "Color4DNoteEx", LAYER_NOTES );
730 migrateLegacyColor( "Color4DPinEx", LAYER_PIN );
731 migrateLegacyColor( "Color4DPinNameEx", LAYER_PINNAM );
732 migrateLegacyColor( "Color4DPinNumEx", LAYER_PINNUM );
733 migrateLegacyColor( "Color4DReferenceEx", LAYER_REFERENCEPART );
734 migrateLegacyColor( "Color4DShadowEx", LAYER_SELECTION_SHADOWS );
735 migrateLegacyColor( "Color4DSheetEx", LAYER_SHEET );
736 migrateLegacyColor( "Color4DSheetFileNameEx", LAYER_SHEETFILENAME );
737 migrateLegacyColor( "Color4DSheetLabelEx", LAYER_SHEETLABEL );
738 migrateLegacyColor( "Color4DSheetNameEx", LAYER_SHEETNAME );
739 migrateLegacyColor( "Color4DValueEx", LAYER_VALUEPART );
740 migrateLegacyColor( "Color4DWireEx", LAYER_WIRE );
741 migrateLegacyColor( "Color4DWorksheetEx", LAYER_SCHEMATIC_DRAWINGSHEET );
742
743 Pgm().GetSettingsManager().SaveColorSettings( cs, "schematic" );
744
745 Set( "appearance.color_theme", cs->GetFilename() );
746
747 // LibEdit settings were stored with eeschema. If eeschema is the first app to run,
748 // we need to migrate the LibEdit settings here
749
750 auto libedit = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>( false );
751 libedit->MigrateFromLegacy( aCfg );
752 libedit->Load();
753
754 return ret;
755}
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetColor(int aLayer, const COLOR4D &aColor)
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
@ LAYER_SHEETNAME
Definition: layer_ids.h:363
@ LAYER_ERC_WARN
Definition: layer_ids.h:369
@ LAYER_SHEETLABEL
Definition: layer_ids.h:366
@ LAYER_PINNUM
Definition: layer_ids.h:350
@ LAYER_DEVICE
Definition: layer_ids.h:357
@ LAYER_BRIGHTENED
Definition: layer_ids.h:379
@ LAYER_HIDDEN
Definition: layer_ids.h:380
@ LAYER_HIERLABEL
Definition: layer_ids.h:349
@ LAYER_PINNAM
Definition: layer_ids.h:351
@ LAYER_GLOBLABEL
Definition: layer_ids.h:348
@ LAYER_WIRE
Definition: layer_ids.h:344
@ LAYER_NOTES
Definition: layer_ids.h:358
@ LAYER_ERC_ERR
Definition: layer_ids.h:370
@ LAYER_PIN
Definition: layer_ids.h:361
@ LAYER_VALUEPART
Definition: layer_ids.h:353
@ LAYER_BUS
Definition: layer_ids.h:345
@ LAYER_SCHEMATIC_CURSOR
Definition: layer_ids.h:377
@ LAYER_FIELDS
Definition: layer_ids.h:354
@ LAYER_DEVICE_BACKGROUND
Definition: layer_ids.h:372
@ LAYER_SCHEMATIC_DRAWINGSHEET
Definition: layer_ids.h:382
@ LAYER_LOCLABEL
Definition: layer_ids.h:347
@ LAYER_JUNCTION
Definition: layer_ids.h:346
@ LAYER_REFERENCEPART
Definition: layer_ids.h:352
@ LAYER_SHEET
Definition: layer_ids.h:362
@ LAYER_SELECTION_SHADOWS
Definition: layer_ids.h:381
@ LAYER_SCHEMATIC_BACKGROUND
Definition: layer_ids.h:376
@ LAYER_SHEETFILENAME
Definition: layer_ids.h:364
@ LAYER_NOCONNECT
Definition: layer_ids.h:367
@ LAYER_SCHEMATIC_GRID
Definition: layer_ids.h:374
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111

References JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetFilename(), LAYER_BRIGHTENED, LAYER_BUS, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_ERC_ERR, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GLOBLABEL, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_NOCONNECT, LAYER_NOTES, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_REFERENCEPART, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_SCHEMATIC_GRID, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_VALUEPART, LAYER_WIRE, libedit, migrateBomSettings(), APP_SETTINGS_BASE::MigrateFromLegacy(), Pgm(), JSON_SETTINGS::Set(), and COLOR_SETTINGS::SetColor().

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )
protectedinherited

Migrates the library tree width setting from a single column (Item) to multi-column.

Definition at line 394 of file app_settings.cpp.

395{
396 // We used to store only the width of the first column, because there were only
397 // two possible columns.
398 if( std::optional<int> optWidth = Get<int>( "lib_tree.column_width" ) )
399 {
400 Set<nlohmann::json>( "lib_tree.column_widths", { { "Item", *optWidth } } );
401 At( "lib_tree" ).erase( "column_width" );
402 }
403
404 return true;
405}

References JSON_SETTINGS::At().

Referenced by EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ migrateWindowConfig()

bool APP_SETTINGS_BASE::migrateWindowConfig ( wxConfigBase *  aCfg,
const std::string &  aFrameName,
const std::string &  aJsonPath 
)
protectedinherited

Migrates legacy window settings into the JSON document.

Parameters
aCfgis the wxConfig object to read from
aFrameNameis the prefix for window settings in the legacy config file
aJsonPathis the prefix for storing window settings in the JSON file
Returns
true if all settings were migrated

Definition at line 256 of file app_settings.cpp.

258{
259 bool ret = true;
260
261 const std::string frameGDO = aFrame + "GalDisplayOptions";
262 const std::string cursorPath = aJsonPath + ".cursor";
263 const std::string gridPath = aJsonPath + ".grid";
264
265 ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
266 ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
267 ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
268 ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
269 ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
270 ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
271 ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
272
273 ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
274 ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
275
276 ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
277
278 ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
279 ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
280
281 ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
282 ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
283 ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
284 ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
285 ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
286 ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
287
288 return ret;
289}
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.

References JSON_SETTINGS::fromLegacyColor(), and JSON_SETTINGS::fromLegacyString().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

◆ netlistSettingsFromJson()

std::vector< EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::netlistSettingsFromJson ( const nlohmann::json aObj)
staticprivate

Definition at line 874 of file eeschema_settings.cpp.

876{
877 std::vector<EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS> ret;
878
879 wxASSERT( aObj.is_array() );
880
881 for( const nlohmann::json& entry : aObj )
882 {
883 if( entry.empty() || !entry.is_object() )
884 continue;
885
886 if( !entry.contains( "name" ) || !entry.contains( "path" ) )
887 continue;
888
889 NETLIST_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
890 entry.at( "path" ).get<wxString>() );
891
892 if( entry.contains( "command" ) )
893 plugin.command = entry.at( "command" ).get<wxString>();
894
895 ret.emplace_back( plugin );
896 }
897
898 return ret;
899}

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command.

Referenced by EESCHEMA_SETTINGS().

◆ netlistSettingsToJson()

nlohmann::json EESCHEMA_SETTINGS::netlistSettingsToJson ( ) const
private

Definition at line 855 of file eeschema_settings.cpp.

856{
857 nlohmann::json js = nlohmann::json::array();
858
859 for( const NETLIST_PLUGIN_SETTINGS& plugin : m_NetlistPanel.plugins )
860 {
861 nlohmann::json pluginJson;
862
863 pluginJson["name"] = plugin.name.ToUTF8();
864 pluginJson["path"] = plugin.path.ToUTF8();
865 pluginJson["command"] = plugin.command.ToUTF8();
866
867 js.push_back( pluginJson );
868 }
869
870 return js;
871}

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command, m_NetlistPanel, EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::name, EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::path, and EESCHEMA_SETTINGS::PANEL_NETLIST::plugins.

Referenced by EESCHEMA_SETTINGS().

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

585{
586 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
587 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
588 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
589}

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_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 790 of file json_settings.cpp.

791{
792 if( !aSettings || !m_manager )
793 return;
794
795 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
796 [&aSettings]( const JSON_SETTINGS* aPtr ) {
797 return aPtr == aSettings;
798 } );
799
800 if( it != m_nested_settings.end() )
801 {
802 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
803 ( *it )->SaveToFile();
804 m_nested_settings.erase( it );
805 }
806
807 aSettings->SetParent( nullptr );
808}
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)

References JSON_SETTINGS::m_manager, 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 364 of file json_settings.cpp.

365{
366 for( auto param : m_params )
367 param->SetDefault();
368}

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

372{
373 if( !m_writeFile )
374 return false;
375
376 // Default PROJECT won't have a filename set
377 if( m_filename.IsEmpty() )
378 return false;
379
380 wxFileName path;
381
382 if( aDirectory.empty() )
383 {
384 path.Assign( m_filename );
385 path.SetExt( getFileExt() );
386 }
387 else
388 {
389 wxString dir( aDirectory );
390 path.Assign( dir, m_filename, getFileExt() );
391 }
392
393 if( !m_createIfMissing && !path.FileExists() )
394 {
395 wxLogTrace( traceSettings,
396 wxT( "File for %s doesn't exist and m_createIfMissing == false; not saving" ),
397 GetFullFilename() );
398 return false;
399 }
400
401 // Ensure the path exists, and create it if not.
402 if( !path.DirExists() && !path.Mkdir() )
403 {
404 wxLogTrace( traceSettings, wxT( "Warning: could not create path %s, can't save %s" ),
405 path.GetPath(), GetFullFilename() );
406 return false;
407 }
408
409 if( ( path.FileExists() && !path.IsFileWritable() ) ||
410 ( !path.FileExists() && !path.IsDirWritable() ) )
411 {
412 wxLogTrace( traceSettings, wxT( "File for %s is read-only; not saving" ), GetFullFilename() );
413 return false;
414 }
415
416 bool modified = false;
417
418 for( auto settings : m_nested_settings )
419 modified |= settings->SaveToFile();
420
421 modified |= Store();
422
423 if( !modified && !aForce && path.FileExists() )
424 {
425 wxLogTrace( traceSettings, wxT( "%s contents not modified, skipping save" ), GetFullFilename() );
426 return false;
427 }
428 else if( !modified && !aForce && !m_createIfDefault )
429 {
430 wxLogTrace( traceSettings,
431 wxT( "%s contents still default and m_createIfDefault == false; not saving" ),
432 GetFullFilename() );
433 return false;
434 }
435
436 wxLogTrace( traceSettings, wxT( "Saving %s" ), GetFullFilename() );
437
439 bool success = true;
440
441 try
442 {
443 std::stringstream buffer;
444 buffer << std::setw( 2 ) << *m_internals << std::endl;
445
446 wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
447
448 if( !fileStream.IsOk()
449 || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
450 {
451 wxLogTrace( traceSettings, wxT( "Warning: could not save %s" ), GetFullFilename() );
452 success = false;
453 }
454 }
455 catch( nlohmann::json::exception& error )
456 {
457 wxLogTrace( traceSettings, wxT( "Catch error: could not save %s. Json error %s" ),
458 GetFullFilename(), error.what() );
459 success = false;
460 }
461 catch( ... )
462 {
463 wxLogTrace( traceSettings, wxT( "Error: could not save %s." ) );
464 success = false;
465 }
466
467 return success;
468}
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...

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(), SETTINGS_MANAGER::MigrateIfNeeded(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT::PinLibrary(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PGM_BASE::SetLanguage(), and PROJECT::UnpinLibrary().

◆ Set() [1/3]

template<typename ValueType >
template void JSON_SETTINGS::Set< const char * > ( const std::string &  aPath,
ValueType  aVal 
)
inherited

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

565{
566 m_internals->SetFromString( aPath, aVal );
567}

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_SET< Type >::Store(), PARAM_PATH_LIST::Store(), and PARAM_MAP< Value >::Store().

◆ Set() [2/3]

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

Definition at line 822 of file json_settings.cpp.

823{
824 ( *m_internals )[aPath] = aVal.ToUTF8();
825}

◆ Set() [3/3]

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

◆ SetFilename()

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

◆ SetIfPresent() [1/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 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_boolean() )
655 {
656 aTarget = aObj.at( ptr ).get<bool>();
657 return true;
658 }
659
660 return false;
661}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/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 664 of file json_settings.cpp.

666{
667 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
668
669 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
670 {
671 aTarget = aObj.at( ptr ).get<int>();
672 return true;
673 }
674
675 return false;
676}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/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 679 of file json_settings.cpp.

681{
682 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
683
684 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
685 {
686 aTarget = aObj.at( ptr ).get<unsigned int>();
687 return true;
688 }
689
690 return false;
691}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/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 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_string() )
640 {
641 aTarget = aObj.at( ptr ).get<wxString>();
642 return true;
643 }
644
645 return false;
646}

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ SetLegacyFilename()

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

Definition at line 82 of file json_settings.h.

82{ m_legacy_filename = aFilename; }

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 79 of file json_settings.h.

79{ m_location = aLocation; }

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192 {
193 m_manager = aManager;
194 }

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

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

351{
352 bool modified = false;
353
354 for( auto param : m_params )
355 {
356 modified |= !param->MatchesFile( this );
357 param->Store( this );
358 }
359
360 return modified;
361}

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_AnnotatePanel

◆ m_Appearance

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 190 of file app_settings.h.

◆ m_AuiPanels

◆ m_AutoplaceFields

◆ m_BomPanel

◆ m_ColorPicker

◆ m_ColorTheme

◆ 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 318 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 312 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 324 of file json_settings.h.

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

◆ m_Drawing

◆ m_FieldEditorPanel

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_FindReplaceExtra

FIND_REPLACE_EXTRA EESCHEMA_SETTINGS::m_FindReplaceExtra

◆ m_Graphics

◆ m_Input

◆ m_internals

◆ m_lastSymbolLibDir

wxString EESCHEMA_SETTINGS::m_lastSymbolLibDir

◆ 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 300 of file json_settings.h.

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

◆ m_LibTree

◆ m_LibViewPanel

PANEL_LIB_VIEW EESCHEMA_SETTINGS::m_LibViewPanel

Definition at line 293 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and SYMBOL_VIEWER_FRAME::SaveSettings().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation(), and JSON_SETTINGS::SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 333 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), JSON_SETTINGS::ReleaseNestedSettings(), 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 336 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 309 of file json_settings.h.

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

◆ m_NetlistPanel

PANEL_NETLIST EESCHEMA_SETTINGS::m_NetlistPanel

◆ m_PageSettings

PAGE_SETTINGS EESCHEMA_SETTINGS::m_PageSettings

Definition at line 285 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ m_params

◆ m_PlotPanel

PANEL_PLOT EESCHEMA_SETTINGS::m_PlotPanel

◆ m_Printing

◆ m_RescueNeverShow

bool EESCHEMA_SETTINGS::m_RescueNeverShow

◆ 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 327 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_Selection

◆ m_Simulator

◆ m_SymChooserPanel

PANEL_SYM_CHOOSER EESCHEMA_SETTINGS::m_SymChooserPanel

Definition at line 299 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ m_System

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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