xref: /minix3/external/bsd/lutok/dist/c_gate.cpp (revision 11be35a165022172ed3cea20f2b5df0307540b0e)
1*11be35a1SLionel Sambuc // Copyright 2011 Google Inc.
2*11be35a1SLionel Sambuc // All rights reserved.
3*11be35a1SLionel Sambuc //
4*11be35a1SLionel Sambuc // Redistribution and use in source and binary forms, with or without
5*11be35a1SLionel Sambuc // modification, are permitted provided that the following conditions are
6*11be35a1SLionel Sambuc // met:
7*11be35a1SLionel Sambuc //
8*11be35a1SLionel Sambuc // * Redistributions of source code must retain the above copyright
9*11be35a1SLionel Sambuc //   notice, this list of conditions and the following disclaimer.
10*11be35a1SLionel Sambuc // * Redistributions in binary form must reproduce the above copyright
11*11be35a1SLionel Sambuc //   notice, this list of conditions and the following disclaimer in the
12*11be35a1SLionel Sambuc //   documentation and/or other materials provided with the distribution.
13*11be35a1SLionel Sambuc // * Neither the name of Google Inc. nor the names of its contributors
14*11be35a1SLionel Sambuc //   may be used to endorse or promote products derived from this software
15*11be35a1SLionel Sambuc //   without specific prior written permission.
16*11be35a1SLionel Sambuc //
17*11be35a1SLionel Sambuc // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*11be35a1SLionel Sambuc // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*11be35a1SLionel Sambuc // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*11be35a1SLionel Sambuc // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*11be35a1SLionel Sambuc // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*11be35a1SLionel Sambuc // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*11be35a1SLionel Sambuc // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*11be35a1SLionel Sambuc // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*11be35a1SLionel Sambuc // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*11be35a1SLionel Sambuc // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*11be35a1SLionel Sambuc // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*11be35a1SLionel Sambuc 
29*11be35a1SLionel Sambuc #include "c_gate.hpp"
30*11be35a1SLionel Sambuc #include "state.ipp"
31*11be35a1SLionel Sambuc 
32*11be35a1SLionel Sambuc 
33*11be35a1SLionel Sambuc /// Creates a new gateway to an existing C++ Lua state.
34*11be35a1SLionel Sambuc ///
35*11be35a1SLionel Sambuc /// \param state_ The state to connect to.  This object must remain alive while
36*11be35a1SLionel Sambuc ///     the newly-constructed state_c_gate is alive.
state_c_gate(state & state_)37*11be35a1SLionel Sambuc lutok::state_c_gate::state_c_gate(state& state_) :
38*11be35a1SLionel Sambuc     _state(state_)
39*11be35a1SLionel Sambuc {
40*11be35a1SLionel Sambuc }
41*11be35a1SLionel Sambuc 
42*11be35a1SLionel Sambuc 
43*11be35a1SLionel Sambuc /// Destructor.
44*11be35a1SLionel Sambuc ///
45*11be35a1SLionel Sambuc /// Destroying this object has no implications on the life cycle of the Lua
46*11be35a1SLionel Sambuc /// state.  Only the corresponding state object controls when the Lua state is
47*11be35a1SLionel Sambuc /// closed.
~state_c_gate(void)48*11be35a1SLionel Sambuc lutok::state_c_gate::~state_c_gate(void)
49*11be35a1SLionel Sambuc {
50*11be35a1SLionel Sambuc }
51*11be35a1SLionel Sambuc 
52*11be35a1SLionel Sambuc 
53*11be35a1SLionel Sambuc /// Creates a C++ state for a C Lua state.
54*11be35a1SLionel Sambuc ///
55*11be35a1SLionel Sambuc /// \warning The created state object does NOT own the C state.  You must take
56*11be35a1SLionel Sambuc /// care to properly destroy the input lua_State when you are done with it to
57*11be35a1SLionel Sambuc /// not leak resources.
58*11be35a1SLionel Sambuc ///
59*11be35a1SLionel Sambuc /// \param raw_state The raw state to wrap temporarily.
60*11be35a1SLionel Sambuc ///
61*11be35a1SLionel Sambuc /// \return The wrapped state without strong ownership on the input state.
62*11be35a1SLionel Sambuc lutok::state
connect(lua_State * raw_state)63*11be35a1SLionel Sambuc lutok::state_c_gate::connect(lua_State* raw_state)
64*11be35a1SLionel Sambuc {
65*11be35a1SLionel Sambuc     return state(static_cast< void* >(raw_state));
66*11be35a1SLionel Sambuc }
67*11be35a1SLionel Sambuc 
68*11be35a1SLionel Sambuc 
69*11be35a1SLionel Sambuc /// Returns the C native Lua state.
70*11be35a1SLionel Sambuc ///
71*11be35a1SLionel Sambuc /// \return A native lua_State object holding the Lua C API state.
72*11be35a1SLionel Sambuc lua_State*
c_state(void)73*11be35a1SLionel Sambuc lutok::state_c_gate::c_state(void)
74*11be35a1SLionel Sambuc {
75*11be35a1SLionel Sambuc     return static_cast< lua_State* >(_state.raw_state());
76*11be35a1SLionel Sambuc }
77