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)
 
void SetLocation (SETTINGS_LOC aLocation)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
nlohmann::jsonAt (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally. More...
 
bool Contains (const std::string &aPath) const
 
size_t Count (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static 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_PcbUse45DegreeLimit
 
bool m_FpeditUse45DegreeLimit
 
bool m_FlipLeftRight
 
bool m_PolarCoords
 
int m_RotationAngle
 
bool m_ShowPageLimits
 
bool m_AutoRefillZones
 
bool m_AllowFreePads
 
wxString m_FootprintTextShownColumns
 
std::unique_ptr< PNS::ROUTING_SETTINGSm_PnsSettings
 
double m_FootprintViewerZoom
 The last zoom level used (0 for auto) More...
 
wxString m_lastFootprintLibDir
 
wxString m_lastFootprint3dDir
 
ACTION_PLUGIN_SETTINGS_LIST m_VisibleActionPlugins
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
COLOR_PICKER m_ColorPicker
 
LIB_TREE m_LibTree
 
PRINTING m_Printing
 
SYSTEM m_System
 
WINDOW_SETTINGS m_Window
 
wxString m_ColorTheme
 Active color theme name. More...
 
int m_appSettingsSchemaVersion
 ! Local schema version for common app settings More...
 

Protected Member Functions

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

Protected Attributes

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

Detailed Description

Definition at line 63 of file pcbnew_settings.h.

Constructor & Destructor Documentation

◆ PCBNEW_SETTINGS()

PCBNEW_SETTINGS::PCBNEW_SETTINGS ( )

Definition at line 49 of file pcbnew_settings.cpp.

51  m_AuiPanels(),
52  m_Cleanup(),
53  m_DrcDialog(),
54  m_ExportIdf(),
55  m_ExportStep(),
56  m_ExportSvg(),
57  m_ExportVrml(),
59  m_GenDrill(),
62  m_PlaceFile(),
63  m_Plot(),
65  m_Zones(),
68  m_Display(),
70  m_PcbUse45DegreeLimit( false ),
71  m_FpeditUse45DegreeLimit( false ),
72  m_FlipLeftRight( false ),
73  m_PolarCoords( false ),
74  m_RotationAngle( 900 ),
75  m_ShowPageLimits( true ),
76  m_AutoRefillZones( true ),
77  m_AllowFreePads( false ),
78  m_PnsSettings( nullptr ),
80 {
83  m_MagneticItems.graphics = false;
84 
85  m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
87 
88  m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
90 
91  m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
92  &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
93 
94  m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
95  &m_FootprintChooser.width, -1 ) );
96 
97  m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
98  &m_FootprintChooser.height, -1 ) );
99 
100  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
101  &m_FootprintChooser.sash_h, -1 ) );
102 
103  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
104  &m_FootprintChooser.sash_v, -1 ) );
105 
106  m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
107  &m_FlipLeftRight, true ) );
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.pcb_use_45_degree_limit",
128  &m_PcbUse45DegreeLimit, false ) );
129 
130  m_params.emplace_back( new PARAM<bool>( "editing.fp_use_45_degree_limit",
131  &m_FpeditUse45DegreeLimit, false ) );
132 
133  m_params.emplace_back( new PARAM<bool>( "editing.auto_fill_zones",
134  &m_AutoRefillZones, true ) );
135 
136  m_params.emplace_back( new PARAM<bool>( "editing.allow_free_pads",
137  &m_AllowFreePads, false ) );
138 
139  m_params.emplace_back( new PARAM<int>( "editing.rotation_angle",
140  &m_RotationAngle, 900, 1, 900 ) );
141 
142  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
143  &m_Display.m_DisplayGraphicsFill, true ) );
144 
145  m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
146  &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
147 
148  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
149  &m_Display.m_DisplayGraphicsFill, true ) );
150 
151  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
152  &m_Display.m_DisplayTextFill, true ) );
153 
154  m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
155  &m_Display.m_DisplayNetNamesMode, 3, 0, 3 ) );
156 
157  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
158  &m_Display.m_DisplayPadClearance, true ) );
159 
160  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_no_connects",
162 
163  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
164  &m_Display.m_DisplayPadFill, true ) );
165 
166  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
167  &m_Display.m_DisplayPadNum, true ) );
168 
169  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
170  &m_Display.m_ShowGlobalRatsnest, true ) );
171 
172  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
173  &m_Display.m_ShowModuleRatsnest, true ) );
174 
175  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
177 
178  m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
179  reinterpret_cast<int*>( &m_Display.m_ShowTrackClearanceMode ),
181 
182  m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
183  &m_Display.m_DisplayPcbTrackFill, true ) );
184 
185  m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
186  &m_Display.m_DisplayViaFill, true ) );
187 
188  m_params.emplace_back( new PARAM_ENUM<ZONE_DISPLAY_MODE>( "pcb_display.zone_mode",
191 
192  m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
193  reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
195 
196  m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
197  &m_Display.m_DisplayInvertXAxis, false ) );
198 
199  m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
200  &m_Display.m_DisplayInvertYAxis, false ) );
201 
202  m_params.emplace_back( new PARAM<bool>( "pcb_display.live_3d_refresh",
203  &m_Display.m_Live3DRefresh, false ) );
204 
205  m_params.emplace_back( new PARAM<bool>( "pcb_display.show_page_borders",
206  &m_ShowPageLimits, true ) );
207 
208  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
209  &m_Cleanup.cleanup_vias, true ) );
210 
211  m_params.emplace_back( new PARAM<bool>( "cleanup.delete_dangling_vias",
212  &m_Cleanup.delete_dangling_vias, true ) );
213 
214  m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
215  &m_Cleanup.merge_segments, true ) );
216 
217  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
218  &m_Cleanup.cleanup_unconnected, true ) );
219 
220  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
222 
223  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
224  &m_Cleanup.cleanup_tracks_in_pad, false ) );
225 
226  m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
227  &m_DrcDialog.refill_zones, true ) );
228 
229  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_all_track_errors",
231 
232  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
233  &m_DrcDialog.test_footprints, false ) );
234 
235  m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
237 
238  m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
239  &m_GenDrill.merge_pth_npth, false ) );
240 
241  m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
242  &m_GenDrill.minimal_header, false ) );
243 
244  m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror",
245  &m_GenDrill.mirror, false ) );
246 
247  m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
248  &m_GenDrill.unit_drill_is_inch, true ) );
249 
250  m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
252 
253  m_params.emplace_back( new PARAM<int>( "gen_drill.drill_file_type",
254  &m_GenDrill.drill_file_type, 0 ) );
255 
256  m_params.emplace_back( new PARAM<int>( "gen_drill.map_file_type",
257  &m_GenDrill.map_file_type, 1 ) );
258 
259  m_params.emplace_back( new PARAM<int>( "gen_drill.zeros_format",
260  &m_GenDrill.zeros_format, 0, 0, 3 ) );
261 
262  m_params.emplace_back( new PARAM<bool>( "export_idf.auto_adjust",
263  &m_ExportIdf.auto_adjust, false ) );
264 
265  m_params.emplace_back( new PARAM<int>( "export_idf.ref_units",
266  &m_ExportIdf.ref_units, 0 ) );
267 
268  m_params.emplace_back( new PARAM<double>( "export_idf.ref_x",
269  &m_ExportIdf.ref_x, 0 ) );
270 
271  m_params.emplace_back( new PARAM<double>( "export_idf.ref_y",
272  &m_ExportIdf.ref_y, 0 ) );
273 
274  m_params.emplace_back( new PARAM<bool>( "export_idf.units_mils",
275  &m_ExportIdf.units_mils, false ) );
276 
277  m_params.emplace_back( new PARAM<int>( "export_step.origin_mode",
278  &m_ExportStep.origin_mode, 0 ) );
279 
280  m_params.emplace_back( new PARAM<int>( "export_step.origin_units",
281  &m_ExportStep.origin_units, 0 ) );
282 
283  m_params.emplace_back( new PARAM<double>( "export_step.origin_x",
284  &m_ExportStep.origin_x, 0 ) );
285 
286  m_params.emplace_back( new PARAM<double>( "export_step.origin_y",
287  &m_ExportStep.origin_y, 0 ) );
288 
289  m_params.emplace_back( new PARAM<bool>( "export_step.no_virtual",
290  &m_ExportStep.no_virtual, false ) );
291 
292  m_params.emplace_back( new PARAM<bool>( "export_step.replace_models",
293  &m_ExportStep.replace_models, false ) );
294 
295  m_params.emplace_back( new PARAM<bool>( "export_step.overwrite_file",
296  &m_ExportStep.overwrite_file, true ) );
297 
298  m_params.emplace_back( new PARAM<bool>( "export_svg.black_and_white",
299  &m_ExportSvg.black_and_white, false ) );
300 
301  m_params.emplace_back( new PARAM<bool>( "export_svg.mirror",
302  &m_ExportSvg.mirror, false ) );
303 
304  m_params.emplace_back( new PARAM<bool>( "export_svg.one_file",
305  &m_ExportSvg.one_file, false ) );
306 
307  m_params.emplace_back(new PARAM<bool>( "export_svg.plot_board_edges",
308  &m_ExportSvg.plot_board_edges, true ) );
309 
310  m_params.emplace_back( new PARAM<int>( "export_svg.page_size",
311  &m_ExportSvg.page_size, 0 ) );
312 
313  m_params.emplace_back( new PARAM<wxString>( "export_svg.output_dir",
314  &m_ExportSvg.output_dir, "" ) );
315 
316  m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers",
317  &m_ExportSvg.layers, {} ) );
318 
319  m_params.emplace_back( new PARAM<int>( "export_vrml.units",
320  &m_ExportVrml.units, 1 ) );
321 
322  m_params.emplace_back( new PARAM<bool>( "export_vrml.copy_3d_models",
323  &m_ExportVrml.copy_3d_models, false ) );
324 
325  m_params.emplace_back( new PARAM<bool>( "export_vrml.use_relative_paths",
326  &m_ExportVrml.use_relative_paths, false ) );
327 
328  m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units",
329  &m_ExportVrml.ref_units, 0 ) );
330 
331  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x",
332  &m_ExportVrml.ref_x, 0 ) );
333 
334  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y",
335  &m_ExportVrml.ref_y, 0 ) );
336 
337  m_params.emplace_back( new PARAM<int>( "export_vrml.origin_mode",
338  &m_ExportVrml.origin_mode, 0 ) );
339 
340  m_params.emplace_back( new PARAM<int>( "zones.hatching_style",
341  &m_Zones.hatching_style, 0 ) );
342 
343  m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode",
344  &m_Zones.net_sort_mode, -1 ) );
345 
346  m_params.emplace_back( new PARAM<double>( "zones.clearance",
348 
349  m_params.emplace_back( new PARAM<double>( "zones.min_thickness",
351 
352  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_gap",
354 
355  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_copper_width",
357 
358  m_params.emplace_back( new PARAM<int>( "import_graphics.layer",
360 
361  m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
363 
364  m_params.emplace_back( new PARAM<int>( "import_graphics.line_width_units",
366 
367  m_params.emplace_back( new PARAM<double>( "import_graphics.line_width",
368  &m_ImportGraphics.line_width, 0.2 ) );
369 
370  m_params.emplace_back( new PARAM<int>( "import_graphics.origin_units",
372 
373  m_params.emplace_back( new PARAM<double>( "import_graphics.origin_x",
374  &m_ImportGraphics.origin_x, 0 ) );
375 
376  m_params.emplace_back( new PARAM<double>( "import_graphics.origin_y",
377  &m_ImportGraphics.origin_y, 0 ) );
378 
379  m_params.emplace_back( new PARAM<int>( "import_graphics.dxf_units",
380  &m_ImportGraphics.dxf_units, 0 ) );
381 
382  m_params.emplace_back( new PARAM<int>( "netlist.report_filter",
384 
385  m_params.emplace_back( new PARAM<bool>( "netlist.update_footprints",
387 
388  m_params.emplace_back( new PARAM<bool>( "netlist.delete_shorting_tracks",
390 
391  m_params.emplace_back( new PARAM<bool>( "netlist.delete_extra_footprints",
393 
394  m_params.emplace_back( new PARAM<bool>( "netlist.associate_by_ref_sch",
396 
397  m_params.emplace_back(new PARAM<int>( "place_file.units",
398  &m_PlaceFile.units, 1 ) );
399 
400  m_params.emplace_back( new PARAM<int>( "place_file.file_options",
401  &m_PlaceFile.file_options, 0 ) );
402 
403  m_params.emplace_back( new PARAM<int>( "place_file.file_format",
404  &m_PlaceFile.file_format, 0 ) );
405 
406  m_params.emplace_back( new PARAM<bool>( "place_file.include_board_edge",
407  &m_PlaceFile.include_board_edge, false ) );
408 
409  m_params.emplace_back( new PARAM<bool>( "place_file.use_place_file_origin",
410  &m_PlaceFile.use_aux_origin, true ) );
411 
412  m_params.emplace_back( new PARAM<int>( "plot.all_layers_on_one_page",
414 
415  m_params.emplace_back( new PARAM<bool>( "plot.edgecut_on_all_layers",
416  &m_Plot.edgecut_on_all_layers, true ) );
417 
418  m_params.emplace_back( new PARAM<int>( "plot.pads_drill_mode",
419  &m_Plot.pads_drill_mode, 2 ) );
420 
421  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x",
422  &m_Plot.fine_scale_x, 0 ) );
423 
424  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y",
425  &m_Plot.fine_scale_y, 0 ) );
426 
427  m_params.emplace_back( new PARAM<double>( "plot.ps_fine_width_adjust",
429 
430  m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
432 
433  m_params.emplace_back( new PARAM<bool>( "plot.mirror",
434  &m_Plot.mirror, false ) );
435 
436  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
437  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
438 
439  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.width",
440  &m_FootprintWizardList.width, -1 ) );
441 
442  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
443  &m_FootprintWizardList.height, -1 ) );
444 
445  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_sort_on_modules",
447  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_front_prefix",
448  &m_Reannotate.remove_front_prefix, false ) );
449  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_back_prefix",
450  &m_Reannotate.remove_back_prefix, false ) );
451  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_exclude_locked",
452  &m_Reannotate.exclude_locked, false ) );
453 
454  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_grid_index",
455  &m_Reannotate.grid_index, 0 ) );
456  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_sort_code",
457  &m_Reannotate.sort_code, 0 ) );
458  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_choice",
460  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_report_severity",
462 
463  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_refdes_start",
465  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_refdes_start",
467  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_prefix",
468  &m_Reannotate.front_prefix, "" ) );
469  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_prefix",
470  &m_Reannotate.back_prefix, "" ) );
471  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_exclude_list",
472  &m_Reannotate.exclude_list, "" ) );
473  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_report_file_name",
475 
476  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
477  [&]() -> nlohmann::json
478  {
479  nlohmann::json js = nlohmann::json::array();
480 
481  for( const auto& pair : m_VisibleActionPlugins )
482  js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
483 
484  return js;
485  },
486  [&]( const nlohmann::json& aObj )
487  {
488  m_VisibleActionPlugins.clear();
489 
490  if( !aObj.is_array() )
491  {
492  return;
493  }
494 
495  for( const auto& entry : aObj )
496  {
497  if( entry.empty() || !entry.is_object() )
498  continue;
499 
500  for( const auto& pair : entry.items() )
501  {
502  m_VisibleActionPlugins.emplace_back( std::make_pair(
503  wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
504  }
505  }
506  },
507  nlohmann::json::array() ) );
508 
509  addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
510 
511  m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
512  &m_FootprintViewerZoom, 1.0 ) );
513 
514  addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
515 
516  m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
517  &m_lastFootprintLibDir, "" ) );
518 
519  m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
520  &m_lastFootprint3dDir, "" ) );
521 
522  registerMigration( 0, 1,
523  [&]()
524  {
525  if( OPT<int> optval = Get<int>( "pcb_display.rotation_angle" ) )
526  Set( "editing.rotation_angle", optval.get() );
527 
528  try
529  {
530  At( "pcb_display" ).erase( "rotation_angle" );
531  }
532  catch( ... )
533  {}
534 
535  return true;
536  } );
537 
538 }
DIALOG_GENERATE_DRILL m_GenDrill
void addParamsForWindow(WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
Adds parameters for the given window object.
DIALOG_EXPORT_STEP m_ExportStep
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
DIALOG_CLEANUP m_Cleanup
DIALOG_EXPORT_IDF m_ExportIdf
Stores an enum as an integer.
Definition: parameters.h:215
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 used (0 for auto)
wxString m_FootprintTextShownColumns
DIALOG_EXPORT_VRML m_ExportVrml
nlohmann::json json
Definition: gerbview.cpp:41
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
FOOTPRINT_CHOOSER m_FootprintChooser
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
How trace clearances are displayed.
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList
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
ACTION_PLUGIN_SETTINGS_LIST m_VisibleActionPlugins
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
bool m_Live3DRefresh
If true, 3D viewer will redraw on every modification operation.
MAGNETIC_OPTIONS pads
ZONE_DISPLAY_MODE m_ZoneDisplayMode
AUI_PANELS m_AuiPanels
DIALOG_PLOT m_Plot
DIALOG_REANNOTATE m_Reannotate
boost::optional< T > OPT
Definition: optional.h:7
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
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, JSON_SETTINGS::At(), 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, DRAG, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::drill_file_type, Dwgs_User, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::dxf_units, PCBNEW_SETTINGS::DIALOG_PLOT::edgecut_on_all_layers, 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_AllowFreePads, m_AuiPanels, m_AutoRefillZones, 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_DisplayPadClearance, PCB_DISPLAY_OPTIONS::m_DisplayPadFill, PCB_DISPLAY_OPTIONS::m_DisplayPadNoConnects, 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_FootprintViewerZoom, m_FootprintWizard, m_FootprintWizardList, m_FpeditUse45DegreeLimit, m_GenDrill, m_ImportGraphics, m_lastFootprint3dDir, m_lastFootprintLibDir, PCB_DISPLAY_OPTIONS::m_Live3DRefresh, m_MagneticItems, PCB_DISPLAY_OPTIONS::m_MaxLinksShowed, m_NetlistDialog, JSON_SETTINGS::m_params, m_PcbUse45DegreeLimit, m_PlaceFile, m_Plot, m_PolarCoords, m_Reannotate, m_RotationAngle, PCB_DISPLAY_OPTIONS::m_ShowGlobalRatsnest, PCB_DISPLAY_OPTIONS::m_ShowModuleRatsnest, m_ShowPageLimits, PCB_DISPLAY_OPTIONS::m_ShowTrackClearanceMode, m_TrackDragAction, m_VisibleActionPlugins, 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_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_VRML::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, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::overwrite_file, 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, JSON_SETTINGS::registerMigration(), PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_front_prefix, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::replace_models, 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, JSON_SETTINGS::Set(), PCBNEW_SETTINGS::DIALOG_DRC::severities, SHOW_FILLED, PCBNEW_SETTINGS::AUI_PANELS::show_layer_manager, PCB_DISPLAY_OPTIONS::SHOW_TRACK_CLEARANCE_WITH_VIA_WHILE_ROUTING, SHOW_TRIANGULATION, 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_PLACE_FILE::use_aux_origin, 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 743 of file json_settings.cpp.

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

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

Referenced by NESTED_SETTINGS::SetParent().

◆ addParamsForWindow()

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

Adds parameters for the given window object.

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

Definition at line 269 of file app_settings.cpp.

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

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

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

◆ At()

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

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

Definition at line 111 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ Contains()

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

Definition at line 117 of file json_settings.cpp.

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

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

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

◆ Count()

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

Definition at line 123 of file json_settings.cpp.

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

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

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().

◆ DefaultGridSizeList()

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

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

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

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

Definition at line 344 of file app_settings.cpp.

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

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

◆ fromLegacy()

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

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

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

Definition at line 655 of file json_settings.cpp.

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

◆ fromLegacyColor()

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

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

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

Definition at line 715 of file json_settings.cpp.

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

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 691 of file json_settings.cpp.

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

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

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 494 of file json_settings.cpp.

495 {
496  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
497  {
498  try
499  {
500  return ret->get<ValueType>();
501  }
502  catch( ... )
503  {
504  }
505  }
506 
507  return NULLOPT;
508 }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ Get() [2/2]

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

Definition at line 773 of file json_settings.cpp.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 270 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

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

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

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

◆ GetJson()

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

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

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

Definition at line 474 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 275 of file json_settings.h.

276  {
277  return wxEmptyString;
278  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 312 of file pcbnew_settings.h.

312 { return "PcbFrame"; }

Referenced by MigrateFromLegacy().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 79 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 129 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 135 of file json_settings.cpp.

136 {
137  for( auto param : m_params )
138  {
139  try
140  {
141  param->Load( this, m_resetParamsIfMissing );
142  }
143  catch( ... )
144  {
145  // Skip unreadable parameters in file
146  wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
147  }
148  }
149 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

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

◆ LoadFromFile()

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

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

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

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 152 of file json_settings.cpp.

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

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

Referenced by SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

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

Returns
true if migration was successful

Definition at line 552 of file json_settings.cpp.

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

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

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 209 of file app_settings.cpp.

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

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

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

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

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_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::Set(), 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 233 of file app_settings.cpp.

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

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

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

◆ registerMigration()

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

Registers a migration from one schema version to another.

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

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

Definition at line 543 of file json_settings.cpp.

545 {
546  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
547  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
548  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
549 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 750 of file json_settings.cpp.

751 {
752  if( !aSettings )
753  return;
754 
755  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
756  [&aSettings]( const JSON_SETTINGS* aPtr ) {
757  return aPtr == aSettings;
758  } );
759 
760  if( it != m_nested_settings.end() )
761  {
762  wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
763  ( *it )->SaveToFile();
764  m_nested_settings.erase( it );
765  }
766 
767  aSettings->SetParent( nullptr );
768 }
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 367 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

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

c *

Returns
true if the file was saved

Reimplemented in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 374 of file json_settings.cpp.

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

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

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

◆ Set() [1/3]

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

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

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

Definition at line 524 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 782 of file json_settings.cpp.

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

◆ SetFilename()

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

Definition at line 76 of file json_settings.h.

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

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 594 of file json_settings.cpp.

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

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 609 of file json_settings.cpp.

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

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 624 of file json_settings.cpp.

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

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 639 of file json_settings.cpp.

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

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 81 of file json_settings.h.

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

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 78 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192  {
193  m_manager = aManager;
194  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document was updated

Definition at line 353 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_AllowFreePads

◆ 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

◆ m_AutoRefillZones

bool PCBNEW_SETTINGS::m_AutoRefillZones

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

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 296 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 308 of file json_settings.h.

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

◆ m_Display

PCB_DISPLAY_OPTIONS PCBNEW_SETTINGS::m_Display

◆ m_DrcDialog

DIALOG_DRC PCBNEW_SETTINGS::m_DrcDialog

Definition at line 240 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 242 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 244 of file pcbnew_settings.h.

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

◆ m_ExportSvg

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

double PCBNEW_SETTINGS::m_FootprintViewerZoom

The last zoom level used (0 for auto)

Definition at line 302 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 270 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS().

◆ m_FootprintWizardList

◆ m_FpeditUse45DegreeLimit

◆ m_GenDrill

DIALOG_GENERATE_DRILL PCBNEW_SETTINGS::m_GenDrill

Definition at line 252 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 254 of file pcbnew_settings.h.

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

◆ m_internals

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

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

◆ m_LibTree

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 287 of file json_settings.h.

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

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

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

◆ m_migrators

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

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

Definition at line 320 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 293 of file json_settings.h.

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

◆ m_NetlistDialog

◆ m_params

◆ m_PcbUse45DegreeLimit

◆ m_PlaceFile

DIALOG_PLACE_FILE PCBNEW_SETTINGS::m_PlaceFile

◆ m_Plot

DIALOG_PLOT PCBNEW_SETTINGS::m_Plot

Definition at line 260 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 300 of file pcbnew_settings.h.

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

◆ m_PolarCoords

bool PCBNEW_SETTINGS::m_PolarCoords

◆ 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 311 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 287 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
Todo:
Implement real auto zone filling (not just after zone properties are edited)

Definition at line 289 of file pcbnew_settings.h.

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

◆ m_System

◆ m_TrackDragAction

◆ m_VisibleActionPlugins

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

◆ m_Zones


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