get_table_string_v Subroutine

private subroutine get_table_string_v(val, ErrCode, L, thandle, key, pos, default)

This routine obtains a vectorial quantity with fixed length from a Lua table as a whole.

It is intented to ease the reading of vectors on the Fortran side by capsulating the parsing of the Lua table internally. Components which are not found are filled with the data given in the default vector. For each component an error code will be returned to indicate the success when reading it. If the vector is not defined at all, all components will be indicated as non-existent. Components, which are neither defined in the Lua script, nor in the default will be marked with the aoterr_Fatal flag.

Arguments

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

Vector read from the Lua table.
integer, intent(out) :: ErrCode(:)

Error code describing problems encountered in each of the components. This array has to have the same length as val.
type(flu_State) :: L

Handle to the lua script
integer, intent(in), optional :: thandle

Handle of the parent table
character(len=*), intent(in), optional :: key

Name of the variable (vector) to read.
integer, intent(in), optional :: pos

Position of the (vector) to read.
character(len=*), intent(in), optional :: default(:)

A default vector to use, if no proper definition is found. Components will be filled with the help of this default definition.

Calls

proc~~get_table_string_v~~CallsGraph proc~get_table_string_v get_table_string_v interface~aot_top_get_val~8 aot_top_get_val proc~get_table_string_v->interface~aot_top_get_val~8 proc~aot_type_of aot_type_of proc~get_table_string_v->proc~aot_type_of proc~aot_top_get_extdouble aot_top_get_extdouble interface~aot_top_get_val~8->proc~aot_top_get_extdouble proc~aot_table_push aot_table_push proc~aot_type_of->proc~aot_table_push proc~flu_getglobal flu_getglobal proc~aot_type_of->proc~flu_getglobal proc~flu_type flu_type proc~aot_type_of->proc~flu_type proc~aot_table_push->proc~flu_getglobal proc~aot_table_push->proc~flu_type interface~flu_pushinteger flu_pushinteger proc~aot_table_push->interface~flu_pushinteger proc~flu_getfield flu_getfield proc~aot_table_push->proc~flu_getfield proc~flu_gettable flu_gettable proc~aot_table_push->proc~flu_gettable proc~flu_pop flu_pop proc~aot_table_push->proc~flu_pop proc~flu_pushnil flu_pushnil proc~aot_table_push->proc~flu_pushnil proc~flu_isnoneornil flu_isNoneOrNil proc~aot_top_get_extdouble->proc~flu_isnoneornil proc~flu_isnumber flu_isnumber proc~aot_top_get_extdouble->proc~flu_isnumber proc~aot_top_get_extdouble->proc~flu_pop proc~flu_todouble flu_todouble proc~aot_top_get_extdouble->proc~flu_todouble interface~lua_getglobal lua_getglobal proc~flu_getglobal->interface~lua_getglobal interface~lua_type lua_type proc~flu_type->interface~lua_type proc~flu_pushint flu_pushint interface~flu_pushinteger->proc~flu_pushint proc~flu_pushlong flu_pushlong interface~flu_pushinteger->proc~flu_pushlong interface~lua_getfield lua_getfield proc~flu_getfield->interface~lua_getfield interface~lua_gettable lua_gettable proc~flu_gettable->interface~lua_gettable proc~flu_isnoneornil->interface~lua_type interface~lua_isnumber lua_isNumber proc~flu_isnumber->interface~lua_isnumber interface~lua_settop lua_settop proc~flu_pop->interface~lua_settop interface~lua_pushnil lua_pushnil proc~flu_pushnil->interface~lua_pushnil interface~lua_tonumberx lua_tonumberx proc~flu_todouble->interface~lua_tonumberx interface~lua_pushinteger lua_pushinteger proc~flu_pushint->interface~lua_pushinteger proc~flu_pushlong->interface~lua_pushinteger

Called by

proc~~get_table_string_v~~CalledByGraph proc~get_table_string_v get_table_string_v interface~aot_get_val~6 aot_get_val interface~aot_get_val~6->proc~get_table_string_v interface~aot_table_get_val~6 aot_table_get_val interface~aot_table_get_val~6->proc~get_table_string_v

Source Code

  subroutine get_table_string_v(val, ErrCode, L, thandle, key, &
    &                         pos, default)
    type(flu_State) :: L !! Handle to the lua script
    integer, intent(in), optional :: thandle !! Handle of the parent table

    !> Vector read from the Lua table.
    character(len=*), intent(out) :: val(:)

    !> Error code describing problems encountered in each of the components.
    !! This array has to have the same length as val.
    integer, intent(out) :: ErrCode(:)

    !> Name of the variable (vector) to read.
    character(len=*), intent(in), optional :: key

    !> Position of the (vector) to read.
    integer, intent(in), optional :: pos

    !> A default vector to use, if no proper definition is found.
    !! Components will be filled with the help of this default definition.
    character(len=*), intent(in), optional :: default(:)

    integer :: toptype

    toptype = aot_type_of(L       = L,       &
      &                   thandle = thandle, &
      &                   key     = key,     &
      &                   pos     = pos      )

    if (toptype /= FLU_TNONE) then
      call aot_top_get_val(val, ErrCode, L, default)
    else
      ErrCode = ibSet(0, aoterr_NonExistent)
      ErrCode = ibSet(ErrCode, aoterr_Fatal)
    end if

  end subroutine get_table_string_v