src/python.h

   1 /*********************************
   2 ** Tsunagari Tile Engine        **
   3 ** python.h                     **
   4 ** Copyright 2011-2012 OmegaSDG **
   5 *********************************/
   6
   7 // **********
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24 // IN THE SOFTWARE.
  25 // **********
  26
  27 #ifndef PYTHON_H
  28 #define PYTHON_H
  29
  30 // In this file.
  31 #include <boost/python/def.hpp>
  32 #include <boost/python/errors.hpp>
  33 #include <boost/python/import.hpp>
  34 #include <boost/python/object.hpp>
  35 #include <boost/python/ptr.hpp>
  36 #include <boost/python/scope.hpp>
  37
  38 // For bindings.
  39 #include <boost/python/class.hpp>
  40 #include <boost/python/operators.hpp>
  41 #include <boost/python/other.hpp>
  42 #include <boost/python/self.hpp>
  43
  44 extern int inPythonScript;
  45
  46 //! Initialize Python libraries for use.
  47 bool pythonInit();
  48
  49 //! Free resourcers used by Python libraries and uninitialize them.
  50 void pythonFinalize();
  51
  52 //! Print last error received within Python.
  53 void pythonErr();
  54
  55
  56 //! Access to global namespace shared by all Python scripts.
  57 boost::python::object pythonGlobals();
  58
  59 //! Convenience function for binding a C++ object into the global Python
  60 //! namespace.
  61 template<class T>
  62 void pythonSetGlobal(const char* name, T pointer)
  63 {
  64         try {
  65                 pythonGlobals()[name] = boost::python::ptr(pointer);
  66         } catch (boost::python::error_already_set) {
  67                 pythonErr();
  68         }
  69 }
  70
  71 template<class Fn>
  72 void pythonAddFunction(const char* name, Fn fn)
  73 {
  74         using namespace boost::python;
  75
  76         try {
  77                 scope bltins(import("__builtin__"));
  78                 def(name, fn);
  79         } catch (error_already_set) {
  80                 pythonErr();
  81         }
  82 }
  83
  84
  85 //! Compile a Python script. Must provide both a representative filename for
  86 //! any error messages along with a string containing the body of code to
  87 //! compile. Returns NULL on failure and prints any errors.
  88 PyCodeObject* pythonCompile(const char* fn, const char* code);
  89
  90 //! Run a compiled Python script. Returns false on runtime error and prints the
  91 //! error.
  92 bool pythonExec(PyCodeObject* code);
  93
  94 #endif
  95