aot_top_module Module

Module for interaction with topmost element of the Lua stack.

This is a basic module which provides the fundamental functionality to access the topmost element in the stack of the Lua API. All intrinsic variables except complex numbers can be accessed this way.


Uses

  • module~~aot_top_module~~UsesGraph module~aot_top_module aot_top_module module~aot_err_module aot_err_module module~aot_top_module->module~aot_err_module module~aot_extdouble_top_module aot_extdouble_top_module module~aot_top_module->module~aot_extdouble_top_module module~aot_quadruple_top_module aot_quadruple_top_module module~aot_top_module->module~aot_quadruple_top_module module~flu_binding flu_binding module~aot_top_module->module~flu_binding module~flu_kinds_module flu_kinds_module module~aot_top_module->module~flu_kinds_module module~aot_err_module->module~flu_binding module~aot_extdouble_top_module->module~aot_err_module module~aot_extdouble_top_module->module~flu_binding module~aot_quadruple_top_module->module~aot_err_module module~aot_quadruple_top_module->module~flu_binding module~flu_binding->module~flu_kinds_module iso_c_binding iso_c_binding module~flu_binding->iso_c_binding module~dump_lua_fif_module dump_lua_fif_module module~flu_binding->module~dump_lua_fif_module module~lua_fif lua_fif module~flu_binding->module~lua_fif module~lua_parameters lua_parameters module~flu_binding->module~lua_parameters module~dump_lua_fif_module->iso_c_binding module~lua_fif->iso_c_binding module~lua_fif->module~lua_parameters module~lua_parameters->iso_c_binding

Used by

  • module~~aot_top_module~~UsedByGraph module~aot_top_module aot_top_module module~aot_extdouble_table_module aot_extdouble_table_module module~aot_extdouble_table_module->module~aot_top_module module~aot_table_ops_module aot_table_ops_module module~aot_extdouble_table_module->module~aot_table_ops_module module~aot_extdouble_vector_module aot_extdouble_vector_module module~aot_extdouble_vector_module->module~aot_top_module module~aot_extdouble_vector_module->module~aot_table_ops_module module~aot_fun_module aot_fun_module module~aot_fun_module->module~aot_top_module module~aot_table_module aot_table_module module~aot_fun_module->module~aot_table_module module~aot_extdouble_fun_module aot_extdouble_fun_module module~aot_fun_module->module~aot_extdouble_fun_module module~aot_quadruple_fun_module aot_quadruple_fun_module module~aot_fun_module->module~aot_quadruple_fun_module module~aot_references_module aot_references_module module~aot_fun_module->module~aot_references_module module~aot_quadruple_table_module aot_quadruple_table_module module~aot_quadruple_table_module->module~aot_top_module module~aot_quadruple_table_module->module~aot_table_ops_module module~aot_quadruple_vector_module aot_quadruple_vector_module module~aot_quadruple_vector_module->module~aot_top_module module~aot_quadruple_vector_module->module~aot_table_ops_module module~aot_table_module->module~aot_top_module module~aot_table_module->module~aot_extdouble_table_module module~aot_table_module->module~aot_quadruple_table_module module~aot_table_module->module~aot_table_ops_module module~aot_table_ops_module->module~aot_top_module module~aot_vector_module aot_vector_module module~aot_vector_module->module~aot_top_module module~aot_vector_module->module~aot_extdouble_vector_module module~aot_vector_module->module~aot_quadruple_vector_module module~aot_vector_module->module~aot_table_ops_module module~aotus_module aotus_module module~aotus_module->module~aot_top_module module~aotus_module->module~aot_table_module module~aotus_module->module~aot_vector_module module~aot_extdouble_fun_module->module~aot_table_module module~aot_path_module aot_path_module module~aot_path_module->module~aot_fun_module module~aot_path_module->module~aot_table_module module~aot_path_module->module~aotus_module module~aot_quadruple_fun_module->module~aot_table_module module~aot_references_module->module~aot_table_ops_module

Interfaces

public interface aot_top_get_val

Get the value on top of the Lua API stack

This is the most basic operation to retrieve a value. It is also most flexible in the sense, that it does not matter how the value actually gets on top of the stack by previous Lua operations.

The interface looks like this: call aot_top_get_val(val, errCode, L, default). See for example aot_top_get_real for a more detailed description of the parameters.

aot_top_get_val can not be in the same generic interface as the other aot_get_val routines, as it results in ambiguities of the interfaces.

Note

The retrieved value will be popped from the Lua API stack.

  • private subroutine aot_top_get_real(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as a single precision real.

    Arguments

    Type IntentOptional Attributes Name
    real(kind=single_k), intent(out) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    real(kind=single_k), intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

  • private subroutine aot_top_get_double(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as a double precision real.

    Arguments

    Type IntentOptional Attributes Name
    real(kind=double_k), intent(out) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    real(kind=double_k), intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

  • private subroutine aot_top_get_integer(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as a default integer.

    Arguments

    Type IntentOptional Attributes Name
    integer(kind=int_k), intent(out) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    integer(kind=int_k), intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

  • private subroutine aot_top_get_long(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as a single precision real.

    Arguments

    Type IntentOptional Attributes Name
    integer(kind=long_k), intent(out) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    integer(kind=long_k), intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

  • private subroutine aot_top_get_string(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as a single precision real.

    Arguments

    Type IntentOptional Attributes Name
    character(len=*) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    character(len=*), intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

  • private subroutine aot_top_get_logical(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as a single precision real.

    Arguments

    Type IntentOptional Attributes Name
    logical, intent(out) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    logical, intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

  • private subroutine aot_top_get_userdata(val, ErrCode, L, default)

    Interpret topmost entry on Lua stack as userdata.

    Arguments

    Type IntentOptional Attributes Name
    type(c_ptr), intent(out) :: val

    Value of the Variable in the script
    integer, intent(out) :: ErrCode

    Error code to indicate what kind of problem might have occured.
    type(flu_State) :: L

    Handle to the Lua script
    type(c_ptr), intent(in), optional :: default

    Some default value, that should be used, if the variable is not set in the Lua script.

Subroutines

private subroutine aot_top_get_real(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as a single precision real.

Arguments

Type IntentOptional Attributes Name
real(kind=single_k), intent(out) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
real(kind=single_k), intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.

private subroutine aot_top_get_double(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as a double precision real.

Arguments

Type IntentOptional Attributes Name
real(kind=double_k), intent(out) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
real(kind=double_k), intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.

private subroutine aot_top_get_integer(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as a default integer.

Arguments

Type IntentOptional Attributes Name
integer(kind=int_k), intent(out) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
integer(kind=int_k), intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.

private subroutine aot_top_get_long(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as a single precision real.

Arguments

Type IntentOptional Attributes Name
integer(kind=long_k), intent(out) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
integer(kind=long_k), intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.

private subroutine aot_top_get_logical(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as a single precision real.

Arguments

Type IntentOptional Attributes Name
logical, intent(out) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
logical, intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.

private subroutine aot_top_get_string(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as a single precision real.

Arguments

Type IntentOptional Attributes Name
character(len=*) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
character(len=*), intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.

private subroutine aot_top_get_userdata(val, ErrCode, L, default)

Interpret topmost entry on Lua stack as userdata.

Arguments

Type IntentOptional Attributes Name
type(c_ptr), intent(out) :: val

Value of the Variable in the script
integer, intent(out) :: ErrCode

Error code to indicate what kind of problem might have occured.
type(flu_State) :: L

Handle to the Lua script
type(c_ptr), intent(in), optional :: default

Some default value, that should be used, if the variable is not set in the Lua script.