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_AddUnlockedPads( false ),
71  m_PolarCoords( false ),
72  m_RotationAngle( 900 ),
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<int>( "aui.right_panel_width",
87 
88  m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
89  &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
90 
91  m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
92  &m_FootprintChooser.width, -1 ) );
93 
94  m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
95  &m_FootprintChooser.height, -1 ) );
96 
97  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
98  &m_FootprintChooser.sash_h, -1 ) );
99 
100  m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
101  &m_FootprintChooser.sash_v, -1 ) );
102 
103  m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
104  &m_FlipLeftRight, true ) );
105 
106  m_params.emplace_back( new PARAM<bool>( "editing.add_unlocked_pads",
107  &m_AddUnlockedPads, false ) );
108 
109  m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
110  &m_MagneticItems.graphics, true ) );
111 
112  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
113  reinterpret_cast<int*>( &m_MagneticItems.pads ),
114  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
115 
116  m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
117  reinterpret_cast<int*>( &m_MagneticItems.tracks ),
118  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
119 
120  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
121  &m_PolarCoords, false ) );
122 
123  m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
124  reinterpret_cast<int*>( &m_TrackDragAction ),
125  static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
126 
127  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
128  &m_Use45DegreeGraphicSegments, false ) );
129 
130  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
131  &m_Display.m_DisplayGraphicsFill, true ) );
132 
133  m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
134  &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
135 
136  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
137  &m_Display.m_DisplayGraphicsFill, true ) );
138 
139  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
140  &m_Display.m_DisplayTextFill, true ) );
141 
142  m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
143  &m_Display.m_DisplayNetNamesMode, 3, 0, 3 ) );
144 
145  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
146  &m_Display.m_DisplayPadIsol, true ) );
147 
148  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
149  &m_Display.m_DisplayPadFill, true ) );
150 
151  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
152  &m_Display.m_DisplayPadNum, true ) );
153 
154  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
155  &m_Display.m_ShowGlobalRatsnest, true ) );
156 
157  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
158  &m_Display.m_ShowModuleRatsnest, true ) );
159 
160  m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
162 
163  m_params.emplace_back( new PARAM<int>( "pcb_display.rotation_angle",
164  &m_RotationAngle, 900, 1, 900 ) );
165 
166  m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
167  reinterpret_cast<int*>( &m_Display.m_ShowTrackClearanceMode ),
169 
170  m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
171  &m_Display.m_DisplayPcbTrackFill, true ) );
172 
173  m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
174  &m_Display.m_DisplayViaFill, true ) );
175 
176  m_params.emplace_back( new PARAM_ENUM<ZONE_DISPLAY_MODE>( "pcb_display.zone_mode",
179 
180  m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
181  reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
183 
184  m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
185  &m_Display.m_DisplayInvertXAxis, false ) );
186 
187  m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
188  &m_Display.m_DisplayInvertYAxis, false ) );
189 
190  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
191  &m_Cleanup.cleanup_vias, true ) );
192 
193  m_params.emplace_back( new PARAM<bool>( "cleanup.delete_dangling_vias",
194  &m_Cleanup.delete_dangling_vias, true ) );
195 
196  m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
197  &m_Cleanup.merge_segments, true ) );
198 
199  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
200  &m_Cleanup.cleanup_unconnected, true ) );
201 
202  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
204 
205  m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
206  &m_Cleanup.cleanup_tracks_in_pad, true ) );
207 
208  m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
209  &m_DrcDialog.refill_zones, true ) );
210 
211  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_all_track_errors",
213 
214  m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
215  &m_DrcDialog.test_footprints, false ) );
216 
217  m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
219 
220  m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
221  &m_GenDrill.merge_pth_npth, false ) );
222 
223  m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
224  &m_GenDrill.minimal_header, false ) );
225 
226  m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror", &m_GenDrill.mirror, false ) );
227 
228  m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
229  &m_GenDrill.unit_drill_is_inch, true ) );
230 
231  m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
233 
234  m_params.emplace_back( new PARAM<int>(
235  "gen_drill.drill_file_type", &m_GenDrill.drill_file_type, 0 ) );
236 
237  m_params.emplace_back( new PARAM<int>( "gen_drill.map_file_type",
238  &m_GenDrill.map_file_type, 1 ) );
239 
240  m_params.emplace_back( new PARAM<int>( "gen_drill.zeros_format",
241  &m_GenDrill.zeros_format, 0, 0, 3 ) );
242 
243  m_params.emplace_back( new PARAM<bool>( "export_idf.auto_adjust",
244  &m_ExportIdf.auto_adjust, false ) );
245 
246  m_params.emplace_back( new PARAM<int>( "export_idf.ref_units",
247  &m_ExportIdf.ref_units, 0 ) );
248 
249  m_params.emplace_back( new PARAM<double>( "export_idf.ref_x",
250  &m_ExportIdf.ref_x, 0 ) );
251 
252  m_params.emplace_back( new PARAM<double>( "export_idf.ref_y",
253  &m_ExportIdf.ref_y, 0 ) );
254 
255  m_params.emplace_back( new PARAM<bool>( "export_idf.units_mils",
256  &m_ExportIdf.units_mils, false ) );
257 
258  m_params.emplace_back( new PARAM<int>( "export_step.origin_mode",
259  &m_ExportStep.origin_mode, 0 ) );
260 
261  m_params.emplace_back( new PARAM<int>( "export_step.origin_units",
262  &m_ExportStep.origin_units, 0 ) );
263 
264  m_params.emplace_back( new PARAM<double>( "export_step.origin_x",
265  &m_ExportStep.origin_x, 0 ) );
266 
267  m_params.emplace_back( new PARAM<double>( "export_step.origin_y",
268  &m_ExportStep.origin_y, 0 ) );
269 
270  m_params.emplace_back( new PARAM<bool>( "export_step.no_virtual",
271  &m_ExportStep.no_virtual, false ) );
272 
273  m_params.emplace_back( new PARAM<bool>( "export_svg.black_and_white",
274  &m_ExportSvg.black_and_white, false ) );
275 
276  m_params.emplace_back( new PARAM<bool>( "export_svg.mirror",
277  &m_ExportSvg.mirror, false ) );
278 
279  m_params.emplace_back( new PARAM<bool>( "export_svg.one_file",
280  &m_ExportSvg.one_file, false ) );
281 
282  m_params.emplace_back(new PARAM<bool>( "export_svg.plot_board_edges",
283  &m_ExportSvg.plot_board_edges, true ) );
284 
285  m_params.emplace_back( new PARAM<int>( "export_svg.page_size",
286  &m_ExportSvg.page_size, 0 ) );
287 
288  m_params.emplace_back( new PARAM<wxString>( "export_svg.output_dir",
289  &m_ExportSvg.output_dir, "" ) );
290 
291  m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers",
292  &m_ExportSvg.layers, {} ) );
293 
294  m_params.emplace_back( new PARAM<int>( "export_vrml.units",
295  &m_ExportVrml.units, 1 ) );
296 
297  m_params.emplace_back( new PARAM<bool>( "export_vrml.copy_3d_models",
298  &m_ExportVrml.copy_3d_models, false ) );
299 
300  m_params.emplace_back( new PARAM<bool>( "export_vrml.use_relative_paths",
301  &m_ExportVrml.use_relative_paths, false ) );
302 
303  m_params.emplace_back( new PARAM<bool>( "export_vrml.use_plain_pcb",
304  &m_ExportVrml.use_plain_pcb, false ) );
305 
306  m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units",
307  &m_ExportVrml.ref_units, 0 ) );
308 
309  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x",
310  &m_ExportVrml.ref_x, 0 ) );
311 
312  m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y",
313  &m_ExportVrml.ref_y, 0 ) );
314 
315  m_params.emplace_back( new PARAM<int>( "zones.hatching_style",
316  &m_Zones.hatching_style, 0 ) );
317 
318  m_params.emplace_back( new PARAM<wxString>( "zones.net_filter",
319  &m_Zones.net_filter, "" ) );
320 
321  m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode",
322  &m_Zones.net_sort_mode, 1 ) );
323 
324  m_params.emplace_back( new PARAM<double>( "zones.clearance",
326 
327  m_params.emplace_back( new PARAM<double>( "zones.min_thickness",
329 
330  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_gap",
332 
333  m_params.emplace_back( new PARAM<double>( "zones.thermal_relief_copper_width",
335 
336  m_params.emplace_back( new PARAM<int>( "import_graphics.layer",
338 
339  m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
341 
342  m_params.emplace_back( new PARAM<int>( "import_graphics.line_width_units",
344 
345  m_params.emplace_back( new PARAM<double>( "import_graphics.line_width",
346  &m_ImportGraphics.line_width, 0.2 ) );
347 
348  m_params.emplace_back( new PARAM<int>( "import_graphics.origin_units",
350 
351  m_params.emplace_back( new PARAM<double>( "import_graphics.origin_x",
352  &m_ImportGraphics.origin_x, 0 ) );
353 
354  m_params.emplace_back( new PARAM<double>( "import_graphics.origin_y",
355  &m_ImportGraphics.origin_y, 0 ) );
356 
357  m_params.emplace_back( new PARAM<int>( "import_graphics.dxf_units",
358  &m_ImportGraphics.dxf_units, 0 ) );
359 
360  m_params.emplace_back( new PARAM<int>( "netlist.report_filter",
362 
363  m_params.emplace_back( new PARAM<bool>( "netlist.update_footprints",
365 
366  m_params.emplace_back( new PARAM<bool>( "netlist.delete_shorting_tracks",
368 
369  m_params.emplace_back( new PARAM<bool>( "netlist.delete_extra_footprints",
371 
372  m_params.emplace_back( new PARAM<bool>( "netlist.delete_single_pad_nets",
374 
375  m_params.emplace_back( new PARAM<bool>( "netlist.associate_by_ref_sch",
377 
378  m_params.emplace_back(new PARAM<int>( "place_file.units",
379  &m_PlaceFile.units, 1 ) );
380 
381  m_params.emplace_back( new PARAM<int>( "place_file.file_options",
382  &m_PlaceFile.file_options, 0 ) );
383 
384  m_params.emplace_back( new PARAM<int>( "place_file.file_format",
385  &m_PlaceFile.file_format, 0 ) );
386 
387  m_params.emplace_back( new PARAM<bool>( "place_file.include_board_edge",
388  &m_PlaceFile.include_board_edge, false ) );
389 
390  m_params.emplace_back( new PARAM<int>( "plot.all_layers_on_one_page",
392 
393  m_params.emplace_back( new PARAM<int>( "plot.pads_drill_mode",
394  &m_Plot.pads_drill_mode, 2 ) );
395 
396  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x",
397  &m_Plot.fine_scale_x, 0 ) );
398 
399  m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y",
400  &m_Plot.fine_scale_y, 0 ) );
401 
402  m_params.emplace_back( new PARAM<double>( "plot.ps_fine_width_adjust",
404 
405  m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
407 
408  m_params.emplace_back( new PARAM<bool>( "plot.mirror",
409  &m_Plot.mirror, false ) );
410 
411  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
412  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
413 
414  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.width",
415  &m_FootprintWizardList.width, -1 ) );
416 
417  m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
418  &m_FootprintWizardList.height, -1 ) );
419 
420  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_sort_on_modules",
422  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_front_prefix",
423  &m_Reannotate.remove_front_prefix, false ) );
424  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_back_prefix",
425  &m_Reannotate.remove_back_prefix, false ) );
426  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_update_schematic",
427  &m_Reannotate.update_schematic, true ) );
428  m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_exclude_locked",
429  &m_Reannotate.exclude_locked, false ) );
430 
431  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_grid_index",
432  &m_Reannotate.grid_index, 0 ) );
433  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_sort_code",
434  &m_Reannotate.sort_code, 0 ) );
435  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_choice",
437  m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_report_severity",
439 
440  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_refdes_start",
442  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_refdes_start",
444  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_prefix",
445  &m_Reannotate.front_prefix, "" ) );
446  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_prefix",
447  &m_Reannotate.back_prefix, "" ) );
448  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_exclude_list",
449  &m_Reannotate.exclude_list, "" ) );
450  m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_report_file_name",
452 
453 #if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU)
454  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
455  [&]() -> nlohmann::json
456  {
457  nlohmann::json js = nlohmann::json::array();
458 
459  for( const auto& pair : m_VisibleActionPlugins )
460  js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
461 
462  return js;
463  },
464  [&]( const nlohmann::json& aObj )
465  {
466  m_VisibleActionPlugins.clear();
467 
468  if( !aObj.is_array() )
469  {
470  return;
471  }
472 
473  for( const auto& entry : aObj )
474  {
475  if( entry.empty() || !entry.is_object() )
476  continue;
477 
478  for( const auto& pair : entry.items() )
479  {
480  m_VisibleActionPlugins.emplace_back( std::make_pair(
481  wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
482  }
483  }
484  },
485  nlohmann::json::array() ) );
486 #endif
487 
488  addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
489 
490  m_params.emplace_back( new PARAM<bool>( "footprint_viewer.auto_zoom",
491  &m_FootprintViewerAutoZoom, false ) );
492 
493  m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
494  &m_FootprintViewerZoom, 1.0 ) );
495 
496  addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
497 
498  m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
499  &m_lastFootprintLibDir, "" ) );
500 
501  m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
502  &m_lastFootprint3dDir, "" ) );
503 }
504 
505 
507 
508 
509 bool PCBNEW_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
510 {
511  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
512 
513  const std::string f = getLegacyFrameName();
514 
515  //
516  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
517  //
518  ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
519 
520  ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
521  ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
522  ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
523  ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
524 
525  ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
526  ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
527  ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
528  ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
529  ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
530  ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
531 
532  ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
533  ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
534  ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
535  ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
536  ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
537  ret &= fromLegacy<int>( aCfg, "PcbDisplayOrigin", "pcb_display.origin_mode" );
538  ret &= fromLegacy<bool>( aCfg, "PcbInvertXAxis", "pcb_display.origin_invert_x_axis" );
539  ret &= fromLegacy<bool>( aCfg, "PcbInvertYAxis", "pcb_display.origin_invert_y_axis" );
540  ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
541  ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
542  ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
543  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
544  ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
545  ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
546  ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
547  ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
548  ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
549  ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
550  ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
551 
552  ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
553 
554  aCfg->SetPath( "/dialogs/cleanup_tracks" );
555  ret &= fromLegacy<bool>( aCfg, "DialogCleanupVias", "cleanup.cleanup_vias" );
556  ret &= fromLegacy<bool>( aCfg, "DialogCleanupMergeSegments", "cleanup.merge_segments" );
557  ret &= fromLegacy<bool>( aCfg, "DialogCleanupUnconnected", "cleanup.cleanup_unconnected" );
558  ret &= fromLegacy<bool>( aCfg, "DialogCleanupShortCircuit", "cleanup.cleanup_short_circuits" );
559  ret &= fromLegacy<bool>( aCfg, "DialogCleanupTracksInPads", "cleanup.cleanup_tracks_in_pad" );
560  aCfg->SetPath( "../.." );
561 
562  ret &= fromLegacy<bool>( aCfg, "RefillZonesBeforeDrc", "drc_dialog.refill_zones" );
563  ret &= fromLegacy<bool>( aCfg, "DrcTestFootprints", "drc_dialog.test_footprints" );
564 
565  ret &= fromLegacy<bool>( aCfg, "DrillMergePTHNPTH", "gen_drill.merge_pth_npth" );
566  ret &= fromLegacy<bool>( aCfg, "DrillMinHeader", "gen_drill.minimal_header" );
567  ret &= fromLegacy<bool>( aCfg, "DrillMirrorYOpt", "gen_drill.mirror" );
568  ret &= fromLegacy<bool>( aCfg, "DrillUnit", "gen_drill.unit_drill_is_inch" );
569  ret &= fromLegacy<bool>( aCfg, "OvalHolesRouteMode", "gen_drill.use_route_for_oval_holes" );
570  ret &= fromLegacy<int>( aCfg, "DrillFileType", "gen_drill.drill_file_type" );
571  ret &= fromLegacy<int>( aCfg, "DrillMapFileType", "gen_drill.map_file_type" );
572  ret &= fromLegacy<int>( aCfg, "DrillZerosFormat", "gen_drill.zeros_format" );
573 
574  ret &= fromLegacy<bool>( aCfg, "IDFRefAutoAdj", "export_idf.auto_adjust" );
575  ret &= fromLegacy<int>( aCfg, "IDFRefUnits", "export_idf.ref_units" );
576  ret &= fromLegacy<double>( aCfg, "IDFRefX", "export_idf.ref_x" );
577  ret &= fromLegacy<double>( aCfg, "IDFRefY", "export_idf.ref_y" );
578  ret &= fromLegacy<bool>( aCfg, "IDFExportThou", "export_idf.units_mils" );
579 
580  ret &= fromLegacy<int>( aCfg, "STEP_Origin_Opt", "export_step.origin_mode" );
581  ret &= fromLegacy<int>( aCfg, "STEP_UserOriginUnits", "export_step.origin_units" );
582  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginX", "export_step.origin_x" );
583  ret &= fromLegacy<double>( aCfg, "STEP_UserOriginY", "export_step.origin_y" );
584  ret &= fromLegacy<bool>( aCfg, "STEP_NoVirtual", "export_step.no_virtual" );
585 
586  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeColor", "export_svg.black_and_white" );
587  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeMirror", "export_svg.mirror" );
588  ret &= fromLegacy<bool>( aCfg, "PlotSVGModeOneFile", "export_svg.one_file" );
589  ret &= fromLegacy<bool>( aCfg, "PlotSVGBrdEdge", "export_svg.plot_board_edges" );
590  ret &= fromLegacy<int>( aCfg, "PlotSVGPageOpt", "export_svg.page_size" );
591  ret &= fromLegacyString( aCfg, "PlotSVGDirectory", "export_svg.output_dir" );
592 
593  {
594  nlohmann::json js = nlohmann::json::array();
595  wxString key;
596  bool val = false;
597 
598  for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
599  {
600  key.Printf( wxT( "PlotSVGLayer_%d" ), i );
601 
602  if( aCfg->Read( key, &val ) && val )
603  js.push_back( i );
604  }
605 
606  ( *this )[PointerFromString( "export_svg.layers" ) ] = js;
607  }
608 
609  {
610  nlohmann::json js = nlohmann::json::array();
611 
612  wxString packed;
613 
614  if( aCfg->Read( "ActionPluginButtons", &packed ) )
615  {
616  wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
617 
618  while( pluginSettingsTokenizer.HasMoreTokens() )
619  {
620  nlohmann::json row;
621  wxString plugin = pluginSettingsTokenizer.GetNextToken();
622  wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
623 
624  if( pluginTokenizer.CountTokens() != 2 )
625  {
626  // Bad config
627  continue;
628  }
629 
630  std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
631 
632  js.push_back( nlohmann::json( {
633  { key, pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 } } ) );
634  }
635  }
636 
637  ( *this )[PointerFromString( "action_plugins" ) ] = js;
638  }
639 
640  //
641  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
642  //
643  ret &= fromLegacy<int>( aCfg, "VrmlExportUnit", "export_vrml.units" );
644  ret &= fromLegacy<bool>( aCfg, "VrmlExportCopyFiles", "export_vrml.copy_3d_models" );
645  ret &= fromLegacy<bool>( aCfg, "VrmlUseRelativePaths", "export_vrml.use_relative_paths" );
646  ret &= fromLegacy<bool>( aCfg, "VrmlUsePlainPCB", "export_vrml.use_plain_pcb" );
647  ret &= fromLegacy<int>( aCfg, "VrmlRefUnits", "export_vrml.ref_units" );
648  ret &= fromLegacy<double>( aCfg, "VrmlRefX", "export_vrml.ref_x" );
649  ret &= fromLegacy<double>( aCfg, "VrmlRefY", "export_vrml.ref_y" );
650 
651  ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
652  ret &= fromLegacyString( aCfg, "Zone_Filter_Opt", "zones.net_filter" );
653  ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
654  ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
655  ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
656  ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
657  ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
658 
659  aCfg->SetPath( "ImportGraphics" );
660  ret &= fromLegacy<int>( aCfg, "BoardLayer", "import_graphics.layer" );
661  ret &= fromLegacy<bool>( aCfg, "InteractivePlacement", "import_graphics.interactive_placement" );
662  ret &= fromLegacyString( aCfg, "LastFile", "import_graphics.last_file" );
663  ret &= fromLegacy<double>( aCfg, "LineWidth", "import_graphics.line_width" );
664  ret &= fromLegacy<int>( aCfg, "LineWidthUnits", "import_graphics.line_width_units" );
665  ret &= fromLegacy<int>( aCfg, "PositionUnits", "import_graphics.origin_units" );
666  ret &= fromLegacy<double>( aCfg, "PositionX", "import_graphics.origin_x" );
667  ret &= fromLegacy<double>( aCfg, "PositionY", "import_graphics.origin_y" );
668  aCfg->SetPath( ".." );
669 
670  ret &= fromLegacy<int>( aCfg, "NetlistReportFilterMsg", "netlist.report_filter" );
671  ret &= fromLegacy<bool>( aCfg, "NetlistUpdateFootprints", "netlist.update_footprints" );
672  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteShortingTracks", "netlist.delete_shorting_tracks" );
673  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteExtraFootprints", "netlist.delete_extra_footprints" );
674  ret &= fromLegacy<bool>( aCfg, "NetlistDeleteSinglePadNets", "netlist.delete_single_pad_nets" );
675 
676  ret &= fromLegacy<int>( aCfg, "PlaceFileUnits", "place_file.units" );
677  ret &= fromLegacy<int>( aCfg, "PlaceFileOpts", "place_file.file_options" );
678  ret &= fromLegacy<int>( aCfg, "PlaceFileFormat", "place_file.file_format" );
679  ret &= fromLegacy<bool>( aCfg, "PlaceFileIncludeBrdEdge", "place_file.include_board_edge" );
680 
681  ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.all_layers_on_one_page" );
682  ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
683  ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
684  ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
685  ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
686  ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
687 
688  ret &= fromLegacyString( aCfg, "FootprintTextShownColumns", "window.footprint_text_shown_columns" );
689 
690  ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
691  ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
692 
693  migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
694 
695  ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
696  ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
697 
698  migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
699  ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
700 
701 
702  const std::string p = "pcbnew.InteractiveRouter.";
703 
704  ( *this )[PointerFromString( "tools.pns.meta" )] = nlohmann::json( {
705  { "filename", "pns" },
706  { "version", 0 }
707  } );
708 
709  ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
710  ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
711  ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
712  ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
713  ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
714  ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
715  ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
716  ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
717  ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
718  ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
719  ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
720  ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
721  ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
722  ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
723  ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "tools.pns.inline_drag" );
724 
725  // Initialize some new PNS settings to legacy behaviors if coming from legacy
726  ( *this )[PointerFromString( "tools.pns.fix_all_segments" )] = false;
727 
728  // Migrate color settings that were stored in the pcbnew config file
729 
730  COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetMigratedColorSettings();
731 
732  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
733  wxString str;
734 
735  if( aCfg->Read( aKey, &str ) )
736  cs->SetColor( aLayerId, COLOR4D( str ) );
737  };
738 
739  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
740  {
741  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
742  migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
743  }
744 
745  migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
746  migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
747  migrateLegacyColor( "Color4DGrid", LAYER_GRID );
748  migrateLegacyColor( "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
749  migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
750  migrateLegacyColor( "Color4DPadBackEx", LAYER_PAD_BK );
751  migrateLegacyColor( "Color4DPadFrontEx", LAYER_PAD_FR );
752  migrateLegacyColor( "Color4DPadThruHoleEx", LAYER_PADS_TH );
753  migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
754  migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
755  migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
756  migrateLegacyColor( "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
757  migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
758  migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
759  migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
760  migrateLegacyColor( "Color4DWorksheet", LAYER_DRAWINGSHEET );
761 
762  Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
763 
764  ( *this )[PointerFromString( "appearance.color_theme" )] = cs->GetFilename();
765 
766  double x, y;
767 
768  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
769  {
770  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
771  static_cast<long>( EDA_UNITS::INCHES ) ) );
772 
773  // Convert to internal units
774  x = From_User_Unit( u, x );
775  y = From_User_Unit( u, y );
776 
777  ( *this )[PointerFromString( "window.grid.user_grid_x" )] = StringFromValue( u, x );
778  ( *this )[PointerFromString( "window.grid.user_grid_y" )] = StringFromValue( u, y );
779  }
780 
781  // Footprint editor settings were stored in pcbnew config file. Migrate them here.
782  auto fpedit = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( false );
783  fpedit->MigrateFromLegacy( aCfg );
784  fpedit->Load();
785 
786  // Same with 3D viewer
787  auto viewer3d = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( false );
788  viewer3d->MigrateFromLegacy( aCfg );
789  viewer3d->Load();
790 
791  return ret;
792 }
DIALOG_GENERATE_DRILL m_GenDrill
Filled polygons are shown.
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
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
DIALOG_CLEANUP m_Cleanup
multilayer pads, usually with holes
Implementation of conversion functions that require both schematic and board internal units.
Outlines of filled polygons are shown.
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
wxString GetFilename() const
Definition: json_settings.h:64
Stores an enum as an integer.
Definition: parameters.h:226
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
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
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
wxString m_lastFootprint3dDir
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:99
PCB_DISPLAY_ORIGIN_OPTIONS_T m_DisplayOrigin
Which origin is used for display transforms.
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)
Return the fixed name association with aLayerId.
Definition: lset.cpp:82
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
EDA_UNITS
Definition: eda_units.h:38
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
ZONE_DISPLAY_MODE m_ZoneDisplayMode
AUI_PANELS m_AuiPanels
The common library.
DIALOG_PLOT m_Plot
DIALOG_REANNOTATE m_Reannotate
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:225
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...
drawingsheet frame and titleblock
#define ZONE_THERMAL_RELIEF_GAP_MIL
Definition: zones.h:29
DIALOG_DRC m_DrcDialog
MAGNETIC_SETTINGS m_MagneticItems
wxString m_lastFootprintLibDir
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.
double From_User_Unit(EDA_UNITS aUnits, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:313
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)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98