WScriptInterpreterPython.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WSCRIPTINTERPRETERPYTHON_H
#define WSCRIPTINTERPRETERPYTHON_H
 
#ifdef PYTHON_FOUND
 
#include <memory>
#include <queue>
#include <string>
#include <vector>
 
#include <boost/python.hpp>
#include <boost/thread/mutex.hpp>
 
#include "../../common/WThreadedRunner.h"
#include "../WScriptInterpreter.h"
#include "../wrappers/WLoggerWrapper.h"
#include "../wrappers/WModuleContainerWrapper.h"
 
namespace pb = boost::python;
 
/**
 * \class WScriptInterpreterPython
 *
 * An interpreter for python scripts.
 */
class WScriptInterpreterPython : public WScriptInterpreter
{
public:
    /**
     * Constructor. Creates the interpreter.
     */
    explicit WScriptInterpreterPython( std::shared_ptr< WModuleContainer > const& rootContainer );
 
    /**
     * Destructor. Destroys the interpreter.
     */
    virtual ~WScriptInterpreterPython();
 
    /**
     * Initializes bindings for OpenWalnut classes. Call this after starting the kernel.
     */
    virtual void initBindings();
 
    /**
     * Sets the script parameters. These are the parameters you would normally call your script with, e.g.
     * "./myscript.py param 1 param2".
     *
     * \param params The parameters to the script. In our example, they would be "./myscript.py", "param", "1" and "param2".
     */
    virtual void setParameters( std::vector< std::string > const& params );
 
    /**
     * Execute some python code.
     *
     * \param line The code to execute.
     */
    virtual void execute( std::string const& line );
 
    /**
     * Execute a script in a seperate thread. This function returns immediately.
     *
     * \param script The script to execute.
     */
    virtual void executeAsync( std::string const& script );
 
    /**
     * Execute a file.
     *
     * \param filename The script file to execute.
     */
    virtual void executeFile( std::string const& filename );
 
    /**
     * Execute a script file in a seperate thread. This function returns immediately.
     *
     * \param filename The script file to execute.
     */
    virtual void executeFileAsync( std::string const& filename );
 
    /**
     * Get the name of the language interpreted by this interpreter.
     *
     * \return The name of the script language.
     */
    virtual std::string const getName() const;
 
    /**
     * Get the default extension for script file belonging to the script interpreter's language.
     *
     * \return The default file extension.
     */
    virtual std::string const getExtension() const;
 
private:
    /**
     * A thread that executes scripts from a queue.
     */
    class ScriptThread : public WThreadedRunner
    {
    public:
        /**
         * Create a thread.
         */
        explicit ScriptThread( WScriptInterpreterPython& interpreter ); // NOLINT reference
 
        /**
         * Destructor.
         */
        virtual ~ScriptThread();
 
        /**
         * Executes scripts stored in the script queue and sleeps as long as no
         * scripts are in the queue.
         */
        virtual void threadMain();
 
        /**
         * Adds a script string to the queue. This is a thread-safe operation.
         *
         * \param script The script to add.
         */
        void addToExecuteQueue( std::string const& script );
 
        /**
         * Request this script thread to stop. Returns immediatly.
         */
        void requestStop();
 
    private:
        //! A queue for scripts to be executed.
        std::queue< std::string > m_scriptQueue;
 
        //! A mutex for thread-safe adding to the queue.
        boost::mutex m_queueMutex;
 
        //! A condition to be notified when a new script is added.
        std::shared_ptr< WCondition > m_condition;
 
        //! A condition set used for immidiate returns on wait() if it was notified beforehand.
        WConditionSet m_conditionSet;
 
        //! A reference to the interpreter this thread belongs to.
        WScriptInterpreterPython& m_interpreter;
    };
 
    //! The python module.
    pb::object m_pyModule;
 
    //! The namespace where we will be working. Bindings are declared in this workspace.
    pb::object m_pyMainNamespace;
 
    //! A pointer to the kernel's root container. We can use this to manipulate modules.
    WModuleContainerWrapper m_rootContainer;
 
    //! The logger.
    WLoggerWrapper m_logger;
 
    //! The number of args passed when calling the script.
    int m_argc;
 
    //! The args passed to the script.
    char** m_argv;
 
    //! A mutex for safe execution of scripts.
    boost::mutex m_mutex;
 
    //! A thread for asynchronous execution of scripts.
    ScriptThread m_scriptThread;
};
 
#endif  // PYTHON_FOUND
 
#endif  // WSCRIPTINTERPRETERPYTHON_H