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