KiCad PCB EDA Suite
pcbnew/dialogs/dialog_netlist.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) 1992-2019 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 <fctsys.h>
25 #include <project.h>
26 #include <kiface_i.h>
27 #include <confirm.h>
28 #include <macros.h>
29 #include <html_messagebox.h>
30 #include <pcb_edit_frame.h>
31 #include <pcbnew_settings.h>
32 #include <reporter.h>
33 #include <bitmaps.h>
34 #include <drc/drc.h>
35 #include <drc/drc_item.h>
36 #include <drc/footprint_tester.h>
37 #include <tool/tool_manager.h>
38 #include <tools/pcb_actions.h>
39 #include <class_board.h>
44 #include <project/project_file.h> // LAST_PATH_TYPE
45 
46 #include <dialog_netlist.h>
47 
48 #include <wx_html_report_panel.h>
49 
50 
52 {
53  wxString netlistName = GetLastPath( LAST_PATH_NETLIST );
54 
55  DIALOG_NETLIST dlg( this, netlistName );
56 
57  dlg.ShowModal();
58 
59  SetLastPath( LAST_PATH_NETLIST, netlistName );
60 }
61 
64 
65 
66 DIALOG_NETLIST::DIALOG_NETLIST( PCB_EDIT_FRAME* aParent, wxString& aNetlistFullFilename )
67  : DIALOG_NETLIST_BASE( aParent ),
68  m_parent( aParent ),
69  m_netlistPath( aNetlistFullFilename ),
70  m_initialized( false ),
71  m_runDragCommand( false )
72 {
74  m_browseButton->SetBitmap( KiBitmap( folder_xpm ) );
75 
76  auto cfg = m_parent->GetPcbNewSettings();
77 
78  m_cbUpdateFootprints->SetValue( cfg->m_NetlistDialog.update_footprints );
79  m_cbDeleteShortingTracks->SetValue( cfg->m_NetlistDialog.delete_shorting_tracks );
80  m_cbDeleteExtraFootprints->SetValue( cfg->m_NetlistDialog.delete_extra_footprints );
81  m_cbDeleteSinglePadNets->SetValue( cfg->m_NetlistDialog.delete_single_pad_nets );
82 
84  m_matchByTimestamp->SetSelection( m_matchByUUID ? 0 : 1 );
85 
86  m_MessageWindow->SetLabel( _("Changes To Be Applied") );
87  m_MessageWindow->SetVisibleSeverities( cfg->m_NetlistDialog.report_filter );
88 
89  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
90  // that requires us to correct the button labels here.
91  m_sdbSizer1OK->SetLabel( _( "Update PCB" ) );
92  m_sdbSizer1Apply->SetLabel( _( "Rebuild Ratsnest" ) );
93  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
94  m_buttonsSizer->Layout();
95 
96  m_sdbSizer1OK->SetDefault();
98 
99  m_initialized = true;
100  loadNetlist( true );
101 }
102 
104 {
105  m_warnForNoNetPads = m_cbWarnNoNetPad->GetValue();
106  m_matchByUUID = m_matchByTimestamp->GetSelection() == 0;
107 
108  auto cfg = m_parent->GetPcbNewSettings();
109 
111  cfg->m_NetlistDialog.update_footprints = m_cbUpdateFootprints->GetValue();
112  cfg->m_NetlistDialog.delete_shorting_tracks = m_cbDeleteShortingTracks->GetValue();
113  cfg->m_NetlistDialog.delete_extra_footprints = m_cbDeleteExtraFootprints->GetValue();
114  cfg->m_NetlistDialog.delete_single_pad_nets = m_cbDeleteSinglePadNets->GetValue();
115 
116  if( m_runDragCommand )
117  {
119  controls->SetCursorPosition( controls->GetMousePosition() );
121  }
122 }
123 
124 
125 void DIALOG_NETLIST::OnOpenNetlistClick( wxCommandEvent& event )
126 {
127  wxString dirPath = wxFileName( Prj().GetProjectFullName() ).GetPath();
128 
129  wxString filename = m_parent->GetLastPath( LAST_PATH_NETLIST );
130 
131  if( !filename.IsEmpty() )
132  {
133  wxFileName fn = filename;
134  dirPath = fn.GetPath();
135  filename = fn.GetFullName();
136  }
137 
138  wxFileDialog FilesDialog( this, _( "Select Netlist" ), dirPath, filename,
139  NetlistFileWildcard(), wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
140 
141  if( FilesDialog.ShowModal() != wxID_OK )
142  return;
143 
144  m_NetlistFilenameCtrl->SetValue( FilesDialog.GetPath() );
146 }
147 
148 void DIALOG_NETLIST::OnUpdatePCB( wxCommandEvent& event )
149 {
150  BOARD* pcb = m_parent->GetBoard();
151  wxFileName fn = m_NetlistFilenameCtrl->GetValue();
152 
153  if( !fn.IsOk() )
154  {
155  wxMessageBox( _("Please, choose a valid netlist file.") );
156  return;
157  }
158 
159  if( !fn.FileExists() )
160  {
161  wxMessageBox( _("The netlist file does not exist.") );
162  return;
163  }
164 
165  // Give the user a chance to bail out when making changes from a netlist.
166  if( pcb->IsEmpty() || IsOK( this, _( "The changes made cannot be undone. "
167  "Are you sure you want to update the PCB?" ) ) )
168  {
169  m_MessageWindow->SetLabel( _( "Changes Applied To PCB" ) );
170  loadNetlist( false );
171 
172  m_sdbSizer1Cancel->SetDefault();
173  }
174 }
175 
176 
177 void DIALOG_NETLIST::OnTestFootprintsClick( wxCommandEvent& event )
178 {
179  if( m_parent->GetBoard()->GetFirstModule() == nullptr )
180  {
181  DisplayInfoMessage( this, _( "No footprints." ) );
182  return;
183  }
184 
185  wxString netlistFilename = m_NetlistFilenameCtrl->GetValue();
186  NETLIST netlist;
187  wxBusyCursor dummy; // Shows an hourglass while calculating.
188 
189  if( !m_parent->ReadNetlistFromFile( netlistFilename, netlist, NULL_REPORTER::GetInstance() ) )
190  return;
191 
192  HTML_MESSAGE_BOX dlg( this, _( "Check footprints" ) );
193  std::vector<DRC_ITEM*> drcItems;
194 
195  TestFootprints( netlist, m_parent->GetBoard(), drcItems );
196 
197  for( DRC_ITEM* item : drcItems )
198  dlg.AddHTML_Text( item->ShowHtml( m_parent ) );
199 
200  dlg.ShowModal();
201 }
202 
203 
204 void DIALOG_NETLIST::OnFilenameKillFocus( wxFocusEvent& event )
205 {
207  event.Skip();
208 }
209 
210 
212 {
213  if( m_initialized )
214  {
215  wxFileName fn = m_NetlistFilenameCtrl->GetValue();
216 
217  if( fn.IsOk() )
218  {
219  if( fn.FileExists() )
220  {
221  m_netlistPath = m_NetlistFilenameCtrl->GetValue();
222  loadNetlist( true );
223  }
224  else
225  {
227  REPORTER& reporter = m_MessageWindow->Reporter();
228  reporter.Report( _( "The netlist file does not exist." ), RPT_SEVERITY_ERROR );
229  }
230  }
231  }
232 }
233 
234 
235 void DIALOG_NETLIST::OnMatchChanged( wxCommandEvent& event )
236 {
237  if( m_initialized )
238  loadNetlist( true );
239 }
240 
241 
242 void DIALOG_NETLIST::OnOptionChanged( wxCommandEvent& event )
243 {
244  if( m_initialized )
245  loadNetlist( true );
246 }
247 
248 
249 void DIALOG_NETLIST::OnCompileRatsnestClick( wxCommandEvent& event )
250 {
251  // Rebuild the board connectivity:
252  auto board = m_parent->GetBoard();
253  board->GetConnectivity()->RecalculateRatsnest();
254 }
255 
256 
257 void DIALOG_NETLIST::OnUpdateUIValidNetlistFile( wxUpdateUIEvent& aEvent )
258 {
259  aEvent.Enable( !m_NetlistFilenameCtrl->GetValue().IsEmpty() );
260 }
261 
262 
263 void DIALOG_NETLIST::loadNetlist( bool aDryRun )
264 {
265  wxString netlistFileName = m_NetlistFilenameCtrl->GetValue();
266  wxFileName fn = netlistFileName;
267 
268  if( !fn.IsOk() || !fn.FileExists() )
269  return;
270 
272  REPORTER& reporter = m_MessageWindow->Reporter();
273 
274  wxBusyCursor busy;
275 
276  wxString msg;
277  msg.Printf( _( "Reading netlist file \"%s\".\n" ), GetChars( netlistFileName ) );
278  reporter.ReportHead( msg, RPT_SEVERITY_INFO );
279 
280  if( m_matchByTimestamp->GetSelection() == 1 )
281  msg = _( "Using reference designators to match components and footprints.\n" );
282  else
283  msg = _( "Using tstamps (unique IDs) to match components and footprints.\n" );
284 
285  reporter.ReportHead( msg, RPT_SEVERITY_INFO );
286  m_MessageWindow->SetLazyUpdate( true ); // Use lazy update to speed the creation of the report
287  // (the window is not updated for each message)
288  m_matchByUUID = m_matchByTimestamp->GetSelection() == 0;
289 
290  NETLIST netlist;
291 
294  netlist.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
295 
296  if( !m_parent->ReadNetlistFromFile( netlistFileName, netlist, reporter ) )
297  return;
298 
300  updater.SetReporter ( &reporter );
301  updater.SetIsDryRun( aDryRun );
302  updater.SetLookupByTimestamp( m_matchByUUID );
303  updater.SetDeleteUnusedComponents ( m_cbDeleteExtraFootprints->GetValue() );
304  updater.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
305  updater.SetDeleteSinglePadNets( m_cbDeleteSinglePadNets->GetValue() );
306  m_warnForNoNetPads = m_cbWarnNoNetPad->GetValue();
307  updater.SetWarnPadNoNetInNetlist( m_warnForNoNetPads );
308  updater.UpdateNetlist( netlist );
309 
310  // The creation of the report was made without window update: the full page must be displayed
311  m_MessageWindow->Flush( true );
312 
313  if( aDryRun )
314  return;
315 
317 }
318 
319 
void SetVisibleSeverities(int aSeverities)
Set the visible severity filter.
const BITMAP_OPAQUE folder_xpm[1]
Definition: folder.cpp:20
void SetLazyUpdate(bool aLazyUpdate)
Sets the lasy update.
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:92
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
void OnMatchChanged(wxCommandEvent &event) override
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
PCB_EDIT_FRAME * m_parent
This file is part of the common library.
BOARD_NETLIST_UPDATER updates the BOARD with a new netlist.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
bool ReadNetlistFromFile(const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)
Reads a netlist from a file into a NETLIST object.
void Flush(bool aSort=false)
Forces updating the HTML page, after the report is built in lazy mode If aSort = true,...
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
BOARD_NETLIST_UPDATER class definition.
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Moves cursor to the requested position expressed in world coordinates.
void SetFindByTimeStamp(bool aFindByTimeStamp)
Definition: pcb_netlist.h:309
void SetReporter(REPORTER *aReporter)
Sets the reporter object
PCBNEW_SETTINGS * GetPcbNewSettings()
REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
void OnNetlistChanged(BOARD_NETLIST_UPDATER &aUpdater, bool *aRunDragCommand)
Called after netlist is updated.
void OnTestFootprintsClick(wxCommandEvent &event) override
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
void OnFilenameKillFocus(wxFocusEvent &event) override
wxString GetLastPath(LAST_PATH_TYPE aType)
Get the last path for a particular type.
This file contains miscellaneous commonly used macros and functions.
void TestFootprints(NETLIST &aNetlist, BOARD *aBoard, std::vector< DRC_ITEM * > &aDRCList)
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
void SetReplaceFootprints(bool aReplaceFootprints)
Definition: pcb_netlist.h:313
NETLIST stores all of information read from a netlist along with the flags used to update the NETLIST...
Definition: pcb_netlist.h:212
DIALOG_NETLIST m_NetlistDialog
void OnOpenNetlistClick(wxCommandEvent &event) override
wxString NetlistFileWildcard()
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
REPORTER & Reporter()
returns the reporter object that reports to this panel
void OnOptionChanged(wxCommandEvent &event) override
Subclass of DIALOG_DISPLAY_HTML_TEXT_BASE, which is generated by wxFormBuilder.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:355
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:330
Definition of file extensions used in Kicad.
VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (such a...
HTML_MESSAGE_BOX.
static bool m_warnForNoNetPads
WX_HTML_REPORT_PANEL * m_MessageWindow
virtual REPORTER & ReportHead(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Function ReportHead Places the report at the beginning of the list for objects that support ordering.
Definition: reporter.h:103
void OnUpdatePCB(wxCommandEvent &event) override
DIALOG_NETLIST(PCB_EDIT_FRAME *aParent, wxString &aNetlistFullFilename)
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
void Clear()
clears the report panel
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
#define _(s)
Definition: 3d_actions.cpp:33
void AddHTML_Text(const wxString &message)
Add HTML text (without any change) to message list.
wxString & m_netlistPath
void OnUpdateUIValidNetlistFile(wxUpdateUIEvent &aEvent) override
PCB_EDIT_FRAME is the main frame for Pcbnew.
void OnCompileRatsnestClick(wxCommandEvent &event) override
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:74
void SetDeleteExtraFootprints(bool aDeleteExtraFootprints)
Definition: pcb_netlist.h:298
static REPORTER & GetInstance()
Definition: reporter.cpp:105
BOARD * GetBoard() const
static bool m_matchByUUID
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
void SetLabel(const wxString &aLabel) override
sets the frame label
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:283
bool IsEmpty() const
Definition: class_board.h:311
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.