contrib/lutok/c_gate.cpp

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