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 ),
75 m_PnsSettings( nullptr ),
78{
80
83 m_MagneticItems.graphics = false;
84 m_MagneticItems.allLayers = false;
85
86 m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
87 &m_AuiPanels.show_layer_manager, true ) );
88
89 m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
90 &m_AuiPanels.right_panel_width, -1 ) );
91
92 m_params.emplace_back( new PARAM<int>( "aui.net_inspector_width",
93 &m_AuiPanels.net_inspector_width, -1 ) );
94
95 m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
96 &m_AuiPanels.properties_panel_width, -1 ) );
97
98 m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
99 &m_AuiPanels.properties_splitter, 0.5f ) );
100
101 m_params.emplace_back( new PARAM<int>( "aui.search_panel_height",
102 &m_AuiPanels.search_panel_height, -1 ) );
103
104 m_params.emplace_back( new PARAM<int>( "aui.search_panel_width",
105 &m_AuiPanels.search_panel_width, -1 ) );
106
107 m_params.emplace_back( new PARAM<int>( "aui.search_panel_dock_direction",
108 &m_AuiPanels.search_panel_dock_direction, 3 ) );
109
110 m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
111 &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
112
113 m_params.emplace_back( new PARAM<bool>( "aui.appearance_expand_layer_display",
114 &m_AuiPanels.appearance_expand_layer_display, false ) );
115
116 m_params.emplace_back( new PARAM<bool>( "aui.appearance_expand_net_display",
117 &m_AuiPanels.appearance_expand_net_display, false ) );
118
119 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
120 &m_AuiPanels.show_properties, true ) );
121
122 m_params.emplace_back( new PARAM<bool>( "aui.show_git_commit_pane", &m_AuiPanels.show_git_commit_pane, false ) );
123
124 m_params.emplace_back( new PARAM<bool>( "aui.show_search",
125 &m_AuiPanels.show_search, false ) );
126
127 m_params.emplace_back( new PARAM<bool>( "aui.show_net_inspector",
128 &m_AuiPanels.show_net_inspector, false ) );
129
130 m_params.emplace_back( new PARAM<bool>( "aui.design_blocks_show",
131 &m_AuiPanels.design_blocks_show, false ) );
132
133 m_params.emplace_back( new PARAM<int>( "aui.design_blocks_panel_docked_width",
134 &m_AuiPanels.design_blocks_panel_docked_width, -1 ) );
135
136 m_params.emplace_back( new PARAM<int>( "aui.design_blocks_panel_float_width",
137 &m_AuiPanels.design_blocks_panel_float_width, -1 ) );
138
139 m_params.emplace_back( new PARAM<int>( "aui.design_blocks_panel_float_height",
140 &m_AuiPanels.design_blocks_panel_float_height, -1 ) );
141
142 m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
143 &m_FootprintChooser.width, -1 ) );
144
145 m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
146 &m_FootprintChooser.height, -1 ) );
147
148 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
149 &m_FootprintChooser.sash_h, -1 ) );
150
151 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
152 &m_FootprintChooser.sash_v, -1 ) );
153
154 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sort_mode",
155 &m_FootprintChooser.sort_mode, 0 ) );
156
157 m_params.emplace_back( new PARAM<bool>( "footprint_chooser.filter_on_pin_count",
158 &m_FootprintChooser.filter_on_pin_count, false ) );
159
160 m_params.emplace_back( new PARAM<bool>( "footprint_chooser.use_fp_filters",
161 &m_FootprintChooser.use_fp_filters, false ) );
162
163 m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
164 reinterpret_cast<bool*>( &m_FlipDirection ),
165 static_cast<bool>( FLIP_DIRECTION::LEFT_RIGHT ) ) );
166
167 m_params.emplace_back( new PARAM<bool>( "editing.esc_clears_net_highlight",
168 &m_ESCClearsNetHighlight, true ) );
169
170 m_params.emplace_back( new PARAM<bool>( "editing.show_courtyard_collisions",
171 &m_ShowCourtyardCollisions, true ) );
172
173 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
174 &m_MagneticItems.graphics, true ) );
175
176 m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
177 reinterpret_cast<int*>( &m_MagneticItems.pads ),
179
180 m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
181 reinterpret_cast<int*>( &m_MagneticItems.tracks ),
183
184 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_all_layers",
185 &m_MagneticItems.allLayers, false ) );
186
188
189 m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
190 &m_PolarCoords, false ) );
191
192 m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
193 reinterpret_cast<int*>( &m_TrackDragAction ),
194 static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
195
196 m_params.emplace_back( new PARAM<int>( "editing.arc_edit_mode",
197 reinterpret_cast<int*>( &m_ArcEditMode ),
199
200 m_params.emplace_back( new PARAM<bool>( "editing.ctrl_click_highlight",
201 &m_CtrlClickHighlight, false ) );
202
203 m_params.emplace_back( new PARAM<int>( "editing.pcb_angle_snap_mode",
204 reinterpret_cast<int*>( &m_AngleSnapMode ),
205 static_cast<int>( LEADER_MODE::DIRECT ) ) );
206
207 m_params.emplace_back( new PARAM<bool>( "editing.auto_constraints", &m_AutoConstraints, true ) );
208
209 m_params.emplace_back( new PARAM<bool>( "editing.auto_fill_zones",
210 &m_AutoRefillZones, false ) );
211
212 m_params.emplace_back( new PARAM<bool>( "editing.allow_free_pads",
213 &m_AllowFreePads, false ) );
214
215 m_params.emplace_back(
216 new PARAM<bool>( "editing.area_anchor_point_selection", &m_AreaAnchorPointSelection, false ) );
217
218 m_params.emplace_back( new PARAM<bool>( "import.keep_kicad_layer_names",
219 &m_ImportKeepKiCadLayerNames, false ) );
220
221 m_params.emplace_back( new PARAM_LAMBDA<int>( "editing.rotation_angle",
222 [this] () -> int
223 {
224 int rot = m_RotationAngle.AsTenthsOfADegree();
225
226 // Don't store values larger than 360 degrees
227 return rot % 3600;
228 },
229 [this] ( int aVal )
230 {
231 if( aVal )
233
234 // A misconfiguration allowed some angles to be stored as tenth of a degree but read
235 // as tens of degrees. By disallowing storage of values larger than 360, we can weed out
236 // those invalid values here.
237 while( m_RotationAngle > ANGLE_360 )
239
240 },
241 900 ) );
242
243 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
244 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
245
246 m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
247 &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
248
249 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
250 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
251
252 m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
253 &m_ViewersDisplay.m_DisplayTextFill, true ) );
254
255 m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
256 &m_Display.m_NetNames, 3, 0, 3 ) );
257
258 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
259 &m_Display.m_PadClearance, true ) );
260
261 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_use_via_color_for_normal_th_padstacks",
262 &m_Display.m_UseViaColorForNormalTHPadstacks, false ) );
263
264 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
265 &m_ViewersDisplay.m_DisplayPadFill, true ) );
266
267 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
268 &m_ViewersDisplay.m_DisplayPadNumbers, true ) );
269
270 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
271 &m_Display.m_ShowGlobalRatsnest, true ) );
272
273 m_params.emplace_back( new PARAM<bool>( "pcb_display.show_constraints",
274 &m_Display.m_ShowConstraints, false ) );
275
276 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
277 &m_Display.m_ShowModuleRatsnest, true ) );
278
279 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
280 &m_Display.m_DisplayRatsnestLinesCurved, false ) );
281
282 m_params.emplace_back( new PARAM<double>( "pcb_display.ratsnest_thickness",
283 &m_Display.m_RatsnestThickness, 0.5 ) );
284
285 m_params.emplace_back( new PARAM_ENUM<TRACK_CLEARANCE_MODE>( "pcb_display.track_clearance_mode",
288
289 m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
290 &m_Display.m_DisplayPcbTrackFill, true ) );
291
292 m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
293 &m_Display.m_DisplayViaFill, true ) );
294
295 m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
296 reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
298
299 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
300 &m_Display.m_DisplayInvertXAxis, false ) );
301
302 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
303 &m_Display.m_DisplayInvertYAxis, false ) );
304
305 m_params.emplace_back( new PARAM<bool>( "pcb_display.force_show_fields_when_fp_selected",
306 &m_Display.m_ForceShowFieldsWhenFPSelected, true ) );
307
308 m_params.emplace_back( new PARAM<bool>( "pcb_display.live_3d_refresh",
309 &m_Display.m_Live3DRefresh, false ) );
310
311 m_params.emplace_back( new PARAM<bool>( "pcb_display.show_page_borders",
312 &m_ShowPageLimits, true ) );
313
314 m_params.emplace_back( new PARAM_MAP<int>( "field_editor.field_widths",
315 &m_FieldEditorPanel.field_widths, {} ) );
316
317 m_params.emplace_back( new PARAM<int>( "field_editor.selection_mode",
318 &m_FieldEditorPanel.selection_mode, 0 ) );
319
320 m_params.emplace_back( new PARAM<int>( "field_editor.sash_pos",
321 &m_FieldEditorPanel.sash_pos, 400 ) );
322
323 m_params.emplace_back( new PARAM<int>( "field_editor.variant_sash_pos",
324 &m_FieldEditorPanel.variant_sash_pos, 500 ) );
325
326 m_params.emplace_back( new PARAM<bool>( "field_editor.sidebar_collapsed",
327 &m_FieldEditorPanel.sidebar_collapsed, false ) );
328
329 m_params.emplace_back( new PARAM<bool>( "export_d356.doNotExportUnconnectedPads",
330 &m_ExportD356.doNotExportUnconnectedPads, false ) );
331
332 addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
333
334 m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
335 &m_FootprintViewerZoom, 1.0 ) );
336
337 m_params.emplace_back( new PARAM<bool>( "footprint_viewer.autozoom",
339
340 m_params.emplace_back( new PARAM<int>( "footprint_viewer.lib_list_width",
342
343 m_params.emplace_back( new PARAM<int>( "footprint_viewer.fp_list_width",
345
346 addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
347
348 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
349 &m_LastFootprintLibDir, "" ) );
350
351 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
352 &m_LastFootprint3dDir, "" ) );
353
354 m_params.emplace_back( new PARAM<bool>( "DRC.report_all_track_errors",
355 &m_DRCDialog.report_all_track_errors, false ) );
356
357 m_params.emplace_back( new PARAM<bool>( "DRC.crossprobe",
358 &m_DRCDialog.crossprobe, true ) );
359
360 m_params.emplace_back( new PARAM<bool>( "DRC.scroll_on_crossprobe",
361 &m_DRCDialog.scroll_on_crossprobe, true ) );
362
363 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.zero_color",
364 &m_DiffPhaseSkewSettings.m_ZeroSkewColor, COLOR4D( 1.0, 1.0, 1.0, 1.0 ) ) );
365
366 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.positive_color",
367 &m_DiffPhaseSkewSettings.m_PositiveSkewColor, COLOR4D( 0.0, 0.0, 1.0, 1.0 ) ) );
368
369 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.negative_color",
370 &m_DiffPhaseSkewSettings.m_NegativeSkewColor, COLOR4D( 1.0, 0.0, 0.0, 1.0 ) ) );
371
372 m_params.emplace_back( new PARAM<COLOR4D>( "diff_phase_skew.unknown_color",
373 &m_DiffPhaseSkewSettings.m_UnknownSkewColor, COLOR4D( 0.5, 0.5, 0.5, 1.0 ) ) );
374
375 m_params.emplace_back( new PARAM<bool>( "diff_phase_skew.use_log_scale",
376 &m_DiffPhaseSkewSettings.m_UseLogScale, false ) );
377
378 registerMigration( 0, 1,
379 [&]()
380 {
381 if( std::optional<int> optval = Get<int>( "pcb_display.rotation_angle" ) )
382 Set( "editing.rotation_angle", *optval );
383
384 try
385 {
386 At( "pcb_display" ).erase( "rotation_angle" );
387 }
388 catch( ... )
389 {}
390
391 return true;
392 } );
393
394 registerMigration( 1, 2,
395 [&]()
396 {
397 // In version 1 this meant "after Zone Properties dialog", but it now means
398 // "everywhere" so we knock it off on transition.
399 Set( "editing.auto_fill_zones", false );
400
401 return true;
402 } );
403
404
405 registerMigration( 2, 3,
406 [&]() -> bool
407 {
408 // We used to have a bug on GTK which would set the lib tree column width way
409 // too narrow.
410 if( std::optional<int> optval = Get<int>( "lib_tree.column_width" ) )
411 {
412 if( optval < 150 )
413 Set( "lib_tree.column_width", 300 );
414 }
415
416 return true;
417 } );
418
419 registerMigration( 3, 4,
420 [&]() -> bool
421 {
422 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
423 return migrateLibTreeWidth();
424 } );
425
426 registerMigration( 4, 5,
427 [&]() -> bool
428 {
429 // This default proved to be unpopular; bump it off for everyone
430 Set( "editing.auto_fill_zones", false );
431 return true;
432 } );
433}
434
435
437
438
439bool PCBNEW_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
440{
441 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
442
443 const std::string f = getLegacyFrameName();
444
445 //
446 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
447 //
448 ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
449
450 ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
451 ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
452 ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
453 ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
454
455 ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
456 ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
457 ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
458 ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
459 ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
460 ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
461
462 ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
463 ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
464 ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
465 ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
466 ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
467 ret &= fromLegacy<int>( aCfg, "PcbDisplayOrigin", "pcb_display.origin_mode" );
468 ret &= fromLegacy<bool>( aCfg, "PcbInvertXAxis", "pcb_display.origin_invert_x_axis" );
469 ret &= fromLegacy<bool>( aCfg, "PcbInvertYAxis", "pcb_display.origin_invert_y_axis" );
470 ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
471 ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
472 ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
473 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
474 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
475 ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
476 ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
477 ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
478 ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
479 ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
480 ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
481
482 ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
483
484 {
485 nlohmann::json js = nlohmann::json::array();
486 wxString key;
487 bool val = false;
488
489 for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
490 {
491 key.Printf( wxT( "PlotSVGLayer_%d" ), i );
492
493 if( aCfg->Read( key, &val ) && val )
494 js.push_back( i );
495 }
496
497 Set( "export_svg.layers", js );
498 }
499
500 {
501 nlohmann::json js = nlohmann::json::array();
502
503 wxString packed;
504
505 if( aCfg->Read( "ActionPluginButtons", &packed ) )
506 {
507 wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
508
509 while( pluginSettingsTokenizer.HasMoreTokens() )
510 {
511 nlohmann::json row;
512 wxString plugin = pluginSettingsTokenizer.GetNextToken();
513 wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
514
515 if( pluginTokenizer.CountTokens() != 2 )
516 {
517 // Bad config
518 continue;
519 }
520
521 std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
522 bool value( pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 );
523
524 js.push_back( nlohmann::json( { { key, value } } ) );
525 }
526 }
527
528 Set( "action_plugins", js );
529 }
530
531 //
532 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
533 //
534 ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
535 ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
536 ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
537 ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
538 ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
539 ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
540
541 ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.all_layers_on_one_page" );
542 ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
543 ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
544 ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
545 ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
546 ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
547
548 ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
549 ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
550
551 migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
552
553 ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
554 ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
555
556 migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
557 ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
558
559
560 const std::string p = "pcbnew.InteractiveRouter.";
561
562 Set( "tools.pns.meta", nlohmann::json( {
563 { "filename", "pns" },
564 { "version", 0 }
565 } ) );
566
567 ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
568 ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
569 ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
570 ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
571 ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
572 ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
573 ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
574 ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
575 ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
576 ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
577 ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
578 ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
579 ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
580 ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
581 ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "editing.track_drag_action" );
582
583 // Initialize some new PNS settings to legacy behaviors if coming from legacy
584 Set( "tools.pns.fix_all_segments", false );
585
586 // Migrate color settings that were stored in the pcbnew config file
587
590
591 auto migrateLegacyColor =
592 [&] ( const std::string& aKey, int aLayerId )
593 {
594 wxString str;
595
596 if( aCfg->Read( aKey, &str ) )
597 cs->SetColor( aLayerId, COLOR4D( str ) );
598 };
599
600 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
601 {
602 wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
603 migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
604 }
605
606 migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
607 migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
608 migrateLegacyColor( "Color4DGrid", LAYER_GRID );
609 migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
610 migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
611 migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
612 migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
613 migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BLIND );
614 migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BURIED );
615 migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
616 migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
617 migrateLegacyColor( "Color4DWorksheet", LAYER_DRAWINGSHEET );
618 migrateLegacyColor( "Color4DGrid", LAYER_PAGE_LIMITS );
619
620 mgr.SaveColorSettings( cs, "board" );
621
622 Set( "appearance.color_theme", cs->GetFilename() );
623
624 double x = 0, y = 0;
625
626 if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
627 {
628 EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
629 static_cast<long>( EDA_UNITS::INCH ) ) );
630
631 // Convert to internal units
634
635 Set( "window.grid.user_grid_x", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, x ) );
636 Set( "window.grid.user_grid_y", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, y ) );
637 }
638
639 // Footprint editor settings were stored in pcbnew config file. Migrate them here.
641 fpedit->MigrateFromLegacy( aCfg );
642 fpedit->Load();
643
644 // Same with 3D viewer
646 viewer3d->MigrateFromLegacy( aCfg );
647 viewer3d->Load();
648
649 return ret;
650}
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:128
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...
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...
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
Stores an enum as an integer.
Definition parameters.h:232
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:124
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:474
@ TENTHS_OF_A_DEGREE_T
Definition eda_angle.h:29
static constexpr EDA_ANGLE ANGLE_360
Definition eda_angle.h:478
EDA_UNITS
Definition eda_units.h:45
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:26
@ LEFT_RIGHT
Flip left to right (around the Y axis)
Definition mirror.h:27
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
@ DO_NOT_SHOW_CLEARANCE
@ SHOW_WITH_VIA_ALWAYS
@ 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.
struct DROP_TABLE cs