kicad/pcbnew/swig/python_scripting.h

/*
 * 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

#ifndef NO_WXPYTHON_EXTENSION_HEADERS
#ifdef KICAD_SCRIPTING_WXPYTHON
    #ifdef KICAD_SCRIPTING_WXPYTHON_PHOENIX
        #include <wx/window.h>
    #else
        #include <wx/wxPython/wxPython.h>
    #endif
#endif
#endif

#include <wx/string.h>
#include <wx/arrstr.h>


/**
 * Initialize the Python engine inside pcbnew.
 */
bool pcbnewInitPythonScripting( const char* aStockScriptingPath, const char* aUserScriptingPath );
void pcbnewFinishPythonScripting();

/**
 * Collect the list of python scripts which could not be loaded.
 *
 * @param aNames is a wxString which will contain the filenames (separated by '\n')
 */
void        pcbnewGetUnloadableScriptNames( wxString& aNames );

/**
 * Collect the list of paths where python scripts are searched.
 *
 * @param aNames is a wxString which will contain the paths (separated by '\n')
 */
void        pcbnewGetScriptsSearchPaths( wxString& aNames );

/**
 * Return the backtrace of errors (if any) when wizard python scripts are loaded.
 *
 * @param aNames is a wxString which will contain the trace
 */
void        pcbnewGetWizardsBackTrace( wxString& aNames );

/**
 * 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        pcbnewUpdatePythonEnvVar( const wxString& aVar, const wxString& aValue );


#ifdef KICAD_SCRIPTING_WXPYTHON
void        RedirectStdio();
wxWindow*   CreatePythonShellWindow( wxWindow* parent, const wxString& aFramenameId );
#endif

bool IsWxPythonLoaded();

#if 0 && defined (KICAD_SCRIPTING_WXPYTHON)
// This definition of PyLOCK crashed Pcbnew under some conditions (JPC),
// especially reloading plugins
class PyLOCK
{
    wxPyBlock_t b;
public:

    // @todo, find out why these are wxPython specific.  We need the GIL regardless.
    // Should never assume python will only have one thread calling it.
    PyLOCK()    { b = wxPyBeginBlockThreads(); }
    ~PyLOCK()   { wxPyEndBlockThreads( b ); }
};
#else
class PyLOCK
{
    PyGILState_STATE gil_state;
public:
    PyLOCK()      { gil_state = PyGILState_Ensure(); }
    ~PyLOCK()     { PyGILState_Release( gil_state ); }
};
#endif

wxString        PyStringToWx( PyObject* str );
wxArrayString   PyArrayStringToWx( PyObject* arr );
wxString        PyErrStringWithTraceback();

wxString        PyScriptingPath( bool aUserPath = false );
wxString        PyPluginsPath( bool aUserPath = false );

#endif    // __PYTHON_SCRIPTING_H