KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcbnew_settings.cpp
Go to the documentation of this file.
1/*
2* This program source code file is part of KiCad, a free EDA CAD application.
3*
4* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5*
6* This program is free software; you can redistribute it and/or
7* modify it under the terms of the GNU General Public License
8* as published by the Free Software Foundation; either version 2
9* of the License, or (at your option) any later version.
10*
11* This program is distributed in the hope that it will be useful,
12* but WITHOUT ANY WARRANTY; without even the implied warranty of
13* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14* GNU General Public License for more details.
15*
16* You should have received a copy of the GNU General Public License
17* along with this program. If not, see <https://www.gnu.org/licenses/>.
18*/
19
20#include <common.h>
23#include <layer_ids.h>
24#include <lset.h>
25#include <pcbnew_settings.h>
26#include <pgm_base.h>
30#include <settings/parameters.h>
34#include <wx/config.h>
35#include <wx/tokenzr.h>
36#include <base_units.h>
37
39
40
42const int pcbnewSchemaVersion = 5;
43
44
50
51
58 m_Display(),
62 m_CtrlClickHighlight( false ),
65 m_AutoConstraints( true ),
67 m_PolarCoords( false ),
69 m_ShowPageLimits( true ),
71 m_AutoRefillZones( false ),
72 m_AllowFreePads( false ),
74 m_PnsSettings( nullptr ),
77{
79
82 m_MagneticItems.graphics = false;
83 m_MagneticItems.allLayers = false;
84
85 m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
86 &m_AuiPanels.show_layer_manager, true ) );
87
88 m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
89 &m_AuiPanels.right_panel_width, -1 ) );
90
91 m_params.emplace_back( new PARAM<int>( "aui.net_inspector_width",
92 &m_AuiPanels.net_inspector_width, -1 ) );
93
94 m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
95 &m_AuiPanels.properties_panel_width, -1 ) );
96
97 m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
98 &m_AuiPanels.properties_splitter, 0.5f ) );
99
100 m_params.emplace_back( new PARAM<int>( "aui.search_panel_height",
101 &m_AuiPanels.search_panel_height, -1 ) );
102
103 m_params.emplace_back( new PARAM<int>( "aui.search_panel_width",
104 &m_AuiPanels.search_panel_width, -1 ) );
105
106 m_params.emplace_back( new PARAM<int>( "aui.search_panel_dock_direction",
107 &m_AuiPanels.search_panel_dock_direction, 3 ) );
108
109 m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
110 &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
111
112 m_params.emplace_back( new PARAM<bool>( "aui.appearance_expand_layer_display",
113 &m_AuiPanels.appearance_expand_layer_display, false ) );
114
115 m_params.emplace_back( new PARAM<bool>( "aui.appearance_expand_net_display",
116 &m_AuiPanels.appearance_expand_net_display, false ) );
117
118 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
119 &m_AuiPanels.show_properties, true ) );
120
121 m_params.emplace_back( new PARAM<bool>( "aui.show_search",
122 &m_AuiPanels.show_search, false ) );
123
124 m_params.emplace_back( new PARAM<bool>( "aui.show_net_inspector",
125 &m_AuiPanels.show_net_inspector, false ) );
126
127 m_params.emplace_back( new PARAM<bool>( "aui.design_blocks_show", &m_AuiPanels.design_blocks_show, false ) );
128
129 m_params.emplace_back( new PARAM<int>( "aui.design_blocks_panel_docked_width",
130 &m_AuiPanels.design_blocks_panel_docked_width, -1 ) );
131
132 m_params.emplace_back(
133 new PARAM<int>( "aui.design_blocks_panel_float_width", &m_AuiPanels.design_blocks_panel_float_width, -1 ) );
134
135 m_params.emplace_back( new PARAM<int>( "aui.design_blocks_panel_float_height",
136 &m_AuiPanels.design_blocks_panel_float_height, -1 ) );
137
138 m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
139 &m_FootprintChooser.width, -1 ) );
140
141 m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
142 &m_FootprintChooser.height, -1 ) );
143
144 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
145 &m_FootprintChooser.sash_h, -1 ) );
146
147 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
148 &m_FootprintChooser.sash_v, -1 ) );
149
150 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sort_mode",
151 &m_FootprintChooser.sort_mode, 0 ) );
152
153 m_params.emplace_back( new PARAM<bool>( "footprint_chooser.filter_on_pin_count",
154 &m_FootprintChooser.filter_on_pin_count, false ) );
155
156 m_params.emplace_back( new PARAM<bool>( "footprint_chooser.use_fp_filters",
157 &m_FootprintChooser.use_fp_filters, false ) );
158
159 m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
160 reinterpret_cast<bool*>( &m_FlipDirection ),
161 static_cast<bool>( FLIP_DIRECTION::LEFT_RIGHT ) ) );
162
163 m_params.emplace_back( new PARAM<bool>( "editing.esc_clears_net_highlight",
164 &m_ESCClearsNetHighlight, true ) );
165
166 m_params.emplace_back( new PARAM<bool>( "editing.show_courtyard_collisions",
167 &m_ShowCourtyardCollisions, true ) );
168
169 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
170 &m_MagneticItems.graphics, true ) );
171
172 m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
173 reinterpret_cast<int*>( &m_MagneticItems.pads ),
175
176 m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
177 reinterpret_cast<int*>( &m_MagneticItems.tracks ),
179
180 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_all_layers",
181 &m_MagneticItems.allLayers, false ) );
182
184
185 m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
186 &m_PolarCoords, false ) );
187
188 m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
189 reinterpret_cast<int*>( &m_TrackDragAction ),
190 static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
191
192 m_params.emplace_back( new PARAM<int>( "editing.arc_edit_mode",
193 reinterpret_cast<int*>( &m_ArcEditMode ),
195
196 m_params.emplace_back( new PARAM<bool>( "editing.ctrl_click_highlight",
197 &m_CtrlClickHighlight, false ) );
198
199 m_params.emplace_back( new PARAM<int>( "editing.pcb_angle_snap_mode",
200 reinterpret_cast<int*>( &m_AngleSnapMode ),
201 static_cast<int>( LEADER_MODE::DIRECT ) ) );
202
203 m_params.emplace_back( new PARAM<bool>( "editing.auto_constraints", &m_AutoConstraints, true ) );
204
205 m_params.emplace_back( new PARAM<bool>( "editing.auto_fill_zones",
206 &m_AutoRefillZones, false ) );
207
208 m_params.emplace_back( new PARAM<bool>( "editing.allow_free_pads",
209 &m_AllowFreePads, false ) );
210
211 m_params.emplace_back( new PARAM<bool>( "import.keep_kicad_layer_names",
212 &m_ImportKeepKiCadLayerNames, false ) );
213
214 m_params.emplace_back( new PARAM_LAMBDA<int>( "editing.rotation_angle",
215 [this] () -> int
216 {
217 int rot = m_RotationAngle.AsTenthsOfADegree();
218
219 // Don't store values larger than 360 degrees
220 return rot % 3600;
221 },
222 [this] ( int aVal )
223 {
224 if( aVal )
226
227 // A misconfiguration allowed some angles to be stored as tenth of a degree but read
228 // as tens of degrees. By disallowing storage of values larger than 360, we can weed out
229 // those invalid values here.
230 while( m_RotationAngle > ANGLE_360 )
232
233 },
234 900 ) );
235
236 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
237 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
238
239 m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
240 &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
241
242 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
243 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
244
245 m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
246 &m_ViewersDisplay.m_DisplayTextFill, true ) );
247
248 m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
249 &m_Display.m_NetNames, 3, 0, 3 ) );
250
251 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
252 &m_Display.m_PadClearance, true ) );
253
254 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_use_via_color_for_normal_th_padstacks",
255 &m_Display.m_UseViaColorForNormalTHPadstacks, false ) );
256
257 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
258 &m_ViewersDisplay.m_DisplayPadFill, true ) );
259
260 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
261 &m_ViewersDisplay.m_DisplayPadNumbers, true ) );
262
263 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
264 &m_Display.m_ShowGlobalRatsnest, true ) );
265
266 m_params.emplace_back( new PARAM<bool>( "pcb_display.show_constraints", &m_Display.m_ShowConstraints, false ) );
267
268 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
269 &m_Display.m_ShowModuleRatsnest, true ) );
270
271 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
272 &m_Display.m_DisplayRatsnestLinesCurved, false ) );
273
274 m_params.emplace_back( new PARAM<double>( "pcb_display.ratsnest_thickness",
275 &m_Display.m_RatsnestThickness, 0.5 ) );
276
277 m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
278 reinterpret_cast<int*>( &m_Display.m_TrackClearance ), SHOW_WITH_VIA_WHILE_ROUTING ) );
279
280 m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
281 &m_Display.m_DisplayPcbTrackFill, true ) );
282
283 m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
284 &m_Display.m_DisplayViaFill, true ) );
285
286 m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
287 reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
289
290 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
291 &m_Display.m_DisplayInvertXAxis, false ) );
292
293 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
294 &m_Display.m_DisplayInvertYAxis, false ) );
295
296 m_params.emplace_back( new PARAM<bool>( "pcb_display.force_show_fields_when_fp_selected",
297 &m_Display.m_ForceShowFieldsWhenFPSelected, true ) );
298
299 m_params.emplace_back( new PARAM<bool>( "pcb_display.live_3d_refresh",
300 &m_Display.m_Live3DRefresh, false ) );
301
302 m_params.emplace_back( new PARAM<bool>( "pcb_display.show_page_borders",
303 &m_ShowPageLimits, true ) );
304
305 m_params.emplace_back( new PARAM_MAP<int>( "field_editor.field_widths",
306 &m_FieldEditorPanel.field_widths, {} ) );
307
308 m_params.emplace_back( new PARAM<int>( "field_editor.selection_mode",
309 &m_FieldEditorPanel.selection_mode, 0 ) );
310
311 m_params.emplace_back( new PARAM<int>( "field_editor.sash_pos",
312 &m_FieldEditorPanel.sash_pos, 400 ) );
313
314 m_params.emplace_back( new PARAM<int>( "field_editor.variant_sash_pos",
315 &m_FieldEditorPanel.variant_sash_pos, 500 ) );
316
317 m_params.emplace_back( new PARAM<bool>( "field_editor.sidebar_collapsed",
318 &m_FieldEditorPanel.sidebar_collapsed, false ) );
319
320 m_params.emplace_back( new PARAM<bool>( "export_d356.doNotExportUnconnectedPads",
321 &m_ExportD356.doNotExportUnconnectedPads, false ) );
322
323 addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
324
325 m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
326 &m_FootprintViewerZoom, 1.0 ) );
327
328 m_params.emplace_back( new PARAM<bool>( "footprint_viewer.autozoom",
330
331 m_params.emplace_back( new PARAM<int>( "footprint_viewer.lib_list_width",
333
334 m_params.emplace_back( new PARAM<int>( "footprint_viewer.fp_list_width",
336
337 addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
338
339 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
340 &m_LastFootprintLibDir, "" ) );
341
342 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
343 &m_LastFootprint3dDir, "" ) );
344
345 m_params.emplace_back( new PARAM<bool>( "DRC.report_all_track_errors",
346 &m_DRCDialog.report_all_track_errors, false ) );
347
348 m_params.emplace_back( new PARAM<bool>( "DRC.crossprobe",
349 &m_DRCDialog.crossprobe, true ) );
350
351 m_params.emplace_back( new PARAM<bool>( "DRC.scroll_on_crossprobe",
352 &m_DRCDialog.scroll_on_crossprobe, true ) );
353
354 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.zero_color", &m_DiffPhaseSkewSettings.m_ZeroSkewColor,
355 COLOR4D( 1.0, 1.0, 1.0, 1.0 ) ) );
356
357 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.positive_color",
358 &m_DiffPhaseSkewSettings.m_PositiveSkewColor,
359 COLOR4D( 0.0, 0.0, 1.0, 1.0 ) ) );
360
361 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.negative_color",
362 &m_DiffPhaseSkewSettings.m_NegativeSkewColor,
363 COLOR4D( 1.0, 0.0, 0.0, 1.0 ) ) );
364
365 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.unknown_color",
366 &m_DiffPhaseSkewSettings.m_UnknownSkewColor,
367 COLOR4D( 0.5, 0.5, 0.5, 1.0 ) ) );
368
369 registerMigration( 0, 1,
370 [&]()
371 {
372 if( std::optional<int> optval = Get<int>( "pcb_display.rotation_angle" ) )
373 Set( "editing.rotation_angle", *optval );
374
375 try
376 {
377 At( "pcb_display" ).erase( "rotation_angle" );
378 }
379 catch( ... )
380 {}
381
382 return true;
383 } );
384
385 registerMigration( 1, 2,
386 [&]()
387 {
388 // In version 1 this meant "after Zone Properties dialog", but it now means
389 // "everywhere" so we knock it off on transition.
390 Set( "editing.auto_fill_zones", false );
391
392 return true;
393 } );
394
395
396 registerMigration( 2, 3,
397 [&]() -> bool
398 {
399 // We used to have a bug on GTK which would set the lib tree column width way
400 // too narrow.
401 if( std::optional<int> optval = Get<int>( "lib_tree.column_width" ) )
402 {
403 if( optval < 150 )
404 Set( "lib_tree.column_width", 300 );
405 }
406
407 return true;
408 } );
409
410 registerMigration( 3, 4,
411 [&]() -> bool
412 {
413 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
414 return migrateLibTreeWidth();
415 } );
416
417 registerMigration( 4, 5,
418 [&]() -> bool
419 {
420 // This default proved to be unpopular; bump it off for everyone
421 Set( "editing.auto_fill_zones", false );
422 return true;
423 } );
424}
425
426
428
429
430bool PCBNEW_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
431{
432 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
433
434 const std::string f = getLegacyFrameName();
435
436 //
437 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
438 //
439 ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
440
441 ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
442 ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
443 ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
444 ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
445
446 ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
447 ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
448 ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
449 ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
450 ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
451 ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
452
453 ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
454 ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
455 ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
456 ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
457 ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
458 ret &= fromLegacy<int>( aCfg, "PcbDisplayOrigin", "pcb_display.origin_mode" );
459 ret &= fromLegacy<bool>( aCfg, "PcbInvertXAxis", "pcb_display.origin_invert_x_axis" );
460 ret &= fromLegacy<bool>( aCfg, "PcbInvertYAxis", "pcb_display.origin_invert_y_axis" );
461 ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
462 ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
463 ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
464 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
465 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
466 ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
467 ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
468 ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
469 ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
470 ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
471 ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
472
473 ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
474
475 {
476 nlohmann::json js = nlohmann::json::array();
477 wxString key;
478 bool val = false;
479
480 for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
481 {
482 key.Printf( wxT( "PlotSVGLayer_%d" ), i );
483
484 if( aCfg->Read( key, &val ) && val )
485 js.push_back( i );
486 }
487
488 Set( "export_svg.layers", js );
489 }
490
491 {
492 nlohmann::json js = nlohmann::json::array();
493
494 wxString packed;
495
496 if( aCfg->Read( "ActionPluginButtons", &packed ) )
497 {
498 wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
499
500 while( pluginSettingsTokenizer.HasMoreTokens() )
501 {
502 nlohmann::json row;
503 wxString plugin = pluginSettingsTokenizer.GetNextToken();
504 wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
505
506 if( pluginTokenizer.CountTokens() != 2 )
507 {
508 // Bad config
509 continue;
510 }
511
512 std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
513 bool value( pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 );
514
515 js.push_back( nlohmann::json( { { key, value } } ) );
516 }
517 }
518
519 Set( "action_plugins", js );
520 }
521
522 //
523 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
524 //
525 ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
526 ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
527 ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
528 ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
529 ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
530 ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
531
532 ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.all_layers_on_one_page" );
533 ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
534 ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
535 ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
536 ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
537 ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
538
539 ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
540 ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
541
542 migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
543
544 ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
545 ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
546
547 migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
548 ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
549
550
551 const std::string p = "pcbnew.InteractiveRouter.";
552
553 Set( "tools.pns.meta", nlohmann::json( {
554 { "filename", "pns" },
555 { "version", 0 }
556 } ) );
557
558 ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
559 ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
560 ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
561 ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
562 ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
563 ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
564 ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
565 ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
566 ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
567 ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
568 ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
569 ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
570 ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
571 ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
572 ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "editing.track_drag_action" );
573
574 // Initialize some new PNS settings to legacy behaviors if coming from legacy
575 Set( "tools.pns.fix_all_segments", false );
576
577 // Migrate color settings that were stored in the pcbnew config file
578
581
582 auto migrateLegacyColor =
583 [&] ( const std::string& aKey, int aLayerId )
584 {
585 wxString str;
586
587 if( aCfg->Read( aKey, &str ) )
588 cs->SetColor( aLayerId, COLOR4D( str ) );
589 };
590
591 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
592 {
593 wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
594 migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
595 }
596
597 migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
598 migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
599 migrateLegacyColor( "Color4DGrid", LAYER_GRID );
600 migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
601 migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
602 migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
603 migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
604 migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BLIND );
605 migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BURIED );
606 migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
607 migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
608 migrateLegacyColor( "Color4DWorksheet", LAYER_DRAWINGSHEET );
609 migrateLegacyColor( "Color4DGrid", LAYER_PAGE_LIMITS );
610
611 mgr.SaveColorSettings( cs, "board" );
612
613 Set( "appearance.color_theme", cs->GetFilename() );
614
615 double x = 0, y = 0;
616
617 if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
618 {
619 EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
620 static_cast<long>( EDA_UNITS::INCH ) ) );
621
622 // Convert to internal units
625
626 Set( "window.grid.user_grid_x", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, x ) );
627 Set( "window.grid.user_grid_y", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, y ) );
628 }
629
630 // Footprint editor settings were stored in pcbnew config file. Migrate them here.
632 fpedit->MigrateFromLegacy( aCfg );
633 fpedit->Load();
634
635 // Same with 3D viewer
637 viewer3d->MigrateFromLegacy( aCfg );
638 viewer3d->Load();
639
640 return ret;
641}
ARC_EDIT_MODE
Settings for arc editing.
@ KEEP_CENTER_ADJUST_ANGLE_RADIUS
When editing endpoints, the angle and radius are adjusted.
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:121
bool migrateWindowConfig(wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
Migrate legacy window settings into the JSON document.
void addParamsForWindow(WINDOW_SETTINGS *aWindow, const std::string &aJsonPath, int aDefaultWidth=0, int aDefaultHeight=0)
Add parameters for the given window object.
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
bool migrateLibTreeWidth()
Migrate the library tree width setting from a single column (Item) to multi-column.
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetColor(int aLayer, const COLOR4D &aColor)
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
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 fromLegacy(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig value to a given JSON pointer value.
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
std::optional< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
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...
wxString GetFilename() const
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition lset.cpp:184
Like a normal param, but with custom getter and setter functions.
Definition parameters.h:299
Represents a map of <std::string, Value>.
Definition parameters.h:752
DIALOG_EXPORT_D356 m_ExportD356
DISPLAY_OPTIONS m_Display
wxString m_LastFootprintLibDir
EDA_ANGLE m_RotationAngle
DIALOG_DRC m_DRCDialog
ARC_EDIT_MODE m_ArcEditMode
FOOTPRINT_CHOOSER m_FootprintChooser
virtual ~PCBNEW_SETTINGS()
TRACK_DRAG_ACTION m_TrackDragAction
LEADER_MODE m_AngleSnapMode
virtual std::string getLegacyFrameName() const override
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
WINDOW_SETTINGS m_FootprintWizard
FIELDS_TABLE_SETTINGS m_FieldEditorPanel
DIFF_PHASE_SKEW_SETTINGS m_DiffPhaseSkewSettings
AUI_PANELS m_AuiPanels
WINDOW_SETTINGS m_FootprintViewer
wxString m_LastFootprint3dDir
MAGNETIC_SETTINGS m_MagneticItems
FLIP_DIRECTION m_FlipDirection
SNAP_INFERENCE_SETTINGS m_SnapInference
std::unique_ptr< PNS::ROUTING_SETTINGS > m_PnsSettings
bool m_FootprintViewerAutoZoomOnSelect
true to use automatic zoom on fp selection
std::set< wxString > m_MatchProperties
Keyed as "family/Property Name"; see MATCH_PROPERTIES_CATALOG.
PCB_VIEWERS_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay
void addMatchPropertiesParam()
Opt-in.
double m_FootprintViewerZoom
The last zoom level used (0 for auto)
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition pgm_base.h:123
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely save a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
COLOR_SETTINGS * GetMigratedColorSettings()
Return a color theme for storing colors migrated from legacy (5.x and earlier) settings,...
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:424
@ TENTHS_OF_A_DEGREE_T
Definition eda_angle.h:30
static constexpr EDA_ANGLE ANGLE_360
Definition eda_angle.h:428
EDA_UNITS
Definition eda_units.h:44
LEADER_MODE
The kind of the leader line.
@ DIRECT
Unconstrained point-to-point.
@ LAYER_GRID
Definition layer_ids.h:250
@ LAYER_PAGE_LIMITS
Color for drawing the page extents (visibility stored in PCBNEW_SETTINGS::m_ShowPageLimits)
Definition layer_ids.h:334
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition layer_ids.h:235
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition layer_ids.h:274
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition layer_ids.h:277
@ LAYER_CURSOR
PCB cursor.
Definition layer_ids.h:278
@ LAYER_AUX_ITEMS
Auxiliary items (guides, rule, etc).
Definition layer_ids.h:279
@ LAYER_RATSNEST
Definition layer_ids.h:249
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition layer_ids.h:244
@ LAYER_VIA_BURIED
Draw blind vias.
Definition layer_ids.h:231
@ LAYER_VIA_BLIND
Draw micro vias.
Definition layer_ids.h:230
@ LAYER_VIA_MICROVIA
Definition layer_ids.h:229
@ LAYER_VIA_THROUGH
Draw buried vias.
Definition layer_ids.h:232
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
@ PCB_LAYER_ID_COUNT
Definition layer_ids.h:167
FLIP_DIRECTION
Definition mirror.h:23
@ LEFT_RIGHT
Flip left to right (around the Y axis)
Definition mirror.h:24
KICOMMON_API double FromUserUnit(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnit, double aValue)
Return in internal units the value aValue given in a real unit such as "in", "mm",...
KICOMMON_API wxString StringFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Return the string from aValue according to aUnits (inch, mm ...) for display.
const std::set< wxString > & DefaultKeys()
The subset enabled until the user says otherwise.
const int pcbnewSchemaVersion
! Update the schema version whenever a migration is required
@ SHOW_WITH_VIA_WHILE_ROUTING
@ PCB_ORIGIN_PAGE
TRACK_DRAG_ACTION
PGM_BASE & Pgm()
The global program "get" accessor.
see class PGM_BASE
T * GetAppSettings(const char *aFilename)
void AddSnapInferenceParams(std::vector< PARAM_BASE * > &aParams, SNAP_INFERENCE_SETTINGS &aSettings)
Register the snap inference parameters.