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 <tool/tool_manager.h>
35 #include <tools/pcb_actions.h>
36 #include <class_board.h>
41 #include <project/project_file.h> // LAST_PATH_TYPE
42 
43 #include <dialog_netlist.h>
44 
45 #include <wx_html_report_panel.h>
46 
47 
49 {
50  wxString netlistName = GetLastPath( LAST_PATH_NETLIST );
51 
52  DIALOG_NETLIST dlg( this, netlistName );
53 
54  dlg.ShowModal();
55 
56  SetLastPath( LAST_PATH_NETLIST, netlistName );
57 }
58 
61 
62 
63 DIALOG_NETLIST::DIALOG_NETLIST( PCB_EDIT_FRAME* aParent, wxString& aNetlistFullFilename )
64  : DIALOG_NETLIST_BASE( aParent ),
65  m_parent( aParent ),
66  m_netlistPath( aNetlistFullFilename ),
67  m_initialized( false ),
68  m_runDragCommand( false )
69 {
71  m_browseButton->SetBitmap( KiBitmap( folder_xpm ) );
72 
73  auto cfg = m_parent->GetPcbNewSettings();
74 
75  m_cbUpdateFootprints->SetValue( cfg->m_NetlistDialog.update_footprints );
76  m_cbDeleteShortingTracks->SetValue( cfg->m_NetlistDialog.delete_shorting_tracks );
77  m_cbDeleteExtraFootprints->SetValue( cfg->m_NetlistDialog.delete_extra_footprints );
78  m_cbDeleteSinglePadNets->SetValue( cfg->m_NetlistDialog.delete_single_pad_nets );
79 
81  m_matchByTimestamp->SetSelection( m_matchByUUID ? 0 : 1 );
82 
83  m_MessageWindow->SetLabel( _("Changes To Be Applied") );
84  m_MessageWindow->SetVisibleSeverities( cfg->m_NetlistDialog.report_filter );
85 
86  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
87  // that requires us to correct the button labels here.
88  m_sdbSizer1OK->SetLabel( _( "Update PCB" ) );
89  m_sdbSizer1Apply->SetLabel( _( "Rebuild Ratsnest" ) );
90  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
91  m_buttonsSizer->Layout();
92 
93  m_sdbSizer1OK->SetDefault();
95 
96  m_initialized = true;
97  loadNetlist( true );
98 }
99 
101 {
102  m_warnForNoNetPads = m_cbWarnNoNetPad->GetValue();
103  m_matchByUUID = m_matchByTimestamp->GetSelection() == 0;
104 
105  auto cfg = m_parent->GetPcbNewSettings();
106 
108  cfg->m_NetlistDialog.update_footprints = m_cbUpdateFootprints->GetValue();
109  cfg->m_NetlistDialog.delete_shorting_tracks = m_cbDeleteShortingTracks->GetValue();
110  cfg->m_NetlistDialog.delete_extra_footprints = m_cbDeleteExtraFootprints->GetValue();
111  cfg->m_NetlistDialog.delete_single_pad_nets = m_cbDeleteSinglePadNets->GetValue();
112 
113  if( m_runDragCommand )
114  {
116  controls->SetCursorPosition( controls->GetMousePosition() );
118  }
119 }
120 
121 
122 void DIALOG_NETLIST::OnOpenNetlistClick( wxCommandEvent& event )
123 {
124  wxString dirPath = wxFileName( Prj().GetProjectFullName() ).GetPath();
125 
126  wxString filename = m_parent->GetLastPath( LAST_PATH_NETLIST );
127 
128  if( !filename.IsEmpty() )
129  {
130  wxFileName fn = filename;
131  dirPath = fn.GetPath();
132  filename = fn.GetFullName();
133  }
134 
135  wxFileDialog FilesDialog( this, _( "Select Netlist" ), dirPath, filename,
136  NetlistFileWildcard(), wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
137 
138  if( FilesDialog.ShowModal() != wxID_OK )
139  return;
140 
141  m_NetlistFilenameCtrl->SetValue( FilesDialog.GetPath() );
143 }
144 
145 void DIALOG_NETLIST::OnUpdatePCB( wxCommandEvent& event )
146 {
147  BOARD* pcb = m_parent->GetBoard();
148  wxFileName fn = m_NetlistFilenameCtrl->GetValue();
149 
150  if( !fn.IsOk() )
151  {
152  wxMessageBox( _("Please, choose a valid netlist file.") );
153  return;
154  }
155 
156  if( !fn.FileExists() )
157  {
158  wxMessageBox( _("The netlist file does not exist.") );
159  return;
160  }
161 
162  // Give the user a chance to bail out when making changes from a netlist.
163  if( pcb->IsEmpty() || IsOK( this, _( "The changes made cannot be undone. "
164  "Are you sure you want to update the PCB?" ) ) )
165  {
166  m_MessageWindow->SetLabel( _( "Changes Applied To PCB" ) );
167  loadNetlist( false );
168 
169  m_sdbSizer1Cancel->SetDefault();
170  }
171 }
172 
173 
174 void DIALOG_NETLIST::OnFilenameKillFocus( wxFocusEvent& event )
175 {
177  event.Skip();
178 }
179 
180 
182 {
183  if( m_initialized )
184  {
185  wxFileName fn = m_NetlistFilenameCtrl->GetValue();
186 
187  if( fn.IsOk() )
188  {
189  if( fn.FileExists() )
190  {
191  m_netlistPath = m_NetlistFilenameCtrl->GetValue();
192  loadNetlist( true );
193  }
194  else
195  {
197  REPORTER& reporter = m_MessageWindow->Reporter();
198  reporter.Report( _( "The netlist file does not exist." ), RPT_SEVERITY_ERROR );
199  }
200  }
201  }
202 }
203 
204 
205 void DIALOG_NETLIST::OnMatchChanged( wxCommandEvent& event )
206 {
207  if( m_initialized )
208  loadNetlist( true );
209 }
210 
211 
212 void DIALOG_NETLIST::OnOptionChanged( wxCommandEvent& event )
213 {
214  if( m_initialized )
215  loadNetlist( true );
216 }
217 
218 
219 void DIALOG_NETLIST::OnCompileRatsnestClick( wxCommandEvent& event )
220 {
221  // Rebuild the board connectivity:
222  auto board = m_parent->GetBoard();
223  board->GetConnectivity()->RecalculateRatsnest();
224 }
225 
226 
227 void DIALOG_NETLIST::loadNetlist( bool aDryRun )
228 {
229  wxString netlistFileName = m_NetlistFilenameCtrl->GetValue();
230  wxFileName fn = netlistFileName;
231 
232  if( !fn.IsOk() || !fn.FileExists() )
233  return;
234 
236  REPORTER& reporter = m_MessageWindow->Reporter();
237 
238  wxBusyCursor busy;
239 
240  wxString msg;
241  msg.Printf( _( "Reading netlist file \"%s\".\n" ), GetChars( netlistFileName ) );
242  reporter.ReportHead( msg, RPT_SEVERITY_INFO );
243 
244  if( m_matchByTimestamp->GetSelection() == 1 )
245  msg = _( "Using reference designators to match components and footprints.\n" );
246  else
247  msg = _( "Using tstamps (unique IDs) to match components and footprints.\n" );
248 
249  reporter.ReportHead( msg, RPT_SEVERITY_INFO );
250  m_MessageWindow->SetLazyUpdate( true ); // Use lazy update to speed the creation of the report
251  // (the window is not updated for each message)
252  m_matchByUUID = m_matchByTimestamp->GetSelection() == 0;
253 
254  NETLIST netlist;
255 
257  netlist.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
258 
259  if( !m_parent->ReadNetlistFromFile( netlistFileName, netlist, reporter ) )
260  return;
261 
263  updater.SetReporter ( &reporter );
264  updater.SetIsDryRun( aDryRun );
265  updater.SetLookupByTimestamp( m_matchByUUID );
266  updater.SetDeleteUnusedComponents ( m_cbDeleteExtraFootprints->GetValue() );
267  updater.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
268  updater.SetDeleteSinglePadNets( m_cbDeleteSinglePadNets->GetValue() );
269  m_warnForNoNetPads = m_cbWarnNoNetPad->GetValue();
270  updater.SetWarnPadNoNetInNetlist( m_warnForNoNetPads );
271  updater.UpdateNetlist( netlist );
272 
273  // The creation of the report was made without window update: the full page must be displayed
274  m_MessageWindow->Flush( true );
275 
276  if( aDryRun )
277  return;
278 
280 }
281 
282 
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:95
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:267
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.
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.
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
void SetReplaceFootprints(bool aReplace)
Definition: pcb_netlist.h:270
NETLIST stores all of information read from a netlist along with the flags used to update the NETLIST...
Definition: pcb_netlist.h:194
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
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:339
Definition of file extensions used in Kicad.
VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (such a...
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
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
#define _(s)
Definition: 3d_actions.cpp:33
wxString & m_netlistPath
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:78
BOARD * GetBoard() const
static bool m_matchByUUID
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:292
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.