KiCad PCB EDA Suite
Loading...
Searching...
No Matches
load_select_footprint.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) 2018 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <functional>
27using namespace std::placeholders;
28
29#include <board.h>
30#include <footprint.h>
31#include <confirm.h>
34#include <eda_list_dialog.h>
36#include <footprint_tree_pane.h>
38#include <fp_lib_table.h>
39#include <pcb_io/pcb_io_mgr.h>
40#include <string_utils.h>
41#include <kiway.h>
42#include <lib_id.h>
43#include <macros.h>
44#include <pcb_edit_frame.h>
45#include <pcbnew_settings.h>
47#include <view/view_controls.h>
48#include <widgets/lib_tree.h>
51#include <project_pcb.h>
52
53
54static wxArrayString s_FootprintHistoryList;
55static unsigned s_FootprintHistoryMaxCount = 8;
56
57static void AddFootprintToHistory( const wxString& aName )
58{
59 // Remove duplicates
60 for( int ii = s_FootprintHistoryList.GetCount() - 1; ii >= 0; --ii )
61 {
62 if( s_FootprintHistoryList[ ii ] == aName )
63 s_FootprintHistoryList.RemoveAt((size_t) ii );
64 }
65
66 // Add the new name at the beginning of the history list
67 s_FootprintHistoryList.Insert( aName, 0 );
68
69 // Remove extra names
71 s_FootprintHistoryList.RemoveAt( s_FootprintHistoryList.GetCount() - 1 );
72}
73
74
75#include <bitmaps.h>
77{
78 bool is_last_fp_from_brd = IsCurrentFPFromBoard();
79
80 FOOTPRINT* newFootprint = nullptr;
82
83 if( frame == nullptr ) // happens if no board editor opened
84 return false;
85
86 if( aFootprint == nullptr )
87 {
88 if( !frame->GetBoard() || !frame->GetBoard()->GetFirstFootprint() )
89 return false;
90
91 aFootprint = SelectFootprintFromBoard( frame->GetBoard() );
92 }
93
94 if( aFootprint == nullptr )
95 return false;
96
97 // Ensure we do not have the pad editor open (that is apseudo modal dlg).
98 // LoadFootprintFromBoard() can be called from the board editor, and we must ensure
99 // no footprint item is currently in edit
100 if( wxWindow::FindWindowByName( PAD_PROPERTIES_DLG_NAME ) )
101 wxWindow::FindWindowByName( PAD_PROPERTIES_DLG_NAME )->Close();
102
103 if( !Clear_Pcb( true ) )
104 return false;
105
106 m_boardFootprintUuids.clear();
107
108 auto recordAndUpdateUuid =
109 [&]( BOARD_ITEM* aItem )
110 {
111 KIID newId;
112 m_boardFootprintUuids[ newId ] = aItem->m_Uuid;
113 const_cast<KIID&>( aItem->m_Uuid ) = newId;
114 };
115
116 newFootprint = (FOOTPRINT*) aFootprint->Clone(); // Keep existing uuids
117 newFootprint->SetParent( GetBoard() );
118 newFootprint->SetParentGroup( nullptr );
119 newFootprint->SetLink( aFootprint->m_Uuid );
120
121 newFootprint->ClearFlags();
122 recordAndUpdateUuid( newFootprint );
123 newFootprint->RunOnDescendants(
124 [&]( BOARD_ITEM* aItem )
125 {
126 if( aItem->Type() == PCB_PAD_T )
127 aItem->SetLocked( false );
128
129 aItem->ClearFlags();
130 recordAndUpdateUuid( aItem );
131 } );
132
133 AddFootprintToBoard( newFootprint );
134
135 // Clear references to any net info, because the footprint editor does know any thing about
136 // nets handled by the current edited board.
137 // Moreover we do not want to save any reference to an unknown net when saving the footprint
138 // in lib cache so we force the ORPHANED dummy net info for all pads.
139 newFootprint->ClearAllNets();
140
142 PlaceFootprint( newFootprint );
143 newFootprint->SetPosition( VECTOR2I( 0, 0 ) ); // cursor in GAL may not yet be initialized
144
145 // Put it on FRONT layer,
146 // because this is the default in Footprint Editor, and in libs
147 if( newFootprint->GetLayer() != F_Cu )
148 {
149 newFootprint->Flip( newFootprint->GetPosition(),
151 }
152
153 // Put it in orientation 0,
154 // because this is the default orientation in Footprint Editor, and in libs
155 newFootprint->SetOrientation( ANGLE_0 );
156
157 Zoom_Automatique( false );
158
159 m_adapter->SetPreselectNode( newFootprint->GetFPID(), 0 );
160
162 GetScreen()->SetContentModified( false );
163
164 // Update the save items if needed.
165 if( !is_last_fp_from_brd )
166 {
169
170 if( IsLibraryTreeShown() )
172 }
173
174 Update3DView( true, true );
175 UpdateView();
176 GetCanvas()->Refresh();
177 m_treePane->GetLibTree()->RefreshLibTree(); // update any previously-highlighted items
178
179 return true;
180}
181
182
184{
185 wxString footprintName;
186 LIB_ID fpid;
187 FOOTPRINT* footprint = nullptr;
188
189 static wxString lastComponentName;
190
191 DIALOG_FOOTPRINT_CHOOSER dialog( this, aPreselect, s_FootprintHistoryList );
192
193 if( dialog.ShowModal() == wxID_CANCEL )
194 return nullptr;
195
196 fpid = dialog.GetSelectedLibId();
197
198 if( !fpid.IsValid() )
199 return nullptr;
200 else
201 footprintName = fpid.Format().wx_str();
202
203 try
204 {
205 footprint = loadFootprint( fpid );
206 }
207 catch( const IO_ERROR& )
208 {
209 }
210
211 if( footprint )
212 {
213 lastComponentName = footprintName;
214 AddFootprintToHistory( footprintName );
215 }
216
217 return footprint;
218}
219
220
222{
223 FOOTPRINT* footprint = nullptr;
224
225 try
226 {
227 footprint = loadFootprint( aFootprintId );
228 }
229 catch( const IO_ERROR& )
230 {
231 }
232
233 return footprint;
234}
235
236
238{
240
241 wxCHECK_MSG( fptbl, nullptr, wxT( "Cannot look up LIB_ID in NULL FP_LIB_TABLE." ) );
242
243 FOOTPRINT *footprint = nullptr;
244
245 // When loading a footprint from a library in the footprint editor
246 // the items UUIDs must be keep and not reinitialized
247 bool keepUUID = IsType( FRAME_FOOTPRINT_EDITOR );
248
249 try
250 {
251 footprint = fptbl->FootprintLoadWithOptionalNickname( aFootprintId, keepUUID );
252 }
253 catch( const IO_ERROR& )
254 {
255 }
256
257 if( footprint )
258 {
259 // If the footprint is found, clear all net info to be sure there are no broken links to
260 // any netinfo list (should be not needed, but it can be edited from the footprint editor )
261 footprint->ClearAllNets();
262
263 if( m_pcb && !m_pcb->IsFootprintHolder() )
264 {
266
268 bds.m_StyleFPShapes );
269 }
270 }
271
272 return footprint;
273}
274
275
277{
278 static wxString oldName; // Save name of last footprint selected.
279
280 wxString fpname;
281 wxString msg;
282 wxArrayString listnames;
283
284 for( FOOTPRINT* footprint : aPcb->Footprints() )
285 listnames.Add( footprint->GetReference() );
286
287 msg.Printf( _( "Footprints [%u items]" ), (unsigned) listnames.GetCount() );
288
289 wxArrayString headers;
290
291 headers.Add( _( "Footprint" ) );
292
293 std::vector<wxArrayString> itemsToDisplay;
294
295 // Conversion from wxArrayString to vector of ArrayString
296 for( unsigned i = 0; i < listnames.GetCount(); i++ )
297 {
298 wxArrayString item;
299
300 item.Add( listnames[i] );
301 itemsToDisplay.push_back( item );
302 }
303
304 EDA_LIST_DIALOG dlg( this, msg, headers, itemsToDisplay, wxEmptyString );
305
306 if( dlg.ShowModal() == wxID_OK )
307 fpname = dlg.GetTextSelection();
308 else
309 return nullptr;
310
311 oldName = fpname;
312
313 for( FOOTPRINT* fp : aPcb->Footprints() )
314 {
315 if( fpname == fp->GetReference() )
316 return fp;
317 }
318
319 return nullptr;
320}
321
322
323bool FOOTPRINT_EDIT_FRAME::SaveLibraryAs( const wxString& aLibraryPath )
324{
325 const wxString& curLibPath = aLibraryPath;
326 wxString dstLibPath = CreateNewLibrary( wxEmptyString, aLibraryPath );
327
328 if( !dstLibPath )
329 return false; // user aborted in CreateNewLibrary()
330
331 wxBusyCursor dummy;
332 wxString msg;
333
336
337 if( dstType == PCB_IO_MGR::FILE_TYPE_NONE )
338 dstType = PCB_IO_MGR::KICAD_SEXP;
339
340 try
341 {
344
345 if( !cur )
346 {
347 msg = wxString::Format( _( "Unable to find a reader for '%s'." ), curLibPath );
348 DisplayError( this, msg );
349 return false;
350 }
351
352 if( !dst )
353 {
354 msg = wxString::Format( _( "Unable to find a writer for '%s'." ), dstLibPath );
355 DisplayError( this, msg );
356 return false;
357 }
358
359 wxArrayString footprints;
360
361 cur->FootprintEnumerate( footprints, curLibPath, false );
362
363 for( unsigned i = 0; i < footprints.size(); ++i )
364 {
365 const FOOTPRINT* footprint = cur->GetEnumeratedFootprint( curLibPath, footprints[i] );
366 dst->FootprintSave( dstLibPath, footprint );
367
368 msg = wxString::Format( _( "Footprint '%s' saved." ), footprints[i] );
369 SetStatusText( msg );
370 }
371 }
372 catch( const IO_ERROR& ioe )
373 {
374 DisplayError( this, ioe.What() );
375 return false;
376 }
377
378 msg = wxString::Format( _( "Footprint library '%s' saved as '%s'." ),
379 curLibPath,
380 dstLibPath );
381
382 DisplayInfoMessage( this, msg );
383
384 SetStatusText( wxEmptyString );
385 return true;
386}
387
388
389static FOOTPRINT* s_FootprintInitialCopy = nullptr; // Copy of footprint for abort/undo command
390
391static PICKED_ITEMS_LIST s_PickedList; // A pick-list to save initial footprint
392 // and dragged tracks
393
394void PCB_BASE_FRAME::PlaceFootprint( FOOTPRINT* aFootprint, bool aRecreateRatsnest )
395{
396 if( aFootprint == nullptr )
397 return;
398
399 OnModify();
400
401 if( aFootprint->IsNew() )
402 {
403 SaveCopyInUndoList( aFootprint, UNDO_REDO::NEWITEM );
404 }
405 else if( aFootprint->IsMoving() )
406 {
407 ITEM_PICKER picker( nullptr, aFootprint, UNDO_REDO::CHANGED );
409 s_PickedList.PushItem( picker );
410 s_FootprintInitialCopy = nullptr; // the picker is now owner of s_ModuleInitialCopy.
411 }
412
413 if( s_PickedList.GetCount() )
414 {
415 SaveCopyInUndoList( s_PickedList, UNDO_REDO::UNSPECIFIED );
416
417 // Clear list, but DO NOT delete items, because they are owned by the saved undo
418 // list and they therefore in use
420 }
421
422 aFootprint->SetPosition( GetCanvas()->GetViewControls()->GetCursorPosition() );
423 aFootprint->ClearFlags();
424
426 s_FootprintInitialCopy = nullptr;
427
428 if( aRecreateRatsnest )
429 m_pcb->GetConnectivity()->Update( aFootprint );
430
431 if( aRecreateRatsnest )
432 Compile_Ratsnest( true );
433
434 SetMsgPanel( aFootprint );
435}
436
437
void SetContentModified(bool aModified=true)
Definition: base_screen.h:59
Container for design settings for a BOARD object.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
void SetParentGroup(PCB_GROUP *aGroup)
Definition: board_item.h:89
virtual void SetLocked(bool aLocked)
Definition: board_item.h:328
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:290
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition: board.h:320
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:448
const FOOTPRINTS & Footprints() const
Definition: board.h:331
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:892
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:475
LIB_ID GetSelectedLibId() const
To be called after this dialog returns from ShowModal().
int ShowModal() override
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
bool IsType(FRAME_T aType) const
void ReCreateMenuBar()
Recreates the menu bar.
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
const KIID m_Uuid
Definition: eda_item.h:489
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:129
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:104
bool IsMoving() const
Definition: eda_item.h:108
bool IsNew() const
Definition: eda_item.h:107
A dialog which shows:
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
bool SaveLibraryAs(const wxString &aLibraryPath)
Save a library to a new name and/or library type.
void ToggleLibraryTree() override
std::map< KIID, KIID > m_boardFootprintUuids
FOOTPRINT * SelectFootprintFromBoard(BOARD *aPcb)
Display the list of footprints currently existing on the BOARD.
void ReCreateHToolbar() override
Create the main horizontal toolbar for the footprint editor.
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
bool IsLibraryTreeShown() const override
bool Clear_Pcb(bool doAskAboutUnsavedChanges)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:105
void AddFootprintToBoard(FOOTPRINT *aFootprint) override
Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board,...
FOOTPRINT_TREE_PANE * m_treePane
bool LoadFootprintFromBoard(FOOTPRINT *aFootprint)
Load a footprint from the main board into the Footprint Editor.
LIB_TREE * GetLibTree() const
void SetPosition(const VECTOR2I &aPos) override
Definition: footprint.cpp:2341
void SetLink(const KIID &aLink)
Definition: footprint.h:853
void SetOrientation(const EDA_ANGLE &aNewAngle)
Definition: footprint.cpp:2411
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction, int aDepth=0) const override
Invoke a function on all descendants.
Definition: footprint.cpp:2064
EDA_ITEM * Clone() const override
Invoke a function on all children.
Definition: footprint.cpp:2032
void ApplyDefaultSettings(const BOARD &board, bool aStyleFields, bool aStyleText, bool aStyleShapes)
Apply default board settings to the footprint field text properties.
Definition: footprint.cpp:616
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: footprint.h:236
const LIB_ID & GetFPID() const
Definition: footprint.h:248
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: footprint.cpp:982
void ClearAllNets()
Clear (i.e.
Definition: footprint.cpp:973
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition: footprint.cpp:2283
VECTOR2I GetPosition() const override
Definition: footprint.h:224
FOOTPRINT * FootprintLoadWithOptionalNickname(const LIB_ID &aFootprintId, bool aKeepUUID=false)
Load a footprint having aFootprintId with possibly an empty nickname.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
void SetLink(EDA_ITEM *aItem)
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
Definition: kiid.h:49
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:406
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:172
UTF8 Format() const
Definition: lib_id.cpp:118
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:440
FLIP_DIRECTION m_FlipDirection
wxString CreateNewLibrary(const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
If a library name is given, creates a new footprint library in the project folder with the given name...
PCBNEW_SETTINGS * GetPcbNewSettings() const
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
virtual void SaveCopyInUndoList(EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand)
Create a new entry in undo list of commands.
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempts to load aFootprintId from the footprint library table.
FOOTPRINT * SelectFootprintFromLibrary(LIB_ID aPreselect=LIB_ID())
Open a dialog to select a footprint.
FOOTPRINT * LoadFootprint(const LIB_ID &aFootprintId)
Attempt to load aFootprintId from the footprint library table.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
void Compile_Ratsnest(bool aDisplayStatus)
Create the entire board ratsnest.
Definition: ratsnest.cpp:35
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
The main frame for Pcbnew.
static PCB_IO * PluginFind(PCB_FILE_T aFileType)
Return a #PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: pcb_io_mgr.cpp:69
PCB_FILE_T
The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written,...
Definition: pcb_io_mgr.h:56
@ FILE_TYPE_NONE
Definition: pcb_io_mgr.h:77
@ KICAD_SEXP
S-expression Pcbnew file format.
Definition: pcb_io_mgr.h:58
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a footprint library's libPath.
Definition: pcb_io_mgr.cpp:136
A holder to handle information on schematic or board items.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
unsigned GetCount() const
void ClearItemsList()
Delete only the list of pickers NOT the picked data itself.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
Definition: project_pcb.cpp:37
wxString wx_str() const
Definition: utf8.cpp:45
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:222
This file is part of the common library.
#define PAD_PROPERTIES_DLG_NAME
DIALOG_PAD_PROPERTIES, derived from DIALOG_PAD_PROPERTIES_BASE, created by wxFormBuilder.
#define _(s)
static constexpr EDA_ANGLE ANGLE_0
Definition: eda_angle.h:401
static wxArrayString s_FootprintHistoryList
static void AddFootprintToHistory(const wxString &aName)
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
Definition: io_mgr.h:33
@ F_Cu
Definition: layer_ids.h:64
static wxArrayString s_FootprintHistoryList
static unsigned s_FootprintHistoryMaxCount
static PICKED_ITEMS_LIST s_PickedList
static FOOTPRINT * s_FootprintInitialCopy
static void AddFootprintToHistory(const wxString &aName)
This file contains miscellaneous commonly used macros and functions.
KIWAY Kiway(KFCTL_STANDALONE)
std::vector< FAB_LAYER_COLOR > dummy
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:691
VECTOR2< double > VECTOR2D
Definition: vector2d.h:690