KiCad PCB EDA Suite
DIALOG_BOM Class Reference
Inheritance diagram for DIALOG_BOM:
DIALOG_BOM_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_BOM (SCH_EDIT_FRAME *parent)
 
 ~DIALOG_BOM ()
 
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  {
  IN_NAMELINE = 1000, ID_CREATE_BOM, ID_HELP, ID_ADD_PLUGIN,
  ID_REMOVEL_PLUGIN, ID_CMDLINE
}
 

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

wxStaticText * m_staticTextPluginTitle
 
wxListBox * m_lbPlugins
 
wxStaticText * m_staticTextName
 
wxTextCtrl * m_textCtrlName
 
wxButton * m_buttonNetlist
 
wxButton * m_buttonCancel
 
wxButton * m_buttonHelp
 
wxStaticLine * m_staticline2
 
wxButton * m_buttonAddPlugin
 
wxButton * m_buttonDelPlugin
 
wxButton * m_buttonEdit
 
wxStaticText * m_staticTextCmd
 
wxTextCtrl * m_textCtrlCommand
 
wxCheckBox * m_checkBoxShowConsole
 
wxStaticText * m_staticTextInfo
 
wxTextCtrl * m_Messages
 
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

void OnPluginSelected (wxCommandEvent &event) override
 
void OnRunPlugin (wxCommandEvent &event) override
 Function RunPlugin run the plugin command line. More...
 
void OnCancelClick (wxCommandEvent &event) override
 
void OnHelp (wxCommandEvent &event) override
 
void OnAddPlugin (wxCommandEvent &event) override
 Function OnAddPlugin Add a new panel for a new netlist plugin. More...
 
void OnRemovePlugin (wxCommandEvent &event) override
 Function OnRemovePlugin Remove a plugin from the list. More...
 
void OnEditPlugin (wxCommandEvent &event) override
 
void OnCommandLineEdited (wxCommandEvent &event) override
 
void OnNameEdited (wxCommandEvent &event) override
 
void OnShowConsoleChanged (wxCommandEvent &event) override
 
void pluginInit ()
 
void installPluginsList ()
 
wxString getPluginFileName (const wxString &aCommand)
 
void displayPluginInfo (FILE *aFile, const wxString &aFilename)
 display (when exists) the text found between the keyword "@package" (compatible with doxygen comments) and the end of comment block (""" in python", –> in xml) More...
 
wxString choosePlugin ()
 Browse plugin files, and set m_CommandStringCtrl field. More...
 

Private Attributes

SCH_EDIT_FRAMEm_parent
 
BOM_PLUGIN_ARRAY m_plugins
 
wxConfigBase * m_config
 

Detailed Description

Definition at line 175 of file dialog_bom.cpp.

Member Enumeration Documentation

anonymous enum
protectedinherited
Enumerator
IN_NAMELINE 
ID_CREATE_BOM 
ID_HELP 
ID_ADD_PLUGIN 
ID_REMOVEL_PLUGIN 
ID_CMDLINE 

Definition at line 53 of file dialog_bom_base.h.

Constructor & Destructor Documentation

DIALOG_BOM::DIALOG_BOM ( SCH_EDIT_FRAME parent)

Definition at line 229 of file dialog_bom.cpp.

References DIALOG_SHIM::FinishDialogSettings(), installPluginsList(), Kiface(), KIFACE_I::KifaceSettings(), DIALOG_BOM_BASE::m_checkBoxShowConsole, m_config, and m_parent.

229  :
230  DIALOG_BOM_BASE( parent )
231 {
232  m_parent = parent;
235 
236 #ifndef __WINDOWS__
237  m_checkBoxShowConsole->Show( false );
238 #endif
239 
240  // Now all widgets have the size fixed, call FinishDialogSettings
242 }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
wxCheckBox * m_checkBoxShowConsole
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void installPluginsList()
Definition: dialog_bom.cpp:287
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:178
DIALOG_BOM_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Bill of Material"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxConfigBase * m_config
Definition: dialog_bom.cpp:180
DIALOG_BOM::~DIALOG_BOM ( )

Definition at line 244 of file dialog_bom.cpp.

References BOM_PLUGIN_SELECTED_KEY, BOM_PLUGINS_KEY, FROM_UTF8(), STRING_FORMATTER::GetString(), m_config, DIALOG_BOM_BASE::m_lbPlugins, m_plugins, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

245 {
246  // Save the plugin descriptions in config.
247  // the config stores only one string.
248  // plugins are saved inside a S expr:
249  // ( plugins
250  // ( plugin "plugin name 1" (cmd "command line 1") )
251  // ( plugin "plugin name 2" (cmd "command line 2") (opts "option1") (opts "option2") )
252  // ....
253  // )
254 
255  STRING_FORMATTER writer;
256  writer.Print( 0, "(plugins" );
257 
258  for( unsigned ii = 0; ii < m_plugins.GetCount(); ii++ )
259  {
260  writer.Print( 1, "(plugin %s (cmd %s)",
261  writer.Quotew( m_plugins.Item( ii ).Name ).c_str(),
262  writer.Quotew( m_plugins.Item( ii ).Command ).c_str() );
263 
264  for( unsigned jj = 0; jj < m_plugins.Item( ii ).Options.GetCount(); jj++ )
265  {
266  writer.Print( 1, "(opts %s)",
267  writer.Quotew( m_plugins.Item( ii ).Options.Item( jj ) ).c_str() );
268  }
269 
270  writer.Print( 0, ")" );
271  }
272 
273  writer.Print( 0, ")" );
274 
275  wxString list( FROM_UTF8( writer.GetString().c_str() ) );
276 
277  m_config->Write( BOM_PLUGINS_KEY, list );
278 
279  wxString active_plugin_name = m_lbPlugins->GetStringSelection( );
280  m_config->Write( BOM_PLUGIN_SELECTED_KEY, active_plugin_name );
281 
282 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
#define BOM_PLUGIN_SELECTED_KEY
Definition: dialog_bom.cpp:49
wxListBox * m_lbPlugins
#define BOM_PLUGINS_KEY
Definition: dialog_bom.cpp:48
const std::string & GetString()
Definition: richio.h:475
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:482
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
wxConfigBase * m_config
Definition: dialog_bom.cpp:180
Class STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445

Member Function Documentation

wxString DIALOG_BOM::choosePlugin ( )
private

Browse plugin files, and set m_CommandStringCtrl field.

Returns
a command line ro run the plugin

Definition at line 520 of file dialog_bom.cpp.

References EDA_FILE_SELECTOR(), GetChars(), PGM_BASE::GetExecutablePath(), and Pgm().

Referenced by OnAddPlugin().

521 {
522  wxString mask = wxT( "*" );
523 #ifndef __WXMAC__
524  wxString path = Pgm().GetExecutablePath();
525 #else
526  wxString path = GetOSXKicadDataDir() + wxT( "/plugins" );
527 #endif
528 
529  wxString fullFileName = EDA_FILE_SELECTOR( _( "Plugin files:" ),
530  path,
531  wxEmptyString,
532  wxEmptyString,
533  mask,
534  this,
535  wxFD_OPEN,
536  true );
537  if( fullFileName.IsEmpty() )
538  return wxEmptyString;
539 
540  // Creates a default command line,
541  // suitable to run the external tool xslproc or python
542  // The default command line depending on plugin extension, currently
543  // "xsl" or "exe" or "py" or "pyw"
544  wxString cmdLine;
545  wxFileName fn( fullFileName );
546  wxString ext = fn.GetExt();
547 
548  // Python requires on Windows the path of the script ends by '/' instead of '\'
549  // otherwise import does not find modules in the same folder as the python script
550  // We cannot change all '\' to '/' in command line because it causes issues with files
551  // that are stored on network resources and pointed to using the Windows
552  // Universal Naming Convention format. (full filename starting by \\server\)
553  //
554  // I hope changing the last separator only to '/' will work.
555 #ifdef __WINDOWS__
556  if( ext == wxT("py" ) || ext == wxT("pyw" ) )
557  {
558  wxString sc_path = fn.GetPathWithSep();
559  sc_path.RemoveLast();
560  fullFileName = sc_path +'/' + fn.GetFullName();;
561  }
562 #endif
563 
564  if( ext == "xsl" )
565  cmdLine.Printf( "xsltproc -o \"%%O\" \"%s\" \"%%I\"", GetChars( fullFileName ) );
566  else if( ext == "exe" )
567  cmdLine.Printf( "\"%s\" < \"%%I\" > \"%%O\"", GetChars( fullFileName ) );
568  else if( ext == "py" )
569  cmdLine.Printf( "python \"%s\" \"%%I\" \"%%O\"", GetChars( fullFileName ) );
570  else if( ext == "pyw" )
571 #ifdef __WINDOWS__
572  cmdLine.Printf( "pythonw \"%s\" \"%%I\" \"%%O\"", GetChars( fullFileName ) );
573 #else
574  cmdLine.Printf( "python \"%s\" \"%%I\" \"%%O\"", GetChars( fullFileName ) );
575 #endif
576  else
577  cmdLine.Printf( "\"%s\"", GetChars( fullFileName ) );
578 
579  return cmdLine;
580 }
VTBL_ENTRY const wxString & GetExecutablePath() const
Definition: pgm_base.h:173
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
wxString EDA_FILE_SELECTOR(const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition, wxString *aMruPath)
Function EDA_FILE_SELECTOR.
Definition: gestfich.cpp:82
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_BOM::displayPluginInfo ( FILE *  aFile,
const wxString &  aFilename 
)
private

display (when exists) the text found between the keyword "@package" (compatible with doxygen comments) and the end of comment block (""" in python", –> in xml)

Definition at line 365 of file dialog_bom.cpp.

References DIALOG_BOM_BASE::m_Messages.

Referenced by pluginInit().

366 {
367  m_Messages->Clear();
368 
369  // display (when exists) the text found between the keyword "@package"
370  // (compatible with doxygen comments)
371  // and the end of comment block (""" in python", --> in xml)
372 
373  wxString data;
374  wxFFile fdata( aFile ); // dtor will close the file
375 
376  if( !fdata.ReadAll( &data ) )
377  return;
378 
379  wxString header( wxT( "@package" ) );
380  wxString endsection( wxT( "-->" ) ); // For xml
381 
382  wxFileName fn( aFilename );
383 
384  if( fn.GetExt().IsSameAs( wxT("py"), false ) )
385  endsection = wxT( "\"\"\"" );
386  else if( !fn.GetExt().IsSameAs( wxT("xsl"), false ) )
387  // If this is not a python file, we know nothing about file
388  // and the info cannot be found
389  return;
390 
391  // Extract substring between @package and """
392  int strstart = data.Find( header );
393 
394  if( strstart == wxNOT_FOUND )
395  return;
396 
397  strstart += header.Length();
398  int strend = data.find( endsection, strstart );
399 
400  if( strend == wxNOT_FOUND)
401  return;
402 
403  // Remove empty line if any
404  while( data[strstart] < ' ' )
405  strstart++;
406 
407  m_Messages->SetValue( data.SubString( strstart, strend-1 ) );
408 }
wxTextCtrl * m_Messages
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_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 }
wxString DIALOG_BOM::getPluginFileName ( const wxString &  aCommand)
private
Returns
the Plugin filename from a command line
Parameters
aCommand= the command line

Definition at line 583 of file dialog_bom.cpp.

References PROJECT::GetProjectPath(), and KIWAY_HOLDER::Prj().

Referenced by OnAddPlugin(), OnEditPlugin(), and pluginInit().

584 {
585  wxString pluginName;
586 
587  // Try to find the plugin name.
588  // This is possible if the name ends by .py or .pyw or .xsl or .exe
589  int pos = -1;
590 
591  if( (pos = aCommand.Find( wxT(".pyw") )) != wxNOT_FOUND )
592  pos += 3;
593  else if( (pos = aCommand.Find( wxT(".py") )) != wxNOT_FOUND )
594  pos += 2;
595  else if( (pos = aCommand.Find( wxT(".xsl") )) != wxNOT_FOUND )
596  pos += 3;
597  else if( (pos = aCommand.Find( wxT(".exe") )) != wxNOT_FOUND )
598  pos += 3;
599 
600  // the end of plugin name is at position pos.
601  if( pos > 0 )
602  {
603  // Be sure this is the end of the name: the next char is " or space
604  int eos = aCommand[pos+1];
605 
606  if( eos == ' '|| eos == '\"' )
607  {
608  // search for the starting point of the name
609  int jj = pos-1;
610  while( jj >= 0 )
611  if( aCommand[jj] != eos )
612  jj--;
613  else
614  break;
615 
616  // extract the name
617  if( jj >= 0 )
618  {
619  eos = aCommand[jj];
620 
621  if( eos == ' '|| eos == '\"' ) // do not include delimiters
622  jj++;
623 
624  pluginName = aCommand.SubString( jj, pos );
625  }
626  }
627  }
628 
629  // Using a format like %P is possible in plugin name, so expand it
630  wxString prj_dir = Prj().GetProjectPath();
631 
632  if( prj_dir.EndsWith( '/' ) || prj_dir.EndsWith( '\\' ) )
633  prj_dir.RemoveLast();
634 
635  pluginName.Replace( wxT( "%P" ), prj_dir.GetData(), true );
636 
637  return pluginName;
638 }
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:100
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 }
void DIALOG_BOM::installPluginsList ( )
private

Definition at line 287 of file dialog_bom.cpp.

References BOM_PLUGIN_SELECTED_KEY, BOM_PLUGINS_KEY, m_config, DIALOG_BOM_BASE::m_lbPlugins, m_plugins, BOM_CFG_READER_PARSER::Parse(), pluginInit(), and TO_UTF8.

Referenced by DIALOG_BOM().

288 {
289  wxString list, active_plugin_name;
290  m_config->Read( BOM_PLUGINS_KEY, &list );
291  m_config->Read( BOM_PLUGIN_SELECTED_KEY, &active_plugin_name );
292 
293  if( !list.IsEmpty() )
294  {
295  BOM_CFG_READER_PARSER cfg_parser( &m_plugins, TO_UTF8( list ),
296  wxT( "plugins" ) );
297  try
298  {
299  cfg_parser.Parse();
300  }
301  catch( const IO_ERROR& )
302  {
303 // wxLogMessage( ioe.What() );
304  }
305  }
306 
307  // Populate list box
308  for( unsigned ii = 0; ii < m_plugins.GetCount(); ii++ )
309  {
310  m_lbPlugins->Append( m_plugins.Item( ii ).Name );
311 
312  if( active_plugin_name == m_plugins.Item( ii ).Name )
313  m_lbPlugins->SetSelection( ii );
314  }
315 
316  pluginInit();
317 }
#define BOM_PLUGIN_SELECTED_KEY
Definition: dialog_bom.cpp:49
wxListBox * m_lbPlugins
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
#define BOM_PLUGINS_KEY
Definition: dialog_bom.cpp:48
Class BOM_CFG_READER_PARSER holds data and functions pertinent to parsing a S-expression file for a W...
Definition: dialog_bom.cpp:82
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
wxConfigBase * m_config
Definition: dialog_bom.cpp:180
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
void pluginInit()
Definition: dialog_bom.cpp:325
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_BOM::OnAddPlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Function OnAddPlugin Add a new panel for a new netlist plugin.

Reimplemented from DIALOG_BOM_BASE.

Definition at line 477 of file dialog_bom.cpp.

References choosePlugin(), BOM_PLUGIN::Command, getPluginFileName(), DIALOG_BOM_BASE::m_lbPlugins, m_plugins, DIALOG_BOM_BASE::m_textCtrlCommand, name, BOM_PLUGIN::Name, and pluginInit().

478 {
479  wxString cmdLine = choosePlugin();
480  BOM_PLUGIN newPlugin;
481 
482  if( cmdLine.IsEmpty() )
483  return;
484 
485  // Creates a new plugin entry
486  wxFileName fn( getPluginFileName( cmdLine ) );
487 
488  wxString defaultName = fn.GetName();
489  wxString name = wxGetTextFromUser( _("Plugin name in plugin list") ,
490  _("Plugin name"), defaultName );
491 
492  if( name.IsEmpty() )
493  return;
494 
495  // Verify if it does not exists
496  for( unsigned ii = 0; ii < m_plugins.GetCount(); ii++ )
497  {
498  if( name == m_plugins.Item( ii ).Name )
499  {
500  wxMessageBox( _("This name already exists. Abort") );
501  return;
502  }
503  }
504 
505  // Append the new plugin
506  newPlugin.Name = name;
507  newPlugin.Command = wxEmptyString;
508  m_plugins.Add( newPlugin );
509  m_lbPlugins->SetSelection( m_lbPlugins->GetCount() - 1 );
510  m_lbPlugins->Append( name );
511  m_lbPlugins->SetSelection( m_lbPlugins->GetCount() - 1 );
512  m_textCtrlCommand->SetValue( cmdLine );
513 
514  pluginInit();
515 }
Structure BOM_PLUGIN holds data of the BOM plugin.
Definition: dialog_bom.cpp:63
wxString getPluginFileName(const wxString &aCommand)
Definition: dialog_bom.cpp:583
wxListBox * m_lbPlugins
wxString Name
Definition: dialog_bom.cpp:65
wxTextCtrl * m_textCtrlCommand
wxString choosePlugin()
Browse plugin files, and set m_CommandStringCtrl field.
Definition: dialog_bom.cpp:520
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
const char * name
Definition: DXF_plotter.cpp:61
wxString Command
Definition: dialog_bom.cpp:66
void pluginInit()
Definition: dialog_bom.cpp:325
void DIALOG_BOM::OnCancelClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 442 of file dialog_bom.cpp.

443 {
444  EndModal( wxID_CANCEL );
445 }
void DIALOG_BOM::OnCommandLineEdited ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 669 of file dialog_bom.cpp.

References DIALOG_BOM_BASE::m_lbPlugins, m_plugins, and DIALOG_BOM_BASE::m_textCtrlCommand.

670 {
671  int ii = m_lbPlugins->GetSelection();
672 
673  if( ii < 0 )
674  return;
675 
676  m_plugins.Item( ii ).Command = m_textCtrlCommand->GetValue();
677 }
wxListBox * m_lbPlugins
wxTextCtrl * m_textCtrlCommand
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
void DIALOG_BOM::OnEditPlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 640 of file dialog_bom.cpp.

References AddDelimiterString(), ExecuteFile(), PGM_BASE::GetEditorName(), getPluginFileName(), DIALOG_BOM_BASE::m_textCtrlCommand, and Pgm().

641 {
642  wxString pluginName = getPluginFileName( m_textCtrlCommand->GetValue() );
643 
644  if( pluginName.Length() <= 2 ) // if name != ""
645  {
646  wxMessageBox( _("Plugin file name not found. Cannot edit plugin file") );
647  return;
648  }
649 
650  AddDelimiterString( pluginName );
651  wxString editorname = Pgm().GetEditorName();
652 
653  if( !editorname.IsEmpty() )
654  ExecuteFile( this, editorname, pluginName );
655  else
656  wxMessageBox( _("No text editor selected in KiCad. Please choose it") );
657 }
wxString getPluginFileName(const wxString &aCommand)
Definition: dialog_bom.cpp:583
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
wxTextCtrl * m_textCtrlCommand
void AddDelimiterString(wxString &string)
Function AddDelimiterString Add un " to the start and the end of string (if not already done)...
Definition: gestfich.cpp:44
VTBL_ENTRY const wxString & GetEditorName(bool aCanShowFileChooser=true)
Return the preferred editor name.
Definition: pgm_base.cpp:338
int ExecuteFile(wxWindow *frame, const wxString &ExecFile, const wxString &param, wxProcess *callback)
Function ExecuteFile calls the executable file ExecFile with the command line parameters param...
Definition: gestfich.cpp:208
void DIALOG_BOM::OnHelp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 659 of file dialog_bom.cpp.

References FROM_UTF8(), DIALOG_DISPLAY_HTML_TEXT_BASE::m_htmlWindow, s_bomHelpInfo, and HTML_MESSAGE_BOX::SetDialogSizeInDU().

660 {
661  HTML_MESSAGE_BOX help_Dlg( this, _("Bom Generation Help") );
662  help_Dlg.SetDialogSizeInDU( 500, 350 );
663 
664  wxString msg = FROM_UTF8(s_bomHelpInfo);
665  help_Dlg.m_htmlWindow->AppendToPage( msg );
666  help_Dlg.ShowModal();
667 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
const char * s_bomHelpInfo
Definition: dialog_bom.cpp:51
Class HTML_MESSAGE_BOX.
void DIALOG_BOM::OnNameEdited ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 679 of file dialog_bom.cpp.

References DIALOG_BOM_BASE::m_lbPlugins, m_plugins, and DIALOG_BOM_BASE::m_textCtrlName.

680 {
681  int ii = m_lbPlugins->GetSelection();
682 
683  if( ii < 0 )
684  return;
685 
686  m_plugins.Item( ii ).Name = m_textCtrlName->GetValue();
687  m_lbPlugins->SetString( ii, m_plugins.Item( ii ).Name );
688 }
wxListBox * m_lbPlugins
wxTextCtrl * m_textCtrlName
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
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_BOM::OnPluginSelected ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 319 of file dialog_bom.cpp.

References pluginInit().

320 {
321  pluginInit();
322 }
void pluginInit()
Definition: dialog_bom.cpp:325
void DIALOG_BOM::OnRemovePlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Function OnRemovePlugin Remove a plugin from the list.

Reimplemented from DIALOG_BOM_BASE.

Definition at line 452 of file dialog_bom.cpp.

References DIALOG_BOM_BASE::m_lbPlugins, m_plugins, and pluginInit().

453 {
454  int ii = m_lbPlugins->GetSelection();
455 
456  if( ii < 0 )
457  return;
458 
459  m_lbPlugins->Delete( ii );
460 
461  m_plugins.RemoveAt( ii );
462 
463  // Select the next item, if exists
464  if( (int)m_lbPlugins->GetCount() >= ii )
465  ii = m_lbPlugins->GetCount() - 1;
466 
467  if( ii >= 0 )
468  m_lbPlugins->SetSelection( ii );
469 
470  pluginInit();
471 }
wxListBox * m_lbPlugins
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
void pluginInit()
Definition: dialog_bom.cpp:325
void DIALOG_BOM::OnRunPlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Function RunPlugin run the plugin command line.

Reimplemented from DIALOG_BOM_BASE.

Definition at line 414 of file dialog_bom.cpp.

References EDA_DRAW_FRAME::ClearMsgPanel(), SCH_EDIT_FRAME::CreateNetlist(), g_RootSheet, SCH_SCREEN::GetFileName(), SCH_SHEET::GetScreen(), DIALOG_BOM_BASE::m_checkBoxShowConsole, DIALOG_BOM_BASE::m_Messages, m_parent, DIALOG_BOM_BASE::m_textCtrlCommand, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::SetExecFlags(), and SCH_EDIT_FRAME::SetNetListerCommand().

415 {
416  wxFileName fn;
417 
418  // Calculate the xml netlist filename
419  fn = g_RootSheet->GetScreen()->GetFileName();
420 
421  fn.SetPath( wxPathOnly( Prj().GetProjectFullName() ) );
422 
423  fn.ClearExt();
424  wxString fullfilename = fn.GetFullPath();
426 
427  wxString reportmsg;
428  WX_STRING_REPORTER reporter( &reportmsg );
430 
431 #ifdef __WINDOWS__
432  if( m_checkBoxShowConsole->IsChecked() )
433  m_parent->SetExecFlags( wxEXEC_SHOW_CONSOLE );
434 #endif
435 
436  m_parent->CreateNetlist( -1, fullfilename, 0, &reporter, false );
437 
438  m_Messages->SetValue( reportmsg );
439 }
const wxString & GetFileName() const
Definition: sch_screen.h:120
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:279
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:55
wxCheckBox * m_checkBoxShowConsole
wxTextCtrl * m_textCtrlCommand
wxTextCtrl * m_Messages
Class WX_STRING_REPORTER is a wrapper for reporting to a wxString object.
Definition: reporter.h:124
bool CreateNetlist(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=NULL, bool silent=false)
Create a netlist for the current schematic.
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:178
void SetExecFlags(const int aFlags)
Set (adds) specified flags for next execution of external generator of the netlist or bom...
void SetNetListerCommand(const wxString &aCommand)
void ClearMsgPanel(void)
Clear all messages from the message panel.
Definition: draw_frame.cpp:823
void DIALOG_BOM::OnShowConsoleChanged ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 690 of file dialog_bom.cpp.

References DIALOG_BOM_BASE::m_checkBoxShowConsole, DIALOG_BOM_BASE::m_lbPlugins, and m_plugins.

691 {
692 #ifdef __WINDOWS__
693  int ii = m_lbPlugins->GetSelection();
694 
695  if( ii < 0 )
696  return;
697 
698  if( m_checkBoxShowConsole->IsChecked() )
699  {
700  if( m_plugins.Item( ii ).Options.Index( wxT( "show_console" ) ) == wxNOT_FOUND )
701  m_plugins.Item( ii ).Options.Add( wxT( "show_console" ) );
702  }
703  else
704  {
705  m_plugins.Item( ii ).Options.Remove( wxT( "show_console" ) );
706  }
707 #endif
708 }
wxListBox * m_lbPlugins
wxCheckBox * m_checkBoxShowConsole
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
void DIALOG_BOM::pluginInit ( )
private

Definition at line 325 of file dialog_bom.cpp.

References DisplayError(), displayPluginInfo(), GetChars(), getPluginFileName(), DIALOG_BOM_BASE::m_checkBoxShowConsole, DIALOG_BOM_BASE::m_lbPlugins, m_plugins, DIALOG_BOM_BASE::m_textCtrlCommand, and DIALOG_BOM_BASE::m_textCtrlName.

Referenced by installPluginsList(), OnAddPlugin(), OnPluginSelected(), and OnRemovePlugin().

326 {
327  int ii = m_lbPlugins->GetSelection();
328 
329  if( ii < 0 )
330  {
331  m_textCtrlName->SetValue( wxEmptyString );
332  m_textCtrlCommand->SetValue( wxEmptyString );
333  return;
334  }
335 
336  m_textCtrlName->SetValue( m_plugins.Item( ii ).Name );
337  m_textCtrlCommand->SetValue( m_plugins.Item( ii ).Command );
338 
339 #ifdef __WINDOWS__
340  if( m_plugins.Item( ii ).Options.Index( wxT( "show_console" ) ) == wxNOT_FOUND )
341  m_checkBoxShowConsole->SetValue( false );
342  else
343  m_checkBoxShowConsole->SetValue( true );
344 #endif
345 
346  wxString pluginName = getPluginFileName( m_textCtrlCommand->GetValue() );
347 
348  if( pluginName.IsEmpty() )
349  return;
350 
351  FILE* pluginFile = wxFopen( pluginName, "rt" );
352 
353  if( pluginFile == NULL )
354  {
355  wxString msg;
356  msg.Printf( _( "Failed to open file \"%s\"" ), GetChars( pluginName ) );
357  DisplayError( this, msg );
358  return;
359  }
360 
361  displayPluginInfo( pluginFile, pluginName );
362 }
wxString getPluginFileName(const wxString &aCommand)
Definition: dialog_bom.cpp:583
wxListBox * m_lbPlugins
wxTextCtrl * m_textCtrlName
wxCheckBox * m_checkBoxShowConsole
wxTextCtrl * m_textCtrlCommand
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:179
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 displayPluginInfo(FILE *aFile, const wxString &aFilename)
display (when exists) the text found between the keyword "@package" (compatible with doxygen comments...
Definition: dialog_bom.cpp:365
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:185
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(), 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(), DIALOG_NETLIST::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(), 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
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_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_SHIM::IsQuasiModal(), and DIALOG_LAYERS_SETUP::OnInitDialog().

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

Member Data Documentation

wxButton* DIALOG_BOM_BASE::m_buttonAddPlugin
protectedinherited

Definition at line 71 of file dialog_bom_base.h.

wxButton* DIALOG_BOM_BASE::m_buttonCancel
protectedinherited

Definition at line 68 of file dialog_bom_base.h.

wxButton* DIALOG_BOM_BASE::m_buttonDelPlugin
protectedinherited

Definition at line 72 of file dialog_bom_base.h.

wxButton* DIALOG_BOM_BASE::m_buttonEdit
protectedinherited

Definition at line 73 of file dialog_bom_base.h.

wxButton* DIALOG_BOM_BASE::m_buttonHelp
protectedinherited

Definition at line 69 of file dialog_bom_base.h.

wxButton* DIALOG_BOM_BASE::m_buttonNetlist
protectedinherited

Definition at line 67 of file dialog_bom_base.h.

wxCheckBox* DIALOG_BOM_BASE::m_checkBoxShowConsole
protectedinherited

Definition at line 76 of file dialog_bom_base.h.

Referenced by DIALOG_BOM(), OnRunPlugin(), OnShowConsoleChanged(), and pluginInit().

wxConfigBase* DIALOG_BOM::m_config
private

Definition at line 180 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), installPluginsList(), and ~DIALOG_BOM().

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
wxListBox* DIALOG_BOM_BASE::m_lbPlugins
protectedinherited
wxTextCtrl* DIALOG_BOM_BASE::m_Messages
protectedinherited

Definition at line 78 of file dialog_bom_base.h.

Referenced by displayPluginInfo(), and OnRunPlugin().

SCH_EDIT_FRAME* DIALOG_BOM::m_parent
private

Definition at line 178 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), and OnRunPlugin().

BOM_PLUGIN_ARRAY DIALOG_BOM::m_plugins
private
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
wxStaticLine* DIALOG_BOM_BASE::m_staticline2
protectedinherited

Definition at line 70 of file dialog_bom_base.h.

wxStaticText* DIALOG_BOM_BASE::m_staticTextCmd
protectedinherited

Definition at line 74 of file dialog_bom_base.h.

wxStaticText* DIALOG_BOM_BASE::m_staticTextInfo
protectedinherited

Definition at line 77 of file dialog_bom_base.h.

wxStaticText* DIALOG_BOM_BASE::m_staticTextName
protectedinherited

Definition at line 65 of file dialog_bom_base.h.

wxStaticText* DIALOG_BOM_BASE::m_staticTextPluginTitle
protectedinherited

Definition at line 63 of file dialog_bom_base.h.

wxTextCtrl* DIALOG_BOM_BASE::m_textCtrlCommand
protectedinherited
wxTextCtrl* DIALOG_BOM_BASE::m_textCtrlName
protectedinherited

Definition at line 66 of file dialog_bom_base.h.

Referenced by OnNameEdited(), and pluginInit().


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