KiCad PCB EDA Suite
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 (C) 2020 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 <pcbnew_settings.h>
28 #include <pgm_base.h>
32 #include <settings/parameters.h>
34 #include <wx/config.h>
35 #include <wx/tokenzr.h>
36 #include <zones.h>
37 #include <widgets/ui_common.h>
38 #include <base_units.h>
39 
40 #include "../3d-viewer/3d_viewer/3d_viewer_settings.h"
41 
42 
44 const int pcbnewSchemaVersion = 0;
45 
46 
49  m_AuiPanels(),
50  m_Cleanup(),
51  m_DrcDialog(),
52  m_ExportIdf(),
53  m_ExportStep(),
54  m_ExportSvg(),
55  m_ExportVrml(),
56  m_FootprintWizardList(),
57  m_GenDrill(),
58  m_ImportGraphics(),
59  m_NetlistDialog(),
60  m_PlaceFile(),
61  m_Plot(),
62  m_FootprintChooser(),
63  m_Zones(),
64  m_FootprintViewer(),
65  m_FootprintWizard(),
66  m_Display(),
67  m_TrackDragAction( TRACK_DRAG_ACTION::DRAG ),
68  m_Use45DegreeGraphicSegments( false ),
69  m_FlipLeftRight( false ),
70  m_PolarCoords( false ),
71  m_RotationAngle( 900 ),
72  m_PlotLineWidth( 0.1 ),
73  m_ShowPageLimits( true ),
74  m_PnsSettings( nullptr ),
75  m_FootprintViewerAutoZoom( false ),
76  m_FootprintViewerZoom( 1.0 )
77 {
80  m_MagneticItems.graphics = false;
81 
82  m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
84 
85  m_params.emplace_back( new PARAM<bool>( "aui.show_microwave_tools",
87 
88  m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
89  &m_FootprintChooser.width, -1 ) );
90 
91  m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
92  &m_FootprintChooser.height, -1 ) );
93 
94  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
95  &m_FootprintChooser.sash_h, -1 ) );
96 
97  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
98  &m_FootprintChooser.sash_v, -1 ) );
99 
100  m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right", &m_FlipLeftRight, true ) );
101 
102  m_params.emplace_back(
103  new PARAM<bool>( "editing.magnetic_graphics", &m_MagneticItems.graphics, true ) );
104 
105  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
106  reinterpret_cast<int*>( &m_MagneticItems.pads ),
107  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
108 
109  m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
110  reinterpret_cast<int*>( &m_MagneticItems.tracks ),
111  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
112 
113  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords", &m_PolarCoords, false ) );
114 
115  m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
116  reinterpret_cast<int*>( &m_TrackDragAction ),
117  static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
118 
119  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
120  &m_Use45DegreeGraphicSegments, false ) );
121 
122  m_params.emplace_back( new PARAM<bool>(
123  "pcb_display.graphic_items_fill", &m_Display.m_DisplayGraphicsFill, true ) );
124 
125  m_params.emplace_back( new PARAM<int>(
126  "pcb_display.max_links_shown", &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
127 
128  m_params.emplace_back( new PARAM<bool>(
129  "pcb_display.graphics_fill", &m_Display.m_DisplayGraphicsFill, true ) );
130 
131  m_params.emplace_back( new PARAM<bool>(
132  "pcb_display.text_fill", &m_Display.m_DisplayTextFill, true ) );
133 
134  m_params.emplace_back( new PARAM<int>(
135  "pcb_display.net_names_mode", &m_Display.m_DisplayNetNamesMode, 3, 0, 3 ) );
136 
137  m_params.emplace_back(
138  new PARAM<bool>( "pcb_display.pad_clearance", &m_Display.m_DisplayPadIsol, true ) );
139 
140  m_params.emplace_back(
141  new PARAM<bool>( "pcb_display.pad_fill", &m_Display.m_DisplayPadFill, true ) );
142 
143  m_params.emplace_back(
144  new PARAM<bool>( "pcb_display.pad_numbers", &m_Display.m_DisplayPadNum, true ) );
145 
146  m_params.emplace_back( new PARAM<bool>(
147  "pcb_display.ratsnest_global", &m_Display.m_ShowGlobalRatsnest, true ) );
148 
149  m_params.emplace_back( new PARAM<bool>(
150  "pcb_display.ratsnest_footprint", &m_Display.m_ShowModuleRatsnest, true ) );
151 
152  m_params.emplace_back( new PARAM<bool>(
153  "pcb_display.ratsnest_curved", &m_Display.m_DisplayRatsnestLinesCurved, false ) );
154 
155  m_params.emplace_back( new PARAM<int>(
156  "pcb_display.rotation_angle", &m_RotationAngle, 900, 1, 900 ) );
157 
158  m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
159  reinterpret_cast<int*>( &m_Display.m_ShowTrackClearanceMode ),
161 
162  m_params.emplace_back(
163  new PARAM<bool>( "pcb_display.track_fill", &m_Display.m_DisplayPcbTrackFill, true ) );
164 
165  m_params.emplace_back(
166  new PARAM<bool>( "pcb_display.via_fill", &m_Display.m_DisplayViaFill, true ) );
167 
168  m_params.emplace_back(
169  new PARAM<int>( "pcb_display.zone_mode", &m_Display.m_DisplayZonesMode, 0, 0, 2 ) );
170 
171  m_params.emplace_back(
172  new PARAM<double>( "plot.line_width", &m_PlotLineWidth, 0.1, 0.01, 5.0 ) );
173 
174  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
175  &m_Cleanup.cleanup_vias, true ) );
176 
177  m_params.emplace_back( new PARAM<bool>( "cleanup.delete_dangling_vias",
178  &m_Cleanup.delete_dangling_vias, true ) );
179 
180  m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
181  &m_Cleanup.merge_segments, true ) );
182 
183  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
184  &m_Cleanup.cleanup_unconnected, true ) );
185 
186  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
188 
189  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
190  &m_Cleanup.cleanup_tracks_in_pad, true ) );
191 
192  m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
193  &m_DrcDialog.refill_zones, false ) );
194 
195  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_track_to_zone",
196  &m_DrcDialog.test_track_to_zone, false ) );
197 
198  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
199  &m_DrcDialog.test_footprints, false ) );
200 
201  m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
203 
204  m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
205  &m_GenDrill.merge_pth_npth, false ) );
206 
207  m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
208  &m_GenDrill.minimal_header, false ) );
209 
210  m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror", &m_GenDrill.mirror, false ) );
211 
212  m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
213  &m_GenDrill.unit_drill_is_inch, true ) );
214 
215  m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
217 
218  m_params.emplace_back( new PARAM<int>(
219  "gen_drill.drill_file_type", &m_GenDrill.drill_file_type, 0 ) );
220 
221  m_params.emplace_back( new PARAM<int>(
222  "gen_drill.map_file_type", &m_GenDrill.map_file_type, 1 ) );
223 
224  m_params.emplace_back( new PARAM<int>(
225  "gen_drill.zeros_format", &m_GenDrill.zeros_format, 0, 0, 3 ) );
226 
227  m_params.emplace_back(
228  new PARAM<bool>( "export_idf.auto_adjust", &m_ExportIdf.auto_adjust, false ) );
229 
230  m_params.emplace_back( new PARAM<int>( "export_idf.ref_units", &m_ExportIdf.ref_units, 0 ) );
231 
232  m_params.emplace_back( new PARAM<double>( "export_idf.ref_x", &m_ExportIdf.ref_x, 0 ) );
233 
234  m_params.emplace_back( new PARAM<double>( "export_idf.ref_y", &m_ExportIdf.ref_y, 0 ) );
235 
236  m_params.emplace_back(
237  new PARAM<bool>( "export_idf.units_mils", &m_ExportIdf.units_mils, false ) );
238 
239  m_params.emplace_back(
240  new PARAM<int>( "export_step.origin_mode", &m_ExportStep.origin_mode, 0 ) );
241 
242  m_params.emplace_back(
243  new PARAM<int>( "export_step.origin_units", &m_ExportStep.origin_units, 0 ) );
244 
245  m_params.emplace_back( new PARAM<double>( "export_step.origin_x", &m_ExportStep.origin_x, 0 ) );
246 
247  m_params.emplace_back( new PARAM<double>( "export_step.origin_y", &m_ExportStep.origin_y, 0 ) );
248 
249  m_params.emplace_back(
250  new PARAM<bool>( "export_step.no_virtual", &m_ExportStep.no_virtual, false ) );
251 
252  m_params.emplace_back(
253  new PARAM<bool>( "export_svg.black_and_white", &m_ExportSvg.black_and_white, false ) );
254 
255  m_params.emplace_back(
256  new PARAM<bool>( "export_svg.mirror", &m_ExportSvg.mirror, false ) );
257 
258  m_params.emplace_back( new PARAM<bool>( "export_svg.one_file", &m_ExportSvg.one_file, false ) );
259 
260  m_params.emplace_back(new PARAM<bool>(
261  "export_svg.plot_board_edges", &m_ExportSvg.plot_board_edges, true ) );
262 
263  m_params.emplace_back( new PARAM<int>( "export_svg.page_size", &m_ExportSvg.page_size, 0 ) );
264 
265  m_params.emplace_back(
266  new PARAM<wxString>( "export_svg.output_dir", &m_ExportSvg.output_dir, "" ) );
267 
268  m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers", &m_ExportSvg.layers, {} ) );
269 
270  m_params.emplace_back( new PARAM<int>( "export_vrml.units", &m_ExportVrml.units, 1 ) );
271 
272  m_params.emplace_back( new PARAM<bool>(
273  "export_vrml.copy_3d_models", &m_ExportVrml.copy_3d_models, false ) );
274 
275  m_params.emplace_back( new PARAM<bool>(
276  "export_vrml.use_relative_paths", &m_ExportVrml.use_relative_paths, false ) );
277 
278  m_params.emplace_back( new PARAM<bool>(
279  "export_vrml.use_plain_pcb", &m_ExportVrml.use_plain_pcb, false ) );
280 
281  m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units", &m_ExportVrml.ref_units, 0 ) );
282 
283  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x", &m_ExportVrml.ref_x, 0 ) );
284 
285  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y", &m_ExportVrml.ref_y, 0 ) );
286 
287  m_params.emplace_back( new PARAM<int>( "zones.hatching_style", &m_Zones.hatching_style, 0 ) );
288 
289  m_params.emplace_back( new PARAM<wxString>( "zones.net_filter", &m_Zones.net_filter, "" ) );
290 
291  m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode", &m_Zones.net_sort_mode, 1 ) );
292 
293  m_params.emplace_back(
294  new PARAM<double>( "zones.clearance", &m_Zones.clearance, ZONE_CLEARANCE_MIL ) );
295 
296  m_params.emplace_back( new PARAM<double>( "zones.min_thickness",
298 
299  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_gap",
301 
302  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_copper_width",
304 
305  m_params.emplace_back(
306  new PARAM<int>( "import_graphics.layer", &m_ImportGraphics.layer, Dwgs_User ) );
307 
308  m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
310 
311  m_params.emplace_back( new PARAM<int>(
312  "import_graphics.line_width_units", &m_ImportGraphics.line_width_units, 0 ) );
313 
314  m_params.emplace_back(
315  new PARAM<double>( "import_graphics.line_width", &m_ImportGraphics.line_width, 0.2 ) );
316 
317  m_params.emplace_back(
318  new PARAM<int>( "import_graphics.origin_units", &m_ImportGraphics.origin_units, 0 ) );
319 
320  m_params.emplace_back(
321  new PARAM<double>( "import_graphics.origin_x", &m_ImportGraphics.origin_x, 0 ) );
322 
323  m_params.emplace_back(
324  new PARAM<double>( "import_graphics.origin_y", &m_ImportGraphics.origin_y, 0 ) );
325 
326  m_params.emplace_back(
327  new PARAM<int>( "netlist.report_filter", &m_NetlistDialog.report_filter, -1 ) );
328 
329  m_params.emplace_back( new PARAM<bool>(
330  "netlist.update_footprints", &m_NetlistDialog.update_footprints, true ) );
331 
332  m_params.emplace_back( new PARAM<bool>(
333  "netlist.delete_shorting_tracks", &m_NetlistDialog.delete_shorting_tracks, false ) );
334 
335  m_params.emplace_back( new PARAM<bool>(
336  "netlist.delete_extra_footprints", &m_NetlistDialog.delete_extra_footprints, false ) );
337 
338  m_params.emplace_back( new PARAM<bool>(
339  "netlist.delete_single_pad_nets", &m_NetlistDialog.delete_single_pad_nets, false ) );
340 
341  m_params.emplace_back( new PARAM<bool>(
342  "netlist.associate_by_ref_sch", &m_NetlistDialog.associate_by_ref_sch, false ) );
343 
344  m_params.emplace_back(new PARAM<int>( "place_file.units", &m_PlaceFile.units, 1 ) );
345 
346  m_params.emplace_back(
347  new PARAM<int>( "place_file.file_options", &m_PlaceFile.file_options, 0 ) );
348 
349  m_params.emplace_back(
350  new PARAM<int>( "place_file.file_format", &m_PlaceFile.file_format, 0 ) );
351 
352  m_params.emplace_back( new PARAM<bool>(
353  "place_file.include_board_edge", &m_PlaceFile.include_board_edge, false ) );
354 
355  m_params.emplace_back( new PARAM<int>( "plot.one_page_per_layer",
356  &m_Plot.one_page_per_layer, 1 ) );
357 
358  m_params.emplace_back(
359  new PARAM<int>( "plot.pads_drill_mode", &m_Plot.pads_drill_mode, 2 ) );
360 
361  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x", &m_Plot.fine_scale_x, 0 ) );
362 
363  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y", &m_Plot.fine_scale_y, 0 ) );
364 
365  m_params.emplace_back(
366  new PARAM<double>( "plot.ps_fine_width_adjust", &m_Plot.ps_fine_width_adjust, 0 ) );
367 
368  m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
370 
371  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
372  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
373 
374  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.width",
375  &m_FootprintWizardList.width, -1 ) );
376 
377  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
378  &m_FootprintWizardList.height, -1 ) );
379 
380 #if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU)
381  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
382  [&]() -> nlohmann::json
383  {
384  nlohmann::json js = nlohmann::json::array();
385 
386  for( const auto& pair : m_VisibleActionPlugins )
387  js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
388 
389  return js;
390  },
391  [&]( const nlohmann::json& aObj )
392  {
393  m_VisibleActionPlugins.clear();
394 
395  if( !aObj.is_array() )
396  {
397  return;
398  }
399 
400  for( const auto& entry : aObj )
401  {
402  if( entry.empty() || !entry.is_object() )
403  continue;
404 
405  for( const auto& pair : entry.items() )
406  {
407  m_VisibleActionPlugins.emplace_back( std::make_pair(
408  wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
409  }
410  }
411  },
412  nlohmann::json::array() ) );
413 #endif
414 
415  addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
416 
417  m_params.emplace_back( new PARAM<bool>( "footprint_viewer.auto_zoom",
418  &m_FootprintViewerAutoZoom, false ) );
419 
420  m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
421  &m_FootprintViewerZoom, 1.0 ) );
422 
423  addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
424 }
425 
426 
428 
429 
430 bool 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  ret &= fromLegacy<bool>( aCfg, "ShowMicrowaveTools", "aui.show_microwave_tools" );
441 
442  ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
443  ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
444  ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
445  ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
446 
447  ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
448  ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
449  ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
450  ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
451  ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
452  ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments",
453  "editing.use_45_degree_graphic_segments" );
454 
455  ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
456  ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
457  ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
458  ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
459  ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
460  ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
461  ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
462  ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
463  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
464  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
465  ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
466  ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
467  ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
468  ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
469  ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
470  ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
471 
472  ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
473 
474  aCfg->SetPath( "/dialogs/cleanup_tracks" );
475  ret &= fromLegacy<bool>( aCfg, "DialogCleanupVias", "cleanup.cleanup_vias" );
476  ret &= fromLegacy<bool>( aCfg, "DialogCleanupMergeSegments", "cleanup.merge_segments" );
477  ret &= fromLegacy<bool>( aCfg, "DialogCleanupUnconnected", "cleanup.cleanup_unconnected" );
478  ret &= fromLegacy<bool>( aCfg, "DialogCleanupShortCircuit", "cleanup.cleanup_short_circuits" );
479  ret &= fromLegacy<bool>( aCfg, "DialogCleanupTracksInPads", "cleanup.cleanup_tracks_in_pad" );
480  aCfg->SetPath( "../.." );
481 
482  ret &= fromLegacy<bool>( aCfg, "RefillZonesBeforeDrc", "drc_dialog.refill_zones" );
483  ret &= fromLegacy<bool>( aCfg, "DrcTrackToZoneTest", "drc_dialog.test_track_to_zone" );
484  ret &= fromLegacy<bool>( aCfg, "DrcTestFootprints", "drc_dialog.test_footprints" );
485 
486  ret &= fromLegacy<bool>( aCfg, "DrillMergePTHNPTH", "gen_drill.merge_pth_npth" );
487  ret &= fromLegacy<bool>( aCfg, "DrillMinHeader", "gen_drill.minimal_header" );
488  ret &= fromLegacy<bool>( aCfg, "DrillMirrorYOpt", "gen_drill.mirror" );
489  ret &= fromLegacy<bool>( aCfg, "DrillUnit", "gen_drill.unit_drill_is_inch" );
490  ret &= fromLegacy<bool>( aCfg, "OvalHolesRouteMode", "gen_drill.use_route_for_oval_holes" );
491  ret &= fromLegacy<int>( aCfg, "DrillFileType", "gen_drill.drill_file_type" );
492  ret &= fromLegacy<int>( aCfg, "DrillMapFileType", "gen_drill.map_file_type" );
493  ret &= fromLegacy<int>( aCfg, "DrillZerosFormat", "gen_drill.zeros_format" );
494 
495  ret &= fromLegacy<bool>( aCfg, "IDFRefAutoAdj", "export_idf.auto_adjust" );
496  ret &= fromLegacy<int>( aCfg, "IDFRefUnits", "export_idf.ref_units" );
497  ret &= fromLegacy<double>( aCfg, "IDFRefX", "export_idf.ref_x" );
498  ret &= fromLegacy<double>( aCfg, "IDFRefY", "export_idf.ref_y" );
499  ret &= fromLegacy<bool>( aCfg, "IDFExportThou", "export_idf.units_mils" );
500 
501  ret &= fromLegacy<int>( aCfg, "STEP_Origin_Opt", "export_step.origin_mode" );
502  ret &= fromLegacy<int>( aCfg, "STEP_UserOriginUnits", "export_step.origin_units" );
503  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginX", "export_step.origin_x" );
504  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginY", "export_step.origin_y" );
505  ret &= fromLegacy<bool>( aCfg, "STEP_NoVirtual", "export_step.no_virtual" );
506 
507  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeColor", "export_svg.black_and_white" );
508  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeMirror", "export_svg.mirror" );
509  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeOneFile", "export_svg.one_file" );
510  ret &= fromLegacy<bool>( aCfg, "PlotSVGBrdEdge", "export_svg.plot_board_edges" );
511  ret &= fromLegacy<int>( aCfg, "PlotSVGPageOpt", "export_svg.page_size" );
512  ret &= fromLegacyString( aCfg, "PlotSVGDirectory", "export_svg.output_dir" );
513 
514  {
515  nlohmann::json js = nlohmann::json::array();
516  wxString key;
517  bool val = false;
518 
519  for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
520  {
521  key.Printf( wxT( "PlotSVGLayer_%d" ), i );
522 
523  if( aCfg->Read( key, &val ) && val )
524  js.push_back( i );
525  }
526 
527  ( *this )[PointerFromString( "export_svg.layers" ) ] = js;
528  }
529 
530  {
531  nlohmann::json js = nlohmann::json::array();
532 
533  wxString packed;
534 
535  if( aCfg->Read( "ActionPluginButtons", &packed ) )
536  {
537  wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
538 
539  while( pluginSettingsTokenizer.HasMoreTokens() )
540  {
541  nlohmann::json row;
542  wxString plugin = pluginSettingsTokenizer.GetNextToken();
543  wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
544 
545  if( pluginTokenizer.CountTokens() != 2 )
546  {
547  // Bad config
548  continue;
549  }
550 
551  std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
552 
553  js.push_back( nlohmann::json( {
554  { key, pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 } } ) );
555  }
556  }
557 
558  ( *this )[PointerFromString( "action_plugins" ) ] = js;
559  }
560 
561  //
562  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
563  //
564  ret &= fromLegacy<int>( aCfg, "VrmlExportUnit", "export_vrml.units" );
565  ret &= fromLegacy<bool>( aCfg, "VrmlExportCopyFiles", "export_vrml.copy_3d_models" );
566  ret &= fromLegacy<bool>( aCfg, "VrmlUseRelativePaths", "export_vrml.use_relative_paths" );
567  ret &= fromLegacy<bool>( aCfg, "VrmlUsePlainPCB", "export_vrml.use_plain_pcb" );
568  ret &= fromLegacy<int>( aCfg, "VrmlRefUnits", "export_vrml.ref_units" );
569  ret &= fromLegacy<double>( aCfg, "VrmlRefX", "export_vrml.ref_x" );
570  ret &= fromLegacy<double>( aCfg, "VrmlRefY", "export_vrml.ref_y" );
571 
572  ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
573  ret &= fromLegacyString( aCfg, "Zone_Filter_Opt", "zones.net_filter" );
574  ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
575  ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
576  ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
577  ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
578  ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
579 
580  aCfg->SetPath( "ImportGraphics" );
581  ret &= fromLegacy<int>( aCfg, "BoardLayer", "import_graphics.layer" );
582  ret &= fromLegacy<bool>( aCfg, "InteractivePlacement", "import_graphics.interactive_placement" );
583  ret &= fromLegacyString( aCfg, "LastFile", "import_graphics.last_file" );
584  ret &= fromLegacy<double>( aCfg, "LineWidth", "import_graphics.line_width" );
585  ret &= fromLegacy<int>( aCfg, "LineWidthUnits", "import_graphics.line_width_units" );
586  ret &= fromLegacy<int>( aCfg, "PositionUnits", "import_graphics.origin_units" );
587  ret &= fromLegacy<double>( aCfg, "PositionX", "import_graphics.origin_x" );
588  ret &= fromLegacy<double>( aCfg, "PositionY", "import_graphics.origin_y" );
589  aCfg->SetPath( ".." );
590 
591  ret &= fromLegacy<int>( aCfg, "NetlistReportFilterMsg", "netlist.report_filter" );
592  ret &= fromLegacy<bool>( aCfg, "NetlistUpdateFootprints", "netlist.update_footprints" );
593  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteShortingTracks", "netlist.delete_shorting_tracks" );
594  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteExtraFootprints", "netlist.delete_extra_footprints" );
595  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteSinglePadNets", "netlist.delete_single_pad_nets" );
596 
597  ret &= fromLegacy<int>( aCfg, "PlaceFileUnits", "place_file.units" );
598  ret &= fromLegacy<int>( aCfg, "PlaceFileOpts", "place_file.file_options" );
599  ret &= fromLegacy<int>( aCfg, "PlaceFileFormat", "place_file.file_format" );
600  ret &= fromLegacy<bool>( aCfg, "PlaceFileIncludeBrdEdge", "place_file.include_board_edge" );
601 
602  ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.one_page_per_layer" );
603  ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
604  ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
605  ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
606  ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
607  ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
608 
609  ret &= fromLegacyString( aCfg, "FootprintTextShownColumns", "window.footprint_text_shown_columns" );
610 
611  ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
612  ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
613 
614  migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
615 
616  ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
617  ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
618 
619  migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
620  ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
621 
622 
623  const std::string p = "pcbnew.InteractiveRouter.";
624 
625  ( *this )[PointerFromString( "tools.pns.meta" )] = nlohmann::json( {
626  { "filename", "pns" },
627  { "version", 0 }
628  } );
629 
630  ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
631  ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
632  ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
633  ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
634  ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
635  ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
636  ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
637  ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
638  ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
639  ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
640  ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
641  ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
642  ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
643  ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
644  ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "tools.pns.inline_drag" );
645 
646  // Migrate color settings that were stored in the pcbnew config file
647 
648  COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetColorSettings();
649 
650  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
651  wxString str;
652 
653  if( aCfg->Read( aKey, &str ) )
654  cs->SetColor( aLayerId, COLOR4D( str ) );
655  };
656 
657  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
658  {
659  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
660  migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
661  }
662 
663  migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
664  migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
665  migrateLegacyColor( "Color4DGrid", LAYER_GRID );
666  migrateLegacyColor( "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
667  migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
668  migrateLegacyColor( "Color4DPadBackEx", LAYER_PAD_BK );
669  migrateLegacyColor( "Color4DPadFrontEx", LAYER_PAD_FR );
670  migrateLegacyColor( "Color4DPadThruHoleEx", LAYER_PADS_TH );
671  migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
672  migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
673  migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
674  migrateLegacyColor( "Color4DTxtBackEx", LAYER_MOD_TEXT_BK );
675  migrateLegacyColor( "Color4DTxtFrontEx", LAYER_MOD_TEXT_FR );
676  migrateLegacyColor( "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
677  migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
678  migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
679  migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
680  migrateLegacyColor( "Color4DWorksheet", LAYER_WORKSHEET );
681 
682  Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
683 
684  double x, y;
685 
686  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
687  {
688  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
689  static_cast<long>( EDA_UNITS::INCHES ) ) );
690 
691  // Convert to internal units
692  x = From_User_Unit( u, x );
693  y = From_User_Unit( u, y );
694 
695  ( *this )[PointerFromString( "window.grid.user_grid_x" )] = StringFromValue( u, x, true, true );
696  ( *this )[PointerFromString( "window.grid.user_grid_y" )] = StringFromValue( u, y, true, true );
697  }
698 
699  // Footprint editor settings were stored in pcbnew config file. Migrate them here.
700  auto fpedit = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( false );
701  fpedit->MigrateFromLegacy( aCfg );
702  fpedit->Load();
703 
704  // Same with 3D viewer
705  auto viewer3d = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( false );
706  viewer3d->MigrateFromLegacy( aCfg );
707  viewer3d->Load();
708 
709  return ret;
710 }
DIALOG_GENERATE_DRILL m_GenDrill
EDA_UNITS
Definition: common.h:198
void addParamsForWindow(WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
Adds parameters for the given window object.
to draw blind/buried vias
show a marker on pads with no nets
DIALOG_EXPORT_STEP m_ExportStep
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
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
multilayer pads, usually with holes
Implementation of conversion functions that require both schematic and board internal units.
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)
DIALOG_EXPORT_IDF m_ExportIdf
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
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
TRACK_DRAG_ACTION
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
PCB_LAYER_ID
A quick note on layer IDs:
DIALOG_EXPORT_SVG m_ExportSvg
Auxiliary items (guides, rule, etc)
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
TRACK_DRAG_ACTION m_TrackDragAction
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Function Name returns the fixed name association with aLayerId.
Definition: lset.cpp:78
DIALOG_NETLIST m_NetlistDialog
to draw usual through hole vias
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
Functions to provide common constants and other functions to assist in making a consistent UI.
#define ZONE_CLEARANCE_MIL
Definition: zones.h:33
WINDOW_SETTINGS m_FootprintViewer
#define ZONE_THICKNESS_MIL
Definition: zones.h:31
virtual std::string getLegacyFrameName() const override
DIALOG_PLACE_FILE m_PlaceFile
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
see class PGM_BASE
virtual ~PCBNEW_SETTINGS()
Board layer functions and definitions.
MAGNETIC_OPTIONS pads
AUI_PANELS m_AuiPanels
The common library.
DIALOG_PLOT m_Plot
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
Color settings are a bit different than most of the settings objects in that there can be more than o...
#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
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.
MAGNETIC_OPTIONS tracks
void SetColor(int aLayer, COLOR4D aColor)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99