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