kicad/scripting/kipython_frame.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 KiCad Developers, see CHANGELOG.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 3
 * 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/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include <frame_type.h>
#include <kipython_frame.h>
#include <kiway_player.h>
#include <python_scripting.h>

#include <pybind11/embed.h>
#include <sstream>
#include <pybind11/embed.h>

void KIPYTHON_FRAME::SetupPythonEditor()
{
    using namespace pybind11::literals;

    // As always, first grab the GIL
    PyLOCK lock;

    // Make sure the kicad_pyshell module is in the path
    wxString sysPath = SCRIPTING::PyScriptingPath( false );
    auto     locals  = pybind11::dict( "stock_path"_a = sysPath.ToStdString() );

    pybind11::exec( R"(
import sys
sys.path.append( stock_path )
    )", pybind11::globals(), locals );

    // passing window ids instead of pointers is because wxPython is not
    // exposing the needed c++ apis to make that possible.
    std::stringstream pcbnew_pyshell_one_step;
    pcbnew_pyshell_one_step << "import kicad_pyshell\n";
    pcbnew_pyshell_one_step << "newshell = kicad_pyshell.makePcbnewShellWindow( " << GetId() << " )\n";

    // Execute the code to make the makeWindow function we defined above
    PyRun_SimpleString( pcbnew_pyshell_one_step.str().c_str() );
}


void KIPYTHON_FRAME::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.

    PyLOCK      lock;

    using namespace pybind11::literals;
    int id = GetId();
    auto locals = pybind11::dict( "parent_id"_a= id );

    pybind11::exec( R"(
import sys
import wx
output = wx.PyOnDemandOutputWindow()
sys.stderr = output
parent = wx.Window.FindWindowById( parent_id )
output.SetParent( parent )
    )", pybind11::globals(), locals );
}

KIPYTHON_FRAME::KIPYTHON_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
            KIWAY_PLAYER( aKiway, aParent, FRAME_PYTHON, wxT( "KiPython" ), wxDefaultPosition,
                    wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, wxT( "KiPython" ) )
{
    m_stdio = 0;

    CallAfter( [&](){ SetupPythonEditor(); } );

    redirectStdio();
}


KIPYTHON_FRAME::~KIPYTHON_FRAME()
{
    wxWindow* stdio_window = wxWindow::FindWindowById( m_stdio );

    if( stdio_window )
        stdio_window->Close( true );
}