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>
27 #include <settings/parameters.h>
29 #include <wx/config.h>
30 #include <base_units.h>
31 #include <widgets/ui_common.h>
32 #include <wx/log.h>
33 #include <pcbnew.h>
34 
35 
37 const int fpEditSchemaVersion = 1;
38 
39 
42  m_DesignSettings( nullptr, "fpedit.settings" ),
43  m_MagneticItems(),
44  m_Display(),
45  m_UserGrid(),
46  m_PolarCoords( false ),
47  m_Use45DegreeGraphicSegments( true ),
48  m_LibWidth( 250 ),
49  m_LastImportExportPath(),
50  m_FootprintTextShownColumns()
51 {
55 
56  m_params.emplace_back( new PARAM<int>( "window.lib_width",
57  &m_LibWidth, 250 ) );
58 
59  m_params.emplace_back( new PARAM<wxString>( "system.last_import_export_path",
60  &m_LastImportExportPath, "" ) );
61 
62  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
63  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
64 
65  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
66  reinterpret_cast<int*>( &m_MagneticItems.pads ),
67  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_ALWAYS ) ) );
68 
69  m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
70  &m_MagneticItems.graphics, true ) );
71 
72  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords", &m_PolarCoords, false ) );
73 
74  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_graphic_segments",
75  &m_Use45DegreeGraphicSegments, false ) );
76 
77  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
78  &m_Display.m_DisplayTextFill, true ) );
79 
80  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
82 
83  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
84  &m_Display.m_DisplayPadFill, true ) );
85 
86  m_params.emplace_back( new PARAM_LAYER_PRESET( "pcb_display.layer_presets", &m_LayerPresets ) );
87 
88  m_params.emplace_back( new PARAM<wxString>( "pcb_display.active_layer_preset",
89  &m_ActiveLayerPreset, "" ) );
90 
91  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
92  "design_settings.default_footprint_text_items",
93  [&] () -> nlohmann::json
94  {
95  nlohmann::json js = nlohmann::json::array();
96 
98  {
99  js.push_back( nlohmann::json( { item.m_Text.ToUTF8(),
100  item.m_Visible,
101  item.m_Layer } ) );
102  }
103 
104  return js;
105  },
106  [&] ( const nlohmann::json& aObj )
107  {
109 
110  if( !aObj.is_array() )
111  return;
112 
113  for( const nlohmann::json& entry : aObj )
114  {
115  if( entry.empty() || !entry.is_array() )
116  continue;
117 
118  TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
119 
120  textInfo.m_Text = entry.at(0).get<wxString>();
121  textInfo.m_Visible = entry.at(1).get<bool>();
122  textInfo.m_Layer = entry.at(2).get<int>();
123 
124  m_DesignSettings.m_DefaultFPTextItems.push_back( std::move( textInfo ) );
125  }
126  },
127  nlohmann::json::array( {
128  { "REF**", true, F_SilkS },
129  { "", true, F_Fab },
130  { "${REFERENCE}", true, F_Fab }
131  } ) ) );
132 
133  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_line_width",
136  MM_PER_IU ) );
137 
138  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_h",
141 
142  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_v",
145 
146  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_thickness",
149 
150  m_params.emplace_back( new PARAM<bool>( "design_settings.silk_text_italic",
152 
153  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_line_width",
156  MM_PER_IU ) );
157 
158  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_h",
161  MM_PER_IU ) );
162 
163  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_v",
166  MM_PER_IU ) );
167 
168  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_thickness",
171  MM_PER_IU ) );
172 
173  m_params.emplace_back( new PARAM<bool>( "design_settings.copper_text_italic",
175 
176  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.edge_line_width",
179  MM_PER_IU ) );
180 
181  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.courtyard_line_width",
184  MM_PER_IU ) );
185 
186  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_line_width",
189  MM_PER_IU ) );
190 
191  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_h",
194 
195  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_v",
198 
199  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_thickness",
201  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
202 
203  m_params.emplace_back( new PARAM<bool>( "design_settings.fab_text_italic",
205 
206  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_line_width",
209  MM_PER_IU ) );
210 
211  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_h",
214 
215  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_v",
218 
219  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_thickness",
221  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
222 
223  m_params.emplace_back( new PARAM<bool>( "design_settings.others_text_italic",
225 
226  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "editing.selection_filter",
227  [&]() -> nlohmann::json
228  {
229  nlohmann::json ret;
230 
231  ret["lockedItems"] = m_SelectionFilter.lockedItems;
232  ret["footprints"] = m_SelectionFilter.footprints;
233  ret["text"] = m_SelectionFilter.text;
234  ret["tracks"] = m_SelectionFilter.tracks;
235  ret["vias"] = m_SelectionFilter.vias;
236  ret["pads"] = m_SelectionFilter.pads;
237  ret["graphics"] = m_SelectionFilter.graphics;
238  ret["zones"] = m_SelectionFilter.zones;
239  ret["keepouts"] = m_SelectionFilter.keepouts;
240  ret["dimensions"] = m_SelectionFilter.dimensions;
241  ret["otherItems"] = m_SelectionFilter.otherItems;
242 
243  return ret;
244  },
245  [&]( const nlohmann::json& aVal )
246  {
247  if( aVal.empty() || !aVal.is_object() )
248  return;
249 
250  SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
251  SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
252  SetIfPresent( aVal, "text", m_SelectionFilter.text );
253  SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
254  SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
255  SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
256  SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
257  SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
258  SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
259  SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
260  SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
261  },
262  {
263  { "lockedItems", true },
264  { "footprints", true },
265  { "text", true },
266  { "tracks", true },
267  { "vias", true },
268  { "pads", true },
269  { "graphics", true },
270  { "zones", true },
271  { "keepouts", true },
272  { "dimensions", true },
273  { "otherItems", true }
274  } ) );
275 
277 }
278 
279 
281 {
282  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
283 
284  //
285  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
286  //
287  ret &= fromLegacy<int>( aCfg, "ModeditLibWidth", "window.lib_width" );
288  ret &= fromLegacyString( aCfg, "import_last_path", "system.last_import_export_path" );
289  ret &= fromLegacyString( aCfg, "LibFootprintTextShownColumns", "window.footprint_text_shown_columns" );
290 
291  ret &= fromLegacy<int>( aCfg, "FpEditorMagneticPads", "editing.magnetic_pads" );
292  ret &= fromLegacy<bool>( aCfg, "FpEditorDisplayPolarCoords", "editing.polar_coords" );
293  ret &= fromLegacy<int>( aCfg, "FpEditorUse45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
294 
295  ret &= fromLegacy<bool>( aCfg, "FpEditorGraphicLinesDisplayMode", "pcb_display.graphic_items_fill" );
296  ret &= fromLegacy<bool>( aCfg, "FpEditorPadDisplayMode", "pcb_display.pad_fill" );
297  ret &= fromLegacy<bool>( aCfg, "FpEditorTextsDisplayMode", "pcb_display.footprint_text" );
298 
299  ret &= fromLegacy<double>( aCfg, "FpEditorSilkLineWidth", "design_settings.silk_line_width" );
300  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeH", "design_settings.silk_text_size_h" );
301  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeV", "design_settings.silk_text_size_v" );
302  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextThickness", "design_settings.silk_text_thickness" );
303  ret &= fromLegacy<bool>( aCfg, "FpEditorSilkTextItalic", "design_settings.silk_text_italic" );
304  ret &= fromLegacy<double>( aCfg, "FpEditorCopperLineWidth", "design_settings.copper_line_width" );
305  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeH", "design_settings.copper_text_size_h" );
306  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeV", "design_settings.copper_text_size_v" );
307  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextThickness", "design_settings.copper_text_thickness" );
308  ret &= fromLegacy<bool>( aCfg, "FpEditorCopperTextItalic", "design_settings.copper_text_italic" );
309  ret &= fromLegacy<double>( aCfg, "FpEditorEdgeCutLineWidth", "design_settings.edge_line_width" );
310  ret &= fromLegacy<double>( aCfg, "FpEditorCourtyardLineWidth", "design_settings.courtyard_line_width" );
311  ret &= fromLegacy<double>( aCfg, "FpEditorOthersLineWidth", "design_settings.others_line_width" );
312  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeH", "design_settings.others_text_size_h" );
313  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeV", "design_settings.others_text_size_v" );
314  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextThickness", "design_settings.others_text_thickness" );
315  ret &= fromLegacy<bool>( aCfg, "FpEditorOthersTextItalic", "design_settings.others_text_italic" );
316 
317  nlohmann::json textItems = nlohmann::json::array( {
318  { "REF**", true, F_SilkS },
319  { "", true, F_Fab }
320  } );
321 
322  Set( "design_settings.default_footprint_text_items", textItems );
323 
324  ret &= fromLegacyString( aCfg, "FpEditorRefDefaultText", "design_settings.default_footprint_text_items.0.0" );
325  ret &= fromLegacy<bool>( aCfg, "FpEditorRefDefaultVisibility", "design_settings.default_footprint_text_items.0.1" );
326  ret &= fromLegacy<int>( aCfg, "FpEditorRefDefaultLayer", "design_settings.default_footprint_text_items.0.2" );
327  ret &= fromLegacyString( aCfg, "FpEditorValueDefaultText", "design_settings.default_footprint_text_items.1.0" );
328  ret &= fromLegacy<bool>( aCfg, "FpEditorValueDefaultVisibility", "design_settings.default_footprint_text_items.1.1" );
329  ret &= fromLegacy<int>( aCfg, "FpEditorValueDefaultLayer", "design_settings.default_footprint_text_items.1.2" );
330 
331 
332  std::string f = "ModEdit";
333 
334  // Migrate color settings that were stored in the pcbnew config file
335  // We create a copy of the user scheme for the footprint editor context
336 
337  SETTINGS_MANAGER& manager = Pgm().GetSettingsManager();
338  COLOR_SETTINGS* cs = manager.AddNewColorSettings( "user_footprints" );
339 
340  cs->SetName( wxT( "User (Footprints)" ) );
341  manager.Save( cs );
342 
343  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId )
344  {
345  wxString str;
346 
347  if( aCfg->Read( aKey, &str ) )
348  cs->SetColor( aLayerId, COLOR4D( str ) );
349  };
350 
351  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
352  {
353  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
354  migrateLegacyColor( f + "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
355  }
356 
357  migrateLegacyColor( f + "Color4DAnchorEx", LAYER_ANCHOR );
358  migrateLegacyColor( f + "Color4DAuxItems", LAYER_AUX_ITEMS );
359  migrateLegacyColor( f + "Color4DGrid", LAYER_GRID );
360  migrateLegacyColor( f + "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
361  migrateLegacyColor( f + "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
362  migrateLegacyColor( f + "Color4DPadBackEx", LAYER_PAD_BK );
363  migrateLegacyColor( f + "Color4DPadFrontEx", LAYER_PAD_FR );
364  migrateLegacyColor( f + "Color4DPadThruHoleEx", LAYER_PADS_TH );
365  migrateLegacyColor( f + "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
366  migrateLegacyColor( f + "Color4DPCBCursor", LAYER_CURSOR );
367  migrateLegacyColor( f + "Color4DRatsEx", LAYER_RATSNEST );
368  migrateLegacyColor( f + "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
369  migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
370  migrateLegacyColor( f + "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
371  migrateLegacyColor( f + "Color4DViaThruEx", LAYER_VIA_THROUGH );
372  migrateLegacyColor( f + "Color4DWorksheet", LAYER_DRAWINGSHEET );
373 
374  manager.SaveColorSettings( cs, "board" );
375 
376  ( *m_internals )[m_internals->PointerFromString( "appearance.color_theme" )] = "user_footprints";
377 
378  double x, y;
379  f = "ModEditFrame";
380 
381  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
382  {
383  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
384  static_cast<long>( EDA_UNITS::INCHES ) ) );
385 
386  // Convert to internal units
387  x = From_User_Unit( u, x );
388  y = From_User_Unit( u, y );
389 
390  Set( "window.grid.user_grid_x", StringFromValue( u, x ) );
391  Set( "window.grid.user_grid_y", StringFromValue( u, y ) );
392  }
393 
394  return ret;
395 }
396 
397 
399 {
407  if( !m_manager )
408  {
409  wxLogTrace( traceSettings,
410  "Error: FOOTPRINT_EDITOR_SETTINGS migration cannot run unmanaged!" );
411  return false;
412  }
413 
414  std::string theme_ptr( "appearance.color_theme" );
415 
416  if( !Count( theme_ptr ) )
417  return true;
418 
419  wxString selected = At( theme_ptr ).get<wxString>();
420  wxString search = selected + wxT( "_footprints" );
421 
422  for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
423  {
424  if( settings->GetFilename() == search )
425  {
426  wxLogTrace( traceSettings, "Updating footprint editor theme from %s to %s",
427  selected, search );
428  Set( theme_ptr, search );
429  return true;
430  }
431  }
432 
433  return true;
434 }
#define DEFAULT_SILK_TEXT_WIDTH
to draw blind/buried vias
#define DEFAULT_COURTYARD_WIDTH
show a marker on pads with no nets
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
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:106
nlohmann::json json
Definition: gerbview.cpp:41
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
#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
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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:354
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)
Convert a value to a string using double notation.
Definition: base_units.cpp:203
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.
drawingsheet frame and titleblock
#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)
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:281
MAGNETIC_OPTIONS tracks
size_t Count(const std::string &aPath) const
void SetColor(int aLayer, COLOR4D aColor)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103