/** \file
 * \brief IM Lua 5 Binding
 *
 * See Copyright Notice in im_lib.h
 */

#ifndef __IMLUA_H
#define __IMLUA_H

#ifdef __cplusplus
extern "C" {
#endif

/** \defgroup imlua IM Lua 5 Binding
 * \par
 * Binding for the Lua 5 scripting language.           \n
 * Lua 5.1 Copyright (C) 1994-2005 Lua.org, PUC-Rio    \n
 * R. Ierusalimschy, L. H. de Figueiredo & W. Celes    \n
 * http://www.lua.org
 * \par
 * The name of the functions were changed because of the namespace "im" and because of the object orientation. \n
 * As a general rule use:
\verbatim
    imXxx  -> im.Xxx
    IM_XXX -> im.XXX
    imFileXXX(ifile,... -> ifile:XXX(...
    imImageXXX(image,... -> image:XXX(...
\endverbatim
 * All the objects are garbage collected by the Lua garbage collector.
 * \par
 * See \ref imlua.h
 * \ingroup util */

#ifdef LUA_NOOBJECT  /* Lua 3 */
void imlua_open(void);
#endif

#ifdef LUA_TNONE  /* Lua 5 */

/** Initializes the Lua binding of the main IM library.  \n
 * Returns 1 (leaves the "im" table on the top of the stack).
 * You must link the application with the "imlua51" library.
 * \ingroup imlua */
int imlua_open(lua_State *L);
int luaopen_imlua(lua_State *L);

/** Pushes an image as a metatable on the stack.
 * \ingroup imlua */
void imlua_pushimage(lua_State *L, imImage* image);

/** Gets an image as a metatable from the stack, checks for correct type.
 * \ingroup imlua */
imImage* imlua_checkimage(lua_State *L, int param);

/** Initializes the Lua binding of the capture library.  \n
 * Returns 1 (leaves the "im" table on the top of the stack).
 * You must link the application with the "imlua_capture51" library.
 * \ingroup imlua */
int imlua_open_capture(lua_State *L);
int luaopen_imlua_capture(lua_State *L);

/** Initializes the Lua binding of the process library.  \n
 * Returns 1 (leaves the "im" table on the top of the stack).
 * You must link the application with the "imlua_process51" library.
 * \ingroup imlua */
int imlua_open_process(lua_State *L);
int luaopen_imlua_process(lua_State *L);

/** Initializes the Lua binding of the fourier transform library.  \n
 * Returns 1 (leaves the "im" table on the top of the stack).
 * You must link the application with the "imlua_fftw51" library.
 * \ingroup imlua */
int imlua_open_fftw(lua_State *L);
int luaopen_imlua_fftw(lua_State *L);


#endif

#ifdef __cplusplus
}
#endif

#endif