597 lines
16 KiB
C++
597 lines
16 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2012 NBEE Embedded Systems, Miguel Angel Ajo <miguelangel@nbee.es>
|
|
* Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
/**
|
|
* @file python_scripting.cpp
|
|
* @brief methods to add scripting capabilities inside pcbnew
|
|
*/
|
|
|
|
#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 <kicad_string.h>
|
|
#include <macros.h>
|
|
|
|
#include <paths.h>
|
|
#include <pgm_base.h>
|
|
#include <settings/settings_manager.h>
|
|
|
|
#include <kiplatform/environment.h>
|
|
|
|
#include <wx/app.h>
|
|
|
|
#include <config.h>
|
|
|
|
/* init functions defined by swig */
|
|
|
|
extern "C" PyObject* PyInit__pcbnew( void );
|
|
|
|
#define EXTRA_PYTHON_MODULES 10 // this is the number of python
|
|
// modules that we want to add into the list
|
|
|
|
|
|
/* python inittab that links module names to module init functions
|
|
* we will rebuild it to include the original python modules plus
|
|
* our own ones
|
|
*/
|
|
|
|
struct _inittab* SwigImportInittab;
|
|
static int SwigNumModules = 0;
|
|
|
|
/// True if the wxPython scripting layer was successfully loaded.
|
|
static bool wxPythonLoaded = false;
|
|
|
|
|
|
bool IsWxPythonLoaded()
|
|
{
|
|
return wxPythonLoaded;
|
|
}
|
|
|
|
|
|
/**
|
|
* Add a name + initfuction to our SwigImportInittab
|
|
*/
|
|
|
|
static void swigAddModule( const char* name, PyObject* (* initfunc)() )
|
|
{
|
|
SwigImportInittab[SwigNumModules].name = (char*) name;
|
|
SwigImportInittab[SwigNumModules].initfunc = initfunc;
|
|
SwigNumModules++;
|
|
SwigImportInittab[SwigNumModules].name = (char*) 0;
|
|
SwigImportInittab[SwigNumModules].initfunc = 0;
|
|
}
|
|
|
|
|
|
/**
|
|
* Add the builtin python modules
|
|
*/
|
|
static void swigAddBuiltin()
|
|
{
|
|
int i = 0;
|
|
|
|
/* discover the length of the pyimport inittab */
|
|
while( PyImport_Inittab[i].name )
|
|
i++;
|
|
|
|
/* allocate memory for the python module table */
|
|
SwigImportInittab = (struct _inittab*) malloc(
|
|
sizeof( struct _inittab ) * ( i + EXTRA_PYTHON_MODULES ) );
|
|
|
|
/* copy all pre-existing python modules into our newly created table */
|
|
i = 0;
|
|
|
|
while( PyImport_Inittab[i].name )
|
|
{
|
|
swigAddModule( PyImport_Inittab[i].name, PyImport_Inittab[i].initfunc );
|
|
i++;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Add the internal modules to the python scripting so they will be available to the scripts.
|
|
*/
|
|
static void swigAddModules()
|
|
{
|
|
swigAddModule( "_pcbnew", PyInit__pcbnew );
|
|
|
|
// finally it seems better to include all in just one module
|
|
// but in case we needed to include any other modules,
|
|
// it must be done like this:
|
|
// swigAddModule( "_kicad", init_kicad );
|
|
}
|
|
|
|
|
|
/**
|
|
* Switch the python module table to the Pcbnew built one.
|
|
*/
|
|
static void swigSwitchPythonBuiltin()
|
|
{
|
|
PyImport_Inittab = SwigImportInittab;
|
|
}
|
|
|
|
|
|
PyThreadState* g_PythonMainTState;
|
|
|
|
|
|
|
|
|
|
bool ScriptingSetup()
|
|
{
|
|
#if defined( __WINDOWS__ )
|
|
// If our python.exe (in kicad/bin) exists, force our kicad python environment
|
|
wxString kipython = FindKicadFile( "python.exe" );
|
|
|
|
// we need only the path:
|
|
wxFileName fn( kipython );
|
|
kipython = fn.GetPath();
|
|
|
|
// If our python install is existing inside kicad, use it
|
|
// Note: this is useful only when another python version is installed
|
|
if( wxDirExists( kipython ) )
|
|
{
|
|
// clear any PYTHONPATH and PYTHONHOME env var definition: the default
|
|
// values work fine inside Kicad:
|
|
wxSetEnv( wxT( "PYTHONPATH" ), wxEmptyString );
|
|
wxSetEnv( wxT( "PYTHONHOME" ), wxEmptyString );
|
|
|
|
// Add our python executable path in first position:
|
|
wxString ppath;
|
|
wxGetEnv( wxT( "PATH" ), &ppath );
|
|
|
|
kipython << wxT( ";" ) << ppath;
|
|
wxSetEnv( wxT( "PATH" ), kipython );
|
|
}
|
|
|
|
#elif defined( __WXMAC__ )
|
|
|
|
// Add default paths to PYTHONPATH
|
|
wxString pypath;
|
|
|
|
// Bundle scripting folder (<kicad.app>/Contents/SharedSupport/scripting)
|
|
pypath += PATHS::GetOSXKicadDataDir() + wxT( "/scripting" );
|
|
|
|
// $(KICAD_PATH)/scripting/plugins is always added in kicadplugins.i
|
|
if( wxGetenv("KICAD_PATH") != NULL )
|
|
{
|
|
pypath += wxT( ":" ) + wxString( wxGetenv("KICAD_PATH") );
|
|
}
|
|
|
|
// OSX_BUNDLE_PYTHON_SITE_PACKAGES_DIR is provided via the build system.
|
|
|
|
pypath += wxT( ":" ) + Pgm().GetExecutablePath() + wxT( OSX_BUNDLE_PYTHON_SITE_PACKAGES_DIR );
|
|
|
|
// Original content of $PYTHONPATH
|
|
if( wxGetenv( wxT( "PYTHONPATH" ) ) != NULL )
|
|
{
|
|
pypath = wxString( wxGetenv( wxT( "PYTHONPATH" ) ) ) + wxT( ":" ) + pypath;
|
|
}
|
|
|
|
// set $PYTHONPATH
|
|
wxSetEnv( "PYTHONPATH", pypath );
|
|
|
|
wxString pyhome;
|
|
|
|
pyhome += Pgm().GetExecutablePath() +
|
|
wxT( "Contents/Frameworks/Python.framework/Versions/Current" );
|
|
|
|
// set $PYTHONHOME
|
|
wxSetEnv( "PYTHONHOME", pyhome );
|
|
|
|
#else
|
|
wxString pypath;
|
|
|
|
// PYTHON_DEST is the scripts install dir as determined by the build system.
|
|
pypath = Pgm().GetExecutablePath() + wxT( "../" PYTHON_DEST );
|
|
|
|
if( !wxIsEmpty( wxGetenv( wxT( "PYTHONPATH" ) ) ) )
|
|
pypath = wxString( wxGetenv( wxT( "PYTHONPATH" ) ) ) + wxT( ":" ) + pypath;
|
|
|
|
wxSetEnv( wxT( "PYTHONPATH" ), pypath );
|
|
|
|
#endif
|
|
|
|
wxFileName path( PyPluginsPath( true ) + wxT("/") );
|
|
|
|
// Ensure the user plugin path exists, and create it if not.
|
|
// However, if it cannot be created, this is not a fatal error.
|
|
if( !path.DirExists() && !path.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
|
|
wxLogError( "Warning: could not create user scripting path %s", path.GetPath() );
|
|
|
|
if( !InitPythonScripting( TO_UTF8( PyScriptingPath() ), TO_UTF8( PyScriptingPath( true ) ) ) )
|
|
{
|
|
wxLogError( "InitPythonScripting() failed." );
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Initialize the python environment and publish the Pcbnew interface inside it.
|
|
*
|
|
* This initializes all the wxPython interface and returns the python thread control structure
|
|
*/
|
|
bool InitPythonScripting( const char* aStockScriptingPath, const char* aUserScriptingPath )
|
|
{
|
|
int retv;
|
|
char cmd[1024];
|
|
|
|
swigAddBuiltin(); // add builtin functions
|
|
swigAddModules(); // add our own modules
|
|
swigSwitchPythonBuiltin(); // switch the python builtin modules to our new list
|
|
|
|
#ifdef _MSC_VER
|
|
// Under vcpkg/msvc, we need to explicitly set the python home
|
|
// or else it'll start consuming system python registry keys and the like instead
|
|
// We are going to follow the "unix" layout for the msvc/vcpkg distributions so exes in /root/bin
|
|
// And the python lib in /root/lib/python3(/Lib,/DLLs)
|
|
wxFileName pyHome;
|
|
|
|
pyHome.Assign( Pgm().GetExecutablePath() );
|
|
|
|
pyHome.Normalize();
|
|
|
|
// MUST be called before Py_Initialize so it will to create valid default lib paths
|
|
if( !wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
|
|
{
|
|
Py_SetPythonHome( pyHome.GetFullPath().c_str() );
|
|
}
|
|
#endif
|
|
|
|
Py_Initialize();
|
|
PySys_SetArgv( Pgm().App().argc, Pgm().App().argv );
|
|
|
|
#if PY_VERSION_HEX < 0x03070000 // PyEval_InitThreads() is called by Py_Initialize() starting with version 3.7
|
|
PyEval_InitThreads();
|
|
#endif // if PY_VERSION_HEX < 0x03070000
|
|
|
|
#if defined( DEBUG )
|
|
RedirectStdio();
|
|
#endif
|
|
|
|
wxPythonLoaded = true;
|
|
|
|
// Save the current Python thread state and release the
|
|
// Global Interpreter Lock.
|
|
g_PythonMainTState = PyEval_SaveThread();
|
|
|
|
// Load pcbnew inside Python and load all the user plugins and package-based plugins
|
|
{
|
|
PyLOCK lock;
|
|
|
|
// Load os so that we can modify the environment variables through python
|
|
snprintf( cmd, sizeof( cmd ), "import sys, os, traceback\n"
|
|
"sys.path.append(\".\")\n"
|
|
"import pcbnew\n"
|
|
"pcbnew.LoadPlugins(\"%s\", \"%s\")",
|
|
aStockScriptingPath, aUserScriptingPath );
|
|
retv = PyRun_SimpleString( cmd );
|
|
|
|
if( retv != 0 )
|
|
wxLogError( "Python error %d occurred running command:\n\n`%s`", retv, cmd );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Run a python method from the pcbnew module.
|
|
*
|
|
* @param aMethodName is the name of the method (like "pcbnew.myfunction" )
|
|
* @param aNames will contain the returned string
|
|
*/
|
|
static void RunPythonMethodWithReturnedString( const char* aMethodName, wxString& aNames )
|
|
{
|
|
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 = NULL;
|
|
|
|
if(str)
|
|
{
|
|
PyObject* temp_bytes = PyUnicode_AsEncodedString( str, "UTF-8", "strict" );
|
|
|
|
if( temp_bytes != NULL )
|
|
{
|
|
str_res = PyBytes_AS_STRING( temp_bytes );
|
|
aNames = FROM_UTF8( str_res );
|
|
Py_DECREF( temp_bytes );
|
|
}
|
|
else
|
|
{
|
|
wxLogMessage( "cannot encode unicode python string" );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
aNames = wxString();
|
|
}
|
|
|
|
Py_DECREF( pobj );
|
|
}
|
|
|
|
Py_DECREF( localDict );
|
|
|
|
if( PyErr_Occurred() )
|
|
wxLogMessage( PyErrStringWithTraceback() );
|
|
}
|
|
|
|
|
|
void FinishPythonScripting()
|
|
{
|
|
PyEval_RestoreThread( g_PythonMainTState );
|
|
Py_Finalize();
|
|
}
|
|
|
|
|
|
wxString PyEscapeString( const wxString& aSource )
|
|
{
|
|
wxString converted;
|
|
|
|
for( wxUniChar c: aSource )
|
|
{
|
|
if( c == '\\' )
|
|
converted += "\\\\";
|
|
else if( c == '\'' )
|
|
converted += "\\\'";
|
|
else if( c == '\"' )
|
|
converted += "\\\"";
|
|
else
|
|
converted += c;
|
|
}
|
|
|
|
return converted;
|
|
}
|
|
|
|
|
|
void UpdatePythonEnvVar( const wxString& aVar, const wxString& aValue )
|
|
{
|
|
char cmd[1024];
|
|
|
|
// Ensure the interpreter is initalized before we try to interact with it
|
|
if( !Py_IsInitialized() )
|
|
return;
|
|
|
|
wxLogTrace( traceEnvVars, "UpdatePythonEnvVar: Updating Python variable %s = %s",
|
|
aVar, aValue );
|
|
|
|
wxString escapedVar = PyEscapeString( aVar );
|
|
wxString escapedVal = PyEscapeString( aValue );
|
|
|
|
snprintf( cmd, sizeof( cmd ),
|
|
"# coding=utf-8\n" // The values could potentially be UTF8
|
|
"os.environ[\"%s\"]=\"%s\"\n",
|
|
TO_UTF8( escapedVar ),
|
|
TO_UTF8( escapedVal ) );
|
|
|
|
PyLOCK lock;
|
|
|
|
int retv = PyRun_SimpleString( cmd );
|
|
|
|
if( retv != 0 )
|
|
wxLogError( "Python error %d occurred running command:\n\n`%s`", retv, cmd );
|
|
}
|
|
|
|
void RedirectStdio()
|
|
{
|
|
// This is a helpful little tidbit to help debugging and such. It
|
|
// redirects Python's stdout and stderr to a window that will popup
|
|
// only on demand when something is printed, like a traceback.
|
|
const char* python_redirect =
|
|
"import sys\n"
|
|
"import wx\n"
|
|
"output = wx.PyOnDemandOutputWindow()\n"
|
|
"sys.stderr = output\n";
|
|
|
|
PyLOCK lock;
|
|
|
|
int retv = PyRun_SimpleString( python_redirect );
|
|
|
|
if( retv != 0 )
|
|
wxLogError( "Python error %d occurred running command:\n\n`%s`", retv, python_redirect );
|
|
}
|
|
|
|
|
|
wxString PyStringToWx( PyObject* aString )
|
|
{
|
|
wxString ret;
|
|
|
|
if( !aString )
|
|
return ret;
|
|
|
|
const char* str_res = NULL;
|
|
PyObject* temp_bytes = PyUnicode_AsEncodedString( aString, "UTF-8", "strict" );
|
|
|
|
if( temp_bytes != NULL )
|
|
{
|
|
str_res = PyBytes_AS_STRING( temp_bytes );
|
|
ret = FROM_UTF8( str_res );
|
|
Py_DECREF( temp_bytes );
|
|
}
|
|
else
|
|
{
|
|
wxLogMessage( "cannot encode unicode python string" );
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
|
|
wxArrayString PyArrayStringToWx( PyObject* aArrayString )
|
|
{
|
|
wxArrayString ret;
|
|
|
|
if( !aArrayString )
|
|
return ret;
|
|
|
|
int list_size = PyList_Size( aArrayString );
|
|
|
|
for( int n = 0; n < list_size; n++ )
|
|
{
|
|
PyObject* element = PyList_GetItem( aArrayString, n );
|
|
|
|
if( element )
|
|
{
|
|
const char* str_res = NULL;
|
|
PyObject* temp_bytes = PyUnicode_AsEncodedString( element, "UTF-8", "strict" );
|
|
|
|
if( temp_bytes != NULL )
|
|
{
|
|
str_res = PyBytes_AS_STRING( temp_bytes );
|
|
ret.Add( FROM_UTF8( str_res ), 1 );
|
|
Py_DECREF( temp_bytes );
|
|
}
|
|
else
|
|
{
|
|
wxLogMessage( "cannot encode unicode python string" );
|
|
}
|
|
}
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
|
|
wxString PyErrStringWithTraceback()
|
|
{
|
|
wxString err;
|
|
|
|
if( !PyErr_Occurred() )
|
|
return err;
|
|
|
|
PyObject* type;
|
|
PyObject* value;
|
|
PyObject* traceback;
|
|
|
|
PyErr_Fetch( &type, &value, &traceback );
|
|
|
|
PyErr_NormalizeException( &type, &value, &traceback );
|
|
|
|
if( traceback == NULL )
|
|
{
|
|
traceback = Py_None;
|
|
Py_INCREF( traceback );
|
|
}
|
|
|
|
PyException_SetTraceback( value, traceback );
|
|
|
|
PyObject* tracebackModuleString = PyUnicode_FromString( "traceback" );
|
|
PyObject* tracebackModule = PyImport_Import( tracebackModuleString );
|
|
Py_DECREF( tracebackModuleString );
|
|
|
|
PyObject* formatException = PyObject_GetAttrString( tracebackModule,
|
|
"format_exception" );
|
|
Py_DECREF( tracebackModule );
|
|
|
|
PyObject* args = Py_BuildValue( "(O,O,O)", type, value, traceback );
|
|
PyObject* result = PyObject_CallObject( formatException, args );
|
|
Py_XDECREF( formatException );
|
|
Py_XDECREF( args );
|
|
Py_XDECREF( type );
|
|
Py_XDECREF( value );
|
|
Py_XDECREF( traceback );
|
|
|
|
wxArrayString res = PyArrayStringToWx( result );
|
|
|
|
for( unsigned i = 0; i<res.Count(); i++ )
|
|
{
|
|
err += res[i] + wxT( "\n" );
|
|
}
|
|
|
|
PyErr_Clear();
|
|
|
|
return err;
|
|
}
|
|
|
|
|
|
/**
|
|
* Find the Python scripting path.
|
|
*/
|
|
wxString PyScriptingPath( bool aUserPath )
|
|
{
|
|
wxString path;
|
|
|
|
//@todo This should this be a user configurable variable eg KISCRIPT?
|
|
if( aUserPath )
|
|
{
|
|
path = PATHS::GetUserScriptingPath();
|
|
}
|
|
else
|
|
{
|
|
path = PATHS::GetStockScriptingPath();
|
|
}
|
|
|
|
wxFileName scriptPath( path );
|
|
scriptPath.MakeAbsolute();
|
|
|
|
// Convert '\' to '/' in path, because later python script read \n or \r
|
|
// as escaped sequence, and create issues, when calling it by PyRun_SimpleString() method.
|
|
// It can happen on Windows.
|
|
path = scriptPath.GetFullPath();
|
|
path.Replace( '\\', '/' );
|
|
|
|
return path;
|
|
}
|
|
|
|
|
|
wxString PyPluginsPath( bool aUserPath )
|
|
{
|
|
// Note we are using unix path separator, because window separator sometimes
|
|
// creates issues when passing a command string to a python method by PyRun_SimpleString
|
|
return PyScriptingPath( aUserPath ) + '/' + "plugins";
|
|
}
|