Lutok: stack_cleaner.hpp Source File

Lutok 0.6.1 |

Loading...
Searching...
No Matches
stack_cleaner.hpp
Go to the documentation of this file.
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
31
32#if !defined(LUTOK_STACK_CLEANER_HPP)
33#define LUTOK_STACK_CLEANER_HPP
34
35#include <memory>
36
37#include <lutok/state.hpp>
38
39namespace lutok {
40
41
71 class stack_cleaner {
72 struct impl;
73
75 std::unique_ptr< impl > _pimpl;
76
78 stack_cleaner(const stack_cleaner&) = delete;
79
81 stack_cleaner& operator=(const stack_cleaner&) = delete;
82
83public:
84 stack_cleaner(state&);
85 ~stack_cleaner(void);
86
87 void forget(void);
88};
89
90
91} // namespace lutok
92
93#endif // !defined(LUTOK_STACK_CLEANER_HPP)
lutok::stack_cleaner::impl
Internal implementation for lutok::stack_cleaner.
Definition stack_cleaner.cpp:37
lutok::stack_cleaner::operator=
stack_cleaner & operator=(const stack_cleaner &)=delete
Disallow assignment.
lutok::stack_cleaner::forget
void forget(void)
Forgets about any elements currently in the stack.
Definition stack_cleaner.cpp:88
lutok::stack_cleaner::stack_cleaner
stack_cleaner(const stack_cleaner &)=delete
Disallow copies.
lutok::stack_cleaner::_pimpl
std::unique_ptr< impl > _pimpl
Pointer to the shared internal implementation.
Definition stack_cleaner.hpp:75
lutok::stack_cleaner::~stack_cleaner
~stack_cleaner(void)
Pops any values from the stack not known at construction time.
Definition stack_cleaner.cpp:72
lutok::state
A RAII model for the Lua state.
Definition state.hpp:71