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  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...
 
std::string GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const std::string &aFilename)
 
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 std::string &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
virtual bool SaveToFile (const std::string &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)
 
virtual bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 

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
 
FOOTPRINT_CHOOSER m_FootprintChooser
 
ZONES m_Zones
 
WINDOW_SETTINGS m_FootprintViewer
 
WINDOW_SETTINGS m_FootprintWizard
 
PCB_DISPLAY_OPTIONS m_Display
 
MAGNETIC_SETTINGS m_MagneticItems
 
TRACK_DRAG_ACTION m_TrackDragAction
 
bool m_Use45DegreeGraphicSegments
 
bool m_FlipLeftRight
 
bool m_PolarCoords
 
int m_RotationAngle
 
double m_PlotLineWidth
 
bool m_ShowPageLimits
 
wxString m_FootprintTextShownColumns
 
std::unique_ptr< PNS::ROUTING_SETTINGSm_PnsSettings
 
bool m_FootprintViewerAutoZoom
 Should the footprint viewer auto zoom on select. More...
 
double m_FootprintViewerZoom
 The last zoom level in the footprint viewer. More...
 
CROSS_PROBING_SETTINGS m_CrossProbing
 
FIND_REPLACE m_FindReplace
 
GRAPHICS m_Graphics
 
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...
 
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

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

Detailed Description

Definition at line 65 of file pcbnew_settings.h.

Constructor & Destructor Documentation

◆ PCBNEW_SETTINGS()

PCBNEW_SETTINGS::PCBNEW_SETTINGS ( )

Definition at line 47 of file pcbnew_settings.cpp.

49  m_AuiPanels(),
50  m_Cleanup(),
51  m_DrcDialog(),
52  m_ExportIdf(),
53  m_ExportStep(),
54  m_ExportSvg(),
55  m_ExportVrml(),
57  m_GenDrill(),
60  m_PlaceFile(),
61  m_Plot(),
63  m_Zones(),
66  m_Display(),
68  m_FlipLeftRight( false ),
69  m_PolarCoords( false ),
70  m_RotationAngle( 900 ),
71  m_PlotLineWidth( 0.1 ),
72  m_ShowPageLimits( true ),
73  m_PnsSettings( nullptr ),
76 {
79  m_MagneticItems.graphics = false;
80 
81  m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
83 
84  m_params.emplace_back( new PARAM<bool>( "aui.show_microwave_tools",
86 
87  m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
88  &m_FootprintChooser.width, -1 ) );
89 
90  m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
91  &m_FootprintChooser.height, -1 ) );
92 
93  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
94  &m_FootprintChooser.sash_h, -1 ) );
95 
96  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
97  &m_FootprintChooser.sash_v, -1 ) );
98 
99  m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right", &m_FlipLeftRight, true ) );
100 
101  m_params.emplace_back(
102  new PARAM<bool>( "editing.magnetic_graphics", &m_MagneticItems.graphics, true ) );
103 
104  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
105  reinterpret_cast<int*>( &m_MagneticItems.pads ),
106  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
107 
108  m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
109  reinterpret_cast<int*>( &m_MagneticItems.tracks ),
110  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
111 
112  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords", &m_PolarCoords, false ) );
113 
114  m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
115  reinterpret_cast<int*>( &m_TrackDragAction ),
116  static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
117 
118  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
119  &m_Use45DegreeGraphicSegments, false ) );
120 
121  m_params.emplace_back( new PARAM<bool>(
122  "pcb_display.graphic_items_fill", &m_Display.m_DisplayGraphicsFill, true ) );
123 
124  m_params.emplace_back( new PARAM<int>(
125  "pcb_display.max_links_shown", &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
126 
127  m_params.emplace_back( new PARAM<bool>(
128  "pcb_display.graphics_fill", &m_Display.m_DisplayGraphicsFill, true ) );
129 
130  m_params.emplace_back( new PARAM<bool>(
131  "pcb_display.text_fill", &m_Display.m_DisplayTextFill, true ) );
132 
133  m_params.emplace_back( new PARAM<int>(
134  "pcb_display.net_names_mode", &m_Display.m_DisplayNetNamesMode, 3, 0, 3 ) );
135 
136  m_params.emplace_back(
137  new PARAM<bool>( "pcb_display.pad_clearance", &m_Display.m_DisplayPadIsol, true ) );
138 
139  m_params.emplace_back(
140  new PARAM<bool>( "pcb_display.pad_fill", &m_Display.m_DisplayPadFill, true ) );
141 
142  m_params.emplace_back(
143  new PARAM<bool>( "pcb_display.pad_numbers", &m_Display.m_DisplayPadNum, true ) );
144 
145  m_params.emplace_back( new PARAM<bool>(
146  "pcb_display.ratsnest_global", &m_Display.m_ShowGlobalRatsnest, true ) );
147 
148  m_params.emplace_back( new PARAM<bool>(
149  "pcb_display.ratsnest_footprint", &m_Display.m_ShowModuleRatsnest, true ) );
150 
151  m_params.emplace_back( new PARAM<bool>(
152  "pcb_display.ratsnest_curved", &m_Display.m_DisplayRatsnestLinesCurved, false ) );
153 
154  m_params.emplace_back( new PARAM<int>(
155  "pcb_display.rotation_angle", &m_RotationAngle, 900, 1, 900 ) );
156 
157  m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
158  reinterpret_cast<int*>( &m_Display.m_ShowTrackClearanceMode ),
160 
161  m_params.emplace_back(
162  new PARAM<bool>( "pcb_display.track_fill", &m_Display.m_DisplayPcbTrackFill, true ) );
163 
164  m_params.emplace_back(
165  new PARAM<bool>( "pcb_display.via_fill", &m_Display.m_DisplayViaFill, true ) );
166 
167  m_params.emplace_back(
168  new PARAM<int>( "pcb_display.zone_mode", &m_Display.m_DisplayZonesMode, 0, 0, 2 ) );
169 
170  m_params.emplace_back(
171  new PARAM<double>( "plot.line_width", &m_PlotLineWidth, 0.1, 0.01, 5.0 ) );
172 
173  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
174  &m_Cleanup.cleanup_vias, true ) );
175 
176  m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
177  &m_Cleanup.merge_segments, true ) );
178 
179  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
180  &m_Cleanup.cleanup_unconnected, true ) );
181 
182  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
184 
185  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
186  &m_Cleanup.cleanup_tracks_in_pad, true ) );
187 
188  m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
189  &m_DrcDialog.refill_zones, false ) );
190 
191  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_track_to_zone",
192  &m_DrcDialog.test_track_to_zone, false ) );
193 
194  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
195  &m_DrcDialog.test_footprints, false ) );
196 
197  m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
199 
200  m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
201  &m_GenDrill.merge_pth_npth, false ) );
202 
203  m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
204  &m_GenDrill.minimal_header, false ) );
205 
206  m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror", &m_GenDrill.mirror, false ) );
207 
208  m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
209  &m_GenDrill.unit_drill_is_inch, true ) );
210 
211  m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
213 
214  m_params.emplace_back( new PARAM<int>(
215  "gen_drill.drill_file_type", &m_GenDrill.drill_file_type, 0 ) );
216 
217  m_params.emplace_back( new PARAM<int>(
218  "gen_drill.map_file_type", &m_GenDrill.map_file_type, 1 ) );
219 
220  m_params.emplace_back( new PARAM<int>(
221  "gen_drill.zeros_format", &m_GenDrill.zeros_format, 0, 0, 3 ) );
222 
223  m_params.emplace_back(
224  new PARAM<bool>( "export_idf.auto_adjust", &m_ExportIdf.auto_adjust, false ) );
225 
226  m_params.emplace_back( new PARAM<int>( "export_idf.ref_units", &m_ExportIdf.ref_units, 0 ) );
227 
228  m_params.emplace_back( new PARAM<double>( "export_idf.ref_x", &m_ExportIdf.ref_x, 0 ) );
229 
230  m_params.emplace_back( new PARAM<double>( "export_idf.ref_y", &m_ExportIdf.ref_y, 0 ) );
231 
232  m_params.emplace_back(
233  new PARAM<bool>( "export_idf.units_mils", &m_ExportIdf.units_mils, false ) );
234 
235  m_params.emplace_back(
236  new PARAM<int>( "export_step.origin_mode", &m_ExportStep.origin_mode, 0 ) );
237 
238  m_params.emplace_back(
239  new PARAM<int>( "export_step.origin_units", &m_ExportStep.origin_units, 0 ) );
240 
241  m_params.emplace_back( new PARAM<double>( "export_step.origin_x", &m_ExportStep.origin_x, 0 ) );
242 
243  m_params.emplace_back( new PARAM<double>( "export_step.origin_y", &m_ExportStep.origin_y, 0 ) );
244 
245  m_params.emplace_back(
246  new PARAM<bool>( "export_step.no_virtual", &m_ExportStep.no_virtual, false ) );
247 
248  m_params.emplace_back(
249  new PARAM<bool>( "export_svg.black_and_white", &m_ExportSvg.black_and_white, false ) );
250 
251  m_params.emplace_back(
252  new PARAM<bool>( "export_svg.mirror", &m_ExportSvg.mirror, false ) );
253 
254  m_params.emplace_back( new PARAM<bool>( "export_svg.one_file", &m_ExportSvg.one_file, false ) );
255 
256  m_params.emplace_back(new PARAM<bool>(
257  "export_svg.plot_board_edges", &m_ExportSvg.plot_board_edges, true ) );
258 
259  m_params.emplace_back( new PARAM<int>( "export_svg.page_size", &m_ExportSvg.page_size, 0 ) );
260 
261  m_params.emplace_back(
262  new PARAM<wxString>( "export_svg.output_dir", &m_ExportSvg.output_dir, "" ) );
263 
264  m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers", &m_ExportSvg.layers, {} ) );
265 
266  m_params.emplace_back( new PARAM<int>( "export_vrml.units", &m_ExportVrml.units, 1 ) );
267 
268  m_params.emplace_back( new PARAM<bool>(
269  "export_vrml.copy_3d_models", &m_ExportVrml.copy_3d_models, false ) );
270 
271  m_params.emplace_back( new PARAM<bool>(
272  "export_vrml.use_relative_paths", &m_ExportVrml.use_relative_paths, false ) );
273 
274  m_params.emplace_back( new PARAM<bool>(
275  "export_vrml.use_plain_pcb", &m_ExportVrml.use_plain_pcb, false ) );
276 
277  m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units", &m_ExportVrml.ref_units, 0 ) );
278 
279  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x", &m_ExportVrml.ref_x, 0 ) );
280 
281  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y", &m_ExportVrml.ref_y, 0 ) );
282 
283  m_params.emplace_back( new PARAM<int>( "zones.hatching_style", &m_Zones.hatching_style, 0 ) );
284 
285  m_params.emplace_back( new PARAM<wxString>( "zones.net_filter", &m_Zones.net_filter, "" ) );
286 
287  m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode", &m_Zones.net_sort_mode, 1 ) );
288 
289  m_params.emplace_back(
290  new PARAM<double>( "zones.clearance", &m_Zones.clearance, ZONE_CLEARANCE_MIL ) );
291 
292  m_params.emplace_back( new PARAM<double>( "zones.min_thickness",
294 
295  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_gap",
297 
298  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_copper_width",
300 
301  m_params.emplace_back(
302  new PARAM<int>( "import_graphics.layer", &m_ImportGraphics.layer, Dwgs_User ) );
303 
304  m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
306 
307  m_params.emplace_back( new PARAM<int>(
308  "import_graphics.line_width_units", &m_ImportGraphics.line_width_units, 0 ) );
309 
310  m_params.emplace_back(
311  new PARAM<double>( "import_graphics.line_width", &m_ImportGraphics.line_width, 0.2 ) );
312 
313  m_params.emplace_back(
314  new PARAM<int>( "import_graphics.origin_units", &m_ImportGraphics.origin_units, 0 ) );
315 
316  m_params.emplace_back(
317  new PARAM<double>( "import_graphics.origin_x", &m_ImportGraphics.origin_x, 0 ) );
318 
319  m_params.emplace_back(
320  new PARAM<double>( "import_graphics.origin_y", &m_ImportGraphics.origin_y, 0 ) );
321 
322  m_params.emplace_back(
323  new PARAM<int>( "netlist.report_filter", &m_NetlistDialog.report_filter, -1 ) );
324 
325  m_params.emplace_back( new PARAM<bool>(
326  "netlist.update_footprints", &m_NetlistDialog.update_footprints, true ) );
327 
328  m_params.emplace_back( new PARAM<bool>(
329  "netlist.delete_shorting_tracks", &m_NetlistDialog.delete_shorting_tracks, false ) );
330 
331  m_params.emplace_back( new PARAM<bool>(
332  "netlist.delete_extra_footprints", &m_NetlistDialog.delete_extra_footprints, false ) );
333 
334  m_params.emplace_back( new PARAM<bool>(
335  "netlist.delete_single_pad_nets", &m_NetlistDialog.delete_single_pad_nets, false ) );
336 
337  m_params.emplace_back( new PARAM<bool>(
338  "netlist.associate_by_ref_sch", &m_NetlistDialog.associate_by_ref_sch, false ) );
339 
340  m_params.emplace_back(new PARAM<int>( "place_file.units", &m_PlaceFile.units, 1 ) );
341 
342  m_params.emplace_back(
343  new PARAM<int>( "place_file.file_options", &m_PlaceFile.file_options, 0 ) );
344 
345  m_params.emplace_back(
346  new PARAM<int>( "place_file.file_format", &m_PlaceFile.file_format, 0 ) );
347 
348  m_params.emplace_back( new PARAM<bool>(
349  "place_file.include_board_edge", &m_PlaceFile.include_board_edge, false ) );
350 
351  m_params.emplace_back( new PARAM<int>( "plot.one_page_per_layer",
352  &m_Plot.one_page_per_layer, 1 ) );
353 
354  m_params.emplace_back(
355  new PARAM<int>( "plot.pads_drill_mode", &m_Plot.pads_drill_mode, 2 ) );
356 
357  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x", &m_Plot.fine_scale_x, 0 ) );
358 
359  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y", &m_Plot.fine_scale_y, 0 ) );
360 
361  m_params.emplace_back(
362  new PARAM<double>( "plot.ps_fine_width_adjust", &m_Plot.ps_fine_width_adjust, 0 ) );
363 
364  m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
366 
367  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
368  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
369 
370  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.width",
371  &m_FootprintWizardList.width, -1 ) );
372 
373  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
374  &m_FootprintWizardList.height, -1 ) );
375 
376 #if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU)
377  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
378  [&]() -> nlohmann::json
379  {
380  nlohmann::json js = nlohmann::json::array();
381 
382  for( const auto& pair : m_VisibleActionPlugins )
383  js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
384 
385  return js;
386  },
387  [&]( const nlohmann::json& aObj )
388  {
389  m_VisibleActionPlugins.clear();
390 
391  if( !aObj.is_array() )
392  {
393  return;
394  }
395 
396  for( const auto& entry : aObj )
397  {
398  if( entry.empty() || !entry.is_object() )
399  continue;
400 
401  for( const auto& pair : entry.items() )
402  {
403  m_VisibleActionPlugins.emplace_back( std::make_pair(
404  wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
405  }
406  }
407  },
408  nlohmann::json::array() ) );
409 #endif
410 
411  addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
412 
413  m_params.emplace_back( new PARAM<bool>( "footprint_viewer.auto_zoom",
414  &m_FootprintViewerAutoZoom, false ) );
415 
416  m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
417  &m_FootprintViewerZoom, 1.0 ) );
418 
419  addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
420 }
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
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
DIALOG_CLEANUP m_Cleanup
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:296
DIALOG_EXPORT_IDF m_ExportIdf
const int pcbnewSchemaVersion
! Update the schema version whenever a migration is required
#define ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL
Definition: zones.h:30
double m_FootprintViewerZoom
The last zoom level in the footprint viewer.
wxString m_FootprintTextShownColumns
DIALOG_EXPORT_VRML m_ExportVrml
nlohmann::json json
Definition: gerbview.cpp:40
FOOTPRINT_CHOOSER m_FootprintChooser
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
How trace clearances are displayed.
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList
bool m_Use45DegreeGraphicSegments
WINDOW_SETTINGS m_FootprintWizard
DIALOG_EXPORT_SVG m_ExportSvg
TRACK_DRAG_ACTION m_TrackDragAction
DIALOG_NETLIST m_NetlistDialog
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
#define ZONE_CLEARANCE_MIL
Definition: zones.h:33
WINDOW_SETTINGS m_FootprintViewer
std::unique_ptr< PNS::ROUTING_SETTINGS > m_PnsSettings
#define ZONE_THICKNESS_MIL
Definition: zones.h:31
DIALOG_PLACE_FILE m_PlaceFile
MAGNETIC_OPTIONS pads
AUI_PANELS m_AuiPanels
DIALOG_PLOT m_Plot
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
#define ZONE_THERMAL_RELIEF_GAP_MIL
Definition: zones.h:29
DIALOG_DRC m_DrcDialog
MAGNETIC_SETTINGS m_MagneticItems
bool m_FootprintViewerAutoZoom
Should the footprint viewer auto zoom on select.
PCB_DISPLAY_OPTIONS m_Display
MAGNETIC_OPTIONS tracks

References APP_SETTINGS_BASE::addParamsForWindow(), PCBNEW_SETTINGS::DIALOG_NETLIST::associate_by_ref_sch, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::auto_adjust, 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_NETLIST::delete_extra_footprints, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_shorting_tracks, PCBNEW_SETTINGS::DIALOG_NETLIST::delete_single_pad_nets, DRAG, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::drill_file_type, Dwgs_User, PCBNEW_SETTINGS::DIALOG_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, MAGNETIC_SETTINGS::graphics, 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_AuiPanels, m_Cleanup, m_Display, PCB_DISPLAY_OPTIONS::m_DisplayGraphicsFill, PCB_DISPLAY_OPTIONS::m_DisplayNetNamesMode, PCB_DISPLAY_OPTIONS::m_DisplayPadFill, PCB_DISPLAY_OPTIONS::m_DisplayPadIsol, PCB_DISPLAY_OPTIONS::m_DisplayPadNum, PCB_DISPLAY_OPTIONS::m_DisplayPcbTrackFill, PCB_DISPLAY_OPTIONS::m_DisplayRatsnestLinesCurved, PCB_DISPLAY_OPTIONS::m_DisplayTextFill, PCB_DISPLAY_OPTIONS::m_DisplayViaFill, PCB_DISPLAY_OPTIONS::m_DisplayZonesMode, m_DrcDialog, m_ExportIdf, m_ExportStep, m_ExportSvg, m_ExportVrml, m_FlipLeftRight, m_FootprintChooser, m_FootprintTextShownColumns, m_FootprintViewer, m_FootprintViewerAutoZoom, m_FootprintViewerZoom, m_FootprintWizard, m_FootprintWizardList, m_GenDrill, m_ImportGraphics, m_MagneticItems, PCB_DISPLAY_OPTIONS::m_MaxLinksShowed, m_NetlistDialog, JSON_SETTINGS::m_params, m_PlaceFile, m_Plot, m_PlotLineWidth, m_PolarCoords, m_RotationAngle, PCB_DISPLAY_OPTIONS::m_ShowGlobalRatsnest, PCB_DISPLAY_OPTIONS::m_ShowModuleRatsnest, PCB_DISPLAY_OPTIONS::m_ShowTrackClearanceMode, m_TrackDragAction, m_Use45DegreeGraphicSegments, 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::ZONES::net_filter, PCBNEW_SETTINGS::ZONES::net_sort_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::no_virtual, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::one_file, PCBNEW_SETTINGS::DIALOG_PLOT::one_page_per_layer, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_units, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_units, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_x, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_x, PCBNEW_SETTINGS::DIALOG_EXPORT_STEP::origin_y, PCBNEW_SETTINGS::DIALOG_IMPORT_GRAPHICS::origin_y, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::output_dir, MAGNETIC_SETTINGS::pads, PCBNEW_SETTINGS::DIALOG_PLOT::pads_drill_mode, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::page_size, PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::plot_board_edges, PCBNEW_SETTINGS::DIALOG_PLOT::ps_fine_width_adjust, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_units, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_units, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_x, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_x, PCBNEW_SETTINGS::DIALOG_EXPORT_IDF::ref_y, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::ref_y, PCBNEW_SETTINGS::DIALOG_DRC::refill_zones, PCBNEW_SETTINGS::DIALOG_NETLIST::report_filter, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_h, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_v, PCBNEW_SETTINGS::DIALOG_DRC::severities, PCB_DISPLAY_OPTIONS::SHOW_CLEARANCE_NEW_TRACKS_AND_VIA_AREAS, PCBNEW_SETTINGS::AUI_PANELS::show_layer_manager, PCBNEW_SETTINGS::AUI_PANELS::show_microwave_tools, PCBNEW_SETTINGS::DIALOG_DRC::test_footprints, PCBNEW_SETTINGS::DIALOG_DRC::test_track_to_zone, 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_EXPORT_VRML::use_plain_pcb, PCBNEW_SETTINGS::DIALOG_EXPORT_VRML::use_relative_paths, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::use_route_for_oval_holes, PCBNEW_SETTINGS::DIALOG_FOOTPRINT_WIZARD_LIST::width, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::width, PCBNEW_SETTINGS::DIALOG_GENERATE_DRILL::zeros_format, ZONE_CLEARANCE_MIL, ZONE_THERMAL_RELIEF_COPPER_WIDTH_MIL, ZONE_THERMAL_RELIEF_GAP_MIL, and ZONE_THICKNESS_MIL.

◆ ~PCBNEW_SETTINGS()

PCBNEW_SETTINGS::~PCBNEW_SETTINGS ( )
virtualdefault

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

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

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

Definition at line 501 of file json_settings.cpp.

502 {
503  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
504  m_nested_settings.push_back( aSettings );
505 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
std::string GetFilename() const
Definition: json_settings.h:56
const char * traceSettings
Flag to enable settings tracing.

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

238 {
239  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
240  &aWindow->maximized, false ) );
241 
242  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
243  &aWindow->mru_path, "" ) );
244 
245  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->size_x, 0 ) );
246 
247  m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->size_y, 0 ) );
248 
249  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
250  &aWindow->perspective, "" ) );
251 
252  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->pos_x, 0 ) );
253 
254  m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->pos_y, 0 ) );
255 
256  m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
257  &aWindow->zoom_factors, {} ) );
258 
259  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
260  &aWindow->grid.axes_enabled, false ) );
261 
262  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
263  &aWindow->grid.sizes, {} ) );
264 
265  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
266  &aWindow->grid.last_size_idx, 0 ) );
267 
268  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
269  &aWindow->grid.fast_grid_1, 0 ) );
270 
271  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
272  &aWindow->grid.fast_grid_2, 1 ) );
273 
274  // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
275  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
276  &aWindow->grid.user_grid_x, "10 mil" ) );
277  m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
278  &aWindow->grid.user_grid_y, "10 mil" ) );
279 
280  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
281  &aWindow->grid.line_width, 1.0 ) );
282 
283  m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
284  &aWindow->grid.min_spacing, 10 ) );
285 
286  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
287  &aWindow->grid.show, true ) );
288 
289  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
290  &aWindow->grid.style, 0 ) );
291 
292  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
293  &aWindow->cursor.always_show_cursor, true ) );
294 
295  m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
296  &aWindow->cursor.fullscreen_cursor, false ) );
297 }
wxString mru_path
Definition: app_settings.h:71
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:78
double line_width
Definition: app_settings.h:58
wxString perspective
Definition: app_settings.h:74
std::vector< wxString > sizes
Definition: app_settings.h:52
CURSOR_SETTINGS cursor
Definition: app_settings.h:80
GRID_SETTINGS grid
Definition: app_settings.h:81

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, GRID_SETTINGS::fast_grid_1, GRID_SETTINGS::fast_grid_2, CURSOR_SETTINGS::fullscreen_cursor, WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, GRID_SETTINGS::line_width, JSON_SETTINGS::m_params, WINDOW_SETTINGS::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_SETTINGS::pos_x, WINDOW_SETTINGS::pos_y, GRID_SETTINGS::show, WINDOW_SETTINGS::size_x, WINDOW_SETTINGS::size_y, GRID_SETTINGS::sizes, 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().

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

415 {
416  ValueType val;
417 
418  if( aConfig->Read( aKey, &val ) )
419  {
420  try
421  {
422  ( *this )[PointerFromString( aDest )] = val;
423  }
424  catch( ... )
425  {
426  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
427  return false;
428  }
429 
430  return true;
431  }
432 
433  return false;
434 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

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

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

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

Definition at line 473 of file json_settings.cpp.

475 {
476  wxString str;
477 
478  if( aConfig->Read( aKey, &str ) )
479  {
481  color.SetFromWxString( str );
482 
483  try
484  {
485  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
486  ( *this )[PointerFromString( aDest )] = js;
487  }
488  catch( ... )
489  {
490  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
491  return false;
492  }
493 
494  return true;
495  }
496 
497  return false;
498 }
int color
Definition: DXF_plotter.cpp:61
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 449 of file json_settings.cpp.

451 {
452  wxString str;
453 
454  if( aConfig->Read( aKey, &str ) )
455  {
456  try
457  {
458  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
459  }
460  catch( ... )
461  {
462  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
463  return false;
464  }
465 
466  return true;
467  }
468 
469  return false;
470 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 111 of file json_settings.h.

112  {
113  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
114  {
115  try
116  {
117  return ret->get<ValueType>();
118  }
119  catch( ... )
120  {
121  }
122  }
123 
124  return NULLOPT;
125  }
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< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 531 of file json_settings.cpp.

532 {
533  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
534  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
535 
536  return NULLOPT;
537 }
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 217 of file json_settings.h.

218  {
219  return wxT( "json" );
220  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 69 of file json_settings.cpp.

70 {
71  return wxString( m_filename.c_str(), wxConvUTF8 ) + "." + getFileExt();
72 }
std::string m_filename
The filename (not including path) of this settings file.
virtual wxString getFileExt() const

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

Referenced by JSON_SETTINGS::JSON_SETTINGS(), 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 358 of file json_settings.cpp.

359 {
360  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
361 
362  if( this->contains( ptr ) )
363  {
364  try
365  {
366  return OPT<nlohmann::json>{ this->at( ptr ) };
367  }
368  catch( ... )
369  {
370  }
371  }
372 
373  return OPT<nlohmann::json>{};
374 }
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 222 of file json_settings.h.

223  {
224  return wxEmptyString;
225  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 281 of file pcbnew_settings.h.

281 { return "PcbFrame"; }

Referenced by MigrateFromLegacy().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 60 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 75 of file json_settings.cpp.

76 {
77  for( auto param : m_params )
78  {
79  try
80  {
81  param->Load( this, m_resetParamsIfMissing );
82  }
83  catch( ... )
84  {
85  // Skip unreadable parameters in file:
86 #ifdef DEBUG
87  wxLogMessage( wxString::Format( "param '%s' load err", param->GetJsonPath().c_str() ) );
88 #endif
89  }
90  }
91 }
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()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), JSON_SETTINGS::m_params, and JSON_SETTINGS::m_resetParamsIfMissing.

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

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const std::string &  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 94 of file json_settings.cpp.

95 {
96  // First, load all params to default values
97  clear();
98  Load();
99 
100  bool success = true;
101  bool migrated = false;
102  bool legacy_migrated = false;
103 
104  LOCALE_IO locale;
105 
106  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
107  // Backup and restore during migration so that the original can be mutated if convenient
108  wxFileName temp;
109  temp.AssignTempFileName( aPath.GetFullPath() );
110 
111  bool backed_up = true;
112 
113  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
114  {
115  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
116  GetFullFilename() );
117  backed_up = false;
118  }
119 
120  wxConfigBase::DontCreateOnDemand();
121  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
122 
123  // If migrate fails or is not implemented, fall back to built-in defaults that were
124  // already loaded above
125  if( !MigrateFromLegacy( cfg.get() ) )
126  {
127  wxLogTrace( traceSettings,
128  "%s: migrated; not all settings were found in legacy file",
129  GetFullFilename() );
130  }
131  else
132  {
133  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
134  }
135 
136  if( backed_up )
137  {
138  cfg.reset();
139  wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() );
140  wxRemoveFile( temp.GetFullPath() );
141  }
142 
143  // Either way, we want to clean up the old file afterwards
144  legacy_migrated = true;
145  };
146 
147  wxFileName path;
148 
149  if( aDirectory.empty() )
150  {
151  path.Assign( m_filename );
152  path.SetExt( getFileExt() );
153  }
154  else
155  {
156  wxString dir( aDirectory.c_str(), wxConvUTF8 );
157  path.Assign( dir, m_filename, getFileExt() );
158  }
159 
160  if( !path.Exists() )
161  {
162  // Case 1: legacy migration, no .json extension yet
163  path.SetExt( getLegacyFileExt() );
164 
165  if( path.Exists() )
166  {
167  migrateFromLegacy( path );
168  }
169  // Case 2: legacy filename is different from new one
170  else if( !m_legacy_filename.empty() )
171  {
172  path.SetName( m_legacy_filename );
173 
174  if( path.Exists() )
175  migrateFromLegacy( path );
176  }
177  else
178  {
179  success = false;
180  }
181  }
182  else
183  {
184  try
185  {
186  std::ifstream in( path.GetFullPath().ToUTF8() );
187  in >> *this;
188 
189  // If parse succeeds, check if schema migration is required
190  int filever = -1;
191 
192  try
193  {
194  filever = at( PointerFromString( "meta.version" ) ).get<int>();
195  }
196  catch( ... )
197  {
198  wxLogTrace(
199  traceSettings, "%s: file version could not be read!", GetFullFilename() );
200  success = false;
201  }
202 
203  if( filever >= 0 && filever < m_schemaVersion )
204  {
205  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
206  GetFullFilename(), filever, m_schemaVersion );
207 
208  if( Migrate() )
209  {
210  migrated = true;
211  }
212  else
213  {
214  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
215  }
216  }
217  else if( filever > m_schemaVersion )
218  {
219  wxLogTrace( traceSettings,
220  "%s: warning: file version %d is newer than latest (%d)", GetFullFilename(),
221  filever, m_schemaVersion );
222  }
223  }
224  catch( nlohmann::json::parse_error& error )
225  {
226  wxLogTrace(
227  traceSettings, "Parse error reading %s: %s", path.GetFullPath(), error.what() );
228  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
229  migrateFromLegacy( path );
230  }
231  }
232 
233  // Now that we have new data in the JSON structure, load the params again
234  Load();
235 
236  // And finally load any nested settings
237  for( auto settings : m_nested_settings )
238  settings->LoadFromFile();
239 
240  wxLogTrace( traceSettings, "Loaded %s with schema %d", GetFullFilename(), m_schemaVersion );
241 
242  // If we migrated, clean up the legacy file (with no extension)
243  if( legacy_migrated || migrated )
244  {
245  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
246  {
247  wxLogTrace(
248  traceSettings, "Warning: could not remove legacy file %s", path.GetFullPath() );
249  }
250 
251  // And write-out immediately so that we don't lose data if the program later crashes.
252  SaveToFile( aDirectory );
253  }
254 
255  return success;
256 }
std::string m_filename
The filename (not including path) of this settings file.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
virtual bool SaveToFile(const std::string &aDirectory="", bool aForce=false)
virtual wxString getLegacyFileExt() const
wxString GetFullFilename() const
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
virtual bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
std::string m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
virtual wxString getFileExt() const
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtualinherited

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

Reimplemented in COMMON_SETTINGS, COLOR_SETTINGS, and FOOTPRINT_EDITOR_SETTINGS.

Definition at line 377 of file json_settings.cpp.

378 {
379  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
380  return false;
381 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase *  aCfg)
protectedinherited

! Migrates the find/replace history string lists

Definition at line 177 of file app_settings.cpp.

178 {
179  const int find_replace_history_size = 10;
180  nlohmann::json find_history = nlohmann::json::array();
181  nlohmann::json replace_history = nlohmann::json::array();
182  wxString tmp, find_key, replace_key;
183 
184  for( int i = 0; i < find_replace_history_size; ++i )
185  {
186  find_key.Printf( "FindStringHistoryList%d", i );
187  replace_key.Printf( "ReplaceStringHistoryList%d", i );
188 
189  if( aCfg->Read( find_key, &tmp ) )
190  find_history.push_back( tmp.ToStdString() );
191 
192  if( aCfg->Read( replace_key, &tmp ) )
193  replace_history.push_back( tmp.ToStdString() );
194  }
195 
196  ( *this )[PointerFromString( "find_replace.find_history" )] = find_history;
197  ( *this )[PointerFromString( "find_replace.replace_history" )] = replace_history;
198 }
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

bool PCBNEW_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

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

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

Reimplemented from APP_SETTINGS_BASE.

Definition at line 426 of file pcbnew_settings.cpp.

427 {
428  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
429 
430  const std::string f = getLegacyFrameName();
431 
432  //
433  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
434  //
435  ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
436  ret &= fromLegacy<bool>( aCfg, "ShowMicrowaveTools", "aui.show_microwave_tools" );
437 
438  ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
439  ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
440  ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
441  ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
442 
443  ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
444  ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
445  ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
446  ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
447  ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
448  ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments",
449  "editing.use_45_degree_graphic_segments" );
450 
451  ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
452  ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
453  ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
454  ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
455  ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
456  ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
457  ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
458  ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
459  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
460  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
461  ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
462  ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
463  ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
464  ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
465  ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
466  ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
467 
468  ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
469 
470  aCfg->SetPath( "/dialogs/cleanup_tracks" );
471  ret &= fromLegacy<bool>( aCfg, "DialogCleanupVias", "cleanup.cleanup_vias" );
472  ret &= fromLegacy<bool>( aCfg, "DialogCleanupMergeSegments", "cleanup.merge_segments" );
473  ret &= fromLegacy<bool>( aCfg, "DialogCleanupUnconnected", "cleanup.cleanup_unconnected" );
474  ret &= fromLegacy<bool>( aCfg, "DialogCleanupShortCircuit", "cleanup.cleanup_short_circuits" );
475  ret &= fromLegacy<bool>( aCfg, "DialogCleanupTracksInPads", "cleanup.cleanup_tracks_in_pad" );
476  aCfg->SetPath( "../.." );
477 
478  ret &= fromLegacy<bool>( aCfg, "RefillZonesBeforeDrc", "drc_dialog.refill_zones" );
479  ret &= fromLegacy<bool>( aCfg, "DrcTrackToZoneTest", "drc_dialog.test_track_to_zone" );
480  ret &= fromLegacy<bool>( aCfg, "DrcTestFootprints", "drc_dialog.test_footprints" );
481 
482  ret &= fromLegacy<bool>( aCfg, "DrillMergePTHNPTH", "gen_drill.merge_pth_npth" );
483  ret &= fromLegacy<bool>( aCfg, "DrillMinHeader", "gen_drill.minimal_header" );
484  ret &= fromLegacy<bool>( aCfg, "DrillMirrorYOpt", "gen_drill.mirror" );
485  ret &= fromLegacy<bool>( aCfg, "DrillUnit", "gen_drill.unit_drill_is_inch" );
486  ret &= fromLegacy<bool>( aCfg, "OvalHolesRouteMode", "gen_drill.use_route_for_oval_holes" );
487  ret &= fromLegacy<int>( aCfg, "DrillFileType", "gen_drill.drill_file_type" );
488  ret &= fromLegacy<int>( aCfg, "DrillMapFileType", "gen_drill.map_file_type" );
489  ret &= fromLegacy<int>( aCfg, "DrillZerosFormat", "gen_drill.zeros_format" );
490 
491  ret &= fromLegacy<bool>( aCfg, "IDFRefAutoAdj", "export_idf.auto_adjust" );
492  ret &= fromLegacy<int>( aCfg, "IDFRefUnits", "export_idf.ref_units" );
493  ret &= fromLegacy<double>( aCfg, "IDFRefX", "export_idf.ref_x" );
494  ret &= fromLegacy<double>( aCfg, "IDFRefY", "export_idf.ref_y" );
495  ret &= fromLegacy<bool>( aCfg, "IDFExportThou", "export_idf.units_mils" );
496 
497  ret &= fromLegacy<int>( aCfg, "STEP_Origin_Opt", "export_step.origin_mode" );
498  ret &= fromLegacy<int>( aCfg, "STEP_UserOriginUnits", "export_step.origin_units" );
499  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginX", "export_step.origin_x" );
500  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginY", "export_step.origin_y" );
501  ret &= fromLegacy<bool>( aCfg, "STEP_NoVirtual", "export_step.no_virtual" );
502 
503  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeColor", "export_svg.black_and_white" );
504  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeMirror", "export_svg.mirror" );
505  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeOneFile", "export_svg.one_file" );
506  ret &= fromLegacy<bool>( aCfg, "PlotSVGBrdEdge", "export_svg.plot_board_edges" );
507  ret &= fromLegacy<int>( aCfg, "PlotSVGPageOpt", "export_svg.page_size" );
508  ret &= fromLegacyString( aCfg, "PlotSVGDirectory", "export_svg.output_dir" );
509 
510  {
511  nlohmann::json js = nlohmann::json::array();
512  wxString key;
513  bool val = false;
514 
515  for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
516  {
517  key.Printf( wxT( "PlotSVGLayer_%d" ), i );
518 
519  if( aCfg->Read( key, &val ) && val )
520  js.push_back( i );
521  }
522 
523  ( *this )[PointerFromString( "export_svg.layers" ) ] = js;
524  }
525 
526  {
527  nlohmann::json js = nlohmann::json::array();
528 
529  wxString packed;
530 
531  if( aCfg->Read( "ActionPluginButtons", &packed ) )
532  {
533  wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
534 
535  while( pluginSettingsTokenizer.HasMoreTokens() )
536  {
537  nlohmann::json row;
538  wxString plugin = pluginSettingsTokenizer.GetNextToken();
539  wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
540 
541  if( pluginTokenizer.CountTokens() != 2 )
542  {
543  // Bad config
544  continue;
545  }
546 
547  std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
548 
549  js.push_back( nlohmann::json( {
550  { key, pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 } } ) );
551  }
552  }
553 
554  ( *this )[PointerFromString( "action_plugins" ) ] = js;
555  }
556 
557  //
558  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
559  //
560  ret &= fromLegacy<int>( aCfg, "VrmlExportUnit", "export_vrml.units" );
561  ret &= fromLegacy<bool>( aCfg, "VrmlExportCopyFiles", "export_vrml.copy_3d_models" );
562  ret &= fromLegacy<bool>( aCfg, "VrmlUseRelativePaths", "export_vrml.use_relative_paths" );
563  ret &= fromLegacy<bool>( aCfg, "VrmlUsePlainPCB", "export_vrml.use_plain_pcb" );
564  ret &= fromLegacy<int>( aCfg, "VrmlRefUnits", "export_vrml.ref_units" );
565  ret &= fromLegacy<double>( aCfg, "VrmlRefX", "export_vrml.ref_x" );
566  ret &= fromLegacy<double>( aCfg, "VrmlRefY", "export_vrml.ref_y" );
567 
568  ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
569  ret &= fromLegacyString( aCfg, "Zone_Filter_Opt", "zones.net_filter" );
570  ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
571  ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
572  ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
573  ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
574  ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
575 
576  aCfg->SetPath( "ImportGraphics" );
577  ret &= fromLegacy<int>( aCfg, "BoardLayer", "import_graphics.layer" );
578  ret &= fromLegacy<bool>( aCfg, "InteractivePlacement", "import_graphics.interactive_placement" );
579  ret &= fromLegacyString( aCfg, "LastFile", "import_graphics.last_file" );
580  ret &= fromLegacy<double>( aCfg, "LineWidth", "import_graphics.line_width" );
581  ret &= fromLegacy<int>( aCfg, "LineWidthUnits", "import_graphics.line_width_units" );
582  ret &= fromLegacy<int>( aCfg, "PositionUnits", "import_graphics.origin_units" );
583  ret &= fromLegacy<double>( aCfg, "PositionX", "import_graphics.origin_x" );
584  ret &= fromLegacy<double>( aCfg, "PositionY", "import_graphics.origin_y" );
585  aCfg->SetPath( ".." );
586 
587  ret &= fromLegacy<int>( aCfg, "NetlistReportFilterMsg", "netlist.report_filter" );
588  ret &= fromLegacy<bool>( aCfg, "NetlistUpdateFootprints", "netlist.update_footprints" );
589  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteShortingTracks", "netlist.delete_shorting_tracks" );
590  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteExtraFootprints", "netlist.delete_extra_footprints" );
591  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteSinglePadNets", "netlist.delete_single_pad_nets" );
592 
593  ret &= fromLegacy<int>( aCfg, "PlaceFileUnits", "place_file.units" );
594  ret &= fromLegacy<int>( aCfg, "PlaceFileOpts", "place_file.file_options" );
595  ret &= fromLegacy<int>( aCfg, "PlaceFileFormat", "place_file.file_format" );
596  ret &= fromLegacy<bool>( aCfg, "PlaceFileIncludeBrdEdge", "place_file.include_board_edge" );
597 
598  ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.one_page_per_layer" );
599  ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
600  ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
601  ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
602  ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
603  ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
604 
605  ret &= fromLegacyString( aCfg, "FootprintTextShownColumns", "window.footprint_text_shown_columns" );
606 
607  ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
608  ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
609 
610  migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
611 
612  ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
613  ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
614 
615  migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
616  ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
617 
618 
619  const std::string p = "pcbnew.InteractiveRouter.";
620 
621  ( *this )[PointerFromString( "tools.pns.meta" )] = nlohmann::json( {
622  { "filename", "pns" },
623  { "version", 0 }
624  } );
625 
626  ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
627  ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
628  ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
629  ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
630  ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
631  ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
632  ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
633  ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
634  ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
635  ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
636  ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
637  ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
638  ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
639  ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
640  ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "tools.pns.inline_drag" );
641 
642  // Migrate color settings that were stored in the pcbnew config file
643 
644  COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetColorSettings();
645 
646  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
647  wxString str;
648 
649  if( aCfg->Read( aKey, &str ) )
650  cs->SetColor( aLayerId, COLOR4D( str ) );
651  };
652 
653  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
654  {
655  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
656  migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
657  }
658 
659  migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
660  migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
661  migrateLegacyColor( "Color4DGrid", LAYER_GRID );
662  migrateLegacyColor( "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
663  migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
664  migrateLegacyColor( "Color4DPadBackEx", LAYER_PAD_BK );
665  migrateLegacyColor( "Color4DPadFrontEx", LAYER_PAD_FR );
666  migrateLegacyColor( "Color4DPadThruHoleEx", LAYER_PADS_TH );
667  migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
668  migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
669  migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
670  migrateLegacyColor( "Color4DTxtBackEx", LAYER_MOD_TEXT_BK );
671  migrateLegacyColor( "Color4DTxtFrontEx", LAYER_MOD_TEXT_FR );
672  migrateLegacyColor( "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
673  migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
674  migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
675  migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
676  migrateLegacyColor( "Color4DWorksheet", LAYER_WORKSHEET );
677 
678  Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
679 
680  double x, y;
681 
682  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
683  {
684  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
685  static_cast<long>( EDA_UNITS::INCHES ) ) );
686 
687  // Convert to internal units
688  x = From_User_Unit( u, x );
689  y = From_User_Unit( u, y );
690 
691  ( *this )[PointerFromString( "window.grid.user_grid_x" )] = StringFromValue( u, x, true, true );
692  ( *this )[PointerFromString( "window.grid.user_grid_y" )] = StringFromValue( u, y, true, true );
693  }
694 
695  // Footprint editor settings were stored in pcbnew config file. Migrate them here.
696  auto fpedit = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( false );
697  fpedit->MigrateFromLegacy( aCfg );
698  fpedit->Load();
699 
700  // Same with 3D viewer
701  auto viewer3d = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( false );
702  viewer3d->MigrateFromLegacy( aCfg );
703  viewer3d->Load();
704 
705  return ret;
706 }
EDA_UNITS
Definition: common.h:198
to draw blind/buried vias
show a marker on pads with no nets
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
multilayer pads, usually with holes
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
double From_User_Unit(EDA_UNITS aUnits, double aValue, bool aUseMils)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:321
nlohmann::json json
Definition: gerbview.cpp:40
PCB_LAYER_ID
A quick note on layer IDs:
Auxiliary items (guides, rule, etc)
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Function Name returns the fixed name association with aLayerId.
Definition: lset.cpp:78
to draw usual through hole vias
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
virtual std::string getLegacyFrameName() const override
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
smd pads, front layer
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
Color settings are a bit different than most of the settings objects in that there can be more than o...
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, bool aUseMils, EDA_DATA_TYPE aType)
Function StringFromValue returns the string from aValue according to units (inch, mm ....
Definition: base_units.cpp:233
bool migrateWindowConfig(wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
Migrates legacy window settings into the JSON document.
void SetColor(int aLayer, COLOR4D aColor)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

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

◆ migrateWindowConfig()

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

Migrates legacy window settings into the JSON document.

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

Definition at line 201 of file app_settings.cpp.

203 {
204  bool ret = true;
205 
206  const std::string frameGDO = aFrame + "GalDisplayOptions";
207  const std::string cursorPath = aJsonPath + ".cursor";
208  const std::string gridPath = aJsonPath + ".grid";
209 
210  ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
211  ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
212  ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
213  ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
214  ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
215  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
216  ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
217 
218  ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
219  ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
220 
221  ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
222 
223  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
224  ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
225 
226  ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
227  ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
228  ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
229  ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
230  ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
231  ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
232 
233  return ret;
234 }
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
bool fromLegacyColor(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

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

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

◆ PointerFromString()

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

Builds a JSON pointer based on a given string.

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

Definition at line 392 of file json_settings.cpp.

393 {
394  std::replace( aPath.begin(), aPath.end(), '.', '/' );
395  aPath.insert( 0, "/" );
396 
397  nlohmann::json::json_pointer p;
398 
399  try
400  {
401  p = nlohmann::json::json_pointer( aPath );
402  }
403  catch( ... )
404  {
405  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
406  }
407 
408  return p;
409 }

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

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

509 {
510  if( !aSettings )
511  return;
512 
513  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
514  [&aSettings]( const JSON_SETTINGS* aPtr ) {
515  return aPtr == aSettings;
516  } );
517 
518  if( it != m_nested_settings.end() )
519  {
520  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
521  ( *it )->SaveToFile();
522  m_nested_settings.erase( it );
523  }
524 
525  aSettings->SetParent( nullptr );
526 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
void SetParent(JSON_SETTINGS *aParent)

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

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 273 of file json_settings.cpp.

274 {
275  for( auto param : m_params )
276  param->SetDefault();
277 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions().

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const std::string &  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 280 of file json_settings.cpp.

281 {
282  if( !m_writeFile )
283  return false;
284 
285  // Default PROJECT won't have a filename set
286  if( m_filename.empty() )
287  return false;
288 
289  wxFileName path;
290 
291  if( aDirectory.empty() )
292  {
293  path.Assign( m_filename );
294  path.SetExt( getFileExt() );
295  }
296  else
297  {
298  wxString dir( aDirectory.c_str(), wxConvUTF8 );
299  path.Assign( dir, m_filename, getFileExt() );
300  }
301 
302  if( !m_createIfMissing && !path.FileExists() )
303  {
304  wxLogTrace( traceSettings,
305  "File for %s doesn't exist and m_createIfMissing == false; not saving",
306  GetFullFilename() );
307  return false;
308  }
309 
310  bool modified = false;
311 
312  for( auto settings : m_nested_settings )
313  modified |= settings->SaveToFile();
314 
315  modified |= Store();
316 
317  if( !modified && !aForce && path.FileExists() )
318  {
319  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
320  return false;
321  }
322  else if( !modified && !aForce && !m_createIfDefault )
323  {
324  wxLogTrace( traceSettings,
325  "%s contents still default and m_createIfDefault == false; not saving",
326  GetFullFilename() );
327  return false;
328  }
329 
330  if( !path.DirExists() && !path.Mkdir() )
331  {
332  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
333  path.GetPath(), GetFullFilename() );
334  return false;
335  }
336 
337  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
338 
340 
341  try
342  {
343  std::ofstream file( path.GetFullPath().ToUTF8() );
344  file << std::setw( 2 ) << *this << std::endl;
345  }
346  catch( const std::exception& e )
347  {
348  wxLogTrace( traceSettings, "Warning: could not save %s: %s", GetFullFilename(), e.what() );
349  }
350  catch( ... )
351  {
352  }
353 
354  return true;
355 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
std::string m_filename
The filename (not including path) of this settings file.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
const char * traceSettings
Flag to enable settings tracing.
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

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

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

◆ Set() [1/3]

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

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

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

Definition at line 135 of file json_settings.h.

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

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::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 540 of file json_settings.cpp.

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

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const std::string &  aFilename)
inlineinherited

Definition at line 62 of file json_settings.h.

62 { m_legacy_filename = aFilename; }
std::string m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 175 of file json_settings.h.

176  {
177  m_manager = aManager;
178  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

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

260 {
261  bool modified = false;
262 
263  for( auto param : m_params )
264  {
265  modified |= !param->MatchesFile( this );
266  param->Store( this );
267  }
268 
269  return modified;
270 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion
inherited

! Local schema version for common app settings

Definition at line 159 of file app_settings.h.

◆ m_AuiPanels

AUI_PANELS PCBNEW_SETTINGS::m_AuiPanels

Definition at line 214 of file pcbnew_settings.h.

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

◆ m_Cleanup

DIALOG_CLEANUP PCBNEW_SETTINGS::m_Cleanup

◆ 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 249 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 243 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 255 of file json_settings.h.

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

◆ m_Display

PCB_DISPLAY_OPTIONS PCBNEW_SETTINGS::m_Display

◆ m_DrcDialog

DIALOG_DRC PCBNEW_SETTINGS::m_DrcDialog

Definition at line 218 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 220 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 222 of file pcbnew_settings.h.

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

◆ m_ExportSvg

DIALOG_EXPORT_SVG PCBNEW_SETTINGS::m_ExportSvg

Definition at line 224 of file pcbnew_settings.h.

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

◆ m_ExportVrml

DIALOG_EXPORT_VRML PCBNEW_SETTINGS::m_ExportVrml

◆ m_filename

std::string JSON_SETTINGS::m_filename
protectedinherited

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace
inherited

◆ m_FlipLeftRight

◆ m_FootprintChooser

◆ m_FootprintTextShownColumns

wxString PCBNEW_SETTINGS::m_FootprintTextShownColumns

◆ m_FootprintViewer

WINDOW_SETTINGS PCBNEW_SETTINGS::m_FootprintViewer

◆ m_FootprintViewerAutoZoom

bool PCBNEW_SETTINGS::m_FootprintViewerAutoZoom

Should the footprint viewer auto zoom on select.

Definition at line 271 of file pcbnew_settings.h.

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

◆ m_FootprintViewerZoom

double PCBNEW_SETTINGS::m_FootprintViewerZoom

The last zoom level in the footprint viewer.

Definition at line 273 of file pcbnew_settings.h.

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

◆ m_FootprintWizard

WINDOW_SETTINGS PCBNEW_SETTINGS::m_FootprintWizard

Definition at line 246 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS().

◆ m_FootprintWizardList

◆ m_GenDrill

DIALOG_GENERATE_DRILL PCBNEW_SETTINGS::m_GenDrill

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

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

◆ m_legacy_filename

std::string JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 231 of file json_settings.h.

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

◆ m_LibTree

LIB_TREE APP_SETTINGS_BASE::m_LibTree
inherited

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 234 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_MagneticItems

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 264 of file json_settings.h.

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

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

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

◆ m_NetlistDialog

DIALOG_NETLIST PCBNEW_SETTINGS::m_NetlistDialog

◆ m_params

◆ m_PlaceFile

DIALOG_PLACE_FILE PCBNEW_SETTINGS::m_PlaceFile

◆ m_Plot

DIALOG_PLOT PCBNEW_SETTINGS::m_Plot

Definition at line 238 of file pcbnew_settings.h.

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

◆ m_PlotLineWidth

double PCBNEW_SETTINGS::m_PlotLineWidth

Definition at line 263 of file pcbnew_settings.h.

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

◆ m_PnsSettings

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

Definition at line 269 of file pcbnew_settings.h.

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

◆ m_PolarCoords

bool PCBNEW_SETTINGS::m_PolarCoords

◆ m_preserved_paths

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

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

Definition at line 267 of file json_settings.h.

◆ m_Printing

◆ 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 258 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 261 of file pcbnew_settings.h.

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_ShowPageLimits

bool PCBNEW_SETTINGS::m_ShowPageLimits

Definition at line 265 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::LoadSettings().

◆ m_System

◆ m_TrackDragAction

◆ m_Use45DegreeGraphicSegments

bool PCBNEW_SETTINGS::m_Use45DegreeGraphicSegments

◆ m_Window

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 252 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_Zones


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