KiCad PCB EDA Suite
DIALOG_NETLIST Class Reference

#include <dialog_netlist.h>

Inheritance diagram for DIALOG_NETLIST:
DIALOG_NETLIST_BASE 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
 
void OnPaint (wxPaintEvent &event)
 
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 }
 

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 SetSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int HorizPixelsFromDU (int x)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. 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
 
wxStaticLine * m_staticline11
 
wxCheckBox * m_checkDryRun
 
wxCheckBox * m_checkBoxSilentMode
 
wxStaticLine * m_staticline1
 
wxTextCtrl * m_NetlistFilenameCtrl
 
wxBitmapButton * m_browseButton
 
WX_HTML_REPORT_PANELm_MessageWindow
 
bool m_fixupsRun
 
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 OnClickSilentMode (wxCommandEvent &event) 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

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 KiBitmap(), Kiface(), KIFACE_I::KifaceSettings(), DIALOG_NETLIST_BASE::m_browseButton, DIALOG_NETLIST_BASE::m_checkBoxSilentMode, m_config, m_dc, DIALOG_NETLIST_BASE::m_MessageWindow, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, m_parent, DIALOG_NETLIST_BASE::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_BASE( 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_browseButton->SetBitmap( KiBitmap( browse_files_xpm ) );
110  m_NetlistFilenameCtrl->SetValue( aNetlistFullFilename );
111  m_checkBoxSilentMode->SetValue( m_silentMode );
112 
113  int severities = m_config->Read( NETLIST_FILTER_MESSAGES_KEY, -1l );
114  m_MessageWindow->SetVisibleSeverities( severities );
115 
116  // Update sizes and sizers:
117  m_MessageWindow->MsgPanelSetMinSize( wxSize( -1, 160 ) );
118  GetSizer()->SetSizeHints( this );
119 }
void SetVisibleSeverities(int aSeverities)
Set the visible severity filter.
PCB_EDIT_FRAME * m_parent
wxConfigBase * m_config
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:78
#define NETLIST_DELETESINGLEPADNETS_KEY
#define NETLIST_FILTER_MESSAGES_KEY
#define NETLIST_SILENTMODE_KEY
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
WX_HTML_REPORT_PANEL * m_MessageWindow
void MsgPanelSetMinSize(const wxSize &aMinSize)
Set the min size of the area which displays html messages:
DIALOG_NETLIST_BASE(wxWindow *parent, wxWindowID id=wxID_CANCEL, const wxString &title=_("Netlist"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 205 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues(), and DIALOG_SHIM::IsQuasiModal().

206 {
207  // so we can do logging of this state change:
208 
209 #if defined(DEBUG)
210  const char* type_id = typeid( *this ).name();
211  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
212 #endif
213 
214  return wxDialog::Enable( enable );
215 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 610 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 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_FOOTPRINTS::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

611 {
612  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
613  // handle validation in the same way as other dialogs.
614  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
615  return;
616 
617  SetReturnCode( retCode );
618 
619  if( !IsQuasiModal() )
620  {
621  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
622  return;
623  }
624 
625  m_qmodal_showing = false;
626 
627  if( m_qmodal_loop )
628  {
629  if( m_qmodal_loop->IsRunning() )
630  m_qmodal_loop->Exit( 0 );
631  else
632  m_qmodal_loop->ScheduleExit( 0 );
633 
634  m_qmodal_loop = NULL;
635  }
636 
639 
640  Show( false );
641 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool IsQuasiModal()
Definition: dialog_shim.h:103
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
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 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by COLOR4D_PICKER_DLG::COLOR4D_PICKER_DLG(), DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), 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_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG(), 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_PADS_MASK_CLEARANCE::DIALOG_PADS_MASK_CLEARANCE(), 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(), DIALOG_SHIM::IsQuasiModal(), 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(), DIALOG_EDIT_FPTEXT::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_FOOTPRINT_FP_EDITOR::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), and DIALOG_UPDATE_FIELDS::TransferDataToWindow().

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

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 125 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), and DIALOG_SHIM::IsQuasiModal().

126 {
127  wxSize sz( x, 0 );
128  return ConvertDialogToPixels( sz ).x;
129 }
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, KIWAY_HOLDER::Prj(), and KIWAY_HOLDER::SetKiway().

Referenced by SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), FOOTPRINT_EDIT_FRAME::GetIconScale(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_CHOOSE_COMPONENT::OnIdle(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), 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::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_WIZARD_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), 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_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_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(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::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_BASE.

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

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

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 86 of file dialog_netlist.h.

References DIALOG_NETLIST_BASE::m_checkBoxSilentMode, and OnUpdateUIValidNetlistFile().

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

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_COMPILE_RATSNEST

Reimplemented from DIALOG_NETLIST_BASE.

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

References PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), and m_parent.

332 {
333  // Rebuild the board connectivity:
334  auto board = m_parent->GetBoard();
335  board->GetConnectivity()->RecalculateRatsnest();
336 }
PCB_EDIT_FRAME * m_parent
BOARD * GetBoard() const
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
void DIALOG_NETLIST::OnOpenNetlistClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

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

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

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

Definition at line 271 of file dialog_shim.cpp.

References DIALOG_SHIM::m_fixupsRun, and recursiveDescent().

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

272 {
273  if( !m_fixupsRun )
274  {
275 #if DLGSHIM_SELECT_ALL_IN_TEXT_CONTROLS
276  const bool selectAllInTextCtrls = true;
277 #else
278  const bool selectAllInTextCtrls = false;
279 #endif
280  wxWindow* firstTextCtrl = NULL;
281  wxWindow* windowWithFocus = NULL;
282 
283  recursiveDescent( GetChildren(), selectAllInTextCtrls, firstTextCtrl,
284  windowWithFocus );
285 
286 #if DLGSHIM_USE_SETFOCUS
287  // While it would be nice to honour any focus already set (which was
288  // recorded in windowWithFocus), the reality is that it's currently wrong
289  // far more often than it's right.
290  // So just focus on the first text control if we have one; otherwise the
291  // focus on the dialog itself, which will at least allow esc, return, etc.
292  // to function.
293  if( firstTextCtrl )
294  firstTextCtrl->SetFocus();
295  else
296  SetFocus();
297 #endif
298 
299 #ifdef __WXMAC__
300  fixOSXCancelButtonIssue( this );
301 #endif
302 
303  m_fixupsRun = true;
304  }
305 
306  event.Skip();
307 }
static void recursiveDescent(wxWindowList &children, const bool selectTextInTextCtrls, wxWindow *&firstTextCtrl, wxWindow *&windowWithFocus)
bool m_fixupsRun
Definition: dialog_shim.h:149
void DIALOG_NETLIST::OnReadNetlistFileClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 160 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_BASE::m_ChangeExistingFootprintCtrl, DIALOG_NETLIST_BASE::m_checkDryRun, DIALOG_NETLIST_BASE::m_DeleteBadTracks, DIALOG_NETLIST_BASE::m_MessageWindow, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, m_parent, DIALOG_NETLIST_BASE::m_rbSingleNets, DIALOG_NETLIST_BASE::m_RemoveExtraFootprintsCtrl, DIALOG_NETLIST_BASE::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().

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

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 215 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_BASE::m_NetlistFilenameCtrl, m_parent, PCB_EDIT_FRAME::SetLastNetListRead(), verifyFootprints(), wxPoint::x, and wxPoint::y.

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

Reimplemented from DIALOG_NETLIST_BASE.

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

References DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl.

Referenced by OnClickSilentMode().

350 {
351  aEvent.Enable( !m_NetlistFilenameCtrl->GetValue().IsEmpty() );
352 }
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::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_FOOTPRINT_FP_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkNewAlias(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_FOOTPRINT_FP_EDITOR::Edit3DShapeFileName(), DIALOG_FOOTPRINT_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::Files_io_from_id(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_EDIT_FRAME::getLibraryFileName(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), KIWAY_HOLDER::Kiway(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OnLeftClick(), OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), 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(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), 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(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), and DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_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:142
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, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), KIWAY_HOLDER::Kiway(), 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
const char * name
Definition: DXF_plotter.cpp:61
void DIALOG_SHIM::SetSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 118 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), HOTKEYS_EDITOR_DIALOG::HOTKEYS_EDITOR_DIALOG(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_SHIM::IsQuasiModal(), DIALOG_LAYERS_SETUP::OnInitDialog(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

119 {
120  wxSize sz( x, y );
121  SetSize( ConvertDialogToPixels( sz ) );
122 }
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 146 of file dialog_shim.cpp.

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

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SHIM::IsQuasiModal(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_FOOTPRINTS::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), SCH_COMPONENT::SetPosition(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

147 {
148  bool ret;
149  const char* hash_key;
150 
151  if( m_hash_key.size() )
152  {
153  // a special case like EDA_LIST_DIALOG, which has multiple uses.
154  hash_key = m_hash_key.c_str();
155  }
156  else
157  {
158  hash_key = typeid(*this).name();
159  }
160 
161  // Show or hide the window. If hiding, save current position and size.
162  // If showing, use previous position and size.
163  if( show )
164  {
165 #ifndef __WINDOWS__
166  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
167 #endif
168  ret = wxDialog::Show( show );
169 
170  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
171  EDA_RECT savedDialogRect = class_map[ hash_key ];
172 
173  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
174  {
175  SetSize( savedDialogRect.GetPosition().x,
176  savedDialogRect.GetPosition().y,
177  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
178  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
179  0 );
180  }
181 
182  // Be sure that the dialog appears in a visible area
183  // (the dialog position might have been stored at the time when it was
184  // shown on another display)
185  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
186  Centre();
187  }
188  else
189  {
190  // Save the dialog's position & size before hiding, using classname as key
191  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
192 
193 #ifdef __WXMAC__
194  if ( m_eventLoop )
195  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
196 #endif
197 
198  ret = wxDialog::Show( show );
199  }
200 
201  return ret;
202 }
const wxSize GetSize() const
Definition: eda_rect.h:101
std::string m_hash_key
Definition: dialog_shim.h:151
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:113
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 558 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 SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogCreateBOMEditor(), InvokeDialogEditComponentsLibId(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

559 {
560  // This is an exception safe way to zero a pointer before returning.
561  // Yes, even though DismissModal() clears this first normally, this is
562  // here in case there's an exception before the dialog is dismissed.
563  struct NULLER
564  {
565  void*& m_what;
566  NULLER( void*& aPtr ) : m_what( aPtr ) {}
567  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
568  } clear_this( (void*&) m_qmodal_loop );
569 
570  // release the mouse if it's currently captured as the window having it
571  // will be disabled when this dialog is shown -- but will still keep the
572  // capture making it impossible to do anything in the modal dialog itself
573  wxWindow* win = wxWindow::GetCapture();
574  if( win )
575  win->ReleaseMouse();
576 
577  // Get the optimal parent
578  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
579 
580  // Show the optimal parent
581  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
582 
583  wxASSERT_MSG( !m_qmodal_parent_disabler,
584  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
585 
586  // quasi-modal: disable only my "optimal" parent
588 
589 #ifdef __WXMAC__
590  // Apple in its infinite wisdom will raise a disabled window before even passing
591  // us the event, so we have no way to stop it. Instead, we must set an order on
592  // the windows so that the quasi-modal will be pushed in front of the disabled
593  // window when it is raised.
594  ReparentQuasiModal();
595 #endif
596  Show( true );
597 
598  m_qmodal_showing = true;
599 
600  EVENT_LOOP event_loop;
601 
602  m_qmodal_loop = &event_loop;
603 
604  event_loop.Run();
605 
606  return GetReturnCode();
607 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
Toggle a window&#39;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 355 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().

360 {
361  wxString msg;
362  MODULE* module;
363  MODULE* nextModule;
364  NETLIST netlist;
365  wxBusyCursor dummy; // Shows an hourglass while calculating.
366  NETLIST_READER* netlistReader;
367  COMPONENT* component;
368 
369  try
370  {
371  netlistReader = NETLIST_READER::GetNetlistReader( &netlist, aNetlistFilename,
372  aCmpFilename );
373 
374  if( netlistReader == NULL )
375  {
376  msg.Printf( _( "Cannot open netlist file \"%s\"." ), GetChars( aNetlistFilename ) );
377  wxMessageBox( msg, _( "Netlist Load Error." ), wxOK | wxICON_ERROR );
378  return false;
379  }
380 
381  std::unique_ptr< NETLIST_READER > nlr( netlistReader );
382  netlistReader->LoadNetlist();
383  }
384  catch( const IO_ERROR& ioe )
385  {
386  msg.Printf( _( "Error loading netlist file:\n%s" ), ioe.What().GetData() );
387  wxMessageBox( msg, _( "Netlist Load Error" ), wxOK | wxICON_ERROR );
388  return false;
389  }
390 
391  BOARD* pcb = m_parent->GetBoard();
392 
393  // Search for duplicate footprints.
394  module = pcb->m_Modules;
395 
396  for( ; module != NULL; module = module->Next() )
397  {
398  nextModule = module->Next();
399 
400  for( ; nextModule != NULL; nextModule = nextModule->Next() )
401  {
402  if( module->GetReference().CmpNoCase( nextModule->GetReference() ) == 0 )
403  {
404  aDuplicates.push_back( module );
405  break;
406  }
407  }
408  }
409 
410  // Search for component footprints in the netlist but not on the board.
411  for( unsigned ii = 0; ii < netlist.GetCount(); ii++ )
412  {
413  component = netlist.GetComponent( ii );
414 
415  module = pcb->FindModuleByReference( component->GetReference() );
416 
417  if( module == NULL )
418  {
419  aMissing.Add( component->GetReference() );
420  aMissing.Add( component->GetValue() );
421  }
422  }
423 
424  // Search for component footprints found on board but not in netlist.
425  module = pcb->m_Modules;
426 
427  for( ; module != NULL; module = module->Next() )
428  {
429 
430  component = netlist.GetComponentByReference( module->GetReference() );
431 
432  if( component == NULL )
433  aNotInNetlist.push_back( module );
434  }
435 
436  return true;
437 }
PCB_EDIT_FRAME * m_parent
MODULE * Next() const
Definition: class_module.h:121
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:151
const wxString & GetValue() const
Definition: pcb_netlist.h:153
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
>
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:214
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:265
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:169
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:458
DLIST< MODULE > m_Modules
Definition: class_board.h:245
COMPONENT * GetComponentByReference(const wxString &aReference)
Function GetComponentByReference returns a COMPONENT by aReference.
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:256
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
int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 132 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_SHIM::IsQuasiModal(), and DIALOG_LAYERS_SETUP::OnInitDialog().

133 {
134  wxSize sz( 0, y );
135  return ConvertDialogToPixels( sz ).y;
136 }

Member Data Documentation

wxBitmapButton* DIALOG_NETLIST_BASE::m_browseButton
protectedinherited
wxButton* DIALOG_NETLIST_BASE::m_buttonClose
protectedinherited
wxButton* DIALOG_NETLIST_BASE::m_buttonFPTest
protectedinherited
wxButton* DIALOG_NETLIST_BASE::m_buttonRead
protectedinherited
wxButton* DIALOG_NETLIST_BASE::m_buttonRebild
protectedinherited
wxRadioBox* DIALOG_NETLIST_BASE::m_ChangeExistingFootprintCtrl
protectedinherited
wxCheckBox* DIALOG_NETLIST_BASE::m_checkBoxSilentMode
protectedinherited
wxCheckBox* DIALOG_NETLIST_BASE::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().

wxRadioBox* DIALOG_NETLIST_BASE::m_DeleteBadTracks
protectedinherited
bool DIALOG_SHIM::m_fixupsRun
protectedinherited

Definition at line 149 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

std::string DIALOG_SHIM::m_hash_key
protectedinherited
WX_HTML_REPORT_PANEL* DIALOG_NETLIST_BASE::m_MessageWindow
protectedinherited
wxTextCtrl* DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl
protectedinherited
EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 154 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_BASE::m_rbSingleNets
protectedinherited
wxRadioBox* DIALOG_NETLIST_BASE::m_RemoveExtraFootprintsCtrl
protectedinherited
wxRadioBox* DIALOG_NETLIST_BASE::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_BASE::m_staticline1
protectedinherited
wxStaticLine* DIALOG_NETLIST_BASE::m_staticline11
protectedinherited

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