/*-
 * Copyright (c) 2004 - 2011 CTPP Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the CTPP Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      FnListElement.hpp
 *
 * $CTPP$
 */
#ifndef _VM_FN_LIST_ELEMENT_HPP__
#define _VM_FN_LIST_ELEMENT_HPP__ 1

#include "CTPP2VMSyscall.hpp"

/**
  @file FnListElement.hpp
  @brief Virtual machine standard library function, get element of specified data set
*/

namespace CTPP // C++ Template Engine
{

class CDT;
class Logger;

/**
  @class FnListElement VMSTDLibFunctions.hpp <VMSTDLibFunctions.hpp>
  @brief Get element of specified data set
*/
class FnListElement:
  public SyscallHandler
{
	/**
	  @brief A destructor
	*/
	~FnListElement() throw();

private:
	friend class STDLibInitializer;

	// ///////////////////////////////////////////////////////////////

	/**
	  @brief Constructor
	*/
	FnListElement();

	/**
	  @brief Copy constructor
	  @param oRhs - object to copy
	*/
	FnListElement(const FnListElement & oRhs);

	/**
	  @brief Copy operator =
	  @param oRhs - object to copy
	*/
	FnListElement & operator =(const FnListElement & oRhs);

	/**
	  @brief Handler
	  @param aArguments - list of arguments
	  @param iArgNum - number of arguments
	  @param oCDTRetVal - return value
	*/
	INT_32 Handler(CDT            * aArguments,
	               const UINT_32    iArgNum,
	               CDT            & oCDTRetVal,
	               Logger         & oLogger);

	/**
	  @brief Get function name
	*/
	CCHAR_P GetName() const;
};

} // namespace CTPP
#endif // _VM_FN_LIST_ELEMENT_HPP__
// End.
