KiCad PCB EDA Suite
footprint_editor_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 Jon Evans <jon@craftyjon.com>
5  * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software: you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation, either version 3 of the License, or (at your
10  * option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #include <common.h>
24 #include <pgm_base.h>
26 #include <settings/parameters.h>
28 #include <wx/config.h>
29 #include <base_units.h>
30 #include <widgets/ui_common.h>
31 
32 
34 const int fpEditSchemaVersion = 1;
35 
36 
39  m_DesignSettings( nullptr, "fpedit.settings" ),
40  m_MagneticItems(),
41  m_Display(),
42  m_UserGrid(),
43  m_PolarCoords( false ),
44  m_Use45DegreeGraphicSegments( true ),
45  m_LibWidth( 250 ),
46  m_LastImportExportPath(),
47  m_FootprintTextShownColumns()
48 {
51  m_MagneticItems.graphics = false;
52 
53  m_params.emplace_back( new PARAM<int>( "window.lib_width",
54  &m_LibWidth, 250 ) );
55 
56  m_params.emplace_back( new PARAM<wxString>( "system.last_import_export_path",
57  &m_LastImportExportPath, "" ) );
58 
59  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
60  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
61 
62  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
63  reinterpret_cast<int*>( &m_MagneticItems.pads ),
64  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
65 
66  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords", &m_PolarCoords, false ) );
67 
68  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
69  &m_Use45DegreeGraphicSegments, false ) );
70 
71  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
72  &m_Display.m_DisplayTextFill, true ) );
73 
74  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
76 
77  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
78  &m_Display.m_DisplayPadFill, true ) );
79 
80  m_params.emplace_back( new PARAM_LAYER_PRESET( "pcb_display.layer_presets", &m_LayerPresets ) );
81 
82  m_params.emplace_back( new PARAM<wxString>( "pcb_display.active_layer_preset",
83  &m_ActiveLayerPreset, "" ) );
84 
85  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
86  "design_settings.default_footprint_text_items",
87  [&] () -> nlohmann::json
88  {
89  nlohmann::json js = nlohmann::json::array();
90 
92  {
93  js.push_back( nlohmann::json( { item.m_Text.ToUTF8(),
94  item.m_Visible,
95  item.m_Layer } ) );
96  }
97 
98  return js;
99  },
100  [&] ( const nlohmann::json& aObj )
101  {
103 
104  if( !aObj.is_array() )
105  return;
106 
107  for( const nlohmann::json& entry : aObj )
108  {
109  if( entry.empty() || !entry.is_array() )
110  continue;
111 
112  TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
113 
114  textInfo.m_Text = entry.at(0).get<wxString>();
115  textInfo.m_Visible = entry.at(1).get<bool>();
116  textInfo.m_Layer = entry.at(2).get<int>();
117 
118  m_DesignSettings.m_DefaultFPTextItems.push_back( std::move( textInfo ) );
119  }
120  },
121  nlohmann::json::array( {
122  { "REF**", true, F_SilkS },
123  { "", true, F_Fab },
124  { "${REFERENCE}", true, F_Fab }
125  } ) ) );
126 
127  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_line_width",
130  MM_PER_IU ) );
131 
132  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_h",
135 
136  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_v",
139 
140  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_thickness",
143 
144  m_params.emplace_back( new PARAM<bool>( "design_settings.silk_text_italic",
146 
147  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_line_width",
150  MM_PER_IU ) );
151 
152  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_h",
155  MM_PER_IU ) );
156 
157  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_v",
160  MM_PER_IU ) );
161 
162  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_thickness",
165  MM_PER_IU ) );
166 
167  m_params.emplace_back( new PARAM<bool>( "design_settings.copper_text_italic",
169 
170  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.edge_line_width",
173  MM_PER_IU ) );
174 
175  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.courtyard_line_width",
178  MM_PER_IU ) );
179 
180  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_line_width",
183  MM_PER_IU ) );
184 
185  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_h",
188 
189  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_v",
192 
193  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_thickness",
195  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
196 
197  m_params.emplace_back( new PARAM<bool>( "design_settings.fab_text_italic",
199 
200  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_line_width",
203  MM_PER_IU ) );
204 
205  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_h",
208 
209  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_v",
212 
213  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_thickness",
215  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
216 
217  m_params.emplace_back( new PARAM<bool>( "design_settings.others_text_italic",
219 
220  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "editing.selection_filter",
221  [&]() -> nlohmann::json
222  {
223  nlohmann::json ret;
224 
225  ret["lockedItems"] = m_SelectionFilter.lockedItems;
226  ret["footprints"] = m_SelectionFilter.footprints;
227  ret["text"] = m_SelectionFilter.text;
228  ret["tracks"] = m_SelectionFilter.tracks;
229  ret["vias"] = m_SelectionFilter.vias;
230  ret["pads"] = m_SelectionFilter.pads;
231  ret["graphics"] = m_SelectionFilter.graphics;
232  ret["zones"] = m_SelectionFilter.zones;
233  ret["keepouts"] = m_SelectionFilter.keepouts;
234  ret["dimensions"] = m_SelectionFilter.dimensions;
235  ret["otherItems"] = m_SelectionFilter.otherItems;
236 
237  return ret;
238  },
239  [&]( const nlohmann::json& aVal )
240  {
241  if( aVal.empty() || !aVal.is_object() )
242  return;
243 
244  SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
245  SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
246  SetIfPresent( aVal, "text", m_SelectionFilter.text );
247  SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
248  SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
249  SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
250  SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
251  SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
252  SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
253  SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
254  SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
255  },
256  {
257  { "lockedItems", true },
258  { "footprints", true },
259  { "text", true },
260  { "tracks", true },
261  { "vias", true },
262  { "pads", true },
263  { "graphics", true },
264  { "zones", true },
265  { "keepouts", true },
266  { "dimensions", true },
267  { "otherItems", true }
268  } ) );
269 
271 }
272 
273 
275 {
276  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
277 
278  //
279  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
280  //
281  ret &= fromLegacy<int>( aCfg, "ModeditLibWidth", "window.lib_width" );
282  ret &= fromLegacyString( aCfg, "import_last_path", "system.last_import_export_path" );
283  ret &= fromLegacyString( aCfg, "LibFootprintTextShownColumns", "window.footprint_text_shown_columns" );
284 
285  ret &= fromLegacy<int>( aCfg, "FpEditorMagneticPads", "editing.magnetic_pads" );
286  ret &= fromLegacy<bool>( aCfg, "FpEditorDisplayPolarCoords", "editing.polar_coords" );
287  ret &= fromLegacy<int>( aCfg, "FpEditorUse45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
288 
289  ret &= fromLegacy<bool>( aCfg, "FpEditorGraphicLinesDisplayMode", "pcb_display.graphic_items_fill" );
290  ret &= fromLegacy<bool>( aCfg, "FpEditorPadDisplayMode", "pcb_display.pad_fill" );
291  ret &= fromLegacy<bool>( aCfg, "FpEditorTextsDisplayMode", "pcb_display.footprint_text" );
292 
293  ret &= fromLegacy<double>( aCfg, "FpEditorSilkLineWidth", "design_settings.silk_line_width" );
294  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeH", "design_settings.silk_text_size_h" );
295  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeV", "design_settings.silk_text_size_v" );
296  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextThickness", "design_settings.silk_text_thickness" );
297  ret &= fromLegacy<bool>( aCfg, "FpEditorSilkTextItalic", "design_settings.silk_text_italic" );
298  ret &= fromLegacy<double>( aCfg, "FpEditorCopperLineWidth", "design_settings.copper_line_width" );
299  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeH", "design_settings.copper_text_size_h" );
300  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeV", "design_settings.copper_text_size_v" );
301  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextThickness", "design_settings.copper_text_thickness" );
302  ret &= fromLegacy<bool>( aCfg, "FpEditorCopperTextItalic", "design_settings.copper_text_italic" );
303  ret &= fromLegacy<double>( aCfg, "FpEditorEdgeCutLineWidth", "design_settings.edge_line_width" );
304  ret &= fromLegacy<double>( aCfg, "FpEditorCourtyardLineWidth", "design_settings.courtyard_line_width" );
305  ret &= fromLegacy<double>( aCfg, "FpEditorOthersLineWidth", "design_settings.others_line_width" );
306  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeH", "design_settings.others_text_size_h" );
307  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeV", "design_settings.others_text_size_v" );
308  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextThickness", "design_settings.others_text_thickness" );
309  ret &= fromLegacy<bool>( aCfg, "FpEditorOthersTextItalic", "design_settings.others_text_italic" );
310 
311  nlohmann::json textItems = nlohmann::json::array( {
312  { "REF**", true, F_SilkS },
313  { "", true, F_Fab }
314  } );
315 
316  ( *this )[PointerFromString( "design_settings.default_footprint_text_items" )] = textItems;
317 
318  ret &= fromLegacyString( aCfg, "FpEditorRefDefaultText", "design_settings.default_footprint_text_items.0.0" );
319  ret &= fromLegacy<bool>( aCfg, "FpEditorRefDefaultVisibility", "design_settings.default_footprint_text_items.0.1" );
320  ret &= fromLegacy<int>( aCfg, "FpEditorRefDefaultLayer", "design_settings.default_footprint_text_items.0.2" );
321  ret &= fromLegacyString( aCfg, "FpEditorValueDefaultText", "design_settings.default_footprint_text_items.1.0" );
322  ret &= fromLegacy<bool>( aCfg, "FpEditorValueDefaultVisibility", "design_settings.default_footprint_text_items.1.1" );
323  ret &= fromLegacy<int>( aCfg, "FpEditorValueDefaultLayer", "design_settings.default_footprint_text_items.1.2" );
324 
325 
326  std::string f = "ModEdit";
327 
328  // Migrate color settings that were stored in the pcbnew config file
329  // We create a copy of the user scheme for the footprint editor context
330 
331  SETTINGS_MANAGER& manager = Pgm().GetSettingsManager();
332  COLOR_SETTINGS* cs = manager.AddNewColorSettings( "user_footprints" );
333 
334  cs->SetName( wxT( "User (Footprints)" ) );
335  manager.Save( cs );
336 
337  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId )
338  {
339  wxString str;
340 
341  if( aCfg->Read( aKey, &str ) )
342  cs->SetColor( aLayerId, COLOR4D( str ) );
343  };
344 
345  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
346  {
347  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
348  migrateLegacyColor( f + "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
349  }
350 
351  migrateLegacyColor( f + "Color4DAnchorEx", LAYER_ANCHOR );
352  migrateLegacyColor( f + "Color4DAuxItems", LAYER_AUX_ITEMS );
353  migrateLegacyColor( f + "Color4DGrid", LAYER_GRID );
354  migrateLegacyColor( f + "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
355  migrateLegacyColor( f + "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
356  migrateLegacyColor( f + "Color4DPadBackEx", LAYER_PAD_BK );
357  migrateLegacyColor( f + "Color4DPadFrontEx", LAYER_PAD_FR );
358  migrateLegacyColor( f + "Color4DPadThruHoleEx", LAYER_PADS_TH );
359  migrateLegacyColor( f + "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
360  migrateLegacyColor( f + "Color4DPCBCursor", LAYER_CURSOR );
361  migrateLegacyColor( f + "Color4DRatsEx", LAYER_RATSNEST );
362  migrateLegacyColor( f + "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
363  migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
364  migrateLegacyColor( f + "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
365  migrateLegacyColor( f + "Color4DViaThruEx", LAYER_VIA_THROUGH );
366  migrateLegacyColor( f + "Color4DWorksheet", LAYER_WORKSHEET );
367 
368  manager.SaveColorSettings( cs, "board" );
369 
370  ( *this )[PointerFromString( "appearance.color_theme" )] = "user_footprints";
371 
372  double x, y;
373  f = "ModEditFrame";
374 
375  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
376  {
377  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
378  static_cast<long>( EDA_UNITS::INCHES ) ) );
379 
380  // Convert to internal units
381  x = From_User_Unit( u, x );
382  y = From_User_Unit( u, y );
383 
384  ( *this )[PointerFromString( "window.grid.user_grid_x" )] = StringFromValue( u, x );
385  ( *this )[PointerFromString( "window.grid.user_grid_y" )] = StringFromValue( u, y );
386  }
387 
388  return ret;
389 }
390 
391 
393 {
401  if( !m_manager )
402  {
403  wxLogTrace( traceSettings,
404  "Error: FOOTPRINT_EDITOR_SETTINGS migration cannot run unmanaged!" );
405  return false;
406  }
407 
408  nlohmann::json::json_pointer theme_ptr( "/appearance/color_theme" );
409 
410  if( !count( theme_ptr ) )
411  return true;
412 
413  wxString selected = at( theme_ptr ).get<wxString>();
414  wxString search = selected + wxT( "_footprints" );
415 
416  for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
417  {
418  if( settings->GetFilename() == search )
419  {
420  wxLogTrace( traceSettings, "Updating footprint editor theme from %s to %s",
421  selected, search );
422  ( *this )[theme_ptr] = search;
423  return true;
424  }
425  }
426 
427  return true;
428 }
#define DEFAULT_SILK_TEXT_WIDTH
to draw blind/buried vias
show a marker on pads with no nets
bool otherItems
Anything not fitting one of the above categories.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
multilayer pads, usually with holes
#define TEXTS_MAX_WIDTH
Maximum text width in internal units (10 inches)
Definition: pcbnew.h:33
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)
#define DEFAULT_LINE_WIDTH
#define DEFAULT_COPPER_LINE_WIDTH
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
nlohmann::json json
Definition: gerbview.cpp:39
#define DEFAULT_TEXT_WIDTH
wxSize m_TextSize[LAYER_CLASS_COUNT]
const int fpEditSchemaVersion
! Update the schema version whenever a migration is required
PCB_LAYER_ID
A quick note on layer IDs:
#define DEFAULT_SILK_TEXT_SIZE
int m_TextThickness[LAYER_CLASS_COUNT]
#define DEFAULT_SILK_LINE_WIDTH
Auxiliary items (guides, rule, etc)
bool text
Text (free or attached to a footprint)
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
bool dimensions
Dimension items.
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:82
bool graphics
Graphic lines, shapes, polygons.
static bool SetIfPresent(const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
Sets the given string if the given key/path is present.
to draw usual through hole vias
bool m_TextItalic[LAYER_CLASS_COUNT]
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition: parameters.h:388
Functions to provide common constants and other functions to assist in making a consistent UI.
SELECTION_FILTER_OPTIONS m_SelectionFilter
void SetName(const wxString &aName)
#define TEXTS_MAX_SIZE
Maximum text size in internal units (10 inches)
Definition: pcbnew.h:32
SETTINGS_MANAGER * GetSettingsManager()
bool footprints
Allow selecting entire footprints.
int m_LineThickness[LAYER_CLASS_COUNT]
#define TEXTS_MIN_SIZE
Minimum text size in internal units (1 mil)
Definition: pcbnew.h:31
EDA_UNITS
Definition: eda_units.h:38
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 lockedItems
Allow selecting locked items.
smd pads, front layer
see class PGM_BASE
Board layer functions and definitions.
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
std::vector< LAYER_PRESET > m_LayerPresets
MAGNETIC_OPTIONS pads
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely saves a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
The common library.
#define DEFAULT_COPPER_TEXT_WIDTH
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)
Function StringFromValue returns the string from aValue according to units (inch, mm ....
Definition: base_units.cpp:220
Color settings are a bit different than most of the settings objects in that there can be more than o...
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
#define DEFAULT_COPPER_TEXT_SIZE
BOARD_DESIGN_SETTINGS m_DesignSettings
Only some of these settings are actually used for footprint editing.
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
static constexpr int Millimeter2iu(double mm)
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:308
MAGNETIC_OPTIONS tracks
void SetColor(int aLayer, COLOR4D aColor)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100