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  AUTOPLACE_FIELDS
 
struct  BOM_PLUGIN_SETTINGS
 
struct  DRAWING
 
struct  INPUT
 
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)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
bool IsDefault (const std::string &aParamName)
 Checks if the current state of a parameter matches its default value. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static std::vector< BOM_PLUGIN_SETTINGSDefaultBomPlugins ()
 
static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present. More...
 

Public Attributes

APPEARANCE m_Appearance
 
AUTOPLACE_FIELDS m_AutoplaceFields
 
DRAWING m_Drawing
 
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...
 
void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 

Private Member Functions

bool migrateBomSettings ()
 
nlohmann::json bomSettingsToJson () const
 

Static Private Member Functions

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

Detailed Description

Definition at line 33 of file eeschema_settings.h.

Constructor & Destructor Documentation

◆ EESCHEMA_SETTINGS()

EESCHEMA_SETTINGS::EESCHEMA_SETTINGS ( )

Definition at line 57 of file eeschema_settings.cpp.

57  :
59  m_Appearance(),
61  m_Drawing(),
62  m_Input(),
65  m_BomPanel(),
69  m_PlotPanel(),
71  m_Selection(),
72  m_Simulator(),
73  m_RescueNeverShow( false )
74 {
75  m_params.emplace_back( new PARAM<wxString>( "appearance.edit_component_visible_columns",
76  &m_Appearance.edit_component_visible_columns, "0 1 2 3 4 5 6 7" ) );
77 
78  m_params.emplace_back( new PARAM<wxString>( "appearance.edit_sheet_visible_columns",
79  &m_Appearance.edit_sheet_visible_columns, "0 1 2 3 4 5 6 7" ) );
80 
81  m_params.emplace_back( new PARAM<int>( "appearance.erc_severities",
83 
84  m_params.emplace_back( new PARAM<bool>( "appearance.footprint_preview",
86 
87  m_params.emplace_back( new PARAM<bool>( "appearance.navigator_stays_open",
89 
90  m_params.emplace_back( new PARAM<bool>( "appearance.print_sheet_reference",
92 
93  m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_pins",
94  &m_Appearance.show_hidden_pins, false ) );
95 
96  m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_fields",
97  &m_Appearance.show_hidden_fields, false ) );
98 
99  m_params.emplace_back( new PARAM<bool>( "appearance.show_illegal_symbol_lib_dialog",
101 
102  m_params.emplace_back( new PARAM<bool>( "appearance.show_page_limits",
103  &m_Appearance.show_page_limits, true ) );
104 
105  m_params.emplace_back( new PARAM<bool>( "appearance.show_sexpr_file_convert_warning",
107 
108  m_params.emplace_back(
109  new PARAM<bool>( "appearance.show_sheet_filename_case_sensitivity_dialog",
111 
112  m_params.emplace_back( new PARAM<bool>( "autoplace_fields.enable",
113  &m_AutoplaceFields.enable, true ) );
114 
115  m_params.emplace_back( new PARAM<bool>( "autoplace_fields.allow_rejustify",
117 
118  m_params.emplace_back( new PARAM<bool>( "autoplace_fields.align_to_grid",
119  &m_AutoplaceFields.align_to_grid, true ) );
120 
121  m_params.emplace_back( new PARAM<int>( "drawing.default_bus_thickness",
123 
124  m_params.emplace_back( new PARAM<int>( "drawing.default_junction_size",
126 
127  m_params.emplace_back( new PARAM<int>( "drawing.pin_symbol_size",
129 
130  m_params.emplace_back(
131  new PARAM<double>( "drawing.text_offset_ratio", &m_Drawing.text_offset_ratio, 0.08 ) );
132 
133  m_params.emplace_back( new PARAM<int>( "drawing.default_line_thickness",
135 
136  m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_x",
138 
139  m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_y",
141 
142  m_params.emplace_back( new PARAM<int>( "drawing.default_wire_thickness",
144 
145  m_params.emplace_back( new PARAM<int>(
146  "drawing.default_text_size", &m_Drawing.default_text_size, DEFAULT_TEXT_SIZE ) );
147 
148  m_params.emplace_back( new PARAM<wxString>( "drawing.field_names",
149  &m_Drawing.field_names, "" ) );
150 
151  m_params.emplace_back( new PARAM<bool>( "drawing.hv_lines_only",
152  &m_Drawing.hv_lines_only, true ) );
153 
154  m_params.emplace_back( new PARAM<bool>( "drawing.auto_start_wires",
155  &m_Drawing.auto_start_wires, true ) );
156 
157  m_params.emplace_back( new PARAM<int>( "drawing.repeat_label_increment",
158  &m_Drawing.repeat_label_increment, 1, -10, 10 ) );
159 
160  m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_border_color",
161  &m_Drawing.default_sheet_border_color, COLOR4D::UNSPECIFIED ) );
162 
163  m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_background_color",
164  &m_Drawing.default_sheet_background_color, COLOR4D::UNSPECIFIED ) );
165 
166  m_params.emplace_back( new PARAM_LIST<double>( "drawing.junction_size_mult_list",
167  &m_Drawing.junction_size_mult_list, { 0.0, 1.7, 4.0, 6.0, 9.0, 12.0 } ) );
168 
169  m_params.emplace_back(new PARAM <double>( "drawing.junction_size_mult",
170  &m_Drawing.junction_size_mult, 4.0 ) );
171 
172  m_params.emplace_back(new PARAM <int>( "drawing.junction_size_choice",
174 
175  m_params.emplace_back( new PARAM<bool>( "input.drag_is_move",
176  &m_Input.drag_is_move, true ) );
177 
178  m_params.emplace_back( new PARAM<int>( "selection.thickness",
179  &m_Selection.thickness, 3 ) );
180 
181  m_params.emplace_back( new PARAM<bool>( "selection.draw_selected_children",
183 
184  m_params.emplace_back( new PARAM<bool>( "selection.fill_shapes",
185  &m_Selection.fill_shapes, false ) );
186 
187  m_params.emplace_back( new PARAM<bool>( "selection.select_pin_selects_symbol",
189 
190  m_params.emplace_back( new PARAM<bool>( "selection.text_as_box",
191  &m_Selection.text_as_box, false ) );
192 
193  m_params.emplace_back( new PARAM<int>( "annotation.method",
194  &m_AnnotatePanel.method, 0, 0, 2 ) );
195 
196  m_params.emplace_back( new PARAM<int>( "annotation.scope",
197  &m_AnnotatePanel.scope, 0, 0, 2 ) );
198 
199  m_params.emplace_back( new PARAM<int>( "annotation.options",
200  &m_AnnotatePanel.options, 0, 0, 2 ) );
201 
202  m_params.emplace_back( new PARAM<int>( "annotation.messages_filter",
204 
205  m_params.emplace_back( new PARAM<int>( "annotation.sort_order",
206  &m_AnnotatePanel.sort_order, 0, 0, 1 ) );
207 
208  m_params.emplace_back( new PARAM<wxString>( "bom.selected_plugin",
209  &m_BomPanel.selected_plugin, "" ) );
210 
211  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "bom.plugins",
212  std::bind( &EESCHEMA_SETTINGS::bomSettingsToJson, this ),
213  [&]( const nlohmann::json& aObj )
214  {
215  if( !aObj.is_array() )
216  return;
217 
218  const nlohmann::json& list = aObj.empty() ? defaultBomPlugins : aObj;
219 
221  },
222  defaultBomPlugins ) );
223 
224  m_params.emplace_back( new PARAM<bool>( "page_settings.export_paper",
225  &m_PageSettings.export_paper, false ) );
226 
227  m_params.emplace_back( new PARAM<bool>( "page_settings.export_revision",
228  &m_PageSettings.export_revision, false ) );
229 
230  m_params.emplace_back( new PARAM<bool>( "page_settings.export_date",
231  &m_PageSettings.export_date, false ) );
232 
233  m_params.emplace_back( new PARAM<bool>( "page_settings.export_title",
234  &m_PageSettings.export_title, false ) );
235 
236  m_params.emplace_back( new PARAM<bool>( "page_settings.export_company",
237  &m_PageSettings.export_company, false ) );
238 
239  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment1",
240  &m_PageSettings.export_comment1, false ) );
241 
242  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment2",
243  &m_PageSettings.export_comment2, false ) );
244 
245  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment3",
246  &m_PageSettings.export_comment3, false ) );
247 
248  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment4",
249  &m_PageSettings.export_comment4, false ) );
250 
251  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment5",
252  &m_PageSettings.export_comment5, false ) );
253 
254  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment6",
255  &m_PageSettings.export_comment6, false ) );
256 
257  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment7",
258  &m_PageSettings.export_comment7, false ) );
259 
260  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment8",
261  &m_PageSettings.export_comment8, false ) );
262 
263  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment9",
264  &m_PageSettings.export_comment9, false ) );
265 
266  m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_show",
268 
269  m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_group_by",
271 
272  m_params.emplace_back( new PARAM_MAP<int>( "field_editor.column_widths",
274 
275  m_params.emplace_back( new PARAM<bool>( "plot.background_color",
276  &m_PlotPanel.background_color, false ) );
277 
278  m_params.emplace_back( new PARAM<bool>( "plot.color",
279  &m_PlotPanel.color, true ) );
280 
281  m_params.emplace_back( new PARAM<wxString>( "plot.color_theme",
282  &m_PlotPanel.color_theme, wxT( "user" ) ) );
283 
284  m_params.emplace_back( new PARAM<int>( "plot.format",
285  &m_PlotPanel.format, 0 ) );
286 
287  m_params.emplace_back( new PARAM<bool>( "plot.frame_reference",
288  &m_PlotPanel.frame_reference, true ) );
289 
290  m_params.emplace_back( new PARAM<int>( "plot.hpgl_paper_size",
292 
293  m_params.emplace_back( new PARAM<double>( "plot.hpgl_pen_size",
294  &m_PlotPanel.hpgl_pen_size, 0.5 ) );
295 
296  m_params.emplace_back( new PARAM<int>( "plot.hpgl_origin",
297  &m_PlotPanel.hpgl_origin, 0 ) );
298 
299  m_params.emplace_back( new PARAM<int>( "simulator.window.pos_x",
300  &m_Simulator.window.state.pos_x, 0 ) );
301 
302  m_params.emplace_back( new PARAM<int>( "simulator.window.pos_y",
303  &m_Simulator.window.state.pos_y, 0 ) );
304 
305  m_params.emplace_back( new PARAM<int>( "simulator.window.size_x",
306  &m_Simulator.window.state.size_x, 500 ) );
307 
308  m_params.emplace_back( new PARAM<int>( "simulator.window.size_y",
309  &m_Simulator.window.state.size_y, 400 ) );
310 
311  m_params.emplace_back( new PARAM<unsigned int>( "simulator.window.display",
313 
314  m_params.emplace_back( new PARAM<bool>( "simulator.window.maximized",
315  &m_Simulator.window.state.maximized, false ) );
316 
317  m_params.emplace_back( new PARAM<wxString>( "simulator.window.perspective",
318  &m_Simulator.window.perspective, "" ) );
319 
320  m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_width",
322 
323  m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_height",
325 
326  m_params.emplace_back( new PARAM<int>( "simulator.signal_panel_height",
328 
329  m_params.emplace_back( new PARAM<int>( "simulator.cursors_panel_height",
331 
332  m_params.emplace_back( new PARAM<bool>( "simulator.white_background",
333  &m_Simulator.white_background, false ) );
334 
335  m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_h",
336  &m_SymChooserPanel.sash_pos_h, -1 ) );
337 
338  m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_v",
339  &m_SymChooserPanel.sash_pos_v, -1 ) );
340 
341  m_params.emplace_back( new PARAM<int>( "symbol_chooser.width",
342  &m_SymChooserPanel.width, -1 ) );
343 
344  m_params.emplace_back( new PARAM<int>( "symbol_chooser.height",
345  &m_SymChooserPanel.height, -1 ) );
346 
347  m_params.emplace_back( new PARAM<bool>( "symbol_chooser.keep_symbol",
348  &m_SymChooserPanel.keep_symbol, false ) );
349 
350  m_params.emplace_back( new PARAM<bool>( "symbol_chooser.place_all_units",
352 
353  m_params.emplace_back( new PARAM<bool>( "system.never_show_rescue_dialog",
354  &m_RescueNeverShow, false ) );
355 
356  m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_x",
358 
359  m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_y",
361 
362  m_params.emplace_back( new PARAM<int>( "lib_view.window.size_x",
363  &m_LibViewPanel.window.state.size_x, 500 ) );
364 
365  m_params.emplace_back( new PARAM<int>( "lib_view.window.size_y",
366  &m_LibViewPanel.window.state.size_y, 400 ) );
367 
368  m_params.emplace_back( new PARAM<unsigned int>( "lib_view.window.display",
370 
371  m_params.emplace_back( new PARAM<bool>( "lib_view.window.maximized",
372  &m_LibViewPanel.window.state.maximized, false ) );
373 
374  m_params.emplace_back( new PARAM<wxString>( "lib_view.window.perspective",
376 
377  m_params.emplace_back( new PARAM<int>( "lib_view.lib_list_width",
378  &m_LibViewPanel.lib_list_width, 150 ) );
379 
380  m_params.emplace_back( new PARAM<int>( "lib_view.cmp_list_width",
381  &m_LibViewPanel.cmp_list_width, 150 ) );
382 
383  m_params.emplace_back( new PARAM<bool>( "lib_view.show_pin_electrical_type",
385 
386  m_params.emplace_back( new PARAM<wxString>( "system.last_symbol_lib_dir",
387  &m_lastSymbolLibDir, "" ) );
388 
389 
390  // Migrations
391 
392  registerMigration( 0, 1,
393  [&]() -> bool
394  {
395  // Version 0 to 1: BOM plugin settings moved from sexpr to JSON
396  return migrateBomSettings();
397  } );
398 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
const nlohmann::json defaultBomPlugins
Default value for bom.plugins.
Represents a map of <std::string, Value>.
Definition: parameters.h:643
std::vector< BOM_PLUGIN_SETTINGS > plugins
PANEL_ANNOTATE m_AnnotatePanel
#define DEFAULT_JUNCTION_DIAM
The default bus and wire enty size in mils.
nlohmann::json json
Definition: gerbview.cpp:41
PANEL_SYM_CHOOSER m_SymChooserPanel
PANEL_FIELD_EDITOR m_FieldEditorPanel
PAGE_SETTINGS m_PageSettings
static std::vector< BOM_PLUGIN_SETTINGS > bomSettingsFromJson(const nlohmann::json &aObj)
wxString perspective
Definition: app_settings.h:85
AUTOPLACE_FIELDS m_AutoplaceFields
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
std::map< std::string, int > column_widths
nlohmann::json bomSettingsToJson() const
#define DEFAULT_LINE_THICKNESS
The default wire width in mils. (can be changed in preference menu)
PANEL_LIB_VIEW m_LibViewPanel
#define DEFAULT_BUS_THICKNESS
The default noconnect size in mils.
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
WINDOW_STATE state
Definition: app_settings.h:83
#define DEFAULT_WIRE_THICKNESS
The default bus 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.
std::vector< double > junction_size_mult_list
const int eeschemaSchemaVersion
! Update the schema version whenever a migration is required
std::map< std::string, bool > fields_group_by
unsigned int display
Definition: app_settings.h:75
std::map< std::string, bool > fields_show
PANEL_NETLIST m_NetlistPanel

References EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::align_to_grid, EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::allow_rejustify, EESCHEMA_SETTINGS::DRAWING::auto_start_wires, 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, DEFAULT_BUS_THICKNESS, EESCHEMA_SETTINGS::DRAWING::default_bus_thickness, DEFAULT_JUNCTION_DIAM, EESCHEMA_SETTINGS::DRAWING::default_junction_size, DEFAULT_LINE_THICKNESS, EESCHEMA_SETTINGS::DRAWING::default_line_thickness, 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, DEFAULT_WIRE_THICKNESS, EESCHEMA_SETTINGS::DRAWING::default_wire_thickness, defaultBomPlugins, WINDOW_STATE::display, EESCHEMA_SETTINGS::INPUT::drag_is_move, EESCHEMA_SETTINGS::SELECTION::draw_selected_children, EESCHEMA_SETTINGS::APPEARANCE::edit_component_visible_columns, EESCHEMA_SETTINGS::APPEARANCE::edit_sheet_visible_columns, EESCHEMA_SETTINGS::AUTOPLACE_FIELDS::enable, EESCHEMA_SETTINGS::APPEARANCE::erc_severities, 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::PANEL_PLOT::hpgl_origin, EESCHEMA_SETTINGS::PANEL_PLOT::hpgl_paper_size, EESCHEMA_SETTINGS::PANEL_PLOT::hpgl_pen_size, EESCHEMA_SETTINGS::DRAWING::hv_lines_only, EESCHEMA_SETTINGS::DRAWING::junction_size_choice, EESCHEMA_SETTINGS::DRAWING::junction_size_mult, EESCHEMA_SETTINGS::DRAWING::junction_size_mult_list, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::keep_symbol, EESCHEMA_SETTINGS::PANEL_LIB_VIEW::lib_list_width, m_AnnotatePanel, m_Appearance, m_AutoplaceFields, m_BomPanel, m_Drawing, m_FieldEditorPanel, m_Input, m_lastSymbolLibDir, m_LibViewPanel, 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(), EESCHEMA_SETTINGS::APPEARANCE::navigator_stays_open, 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, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, EESCHEMA_SETTINGS::APPEARANCE::print_sheet_reference, JSON_SETTINGS::registerMigration(), EESCHEMA_SETTINGS::DRAWING::repeat_label_increment, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_h, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_v, EESCHEMA_SETTINGS::PANEL_ANNOTATE::scope, EESCHEMA_SETTINGS::SELECTION::select_pin_selects_symbol, EESCHEMA_SETTINGS::PANEL_BOM::selected_plugin, 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::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::SELECTION::text_as_box, EESCHEMA_SETTINGS::DRAWING::text_offset_ratio, EESCHEMA_SETTINGS::SELECTION::thickness, 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 203 of file eeschema_settings.h.

203 {}

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

676 {
677  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
678  m_nested_settings.push_back( aSettings );
679 }
wxString GetFilename() const
Definition: json_settings.h:66
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ 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 268 of file app_settings.cpp.

269 {
270  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
271  &aWindow->state.maximized, false ) );
272 
273  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
274  &aWindow->mru_path, "" ) );
275 
276  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
277 
278  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
279 
280  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
281  &aWindow->perspective, "" ) );
282 
283  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
284 
285  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
286 
287  m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
288 
289  m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
290  &aWindow->zoom_factors, {} ) );
291 
292  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
293  &aWindow->grid.axes_enabled, false ) );
294 
295  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
296  &aWindow->grid.sizes, DefaultGridSizeList() ) );
297 
298  // pcbnew default grid doesn't matter much, but eeschema does, so default to the index
299  // of the 50mil grid in eeschema
300  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
301  &aWindow->grid.last_size_idx, 1 ) );
302 
303  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
304  &aWindow->grid.fast_grid_1, 1 ) );
305 
306  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
307  &aWindow->grid.fast_grid_2, 2 ) );
308 
309  // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
310  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
311  &aWindow->grid.user_grid_x, "10 mil" ) );
312  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
313  &aWindow->grid.user_grid_y, "10 mil" ) );
314 
315  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
316  &aWindow->grid.line_width, 1.0 ) );
317 
318  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
319  &aWindow->grid.min_spacing, 10 ) );
320 
321  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
322  &aWindow->grid.show, true ) );
323 
324  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
325  &aWindow->grid.style, 0 ) );
326 
327  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
328  &aWindow->grid.snap, 0 ) );
329 
330  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
331  &aWindow->cursor.always_show_cursor, true ) );
332 
333  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
334  &aWindow->cursor.fullscreen_cursor, false ) );
335 }
wxString mru_path
Definition: app_settings.h:84
bool fullscreen_cursor
Definition: app_settings.h:43
wxString user_grid_y
Definition: app_settings.h:54
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
wxString user_grid_x
Definition: app_settings.h:53
double min_spacing
Definition: app_settings.h:59
bool always_show_cursor
Definition: app_settings.h:42
std::vector< double > zoom_factors
Definition: app_settings.h:86
double line_width
Definition: app_settings.h:58
wxString perspective
Definition: app_settings.h:85
std::vector< wxString > sizes
Definition: app_settings.h:52
CURSOR_SETTINGS cursor
Definition: app_settings.h:88
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75
virtual const std::vector< wxString > DefaultGridSizeList() const
By default, this returns the list of grids available in PcbNew-based applications.

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_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().

◆ bomSettingsFromJson()

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

Definition at line 715 of file eeschema_settings.cpp.

717 {
718  std::vector<EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS> ret;
719 
720  wxASSERT( aObj.is_array() );
721 
722  for( const nlohmann::json& entry : aObj )
723  {
724  if( entry.empty() || !entry.is_object() )
725  continue;
726 
727  if( !entry.contains( "name" ) || !entry.contains( "path" ) )
728  continue;
729 
730  BOM_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
731  entry.at( "path" ).get<wxString>() );
732 
733  if( entry.contains( "command" ) )
734  plugin.command = entry.at( "command" ).get<wxString>();
735 
736  ret.emplace_back( plugin );
737  }
738 
739  return ret;
740 }
nlohmann::json json
Definition: gerbview.cpp:41

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command.

Referenced by DefaultBomPlugins(), and EESCHEMA_SETTINGS().

◆ bomSettingsToJson()

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

Definition at line 696 of file eeschema_settings.cpp.

697 {
698  nlohmann::json js = nlohmann::json::array();
699 
700  for( const BOM_PLUGIN_SETTINGS& plugin : m_BomPanel.plugins )
701  {
702  nlohmann::json pluginJson;
703 
704  pluginJson["name"] = plugin.name.ToUTF8();
705  pluginJson["path"] = plugin.path.ToUTF8();
706  pluginJson["command"] = plugin.command.ToUTF8();
707 
708  js.push_back( pluginJson );
709  }
710 
711  return js;
712 }
std::vector< BOM_PLUGIN_SETTINGS > plugins
nlohmann::json json
Definition: gerbview.cpp:41

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

◆ DefaultBomPlugins()

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

Definition at line 663 of file eeschema_settings.cpp.

664 {
666 }
const nlohmann::json defaultBomPlugins
Default value for bom.plugins.
static std::vector< BOM_PLUGIN_SETTINGS > bomSettingsFromJson(const nlohmann::json &aObj)

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 the window.grid.sizes parameter

Definition at line 338 of file app_settings.cpp.

339 {
340  return { "1000 mil",
341  "500 mil",
342  "250 mil",
343  "200 mil",
344  "100 mil",
345  "50 mil",
346  "25 mil",
347  "20 mil",
348  "10 mil",
349  "5 mil",
350  "2 mil",
351  "1 mil",
352  "5.0 mm",
353  "2.5 mm",
354  "1.0 mm",
355  "0.5 mm",
356  "0.25 mm",
357  "0.2 mm",
358  "0.1 mm",
359  "0.05 mm",
360  "0.025 mm",
361  "0.01 mm" };
362 }

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

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

589 {
590  ValueType val;
591 
592  if( aConfig->Read( aKey, &val ) )
593  {
594  try
595  {
596  ( *this )[PointerFromString( aDest )] = val;
597  }
598  catch( ... )
599  {
600  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
601  return false;
602  }
603 
604  return true;
605  }
606 
607  return false;
608 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

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

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

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

Definition at line 647 of file json_settings.cpp.

649 {
650  wxString str;
651 
652  if( aConfig->Read( aKey, &str ) )
653  {
655  color.SetFromWxString( str );
656 
657  try
658  {
659  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
660  ( *this )[PointerFromString( aDest )] = js;
661  }
662  catch( ... )
663  {
664  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
665  return false;
666  }
667 
668  return true;
669  }
670 
671  return false;
672 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:41
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 623 of file json_settings.cpp.

625 {
626  wxString str;
627 
628  if( aConfig->Read( aKey, &str ) )
629  {
630  try
631  {
632  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
633  }
634  catch( ... )
635  {
636  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
637  return false;
638  }
639 
640  return true;
641  }
642 
643  return false;
644 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 133 of file json_settings.h.

134  {
135  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
136  {
137  try
138  {
139  return ret->get<ValueType>();
140  }
141  catch( ... )
142  {
143  }
144  }
145 
146  return NULLOPT;
147  }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ Get() [2/2]

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

Definition at line 705 of file json_settings.cpp.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 283 of file json_settings.h.

284  {
285  return wxT( "json" );
286  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 81 of file json_settings.cpp.

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

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

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

◆ GetJson()

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

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

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

Definition at line 436 of file json_settings.cpp.

437 {
438  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
439 
440  if( contains( ptr ) )
441  {
442  try
443  {
444  return OPT<nlohmann::json>{ at( ptr ) };
445  }
446  catch( ... )
447  {
448  }
449  }
450 
451  return OPT<nlohmann::json>{};
452 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References alg::contains(), and JSON_SETTINGS::PointerFromString().

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 288 of file json_settings.h.

289  {
290  return wxEmptyString;
291  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 211 of file eeschema_settings.h.

211 { return "SchematicFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 72 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ IsDefault()

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

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

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

Definition at line 324 of file json_settings.cpp.

325 {
326  for( const PARAM_BASE* param : m_params )
327  {
328  if( param->GetJsonPath() == aParamName )
329  return param->IsDefault();
330  }
331 
332  return false;
333 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 87 of file json_settings.cpp.

88 {
89  for( auto param : m_params )
90  {
91  try
92  {
93  param->Load( this, m_resetParamsIfMissing );
94  }
95  catch( ... )
96  {
97  // Skip unreadable parameters in file
98  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
99  }
100  }
101 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

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

◆ LoadFromFile()

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

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

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

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 104 of file json_settings.cpp.

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

References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), path, JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

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

Returns
true if migration was successful

Definition at line 464 of file json_settings.cpp.

465 {
466  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
467 
468  while( filever < m_schemaVersion )
469  {
470  if( !m_migrators.count( filever ) )
471  {
472  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
473  typeid( *this ).name(), filever );
474  return false;
475  }
476 
477  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
478 
479  if( pair.second() )
480  {
481  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
482  filever, pair.first );
483  filever = pair.first;
484  ( *this )[PointerFromString( "meta.version" )] = filever;
485  }
486  else
487  {
488  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
489  typeid( *this ).name(), filever, pair.first );
490  return false;
491  }
492  }
493 
494  return true;
495 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

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

◆ migrateBomSettings()

bool EESCHEMA_SETTINGS::migrateBomSettings ( )
private

Definition at line 669 of file eeschema_settings.cpp.

670 {
671  nlohmann::json::json_pointer ptr = PointerFromString( "bom.plugins" );
672 
673  if( !contains( ptr ) )
674  return false;
675 
676  wxString list = at( ptr ).get<wxString>();
677 
678  BOM_CFG_PARSER cfg_parser( &m_BomPanel.plugins, TO_UTF8( list ), wxT( "plugins" ) );
679 
680  try
681  {
682  cfg_parser.Parse();
683  }
684  catch( const IO_ERROR& )
685  {
686  return false;
687  }
688 
689  // Parser will have loaded up our array, let's dump it out to JSON
690  at( ptr ) = bomSettingsToJson();
691 
692  return true;
693 }
std::vector< BOM_PLUGIN_SETTINGS > plugins
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
Used for parsing legacy-format bom plugin configurations.
nlohmann::json bomSettingsToJson() const
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

References bomSettingsToJson(), alg::contains(), m_BomPanel, EESCHEMA_SETTINGS::PANEL_BOM::plugins, JSON_SETTINGS::PointerFromString(), 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 208 of file app_settings.cpp.

209 {
210  const int find_replace_history_size = 10;
211  nlohmann::json find_history = nlohmann::json::array();
212  nlohmann::json replace_history = nlohmann::json::array();
213  wxString tmp, find_key, replace_key;
214 
215  for( int i = 0; i < find_replace_history_size; ++i )
216  {
217  find_key.Printf( "FindStringHistoryList%d", i );
218  replace_key.Printf( "ReplaceStringHistoryList%d", i );
219 
220  if( aCfg->Read( find_key, &tmp ) )
221  find_history.push_back( tmp.ToStdString() );
222 
223  if( aCfg->Read( replace_key, &tmp ) )
224  replace_history.push_back( tmp.ToStdString() );
225  }
226 
227  ( *this )[PointerFromString( "find_replace.find_history" )] = find_history;
228  ( *this )[PointerFromString( "find_replace.replace_history" )] = replace_history;
229 }
nlohmann::json json
Definition: gerbview.cpp:41
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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 401 of file eeschema_settings.cpp.

402 {
403  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
404 
405  // Now modify the loaded grid selection, because in earlier versions the grids index was shared
406  // between all applications and started at 1000 mils. There is a 4-position offset between
407  // this index and the possible eeschema grids list that we have to subtract.
408  nlohmann::json::json_pointer gridSizePtr = PointerFromString( "window.grid.last_size" );
409 
410  try
411  {
412  ( *this )[gridSizePtr] = ( *this )[gridSizePtr].get<int>() - 4;
413  }
414  catch( ... )
415  {
416  // Otherwise, default grid size should be 50 mils; index 1
417  ( *this )[gridSizePtr] = 1;
418  }
419 
420  ret &= fromLegacy<bool>( aCfg, "FootprintPreview", "appearance.footprint_preview" );
421  ret &= fromLegacy<bool>( aCfg, "NavigatorStaysOpen", "appearance.navigator_stays_open" );
422  ret &= fromLegacy<bool>( aCfg, "PrintSheetReferenceAndTitleBlock",
423  "appearance.print_sheet_reference" );
424  ret &= fromLegacy<bool>( aCfg, "ShowHiddenPins", "appearance.show_hidden_pins" );
425  ret &= fromLegacy<bool>( aCfg, "ShowIllegalSymbolLibDialog",
426  "appearance.show_illegal_symbol_lib_dialog" );
427  ret &= fromLegacy<bool>( aCfg, "ShowPageLimits", "appearance.show_page_limits" );
428  ret &= fromLegacy<bool>( aCfg, "ShowSheetFileNameCaseSensitivityDlg",
429  "appearance.show_sheet_filename_case_sensitivity_dialog" );
430 
431  ret &= fromLegacy<bool>( aCfg, "AutoplaceFields", "autoplace_fields.enable" );
432  ret &= fromLegacy<bool>( aCfg, "AutoplaceJustify", "autoplace_fields.allow_rejustify" );
433  ret &= fromLegacy<bool>( aCfg, "AutoplaceAlign", "autoplace_fields.align_to_grid" );
434 
435  ret &= fromLegacy<int>( aCfg, "DefaultBusWidth", "drawing.default_bus_thickness" );
436  ret &= fromLegacy<int>( aCfg, "DefaultJunctionSize", "drawing.default_junction_size" );
437  ret &= fromLegacy<int>( aCfg, "DefaultDrawLineWidth", "drawing.default_line_thickness" );
438  ret &= fromLegacy<int>( aCfg, "RepeatStepX", "drawing.default_repeat_offset_x" );
439  ret &= fromLegacy<int>( aCfg, "RepeatStepY", "drawing.default_repeat_offset_y" );
440  ret &= fromLegacy<int>( aCfg, "DefaultWireWidth", "drawing.default_wire_thickness" );
441  ret &= fromLegacyString( aCfg, "FieldNames", "drawing.field_names" );
442  ret &= fromLegacy<bool>( aCfg, "HorizVertLinesOnly", "drawing.hv_lines_only" );
443  ret &= fromLegacy<int>( aCfg, "RepeatLabelIncrement", "drawing.repeat_label_increment" );
444 
445  ret &= fromLegacy<bool>( aCfg, "DragActionIsMove", "input.drag_is_move" );
446 
447  ret &= fromLegacy<int>( aCfg, "SelectionThickness", "selection.thickness" );
448  ret &= fromLegacy<bool>( aCfg, "SelectionDrawChildItems", "selection.draw_selected_children" );
449  ret &= fromLegacy<bool>( aCfg, "SelectionFillShapes", "selection.fill_shapes" );
450  ret &= fromLegacy<bool>( aCfg, "SelectPinSelectSymbolOpt",
451  "selection.select_pin_selects_symbol" );
452  ret &= fromLegacy<bool>( aCfg, "SelectionTextAsBox", "selection.text_as_box" );
453 
454  ret &= fromLegacy<int>( aCfg, "AnnotateAlgoOption", "annotation.method" );
455  ret &= fromLegacy<int>( aCfg, "AnnotateFilterMsg", "annotation.messages_filter" );
456  ret &= fromLegacy<int>( aCfg, "AnnotateSortOption", "annotation.sort_order" );
457 
458  ret &= fromLegacyString( aCfg, "bom_plugin_selected", "bom.selected_plugin" );
459  ret &= fromLegacyString( aCfg, "bom_plugins", "bom.plugins" );
460 
462 
463  ret &= fromLegacyString( aCfg, "SymbolFieldsShownColumns",
464  "edit_sch_component.visible_columns" );
465 
466  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportRevision", "page_settings.export_revision" );
467  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportDate", "page_settings.export_date" );
468  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportTitle", "page_settings.export_title" );
469  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportCompany", "page_settings.export_company" );
470  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment1", "page_settings.export_comment1" );
471  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment2", "page_settings.export_comment2" );
472  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment3", "page_settings.export_comment3" );
473  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment4", "page_settings.export_comment4" );
474  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment5", "page_settings.export_comment5" );
475  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment6", "page_settings.export_comment6" );
476  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment7", "page_settings.export_comment7" );
477  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment8", "page_settings.export_comment8" );
478  ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment9", "page_settings.export_comment9" );
479 
480  {
481  constexpr int max_custom_commands = 8; // from DIALOG_NETLIST
482  nlohmann::json js_cmd = nlohmann::json::array();
483  nlohmann::json js_title = nlohmann::json::array();
484  wxString cmd_key, title_key, cmd, title;
485 
486  for( int i = 1; i <= max_custom_commands; ++i )
487  {
488  // Only migrate if both title and command are specified
489  cmd_key.Printf( "CustomNetlistCommand%d", i );
490  title_key.Printf( "CustomNetlistTitle%d", i );
491 
492  if( aCfg->Read( cmd_key, &cmd ) && aCfg->Read( title_key, &title )
493  && !cmd.IsEmpty() && !title.IsEmpty() )
494  {
495  js_cmd.push_back( cmd.ToUTF8() );
496  js_title.push_back( title.ToUTF8() );
497  }
498  }
499 
500  ( *this )[PointerFromString( "netlist.custom_command_titles" )] = js_title;
501  ( *this )[PointerFromString( "netlist.custom_command_paths" )] = js_cmd;
502  }
503 
504  {
505  // NOTE(JE) These parameters should move to project-local storage before V6, but we are
506  // migrating them here in order to preserve data. There is a bug here that is preserved:
507  // keys are taken directly from the (translated) UI and stored in the config, so if the user
508  // changes languages the keys will no longer work.
509  aCfg->SetPath( "SymbolFieldEditor/Show/" );
510 
511  nlohmann::json js = nlohmann::json( {} );
512  wxString key;
513  bool value = false;
514  long index = 0;
515 
516  while( aCfg->GetNextEntry( key, index ) )
517  {
518  if( aCfg->Read( key, &value ) )
519  {
520  std::string key_utf( key.ToUTF8() );
521  js[PointerFromString( key_utf )] = value;
522  }
523  }
524 
525  ( *this )[PointerFromString( "field_editor.fields_show" ) ] = js;
526 
527  aCfg->SetPath( "../GroupBy" );
528 
529  while( aCfg->GetNextEntry( key, index ) )
530  {
531  if( aCfg->Read( key, &value ) )
532  {
533  std::string key_utf( key.ToUTF8() );
534  js[PointerFromString( key_utf )] = value;
535  }
536  }
537 
538  ( *this )[PointerFromString( "field_editor.fields_group_by" ) ] = js;
539 
540  aCfg->SetPath( "../.." );
541  }
542 
543  ret &= fromLegacy<bool>( aCfg, "PlotModeColor", "plot.color" );
544  ret &= fromLegacy<int>( aCfg, "PlotFormat", "plot.format" );
545  ret &= fromLegacy<bool>( aCfg, "PlotFrameRef", "plot.frame_reference" );
546  ret &= fromLegacy<bool>( aCfg, "PlotHPGLOrg", "plot.hpgl_origin" );
547  ret &= fromLegacy<int>( aCfg, "PlotHPGLPaperSize", "plot.hpgl_paper_size" );
548  ret &= fromLegacy<double>( aCfg, "PlotHPGLPenSize", "plot.hpgl_pen_size" );
549 
550  ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMEPos_x", "simulator.window.pos_x" );
551  ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMEPos_y", "simulator.window.pos_y" );
552  ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMESize_x", "simulator.window.size_x" );
553  ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMESize_y", "simulator.window.size_y" );
554  ret &= fromLegacy<bool>( aCfg, "SIM_PLOT_FRAMEMaximized", "simulator.window.maximized" );
555  ret &= fromLegacyString( aCfg, "SIM_PLOT_FRAMEPerspective", "simulator.window.perspective" );
556  ret &= fromLegacyString( aCfg, "SIM_PLOT_FRAMEMostRecentlyUsedPath", "simulator.mru_path" );
557  ret &= fromLegacy<int>( aCfg, "SimPlotPanelWidth", "simulator.plot_panel_width" );
558  ret &= fromLegacy<int>( aCfg, "SimPlotPanelHeight", "simulator.plot_panel_height" );
559  ret &= fromLegacy<int>( aCfg, "SimSignalPanelHeight", "simulator.signal_panel_height" );
560  ret &= fromLegacy<int>( aCfg, "SimCursorsPanelHeight", "simulator.cursors_panel_height" );
561  ret &= fromLegacy<bool>( aCfg, "SimPlotWhiteBg", "simulator.white_background" );
562 
563  ret &= fromLegacy<int>( aCfg, "SymbolChooserHSashPosition", "symbol_chooser.sash_pos_h" );
564  ret &= fromLegacy<int>( aCfg, "SymbolChooserVSashPosition", "symbol_chooser.sash_pos_v" );
565  ret &= fromLegacy<int>( aCfg, "SymbolChooserWidth", "symbol_chooser.width" );
566  ret &= fromLegacy<int>( aCfg, "SymbolChooserHeight", "symbol_chooser.height" );
567  ret &= fromLegacy<bool>( aCfg, "SymbolChooserKeepSymbol", "symbol_chooser.keep_symbol" );
568  ret &= fromLegacy<bool>( aCfg, "SymbolChooserUseUnits", "symbol_chooser.place_all_units" );
569 
570  const std::string vlf = "ViewlibFrame";
571  ret &= fromLegacy<bool>( aCfg, vlf + "Maximized", "lib_view.window.maximized" );
572  ret &= fromLegacyString( aCfg, vlf + "MostRecentlyUsedPath", "lib_view.window.mru_path" );
573  ret &= fromLegacy<int>( aCfg, vlf + "Size_x", "lib_view.window.size_x" );
574  ret &= fromLegacy<int>( aCfg, vlf + "Size_y", "lib_view.window.size_y" );
575  ret &= fromLegacyString( aCfg, vlf + "Perspective", "lib_view.window.perspective" );
576  ret &= fromLegacy<int>( aCfg, vlf + "Pos_x", "lib_view.window.pos_x" );
577  ret &= fromLegacy<int>( aCfg, vlf + "Pos_y", "lib_view.window.pos_y" );
578  ret &= fromLegacy<int>( aCfg, "ViewLiblistWidth", "lib_view.lib_list_width" );
579  ret &= fromLegacy<int>( aCfg, "ViewCmplistWidth", "lib_view.cmp_list_width" );
580  ret &= fromLegacy<bool>( aCfg,
581  "ViewCmpShowPinElectricalType", "lib_view.show_pin_electrical_type" );
582  ret &= fromLegacy<bool>( aCfg, vlf + "ShowGrid", "lib_view.grid.show" );
583  ret &= fromLegacy<int>( aCfg, vlf + "_LastGridSize", "lib_view.grid.last_size" );
584 
585  ret &= fromLegacy<bool>( aCfg, "RescueNeverShow", "system.never_show_rescue_dialog" );
586 
587  // Legacy version stored this setting in eeschema, so move it to common if it exists
588  aCfg->Read( "MoveWarpsCursor", &Pgm().GetCommonSettings()->m_Input.warp_mouse_on_move );
589 
590  COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetMigratedColorSettings();
591 
592  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
593  wxString str;
594 
595  if( aCfg->Read( aKey, &str ) )
596  cs->SetColor( aLayerId, COLOR4D( str ) );
597  };
598 
599  migrateLegacyColor( "Color4DBgCanvasEx", LAYER_SCHEMATIC_BACKGROUND );
600  migrateLegacyColor( "Color4DBodyBgEx", LAYER_DEVICE_BACKGROUND );
601  migrateLegacyColor( "Color4DBodyEx", LAYER_DEVICE );
602  migrateLegacyColor( "Color4DBrightenedEx", LAYER_BRIGHTENED );
603  migrateLegacyColor( "Color4DBusEx", LAYER_BUS );
604  migrateLegacyColor( "Color4DConnEx", LAYER_JUNCTION );
605  migrateLegacyColor( "Color4DCursorEx", LAYER_SCHEMATIC_CURSOR );
606  migrateLegacyColor( "Color4DErcEEx", LAYER_ERC_ERR );
607  migrateLegacyColor( "Color4DErcWEx", LAYER_ERC_WARN );
608  migrateLegacyColor( "Color4DFieldEx", LAYER_FIELDS );
609  migrateLegacyColor( "Color4DGLabelEx", LAYER_GLOBLABEL );
610  migrateLegacyColor( "Color4DGridEx", LAYER_SCHEMATIC_GRID );
611  migrateLegacyColor( "Color4DHLabelEx", LAYER_HIERLABEL );
612  migrateLegacyColor( "Color4DHiddenEx", LAYER_HIDDEN );
613  migrateLegacyColor( "Color4DLLabelEx", LAYER_LOCLABEL );
614  migrateLegacyColor( "Color4DNoConnectEx", LAYER_NOCONNECT );
615  migrateLegacyColor( "Color4DNoteEx", LAYER_NOTES );
616  migrateLegacyColor( "Color4DPinEx", LAYER_PIN );
617  migrateLegacyColor( "Color4DPinNameEx", LAYER_PINNAM );
618  migrateLegacyColor( "Color4DPinNumEx", LAYER_PINNUM );
619  migrateLegacyColor( "Color4DReferenceEx", LAYER_REFERENCEPART );
620  migrateLegacyColor( "Color4DShadowEx", LAYER_SELECTION_SHADOWS );
621  migrateLegacyColor( "Color4DSheetEx", LAYER_SHEET );
622  migrateLegacyColor( "Color4DSheetFileNameEx", LAYER_SHEETFILENAME );
623  migrateLegacyColor( "Color4DSheetLabelEx", LAYER_SHEETLABEL );
624  migrateLegacyColor( "Color4DSheetNameEx", LAYER_SHEETNAME );
625  migrateLegacyColor( "Color4DValueEx", LAYER_VALUEPART );
626  migrateLegacyColor( "Color4DWireEx", LAYER_WIRE );
627  migrateLegacyColor( "Color4DWorksheetEx", LAYER_SCHEMATIC_DRAWINGSHEET );
628 
629  Pgm().GetSettingsManager().SaveColorSettings( cs, "schematic" );
630 
631  ( *this )[PointerFromString( "appearance.color_theme" )] = cs->GetFilename();
632 
633  // LibEdit settings were stored with eeschema. If eeschema is the first app to run,
634  // we need to migrate the LibEdit settings here
635 
636  auto libedit = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>( false );
637  libedit->MigrateFromLegacy( aCfg );
638  libedit->Load();
639 
640  return ret;
641 }
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
wxString GetFilename() const
Definition: json_settings.h:66
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
nlohmann::json json
Definition: gerbview.cpp:41
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
Color settings are a bit different than most of the settings objects in that there can be more than o...
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
void SetColor(int aLayer, COLOR4D aColor)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

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, m_Input, migrateBomSettings(), APP_SETTINGS_BASE::MigrateFromLegacy(), Pgm(), JSON_SETTINGS::PointerFromString(), and COLOR_SETTINGS::SetColor().

◆ 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 232 of file app_settings.cpp.

234 {
235  bool ret = true;
236 
237  const std::string frameGDO = aFrame + "GalDisplayOptions";
238  const std::string cursorPath = aJsonPath + ".cursor";
239  const std::string gridPath = aJsonPath + ".grid";
240 
241  ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
242  ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
243  ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
244  ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
245  ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
246  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
247  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
248 
249  ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
250  ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
251 
252  ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
253 
254  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
255  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
256 
257  ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
258  ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
259  ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
260  ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
261  ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
262  ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
263 
264  return ret;
265 }
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
bool 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 CVPCB_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

◆ PointerFromString()

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

Builds a JSON pointer based on a given string.

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

Definition at line 506 of file json_settings.cpp.

507 {
508  std::replace( aPath.begin(), aPath.end(), '.', '/' );
509  aPath.insert( 0, "/" );
510 
511  nlohmann::json::json_pointer p;
512 
513  try
514  {
515  p = nlohmann::json::json_pointer( aPath );
516  }
517  catch( ... )
518  {
519  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
520  }
521 
522  return p;
523 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), migrateBomSettings(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetIfPresent().

◆ registerMigration()

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

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 455 of file json_settings.cpp.

457 {
458  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
459  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
460  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
461 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

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

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

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 682 of file json_settings.cpp.

683 {
684  if( !aSettings )
685  return;
686 
687  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
688  [&aSettings]( const JSON_SETTINGS* aPtr ) {
689  return aPtr == aSettings;
690  } );
691 
692  if( it != m_nested_settings.end() )
693  {
694  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
695  ( *it )->SaveToFile();
696  m_nested_settings.erase( it );
697  }
698 
699  aSettings->SetParent( nullptr );
700 }
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 317 of file json_settings.cpp.

318 {
319  for( auto param : m_params )
320  param->SetDefault();
321 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
virtualinherited
   Calls Store() and then writes the contents of the JSON document to a file
   @param aDirectory is the directory to save to, including trailing separator

c *

Returns
true if the file was saved

Reimplemented in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 336 of file json_settings.cpp.

337 {
338  if( !m_writeFile )
339  return false;
340 
341  // Default PROJECT won't have a filename set
342  if( m_filename.IsEmpty() )
343  return false;
344 
345  wxFileName path;
346 
347  if( aDirectory.empty() )
348  {
349  path.Assign( m_filename );
350  path.SetExt( getFileExt() );
351  }
352  else
353  {
354  wxString dir( aDirectory );
355  path.Assign( dir, m_filename, getFileExt() );
356  }
357 
358  if( !m_createIfMissing && !path.FileExists() )
359  {
360  wxLogTrace( traceSettings,
361  "File for %s doesn't exist and m_createIfMissing == false; not saving",
362  GetFullFilename() );
363  return false;
364  }
365 
366  // Ensure the path exists, and create it if not.
367  if( !path.DirExists() && !path.Mkdir() )
368  {
369  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
370  path.GetPath(), GetFullFilename() );
371  return false;
372  }
373 
374  if( ( path.FileExists() && !path.IsFileWritable() ) ||
375  ( !path.FileExists() && !path.IsDirWritable() ) )
376  {
377  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
378  return false;
379  }
380 
381  bool modified = false;
382 
383  for( auto settings : m_nested_settings )
384  modified |= settings->SaveToFile();
385 
386  modified |= Store();
387 
388  if( !modified && !aForce && path.FileExists() )
389  {
390  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
391  return false;
392  }
393  else if( !modified && !aForce && !m_createIfDefault )
394  {
395  wxLogTrace( traceSettings,
396  "%s contents still default and m_createIfDefault == false; not saving",
397  GetFullFilename() );
398  return false;
399  }
400 
401  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
402 
404  bool success = true;
405 
406  try
407  {
408  std::stringstream buffer;
409  buffer << std::setw( 2 ) << *this << std::endl;
410 
411  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
412 
413  if( !fileStream.IsOk()
414  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
415  {
416  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
417  success = false;
418  }
419  }
420  catch( nlohmann::json::exception& error )
421  {
422  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
423  GetFullFilename(), error.what() );
424  success = false;
425  }
426  catch( ... )
427  {
428  wxLogTrace( traceSettings, "Error: could not save %s." );
429  success = false;
430  }
431 
432  return success;
433 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
wxString GetFullFilename() const
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

References dummy(), JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::m_createIfDefault, JSON_SETTINGS::m_createIfMissing, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, path, JSON_SETTINGS::Store(), and traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and PGM_BASE::SetLanguage().

◆ Set() [1/3]

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

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

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

Definition at line 157 of file json_settings.h.

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

References JSON_SETTINGS::PointerFromString().

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

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 714 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

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

Definition at line 70 of file json_settings.h.

70 { m_filename = aFilename; }
wxString m_filename
The filename (not including path) of this settings file (inicode)

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ SetIfPresent() [1/4]

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

Sets the given string if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 526 of file json_settings.cpp.

528 {
529  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
530 
531  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
532  {
533  aTarget = aObj.at( ptr ).get<wxString>();
534  return true;
535  }
536 
537  return false;
538 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ SetIfPresent() [2/4]

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

Sets the given bool if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 541 of file json_settings.cpp.

543 {
544  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
545 
546  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
547  {
548  aTarget = aObj.at( ptr ).get<bool>();
549  return true;
550  }
551 
552  return false;
553 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/4]

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

Sets the given int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 556 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/4]

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

Sets the given unsigned int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 571 of file json_settings.cpp.

573 {
574  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
575 
576  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
577  {
578  aTarget = aObj.at( ptr ).get<unsigned int>();
579  return true;
580  }
581 
582  return false;
583 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 74 of file json_settings.h.

74 { m_legacy_filename = aFilename; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 197 of file json_settings.h.

198  {
199  m_manager = aManager;
200  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 77 of file json_settings.h.

77 { m_writeFile = !aReadOnly; }
bool m_writeFile
Whether or not the backing store file should be written.

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 303 of file json_settings.cpp.

304 {
305  bool modified = false;
306 
307  for( auto param : m_params )
308  {
309  modified |= !param->MatchesFile( this );
310  param->Store( this );
311  }
312 
313  return modified;
314 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_AnnotatePanel

PANEL_ANNOTATE EESCHEMA_SETTINGS::m_AnnotatePanel

Definition at line 231 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and DIALOG_ANNOTATE::InitValues().

◆ m_Appearance

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 187 of file app_settings.h.

◆ 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 315 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 309 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 321 of file json_settings.h.

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

◆ m_Drawing

◆ m_FieldEditorPanel

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_Graphics

◆ m_Input

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

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 330 of file json_settings.h.

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

◆ m_migrators

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

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 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 306 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

Definition at line 239 of file eeschema_settings.h.

Referenced by NETLIST_DIALOG::WriteCurrentNetlistSetup().

◆ m_PageSettings

PAGE_SETTINGS EESCHEMA_SETTINGS::m_PageSettings

Definition at line 229 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ m_params

◆ m_PlotPanel

PANEL_PLOT EESCHEMA_SETTINGS::m_PlotPanel

◆ m_preserved_paths

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

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

Definition at line 333 of file json_settings.h.

◆ m_Printing

◆ m_RescueNeverShow

bool EESCHEMA_SETTINGS::m_RescueNeverShow

Definition at line 249 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ 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 324 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 243 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: