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