libs/lua/LuaBridge/LuaBridge.h

   1 //------------------------------------------------------------------------------
   2 /*
   3   https://github.com/vinniefalco/LuaBridge
   4
   5   Copyright 2016, Robin Gareus <robin@gareus.org>
   6   Copyright 2012, Vinnie Falco <vinnie.falco@gmail.com>
   7   Copyright 2007, Nathan Reed
   8
   9   License: The MIT License (http://www.opensource.org/licenses/mit-license.php)
  10
  11   Permission is hereby granted, free of charge, to any person obtaining a copy
  12   of this software and associated documentation files (the "Software"), to deal
  13   in the Software without restriction, including without limitation the rights
  14   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15   copies of the Software, and to permit persons to whom the Software is
  16   furnished to do so, subject to the following conditions:
  17
  18   The above copyright notice and this permission notice shall be included in all
  19   copies or substantial portions of the Software.
  20
  21   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27   SOFTWARE.
  28 */
  29 //==============================================================================
  30
  31 #ifndef LUABRIDGE_LUABRIDGE_HEADER
  32 #define LUABRIDGE_LUABRIDGE_HEADER
  33
  34 // All #include dependencies are listed here
  35 // instead of in the individual header files.
  36 //
  37 #include <cassert>
  38 #include <sstream>
  39 #include <stdexcept>
  40 #include <string>
  41 #include <typeinfo>
  42
  43 #include <bitset>
  44 #include <list>
  45 #include <map>
  46 #include <set>
  47 #include <vector>
  48
  49 #include <inttypes.h>
  50 #include <boost/ref.hpp>
  51 #include <boost/type_traits.hpp>
  52 #include <boost/shared_ptr.hpp>
  53
  54 #include "lua/luastate.h"
  55
  56 #define LUABRIDGE_MAJOR_VERSION 2
  57 #define LUABRIDGE_MINOR_VERSION 0
  58 #define LUABRIDGE_VERSION 200
  59
  60 namespace luabridge
  61 {
  62
  63 // Forward declaration
  64 //
  65 template <class T>
  66 struct Stack;
  67
  68 #include "detail/LuaHelpers.h"
  69
  70 #include "detail/TypeTraits.h"
  71 #include "detail/TypeList.h"
  72 #include "detail/FuncTraits.h"
  73 #include "detail/Constructor.h"
  74 #include "detail/Stack.h"
  75 #include "detail/ClassInfo.h"
  76
  77 class LuaRef;
  78
  79 #include "detail/LuaException.h"
  80 #include "detail/LuaRef.h"
  81 #include "detail/Iterator.h"
  82 #include "detail/FuncArgs.h"
  83
  84 //------------------------------------------------------------------------------
  85 /**
  86     security options.
  87 */
  88 class Security
  89 {
  90 public:
  91   static bool hideMetatables ()
  92   {
  93     return getSettings().hideMetatables;
  94   }
  95
  96   static void setHideMetatables (bool shouldHide)
  97   {
  98     getSettings().hideMetatables = shouldHide;
  99   }
 100
 101 private:
 102   struct Settings
 103   {
 104     Settings () : hideMetatables (true)
 105     {
 106     }
 107
 108     bool hideMetatables;
 109   };
 110
 111   static Settings& getSettings ()
 112   {
 113     static Settings settings;
 114     return settings;
 115   }
 116 };
 117
 118 //------------------------------------------------------------------------------
 119
 120 #ifdef LUABINDINGDOC
 121 class LuaBindingDoc
 122 {
 123 public:
 124         static bool printBindings ()
 125         {
 126                 return getSettings().print_bindings;
 127         }
 128
 129         static void setPrintBindings (bool en)
 130         {
 131                 getSettings().print_bindings = en;
 132         }
 133
 134 private:
 135         struct Settings
 136         {
 137                 Settings () : print_bindings (false) { }
 138                 bool print_bindings;
 139         };
 140
 141         static Settings& getSettings ()
 142         {
 143                 static Settings settings;
 144                 return settings;
 145         }
 146 };
 147 #endif
 148
 149 //------------------------------------------------------------------------------
 150
 151
 152 #include "detail/Userdata.h"
 153 #include "detail/CFunctions.h"
 154 #include "detail/Namespace.h"
 155
 156 //------------------------------------------------------------------------------
 157 /**
 158     Push an object onto the Lua stack.
 159 */
 160 template <class T>
 161 inline void push (lua_State* L, T t)
 162 {
 163   Stack <T>::push (L, t);
 164 }
 165
 166 //------------------------------------------------------------------------------
 167 /**
 168   Set a global value in the lua_State.
 169
 170   @note This works on any type specialized by `Stack`, including `LuaRef` and
 171         its table proxies.
 172 */
 173 template <class T>
 174 inline void setGlobal (lua_State* L, T t, char const* name)
 175 {
 176   push (L, t);
 177   lua_setglobal (L, name);
 178 }
 179
 180 //------------------------------------------------------------------------------
 181 /**
 182   Change whether or not metatables are hidden (on by default).
 183 */
 184 inline void setHideMetatables (bool shouldHide)
 185 {
 186   Security::setHideMetatables (shouldHide);
 187 }
 188
 189 #ifdef LUABINDINGDOC
 190 inline void setPrintBindings (bool en)
 191 {
 192   LuaBindingDoc::setPrintBindings (en);
 193 }
 194 #endif
 195
 196 } // end Namespace
 197
 198 #endif