luaEncoderDecoder.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file luaEncoderDecoder.h
//! \ingroup vreUtil
//! \brief Provides type conversion between C++ and Lua
//!
//! This file defines the base encoder and decoder classes for converting between
//! C++ data types and Lua values. It forms the foundation for type-safe data
//! exchange between C++ and Lua within the VREngage system.
 
#pragma once
 
#include "vreUtil/export.h"
 
struct lua_State;
 
namespace makVre
{
class DtLuaObject;
class DtLuaFunction;
 
 
//! \brief Base class for all Lua to C++ decoders
//!
//! This abstract base class defines the interface for all type-specific decoders
//! that convert Lua values to C++ values.
class UTIL_DLL DtBaseDecoder{
   public:
      //! \brief Default constructor
      DtBaseDecoder(){}
 
   //! \brief Virtual destructor
   virtual ~DtBaseDecoder(){}
};
 
//! \brief Type-specific decoder for converting Lua values to C++ values
//! \tparam T The C++ type to convert to
//!
//! This template class defines the interface for type-specific decoders.
//! Specializations of this template implement the actual conversion for each supported type.
template <typename T>
class DtTypeDecoder : public DtBaseDecoder
{
public:
   //! \brief Converts a Lua value to a C++ value
   //! \param state Pointer to the Lua state
   //! \param index Index of the value on the Lua stack
   //! \return The value converted to the specified C++ type
   virtual T get(lua_State* state, int index);
};
 
//! \brief Base class for all C++ to Lua encoders
//!
//! This abstract base class defines the interface for all type-specific encoders
//! that convert C++ values to Lua values.
class UTIL_DLL DtBaseEncoder{
   public:
      //! \brief Default constructor
      DtBaseEncoder(){}
 
   //! \brief Virtual destructor
   virtual ~DtBaseEncoder(){}
};
 
//! \brief Type-specific encoder for converting C++ values to Lua values
//! \tparam T The C++ type to convert from
//!
//! This template class defines the interface for type-specific encoders.
//! Specializations of this template implement the actual conversion for each supported type.
//! The implementation for all these classes is defined in the source file.
template <typename T>
class DtTypeEncoder : public DtBaseEncoder
{
public:
   //! \brief Pushes a C++ value onto the Lua stack
   //! \param state Pointer to the Lua state
   //! \param data The C++ value to push onto the Lua stack
   virtual void push(lua_State* state, const T& data);
};
 
#pragma endregion
} // namespace makVre