KiCad PCB EDA Suite
dialog_footprint_wizard_list.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2012-2014 Miguel Angel Ajo <miguelangel@nbee.es>
5  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
29 #include <wx/grid.h>
30 
31 #include <pcbnew.h>
32 #include <kiface_i.h>
34 #include <footprint_wizard_frame.h>
35 
36 #if defined(KICAD_SCRIPTING) || defined(KICAD_SCRIPTING_WXPYTHON)
37 #include <python_scripting.h>
38 #else
39 // Dummy functions, actually defined in python_scripting.h when KICAD_SCRIPTING is enabled
40 static void pcbnewGetWizardsBackTrace( wxString& aText ) {}
41 static void pcbnewGetScriptsSearchPaths( wxString& aText ) {}
42 static void pcbnewGetUnloadableScriptNames( wxString& aText ) {}
43 #endif
44 
46 {
50 };
51 
52 #define FPWIZARTDLIST_HEIGHT_KEY wxT( "FpWizardListHeight" )
53 #define FPWIZARTDLIST_WIDTH_KEY wxT( "FpWizardListWidth" )
54 
57 {
59  initLists();
60 
61  if( m_config )
62  {
63  wxSize size;
64  m_config->Read( FPWIZARTDLIST_WIDTH_KEY, &size.x, -1 );
65  m_config->Read( FPWIZARTDLIST_HEIGHT_KEY, &size.y, -1 );
66  SetSize( size );
67  }
68 
69 
70  m_sdbSizerOK->SetDefault();
72 
73  Center();
74 }
75 
76 
78 {
79  if( m_config && !IsIconized() )
80  {
81  m_config->Write( FPWIZARTDLIST_WIDTH_KEY, GetSize().x );
82  m_config->Write( FPWIZARTDLIST_HEIGHT_KEY, GetSize().y );
83  }
84 }
85 
86 
88 {
89  // Current wizard selection, empty or first
90  m_footprintWizard = NULL;
91 
93 
94  if( n_wizards )
96 
97  // Choose selection mode and insert the needed rows
98 
99  m_footprintGeneratorsGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
100 
101  int curr_row_cnt = m_footprintGeneratorsGrid->GetNumberRows();
102 
103  if( curr_row_cnt )
104  m_footprintGeneratorsGrid->DeleteRows( 0, curr_row_cnt );
105 
106  if( n_wizards )
107  m_footprintGeneratorsGrid->InsertRows( 0, n_wizards );
108 
109  // Put all wizards in the list
110  for( int ii = 0; ii < n_wizards; ii++ )
111  {
112  wxString num = wxString::Format( "%d", ii+1 );
114  wxString name = wizard->GetName();
115  wxString description = wizard->GetDescription();
116  wxString image = wizard->GetImage();
117 
118  m_footprintGeneratorsGrid->SetCellValue( ii, FP_GEN_ROW_NUMBER, num );
119  m_footprintGeneratorsGrid->SetCellValue( ii, FP_GEN_ROW_NAME, name );
120  m_footprintGeneratorsGrid->SetCellValue( ii, FP_GEN_ROW_DESCR, description );
121 
122  }
123 
124  m_footprintGeneratorsGrid->AutoSizeColumns();
125 
126  // Auto-expand the description column
127  int width = m_footprintGeneratorsGrid->GetClientSize().GetWidth() -
128  m_footprintGeneratorsGrid->GetRowLabelSize() -
130 
131  if ( width > m_footprintGeneratorsGrid->GetColMinimalAcceptableWidth() )
132  m_footprintGeneratorsGrid->SetColSize( FP_GEN_ROW_DESCR, width );
133 
134  // Select the first row
135  m_footprintGeneratorsGrid->ClearSelection();
136  m_footprintGeneratorsGrid->SelectRow( 0, false );
137 
138  // Display info about scripts: Search paths
139  wxString message;
140  pcbnewGetScriptsSearchPaths( message );
141  m_tcSearchPaths->SetValue( message );
142  // Display info about scripts: unloadable scripts (due to syntax errors is python source)
144 
145  if( message.IsEmpty() )
146  {
147  m_tcNotLoaded->SetValue( _( "All footprint generator scripts were loaded" ) );
148  m_buttonShowTrace->Show( false );
149  }
150  else
151  m_tcNotLoaded->SetValue( message );
152 }
153 
154 
156 {
157 #if defined(KICAD_SCRIPTING)
158  FOOTPRINT_WIZARD_FRAME* fpw_frame = static_cast<FOOTPRINT_WIZARD_FRAME*>( GetParent() );
159  fpw_frame->PythonPluginsReload();
160 
161  initLists();
162 #endif
163 }
164 
165 
167 {
168  int click_row = event.GetRow();
170  m_footprintGeneratorsGrid->SelectRow( event.GetRow(), false );
171  // Move the grid cursor to the active line, mainly for aesthetic reasons:
172  m_footprintGeneratorsGrid->GoToCell( event.GetRow(), FP_GEN_ROW_NUMBER );
173 }
174 
175 
177 {
178  EndModal( wxID_OK );
179 }
180 
181 void DIALOG_FOOTPRINT_WIZARD_LIST::onShowTrace( wxCommandEvent& event )
182 {
183  wxString trace;
184  pcbnewGetWizardsBackTrace( trace );
185 
186  // Filter message before displaying them
187  // a trace starts by "Traceback" and is followed by 2 useless lines
188  // for our purpose
189  wxArrayString traces;
190  wxStringSplit( trace, traces, '\n' );
191 
192  // Build the filtered message (remove useless lines)
193  trace.Clear();
194 
195  for( unsigned ii = 0; ii < traces.Count(); ++ii )
196  {
197  if( traces[ii].Contains( "Traceback" ) )
198  {
199  ii += 2; // Skip this line and next lines which are related to pcbnew.py module
200 
201  if( !trace.IsEmpty() ) // Add separator for the next trace block
202  trace << "\n**********************************\n";
203  }
204  else
205  trace += traces[ii] + "\n";
206  }
207 
208  // Now display the filtered trace in our dialog
209  // (a simple wxMessageBox is really not suitable for long messages)
210  DIALOG_FOOTPRINT_WIZARD_LOG logWindow( this );
211  logWindow.m_Message->SetValue( trace );
212  logWindow.ShowModal();
213 }
214 
215 
217 {
218  return m_footprintWizard;
219 }
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Function wxStringSplit splits aString to a string list separated at aSplitter.
Definition: common.cpp:137
Class FOOTPRINT_WIZARD_FRAME.
FOOTPRINT_WIZARD * m_footprintWizard
The selected python script wizard.
Class DIALOG_FOOTPRINT_WIZARD_LIST_BASE.
long trace
Definition: solve.cpp:232
void OnCellFpGeneratorDoubleClick(wxGridEvent &event) override
static FOOTPRINT_WIZARD * GetWizard(const wxString &aName)
Function GetWizard.
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
Class DIALOG_FOOTPRINT_WIZARD_LOG.
static void pcbnewGetScriptsSearchPaths(wxString &aText)
void OnCellFpGeneratorClick(wxGridEvent &event) override
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
static int GetWizardsCount()
Function GetWizardsCount.
virtual wxString GetDescription()=0
Function GetDescription.
void onUpdatePythonModulesClick(wxCommandEvent &event) override
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
static void pcbnewGetWizardsBackTrace(wxString &aText)
void PythonPluginsReload()
Reload the Python plugins if they are newer than the already loaded, and load new plugins if any Do n...
void onShowTrace(wxCommandEvent &event) override
virtual wxString GetImage()=0
Function GetImage.
const char * name
Definition: DXF_plotter.cpp:61
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
virtual wxString GetName()=0
Function GetName.
#define FPWIZARTDLIST_WIDTH_KEY
#define FPWIZARTDLIST_HEIGHT_KEY
static void pcbnewGetUnloadableScriptNames(wxString &aText)
Class FOOTPRINT_WIZARD This is the parent class from where any footprint wizard class must derive...