src/python.h

   1 /***************************************
   2 ** Tsunagari Tile Engine              **
   3 ** python.h                           **
   4 ** Copyright 2011-2013 PariahSoft LLC **
   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 #include <string>
  31
  32 typedef struct _object PyObject;
  33
  34 extern int inPythonScript;
  35
  36
  37 //! Initialize Python libraries for use.
  38 bool pythonInit();
  39
  40 //! Free resources used by Python libraries and uninitialize them.
  41 void pythonFinalize();
  42
  43 //! Print last error received within Python.
  44 void pythonErr();
  45
  46
  47 bool pythonPrependPath(const std::string& path);
  48 bool pythonRmPath(const std::string& path);
  49
  50
  51 //! Access to global namespace shared by all Python scripts.
  52 //! Object is borrowed, so don't Py_DECREF it.
  53 PyObject* pythonGlobals();
  54
  55 //! Bind a C++ object into the global Python namespace.
  56 template<class T>
  57 void pythonSetGlobal(const std::string& name, T pointer);
  58
  59 template<class Fn>
  60 void pythonAddFunction(const std::string& name, Fn fn);
  61
  62 void pythonDumpGlobals();
  63
  64 #endif
  65