LuaBridge: support argument references via table return
[ardour.git] / 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 #define LUABRIDGE_MAJOR_VERSION 2
55 #define LUABRIDGE_MINOR_VERSION 0
56 #define LUABRIDGE_VERSION 200
57
58 namespace luabridge
59 {
60
61 // Forward declaration
62 //
63 template <class T>
64 struct Stack;
65
66 #include "detail/LuaHelpers.h"
67
68 #include "detail/TypeTraits.h"
69 #include "detail/TypeList.h"
70 #include "detail/FuncTraits.h"
71 #include "detail/Constructor.h"
72 #include "detail/Stack.h"
73 #include "detail/ClassInfo.h"
74
75 class LuaRef;
76
77 #include "detail/LuaException.h"
78 #include "detail/LuaRef.h"
79 #include "detail/Iterator.h"
80 #include "detail/FuncArgs.h"
81
82 //------------------------------------------------------------------------------
83 /**
84     security options.
85 */
86 class Security
87 {
88 public:
89   static bool hideMetatables ()
90   {
91     return getSettings().hideMetatables;
92   }
93
94   static void setHideMetatables (bool shouldHide)
95   {
96     getSettings().hideMetatables = shouldHide;
97   }
98
99 private:
100   struct Settings
101   {
102     Settings () : hideMetatables (true)
103     {
104     }
105
106     bool hideMetatables;
107   };
108
109   static Settings& getSettings ()
110   {
111     static Settings settings;
112     return settings;
113   }
114 };
115
116 #include "detail/Userdata.h"
117 #include "detail/CFunctions.h"
118 #include "detail/Namespace.h"
119
120 //------------------------------------------------------------------------------
121 /**
122     Push an object onto the Lua stack.
123 */
124 template <class T>
125 inline void push (lua_State* L, T t)
126 {
127   Stack <T>::push (L, t);
128 }
129
130 //------------------------------------------------------------------------------
131 /**
132   Set a global value in the lua_State.
133
134   @note This works on any type specialized by `Stack`, including `LuaRef` and
135         its table proxies.
136 */
137 template <class T>
138 inline void setGlobal (lua_State* L, T t, char const* name)
139 {
140   push (L, t);
141   lua_setglobal (L, name);
142 }
143
144 //------------------------------------------------------------------------------
145 /**
146   Change whether or not metatables are hidden (on by default).
147 */
148 inline void setHideMetatables (bool shouldHide)
149 {
150   Security::setHideMetatables (shouldHide);
151 }
152
153 } // end Namespace
154
155 #endif