KiCad PCB EDA Suite
DIALOG_NETLIST Class Reference

#include <dialog_netlist.h>

Inheritance diagram for DIALOG_NETLIST:
DIALOG_NETLIST_FBP DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_NETLIST (PCB_EDIT_FRAME *aParent, wxDC *aDC, const wxString &aNetlistFullFilename)
 
 ~DIALOG_NETLIST ()
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Types

enum  { ID_READ_NETLIST_FILE = 1000, ID_TEST_NETLIST, ID_COMPILE_RATSNEST, ID_OPEN_NELIST }
 

Protected Member Functions

void FinishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void FixOSXCancelButtonIssue ()
 A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms. More...
 

Protected Attributes

wxRadioBox * m_Select_By_Timestamp
 
wxRadioBox * m_ChangeExistingFootprintCtrl
 
wxRadioBox * m_DeleteBadTracks
 
wxRadioBox * m_RemoveExtraFootprintsCtrl
 
wxRadioBox * m_rbSingleNets
 
wxButton * m_buttonRead
 
wxButton * m_buttonClose
 
wxButton * m_buttonFPTest
 
wxButton * m_buttonRebild
 
wxButton * m_buttonSaveMessages
 
wxStaticLine * m_staticline11
 
wxCheckBox * m_checkDryRun
 
wxCheckBox * m_checkBoxSilentMode
 
wxStaticLine * m_staticline1
 
wxStaticText * m_staticTextNetfilename
 
wxTextCtrl * m_NetlistFilenameCtrl
 
wxButton * m_buttonBrowse
 
WX_HTML_REPORT_PANELm_MessageWindow
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

bool verifyFootprints (const wxString &aNetlistFilename, const wxString &aCmpFilename, std::vector< MODULE * > &aDuplicate, wxArrayString &aMissing, std::vector< MODULE * > &aNotInNetlist)
 Function verifyFootprints compares the netlist to the board and builds a list of duplicate, missing, and extra footprints. More...
 
void loadFootprints (NETLIST &aNetlist)
 Function loadFootprints loads the footprints for each COMPONENT in aNetlist from the list of libraries. More...
 
void OnOpenNetlistClick (wxCommandEvent &event) override
 
void OnReadNetlistFileClick (wxCommandEvent &event) override
 
void OnTestFootprintsClick (wxCommandEvent &event) override
 
void OnCompileRatsnestClick (wxCommandEvent &event) override
 
void OnCancelClick (wxCommandEvent &event) override
 
void OnSaveMessagesToFile (wxCommandEvent &aEvent) override
 
void OnClickSilentMode (wxCommandEvent &event) override
 
void OnUpdateUISaveMessagesToFile (wxUpdateUIEvent &aEvent) override
 
void OnUpdateUIValidNetlistFile (wxUpdateUIEvent &aEvent) override
 

Private Attributes

PCB_EDIT_FRAMEm_parent
 
wxDC * m_dc
 
bool m_silentMode
 
wxConfigBase * m_config
 

Detailed Description

Definition at line 38 of file dialog_netlist.h.

Member Enumeration Documentation

anonymous enum
protectedinherited
Enumerator
ID_READ_NETLIST_FILE 
ID_TEST_NETLIST 
ID_COMPILE_RATSNEST 
ID_OPEN_NELIST 

Definition at line 43 of file dialog_netlist_fbp.h.

Constructor & Destructor Documentation

DIALOG_NETLIST::DIALOG_NETLIST ( PCB_EDIT_FRAME aParent,
wxDC *  aDC,
const wxString &  aNetlistFullFilename 
)

Definition at line 98 of file pcbnew/dialogs/dialog_netlist.cpp.

References Kiface(), KIFACE_I::KifaceSettings(), DIALOG_NETLIST_FBP::m_checkBoxSilentMode, m_config, m_dc, DIALOG_NETLIST_FBP::m_MessageWindow, DIALOG_NETLIST_FBP::m_NetlistFilenameCtrl, m_parent, DIALOG_NETLIST_FBP::m_rbSingleNets, m_silentMode, WX_HTML_REPORT_PANEL::MsgPanelSetMinSize(), NETLIST_DELETESINGLEPADNETS_KEY, NETLIST_FILTER_MESSAGES_KEY, NETLIST_SILENTMODE_KEY, and WX_HTML_REPORT_PANEL::SetVisibleSeverities().

100  : DIALOG_NETLIST_FBP( aParent )
101 {
102  m_parent = aParent;
103  m_dc = aDC;
105 
107  bool tmp = m_config->Read( NETLIST_DELETESINGLEPADNETS_KEY, 0l );
108  m_rbSingleNets->SetSelection( tmp == 0 ? 0 : 1);
109  m_NetlistFilenameCtrl->SetValue( aNetlistFullFilename );
110  m_checkBoxSilentMode->SetValue( m_silentMode );
111 
112  int severities = m_config->Read( NETLIST_FILTER_MESSAGES_KEY, -1l );
113  m_MessageWindow->SetVisibleSeverities( severities );
114 
115  // Update sizes and sizers:
116  m_MessageWindow->MsgPanelSetMinSize( wxSize( -1, 150 ) );
117  GetSizer()->SetSizeHints( this );
118 }
void SetVisibleSeverities(int aSeverities)
Set the visible severity filter.
wxCheckBox * m_checkBoxSilentMode
PCB_EDIT_FRAME * m_parent
wxConfigBase * m_config
wxRadioBox * m_rbSingleNets
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
#define NETLIST_DELETESINGLEPADNETS_KEY
#define NETLIST_FILTER_MESSAGES_KEY
#define NETLIST_SILENTMODE_KEY
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:101
DIALOG_NETLIST_FBP(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Netlist"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxTextCtrl * m_NetlistFilenameCtrl
void MsgPanelSetMinSize(const wxSize &aMinSize)
Set the min size of the area which displays html messages:
WX_HTML_REPORT_PANEL * m_MessageWindow

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 181 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

182 {
183  // so we can do logging of this state change:
184 
185 #if defined(DEBUG)
186  const char* type_id = typeid( *this ).name();
187  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
188 #endif
189 
190  return wxDialog::Enable( enable );
191 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 539 of file dialog_shim.cpp.

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

540 {
541  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
542  // handle validation in the same way as other dialogs.
543  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
544  return;
545 
546  SetReturnCode( retCode );
547 
548  if( !IsQuasiModal() )
549  {
550  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
551  return;
552  }
553 
554  m_qmodal_showing = false;
555 
556  if( m_qmodal_loop )
557  {
558  if( m_qmodal_loop->IsRunning() )
559  m_qmodal_loop->Exit( 0 );
560  else
561  m_qmodal_loop->ScheduleExit( 0 );
562 
563  m_qmodal_loop = NULL;
564  }
565 
568 
569  Show( false );
570 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool IsQuasiModal()
Definition: dialog_shim.h:93
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

FinishDialogSettings must be called from derived classes, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 103 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DialogEditModuleText::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_MODULE_MODULE_EDITOR::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_MODULE_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), and DIALOG_SIGNAL_LIST::TransferDataToWindow().

104 {
105  // must be called from the constructor of derived classes,
106  // when all widgets are initialized, and therefore their size fixed
107 
108  // SetSizeHints fixes the minimal size of sizers in the dialog
109  // (SetSizeHints calls Fit(), so no need to call it)
110  GetSizer()->SetSizeHints( this );
111 
112  // the default position, when calling the first time the dlg
113  Center();
114 }
void DIALOG_SHIM::FixOSXCancelButtonIssue ( )
protectedinherited

A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.

Definition at line 116 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

117 {
118 #ifdef __WXMAC__
119  // A ugly hack to fix an issue on OSX: ctrl+c closes the dialog instead of
120  // copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer
121  // created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority
122  // to copy text standard accelerator, and the dlg is closed when trying to copy text
123  wxButton* button = dynamic_cast< wxButton* > ( wxWindow::FindWindowById( wxID_CANCEL, this ) );
124 
125  if( button )
126  button->SetLabel( _( "Cancel" ) );
127 #endif
128 }
KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendOneEEProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), LIB_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), SCH_SHEET::Load(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndLinkFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:85
void DIALOG_NETLIST::loadFootprints ( NETLIST aNetlist)
private

Function loadFootprints loads the footprints for each COMPONENT in aNetlist from the list of libraries.

Parameters
aNetlistis the netlist of components to load the footprints into.
void DIALOG_NETLIST::OnCancelClick ( wxCommandEvent &  event)
overrideprivatevirtual

wxEVT_COMMAND_BUTTON_CLICKED event handler for wxID_CANCEL

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 344 of file pcbnew/dialogs/dialog_netlist.cpp.

345 {
346  EndModal( wxID_CANCEL );
347 }
void DIALOG_NETLIST::OnClickSilentMode ( wxCommandEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 87 of file dialog_netlist.h.

References DIALOG_NETLIST_FBP::m_checkBoxSilentMode.

88  {
89  m_silentMode = m_checkBoxSilentMode->GetValue();
90  }
wxCheckBox * m_checkBoxSilentMode
void DIALOG_NETLIST::OnCompileRatsnestClick ( wxCommandEvent &  event)
overrideprivatevirtual

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_COMPILE_RATSNEST

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 330 of file pcbnew/dialogs/dialog_netlist.cpp.

References PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::GetBoard(), BOARD::GetRatsnest(), EDA_DRAW_FRAME::IsGalCanvasActive(), m_dc, m_parent, and RN_DATA::ProcessBoard().

331 {
332  // Rebuild the board connectivity:
333  if( m_parent->IsGalCanvasActive() )
335 
336  m_parent->Compile_Ratsnest( m_dc, true );
337 }
PCB_EDIT_FRAME * m_parent
BOARD * GetBoard() const
void ProcessBoard()
Function ProcessBoard() Prepares data for computing (computes a list of current nodes and connections...
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:795
RN_DATA * GetRatsnest() const
Function GetRatsnest() returns list of missing connections between components/tracks.
Definition: class_board.h:287
void Compile_Ratsnest(wxDC *aDC, bool aDisplayStatus)
Function Compile_Ratsnest Create the entire board ratsnest.
Definition: ratsnest.cpp:165
void DIALOG_NETLIST::OnOpenNetlistClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 130 of file pcbnew/dialogs/dialog_netlist.cpp.

References GetChars(), PCB_EDIT_FRAME::GetLastNetListRead(), DIALOG_NETLIST_FBP::m_NetlistFilenameCtrl, m_parent, NetlistFileWildcard, and KIWAY_HOLDER::Prj().

131 {
132  wxString lastPath = wxFileName( Prj().GetProjectFullName() ).GetPath();
133 
134  wxString lastNetlistRead = m_parent->GetLastNetListRead();
135 
136  if( !lastNetlistRead.IsEmpty() && !wxFileName::FileExists( lastNetlistRead ) )
137  {
138  lastNetlistRead = wxEmptyString;
139  }
140  else
141  {
142  wxFileName fn = lastNetlistRead;
143  lastPath = fn.GetPath();
144  lastNetlistRead = fn.GetFullName();
145  }
146 
147  wxLogDebug( wxT( "Last net list read path '%s', file name '%s'." ),
148  GetChars( lastPath ), GetChars( lastNetlistRead ) );
149 
150  wxFileDialog FilesDialog( this, _( "Select Netlist" ), lastPath, lastNetlistRead,
151  NetlistFileWildcard, wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
152 
153  if( FilesDialog.ShowModal() != wxID_OK )
154  return;
155 
156  m_NetlistFilenameCtrl->SetValue( FilesDialog.GetPath() );
157 }
PCB_EDIT_FRAME * m_parent
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const wxString NetlistFileWildcard
wxString GetLastNetListRead()
Get the last net list read with the net list dialog box.
Definition: pcbframe.cpp:976
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:92
wxTextCtrl * m_NetlistFilenameCtrl
void DIALOG_NETLIST::OnReadNetlistFileClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 159 of file pcbnew/dialogs/dialog_netlist.cpp.

References WX_HTML_REPORT_PANEL::Clear(), WX_HTML_REPORT_PANEL::Flush(), PCB_BASE_FRAME::GetBoard(), GetChars(), BOARD::IsEmpty(), IsOK(), DIALOG_NETLIST_FBP::m_ChangeExistingFootprintCtrl, DIALOG_NETLIST_FBP::m_checkDryRun, DIALOG_NETLIST_FBP::m_DeleteBadTracks, DIALOG_NETLIST_FBP::m_MessageWindow, DIALOG_NETLIST_FBP::m_NetlistFilenameCtrl, m_parent, DIALOG_NETLIST_FBP::m_rbSingleNets, DIALOG_NETLIST_FBP::m_RemoveExtraFootprintsCtrl, DIALOG_NETLIST_FBP::m_Select_By_Timestamp, m_silentMode, PCB_EDIT_FRAME::ReadPcbNetlist(), REPORTER::Report(), WX_HTML_REPORT_PANEL::Reporter(), REPORTER::RPT_INFO, and WX_HTML_REPORT_PANEL::SetLazyUpdate().

160 {
161  wxString netlistFileName = m_NetlistFilenameCtrl->GetValue();
162  wxFileName fn = netlistFileName;
163 
164  if( !fn.IsOk() )
165  {
166  wxMessageBox( _("Please, choose a valid netlist file") );
167  return;
168  }
169 
170  if( !fn.FileExists() )
171  {
172  wxMessageBox( _("The netlist file does not exist") );
173  return;
174  }
175 
176  // Give the user a chance to bail out when making changes from a netlist.
177  if( !m_checkDryRun->GetValue() && !m_silentMode
178  && !m_parent->GetBoard()->IsEmpty()
179  && !IsOK( NULL, _( "The changes made by reading the netlist cannot be undone. Are you "
180  "sure you want to read the netlist?" ) ) )
181  return;
182 
184  REPORTER& reporter = m_MessageWindow->Reporter();
185 
186  wxBusyCursor busy;
187 
188  wxString msg;
189  msg.Printf( _( "Reading netlist file \"%s\".\n" ), GetChars( netlistFileName ) );
190  reporter.Report( msg, REPORTER::RPT_INFO );
191 
192  if( m_Select_By_Timestamp->GetSelection() == 1 )
193  msg = _( "Using time stamps to match components and footprints.\n" );
194  else
195  msg = _( "Using references to match components and footprints.\n" );
196 
197  reporter.Report( msg, REPORTER::RPT_INFO );
198  m_MessageWindow->SetLazyUpdate( true ); // use a "lazy" update to speed up the creation of the report
199  // (The window is not updated for each message)
200 
201  m_parent->ReadPcbNetlist( netlistFileName, wxEmptyString, &reporter,
202  m_ChangeExistingFootprintCtrl->GetSelection() == 1,
203  m_DeleteBadTracks->GetSelection() == 1,
204  m_RemoveExtraFootprintsCtrl->GetSelection() == 1,
205  m_Select_By_Timestamp->GetSelection() == 1,
206  m_rbSingleNets->GetSelection() == 1,
207  m_checkDryRun->GetValue() );
208  // The creation of the report was made without window update:
209  // the full page must be displayed
211 }
void SetLazyUpdate(bool aLazyUpdate)
Sets the lasy update.
PCB_EDIT_FRAME * m_parent
BOARD * GetBoard() const
wxRadioBox * m_rbSingleNets
wxRadioBox * m_RemoveExtraFootprintsCtrl
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
void ReadPcbNetlist(const wxString &aNetlistFileName, const wxString &aCmpFileName, REPORTER *aReporter, bool aChangeFootprint, bool aDeleteBadTracks, bool aDeleteExtraFootprints, bool aSelectByTimestamp, bool aDeleteSinglePadNets, bool aIsDryRun)
Function ReadPcbNetlist reads aNetlistFileName and updates the footprints (load missing footprints an...
bool IsEmpty() const
Definition: class_board.h:263
REPORTER & Reporter()
returns the reporter object that reports to this panel
wxRadioBox * m_DeleteBadTracks
void Flush()
Forces updating the HTML page, after the report is built in lazy mode
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:92
void Clear()
clears the report panel
wxTextCtrl * m_NetlistFilenameCtrl
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
wxRadioBox * m_ChangeExistingFootprintCtrl
wxCheckBox * m_checkDryRun
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:111
WX_HTML_REPORT_PANEL * m_MessageWindow
wxRadioBox * m_Select_By_Timestamp
void DIALOG_NETLIST::OnSaveMessagesToFile ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 350 of file pcbnew/dialogs/dialog_netlist.cpp.

References GetChars(), PCB_EDIT_FRAME::GetLastNetListRead(), m_parent, KIWAY_HOLDER::Prj(), and TextWildcard.

351 {
352  wxFileName fn;
353 
354  if( !m_parent->GetLastNetListRead().IsEmpty() )
355  {
357  fn.SetExt( wxT( "txt" ) );
358  }
359  else
360  {
361  fn = wxPathOnly( Prj().GetProjectFullName() );
362  }
363 
364  wxFileDialog dlg( this, _( "Save contents of message window" ), fn.GetPath(), fn.GetName(),
365  TextWildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
366 
367  if( dlg.ShowModal() != wxID_OK )
368  return;
369 
370  fn = dlg.GetPath();
371 
372  if( fn.GetExt().IsEmpty() )
373  fn.SetExt( wxT( "txt" ) );
374 
375  wxFile f( fn.GetFullPath(), wxFile::write );
376 
377  if( !f.IsOpened() )
378  {
379  wxString msg;
380 
381  msg.Printf( _( "Cannot write message contents to file \"%s\"." ),
382  GetChars( fn.GetFullPath() ) );
383  wxMessageBox( msg, _( "File Write Error" ), wxOK | wxICON_ERROR, this );
384  return;
385  }
386 }
PCB_EDIT_FRAME * m_parent
const wxString TextWildcard
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxString GetLastNetListRead()
Get the last net list read with the net list dialog box.
Definition: pcbframe.cpp:976
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:92
void DIALOG_NETLIST::OnTestFootprintsClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 214 of file pcbnew/dialogs/dialog_netlist.cpp.

References HTML_MESSAGE_BOX::AddHTML_Text(), CoordinateToString(), DisplayInfoMessage(), ERR_CNT_MAX, PCB_BASE_FRAME::GetBoard(), MODULE::GetPosition(), MODULE::GetReference(), MODULE::GetValue(), BOARD::m_Modules, DIALOG_NETLIST_FBP::m_NetlistFilenameCtrl, m_parent, PCB_EDIT_FRAME::SetLastNetListRead(), verifyFootprints(), wxPoint::x, and wxPoint::y.

215 {
216  if( m_parent->GetBoard()->m_Modules == NULL )
217  {
218  DisplayInfoMessage( this, _( "No footprints" ) );
219  return;
220  }
221 
222  // Lists of duplicates, missing references and not in netlist footprints:
223  std::vector <MODULE*> duplicate;
224  wxArrayString missing;
225  std::vector <MODULE*> notInNetlist;
226  wxString netlistFilename = m_NetlistFilenameCtrl->GetValue();
227 
228  if( !verifyFootprints( netlistFilename, wxEmptyString, duplicate, missing, notInNetlist ) )
229  return;
230 
231  #define ERR_CNT_MAX 100 // Max number of errors to output in dialog
232  // to avoid a too long message list
233 
234  wxString list; // The messages to display
235 
236  m_parent->SetLastNetListRead( netlistFilename );
237 
238  int err_cnt = 0;
239 
240  // Search for duplicate footprints.
241  if( duplicate.size() == 0 )
242  list << wxT("<p><b>") << _( "No duplicate." ) << wxT("</b></p>");
243  else
244  {
245  list << wxT("<p><b>") << _( "Duplicates:" ) << wxT("</b></p>");
246 
247  for( unsigned ii = 0; ii < duplicate.size(); ii++ )
248  {
249  MODULE* module = duplicate[ii];
250 
251  if( module->GetReference().IsEmpty() )
252  list << wxT("<br>") << wxT("[noref)");
253  else
254  list << wxT("<br>") << module->GetReference();
255 
256  list << wxT(" (<i>") << module->GetValue() << wxT("</i>)");
257  list << wxT(" @ ");
258  list << CoordinateToString( module->GetPosition().x ),
259  list << wxT(", ") << CoordinateToString( module->GetPosition().y ),
260  err_cnt++;
261 
262  if( ERR_CNT_MAX < err_cnt )
263  break;
264  }
265  }
266 
267  // Search for missing modules on board.
268  if( missing.size() == 0 )
269  list << wxT("<p><b>") << _( "No missing footprints." ) << wxT("</b></p>");
270  else
271  {
272  list << wxT("<p><b>") << _( "Missing:" ) << wxT("</b></p>");
273 
274  for( unsigned ii = 0; ii < missing.size(); ii += 2 )
275  {
276  list << wxT("<br>") << missing[ii];
277  list << wxT(" (<i>") << missing[ii+1] << wxT("</i>)");
278  err_cnt++;
279 
280  if( ERR_CNT_MAX < err_cnt )
281  break;
282  }
283  }
284 
285 
286  // Search for modules found on board but not in net list.
287  if( notInNetlist.size() == 0 )
288  list << wxT( "<p><b>" ) << _( "No extra footprints." ) << wxT( "</b></p>" );
289  else
290  {
291  list << wxT( "<p><b>" ) << _( "Not in Netlist:" ) << wxT( "</b></p>" );
292 
293  for( unsigned ii = 0; ii < notInNetlist.size(); ii++ )
294  {
295  MODULE* module = notInNetlist[ii];
296 
297  if( module->GetReference().IsEmpty() )
298  list << wxT( "<br>" ) << wxT( "[noref)" );
299  else
300  list << wxT( "<br>" ) << module->GetReference() ;
301 
302  list << wxT( " (<i>" ) << module->GetValue() << wxT( "</i>)" );
303  list << wxT( " @ " );
304  list << CoordinateToString( module->GetPosition().x ),
305  list << wxT( ", " ) << CoordinateToString( module->GetPosition().y ),
306  err_cnt++;
307 
308  if( ERR_CNT_MAX < err_cnt )
309  break;
310  }
311  }
312 
313  if( ERR_CNT_MAX < err_cnt )
314  {
315  list << wxT( "<p><b>" )
316  << _( "Too many errors: some are skipped" )
317  << wxT( "</b></p>" );
318  }
319 
320  HTML_MESSAGE_BOX dlg( this, _( "Check footprints" ) );
321  dlg.AddHTML_Text( list );
322  dlg.ShowModal();
323 }
wxString CoordinateToString(int aValue, bool aConvertToMils)
Function CoordinateToString is a helper to convert the integer coordinate aValue to a string in inche...
Definition: base_units.cpp:117
PCB_EDIT_FRAME * m_parent
void SetLastNetListRead(const wxString &aNetListFile)
Set the last net list successfully read by the net list dialog box.
Definition: pcbframe.cpp:991
const wxPoint & GetPosition() const override
Definition: class_module.h:143
BOARD * GetBoard() const
const wxString & GetValue() const
Function GetValue.
Definition: class_module.h:439
Class HTML_MESSAGE_BOX.
void DisplayInfoMessage(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:89
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:411
DLIST< MODULE > m_Modules
Definition: class_board.h:243
wxTextCtrl * m_NetlistFilenameCtrl
bool verifyFootprints(const wxString &aNetlistFilename, const wxString &aCmpFilename, std::vector< MODULE * > &aDuplicate, wxArrayString &aMissing, std::vector< MODULE * > &aNotInNetlist)
Function verifyFootprints compares the netlist to the board and builds a list of duplicate, missing, and extra footprints.
#define ERR_CNT_MAX
void DIALOG_NETLIST::OnUpdateUISaveMessagesToFile ( wxUpdateUIEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 389 of file pcbnew/dialogs/dialog_netlist.cpp.

390 {
391  //aEvent.Enable( !m_MessageWindow->IsEmpty() );
392 }
void DIALOG_NETLIST::OnUpdateUIValidNetlistFile ( wxUpdateUIEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_FBP.

Definition at line 395 of file pcbnew/dialogs/dialog_netlist.cpp.

References DIALOG_NETLIST_FBP::m_NetlistFilenameCtrl.

396 {
397  aEvent.Enable( !m_NetlistFilenameCtrl->GetValue().IsEmpty() );
398 }
wxTextCtrl * m_NetlistFilenameCtrl
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 34 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_SCREEN::CheckComponentsToPartsLinks(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), SCH_EDIT_FRAME::CreateArchiveLibrary(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), LIB_EDIT_FRAME::DeleteOnePart(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EESCHEMA_CONFIG::DIALOG_EESCHEMA_CONFIG(), DIALOG_FP_LIB_TABLE::DIALOG_FP_LIB_TABLE(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), LIB_EDIT_FRAME::GetCurPart(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), FOOTPRINT_EDIT_FRAME::getLibPath(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_EDIT_FRAME::InstallConfigFrame(), SCH_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), CVPCB_MAINFRAME::LoadFootprintFiles(), SCH_EDIT_FRAME::LoadOneEEFile(), LIB_EDIT_FRAME::LoadOneLibraryPart(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertLibClick(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertPath(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), LIB_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectIcLib(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OnSelectUnit(), DIALOG_SPICE_MODEL::onSemiSelectLib(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), FP_LOADER_THREAD::ProcessEntry(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndLinkFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), SCH_EDIT_FRAME::RescueProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_SCREEN::Save(), LIB_EDIT_FRAME::SaveActiveLibrary(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_ERC::TestErc(), DIALOG_SPICE_MODEL::updateFromFile(), SIM_PLOT_FRAME::updateNetlistExporter(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), CVPCB_MAINFRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_MODULE_BOARD_EDITOR::~DIALOG_MODULE_BOARD_EDITOR(), and DIALOG_MODULE_MODULE_EDITOR::~DIALOG_MODULE_MODULE_EDITOR().

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:144
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_player.h:85
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 138 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::FixOSXCancelButtonIssue(), EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), CVPCB_MAINFRAME::ReadNetListAndLinkFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

139 {
140  bool ret;
141  const char* hash_key;
142 
143  if( m_hash_key.size() )
144  {
145  // a special case like EDA_LIST_DIALOG, which has multiple uses.
146  hash_key = m_hash_key.c_str();
147  }
148  else
149  {
150  hash_key = typeid(*this).name();
151  }
152 
153  // Show or hide the window. If hiding, save current position and size.
154  // If showing, use previous position and size.
155  if( show )
156  {
157  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
158  ret = wxDialog::Show( show );
159 
160  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
161  EDA_RECT r = class_map[ hash_key ];
162 
163  if( r.GetSize().x != 0 && r.GetSize().y != 0 )
164  SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
165  }
166  else
167  {
168  // Save the dialog's position & size before hiding, using classname as key
169  EDA_RECT r( wxDialog::GetPosition(), wxDialog::GetSize() );
170  class_map[ hash_key ] = r;
171 
172  ret = wxDialog::Show( show );
173  }
174 
176 
177  return ret;
178 }
std::string m_hash_key
Definition: dialog_shim.h:128
void FixOSXCancelButtonIssue()
A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.
static RECT_MAP class_map
const wxPoint & GetPosition() const
Class EDA_RECT handles the component boundary box.
const wxSize & GetSize() const
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 494 of file dialog_shim.cpp.

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

495 {
496  // This is an exception safe way to zero a pointer before returning.
497  // Yes, even though DismissModal() clears this first normally, this is
498  // here in case there's an exception before the dialog is dismissed.
499  struct NULLER
500  {
501  void*& m_what;
502  NULLER( void*& aPtr ) : m_what( aPtr ) {}
503  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
504  } clear_this( (void*&) m_qmodal_loop );
505 
506  // release the mouse if it's currently captured as the window having it
507  // will be disabled when this dialog is shown -- but will still keep the
508  // capture making it impossible to do anything in the modal dialog itself
509  wxWindow* win = wxWindow::GetCapture();
510  if( win )
511  win->ReleaseMouse();
512 
513  // Get the optimal parent
514  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
515 
516  // Show the optimal parent
517  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
518 
519  wxASSERT_MSG( !m_qmodal_parent_disabler,
520  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
521 
522  // quasi-modal: disable only my "optimal" parent
524 
525  Show( true );
526 
527  m_qmodal_showing = true;
528 
529  EVENT_LOOP event_loop;
530 
531  m_qmodal_loop = &event_loop;
532 
533  event_loop.Run();
534 
535  return GetReturnCode();
536 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:33
#define DBG(x)
Definition: fctsys.h:33
bool DIALOG_NETLIST::verifyFootprints ( const wxString &  aNetlistFilename,
const wxString &  aCmpFilename,
std::vector< MODULE * > &  aDuplicate,
wxArrayString &  aMissing,
std::vector< MODULE * > &  aNotInNetlist 
)
private

Function verifyFootprints compares the netlist to the board and builds a list of duplicate, missing, and extra footprints.

Parameters
aNetlistFilenamethe netlist filename.
aCmpFilenamethe component link filename.
aDuplicatethe list of duplicate modules to populate
aMissingthe list of missing module references and values to populate. For each missing item, the first string is the reference designator and the second is the value.
aNotInNetlistis the list of component footprint found in the netlist but not on the board.
Returns
true if no errors occurred while reading the netlist. Otherwise false.

Definition at line 401 of file pcbnew/dialogs/dialog_netlist.cpp.

References MODULE::Add(), dummy(), BOARD::FindModuleByReference(), PCB_BASE_FRAME::GetBoard(), GetChars(), NETLIST::GetComponent(), NETLIST::GetComponentByReference(), NETLIST::GetCount(), NETLIST_READER::GetNetlistReader(), COMPONENT::GetReference(), MODULE::GetReference(), COMPONENT::GetValue(), NETLIST_READER::LoadNetlist(), BOARD::m_Modules, m_parent, MODULE::Next(), and IO_ERROR::What().

Referenced by OnTestFootprintsClick().

406 {
407  wxString msg;
408  MODULE* module;
409  MODULE* nextModule;
410  NETLIST netlist;
411  wxBusyCursor dummy; // Shows an hourglass while calculating.
412  NETLIST_READER* netlistReader;
413  COMPONENT* component;
414 
415  try
416  {
417  netlistReader = NETLIST_READER::GetNetlistReader( &netlist, aNetlistFilename,
418  aCmpFilename );
419 
420  if( netlistReader == NULL )
421  {
422  msg.Printf( _( "Cannot open netlist file \"%s\"." ), GetChars( aNetlistFilename ) );
423  wxMessageBox( msg, _( "Netlist Load Error." ), wxOK | wxICON_ERROR );
424  return false;
425  }
426 
427  std::unique_ptr< NETLIST_READER > nlr( netlistReader );
428  netlistReader->LoadNetlist();
429  }
430  catch( const IO_ERROR& ioe )
431  {
432  msg.Printf( _( "Error loading netlist file:\n%s" ), ioe.What().GetData() );
433  wxMessageBox( msg, _( "Netlist Load Error" ), wxOK | wxICON_ERROR );
434  return false;
435  }
436 
437  BOARD* pcb = m_parent->GetBoard();
438 
439  // Search for duplicate footprints.
440  module = pcb->m_Modules;
441 
442  for( ; module != NULL; module = module->Next() )
443  {
444  nextModule = module->Next();
445 
446  for( ; nextModule != NULL; nextModule = nextModule->Next() )
447  {
448  if( module->GetReference().CmpNoCase( nextModule->GetReference() ) == 0 )
449  {
450  aDuplicates.push_back( module );
451  break;
452  }
453  }
454  }
455 
456  // Search for component footprints in the netlist but not on the board.
457  for( unsigned ii = 0; ii < netlist.GetCount(); ii++ )
458  {
459  component = netlist.GetComponent( ii );
460 
461  module = pcb->FindModuleByReference( component->GetReference() );
462 
463  if( module == NULL )
464  {
465  aMissing.Add( component->GetReference() );
466  aMissing.Add( component->GetValue() );
467  }
468  }
469 
470  // Search for component footprints found on board but not in netlist.
471  module = pcb->m_Modules;
472 
473  for( ; module != NULL; module = module->Next() )
474  {
475 
476  component = netlist.GetComponentByReference( module->GetReference() );
477 
478  if( component == NULL )
479  aNotInNetlist.push_back( module );
480  }
481 
482  return true;
483 }
void Add(BOARD_ITEM *aBoardItem, ADD_MODE aMode=ADD_INSERT) override
>
PCB_EDIT_FRAME * m_parent
MODULE * Next() const
Definition: class_module.h:99
static NETLIST_READER * GetNetlistReader(NETLIST *aNetlist, const wxString &aNetlistFileName, const wxString &aCompFootprintFileName=wxEmptyString)
Function GetNetlistReader attempts to determine the net list file type of aNetlistFileName and return...
MODULE * FindModuleByReference(const wxString &aReference) const
Function FindModuleByReference searches for a MODULE within this board with the given reference desig...
BOARD * GetBoard() const
const wxString & GetReference() const
Definition: pcb_netlist.h:149
const wxString & GetValue() const
Definition: pcb_netlist.h:151
virtual void LoadNetlist()=0
Function LoadNetlist loads the contents of the netlist file into aNetlist.
Class NETLIST stores all of information read from a netlist along with the flags used to update the N...
Definition: pcb_netlist.h:205
Class NETLIST_READER is a pure virtual class to derive a specific type of netlist reader from...
Class COMPONENT is used to store components and all of their related information found in a netlist...
Definition: pcb_netlist.h:83
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:256
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
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:92
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:411
DLIST< MODULE > m_Modules
Definition: class_board.h:243
COMPONENT * GetComponentByReference(const wxString &aReference)
Function GetComponentByReference returns a COMPONENT by aReference.
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:247
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47

Member Data Documentation

wxButton* DIALOG_NETLIST_FBP::m_buttonBrowse
protectedinherited
wxButton* DIALOG_NETLIST_FBP::m_buttonClose
protectedinherited
wxButton* DIALOG_NETLIST_FBP::m_buttonFPTest
protectedinherited
wxButton* DIALOG_NETLIST_FBP::m_buttonRead
protectedinherited
wxButton* DIALOG_NETLIST_FBP::m_buttonRebild
protectedinherited
wxButton* DIALOG_NETLIST_FBP::m_buttonSaveMessages
protectedinherited
wxRadioBox* DIALOG_NETLIST_FBP::m_ChangeExistingFootprintCtrl
protectedinherited
wxCheckBox* DIALOG_NETLIST_FBP::m_checkBoxSilentMode
protectedinherited
wxCheckBox* DIALOG_NETLIST_FBP::m_checkDryRun
protectedinherited
wxConfigBase* DIALOG_NETLIST::m_config
private

Definition at line 44 of file dialog_netlist.h.

Referenced by DIALOG_NETLIST(), and ~DIALOG_NETLIST().

wxDC* DIALOG_NETLIST::m_dc
private

Definition at line 42 of file dialog_netlist.h.

Referenced by DIALOG_NETLIST(), and OnCompileRatsnestClick().

wxRadioBox* DIALOG_NETLIST_FBP::m_DeleteBadTracks
protectedinherited
std::string DIALOG_SHIM::m_hash_key
protectedinherited
WX_HTML_REPORT_PANEL* DIALOG_NETLIST_FBP::m_MessageWindow
protectedinherited
wxTextCtrl* DIALOG_NETLIST_FBP::m_NetlistFilenameCtrl
protectedinherited
EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 131 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited
wxRadioBox* DIALOG_NETLIST_FBP::m_rbSingleNets
protectedinherited
wxRadioBox* DIALOG_NETLIST_FBP::m_RemoveExtraFootprintsCtrl
protectedinherited
wxRadioBox* DIALOG_NETLIST_FBP::m_Select_By_Timestamp
protectedinherited
bool DIALOG_NETLIST::m_silentMode
private

Definition at line 43 of file dialog_netlist.h.

Referenced by DIALOG_NETLIST(), OnReadNetlistFileClick(), and ~DIALOG_NETLIST().

wxStaticLine* DIALOG_NETLIST_FBP::m_staticline1
protectedinherited

Definition at line 64 of file dialog_netlist_fbp.h.

Referenced by DIALOG_NETLIST_FBP::DIALOG_NETLIST_FBP().

wxStaticLine* DIALOG_NETLIST_FBP::m_staticline11
protectedinherited

Definition at line 61 of file dialog_netlist_fbp.h.

Referenced by DIALOG_NETLIST_FBP::DIALOG_NETLIST_FBP().

wxStaticText* DIALOG_NETLIST_FBP::m_staticTextNetfilename
protectedinherited

Definition at line 65 of file dialog_netlist_fbp.h.

Referenced by DIALOG_NETLIST_FBP::DIALOG_NETLIST_FBP().


The documentation for this class was generated from the following files: