luaStackCleaner.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
#pragma once
 
//! \file luaStackCleaner.h
//! \brief Provides a RAII mechanism for automatically cleaning the Lua stack
 
#include "vreUtil/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief A utility class for automatically cleaning the Lua stack
//!
//! The DtLuaStackCleaner class implements the RAII (Resource Acquisition Is Initialization)
//! pattern for managing the Lua stack. It saves the current stack top on construction
//! and restores it on destruction, ensuring the stack is properly cleaned up
//! after operations that might modify it.
//!
//! This is particularly useful for operations that push values onto the stack
//! but need to ensure the stack returns to its original state, even in the
//! presence of exceptions.
class UTIL_DLL DtLuaStackCleaner
{
public:
   //! \brief Constructor
   //!
   //! Records the current top of the Lua stack to restore it later.
   //!
   //! \param vm Reference to the Lua state
   DtLuaStackCleaner(lua_State& vm);
 
   //! \brief Destructor
   //!
   //! Restores the Lua stack to the position it was at when the cleaner was constructed
   ~DtLuaStackCleaner();
 
protected:
   //! \brief Reference to the Lua state being managed
   lua_State& myState;
 
   //! \brief The original top position of the stack
   int myTop;
};
} // namespace makVre