PythonScript.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API 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.
//
//    H3D API 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 H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __PYTHONSCRIPT_H__
#define __PYTHONSCRIPT_H__
 
#include <H3DUtil/Exception.h>
#include <H3D/H3DScriptNode.h>
#include <H3D/MFNode.h>
#include <H3D/SFString.h>
 
#ifdef HAVE_PYTHON
 
#ifndef PyObject_HEAD
struct _object;
typedef _object PyObject;
#endif
 
namespace H3D {
  
  struct H3DAPI_API PythonScript : public H3DScriptNode {
    PythonScript( Inst< MFString > _url = 0,
                  Inst< MFNode    > _references = 0,
                  Inst< SFString > _moduleName = 0 );
    
    virtual Field * getField( const string& _name) const {
      Field *f = H3DScriptNode::getField( _name );
      if( f ) return f;
      if ( _name == "references" )
        return references.get();
      else
        return lookupField( _name );
    }
    
    ~PythonScript();
    
    virtual Field *lookupField( const string &_name ) const;
 
    virtual PyObject *getPythonAttribute( const string &_name ); 
 
    virtual void getTopLevelFields( vector< pair< string, Field * > > &fields );
 
    virtual void traverseSG( TraverseInfo &ti );
    
    virtual bool initialiseParser();
 
    virtual string getInstanceName() {
      ostringstream namestr;
      namestr << "PythonScript_" << this; 
      return namestr.str();   
    }
    
    virtual void loadScript( const string &script_filename, const string &script_content= "" );
 
    std::string execute ( const std::string& _command );
 
    static void setargv( int _argc, char *_argv[] );
    static void setargv( int _argc, wchar_t *_argv[] );
    static bool initPythonHome( const std::string& exe_with_full_path );
 
    virtual void initialize();
 
    H3DUniquePtr< MFNode > references;
 
    H3DUniquePtr< SFString > moduleName;
    
    static H3DNodeDatabase database;
 
    static void allowMainThreadPython();
 
    static void disallowMainThreadPython();
 
    static bool mainThreadPythonAllowed();
 
    inline PyObject *getPythonModule() {
      return static_cast< PyObject *>(module);
    }
 
  private:
    void * module;
    void * module_dict;
    static int argc;
    // Set the argv parameter in Python from the PythonScript::argv or PythonScript::w_argv
    // depending on which is in use.
    static void pythonSetargv();
 
    void initializePython();
 
    // argv or w_argv is the program argv parameter. Only one will be set to non-NULL. Which 
    // on depends if the main function is the wide chars version or not.
    static char **argv;
    static wchar_t **w_argv;
    string module_name;
    static bool python_h3d_initialized;
 };
}
 
#endif // HAVE_PYTHON
#endif