| blob | 5db7159deb4070b66f3047681b9cb66e30cc518a |
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <head>
9 </head>
10 <body>
13 <p>Note: This library is currently in public beta phase. This documentation
14 should be considered beta as well. Please report any grammatical
15 corrections/spelling corrections.</p>
22 <li><a class="reference" href="#building-luabind" id="id4" name="id4">4 Building luabind</a></li>
23 <li><a class="reference" href="#basic-usage" id="id5" name="id5">5 Basic usage</a><ul class="auto-toc">
25 </ul>
26 </li>
28 <li><a class="reference" href="#binding-functions-to-lua" id="id8" name="id8">7 Binding functions to lua</a><ul class="auto-toc">
29 <li><a class="reference" href="#overloaded-functions" id="id9" name="id9">7.1 Overloaded functions</a></li>
30 <li><a class="reference" href="#signature-matching" id="id10" name="id10">7.2 Signature matching</a></li>
31 <li><a class="reference" href="#calling-lua-functions" id="id11" name="id11">7.3 Calling lua functions</a></li>
32 <li><a class="reference" href="#using-lua-threads" id="id12" name="id12">7.4 Using lua threads</a></li>
33 </ul>
34 </li>
35 <li><a class="reference" href="#binding-classes-to-lua" id="id13" name="id13">8 Binding classes to lua</a><ul class="auto-toc">
39 <li><a class="reference" href="#nested-scopes-and-static-functions" id="id17" name="id17">8.4 Nested scopes and static functions</a></li>
40 <li><a class="reference" href="#derived-classes" id="id18" name="id18">8.5 Derived classes</a></li>
41 <li><a class="reference" href="#smart-pointers" id="id19" name="id19">8.6 Smart pointers</a></li>
42 </ul>
43 </li>
46 <li><a class="reference" href="#related-functions" id="id22" name="id22">9.2 Related functions</a></li>
48 </ul>
49 </li>
50 <li><a class="reference" href="#defining-classes-in-lua" id="id24" name="id24">10 Defining classes in lua</a><ul class="auto-toc">
51 <li><a class="reference" href="#deriving-in-lua" id="id25" name="id25">10.1 Deriving in lua</a></li>
52 <li><a class="reference" href="#overloading-operators" id="id26" name="id26">10.2 Overloading operators</a></li>
54 </ul>
55 </li>
57 <li><a class="reference" href="#policies" id="id29" name="id29">12 Policies</a><ul class="auto-toc">
61 <li><a class="reference" href="#return-reference-to" id="id33" name="id33">12.4 Return reference to</a></li>
63 <li><a class="reference" href="#pure-out-value" id="id35" name="id35">12.6 Pure out value</a></li>
64 <li><a class="reference" href="#discard-result" id="id36" name="id36">12.7 Discard result</a></li>
65 <li><a class="reference" href="#return-stl-iterator" id="id37" name="id37">12.8 Return STL iterator</a></li>
67 </ul>
68 </li>
69 <li><a class="reference" href="#splitting-up-the-registration" id="id39" name="id39">13 Splitting up the registration</a></li>
71 <li><a class="reference" href="#implementation-notes" id="id41" name="id41">15 Implementation notes</a></li>
75 <li><a class="reference" href="#acknowledgments" id="id45" name="id45">19 Acknowledgments</a></li>
76 </ul>
77 </div>
80 <p>Luabind is a library that helps you create bindings between C++ and lua. It has
81 the ability to expose functions and classes, written in C++, to lua. It will
82 also supply the functionality to define classes in lua and let them derive from
83 other lua classes or C++ classes. Lua classes can override virtual functions
84 from their C++ base classes. It is written towards lua 5.0, and does not work
86 <p>It is implemented utilizing template meta programming. That means that you
87 don't need an extra preprocess pass to compile your project (it is done by the
88 compiler). It also means you don't (usually) have to know the exact signature of
89 each function you register, since the library will generate code depending on
90 the compile-time type of the function (which includes the signature). The main
91 drawback of this approach is that the compilation time will increase for the
92 file that does the registration, it is therefore recommended that you register
93 everything in the same cpp-file.</p>
94 <p>luabind is released under the terms of the <a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT license</a>.</p>
95 <p>We are very interested in hearing about projects that use luabind, please let
96 us know about your project.</p>
97 </div>
101 <blockquote>
117 </ul>
118 </blockquote>
119 </div>
123 <blockquote>
134 </ul>
135 </blockquote>
137 <blockquote>
140 </ul>
141 </blockquote>
143 means that const member functions are treated as non-const member
144 functions.</p>
145 <p>If you have tried luabind with a compiler not listed here, let us know
146 your result with it.</p>
147 </div>
150 <p>To keep down the compilation-time luabind is built as a library. This means you
151 have to either build it and lika against it, or include its source files in
152 your project. You also have to make sure the luabind directory is somewhere in
153 your compiler's include path. It requires <a class="reference" href="http://www.boost.org">Boost</a> 1.31.0 to be installed (only
154 boost headers). It also requires that lua is installed.</p>
155 <p>The official way of building luabind is with <a class="reference" href="http://www.boost.org/tools/build/v2/index_v2.html">Boost.Build V2</a>. To properly build
156 luabind with Boost.Build you need to set two environment variables:</p>
157 <dl>
161 <dd>Point this to your lua directory. The build system will assume that the
162 include and library files are located in <tt class="literal"><span class="pre">$(LUA_PATH)/include/</span></tt> and
164 </dl>
165 <p>For backward compatibility, there is also a makefile in the root-directory that
166 will build the library and the test program. If you are using a UNIX-system (or
167 cygwin) they will make it easy to build luabind as a static library. If you are
168 using Visual Studio it may be easier to include the files in the src directory
169 in your project.</p>
170 <p>When building luabind you have several options that may streamline the library
171 to better suit your needs. It is extremely important that your application has
172 the same settings as the library was built with. The available options are
174 <p>If you want to change the settings to differ from the default, it's recommended
175 that you define the settings on the commandline of all your files (in the
176 project settings in visual studio).</p>
177 </div>
180 <p>To use luabind, you must include <tt class="literal"><span class="pre">lua.h</span></tt> and luabind's main header file:</p>
183 {
185 }
188 </pre>
189 <p>This includes support for both registering classes and functions. If you just
190 want to have support for functions or classes you can include
191 <tt class="literal"><span class="pre">luabind/function.hpp</span></tt> and <tt class="literal"><span class="pre">luabind/class.hpp</span></tt> separately:</p>
195 </pre>
196 <p>The first thing you need to do is to call <tt class="literal"><span class="pre">luabind::open(lua_State*)</span></tt> which
197 will register the functions to create classes from lua, and initialize some
198 state-global structures used by luabind. If you don't call this function you
199 will hit asserts later in the library. There is no corresponding close function
200 because once a class has been registered in lua, there really isn't any good
201 way to remove it. Partly because any remaining instances of that class relies
202 on the class being there. Everything will be cleaned up when the state is
203 closed though.</p>
204 <!-- Isn't this wrong? Don't we include lua.h using lua_include.hpp ? -->
205 <p>Note that no luabind header will include <tt class="literal"><span class="pre">lua.h</span></tt>, this is up to you. You have
206 to include it before any luabind header is included.</p>
213 void greet()
214 {
216 }
219 {
220 using namespace luabind;
222 open(L);
224 module(L)
225 [
227 ];
229 return 0;
230 }
231 </pre>
234 > loadlib('hello_world.dll', 'init')()
235 > greet()
236 Hello world!
237 >
238 </pre>
239 </div>
240 </div>
243 <p>Everything that gets registered in lua is registered in a namespace (lua
244 tables) or in the global scope (called module). All registrations must be
245 surrounded by its scope. To define a module, the <tt class="literal"><span class="pre">luabind::module</span></tt> class is
246 used. It is used like this:</p>
248 module(L)
249 [
250 // declarations
251 ];
252 </pre>
253 <p>This will register all declared functions or classes in the global namespace in
254 lua. If you want to have a namespace for your module (like the standard
255 libraries) you can give a name to the constructor, like this:</p>
258 [
259 // declarations
260 ];
261 </pre>
263 <p>If you want nested namespaces you can use the <tt class="literal"><span class="pre">luabind::namespace_</span></tt> class. It
264 works exactly as <tt class="literal"><span class="pre">luabind::module</span></tt> except that it doesn't take a lua_State*
265 in it's constructor. An example of its usage could look like this:</p>
268 [
269 // declarations
272 [
273 // library-private declarations
274 ]
275 ];
276 </pre>
279 module(L)
280 [
282 [
283 // declarations
284 ]
286 ];
287 </pre>
290 [
291 // declarations
292 ];
293 </pre>
296 module(L)
297 [
303 ];
304 </pre>
305 <p>More about the actual declarations in the <a class="reference" href="#binding-functions-to-lua">Binding functions to lua</a> and
307 <p>A word of caution, if you are in really bad need for performance, putting your
308 functions in tables will increase the lookup time.</p>
309 </div>
311 <h1><a class="toc-backref" href="#id8" name="binding-functions-to-lua">7 Binding functions to lua</a></h1>
312 <p>To bind functions to lua you use the function <tt class="literal"><span class="pre">luabind::def()</span></tt>. It has the
313 following synopsis:</p>
316 void def(const char* name, F f, const Policies&);
317 </pre>
321 <li>The Policies parameter is used to describe how parameters and return values
322 are treated by the function, this is an optional parameter. More on this in
324 </ul>
325 <p>An example usage could be if you want to register the function <tt class="literal"><span class="pre">float</span>
328 module(L)
329 [
331 ];
332 </pre>
334 <h2><a class="toc-backref" href="#id9" name="overloaded-functions">7.1 Overloaded functions</a></h2>
335 <p>If you have more than one function with the same name, and want to register
336 them in lua, you have to explicitly give the signature. This is to let C++ know
337 which function you refer to. For example, if you have two functions, <tt class="literal"><span class="pre">int</span>
338 <span class="pre">f(const</span> <span class="pre">char*)</span></tt> and <tt class="literal"><span class="pre">void</span> <span class="pre">f(int)</span></tt>.</p>
340 module(L)
341 [
344 ];
345 </pre>
346 </div>
348 <h2><a class="toc-backref" href="#id10" name="signature-matching">7.2 Signature matching</a></h2>
349 <p>luabind will generate code that checks the lua stack to see if the values there
350 can match your functions' signatures. It will handle implicit typecasts between
351 derived classes, and it will prefer matches with the least number of implicit
352 casts. In a function call, if the function is overloaded and there's no
353 overload that match the parameters better than the other, you have an
354 ambiguity. This will spawn a run-time error, stating that the function call is
355 ambiguous. A simple example of this is to register one function that takes an
356 int and one that takes a float. Since lua don't distinguish between floats and
357 integers, both will always match.</p>
358 <p>Since all overloads are tested, it will always find the best match (not the
359 first match). This also means that it can handle situations where the only
360 difference in the signature is that one member function is const and the other
361 isn't.</p>
364 <p>To correctly handle ownership transfer, create_a() would need an adopt
365 return value policy. More on this in the <a class="reference" href="#policies">Policies</a> section.</p>
366 </div>
369 struct A
370 {
371 void f();
372 void f() const;
373 };
375 const A* create_a();
377 struct B: A {};
378 struct C: B {};
380 void g(A*);
381 void g(B*);
382 </pre>
385 a1 = create_a()
386 a1:f() -- the const version is called
388 a2 = A()
389 a2:f() -- the non-const version is called
391 a = A()
392 b = B()
393 c = C()
395 g(a) -- calls g(A*)
396 g(b) -- calls g(B*)
397 g(c) -- calls g(B*)
398 </pre>
399 </div>
401 <h2><a class="toc-backref" href="#id11" name="calling-lua-functions">7.3 Calling lua functions</a></h2>
402 <p>To call a lua function, you can either use <tt class="literal"><span class="pre">call_function()</span></tt>,
403 <tt class="literal"><span class="pre">call_member()</span></tt>, an <tt class="literal"><span class="pre">object</span></tt> or <tt class="literal"><span class="pre">functor</span></tt>.</p>
406 Ret call_function(lua_State* L, const char* name, ...)
407 </pre>
408 <p>This calls the global function called name. This function can only call global
409 lua functions. The ... represents a variable number of parameters that are sent
410 to the lua function. This function call may throw <tt class="literal"><span class="pre">luabind::error</span></tt> if the
411 function call fails.</p>
412 <p>The return value isn't actually Ret (the template parameter), but a proxy
413 object that will do the function call. This enables you to give policies to the
414 call. You do this with the operator[]. You give the policies within the
415 brackets, like this:</p>
418 L
420 , new complex_class()
421 )[ adopt(_1) ];
422 </pre>
425 Ret call_member(object&, const char* name, ...)
426 </pre>
427 <p>This treats the given object as an instance of a class. The given name is the
428 name of a member function to call. The ... represents a variable number of
429 parameters given to the function. This function may throw <tt class="literal"><span class="pre">luabind::error</span></tt> if
430 the function call fails.</p>
431 <p>You can give policies to a member function call the same way as you do with
433 </div>
436 <p>To start a lua thread, you have to call <tt class="literal"><span class="pre">lua_resume()</span></tt>, this means that you
437 cannot use the previous function <tt class="literal"><span class="pre">call_function()</span></tt> to start a thread. You have
438 to use</p>
441 Ret resume_function(lua_State* L, const char* name, ...)
442 </pre>
446 Ret resume(lua_State* L, ...)
447 </pre>
448 <p>The first time you start the thread, you have to give it a function to execute. i.e. you
449 have to use <tt class="literal"><span class="pre">resume_function</span></tt>, when the lua function yeilds, it will return the first
450 value passed in to <tt class="literal"><span class="pre">lua_yield()</span></tt>. When you want to continue the execution, you just call
451 <tt class="literal"><span class="pre">resume()</span></tt> on your <tt class="literal"><span class="pre">lua_State</span></tt>, since it's already executing a function, you don't pass
452 it one. The parameters to <tt class="literal"><span class="pre">resume()</span></tt> will be returned by <tt class="literal"><span class="pre">yield()</span></tt> on the lua side.</p>
453 <p>For yielding C++-functions (without the support of passing data back and forth between the
454 lua side and the c++ side), you can use the <a class="reference" href="#yield">Yield</a> policy.</p>
455 </div>
456 </div>
458 <h1><a class="toc-backref" href="#id13" name="binding-classes-to-lua">8 Binding classes to lua</a></h1>
459 <p>To register classes you use a class called <tt class="literal"><span class="pre">class_</span></tt>. Its name is supposed to
460 resemble the C++ keyword, to make it look more intuitive. It has an overloaded
461 member function <tt class="literal"><span class="pre">def()</span></tt> that is used to register member functions, operators,
462 constructors, enums and properties on the class. It will return its
463 this-pointer, to let you register more members directly.</p>
466 class testclass
467 {
468 public:
469 testclass(const std::string& s): m_string(s) {}
472 private:
473 std::string m_string;
474 };
475 </pre>
476 <p>To register it with a lua environment, write as follows (assuming you are using
477 namespace luabind):</p>
479 module(L)
480 [
484 ];
485 </pre>
486 <p>This will register the class with the name testclass and constructor that takes
487 a string as argument and one member function with the name <tt class="literal"><span class="pre">print_string</span></tt>.</p>
490 > a = testclass('a string')
491 > a:print_string()
492 a string
493 </pre>
494 <p>It is also possible to register free functions as member functions. The
495 requirement on the function is that it takes a pointer, const pointer,
496 reference or const reference to the class type as the first parameter. The rest
497 of the parameters are the ones that are visible in lua, while the object
498 pointer is given as the first parameter. If we have the following C++ code:</p>
500 struct A
501 {
502 int a;
503 };
505 int plus(A* o, int v) { return o->a + v; }
506 </pre>
507 <p>You can register <tt class="literal"><span class="pre">plus()</span></tt> as if it was a member function of A like this:</p>
511 </pre>
512 <p><tt class="literal"><span class="pre">plus()</span></tt> can now be called as a member function on A with one parameter, int.
513 If the object pointer parameter is const, the function will act as if it was a
514 const member function (it can be called on const objects).</p>
517 <p>To register a global data member with a class is easily done. Consider the
518 following class:</p>
520 struct A
521 {
522 int a;
523 };
524 </pre>
527 module(L)
528 [
531 ];
532 </pre>
533 <p>This gives read and write access to the member variable <tt class="literal"><span class="pre">A::a</span></tt>. It is also
534 possible to register attributes with read-only access:</p>
536 module(L)
537 [
540 ];
541 </pre>
542 <p>You can also register getter and setter functions and make them look as if they
543 were a public data member. Consider the following class:</p>
545 class A
546 {
547 public:
548 void set_a(int x) { a = x; }
549 int get_a() const { return a; }
551 private:
552 int a;
553 };
554 </pre>
559 </pre>
560 <p>This way the <tt class="literal"><span class="pre">get_a()</span></tt> and <tt class="literal"><span class="pre">set_a()</span></tt> functions will be called instead of
561 just writing to the data member. If you want to make it read only you can just
562 omit the last parameter.</p>
563 </div>
566 <p>If your class contains enumerated constants (enums), you can register them as
567 well to make them available in lua. Note that they will not be type safe, all
568 enums are integers in lua, and all functions that takes an enum, will accept
569 any integer. You register them like this:</p>
571 module(L)
572 [
575 [
579 ]
580 ];
581 </pre>
582 <p>In lua they are accessed like any data member, except that they are read-only
583 and reached on the class itself rather than on an instance of the class.</p>
586 > print(A.my_enum)
587 4
588 > print(A.another_enum)
589 6
590 </pre>
591 </div>
594 <p>The mechanism for registering operators on your class is pretty simple. You use
595 a global name <tt class="literal"><span class="pre">luabind::self</span></tt> to refer to the class itself and then you just
596 write the operator expression inside the <tt class="literal"><span class="pre">def()</span></tt> call. This class:</p>
598 struct vec
599 {
600 vec operator+(int s);
601 };
602 </pre>
605 module(L)
606 [
608 .def(self + int())
609 ];
610 </pre>
611 <p>This will work regardless if your plus operator is defined inside your class or
612 as a free function.</p>
613 <p>If you operator is const (or, when defined as a free function, takes a const
614 reference to the class itself) you have to use <tt class="literal"><span class="pre">const_self</span></tt> instead of
617 module(L)
618 [
620 .def(const_self + int())
621 ];
622 </pre>
624 <blockquote>
630 </ul>
631 <!-- more -->
632 </blockquote>
633 <p>This means, no in-place operators. The equality operator (==) has a little
634 hatch, it will not be called if the references are equal. This means that the
635 == operator has to do pretty much what's it's expected to do.</p>
636 <p>In the above example the other operand type is instantiated by writing
637 <tt class="literal"><span class="pre">int()</span></tt>. If the operand type is a complex type that cannot easily be
638 instantiated you can wrap the type in a class called <tt class="literal"><span class="pre">other<></span></tt>. For example:</p>
639 <p>To register this class, we don't want to instantiate a string just to register
640 the operator.</p>
642 struct vec
643 {
644 vec operator+(std::string);
645 };
646 </pre>
647 <p>Instead we use the other <tt class="literal"><span class="pre">wrapper</span></tt> like this:</p>
649 module(L)
650 [
653 ];
654 </pre>
657 module(L)
658 [
660 .def( self(int()) )
661 ];
662 </pre>
663 <p>There's one special operator. In lua it's called <tt class="literal"><span class="pre">__tostring</span></tt>, it's not
664 really an operator. It is used for converting objects to strings in a standard
665 way in lua. If you register this functionality, you will be able to use the lua
666 standard function <tt class="literal"><span class="pre">tostring()</span></tt> for converting you object to a string.</p>
667 <p>To implement this operator in C++ you should supply an <tt class="literal"><span class="pre">operator<<</span></tt> for
668 ostream. Like this example:</p>
670 class number {};
673 ...
675 module(L)
676 [
678 .def(tostring(self))
679 ];
680 </pre>
681 </div>
683 <h2><a class="toc-backref" href="#id17" name="nested-scopes-and-static-functions">8.4 Nested scopes and static functions</a></h2>
684 <p>It is possible to add nested scopes to a class. This is useful when you need
685 to wrap a nested class, or a static function.</p>
688 .def(constructor<>()
689 ...
690 .static_
691 [
694 ];
695 </pre>
697 </div>
700 <p>If you want to register classes that derives from other classes, you can
701 specify a template parameter <tt class="literal"><span class="pre">bases<></span></tt> to the <tt class="literal"><span class="pre">class_</span></tt> instantiation. The
702 following hierarchy:</p>
704 struct A {};
705 struct B : A {};
706 </pre>
709 module(L)
710 [
713 ];
714 </pre>
715 <p>If you have multiple inheritance you can specify more than one base. If B would
716 also derive from a class C, it would be registered like this:</p>
718 module(L)
719 [
721 ];
722 </pre>
723 <p>Note that you can omit <tt class="literal"><span class="pre">bases<></span></tt> when using single inheritance.</p>
726 If you don't specify that classes derive from each other, luabind will not
727 be able to implicitly cast pointers between the types.</div>
728 </div>
731 <p>When you register a class you can tell luabind that all instances of that class
732 should be held by some kind of smart pointer (boost::shared_ptr for instance).
733 You do this by giving the holder type as an extra template parameter to
734 the``class_``your constructing, like this:</p>
736 module(L)
737 [
739 ];
740 </pre>
741 <p>You also have to supply two functions for your smart pointer. One that returns
743 in this case). And one function that extracts the raw pointer from the smart
744 pointer. The first function is needed because luabind has to allow the
745 non-const -> conversion when passing values from lua to C++. The second
746 function is needed when lua calls member functions on held types, the this
747 pointer must be a raw pointer, it is also needed to allow the smart_pointer ->
748 raw_pointer conversion from lua to C++. They look like this:</p>
750 namespace luabind {
754 {
755 return p.get();
756 }
761 {
762 return 0;
763 }
764 }
765 </pre>
768 <colgroup>
771 </colgroup>
774 </tr>
775 </thead>
779 </tr>
782 </tr>
785 </tr>
788 </tr>
791 </tr>
794 </tr>
797 </tr>
800 </tr>
803 </tr>
804 </tbody>
805 </table>
807 <colgroup>
810 </colgroup>
813 </tr>
814 </thead>
818 </tr>
821 </tr>
824 </tr>
827 </tr>
828 </tbody>
829 </table>
830 <p>When using a holder type, it can be useful to know if the pointer is valid. For
831 example when using std::auto_ptr, the holder will be invalidated when passed as
832 a parameter to a function. For this purpose there is a member of all object
835 struct test {};
838 module(L)
839 [
841 .def(constructor<>()),
844 ];
845 </pre>
848 > a = test()
849 > f(a)
850 > print a.__ok
851 false
852 </pre>
853 </div>
854 </div>
857 <p>Since functions have to be able to take lua values (of variable type) we need a
858 wrapper around them. This wrapper is called <tt class="literal"><span class="pre">luabind::object</span></tt>. If the
859 function you register takes an object, it will match any lua value. To use it,
860 you need to include <tt class="literal"><span class="pre">luabind/object.hpp</span></tt>. The object class has the following
861 synopsis:</p>
863 class object
864 {
865 public:
866 class iterator;
867 class raw_iterator;
868 class array_iterator;
871 object(lua_State*, const T& value);
872 object(const object&);
873 object(lua_State*);
874 object();
876 ~object();
878 iterator begin() const;
879 iterator end() const;
880 raw_iterator raw_begin() const;
881 raw_iterator raw_end() const;
882 array_iterator abegin() const;
883 array_iterator aend() const;
885 void set();
886 lua_State* lua_state() const;
887 void pushvalue() const;
888 bool is_valid() const;
889 operator safe_bool_type() const;
895 object at(const Key&) const;
898 object raw_at(const Key&) const;
905 bool operator==(const T&) const;
906 bool operator==(const object&) const;
911 bool operator!=(const object&) const;
913 void swap(object&);
914 int type() const;
924 /* ... */
926 };
927 </pre>
928 <p>When you have a lua object, you can assign it a new value with the assignment
929 operator (=). When you do this, the <tt class="literal"><span class="pre">default_policy</span></tt> will be used to make the
930 conversion from C++ value to lua. If your <tt class="literal"><span class="pre">luabind::object</span></tt> is a table you
931 can access its members through the operator[] or the iterators. The value
932 returned from the operator[] is a proxy object that can be used both for
933 reading and writing values into the table (using operator=). Note that it is
934 impossible to know if a lua value is indexable or not (lua_gettable doesn't
935 fail, it succeeds or crashes). This means that if you're trying to index
936 something that cannot be indexed, you're on your own. Lua will call its
937 <tt class="literal"><span class="pre">panic()</span></tt> function (you can define your own panic function using
938 lua_setpanicf). The <tt class="literal"><span class="pre">at()</span></tt> and <tt class="literal"><span class="pre">raw_at()</span></tt> functions returns the value at
939 the given table position (like operator[] but only for reading).</p>
940 <p>The ordinary <tt class="literal"><span class="pre">object::iterator</span></tt> uses lua_gettable to extract the values from
941 the table, the standard way that will invoke metamethods if any. The
942 <tt class="literal"><span class="pre">object::raw_iterator</span></tt> uses lua_rawget and <tt class="literal"><span class="pre">object::array_iterator</span></tt> uses
943 lua_rawgeti. The latter will only iterate over numberical keys starting at 1
944 and continue until the first nil value.</p>
945 <p>The <tt class="literal"><span class="pre">lua_state()</span></tt> function returns the lua state where this object is stored.
946 If you want to manipulate the object with lua functions directly you can push
947 it onto the lua stack by calling <tt class="literal"><span class="pre">pushvalue()</span></tt>. And set the object's value by
948 calling <tt class="literal"><span class="pre">set()</span></tt>, which will pop the top value from the lua stack and assign
949 it to the object.</p>
951 <p>The <tt class="literal"><span class="pre">type()</span></tt> member function will return the lua type of the object. It will
952 return the same values as lua_type().</p>
953 <p>The <tt class="literal"><span class="pre">is_valid()</span></tt> function tells you whether the object has been initialized
954 or not. When created with its default constructor, objects are invalid. To make
955 an object valid, you can assign it a value. If you want to invalidate an object
956 you can simply assign it an invalid object.</p>
957 <!-- So what? implementation detail, leave out of docs
958 isn't really an implicit cast to bool, but an implicit cast
959 to a member pointer, since member pointers don't have any arithmetic operators
960 on them (which can cause hard to find errors). The functionality of the cast
961 operator -->
962 <p>The <tt class="literal"><span class="pre">operator</span> <span class="pre">safe_bool_type()</span></tt> is equivalent to <tt class="literal"><span class="pre">is_valid()</span></tt>. This means
963 that these snippets are equivalent:</p>
965 object o;
966 // ...
967 if (o)
968 {
969 // ...
970 }
972 ...
974 object o;
975 // ...
976 if (o.is_valid())
977 {
978 // ...
979 }
980 </pre>
981 <p>The application operator will call the value as if it was a function. You can
982 give it any number of parameters (currently the <tt class="literal"><span class="pre">default_policy</span></tt> will be used
983 for the conversion). The returned object refers to the return value (currently
984 only one return value is supported). This operator may throw <tt class="literal"><span class="pre">luabind::error</span></tt>
985 if the function call fails. If you want to specify policies to your function
986 call, you can use index-operator (operator[]) on the function call, and give
987 the policies within the [ and ]. Like this:</p>
989 my_function_object(
990 2
991 , 8
992 , new my_complex_structure(6)
993 ) [ adopt(_3) ];
994 </pre>
995 <p>This tells luabind to make lua adopt the ownership and responsibility for the
996 pointer passed in to the lua-function.</p>
997 <p>It's important that all instances of object have been destructed by the time
998 the lua state is closed. The object will keep a pointer to the lua state and
999 release its lua object in its destructor.</p>
1002 void my_function(const object& table)
1003 {
1004 if (table.type() == LUA_TTABLE)
1005 {
1010 }
1011 }
1012 </pre>
1013 <p>If you take a <tt class="literal"><span class="pre">luabind::object</span></tt> as a parameter to a function, any lua value
1014 will match that parameter. That's why we have to make sure it's a table before
1015 we index into it.</p>
1018 <p>The iterators, that are returned by <tt class="literal"><span class="pre">begin()</span> <span class="pre">and</span> <span class="pre">``end()</span></tt> (and their
1019 variants) are (almost) models of the ForwardIterator concept. The exception
1020 is that post increment doesn't exist on them.</p>
1023 class object::iterator
1024 {
1025 iterator();
1026 iterator(const iterator&);
1028 iterator& operator++();
1029 bool operator!=(const iterator&) const;
1032 object key() const;
1034 implementation-defined operator*();
1035 };
1036 </pre>
1037 <p>The implementation defined return value from the dereference operator is a
1038 proxy object that can be used as if it was an object, it can also be used to
1039 assign the specific table entry with a new value. If you want to assign a value
1040 to an entry pointed to by an iterator, just use the assignment operator on the
1041 dereferenced iterator:</p>
1043 *iter = 5;
1044 </pre>
1045 <p>The <tt class="literal"><span class="pre">key()</span></tt> member returns the key used by the iterator when indexing the
1046 associated lua table.</p>
1047 </div>
1049 <h2><a class="toc-backref" href="#id22" name="related-functions">9.2 Related functions</a></h2>
1060 </pre>
1061 </div>
1064 <p>The <tt class="literal"><span class="pre">functor</span></tt> class is similar to object, with the exception that it can only
1065 be used to store functions. If you take it as a parameter, it will only match
1066 functions.</p>
1070 </pre>
1071 <p>It takes one template parameter, the return value of the lua function it
1072 represents. Currently the functor can have at most one return value (unlike lua
1073 functions). It has the following synopsis:</p>
1076 class functor
1077 {
1078 public:
1080 functor(lua_State*, const char* name);
1081 functor(const functor&);
1083 ~functor();
1085 bool is_valid() const;
1086 operator safe_bool_type() const;
1087 void reset();
1089 lua_State* lua_state() const;
1090 void pushvalue() const;
1103 /* ... */
1104 };
1105 </pre>
1106 <p>The application operator takes any parameters. The parameters are converted
1107 into lua and the function is called. The return value will act as if it was the
1108 type Ret, with the exception that you can use the return value to give policies
1109 to the call. You do this the same way as you do with objects, using the
1110 operator[], and giving the policies inside the brackets.</p>
1111 <p>The <tt class="literal"><span class="pre">is_valid()</span></tt> function works just like the one on object, it tells you if
1112 the functor has been assigned with a valid lua function. The <tt class="literal"><span class="pre">operator</span>
1113 <span class="pre">safe_bool_type()</span></tt> is an alias for this member function and also works just as
1114 the one found in object.</p>
1117 function f(a, b)
1118 return a + b
1119 end
1120 </pre>
1126 </pre>
1128 to the application operator of <tt class="literal"><span class="pre">luabind::functor</span></tt>, this is because lua
1129 doesn't have signatures for its functions. All lua functions take any number of
1130 parameters of any type.</p>
1131 <p>If we have a C++ function that takes a <tt class="literal"><span class="pre">luabind::functor</span></tt> and registers it,
1132 it will accept lua functions passed to it. This enables us to expose APIs that
1133 requires you to register callbacks. For example, if your C++ API looks like
1134 this:</p>
1136 void set_callback(void(*)(int, int));
1137 </pre>
1138 <p>And you want to expose it to lua, you have to wrap the call to the lua
1139 function inside a real C++ function, like this:</p>
1143 void callback_wrapper(int a, int b)
1144 {
1145 lua_callback(a, b);
1146 }
1149 {
1150 lua_callback = f;
1151 set_callback(&callback_wrapper);
1152 }
1153 </pre>
1154 <p>And then register <tt class="literal"><span class="pre">set_callback_wrapper</span></tt> instead of registering
1155 <tt class="literal"><span class="pre">set_callback</span></tt>. This will have the effect that when one tries to register the
1156 callback from lua, your <tt class="literal"><span class="pre">set_callback_wrapper</span></tt> will be called instead and
1157 first set the lua functor to the given function. It will then call the real
1158 <tt class="literal"><span class="pre">set_callback</span></tt> with the <tt class="literal"><span class="pre">callback_wrapper</span></tt>. The <tt class="literal"><span class="pre">callback_wrapper</span></tt> will
1159 be called whenever the callback should be called, and it will simply call the
1160 lua function that we registered.</p>
1161 <p>You can also use <tt class="literal"><span class="pre">object_cast</span></tt> to cast an object to a functor.</p>
1162 <p><tt class="literal"><span class="pre">reset</span></tt> on <tt class="literal"><span class="pre">functor</span></tt> will invalidate the functor (and remove any references
1163 to its lua value). If the functor object has longer lifetime than the lua state
1164 (e.g. if it's a global).</p>
1165 </div>
1166 </div>
1168 <h1><a class="toc-backref" href="#id24" name="defining-classes-in-lua">10 Defining classes in lua</a></h1>
1169 <p>In addition to binding C++ functions and classes with lua, luabind also provide
1170 an OO-system in lua.</p>
1172 class 'lua_testclass'
1174 function lua_testclass:__init(name)
1175 self.name = name
1176 end
1178 function lua_testclass:print()
1179 print(self.name)
1180 end
1182 a = lua_testclass('example')
1183 a:print()
1184 </pre>
1187 class 'derived' (lua_testclass)
1189 function derived:__init() super('derived name')
1190 end
1192 function derived:print()
1193 print('Derived:print() -> ')
1194 lua_testclass.print(self)
1195 end
1196 </pre>
1197 <p>Here the <tt class="literal"><span class="pre">super</span></tt> keyword is used in the constructor to initialize the base
1198 class. The user is required to call <tt class="literal"><span class="pre">super</span></tt> first in the constructor.</p>
1199 <p>As you can see in this example, you can call the base class member functions.
1200 You can find all member functions in the base class, but you will have to give
1201 the this-pointer (<tt class="literal"><span class="pre">self</span></tt>) as first argument.</p>
1204 <p>It is also possible to derive lua classes from C++ classes, and override
1205 virtual functions with lua functions. To do this we have to create a wrapper
1206 class for our C++ base class. This is the class that will hold the lua object
1207 when we instantiate a lua class.</p>
1208 <p>The wrapper class has to provide the same constructors as the base class, with
1209 the addition of one extra parameter: <tt class="literal"><span class="pre">luabind::object</span></tt>. This is the reference
1210 to the lua object that should be held by the wrapper, and should be stored in a
1211 member variable as done in the sample below.</p>
1213 class base
1214 {
1215 public:
1216 base(const char* s)
1219 virtual void f(int a)
1221 };
1223 struct base_wrapper : base
1224 {
1225 object self;
1226 base_wrapper(object self_, const char* s)
1227 : base(s), self(self_)
1228 {}
1230 virtual void f(int a)
1231 {
1233 }
1235 static void f_static(base* ptr, int a)
1236 {
1237 return ptr->base::f(a);
1238 }
1239 };
1241 ...
1243 module(L)
1244 [
1248 ];
1249 </pre>
1250 <p>Note that if you have both base classes and a base class wrapper, you must give
1251 both bases and the base class wrapper type as template parameter to
1252 ´´class_´´. The order in which you specify them is not important.</p>
1253 <p>If we didn't have a class wrapper, it would not be possible to pass a lua class
1254 back to C++. Since the entry points of the virtual functions would still point
1255 to the C++ base class, and not to the functions defined in lua. That's why we
1256 need one function that calls the base class' real function (used if the lua
1257 class doesn't redefine it) and one virtual function that dispatches the call
1258 into luabind, to allow it to select if a lua function should be called, or if
1259 the original function should be called. If you don't intend to derive from a
1260 C++ class, or if it doesn't have any virtual member functions, you can register
1261 it without a class wrapper.</p>
1262 <p>You don't need to have a class wrapper in order to derive from a class, but if
1263 it has virtual functions you may have silent errors.</p>
1264 <!-- Unnecessary? The rule of thumb is:
1265 If your class has virtual functions, create a wrapper type, if it doesn't
1266 don't create a wrapper type. -->
1267 </div>
1269 <h2><a class="toc-backref" href="#id26" name="overloading-operators">10.2 Overloading operators</a></h2>
1270 <p>You can overload most operators in lua for your classes. You do this by simply
1271 declaring a member function with the same name as an operator (the name of the
1272 metamethods in lua). The operators you can overload are:</p>
1273 <blockquote>
1286 </ul>
1287 </blockquote>
1288 <p><tt class="literal"><span class="pre">__tostring</span></tt> isn't really an operator, but it's the metamethod that is called
1289 by the standard library's <tt class="literal"><span class="pre">tostring()</span></tt> function. There's one strange behavior
1290 regarding binary operators. You are not guaranteed that the self pointer you
1291 get actually refers to an instance of your class. This is because lua doesn't
1292 distinguish the two cases where you get the other operand as left hand value or
1293 right hand value. Consider the following examples:</p>
1295 class 'my_class'
1297 function my_class:__init(v)
1298 self.val = v
1299 end
1301 function my_class:__sub(v)
1302 return my_class(self.val - v.val)
1303 end
1305 function my_class:__tostring()
1306 return self.val
1307 end
1308 </pre>
1309 <p>This will work well as long as you only subtracts instances of my_class with
1310 each other. But If you want to be able to subtract ordinary numbers from your
1311 class too, you have to manually check the type of both operands, including the
1312 self object.</p>
1314 function my_class:__sub(v)
1315 if (type(self) == 'number') then
1316 return my_class(self - v.val)
1318 elseif (type(v) == 'number') then
1319 return my_class(self.val - v)
1321 else
1322 -- assume both operands are instances of my_class
1323 return my_class(self.val - v.val)
1325 end
1326 end
1327 </pre>
1328 <p>The reason why <tt class="literal"><span class="pre">__sub</span></tt> is used as an example is because subtraction is not
1329 commutative (the order of the operands matter). That's why luabind cannot
1330 change order of the operands to make the self reference always refer to the
1331 actual class instance.</p>
1332 <p>If you have two different lua classes with an overloaded operator, the operator
1333 of the right hand side type will be called. If the other operand is a C++ class
1334 with the same operator overloaded, it will be prioritized over the lua class'
1335 operator. If none of the C++ overloads matches, the lua class operator will be
1336 called.</p>
1337 </div>
1340 <p>If an object needs to perform actions when it's collected we provide a
1341 <tt class="literal"><span class="pre">__finalize</span></tt> function that can be overridden in lua-classes. The
1342 <tt class="literal"><span class="pre">__finalize</span></tt> functions will be called on all classes in the inheritance
1343 chain, starting with the most derived type.</p>
1345 ...
1347 function lua_testclass:__finalize()
1348 -- called when the an object is collected
1349 end
1350 </pre>
1351 </div>
1352 </div>
1355 <p>If any of the functions you register throws an exception when called, that
1356 exception will be caught by luabind and converted to an error string and
1357 <tt class="literal"><span class="pre">lua_error()</span></tt> will be invoked. If the exception is a <tt class="literal"><span class="pre">std::exception</span></tt> or a
1358 <tt class="literal"><span class="pre">const</span> <span class="pre">char*</span></tt> the string that is pushed on the lua stack, as error message,
1359 will be the string returned by <tt class="literal"><span class="pre">std::exception::what()</span></tt> or the string itself
1360 respectively. If the exception is unknown, a generic string saying that the
1361 function threw an exception will be pushed.</p>
1362 <p>Exceptions thrown from user defined functions have to be caught by luabind. If
1363 they weren't they would be thrown through lua itself, which is usually compiled
1364 as C code and doesn't support the stack-unwinding that exceptions imply.</p>
1365 <p>Any function that invokes lua code may throw <tt class="literal"><span class="pre">luabind::error</span></tt>. This exception
1366 means that a lua run-time error occurred. The error message is found on top of
1367 the lua stack. The reason why the exception doesn't contain the error string
1368 itself is because it would then require heap allocation which may fail. If an
1369 exception class throws an exception while it is being thrown itself, the
1370 application will be terminated.</p>
1373 class error : public std::exception
1374 {
1375 public:
1376 error(lua_State*);
1377 lua_State* state() const throw();
1378 virtual const char* what() const throw();
1379 };
1380 </pre>
1381 <p>The state function returns a pointer to the lua state in which the error was
1382 thrown. This pointer may be invalid if you catch this exception after the lua
1383 state is destructed. If the lua state is valid you can use it to retrieve the
1384 error message from the top of the lua stack.</p>
1385 <p>An example of where the lua state pointer may point to an invalid state
1386 follows:</p>
1388 struct lua_state
1389 {
1390 lua_state(lua_State* L): m_L(L) {}
1391 ~lua_state() { lua_close(m_L); }
1392 operator lua_State*() { return m_L; }
1393 lua_State* m_L;
1394 };
1396 int main()
1397 {
1398 try
1399 {
1400 lua_state L = lua_open();
1401 /* ... */
1402 }
1403 catch(luabind::error& e)
1404 {
1405 lua_State* L = e.state();
1406 // L will now point to the destructed
1407 // lua state and be invalid
1408 /* ... */
1409 }
1410 }
1411 </pre>
1412 <p>There's another exception that luabind may throw: <tt class="literal"><span class="pre">luabind::cast_failed</span></tt>,
1413 this exception is thrown from <tt class="literal"><span class="pre">call_function<></span></tt>, <tt class="literal"><span class="pre">call_member<></span></tt> or when
1414 <tt class="literal"><span class="pre">functor<></span></tt> is invoked. It means that the return value from the lua function
1415 couldn't be converted to a C++ value. It is also thrown from <tt class="literal"><span class="pre">object_cast<></span></tt>
1416 if the cast cannot be made.</p>
1417 <p>The synopsis for <tt class="literal"><span class="pre">luabind::cast_failed</span></tt> is:</p>
1419 class cast_failed : public std::exception
1420 {
1421 public:
1422 cast_failed(lua_State*);
1423 lua_State* state() const throw();
1424 LUABIND_TYPE_INFO info() const throw();
1425 virtual const char* what() const throw();
1426 };
1427 </pre>
1428 <p>Again, the state member function returns a pointer to the lua state where the
1429 error occurred. See the example above to see where this pointer may be invalid.</p>
1430 <p>The info member function returns the user defined <tt class="literal"><span class="pre">LUABIND_TYPE_INFO</span></tt>, which
1431 defaults to a <tt class="literal"><span class="pre">const</span> <span class="pre">std::type_info*</span></tt>. This type info describes the type that
1432 we tried to cast a lua value to.</p>
1433 <p>If you have defined <tt class="literal"><span class="pre">LUABIND_NO_EXCEPTIONS</span></tt> none of these exceptions will be
1434 thrown, instead you can set two callback functions that are called instead.
1435 These two functions are only defined if <tt class="literal"><span class="pre">LUABIND_NO_EXCEPTIONS</span></tt> are defined.</p>
1437 luabind::set_error_callback(void(*)(lua_State*))
1438 </pre>
1439 <p>The function you set will be called when a runtime-error occur in lua code. You
1440 can find an error message on top of the lua stack. This function is not
1441 expected to return, if it does luabind will call <tt class="literal"><span class="pre">std::terminate()</span></tt>.</p>
1443 luabind::set_cast_failed_callback(void(*)(lua_State*, LUABIND_TYPE_INFO))
1444 </pre>
1445 <p>The function you set is called instead of throwing <tt class="literal"><span class="pre">cast_failed</span></tt>. This function
1446 is not expected to return, if it does luabind will call <tt class="literal"><span class="pre">std::terminate()</span></tt>.</p>
1447 </div>
1450 <p>Sometimes it is necessary to control how luabind passes arguments and return
1451 value, to do this we have policies. These are the policies that can be used:</p>
1454 <p>This will make a copy of the parameter. This is the default behavior when
1455 passing parameters by-value. Note that this can only be used when passing from
1456 C++ to lua. This policy requires that the parameter type has a copy
1457 constructor.</p>
1458 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/copy_policy.hpp</span></tt>.</p>
1459 </div>
1465 base* create_base()
1466 {
1467 return new base();
1468 }
1470 ...
1472 module(L)
1473 [
1475 ];
1476 </pre>
1477 <p>Here we need to make sure lua understands that it should adopt the pointer
1478 returned by the factory-function. This can be done using the adopt-policy.</p>
1480 module(L)
1481 [
1483 ];
1484 </pre>
1487 base* set_and_get_new(base* ptr)
1488 {
1489 base_ptrs.push_back(ptr);
1490 return new base();
1491 }
1493 module(L)
1494 [
1496 adopt(return_value) + adopt(_1))
1497 ];
1498 </pre>
1499 <p>When lua adopts a pointer, it will call delete on it. This means that it cannot
1500 adopt pointers allocated with another allocator than new (no malloc for
1501 example).</p>
1502 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/adopt_policy.hpp</span></tt>.</p>
1503 </div>
1506 <p>The dependency policy is used to create life-time dependencies between values.
1507 Consider the following example:</p>
1509 struct A
1510 {
1511 B member;
1513 const B& get_member()
1514 {
1515 return member;
1516 }
1517 };
1518 </pre>
1521 module(L)
1522 [
1524 .def(constructor<>())
1526 ];
1527 </pre>
1528 <p>However, since the return value of get_member is a reference to a member of A,
1529 this will create some life-time issues. For example:</p>
1532 a = A()
1533 b = a:get_member() -- b points to a member of a
1534 a = nil
1535 collectgarbage(0) -- since there are no references left to a, it is
1536 -- removed
1537 -- at this point, b is pointing into a removed object
1538 </pre>
1539 <p>When using the dependency-policy, it is possible to tell luabind to tie the
1540 lifetime of one object to another, like this:</p>
1542 module(L)
1543 [
1545 .def(constructor<>())
1547 ];
1548 </pre>
1549 <p>This will create a dependency between the return-value of the function, and the
1550 self-object. This means that the self-object will be kept alive as long as the
1551 result is still alive.</p>
1554 a = A()
1555 b = a:get_member() -- b points to a member of a
1556 a = nil
1557 collectgarbage(0) -- a is dependent on b, so it isn't removed
1558 b = nil
1559 collectgarbage(0) -- all dependencies to a gone, a is removed
1560 </pre>
1561 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/dependency_policy.hpp</span></tt>.</p>
1562 </div>
1564 <h2><a class="toc-backref" href="#id33" name="return-reference-to">12.4 Return reference to</a></h2>
1565 <p>It is very common to return references to arguments or the this-pointer to
1566 allow for chaining in C++.</p>
1568 struct A
1569 {
1570 float val;
1572 A& set(float v)
1573 {
1574 val = v;
1575 return *this;
1576 }
1577 };
1578 </pre>
1579 <p>When luabind generates code for this, it will create a new object for the
1580 return-value, pointing to the self-object. This isn't a problem, but could be a
1581 bit inefficient. When using the return_reference_to-policy we have the ability
1582 to tell luabind that the return-value is already on the lua stack.</p>
1584 module(L)
1585 [
1587 .def(constructor<>())
1589 ];
1590 </pre>
1591 <p>Instead of creating a new object, luabind will just copy the object that is
1592 already on the stack.</p>
1595 This policy ignores all type information and should be used only it
1596 situations where the parameter type is a perfect match to the
1597 return-type (such as in the example).</div>
1598 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/return_reference_to_policy.hpp</span></tt>.</p>
1599 </div>
1602 <p>This policy makes it possible to wrap functions that take non const references
1603 as its parameters with the intention to write return values to them.</p>
1606 </pre>
1609 void f(float* val) { *val = *val + 10.f; }
1610 </pre>
1613 module(L)
1614 [
1616 ];
1617 </pre>
1618 <p>When invoking this function from lua it will return the value assigned to its
1619 parameter.</p>
1623 > print(a)
1624 20
1625 </pre>
1626 <p>When this policy is used in conjunction with user define types we often need
1627 to do ownership transfers.</p>
1629 struct A;
1631 void f1(A*& obj) { obj = new A(); }
1632 void f2(A** obj) { *obj = new A(); }
1633 </pre>
1634 <p>Here we need to make sure luabind takes control over object returned, for
1635 this we use the adopt policy:</p>
1637 module(L)
1638 [
1642 ];
1643 </pre>
1644 <p>Here we are using adopt as an internal policy to out_value. The index
1645 specified, _2, means adopt will be used to convert the value back to lua.
1646 Using _1 means the policy will be used when converting from lua to C++.</p>
1647 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/out_value_policy.hpp</span></tt>.</p>
1648 </div>
1651 <p>This policy works in exactly the same way as out_value, except that it
1652 replaces the parameters with default-constructed objects.</p>
1655 {
1656 x = 3.f;
1657 y = 4.f;
1658 }
1660 ...
1662 module(L)
1663 [
1665 pure_out_value(_1) + pure_out_value(_2))
1666 ];
1667 </pre>
1670 > x, y = get()
1671 > print(x, y)
1672 3 5
1673 </pre>
1674 <p>Like out_value, it is possible to specify an internal policy used then
1675 converting the values back to lua.</p>
1677 void get(test_class*& obj)
1678 {
1679 obj = new test_class();
1680 }
1682 ...
1684 module(L)
1685 [
1687 ];
1688 </pre>
1689 </div>
1692 <p>This is a very simple policy which makes it possible to throw away
1693 the value returned by a C++ function, instead of converting it to
1694 lua. This example makes sure the this reference never gets converted
1695 to lua.</p>
1697 struct simple
1698 {
1700 {
1701 name = n;
1702 return *this;
1703 }
1705 std::string name;
1706 };
1708 ...
1710 module(L)
1711 [
1714 ];
1715 </pre>
1716 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/discard_result_policy.hpp</span></tt>.</p>
1717 </div>
1719 <h2><a class="toc-backref" href="#id37" name="return-stl-iterator">12.8 Return STL iterator</a></h2>
1720 <p>This policy converts an STL container to a generator function that can be used
1721 in lua to iterate over the container. It works on any container that defines
1722 <tt class="literal"><span class="pre">begin()</span></tt> and <tt class="literal"><span class="pre">end()</span></tt> member functions (they have to return iterators). It
1723 can be used like this:</p>
1725 struct A
1726 {
1728 };
1731 module(L)
1732 [
1735 ];
1736 </pre>
1739 a = A()
1741 for name in a.names do
1742 print(name)
1743 end
1744 </pre>
1745 <p>To use this policy you need to include <tt class="literal"><span class="pre">luabind/iterator_policy.hpp</span></tt>.</p>
1746 </div>
1749 <p>This policy will cause the function to always yield the current thread when
1750 returning. See the lua manual for restrictions on yield.</p>
1751 </div>
1752 </div>
1754 <h1><a class="toc-backref" href="#id39" name="splitting-up-the-registration">13 Splitting up the registration</a></h1>
1757 luabind::scope register_a()
1758 {
1759 return
1762 ;
1763 }
1764 </pre>
1767 luabind::scope register_b()
1768 {
1769 return
1772 ;
1773 }
1774 </pre>
1777 luabind::scope register_a();
1778 luabind::scope register_b();
1780 void register_module(lua_State* L)
1781 {
1783 [
1784 register_a(),
1785 register_b()
1786 ];
1787 }
1788 </pre>
1789 </div>
1792 <p>There are a number of configuration options available when building luabind.
1793 It is very important that your project has the exact same conmfiguration
1794 options as the ones given when the library was build! The exceptions are the
1795 <tt class="literal"><span class="pre">LUABIND_MAX_ARITY</span></tt> and <tt class="literal"><span class="pre">LUABIND_MAX_BASES</span></tt> which are template-based
1796 options and only matters when you use the library (which means they can
1797 differ from the settings of the library).</p>
1798 <p>The default settings which will be used if no other settings are given
1800 <p>If you want to change the settings of the library, you can modify the
1801 config file. It is included and used by all makefiles. You can change paths
1802 to lua and boost in there as well.</p>
1803 <dl>
1805 <dd>Controls the maximum arity of functions that are registered with luabind.
1806 You can't register functions that takes more parameters than the number
1807 this macro is set to. It defaults to 5, so, if your functions have greater
1808 arity you have to redefine it. A high limit will increase compilation time.</dd>
1810 <dd>Controls the maximum number of classes one class can derive from in
1811 luabind (the number of classes specified within <tt class="literal"><span class="pre">bases<></span></tt>).
1812 <tt class="literal"><span class="pre">LUABIND_MAX_BASES</span></tt> defaults to 4. A high limit will increase
1813 compilation time.</dd>
1816 calls. If illegal function calls are made (e.g. giving parameters that
1817 doesn't match the function signature) they will not be detected by luabind
1818 and the application will probably crash. Error checking could be disabled
1819 when shipping a release build (given that no end-user has access to write
1820 custom lua code). Note that function parameter matching will be done if a
1821 function is overloaded, since otherwise it's impossible to know which one
1822 was called. Functions will still be able to throw exceptions when error
1823 checking is disabled.</p>
1826 </dd>
1829 This will in many cases disable run-time errors, when performing invalid
1830 casts or calling lua functions that fails or returns values that cannot
1831 be converted by the given policy. luabind requires that no function called
1832 directly or indirectly by luabind throws an exception (throwing exceptions
1833 through lua has undefined behavior).</p>
1835 they will be replaced with calls to the callback functions set with
1836 <tt class="literal"><span class="pre">set_error_callback()</span></tt> and <tt class="literal"><span class="pre">set_cast_failed_callback()</span></tt>.</p>
1837 </dd>
1839 <dd>If you want to link dynamically against lua, you can set this define to
1840 the import-keyword on your compiler and platform. On windows in devstudio
1841 this should be <tt class="literal"><span class="pre">__declspec(dllimport)</span></tt> if you want to link against lua
1842 as a dll.</dd>
1844 <dd>If you want to link against luabind as a dll (in devstudio), you can
1845 define <tt class="literal"><span class="pre">LUABIND_EXPORT</span></tt> to <tt class="literal"><span class="pre">__declspec(dllexport)</span></tt> and
1846 <tt class="literal"><span class="pre">LUABIND_IMPORT</span></tt> to <tt class="literal"><span class="pre">__declspec(dllimport)</span></tt>.
1847 Note that you have to link against lua as a dll aswell, to make it work.</dd>
1848 <dt>LUABIND_TYPE_INFO, LUABIND_TYPE_INFO_EQUAL(i1,i2), LUABIND_TYPEID(t), LUABIND_INVALID_TYPE_INFO</dt>
1850 type-info structure with the <tt class="literal"><span class="pre">LUABIND_TYPE_INFO</span></tt> define. Your type-info
1851 structure must be copyable and must be able to compare itself against
1852 other type-info structures. You supply the compare function through the
1853 <tt class="literal"><span class="pre">LUABIND_TYPE_INFO_EQUAL()</span></tt> define. It should compare the two type-info
1854 structures it is given and return true if they represent the same type and
1855 false otherwise. You also have to supply a function to generate your
1856 type-info structure. You do this through the <tt class="literal"><span class="pre">LUABIND_TYPEID()</span></tt> define.
1857 It should return your type-info structure and it takes a type as its
1858 parameter. That is, a compile time parameter.
1859 <tt class="literal"><span class="pre">LUABIND_INVALID_TYPE_INFO</span></tt> macro should be defined to an invalid type.
1860 No other type should be able to produce this type info. To use it you
1861 probably have to make a traits class with specializations for all classes
1862 that you have type-info for. Like this:</p>
1864 class A;
1865 class B;
1866 class C;
1873 </pre>
1874 <p>If you have set up your own RTTI system like this (by using integers to
1875 identify types) you can have luabind use it with the following defines:</p>
1877 #define LUABIND_TYPE_INFO const std::type_info*
1878 #define LUABIND_TYPEID(t) &typeid(t)
1879 #define LUABIND_TYPE_INFO_EQUAL(i1, i2) *i1 == *i2
1880 #define LUABIND_INVALID_TYPE_INFO &typeid(detail::null_type)
1881 </pre>
1882 <p class="last">Currently the type given through <tt class="literal"><span class="pre">LUABIND_TYPE_INFO</span></tt> must be less-than
1883 comparable!</p>
1884 </dd>
1886 <dd>This define will disable all asserts and should be defined in a release
1887 build.</dd>
1888 </dl>
1889 </div>
1891 <h1><a class="toc-backref" href="#id41" name="implementation-notes">15 Implementation notes</a></h1>
1892 <p>The classes and objects are implemented as user data in lua. To make sure that
1893 the user data really is the internal structure it is supposed to be, we tag
1894 their metatables. A user data who's metatable contains a boolean member named
1895 <tt class="literal"><span class="pre">__luabind_classrep</span></tt> is expected to be a class exported by luabind. A user
1896 data who's metatable contains a boolean member named <tt class="literal"><span class="pre">__luabind_class</span></tt> is
1897 expected to be an instantiation of a luabind class.</p>
1898 <p>This means that if you make your own user data and tags its metatable with the
1899 exact same names, you can very easily fool luabind and crash the application.</p>
1900 <p>In the lua registry, luabind keeps an entry called <tt class="literal"><span class="pre">__luabind_classes</span></tt>. It
1901 should not be removed or overwritten.</p>
1902 <p>In the global table, a variable called <tt class="literal"><span class="pre">super</span></tt> is used every time a
1903 constructor in a lua-class is called. This is to make it easy for that
1904 constructor to call its base class' constructor. So, if you have a global
1905 variable named super it may very well be overwritten. This is probably not the
1906 best solution, and this restriction may very well be removed in the future.</p>
1907 <p>Luabind uses two upvalues for functions that it registers. The first is a
1908 userdata containing a list of overloads for the function, the other is a light
1909 userdata with the value 0x1337, this last value is used to identify functions
1910 registered by luabind. It should be virtually impossible to have such a pointer
1911 as secondary upvalue by pure chance. This means, if you are trying to replace
1912 an existing function with a luabind function, luabind will see that the
1913 secondary upvalue isn't the magic id number and replace it. If it can identify
1914 the function to be a luabind function, it won't replace it, but rather add
1915 another overload to it.</p>
1916 <p>Inside the luabind namespace, there's another namespace called detail. This
1917 namespace contains non-public classes and are not supposed to be used directly.</p>
1918 </div>
1921 <ul>
1922 <li><p class="first"><cite>the attribute '<class-name>.<attribute-name>' is read only</cite></p>
1923 <blockquote>
1925 or there's no setter-method registered on that property name. See the
1926 properties section.</p>
1927 </blockquote>
1928 </li>
1929 <li><p class="first"><cite>the attribute '<class-name>.<attribute-name>' is of type: (<class-name>)
1931 <blockquote>
1932 <p>This error is generated if you try to assign an attribute with a value
1933 of a type that cannot be converted to the attribute's type.</p>
1934 </blockquote>
1935 </li>
1936 <li><p class="first"><cite><class-name>() threw an exception, <class-name>:<function-name>() threw an
1937 exception</cite></p>
1938 <blockquote>
1939 <p>The class' constructor or member function threw an unknown exception.
1940 Known exceptions are const char*, std::exception. See the
1942 </blockquote>
1943 </li>
1944 <li><p class="first"><cite>no overload of '<class-name>:<function-name>' matched the arguments
1946 </li>
1947 <li><p class="first"><cite>no match for function call '<function-name>' with the parameters
1949 </li>
1950 <li><p class="first"><cite>no constructor of <class-name> matched the arguments (<parameter-types>)</cite></p>
1951 </li>
1952 <li><p class="first"><cite>no operator <operator-name> matched the arguments (<parameter-types>)</cite></p>
1953 <blockquote>
1954 <p>No function/operator with the given name takes the parameters you gave
1955 it. You have either misspelled the function name, or given it incorrect
1956 parameters. This error is followed by a list of possible candidate
1957 functions to help you figure out what parameter has the wrong type. If
1958 the candidate list is empty there's no function at all with that name.
1959 See the signature matching section.</p>
1960 </blockquote>
1961 </li>
1962 <li><p class="first"><cite>call of overloaded '<class-name>:<function-name>(<parameter-types>)' is
1963 ambiguous</cite></p>
1964 </li>
1965 <li><p class="first"><cite>ambiguous match for function call '<function-name>' with the parameters
1967 </li>
1968 <li><p class="first"><cite>call of overloaded constructor '<class-name>(<parameter-types>)' is
1969 ambiguous</cite></p>
1970 </li>
1971 <li><p class="first"><cite>call of overloaded operator <operator-name> (<parameter-types>) is
1972 ambiguous</cite></p>
1973 <blockquote>
1974 <p>This means that the function/operator you are trying to call has at least
1975 one other overload that matches the arguments just as good as the first
1976 overload.</p>
1977 </blockquote>
1978 </li>
1979 <li><p class="first"><cite>cannot derive from C++ class '<class-name>'. It does not have a wrapped
1980 type.</cite></p>
1981 <blockquote>
1982 <p>You are trying to derive a lua class from a C++ class that doesn't have a
1983 wrapped type. You have to give your C++ class a wrapped type when you
1984 register it with lua. See the deriving in lua section.</p>
1985 </blockquote>
1986 </li>
1988 </li>
1989 <li><p class="first"><cite>cannot set property '<class-name>.<attribute_name>' because it's read only</cite></p>
1990 <blockquote>
1991 <p>The attribute you are trying to set is registered as read only. If you want
1992 it to be writeable you have to change your class registration and use
1993 def_readwrite() instead of def_readonly(). Alternatively (if your
1994 attribute is a property with getter and setter functions), you have to
1995 give a setter function when declaring your attribute. See the properties section.</p>
1996 </blockquote>
1997 </li>
1998 <li><p class="first"><cite>no static '<enum-name>' in class '<class-name>'</cite></p>
1999 <blockquote>
2000 <p>You will get this error message if you are trying to access an enum that
2001 doesn't exist. Read about how to declare enums.</p>
2002 </blockquote>
2003 </li>
2005 <blockquote>
2006 <p>You have written a malformed class definition in lua. The format is: class
2008 class, you have to break the line directly after the class declaration.</p>
2009 </blockquote>
2010 </li>
2012 <blockquote>
2013 <p>You have written a malformed class definition in lua. The class function
2014 expects a string as argument. That string is the name of the lua class to
2015 define.</p>
2016 </blockquote>
2017 </li>
2018 </ul>
2019 </div>
2022 <dl>
2024 <dd>If you're having problem with functions
2025 that cannot be converted from 'void (__stdcall <em>)(int,int)' to 'void
2026 (__cdecl</em>)(int,int)'. You can change the project settings to make the
2027 compiler generate functions with __cdecl calling conventions. This is
2028 a problem in developer studio.</dd>
2030 <dd>You cannot register a function with ellipses in its signature. Since
2031 ellipses don't preserve type safety, those should be avoided anyway.</dd>
2033 <dd>If you, in visual studio, get fatal error C1204: compiler limit :
2034 internal structure overflow. You should try to split that compilation
2035 unit up in smaller ones.</dd>
2037 <dd>Visual Studio doesn't like anonymous namespaces in its precompiled
2038 headers. If you encounter this problem you can disable precompiled
2039 headers for the compilation unit (cpp-file) that uses luabind.</dd>
2041 <dd>In visual studio you will probably hit this error. To fix it you have to
2042 increase the internal heap with a command-line option. We managed to
2043 compile the test suit with /Zm300, but you may need a larger heap then
2044 that.</dd>
2045 <dt>error C1055: compiler limit <span class="classifier-delimiter">:</span> <span class="classifier">out of keys in VC</span></dt>
2046 <dd>It seems that this error occurs when too many assert() are used in a
2047 program, or more specifically, the __LINE__ macro. It seems to be fixed by
2048 changing /ZI (Program database for edit and continue) to /Zi
2049 (Program database).</dd>
2052 debug-info and symbols (luabind consists of a lot of functions). Also,
2053 if built in debug mode, no optimizations were applied, luabind relies on
2054 that the compiler is able to inline functions. If you built in release
2055 mode, try running strip on your executable to remove export-symbols,
2056 this will trim down the size.</p>
2058 compared to gcc on other platforms and other compilers.</p>
2059 </dd>
2060 </dl>
2061 <!-- HUH?! // check the magic number that identifies luabind's functions -->
2062 <dl>
2065 class. Because there's no lua counterpart to C++ templates. For example,
2068 module(L)
2069 [
2073 ];
2074 </pre>
2075 </dd>
2076 </dl>
2077 <!-- Again, irrelevant to docs: Note that the space between the two > is required by C++. -->
2078 <dl>
2081 object is collected. Note that lua has to own the object to collect it.
2082 If you pass it to C++ and gives up ownership (with adopt policy) it will
2083 no longer be owned by lua, and not collected.</p>
2085 you want to be sure that the correct destructor is called (this apply to C++
2086 in general).</p>
2087 </dd>
2088 </dl>
2089 <!-- And again, the above is irrelevant to docs. This isn't a general C++ FAQ. -->
2090 <dl>
2091 <dt>Fatal Error C1063 compiler limit <span class="classifier-delimiter">:</span> <span class="classifier">compiler stack overflow in VC</span></dt>
2092 <dd>VC6.5 chokes on warnings, if you are getting alot of warnings from your
2093 code try suppressing them with a pragma directive, this should solve the
2094 problem.</dd>
2096 <dd>When you build luabind, lua and you project, make sure you link against
2097 the runtime dynamically (as a dll).</dd>
2099 <dd>This is because there is no way to get a reference to a lua value. Have
2100 a look at out_value and pure_out_value policies.</dd>
2101 </dl>
2102 </div>
2106 <li>You cannot use strings with extra nulls in them as member names that refers
2107 to C++ members.</li>
2108 <li>If one class registers two functions with the same name and the same
2109 signature, there's currently no error. The last registered function will
2110 be the one that's used.</li>
2112 </ul>
2113 <!-- remove? - Visual studio have problems selecting the correct overload of std::swap()
2114 for luabind::object. -->
2116 <li>If you register a function and later rename it, error messages will use the
2117 original function name.</li>
2118 </ul>
2119 </div>
2123 All rights reserved.</p>
2124 <p>This library was inspired by Dave Abrahams' Boost.Python library which can be
2126 <p>Evan Wies has contributed with thorough testing and countless bug reports and
2127 feature ideas.</p>
2129 </div>
2130 </div>
2131 </body>
2132 </html>