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  NETLIST_PLUGIN_SETTINGS
 
struct  PAGE_SETTINGS
 
struct  PANEL_ANNOTATE
 
struct  PANEL_BOM
 
struct  PANEL_FIELD_EDITOR
 
struct  PANEL_LIB_VIEW
 
struct  PANEL_NETLIST
 
struct  PANEL_PLOT
 
struct  PANEL_SYM_CHOOSER
 
struct  SELECTION
 
struct  SIMULATOR
 

Public Member Functions

 EESCHEMA_SETTINGS ()
 
virtual ~EESCHEMA_SETTINGS ()
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
virtual const std::vector< wxString > DefaultGridSizeList () const
 By default, this returns the list of grids available in PcbNew-based applications. More...
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
nlohmann::jsonAt (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally. More...
 
bool Contains (const std::string &aPath) const
 
size_t Count (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
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 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::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 
std::unique_ptr< JSON_SETTINGS_INTERNALSm_internals
 

Private Member Functions

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

Static Private Member Functions

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

Detailed Description

Definition at line 33 of file eeschema_settings.h.

Constructor & Destructor Documentation

◆ EESCHEMA_SETTINGS()

EESCHEMA_SETTINGS::EESCHEMA_SETTINGS ( )

Definition at line 58 of file eeschema_settings.cpp.

58  :
60  m_Appearance(),
62  m_Drawing(),
63  m_Input(),
66  m_BomPanel(),
70  m_PlotPanel(),
72  m_Selection(),
73  m_Simulator(),
74  m_RescueNeverShow( false )
75 {
76  m_params.emplace_back( new PARAM<wxString>( "appearance.edit_component_visible_columns",
77  &m_Appearance.edit_component_visible_columns, "0 1 2 3 4 5 6 7" ) );
78 
79  m_params.emplace_back( new PARAM<wxString>( "appearance.edit_sheet_visible_columns",
80  &m_Appearance.edit_sheet_visible_columns, "0 1 2 3 4 5 6 7" ) );
81 
82  m_params.emplace_back( new PARAM<int>( "appearance.erc_severities",
84 
85  m_params.emplace_back( new PARAM<bool>( "appearance.footprint_preview",
87 
88  m_params.emplace_back( new PARAM<bool>( "appearance.navigator_stays_open",
90 
91  m_params.emplace_back( new PARAM<bool>( "appearance.print_sheet_reference",
93 
94  m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_pins",
95  &m_Appearance.show_hidden_pins, false ) );
96 
97  m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_fields",
98  &m_Appearance.show_hidden_fields, false ) );
99 
100  m_params.emplace_back( new PARAM<bool>( "appearance.show_illegal_symbol_lib_dialog",
102 
103  m_params.emplace_back( new PARAM<bool>( "appearance.show_page_limits",
104  &m_Appearance.show_page_limits, true ) );
105 
106  m_params.emplace_back( new PARAM<bool>( "appearance.show_sexpr_file_convert_warning",
108 
109  m_params.emplace_back(
110  new PARAM<bool>( "appearance.show_sheet_filename_case_sensitivity_dialog",
112 
113  m_params.emplace_back( new PARAM<bool>( "autoplace_fields.enable",
114  &m_AutoplaceFields.enable, true ) );
115 
116  m_params.emplace_back( new PARAM<bool>( "autoplace_fields.allow_rejustify",
118 
119  m_params.emplace_back( new PARAM<bool>( "autoplace_fields.align_to_grid",
120  &m_AutoplaceFields.align_to_grid, true ) );
121 
122  m_params.emplace_back( new PARAM<int>( "drawing.default_bus_thickness",
124 
125  m_params.emplace_back( new PARAM<int>( "drawing.default_junction_size",
127 
128  m_params.emplace_back( new PARAM<int>( "drawing.pin_symbol_size",
130 
131  m_params.emplace_back( new PARAM<double>( "drawing.text_offset_ratio",
132  &m_Drawing.text_offset_ratio, 0.08 ) );
133 
134  m_params.emplace_back( new PARAM<int>( "drawing.default_line_thickness",
136 
137  m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_x",
139 
140  m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_y",
142 
143  m_params.emplace_back( new PARAM<int>( "drawing.default_wire_thickness",
145 
146  m_params.emplace_back( new PARAM<int>( "drawing.default_text_size",
148 
149  m_params.emplace_back( new PARAM<wxString>( "drawing.field_names",
150  &m_Drawing.field_names, "" ) );
151 
152  m_params.emplace_back( new PARAM<bool>( "drawing.hv_lines_only",
153  &m_Drawing.hv_lines_only, true ) );
154 
155  m_params.emplace_back( new PARAM<bool>( "drawing.auto_start_wires",
156  &m_Drawing.auto_start_wires, true ) );
157 
158  m_params.emplace_back( new PARAM<int>( "drawing.repeat_label_increment",
160 
161  m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_border_color",
162  &m_Drawing.default_sheet_border_color, COLOR4D::UNSPECIFIED ) );
163 
164  m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_background_color",
165  &m_Drawing.default_sheet_background_color, COLOR4D::UNSPECIFIED ) );
166 
167  m_params.emplace_back( new PARAM_LIST<double>( "drawing.junction_size_mult_list",
168  &m_Drawing.junction_size_mult_list, { 0.0, 1.7, 4.0, 6.0, 9.0, 12.0 } ) );
169 
170  m_params.emplace_back(new PARAM <int>( "drawing.junction_size_choice",
172 
173  m_params.emplace_back( new PARAM<bool>( "input.drag_is_move",
174  &m_Input.drag_is_move, false ) );
175 
176  m_params.emplace_back( new PARAM<int>( "selection.thickness",
177  &m_Selection.thickness, 3 ) );
178 
179  m_params.emplace_back( new PARAM<bool>( "selection.draw_selected_children",
181 
182  m_params.emplace_back( new PARAM<bool>( "selection.fill_shapes",
183  &m_Selection.fill_shapes, false ) );
184 
185  m_params.emplace_back( new PARAM<bool>( "selection.select_pin_selects_symbol",
187 
188  m_params.emplace_back( new PARAM<bool>( "selection.text_as_box",
189  &m_Selection.text_as_box, false ) );
190 
191  m_params.emplace_back( new PARAM<int>( "annotation.method",
192  &m_AnnotatePanel.method, 0, 0, 2 ) );
193 
194  m_params.emplace_back( new PARAM<int>( "annotation.scope",
195  &m_AnnotatePanel.scope, 0, 0, 2 ) );
196 
197  m_params.emplace_back( new PARAM<int>( "annotation.options",
198  &m_AnnotatePanel.options, 0, 0, 2 ) );
199 
200  m_params.emplace_back( new PARAM<int>( "annotation.messages_filter",
202 
203  m_params.emplace_back( new PARAM<int>( "annotation.sort_order",
204  &m_AnnotatePanel.sort_order, 0, 0, 1 ) );
205 
206  m_params.emplace_back( new PARAM<wxString>( "bom.selected_plugin",
207  &m_BomPanel.selected_plugin, "" ) );
208 
209  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "bom.plugins",
210  std::bind( &EESCHEMA_SETTINGS::bomSettingsToJson, this ),
211  [&]( const nlohmann::json& aObj )
212  {
213  if( !aObj.is_array() )
214  return;
215 
216  const nlohmann::json& list = aObj.empty() ? defaultBomPlugins : aObj;
217 
219  },
220  defaultBomPlugins ) );
221 
222  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "netlist.plugins",
223  std::bind( &EESCHEMA_SETTINGS::netlistSettingsToJson, this ),
224  [&]( const nlohmann::json& aObj )
225  {
226  if( !aObj.is_array() )
227  return;
228 
229  if( aObj.empty() )
230  return;
231 
232  const nlohmann::json& list = aObj;
233 
235  },
236  nullptr ) );
237 
238  m_params.emplace_back( new PARAM<bool>( "page_settings.export_paper",
239  &m_PageSettings.export_paper, false ) );
240 
241  m_params.emplace_back( new PARAM<bool>( "page_settings.export_revision",
242  &m_PageSettings.export_revision, false ) );
243 
244  m_params.emplace_back( new PARAM<bool>( "page_settings.export_date",
245  &m_PageSettings.export_date, false ) );
246 
247  m_params.emplace_back( new PARAM<bool>( "page_settings.export_title",
248  &m_PageSettings.export_title, false ) );
249 
250  m_params.emplace_back( new PARAM<bool>( "page_settings.export_company",
251  &m_PageSettings.export_company, false ) );
252 
253  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment1",
254  &m_PageSettings.export_comment1, false ) );
255 
256  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment2",
257  &m_PageSettings.export_comment2, false ) );
258 
259  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment3",
260  &m_PageSettings.export_comment3, false ) );
261 
262  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment4",
263  &m_PageSettings.export_comment4, false ) );
264 
265  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment5",
266  &m_PageSettings.export_comment5, false ) );
267 
268  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment6",
269  &m_PageSettings.export_comment6, false ) );
270 
271  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment7",
272  &m_PageSettings.export_comment7, false ) );
273 
274  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment8",
275  &m_PageSettings.export_comment8, false ) );
276 
277  m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment9",
278  &m_PageSettings.export_comment9, false ) );
279 
280  m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_show",
282 
283  m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_group_by",
285 
286  m_params.emplace_back( new PARAM_MAP<int>( "field_editor.column_widths",
288 
289  m_params.emplace_back( new PARAM<bool>( "plot.background_color",
290  &m_PlotPanel.background_color, false ) );
291 
292  m_params.emplace_back( new PARAM<bool>( "plot.color",
293  &m_PlotPanel.color, true ) );
294 
295  m_params.emplace_back( new PARAM<wxString>( "plot.color_theme",
296  &m_PlotPanel.color_theme, wxT( "user" ) ) );
297 
298  m_params.emplace_back( new PARAM<int>( "plot.format",
299  &m_PlotPanel.format, 0 ) );
300 
301  m_params.emplace_back( new PARAM<bool>( "plot.frame_reference",
302  &m_PlotPanel.frame_reference, true ) );
303 
304  m_params.emplace_back( new PARAM<int>( "plot.hpgl_paper_size",
306 
307  m_params.emplace_back( new PARAM<double>( "plot.hpgl_pen_size",
308  &m_PlotPanel.hpgl_pen_size, 0.5 ) );
309 
310  m_params.emplace_back( new PARAM<int>( "plot.hpgl_origin",
311  &m_PlotPanel.hpgl_origin, 0 ) );
312 
313  m_params.emplace_back( new PARAM<int>( "simulator.window.pos_x",
314  &m_Simulator.window.state.pos_x, 0 ) );
315 
316  m_params.emplace_back( new PARAM<int>( "simulator.window.pos_y",
317  &m_Simulator.window.state.pos_y, 0 ) );
318 
319  m_params.emplace_back( new PARAM<int>( "simulator.window.size_x",
320  &m_Simulator.window.state.size_x, 500 ) );
321 
322  m_params.emplace_back( new PARAM<int>( "simulator.window.size_y",
323  &m_Simulator.window.state.size_y, 400 ) );
324 
325  m_params.emplace_back( new PARAM<unsigned int>( "simulator.window.display",
327 
328  m_params.emplace_back( new PARAM<bool>( "simulator.window.maximized",
329  &m_Simulator.window.state.maximized, false ) );
330 
331  m_params.emplace_back( new PARAM<wxString>( "simulator.window.perspective",
332  &m_Simulator.window.perspective, "" ) );
333 
334  m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_width",
336 
337  m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_height",
339 
340  m_params.emplace_back( new PARAM<int>( "simulator.signal_panel_height",
342 
343  m_params.emplace_back( new PARAM<int>( "simulator.cursors_panel_height",
345 
346  m_params.emplace_back( new PARAM<bool>( "simulator.white_background",
347  &m_Simulator.white_background, false ) );
348 
349  m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_h",
350  &m_SymChooserPanel.sash_pos_h, -1 ) );
351 
352  m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_v",
353  &m_SymChooserPanel.sash_pos_v, -1 ) );
354 
355  m_params.emplace_back( new PARAM<int>( "symbol_chooser.width",
356  &m_SymChooserPanel.width, -1 ) );
357 
358  m_params.emplace_back( new PARAM<int>( "symbol_chooser.height",
359  &m_SymChooserPanel.height, -1 ) );
360 
361  m_params.emplace_back( new PARAM<bool>( "symbol_chooser.keep_symbol",
362  &m_SymChooserPanel.keep_symbol, false ) );
363 
364  m_params.emplace_back( new PARAM<bool>( "symbol_chooser.place_all_units",
366 
367  m_params.emplace_back( new PARAM<bool>( "system.never_show_rescue_dialog",
368  &m_RescueNeverShow, false ) );
369 
370  m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_x",
372 
373  m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_y",
375 
376  m_params.emplace_back( new PARAM<int>( "lib_view.window.size_x",
377  &m_LibViewPanel.window.state.size_x, 500 ) );
378 
379  m_params.emplace_back( new PARAM<int>( "lib_view.window.size_y",
380  &m_LibViewPanel.window.state.size_y, 400 ) );
381 
382  m_params.emplace_back( new PARAM<unsigned int>( "lib_view.window.display",
384 
385  m_params.emplace_back( new PARAM<bool>( "lib_view.window.maximized",
386  &m_LibViewPanel.window.state.maximized, false ) );
387 
388  m_params.emplace_back( new PARAM<wxString>( "lib_view.window.perspective",
390 
391  m_params.emplace_back( new PARAM<int>( "lib_view.lib_list_width",
392  &m_LibViewPanel.lib_list_width, 150 ) );
393 
394  m_params.emplace_back( new PARAM<int>( "lib_view.cmp_list_width",
395  &m_LibViewPanel.cmp_list_width, 150 ) );
396 
397  m_params.emplace_back( new PARAM<bool>( "lib_view.show_pin_electrical_type",
399 
400  m_params.emplace_back( new PARAM<wxString>( "system.last_symbol_lib_dir",
401  &m_lastSymbolLibDir, "" ) );
402 
403 
404  // Migrations
405 
406  registerMigration( 0, 1,
407  [&]() -> bool
408  {
409  // Version 0 to 1: BOM plugin settings moved from sexpr to JSON
410  return migrateBomSettings();
411  } );
412 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
#define DEFAULT_WIRE_WIDTH_MILS
The default bus width in mils. (can be changed in preference menu)
#define DEFAULT_LINE_WIDTH_MILS
The default wire width in mils. (can be changed in preference menu)
const nlohmann::json defaultBomPlugins
Default value for bom.plugins.
Represents a map of <std::string, Value>.
Definition: parameters.h:511
std::vector< BOM_PLUGIN_SETTINGS > plugins
PANEL_ANNOTATE m_AnnotatePanel
#define DEFAULT_JUNCTION_DIAM
The default bus and wire entry size in mils.
nlohmann::json json
Definition: gerbview.cpp:41
PANEL_SYM_CHOOSER m_SymChooserPanel
std::vector< NETLIST_PLUGIN_SETTINGS > plugins
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
nlohmann::json netlistSettingsToJson() const
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
std::map< std::string, int > column_widths
nlohmann::json bomSettingsToJson() const
PANEL_LIB_VIEW m_LibViewPanel
#define DEFAULT_BUS_WIDTH_MILS
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_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
static std::vector< NETLIST_PLUGIN_SETTINGS > netlistSettingsFromJson(const nlohmann::json &aObj)

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, EESCHEMA_SETTINGS::DRAWING::default_bus_thickness, DEFAULT_BUS_WIDTH_MILS, DEFAULT_JUNCTION_DIAM, EESCHEMA_SETTINGS::DRAWING::default_junction_size, EESCHEMA_SETTINGS::DRAWING::default_line_thickness, DEFAULT_LINE_WIDTH_MILS, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_x, EESCHEMA_SETTINGS::DRAWING::default_repeat_offset_y, EESCHEMA_SETTINGS::DRAWING::default_sheet_background_color, EESCHEMA_SETTINGS::DRAWING::default_sheet_border_color, DEFAULT_TEXT_SIZE, EESCHEMA_SETTINGS::DRAWING::default_text_size, EESCHEMA_SETTINGS::DRAWING::default_wire_thickness, DEFAULT_WIRE_WIDTH_MILS, defaultBomPlugins, WINDOW_STATE::display, EESCHEMA_SETTINGS::INPUT::drag_is_move, EESCHEMA_SETTINGS::SELECTION::draw_selected_children, EESCHEMA_SETTINGS::APPEARANCE::edit_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_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_NetlistPanel, m_PageSettings, JSON_SETTINGS::m_params, m_PlotPanel, m_RescueNeverShow, m_Selection, m_Simulator, m_SymChooserPanel, WINDOW_STATE::maximized, EESCHEMA_SETTINGS::PANEL_ANNOTATE::messages_filter, EESCHEMA_SETTINGS::PANEL_ANNOTATE::method, migrateBomSettings(), EESCHEMA_SETTINGS::APPEARANCE::navigator_stays_open, netlistSettingsFromJson(), netlistSettingsToJson(), EESCHEMA_SETTINGS::PANEL_ANNOTATE::options, WINDOW_SETTINGS::perspective, EESCHEMA_SETTINGS::DRAWING::pin_symbol_size, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::place_all_units, EESCHEMA_SETTINGS::SIMULATOR::plot_panel_height, EESCHEMA_SETTINGS::SIMULATOR::plot_panel_width, EESCHEMA_SETTINGS::PANEL_BOM::plugins, EESCHEMA_SETTINGS::PANEL_NETLIST::plugins, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, EESCHEMA_SETTINGS::APPEARANCE::print_sheet_reference, 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 215 of file eeschema_settings.h.

215 {}

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

744 {
745  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
746  m_nested_settings.push_back( aSettings );
747 }
wxString GetFilename() const
Definition: json_settings.h:72
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 269 of file app_settings.cpp.

270 {
271  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
272  &aWindow->state.maximized, false ) );
273 
274  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
275  &aWindow->mru_path, "" ) );
276 
277  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
278 
279  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
280 
281  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
282  &aWindow->perspective, "" ) );
283 
284  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
285 
286  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
287 
288  m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
289 
290  m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
291  &aWindow->zoom_factors, {} ) );
292 
293  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
294  &aWindow->grid.axes_enabled, false ) );
295 
296  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
297  &aWindow->grid.sizes, DefaultGridSizeList() ) );
298 
299  int defaultGridIdx;
300 
301  if( m_filename == "eeschema" || m_filename == "symbol_editor" || m_filename == "pl_editor" )
302  defaultGridIdx = 1;
303  else
304  defaultGridIdx = 4;
305 
306  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
307  &aWindow->grid.last_size_idx, defaultGridIdx ) );
308 
309  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
310  &aWindow->grid.fast_grid_1, defaultGridIdx ) );
311 
312  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
313  &aWindow->grid.fast_grid_2, defaultGridIdx + 1 ) );
314 
315  // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
316  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
317  &aWindow->grid.user_grid_x, "10 mil" ) );
318  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
319  &aWindow->grid.user_grid_y, "10 mil" ) );
320 
321  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
322  &aWindow->grid.line_width, 1.0 ) );
323 
324  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
325  &aWindow->grid.min_spacing, 10 ) );
326 
327  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
328  &aWindow->grid.show, true ) );
329 
330  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
331  &aWindow->grid.style, 0 ) );
332 
333  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
334  &aWindow->grid.snap, 0 ) );
335 
336  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
337  &aWindow->cursor.always_show_cursor, true ) );
338 
339  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
340  &aWindow->cursor.fullscreen_cursor, false ) );
341 }
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 m_filename
The filename (not including path) of this settings file (inicode)
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_filename, JSON_SETTINGS::m_params, WINDOW_STATE::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, GRID_SETTINGS::show, WINDOW_STATE::size_x, WINDOW_STATE::size_y, GRID_SETTINGS::sizes, GRID_SETTINGS::snap, WINDOW_SETTINGS::state, GRID_SETTINGS::style, GRID_SETTINGS::user_grid_x, GRID_SETTINGS::user_grid_y, and WINDOW_SETTINGS::zoom_factors.

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

◆ At()

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

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

Definition at line 111 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ bomSettingsFromJson()

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

Definition at line 748 of file eeschema_settings.cpp.

750 {
751  std::vector<EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS> ret;
752 
753  wxASSERT( aObj.is_array() );
754 
755  for( const nlohmann::json& entry : aObj )
756  {
757  if( entry.empty() || !entry.is_object() )
758  continue;
759 
760  if( !entry.contains( "name" ) || !entry.contains( "path" ) )
761  continue;
762 
763  BOM_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
764  entry.at( "path" ).get<wxString>() );
765 
766  if( entry.contains( "command" ) )
767  plugin.command = entry.at( "command" ).get<wxString>();
768 
769  ret.emplace_back( plugin );
770  }
771 
772  return ret;
773 }
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 729 of file eeschema_settings.cpp.

730 {
731  nlohmann::json js = nlohmann::json::array();
732 
733  for( const BOM_PLUGIN_SETTINGS& plugin : m_BomPanel.plugins )
734  {
735  nlohmann::json pluginJson;
736 
737  pluginJson["name"] = plugin.name.ToUTF8();
738  pluginJson["path"] = plugin.path.ToUTF8();
739  pluginJson["command"] = plugin.command.ToUTF8();
740 
741  js.push_back( pluginJson );
742  }
743 
744  return js;
745 }
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().

◆ Contains()

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

Definition at line 117 of file json_settings.cpp.

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

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

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

◆ Count()

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

Definition at line 123 of file json_settings.cpp.

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

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

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().

◆ DefaultBomPlugins()

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

Definition at line 698 of file eeschema_settings.cpp.

699 {
701 }
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 window.grid.sizes parameter

Definition at line 344 of file app_settings.cpp.

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

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

657 {
658  ValueType val;
659 
660  if( aConfig->Read( aKey, &val ) )
661  {
662  try
663  {
664  ( *m_internals )[aDest] = val;
665  }
666  catch( ... )
667  {
668  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
669  return false;
670  }
671 
672  return true;
673  }
674 
675  return false;
676 }

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

717 {
718  wxString str;
719 
720  if( aConfig->Read( aKey, &str ) )
721  {
723  color.SetFromWxString( str );
724 
725  try
726  {
727  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
728  ( *m_internals )[aDest] = js;
729  }
730  catch( ... )
731  {
732  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
733  return false;
734  }
735 
736  return true;
737  }
738 
739  return false;
740 }
int color
Definition: DXF_plotter.cpp:57
nlohmann::json json
Definition: gerbview.cpp:41
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 691 of file json_settings.cpp.

693 {
694  wxString str;
695 
696  if( aConfig->Read( aKey, &str ) )
697  {
698  try
699  {
700  ( *m_internals )[aDest] = str.ToUTF8();
701  }
702  catch( ... )
703  {
704  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
705  return false;
706  }
707 
708  return true;
709  }
710 
711  return false;
712 }

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_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 >
template OPT< unsigned long long > JSON_SETTINGS::Get< unsigned long long > ( const std::string &  aPath) const
inherited

Fetches a value from within the JSON document.

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

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

Definition at line 494 of file json_settings.cpp.

495 {
496  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
497  {
498  try
499  {
500  return ret->get<ValueType>();
501  }
502  catch( ... )
503  {
504  }
505  }
506 
507  return NULLOPT;
508 }
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 773 of file json_settings.cpp.

774 {
775  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
776  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
777 
778  return NULLOPT;
779 }
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 270 of file json_settings.h.

271  {
272  return wxT( "json" );
273  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

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

475 {
476  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
477 
478  if( m_internals->contains( ptr ) )
479  {
480  try
481  {
482  return OPT<nlohmann::json>{ m_internals->at( ptr ) };
483  }
484  catch( ... )
485  {
486  }
487  }
488 
489  return OPT<nlohmann::json>{};
490 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 275 of file json_settings.h.

276  {
277  return wxEmptyString;
278  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 223 of file eeschema_settings.h.

223 { return "SchematicFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 79 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 129 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 135 of file json_settings.cpp.

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

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

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

Referenced by SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and 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 552 of file json_settings.cpp.

553 {
554  int filever = m_internals->Get<int>( "meta.version" );
555 
556  while( filever < m_schemaVersion )
557  {
558  if( !m_migrators.count( filever ) )
559  {
560  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
561  typeid( *this ).name(), filever );
562  return false;
563  }
564 
565  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
566 
567  if( pair.second() )
568  {
569  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
570  filever, pair.first );
571  filever = pair.first;
572  m_internals->At( "meta.version" ) = filever;
573  }
574  else
575  {
576  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
577  typeid( *this ).name(), filever, pair.first );
578  return false;
579  }
580  }
581 
582  return true;
583 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
int m_schemaVersion
Version of this settings schema.

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

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

◆ migrateBomSettings()

bool EESCHEMA_SETTINGS::migrateBomSettings ( )
private

Definition at line 704 of file eeschema_settings.cpp.

705 {
706  if( !Contains( "bom.plugins" ) )
707  return false;
708 
709  wxString list = Get<wxString>( "bom.plugins" ).value();
710 
711  BOM_CFG_PARSER cfg_parser( &m_BomPanel.plugins, TO_UTF8( list ), wxT( "plugins" ) );
712 
713  try
714  {
715  cfg_parser.Parse();
716  }
717  catch( const IO_ERROR& )
718  {
719  return false;
720  }
721 
722  // Parser will have loaded up our array, let's dump it out to JSON
723  At( "bom.plugins" ) = bomSettingsToJson();
724 
725  return true;
726 }
std::vector< BOM_PLUGIN_SETTINGS > plugins
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
Used for parsing legacy-format bom plugin configurations.
nlohmann::json bomSettingsToJson() const
bool Contains(const std::string &aPath) const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

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

Referenced by EESCHEMA_SETTINGS(), and MigrateFromLegacy().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 209 of file app_settings.cpp.

210 {
211  const int find_replace_history_size = 10;
212  nlohmann::json find_history = nlohmann::json::array();
213  nlohmann::json replace_history = nlohmann::json::array();
214  wxString tmp, find_key, replace_key;
215 
216  for( int i = 0; i < find_replace_history_size; ++i )
217  {
218  find_key.Printf( "FindStringHistoryList%d", i );
219  replace_key.Printf( "ReplaceStringHistoryList%d", i );
220 
221  if( aCfg->Read( find_key, &tmp ) )
222  find_history.push_back( tmp.ToStdString() );
223 
224  if( aCfg->Read( replace_key, &tmp ) )
225  replace_history.push_back( tmp.ToStdString() );
226  }
227 
228  Set( "find_replace.find_history", find_history );
229  Set( "find_replace.replace_history", replace_history );
230 }
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
nlohmann::json json
Definition: gerbview.cpp:41

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool EESCHEMA_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

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

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 415 of file eeschema_settings.cpp.

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

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

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

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

◆ netlistSettingsFromJson()

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

Definition at line 795 of file eeschema_settings.cpp.

797 {
798  std::vector<EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS> ret;
799 
800  wxASSERT( aObj.is_array() );
801 
802  for( const nlohmann::json& entry : aObj )
803  {
804  if( entry.empty() || !entry.is_object() )
805  continue;
806 
807  if( !entry.contains( "name" ) || !entry.contains( "path" ) )
808  continue;
809 
810  NETLIST_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
811  entry.at( "path" ).get<wxString>() );
812 
813  if( entry.contains( "command" ) )
814  plugin.command = entry.at( "command" ).get<wxString>();
815 
816  ret.emplace_back( plugin );
817  }
818 
819  return ret;
820 }
nlohmann::json json
Definition: gerbview.cpp:41

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command.

Referenced by EESCHEMA_SETTINGS().

◆ netlistSettingsToJson()

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

Definition at line 776 of file eeschema_settings.cpp.

777 {
778  nlohmann::json js = nlohmann::json::array();
779 
780  for( const NETLIST_PLUGIN_SETTINGS& plugin : m_NetlistPanel.plugins )
781  {
782  nlohmann::json pluginJson;
783 
784  pluginJson["name"] = plugin.name.ToUTF8();
785  pluginJson["path"] = plugin.path.ToUTF8();
786  pluginJson["command"] = plugin.command.ToUTF8();
787 
788  js.push_back( pluginJson );
789  }
790 
791  return js;
792 }
nlohmann::json json
Definition: gerbview.cpp:41
std::vector< NETLIST_PLUGIN_SETTINGS > plugins
PANEL_NETLIST m_NetlistPanel

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

Referenced by EESCHEMA_SETTINGS().

◆ registerMigration()

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

Registers a migration from one schema version to another.

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

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

Definition at line 543 of file json_settings.cpp.

545 {
546  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
547  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
548  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
549 }
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(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SCHEMATIC_SETTINGS::SCHEMATIC_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 750 of file json_settings.cpp.

751 {
752  if( !aSettings )
753  return;
754 
755  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
756  [&aSettings]( const JSON_SETTINGS* aPtr ) {
757  return aPtr == aSettings;
758  } );
759 
760  if( it != m_nested_settings.end() )
761  {
762  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
763  ( *it )->SaveToFile();
764  m_nested_settings.erase( it );
765  }
766 
767  aSettings->SetParent( nullptr );
768 }
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 367 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

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

c *

Returns
true if the file was saved

Reimplemented in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 374 of file json_settings.cpp.

375 {
376  if( !m_writeFile )
377  return false;
378 
379  // Default PROJECT won't have a filename set
380  if( m_filename.IsEmpty() )
381  return false;
382 
383  wxFileName path;
384 
385  if( aDirectory.empty() )
386  {
387  path.Assign( m_filename );
388  path.SetExt( getFileExt() );
389  }
390  else
391  {
392  wxString dir( aDirectory );
393  path.Assign( dir, m_filename, getFileExt() );
394  }
395 
396  if( !m_createIfMissing && !path.FileExists() )
397  {
398  wxLogTrace( traceSettings,
399  "File for %s doesn't exist and m_createIfMissing == false; not saving",
400  GetFullFilename() );
401  return false;
402  }
403 
404  // Ensure the path exists, and create it if not.
405  if( !path.DirExists() && !path.Mkdir() )
406  {
407  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
408  path.GetPath(), GetFullFilename() );
409  return false;
410  }
411 
412  if( ( path.FileExists() && !path.IsFileWritable() ) ||
413  ( !path.FileExists() && !path.IsDirWritable() ) )
414  {
415  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
416  return false;
417  }
418 
419  bool modified = false;
420 
421  for( auto settings : m_nested_settings )
422  modified |= settings->SaveToFile();
423 
424  modified |= Store();
425 
426  if( !modified && !aForce && path.FileExists() )
427  {
428  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
429  return false;
430  }
431  else if( !modified && !aForce && !m_createIfDefault )
432  {
433  wxLogTrace( traceSettings,
434  "%s contents still default and m_createIfDefault == false; not saving",
435  GetFullFilename() );
436  return false;
437  }
438 
439  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
440 
442  bool success = true;
443 
444  try
445  {
446  std::stringstream buffer;
447  buffer << std::setw( 2 ) << *m_internals << std::endl;
448 
449  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
450 
451  if( !fileStream.IsOk()
452  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
453  {
454  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
455  success = false;
456  }
457  }
458  catch( nlohmann::json::exception& error )
459  {
460  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
461  GetFullFilename(), error.what() );
462  success = false;
463  }
464  catch( ... )
465  {
466  wxLogTrace( traceSettings, "Error: could not save %s." );
467  success = false;
468  }
469 
470  return success;
471 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

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

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

◆ Set() [1/3]

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

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

525 {
526  m_internals->SetFromString( aPath, aVal );
527 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PARAM< wxString >::Store(), COLOR_MAP_PARAM::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 782 of file json_settings.cpp.

783 {
784  ( *m_internals )[aPath] = aVal.ToUTF8();
785 }

◆ SetFilename()

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

Definition at line 76 of file json_settings.h.

76 { 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::GetColorSettings(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveAs(), 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 594 of file json_settings.cpp.

596 {
597  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
598 
599  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
600  {
601  aTarget = aObj.at( ptr ).get<wxString>();
602  return true;
603  }
604 
605  return false;
606 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 609 of file json_settings.cpp.

611 {
612  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
613 
614  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
615  {
616  aTarget = aObj.at( ptr ).get<bool>();
617  return true;
618  }
619 
620  return false;
621 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 624 of file json_settings.cpp.

626 {
627  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
628 
629  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
630  {
631  aTarget = aObj.at( ptr ).get<int>();
632  return true;
633  }
634 
635  return false;
636 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 639 of file json_settings.cpp.

641 {
642  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
643 
644  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
645  {
646  aTarget = aObj.at( ptr ).get<unsigned int>();
647  return true;
648  }
649 
650  return false;
651 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 81 of file json_settings.h.

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

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 78 of file json_settings.h.

78 { m_location = aLocation; }
SETTINGS_LOC m_location
The location of this settings file (.

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192  {
193  m_manager = aManager;
194  }
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

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

354 {
355  bool modified = false;
356 
357  for( auto param : m_params )
358  {
359  modified |= !param->MatchesFile( this );
360  param->Store( this );
361  }
362 
363  return modified;
364 }
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 246 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 302 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 296 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 308 of file json_settings.h.

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

◆ m_Drawing

◆ m_FieldEditorPanel

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_Graphics

◆ m_Input

◆ m_internals

◆ m_lastSymbolLibDir

wxString EESCHEMA_SETTINGS::m_lastSymbolLibDir

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 284 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 252 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 287 of file json_settings.h.

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

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 317 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 320 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 293 of file json_settings.h.

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

◆ m_NetlistPanel

PANEL_NETLIST EESCHEMA_SETTINGS::m_NetlistPanel

◆ m_PageSettings

PAGE_SETTINGS EESCHEMA_SETTINGS::m_PageSettings

Definition at line 244 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ m_params

◆ m_PlotPanel

PANEL_PLOT EESCHEMA_SETTINGS::m_PlotPanel

◆ m_Printing

◆ m_RescueNeverShow

bool EESCHEMA_SETTINGS::m_RescueNeverShow

Definition at line 264 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ 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 311 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 258 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: