pcbnew_scripting.cpp File Reference

#include <python_scripting.h>
#include <cstdlib>
#include <cstring>
#include <Python.h>
#include <sstream>
#include <eda_base_frame.h>
#include <gal/color4d.h>
#include <trace_helpers.h>
#include <string_utils.h>
#include <macros.h>
#include <paths.h>
#include <settings/settings_manager.h>
#include <kiplatform/environment.h>
#include <wx/app.h>
#include <config.h>

Go to the source code of this file.

Functions
static void	pcbnewRunPythonMethodWithReturnedString (const char *aMethodName, wxString &aNames)
	Run a python method from the pcbnew module. More...
void	pcbnewGetUnloadableScriptNames (wxString &aNames)
	Collect the list of python scripts which could not be loaded. More...
void	pcbnewGetScriptsSearchPaths (wxString &aNames)
	Collect the list of paths where python scripts are searched. More...
void	pcbnewGetWizardsBackTrace (wxString &aTrace)
	Return the backtrace of errors (if any) when wizard python scripts are loaded. More...

Function Documentation

pcbnewGetScriptsSearchPaths()

void pcbnewGetScriptsSearchPaths

(

wxString &

aNames

)

Collect the list of paths where python scripts are searched.

Parameters

aNames

is a wxString which will contain the paths (separated by ' ')

Definition at line 130 of file pcbnew_scripting.cpp.

{
 pcbnewRunPythonMethodWithReturnedString( "pcbnew.GetWizardsSearchPaths", aNames );
}

References pcbnewRunPythonMethodWithReturnedString().

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::initLists().

pcbnewGetUnloadableScriptNames()

void pcbnewGetUnloadableScriptNames

(

wxString &

aNames

)

Collect the list of python scripts which could not be loaded.

Parameters

aNames

is a wxString which will contain the filenames (separated by ' ')

Definition at line 124 of file pcbnew_scripting.cpp.

{
 pcbnewRunPythonMethodWithReturnedString( "pcbnew.GetUnLoadableWizards", aNames );
}

References pcbnewRunPythonMethodWithReturnedString().

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::initLists().

pcbnewGetWizardsBackTrace()

void pcbnewGetWizardsBackTrace

(

wxString &

aNames

)

Return the backtrace of errors (if any) when wizard python scripts are loaded.

Parameters

aNames

is a wxString which will contain the trace

Definition at line 136 of file pcbnew_scripting.cpp.

{
 pcbnewRunPythonMethodWithReturnedString( "pcbnew.GetWizardsBackTrace", aTrace );
 
 // Filter message before displaying them
 // a trace starts by "Traceback" and is followed by 2 useless lines
 // for our purpose
 wxArrayString traces;
 wxStringSplit( aTrace, traces, '\n' );
 
 // Build the filtered message (remove useless lines)
 aTrace.Clear();
 
 for( unsigned ii = 0; ii < traces.Count(); ++ii )
 {
 if( traces[ii].Contains( wxT( "Traceback" ) ) )
 {
 ii += 2; // Skip this line and next lines which are related to pcbnew.py module
 
 if( !aTrace.IsEmpty() ) // Add separator for the next trace block
 aTrace << wxT( "\n**********************************\n" );
 }
 else
 {
 aTrace += traces[ii] + wxT( "\n" );
 }
 }
}

References pcbnewRunPythonMethodWithReturnedString(), and wxStringSplit().

Referenced by PANEL_PCBNEW_ACTION_PLUGINS::OnShowErrorsButtonClick(), DIALOG_FOOTPRINT_WIZARD_LIST::onShowTrace(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

pcbnewRunPythonMethodWithReturnedString()

static void pcbnewRunPythonMethodWithReturnedString ( const char *  aMethodName, wxString &  aNames  )

static

Run a python method from the pcbnew module.

Parameters

aMethodName	is the name of the method (like "pcbnew.myfunction" ).
aNames	will contain the returned string.

Definition at line 58 of file pcbnew_scripting.cpp.

{
 aNames.Clear();
 
 PyLOCK lock;
 PyErr_Clear();
 
 PyObject* builtins = PyImport_ImportModule( "pcbnew" );
 wxASSERT( builtins );
 
 if( !builtins ) // Something is wrong in pcbnew.py module (incorrect version?)
 return;
 
 PyObject* globals = PyDict_New();
 PyDict_SetItemString( globals, "pcbnew", builtins );
 Py_DECREF( builtins );
 
 // Build the python code
 char cmd[1024];
 snprintf( cmd, sizeof(cmd), "result = %s()", aMethodName );
 
 // Execute the python code and get the returned data
 PyObject* localDict = PyDict_New();
 PyObject* pobj = PyRun_String( cmd, Py_file_input, globals, localDict);
 Py_DECREF( globals );
 
 if( pobj )
 {
 PyObject* str = PyDict_GetItemString(localDict, "result" );
 const char* str_res = nullptr;
 
 if(str)
 {
 PyObject* temp_bytes = PyUnicode_AsEncodedString( str, "UTF-8", "strict" );
 
 if( temp_bytes != nullptr )
 {
 str_res = PyBytes_AS_STRING( temp_bytes );
 aNames = FROM_UTF8( str_res );
 Py_DECREF( temp_bytes );
 }
 else
 {
 wxLogMessage( wxS( "cannot encode Unicode python string" ) );
 }
 }
 else
 {
 aNames = wxString();
 }
 
 Py_DECREF( pobj );
 }
 
 Py_DECREF( localDict );
 
 if( PyErr_Occurred() )
 {
 if( strcmp( aMethodName, "pcbnew.GetWizardsBackTrace" ) == 0 )
 aNames = PyErrStringWithTraceback();
 else
 wxLogMessage( PyErrStringWithTraceback() );
 }
}

References FROM_UTF8().

Referenced by pcbnewGetScriptsSearchPaths(), pcbnewGetUnloadableScriptNames(), and pcbnewGetWizardsBackTrace().