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 /// \file c_gate.hpp 30 /// Provides direct access to the C state of the Lua wrappers. 31 32 #if !defined(LUTOK_C_GATE_HPP) 33 #define LUTOK_C_GATE_HPP 34 35 #include <lua.hpp> 36 37 namespace lutok { 38 39 40 class state; 41 42 43 /// Gateway to the raw C state of Lua. 44 /// 45 /// This class provides a mechanism to muck with the internals of the state 46 /// wrapper class. Client code may wish to do so if Lutok is missing some 47 /// features of the performance of Lutok in a particular situation is not 48 /// reasonable. 49 /// 50 /// \warning The use of this class is discouraged. By using this class, you are 51 /// entering the world of unsafety. Anything you do through the objects exposed 52 /// through this class will not be controlled by RAII patterns not validated in 53 /// any other way, so you can end up corrupting the Lua state and later get 54 /// crashes on otherwise perfectly-valid C++ code. 55 class state_c_gate { 56 /// The C++ state that this class wraps. 57 state& _state; 58 59 public: 60 state_c_gate(state&); 61 ~state_c_gate(void); 62 63 static state connect(lua_State*); 64 65 lua_State* c_state(void); 66 }; 67 68 69 } // namespace lutok 70 71 #endif // !defined(LUTOK_C_GATE_HPP) 72