kicad/scripting/python_scripting.h

98 lines
2.9 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* 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
*/
#ifndef __PYTHON_SCRIPTING_H
#define __PYTHON_SCRIPTING_H
// undefs explained here: https://bugzilla.redhat.com/show_bug.cgi?id=427617
#ifdef _POSIX_C_SOURCE
#undef _POSIX_C_SOURCE
#endif
#ifdef _XOPEN_SOURCE
#undef _XOPEN_SOURCE
#endif
#if defined(WIN32)
#undef pid_t // wxWidgets defines this, python typedefs, result is a conflict
#endif
#undef HAVE_CLOCK_GETTIME // macro is defined in Python.h and causes redefine warning
#include <Python.h>
#undef HAVE_CLOCK_GETTIME
#include <wx/window.h>
#include <wx/string.h>
#include <wx/arrstr.h>
class SCRIPTING
{
public:
SCRIPTING();
~SCRIPTING();
/// We do not allow secondary creation of the scripting system
SCRIPTING( SCRIPTING const& ) = delete;
void operator= ( SCRIPTING const& ) = delete;
static bool IsWxAvailable();
static bool IsModuleLoaded( std::string& aModule );
static wxString PyScriptingPath( bool aUserPath = false );
static wxString PyPluginsPath( bool aUserPath = false );
private:
bool scriptingSetup();
PyThreadState* m_python_thread_state;
};
/**
* Set an environment variable in the current Python interpreter.
*
* @param aVar is the variable to set
* @param aValue is the value to give it
*/
void UpdatePythonEnvVar( const wxString& aVar, const wxString& aValue );
void RedirectStdio();
wxWindow* CreatePythonShellWindow( wxWindow* parent, const wxString& aFramenameId );
bool InitPythonScripting( const char* aStockScriptingPath, const char* aUserScriptingPath );
bool IsWxPythonLoaded();
class PyLOCK
{
PyGILState_STATE gil_state;
public:
PyLOCK() { gil_state = PyGILState_Ensure(); }
~PyLOCK() { PyGILState_Release( gil_state ); }
};
wxString PyStringToWx( PyObject* str );
wxArrayString PyArrayStringToWx( PyObject* arr );
wxString PyErrStringWithTraceback();
#endif // __PYTHON_SCRIPTING_H