PythonInterpreter.h

Go to the documentation of this file.

/*
 For more information, please see: http://software.sci.utah.edu

 The MIT License

 Copyright (c) 2009 Scientific Computing and Imaging Institute,
 University of Utah.


 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
 to deal in the Software without restriction, including without limitation
 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included
 in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 */

#ifndef CORE_PYTHON_PYTHONINTERPRETER_H
#define CORE_PYTHON_PYTHONINTERPRETER_H

//#include <boost/python.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/signals2/signal.hpp>

#include <Core/Utils/Singleton.h>
#include <Core/Python/share.h>
//#include <Core/EventHandler/EventHandler.h>
//#include <Core/Python/PythonActionContext.h>

class PythonStdIO;

namespace SCIRun 
{
namespace Core
{

///@class  PythonInterpreter
///@brief  A wrapper class of the python interpreter.
///@details It calls the python interpreter on a separate thread.

class PythonInterpreterPrivate;
typedef boost::shared_ptr< PythonInterpreterPrivate > PythonInterpreterPrivateHandle;

class SCISHARE PythonInterpreter /*: private Core::EventHandler*/
{
    CORE_SINGLETON( PythonInterpreter );
    
public:
    

private:
    PythonInterpreter();
    virtual ~PythonInterpreter();

    // -- overloaded event handler --
private:
    // INITIALIZE_EVENTHANDLER:
    /// This function initializes the event handler associated with the singleton
    /// class. It initializes the python interpreter.
    void initialize_eventhandler();

public:
    // PRINT_BANNER:
    /// Print the basic information about the python interpreter to output_signal_.
    void print_banner();

    // RUN_STRING:
    /// Execute a single python command.
    /// NOTE: The command is run in the main namespace.
    void run_string( const std::string& command );

    // RUN_SCRIPT:
    /// Execute a python script.
    /// NOTE: The script is run in its own local namespace.
    void run_script( const std::string& script );
  
    // RUN_FILE:
    /// Execute a python script from file.
    /// NOTE: The script is run in its own local namespace.
    void run_file( const std::string& file_name );

    // INTERRUPT:
    /// Interrupt the current execution.
    void interrupt();

    // START_TERMINAL:
    /// To be implemented.
    void start_terminal();

    // -- signals --
public:
    typedef boost::signals2::signal< void ( const std::string& ) > console_output_signal_type;
    console_output_signal_type prompt_signal_;
    console_output_signal_type error_signal_;
    console_output_signal_type output_signal_;

private:
    friend class ::PythonStdIO;
    PythonInterpreterPrivateHandle private_;

public:
    // ESCAPEQUOTES:
    /// Escape the quotes(') and backslashes(\) in a string so it can be used as a python string enclosed
    /// by a pair of single quotes.
    static std::string EscapeSingleQuotedString( const std::string& input_str );
};

}}

#endif