KiCad PCB EDA Suite
PCBNEW_SETTINGS Class Reference

#include <pcbnew_settings.h>

Inheritance diagram for PCBNEW_SETTINGS:
APP_SETTINGS_BASE JSON_SETTINGS

Classes

struct  AUI_PANELS
 
struct  DIALOG_CLEANUP
 
struct  DIALOG_DRC
 
struct  DIALOG_EXPORT_IDF
 
struct  DIALOG_EXPORT_STEP
 
struct  DIALOG_EXPORT_SVG
 
struct  DIALOG_EXPORT_VRML
 
struct  DIALOG_FOOTPRINT_WIZARD_LIST
 
struct  DIALOG_GENERATE_DRILL
 
struct  DIALOG_IMPORT_GRAPHICS
 
struct  DIALOG_NETLIST
 
struct  DIALOG_PLACE_FILE
 
struct  DIALOG_PLOT
 
struct  DIALOG_REANNOTATE
 
struct  FOOTPRINT_CHOOSER
 
struct  ZONES
 

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

AUI_PANELS m_AuiPanels
 
DIALOG_CLEANUP m_Cleanup
 
DIALOG_DRC m_DrcDialog
 
DIALOG_EXPORT_IDF m_ExportIdf
 
DIALOG_EXPORT_STEP m_ExportStep
 
DIALOG_EXPORT_SVG m_ExportSvg
 
DIALOG_EXPORT_VRML m_ExportVrml
 
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList
 
DIALOG_GENERATE_DRILL m_GenDrill
 
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
 
DIALOG_NETLIST m_NetlistDialog
 
DIALOG_PLACE_FILE m_PlaceFile
 
DIALOG_PLOT m_Plot
 
DIALOG_REANNOTATE m_Reannotate
 
FOOTPRINT_CHOOSER m_FootprintChooser
 
ZONES m_Zones
 
WINDOW_SETTINGS m_FootprintViewer
 
WINDOW_SETTINGS m_FootprintWizard
 
PCB_DISPLAY_OPTIONS m_Display
 
MAGNETIC_SETTINGS m_MagneticItems
 
TRACK_DRAG_ACTION m_TrackDragAction
 
bool m_Use45DegreeGraphicSegments
 
bool m_FlipLeftRight
 
bool m_AddUnlockedPads
 
bool m_PolarCoords
 
int m_RotationAngle
 
bool m_ShowPageLimits
 
wxString m_FootprintTextShownColumns
 
std::unique_ptr< PNS::ROUTING_SETTINGSm_PnsSettings
 
bool m_FootprintViewerAutoZoom
 Should the footprint viewer auto zoom on select. More...
 
double m_FootprintViewerZoom
 The last zoom level in the footprint viewer. More...
 
wxString m_lastFootprintLibDir
 
wxString m_lastFootprint3dDir
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name. More...
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings More...
 

Protected Member Functions

virtual std::string getLegacyFrameName () const override
 
void migrateFindReplace (wxConfigBase *aCfg)
 ! Migrates the find/replace history string lists More...
 
bool migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
 Migrates legacy window settings into the JSON document. More...
 
void addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
 Adds parameters for the given window object. More...
 
void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

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

Detailed Description

Definition at line 65 of file pcbnew_settings.h.

Constructor & Destructor Documentation

◆ PCBNEW_SETTINGS()

PCBNEW_SETTINGS::PCBNEW_SETTINGS ( )

Definition at line 47 of file pcbnew_settings.cpp.

49  m_AuiPanels(),
50  m_Cleanup(),
51  m_DrcDialog(),
52  m_ExportIdf(),
53  m_ExportStep(),
54  m_ExportSvg(),
55  m_ExportVrml(),
57  m_GenDrill(),
60  m_PlaceFile(),
61  m_Plot(),
63  m_Zones(),
66  m_Display(),
69  m_FlipLeftRight( false ),
70  m_AddUnlockedPads( false ),
71  m_PolarCoords( false ),
72  m_RotationAngle( 900 ),
73  m_ShowPageLimits( true ),
74  m_PnsSettings( nullptr ),
77 {
80  m_MagneticItems.graphics = false;
81 
82  m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
84 
85  m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
87 
88  m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
89  &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
90 
91  m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
92  &m_FootprintChooser.width, -1 ) );
93 
94  m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
95  &m_FootprintChooser.height, -1 ) );
96 
97  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
98  &m_FootprintChooser.sash_h, -1 ) );
99 
100  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
101  &m_FootprintChooser.sash_v, -1 ) );
102 
103  m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
104  &m_FlipLeftRight, true ) );
105 
106  m_params.emplace_back( new PARAM<bool>( "editing.add_unlocked_pads",
107  &m_AddUnlockedPads, false ) );
108 
109  m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
110  &m_MagneticItems.graphics, true ) );
111 
112  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
113  reinterpret_cast<int*>( &m_MagneticItems.pads ),
114  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
115 
116  m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
117  reinterpret_cast<int*>( &m_MagneticItems.tracks ),
118  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
119 
120  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
121  &m_PolarCoords, false ) );
122 
123  m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
124  reinterpret_cast<int*>( &m_TrackDragAction ),
125  static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
126 
127  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
128  &m_Use45DegreeGraphicSegments, false ) );
129 
130  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
131  &m_Display.m_DisplayGraphicsFill, true ) );
132 
133  m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
134  &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
135 
136  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
137  &m_Display.m_DisplayGraphicsFill, true ) );
138 
139  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
140  &m_Display.m_DisplayTextFill, true ) );
141 
142  m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
143  &m_Display.m_DisplayNetNamesMode, 3, 0, 3 ) );
144 
145  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
146  &m_Display.m_DisplayPadIsol, true ) );
147 
148  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
149  &m_Display.m_DisplayPadFill, true ) );
150 
151  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
152  &m_Display.m_DisplayPadNum, true ) );
153 
154  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
155  &m_Display.m_ShowGlobalRatsnest, true ) );
156 
157  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
158  &m_Display.m_ShowModuleRatsnest, true ) );
159 
160  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
162 
163  m_params.emplace_back( new PARAM<int>( "pcb_display.rotation_angle",
164  &m_RotationAngle, 900, 1, 900 ) );
165 
166  m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
167  reinterpret_cast<int*>( &m_Display.m_ShowTrackClearanceMode ),
169 
170  m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
171  &m_Display.m_DisplayPcbTrackFill, true ) );
172 
173  m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
174  &m_Display.m_DisplayViaFill, true ) );
175 
176  m_params.emplace_back( new PARAM_ENUM<ZONE_DISPLAY_MODE>( "pcb_display.zone_mode",
179 
180  m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
181  reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
183 
184  m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
185  &m_Display.m_DisplayInvertXAxis, false ) );
186 
187  m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
188  &m_Display.m_DisplayInvertYAxis, false ) );
189 
190  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
191  &m_Cleanup.cleanup_vias, true ) );
192 
193  m_params.emplace_back( new PARAM<bool>( "cleanup.delete_dangling_vias",
194  &m_Cleanup.delete_dangling_vias, true ) );
195 
196  m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
197  &m_Cleanup.merge_segments, true ) );
198 
199  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
200  &m_Cleanup.cleanup_unconnected, true ) );
201 
202  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
204 
205  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
206  &m_Cleanup.cleanup_tracks_in_pad, true ) );
207 
208  m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
209  &m_DrcDialog.refill_zones, true ) );
210 
211  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_all_track_errors",
213 
214  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
215  &m_DrcDialog.test_footprints, false ) );
216 
217  m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
219 
220  m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
221  &m_GenDrill.merge_pth_npth, false ) );
222 
223  m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
224  &m_GenDrill.minimal_header, false ) );
225 
226  m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror", &m_GenDrill.mirror, false ) );
227 
228  m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
229  &m_GenDrill.unit_drill_is_inch, true ) );
230 
231  m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
233 
234  m_params.emplace_back( new PARAM<int>(
235  "gen_drill.drill_file_type", &m_GenDrill.drill_file_type, 0 ) );
236 
237  m_params.emplace_back( new PARAM<int>( "gen_drill.map_file_type",
238  &m_GenDrill.map_file_type, 1 ) );
239 
240  m_params.emplace_back( new PARAM<int>( "gen_drill.zeros_format",
241  &m_GenDrill.zeros_format, 0, 0, 3 ) );
242 
243  m_params.emplace_back( new PARAM<bool>( "export_idf.auto_adjust",
244  &m_ExportIdf.auto_adjust, false ) );
245 
246  m_params.emplace_back( new PARAM<int>( "export_idf.ref_units",
247  &m_ExportIdf.ref_units, 0 ) );
248 
249  m_params.emplace_back( new PARAM<double>( "export_idf.ref_x",
250  &m_ExportIdf.ref_x, 0 ) );
251 
252  m_params.emplace_back( new PARAM<double>( "export_idf.ref_y",
253  &m_ExportIdf.ref_y, 0 ) );
254 
255  m_params.emplace_back( new PARAM<bool>( "export_idf.units_mils",
256  &m_ExportIdf.units_mils, false ) );
257 
258  m_params.emplace_back( new PARAM<int>( "export_step.origin_mode",
259  &m_ExportStep.origin_mode, 0 ) );
260 
261  m_params.emplace_back( new PARAM<int>( "export_step.origin_units",
262  &m_ExportStep.origin_units, 0 ) );
263 
264  m_params.emplace_back( new PARAM<double>( "export_step.origin_x",
265  &m_ExportStep.origin_x, 0 ) );
266 
267  m_params.emplace_back( new PARAM<double>( "export_step.origin_y",
268  &m_ExportStep.origin_y, 0 ) );
269 
270  m_params.emplace_back( new PARAM<bool>( "export_step.no_virtual",
271  &m_ExportStep.no_virtual, false ) );
272 
273  m_params.emplace_back( new PARAM<bool>( "export_svg.black_and_white",
274  &m_ExportSvg.black_and_white, false ) );
275 
276  m_params.emplace_back( new PARAM<bool>( "export_svg.mirror",
277  &m_ExportSvg.mirror, false ) );
278 
279  m_params.emplace_back( new PARAM<bool>( "export_svg.one_file",
280  &m_ExportSvg.one_file, false ) );
281 
282  m_params.emplace_back(new PARAM<bool>( "export_svg.plot_board_edges",
283  &m_ExportSvg.plot_board_edges, true ) );
284 
285  m_params.emplace_back( new PARAM<int>( "export_svg.page_size",
286  &m_ExportSvg.page_size, 0 ) );
287 
288  m_params.emplace_back( new PARAM<wxString>( "export_svg.output_dir",
289  &m_ExportSvg.output_dir, "" ) );
290 
291  m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers",
292  &m_ExportSvg.layers, {} ) );
293 
294  m_params.emplace_back( new PARAM<int>( "export_vrml.units",
295  &m_ExportVrml.units, 1 ) );
296 
297  m_params.emplace_back( new PARAM<bool>( "export_vrml.copy_3d_models",
298  &m_ExportVrml.copy_3d_models, false ) );
299 
300  m_params.emplace_back( new PARAM<bool>( "export_vrml.use_relative_paths",
301  &m_ExportVrml.use_relative_paths, false ) );
302 
303  m_params.emplace_back( new PARAM<bool>( "export_vrml.use_plain_pcb",
304  &m_ExportVrml.use_plain_pcb, false ) );
305 
306  m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units",
307  &m_ExportVrml.ref_units, 0 ) );
308 
309  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x",
310  &m_ExportVrml.ref_x, 0 ) );
311 
312  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y",
313  &m_ExportVrml.ref_y, 0 ) );
314 
315  m_params.emplace_back( new PARAM<int>( "zones.hatching_style",
316  &m_Zones.hatching_style, 0 ) );
317 
318  m_params.emplace_back( new PARAM<wxString>( "zones.net_filter",
319  &m_Zones.net_filter, "" ) );
320 
321  m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode",
322  &m_Zones.net_sort_mode, 1 ) );
323 
324  m_params.emplace_back( new PARAM<double>( "zones.clearance",
326 
327  m_params.emplace_back( new PARAM<double>( "zones.min_thickness",
329 
330  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_gap",
332 
333  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_copper_width",
335 
336  m_params.emplace_back( new PARAM<int>( "import_graphics.layer",
338 
339  m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
341 
342  m_params.emplace_back( new PARAM<int>( "import_graphics.line_width_units",
344 
345  m_params.emplace_back( new PARAM<double>( "import_graphics.line_width",
346  &m_ImportGraphics.line_width, 0.2 ) );
347 
348  m_params.emplace_back( new PARAM<int>( "import_graphics.origin_units",
350 
351  m_params.emplace_back( new PARAM<double>( "import_graphics.origin_x",
352  &m_ImportGraphics.origin_x, 0 ) );
353 
354  m_params.emplace_back( new PARAM<double>( "import_graphics.origin_y",
355  &m_ImportGraphics.origin_y, 0 ) );
356 
357  m_params.emplace_back( new PARAM<int>( "import_graphics.dxf_units",
358  &m_ImportGraphics.dxf_units, 0 ) );
359 
360  m_params.emplace_back( new PARAM<int>( "netlist.report_filter",
362 
363  m_params.emplace_back( new PARAM<bool>( "netlist.update_footprints",
365 
366  m_params.emplace_back( new PARAM<bool>( "netlist.delete_shorting_tracks",
368 
369  m_params.emplace_back( new PARAM<bool>( "netlist.delete_extra_footprints",
371 
372  m_params.emplace_back( new PARAM<bool>( "netlist.delete_single_pad_nets",
374 
375  m_params.emplace_back( new PARAM<bool>( "netlist.associate_by_ref_sch",
377 
378  m_params.emplace_back(new PARAM<int>( "place_file.units",
379  &m_PlaceFile.units, 1 ) );
380 
381  m_params.emplace_back( new PARAM<int>( "place_file.file_options",
382  &m_PlaceFile.file_options, 0 ) );
383 
384  m_params.emplace_back( new PARAM<int>( "place_file.file_format",
385  &m_PlaceFile.file_format, 0 ) );
386 
387  m_params.emplace_back( new PARAM<bool>( "place_file.include_board_edge",
388  &m_PlaceFile.include_board_edge, false ) );
389 
390  m_params.emplace_back( new PARAM<int>( "plot.all_layers_on_one_page",
392 
393  m_params.emplace_back( new PARAM<int>( "plot.pads_drill_mode",
394  &m_Plot.pads_drill_mode, 2 ) );
395 
396  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x",
397  &m_Plot.fine_scale_x, 0 ) );
398 
399  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y",
400  &m_Plot.fine_scale_y, 0 ) );
401 
402  m_params.emplace_back( new PARAM<double>( "plot.ps_fine_width_adjust",
404 
405  m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
407 
408  m_params.emplace_back( new PARAM<bool>( "plot.mirror",
409  &m_Plot.mirror, false ) );
410 
411  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
412  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
413 
414  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.width",
415  &m_FootprintWizardList.width, -1 ) );
416 
417  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
418  &m_FootprintWizardList.height, -1 ) );
419 
420  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_sort_on_modules",
422  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_front_prefix",
423  &m_Reannotate.remove_front_prefix, false ) );
424  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_back_prefix",
425  &m_Reannotate.remove_back_prefix, false ) );
426  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_update_schematic",
427  &m_Reannotate.update_schematic, true ) );
428  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_exclude_locked",
429  &m_Reannotate.exclude_locked, false ) );
430 
431  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_grid_index",
432  &m_Reannotate.grid_index, 0 ) );
433  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_sort_code",
434  &m_Reannotate.sort_code, 0 ) );
435  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_choice",
437  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_report_severity",
439 
440  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_refdes_start",
442  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_refdes_start",
444  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_prefix",
445  &m_Reannotate.front_prefix, "" ) );
446  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_prefix",
447  &m_Reannotate.back_prefix, "" ) );
448  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_exclude_list",
449  &m_Reannotate.exclude_list, "" ) );
450  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_report_file_name",
452 
453 #if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU)
454  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
455  [&]() -> nlohmann::json
456  {
457  nlohmann::json js = nlohmann::json::array();
458 
459  for( const auto& pair : m_VisibleActionPlugins )
460  js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
461 
462  return js;
463  },
464  [&]( const nlohmann::json& aObj )
465  {
466  m_VisibleActionPlugins.clear();
467 
468  if( !aObj.is_array() )
469  {
470  return;
471  }
472 
473  for( const auto& entry : aObj )
474  {
475  if( entry.empty() || !entry.is_object() )
476  continue;
477 
478  for( const auto& pair : entry.items() )
479  {
480  m_VisibleActionPlugins.emplace_back( std::make_pair(
481  wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
482  }
483  }
484  },
485  nlohmann::json::array() ) );
486 #endif
487 
488  addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
489 
490  m_params.emplace_back( new PARAM<bool>( "footprint_viewer.auto_zoom",
491  &m_FootprintViewerAutoZoom, false ) );
492 
493  m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
494  &m_FootprintViewerZoom, 1.0 ) );
495 
496  addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
497 
498  m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
499  &m_lastFootprintLibDir, "" ) );
500 
501  m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
502  &m_lastFootprint3dDir, "" ) );
503 }
DIALOG_GENERATE_DRILL m_GenDrill
Filled polygons are shown.
void addParamsForWindow(WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
Adds parameters for the given window object.
DIALOG_EXPORT_STEP m_ExportStep
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
DIALOG_CLEANUP m_Cleanup
Outlines of filled polygons are shown.
DIALOG_EXPORT_IDF m_ExportIdf
Stores an enum as an integer.
Definition: parameters.h:226
const int pcbnewSchemaVersion
! Update the schema version whenever a migration is required
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL
Definition: zones.h:30
double m_FootprintViewerZoom
The last zoom level in the footprint viewer.
wxString m_FootprintTextShownColumns
DIALOG_EXPORT_VRML m_ExportVrml
nlohmann::json json
Definition: gerbview.cpp:40
FOOTPRINT_CHOOSER m_FootprintChooser
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
How trace clearances are displayed.
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList
bool m_Use45DegreeGraphicSegments
wxString m_lastFootprint3dDir
WINDOW_SETTINGS m_FootprintWizard
DIALOG_EXPORT_SVG m_ExportSvg
PCB_DISPLAY_ORIGIN_OPTIONS_T m_DisplayOrigin
Which origin is used for display transforms.
TRACK_DRAG_ACTION m_TrackDragAction
DIALOG_NETLIST m_NetlistDialog
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
#define ZONE_CLEARANCE_MIL
Definition: zones.h:33
WINDOW_SETTINGS m_FootprintViewer
std::unique_ptr< PNS::ROUTING_SETTINGS > m_PnsSettings
#define ZONE_THICKNESS_MIL
Definition: zones.h:31
DIALOG_PLACE_FILE m_PlaceFile
MAGNETIC_OPTIONS pads
ZONE_DISPLAY_MODE m_ZoneDisplayMode
AUI_PANELS m_AuiPanels
DIALOG_PLOT m_Plot
DIALOG_REANNOTATE m_Reannotate
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
#define ZONE_THERMAL_RELIEF_GAP_MIL
Definition: zones.h:29
DIALOG_DRC m_DrcDialog
MAGNETIC_SETTINGS m_MagneticItems
wxString m_lastFootprintLibDir
bool m_FootprintViewerAutoZoom
Should the footprint viewer auto zoom on select.
PCB_DISPLAY_OPTIONS m_Display
MAGNETIC_OPTIONS tracks

References APP_SETTINGS_BASE::addParamsForWindow(), PCBNEW_SETTINGS::DIALOG_PLOT::all_layers_on_one_page, PCBNEW_SETTINGS::DIALOG_REANNOTATE::annotation_choice, PCBNEW_SETTINGS::AUI_PANELS::appearance_panel_tab, PCBNEW_SETTINGS::DIALOG_NETLIST::associate_by_ref_sch, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::auto_adjust, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_refdes_start, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::black_and_white, CAPTURE_CURSOR_IN_TRACK_TOOL, PCBNEW_SETTINGS::DIALOG_PLOT::check_zones_before_plotting, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_short_circuits, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_tracks_in_pad, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_unconnected, PCBNEW_SETTINGS::DIALOG_CLEANUP::cleanup_vias, PCBNEW_SETTINGS::ZONES::clearance, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::copy_3d_models, PCBNEW_SETTINGS::DIALOG_CLEANUP::delete_dangling_vias, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_extra_footprints, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_shorting_tracks, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_single_pad_nets, DRAG, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::drill_file_type, Dwgs_User, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_units, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_list, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_locked, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::file_format, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::file_options, PCBNEW_SETTINGS::DIALOG_PLOT::fine_scale_x, PCBNEW_SETTINGS::DIALOG_PLOT::fine_scale_y, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_refdes_start, MAGNETIC_SETTINGS::graphics, PCBNEW_SETTINGS::DIALOG_REANNOTATE::grid_index, PCBNEW_SETTINGS::ZONES::hatching_style, PCBNEW_SETTINGS::DIALOG_FOOTPRINT_WIZARD_LIST::height, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::height, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::include_board_edge, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::interactive_placement, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::layer, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::layers, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::line_width, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::line_width_units, m_AddUnlockedPads, m_AuiPanels, m_Cleanup, m_Display, PCB_DISPLAY_OPTIONS::m_DisplayGraphicsFill, PCB_DISPLAY_OPTIONS::m_DisplayInvertXAxis, PCB_DISPLAY_OPTIONS::m_DisplayInvertYAxis, PCB_DISPLAY_OPTIONS::m_DisplayNetNamesMode, PCB_DISPLAY_OPTIONS::m_DisplayOrigin, PCB_DISPLAY_OPTIONS::m_DisplayPadFill, PCB_DISPLAY_OPTIONS::m_DisplayPadIsol, PCB_DISPLAY_OPTIONS::m_DisplayPadNum, PCB_DISPLAY_OPTIONS::m_DisplayPcbTrackFill, PCB_DISPLAY_OPTIONS::m_DisplayRatsnestLinesCurved, PCB_DISPLAY_OPTIONS::m_DisplayTextFill, PCB_DISPLAY_OPTIONS::m_DisplayViaFill, m_DrcDialog, m_ExportIdf, m_ExportStep, m_ExportSvg, m_ExportVrml, m_FlipLeftRight, m_FootprintChooser, m_FootprintTextShownColumns, m_FootprintViewer, m_FootprintViewerAutoZoom, m_FootprintViewerZoom, m_FootprintWizard, m_FootprintWizardList, m_GenDrill, m_ImportGraphics, m_lastFootprint3dDir, m_lastFootprintLibDir, m_MagneticItems, PCB_DISPLAY_OPTIONS::m_MaxLinksShowed, m_NetlistDialog, JSON_SETTINGS::m_params, m_PlaceFile, m_Plot, m_PolarCoords, m_Reannotate, m_RotationAngle, PCB_DISPLAY_OPTIONS::m_ShowGlobalRatsnest, PCB_DISPLAY_OPTIONS::m_ShowModuleRatsnest, PCB_DISPLAY_OPTIONS::m_ShowTrackClearanceMode, m_TrackDragAction, m_Use45DegreeGraphicSegments, PCB_DISPLAY_OPTIONS::m_ZoneDisplayMode, m_Zones, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::map_file_type, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::merge_pth_npth, PCBNEW_SETTINGS::DIALOG_CLEANUP::merge_segments, PCBNEW_SETTINGS::ZONES::min_thickness, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::minimal_header, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::mirror, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::mirror, PCBNEW_SETTINGS::DIALOG_PLOT::mirror, PCBNEW_SETTINGS::ZONES::net_filter, PCBNEW_SETTINGS::ZONES::net_sort_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::no_virtual, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::one_file, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_units, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_units, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_x, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_x, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_y, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_y, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::output_dir, MAGNETIC_SETTINGS::pads, PCBNEW_SETTINGS::DIALOG_PLOT::pads_drill_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::page_size, PCB_DISPLAY_OPTIONS::PCB_ORIGIN_PAGE, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::plot_board_edges, PCBNEW_SETTINGS::DIALOG_PLOT::ps_fine_width_adjust, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_units, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_units, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_x, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_x, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_y, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_y, PCBNEW_SETTINGS::DIALOG_DRC::refill_zones, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_file_name, PCBNEW_SETTINGS::DIALOG_NETLIST::report_filter, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_severity, PCBNEW_SETTINGS::AUI_PANELS::right_panel_width, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_h, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_v, PCBNEW_SETTINGS::DIALOG_DRC::severities, PCB_DISPLAY_OPTIONS::SHOW_CLEARANCE_NEW_TRACKS_AND_VIA_AREAS, SHOW_FILLED, SHOW_FILLED_OUTLINE, PCBNEW_SETTINGS::AUI_PANELS::show_layer_manager, PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_code, PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_on_fp_location, PCBNEW_SETTINGS::DIALOG_DRC::test_all_track_errors, PCBNEW_SETTINGS::DIALOG_DRC::test_footprints, PCBNEW_SETTINGS::ZONES::thermal_relief_copper_width, PCBNEW_SETTINGS::ZONES::thermal_relief_gap, MAGNETIC_SETTINGS::tracks, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::unit_drill_is_inch, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::units, PCBNEW_SETTINGS::DIALOG_PLACE_FILE::units, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::units_mils, PCBNEW_SETTINGS::DIALOG_NETLIST::update_footprints, PCBNEW_SETTINGS::DIALOG_REANNOTATE::update_schematic, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::use_plain_pcb, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::use_relative_paths, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::use_route_for_oval_holes, PCBNEW_SETTINGS::DIALOG_FOOTPRINT_WIZARD_LIST::width, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::width, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::zeros_format, ZONE_CLEARANCE_MIL, ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL, ZONE_THERMAL_RELIEF_GAP_MIL, and ZONE_THICKNESS_MIL.

◆ ~PCBNEW_SETTINGS()

PCBNEW_SETTINGS::~PCBNEW_SETTINGS ( )
virtualdefault

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 675 of file json_settings.cpp.

676 {
677  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
678  m_nested_settings.push_back( aSettings );
679 }
wxString GetFilename() const
Definition: json_settings.h:64
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 262 of file app_settings.cpp.

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

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

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

◆ DefaultGridSizeList()

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

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

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

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

Definition at line 332 of file app_settings.cpp.

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

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

◆ fromLegacy()

template<typename ValueType >
template bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

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

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

Definition at line 587 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

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

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

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

Definition at line 647 of file json_settings.cpp.

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

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 623 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 131 of file json_settings.h.

132  {
133  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
134  {
135  try
136  {
137  return ret->get<ValueType>();
138  }
139  catch( ... )
140  {
141  }
142  }
143 
144  return NULLOPT;
145  }
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(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 705 of file json_settings.cpp.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 281 of file json_settings.h.

282  {
283  return wxT( "json" );
284  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 81 of file json_settings.cpp.

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

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

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

◆ GetJson()

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

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

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

Definition at line 436 of file json_settings.cpp.

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

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

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 286 of file json_settings.h.

287  {
288  return wxEmptyString;
289  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 311 of file pcbnew_settings.h.

311 { return "PcbFrame"; }

Referenced by MigrateFromLegacy().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ IsDefault()

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

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

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

Definition at line 324 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 87 of file json_settings.cpp.

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

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

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

◆ LoadFromFile()

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

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

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

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 104 of file json_settings.cpp.

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

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

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

Returns
true if migration was successful

Definition at line 464 of file json_settings.cpp.

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

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

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 202 of file app_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool PCBNEW_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 509 of file pcbnew_settings.cpp.

510 {
511  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
512 
513  const std::string f = getLegacyFrameName();
514 
515  //
516  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
517  //
518  ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
519 
520  ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
521  ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
522  ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
523  ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
524 
525  ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
526  ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
527  ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
528  ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
529  ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
530  ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
531 
532  ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
533  ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
534  ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
535  ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
536  ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
537  ret &= fromLegacy<int>( aCfg, "PcbDisplayOrigin", "pcb_display.origin_mode" );
538  ret &= fromLegacy<bool>( aCfg, "PcbInvertXAxis", "pcb_display.origin_invert_x_axis" );
539  ret &= fromLegacy<bool>( aCfg, "PcbInvertYAxis", "pcb_display.origin_invert_y_axis" );
540  ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
541  ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
542  ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
543  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
544  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
545  ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
546  ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
547  ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
548  ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
549  ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
550  ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
551 
552  ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
553 
554  aCfg->SetPath( "/dialogs/cleanup_tracks" );
555  ret &= fromLegacy<bool>( aCfg, "DialogCleanupVias", "cleanup.cleanup_vias" );
556  ret &= fromLegacy<bool>( aCfg, "DialogCleanupMergeSegments", "cleanup.merge_segments" );
557  ret &= fromLegacy<bool>( aCfg, "DialogCleanupUnconnected", "cleanup.cleanup_unconnected" );
558  ret &= fromLegacy<bool>( aCfg, "DialogCleanupShortCircuit", "cleanup.cleanup_short_circuits" );
559  ret &= fromLegacy<bool>( aCfg, "DialogCleanupTracksInPads", "cleanup.cleanup_tracks_in_pad" );
560  aCfg->SetPath( "../.." );
561 
562  ret &= fromLegacy<bool>( aCfg, "RefillZonesBeforeDrc", "drc_dialog.refill_zones" );
563  ret &= fromLegacy<bool>( aCfg, "DrcTestFootprints", "drc_dialog.test_footprints" );
564 
565  ret &= fromLegacy<bool>( aCfg, "DrillMergePTHNPTH", "gen_drill.merge_pth_npth" );
566  ret &= fromLegacy<bool>( aCfg, "DrillMinHeader", "gen_drill.minimal_header" );
567  ret &= fromLegacy<bool>( aCfg, "DrillMirrorYOpt", "gen_drill.mirror" );
568  ret &= fromLegacy<bool>( aCfg, "DrillUnit", "gen_drill.unit_drill_is_inch" );
569  ret &= fromLegacy<bool>( aCfg, "OvalHolesRouteMode", "gen_drill.use_route_for_oval_holes" );
570  ret &= fromLegacy<int>( aCfg, "DrillFileType", "gen_drill.drill_file_type" );
571  ret &= fromLegacy<int>( aCfg, "DrillMapFileType", "gen_drill.map_file_type" );
572  ret &= fromLegacy<int>( aCfg, "DrillZerosFormat", "gen_drill.zeros_format" );
573 
574  ret &= fromLegacy<bool>( aCfg, "IDFRefAutoAdj", "export_idf.auto_adjust" );
575  ret &= fromLegacy<int>( aCfg, "IDFRefUnits", "export_idf.ref_units" );
576  ret &= fromLegacy<double>( aCfg, "IDFRefX", "export_idf.ref_x" );
577  ret &= fromLegacy<double>( aCfg, "IDFRefY", "export_idf.ref_y" );
578  ret &= fromLegacy<bool>( aCfg, "IDFExportThou", "export_idf.units_mils" );
579 
580  ret &= fromLegacy<int>( aCfg, "STEP_Origin_Opt", "export_step.origin_mode" );
581  ret &= fromLegacy<int>( aCfg, "STEP_UserOriginUnits", "export_step.origin_units" );
582  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginX", "export_step.origin_x" );
583  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginY", "export_step.origin_y" );
584  ret &= fromLegacy<bool>( aCfg, "STEP_NoVirtual", "export_step.no_virtual" );
585 
586  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeColor", "export_svg.black_and_white" );
587  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeMirror", "export_svg.mirror" );
588  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeOneFile", "export_svg.one_file" );
589  ret &= fromLegacy<bool>( aCfg, "PlotSVGBrdEdge", "export_svg.plot_board_edges" );
590  ret &= fromLegacy<int>( aCfg, "PlotSVGPageOpt", "export_svg.page_size" );
591  ret &= fromLegacyString( aCfg, "PlotSVGDirectory", "export_svg.output_dir" );
592 
593  {
594  nlohmann::json js = nlohmann::json::array();
595  wxString key;
596  bool val = false;
597 
598  for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
599  {
600  key.Printf( wxT( "PlotSVGLayer_%d" ), i );
601 
602  if( aCfg->Read( key, &val ) && val )
603  js.push_back( i );
604  }
605 
606  ( *this )[PointerFromString( "export_svg.layers" ) ] = js;
607  }
608 
609  {
610  nlohmann::json js = nlohmann::json::array();
611 
612  wxString packed;
613 
614  if( aCfg->Read( "ActionPluginButtons", &packed ) )
615  {
616  wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
617 
618  while( pluginSettingsTokenizer.HasMoreTokens() )
619  {
620  nlohmann::json row;
621  wxString plugin = pluginSettingsTokenizer.GetNextToken();
622  wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
623 
624  if( pluginTokenizer.CountTokens() != 2 )
625  {
626  // Bad config
627  continue;
628  }
629 
630  std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
631 
632  js.push_back( nlohmann::json( {
633  { key, pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 } } ) );
634  }
635  }
636 
637  ( *this )[PointerFromString( "action_plugins" ) ] = js;
638  }
639 
640  //
641  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
642  //
643  ret &= fromLegacy<int>( aCfg, "VrmlExportUnit", "export_vrml.units" );
644  ret &= fromLegacy<bool>( aCfg, "VrmlExportCopyFiles", "export_vrml.copy_3d_models" );
645  ret &= fromLegacy<bool>( aCfg, "VrmlUseRelativePaths", "export_vrml.use_relative_paths" );
646  ret &= fromLegacy<bool>( aCfg, "VrmlUsePlainPCB", "export_vrml.use_plain_pcb" );
647  ret &= fromLegacy<int>( aCfg, "VrmlRefUnits", "export_vrml.ref_units" );
648  ret &= fromLegacy<double>( aCfg, "VrmlRefX", "export_vrml.ref_x" );
649  ret &= fromLegacy<double>( aCfg, "VrmlRefY", "export_vrml.ref_y" );
650 
651  ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
652  ret &= fromLegacyString( aCfg, "Zone_Filter_Opt", "zones.net_filter" );
653  ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
654  ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
655  ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
656  ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
657  ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
658 
659  aCfg->SetPath( "ImportGraphics" );
660  ret &= fromLegacy<int>( aCfg, "BoardLayer", "import_graphics.layer" );
661  ret &= fromLegacy<bool>( aCfg, "InteractivePlacement", "import_graphics.interactive_placement" );
662  ret &= fromLegacyString( aCfg, "LastFile", "import_graphics.last_file" );
663  ret &= fromLegacy<double>( aCfg, "LineWidth", "import_graphics.line_width" );
664  ret &= fromLegacy<int>( aCfg, "LineWidthUnits", "import_graphics.line_width_units" );
665  ret &= fromLegacy<int>( aCfg, "PositionUnits", "import_graphics.origin_units" );
666  ret &= fromLegacy<double>( aCfg, "PositionX", "import_graphics.origin_x" );
667  ret &= fromLegacy<double>( aCfg, "PositionY", "import_graphics.origin_y" );
668  aCfg->SetPath( ".." );
669 
670  ret &= fromLegacy<int>( aCfg, "NetlistReportFilterMsg", "netlist.report_filter" );
671  ret &= fromLegacy<bool>( aCfg, "NetlistUpdateFootprints", "netlist.update_footprints" );
672  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteShortingTracks", "netlist.delete_shorting_tracks" );
673  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteExtraFootprints", "netlist.delete_extra_footprints" );
674  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteSinglePadNets", "netlist.delete_single_pad_nets" );
675 
676  ret &= fromLegacy<int>( aCfg, "PlaceFileUnits", "place_file.units" );
677  ret &= fromLegacy<int>( aCfg, "PlaceFileOpts", "place_file.file_options" );
678  ret &= fromLegacy<int>( aCfg, "PlaceFileFormat", "place_file.file_format" );
679  ret &= fromLegacy<bool>( aCfg, "PlaceFileIncludeBrdEdge", "place_file.include_board_edge" );
680 
681  ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.all_layers_on_one_page" );
682  ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
683  ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
684  ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
685  ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
686  ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
687 
688  ret &= fromLegacyString( aCfg, "FootprintTextShownColumns", "window.footprint_text_shown_columns" );
689 
690  ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
691  ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
692 
693  migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
694 
695  ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
696  ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
697 
698  migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
699  ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
700 
701 
702  const std::string p = "pcbnew.InteractiveRouter.";
703 
704  ( *this )[PointerFromString( "tools.pns.meta" )] = nlohmann::json( {
705  { "filename", "pns" },
706  { "version", 0 }
707  } );
708 
709  ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
710  ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
711  ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
712  ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
713  ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
714  ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
715  ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
716  ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
717  ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
718  ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
719  ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
720  ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
721  ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
722  ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
723  ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "tools.pns.inline_drag" );
724 
725  // Initialize some new PNS settings to legacy behaviors if coming from legacy
726  ( *this )[PointerFromString( "tools.pns.fix_all_segments" )] = false;
727 
728  // Migrate color settings that were stored in the pcbnew config file
729 
730  COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetMigratedColorSettings();
731 
732  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
733  wxString str;
734 
735  if( aCfg->Read( aKey, &str ) )
736  cs->SetColor( aLayerId, COLOR4D( str ) );
737  };
738 
739  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
740  {
741  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
742  migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
743  }
744 
745  migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
746  migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
747  migrateLegacyColor( "Color4DGrid", LAYER_GRID );
748  migrateLegacyColor( "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
749  migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
750  migrateLegacyColor( "Color4DPadBackEx", LAYER_PAD_BK );
751  migrateLegacyColor( "Color4DPadFrontEx", LAYER_PAD_FR );
752  migrateLegacyColor( "Color4DPadThruHoleEx", LAYER_PADS_TH );
753  migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
754  migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
755  migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
756  migrateLegacyColor( "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
757  migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
758  migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
759  migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
760  migrateLegacyColor( "Color4DWorksheet", LAYER_DRAWINGSHEET );
761 
762  Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
763 
764  ( *this )[PointerFromString( "appearance.color_theme" )] = cs->GetFilename();
765 
766  double x, y;
767 
768  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
769  {
770  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
771  static_cast<long>( EDA_UNITS::INCHES ) ) );
772 
773  // Convert to internal units
774  x = From_User_Unit( u, x );
775  y = From_User_Unit( u, y );
776 
777  ( *this )[PointerFromString( "window.grid.user_grid_x" )] = StringFromValue( u, x );
778  ( *this )[PointerFromString( "window.grid.user_grid_y" )] = StringFromValue( u, y );
779  }
780 
781  // Footprint editor settings were stored in pcbnew config file. Migrate them here.
782  auto fpedit = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( false );
783  fpedit->MigrateFromLegacy( aCfg );
784  fpedit->Load();
785 
786  // Same with 3D viewer
787  auto viewer3d = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( false );
788  viewer3d->MigrateFromLegacy( aCfg );
789  viewer3d->Load();
790 
791  return ret;
792 }
to draw blind/buried vias
show a marker on pads with no nets
multilayer pads, usually with holes
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
wxString GetFilename() const
Definition: json_settings.h:64
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
nlohmann::json json
Definition: gerbview.cpp:40
PCB_LAYER_ID
A quick note on layer IDs:
Auxiliary items (guides, rule, etc)
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:82
to draw usual through hole vias
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
virtual std::string getLegacyFrameName() const override
EDA_UNITS
Definition: eda_units.h:38
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
smd pads, front layer
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:225
Color settings are a bit different than most of the settings objects in that there can be more than o...
drawingsheet frame and titleblock
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
double From_User_Unit(EDA_UNITS aUnits, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:313
bool migrateWindowConfig(wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
Migrates legacy window settings into the JSON document.
void SetColor(int aLayer, COLOR4D aColor)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References From_User_Unit(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetFilename(), getLegacyFrameName(), INCHES, LAYER_ANCHOR, LAYER_AUX_ITEMS, LAYER_CURSOR, LAYER_DRAWINGSHEET, LAYER_GRID, LAYER_MOD_TEXT_INVISIBLE, LAYER_NO_CONNECTS, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_PCB_BACKGROUND, LAYER_RATSNEST, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateWindowConfig(), LSET::Name(), PCB_LAYER_ID_COUNT, Pgm(), JSON_SETTINGS::PointerFromString(), COLOR_SETTINGS::SetColor(), and StringFromValue().

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

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

◆ PointerFromString()

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

Builds a JSON pointer based on a given string.

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

Definition at line 506 of file json_settings.cpp.

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

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

◆ registerMigration()

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

Registers a migration from one schema version to another.

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

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

Definition at line 455 of file json_settings.cpp.

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

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

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

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 682 of file json_settings.cpp.

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

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

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 317 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

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

c *

Returns
true if the file was saved

Reimplemented in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 336 of file json_settings.cpp.

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

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

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

◆ Set() [1/3]

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

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

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

Definition at line 155 of file json_settings.h.

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

References JSON_SETTINGS::PointerFromString().

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

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 714 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

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

Definition at line 68 of file json_settings.h.

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

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 526 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

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

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 541 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 556 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 571 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 72 of file json_settings.h.

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

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 195 of file json_settings.h.

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

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 75 of file json_settings.h.

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

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 303 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_AddUnlockedPads

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

AUI_PANELS PCBNEW_SETTINGS::m_AuiPanels

Definition at line 237 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::LoadSettings(), and PCBNEW_SETTINGS().

◆ m_Cleanup

DIALOG_CLEANUP PCBNEW_SETTINGS::m_Cleanup

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

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

◆ m_Display

PCB_DISPLAY_OPTIONS PCBNEW_SETTINGS::m_Display

◆ m_DrcDialog

DIALOG_DRC PCBNEW_SETTINGS::m_DrcDialog

Definition at line 241 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_DRC::~DIALOG_DRC().

◆ m_ExportIdf

DIALOG_EXPORT_IDF PCBNEW_SETTINGS::m_ExportIdf

Definition at line 243 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_EXPORT_IDF3::~DIALOG_EXPORT_IDF3().

◆ m_ExportStep

DIALOG_EXPORT_STEP PCBNEW_SETTINGS::m_ExportStep

Definition at line 245 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_EXPORT_STEP::~DIALOG_EXPORT_STEP().

◆ m_ExportSvg

DIALOG_EXPORT_SVG PCBNEW_SETTINGS::m_ExportSvg

Definition at line 247 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG().

◆ m_ExportVrml

DIALOG_EXPORT_VRML PCBNEW_SETTINGS::m_ExportVrml

◆ m_filename

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_FlipLeftRight

◆ m_FootprintChooser

◆ m_FootprintTextShownColumns

wxString PCBNEW_SETTINGS::m_FootprintTextShownColumns

◆ m_FootprintViewer

◆ m_FootprintViewerAutoZoom

bool PCBNEW_SETTINGS::m_FootprintViewerAutoZoom

Should the footprint viewer auto zoom on select.

Definition at line 297 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::GetAutoZoom(), PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SetAutoZoom().

◆ m_FootprintViewerZoom

double PCBNEW_SETTINGS::m_FootprintViewerZoom

The last zoom level in the footprint viewer.

Definition at line 299 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintWizard

WINDOW_SETTINGS PCBNEW_SETTINGS::m_FootprintWizard

Definition at line 271 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS().

◆ m_FootprintWizardList

◆ m_GenDrill

DIALOG_GENERATE_DRILL PCBNEW_SETTINGS::m_GenDrill

Definition at line 253 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_GENDRILL::UpdateConfig().

◆ m_Graphics

◆ m_ImportGraphics

DIALOG_IMPORT_GRAPHICS PCBNEW_SETTINGS::m_ImportGraphics

Definition at line 255 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_IMPORT_GFX::~DIALOG_IMPORT_GFX().

◆ m_lastFootprint3dDir

wxString PCBNEW_SETTINGS::m_lastFootprint3dDir

◆ m_lastFootprintLibDir

wxString PCBNEW_SETTINGS::m_lastFootprintLibDir

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

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

◆ m_LibTree

LIB_TREE APP_SETTINGS_BASE::m_LibTree
inherited

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 298 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_MagneticItems

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 328 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 334 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 304 of file json_settings.h.

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

◆ m_NetlistDialog

DIALOG_NETLIST PCBNEW_SETTINGS::m_NetlistDialog

◆ m_params

◆ m_PlaceFile

DIALOG_PLACE_FILE PCBNEW_SETTINGS::m_PlaceFile

Definition at line 259 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS().

◆ m_Plot

DIALOG_PLOT PCBNEW_SETTINGS::m_Plot

Definition at line 261 of file pcbnew_settings.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_SETTINGS().

◆ m_PnsSettings

std::unique_ptr<PNS::ROUTING_SETTINGS> PCBNEW_SETTINGS::m_PnsSettings

Definition at line 295 of file pcbnew_settings.h.

Referenced by PNS::TOOL_BASE::Reset().

◆ m_PolarCoords

bool PCBNEW_SETTINGS::m_PolarCoords

◆ m_preserved_paths

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

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

Definition at line 331 of file json_settings.h.

◆ m_Printing

◆ m_Reannotate

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_RotationAngle

int PCBNEW_SETTINGS::m_RotationAngle

Definition at line 289 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::LoadSettings(), and PCBNEW_SETTINGS().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_ShowPageLimits

bool PCBNEW_SETTINGS::m_ShowPageLimits

Definition at line 291 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::LoadSettings().

◆ m_System

◆ m_TrackDragAction

◆ m_Use45DegreeGraphicSegments

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

◆ m_Zones


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