rework lua-bridge C++ variable references
authorRobin Gareus <robin@gareus.org>
Mon, 18 Jul 2016 21:30:20 +0000 (23:30 +0200)
committerRobin Gareus <robin@gareus.org>
Mon, 18 Jul 2016 21:52:40 +0000 (23:52 +0200)
commit520dcf8cdf0e6cf36210fa7826b63fe2c64ec218
treedb61180e4c0b65a98ccb502b907ffe56a3ceac11
parentbb29478aa2739f985cc7d41ae48340a85f0b89cb
rework lua-bridge C++ variable references

Since lua functions are closures, C++ methods that pass arguments by
reference cannot be used directly. The previous approach (boost::ref)
failed with clang. Assume the following:

  void foo (float&) { }
  static inline float& bar () {
    boost::reference_wrapper<float> r (42);
    return r.get ();
  }

  foo ( bar () );

With gcc, "r" goes out of scope after foo's arguments are processed
and all is well.
But with clang,  "r" already leave scope when *inlined* bar() returns.

Solution: allocate some user-data on the lua-stack to hold the reference.
There is no reference to this user-data so lua will eventually
garbage collect it.

(theoretically, creating the table which holds the return-values
could trigger an emergency garbage collection when memory is low and
free the reference just while they're being pushed to the table, then
gain FuncArgs<Params> already dereferenced them all as variable on the
C stack -- probably again compiler specific)
libs/lua/LuaBridge/LuaBridge.h
libs/lua/LuaBridge/detail/Stack.h