aot_out_module.f90 Source File

Source Code

! Copyright (c) 2012-2014, 2016-2018 Harald Klimach <harald@klimachs.de>
! Copyright (c) 2012 Manuel Hasert <m.hasert@grs-sim.de>
! Copyright (c) 2012 Kartik Jain <k.jain@grs-sim.de>
! Copyright (c) 2012 Simon Zimny <s.zimny@grs-sim.de>
! Copyright (c) 2016 Kannan Masilamani <kannan.masilamani@uni-siegen.de>
!
! Parts of this file were written by Harald Klimach, Manuel Hasert, Kartik Jain
! and Simon Zimny for German Research School of Simulation Sciences.
! Parts of this file were written by Kannan Masilamani and Harald Klimach for
! University of Siegen.
!
! Permission is hereby granted, free of charge, to any person obtaining a copy
! of this software and associated documentation files (the "Software"), to deal
! in the Software without restriction, including without limitation the rights
! to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
! copies of the Software, and to permit persons to whom the Software is
! furnished to do so, subject to the following conditions:
!
! The above copyright notice and this permission notice shall be included in
! all copies or substantial portions of the Software.
!
! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
! IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
! IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
! DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
! OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
! OR OTHER DEALINGS IN THE SOFTWARE.
! **************************************************************************** !

!> A module to produce Lua scripts with nested tables.
!!
!! This module eases the output of readable Lua scripts.
!! It takes care of indentation with nested tables, and provides a concise
!! interface to output Fortran data into Lua tables.
!! Therefore this module is somehow the counter-part to the reading functions,
!! however it is almost completely independent and relies purely on Fortran
!! output methods. Thus this module could stand alone, along with the
!! flu_kinds_module without the Lua library.
module aot_out_module
use flu_kinds_module, only: double_k, single_k, int_k, long_k
use aot_out_general_module, only: aot_out_type, aot_out_open, aot_out_close, &
&                               aot_out_open_table, aot_out_close_table, &
&                               aot_out_breakline, aot_out_toChunk

! Include interfaces for quadruple precision if available.

! Support for extended double precision.
use aot_extdouble_out_module

implicit none

public :: aot_out_type
public :: aot_out_val
public :: aot_out_open
public :: aot_out_close
public :: aot_out_open_table
public :: aot_out_close_table
public :: aot_out_toChunk

!> Put Fortran intrinsic types into the script.
!!
!! Scalar values and one-dimensional arrays are supported.
!! Supported data-types are
!! - integer
!! - integer(kind=long_k)
!! - real
!! - real(kind=double_k)
!! - logical
!! - character(len=*)
!! complex values are not supported, as they are indistinguishable from
!! arrays with two entries on the Lua side.
interface aot_out_val
! scalars
module procedure aot_out_val_int
module procedure aot_out_val_long
module procedure aot_out_val_real
module procedure aot_out_val_double
module procedure aot_out_val_logical
module procedure aot_out_val_string

! arrays
module procedure aot_out_val_arr_int
module procedure aot_out_val_arr_long
module procedure aot_out_val_arr_real
module procedure aot_out_val_arr_double
module procedure aot_out_val_arr_logical
module procedure aot_out_val_arr_string
end interface

private

contains

! *****************************************************************************!
!>  Put integer variables into the Lua script.
!!
!! The value is passed in with val, optionally you can assign a name to it
!! with the vname argument. If it should be put on the same line as the
!! previous entry, you have to set advance_previous=.false.
!------------------------------------------------------------------------
type(aot_out_type), intent(inout)  :: put_conf
character(len=*), optional, intent(in) :: vname
integer(kind=int_k), intent(in) :: val
!------------------------------------------------------------------------
!------------------------------------------------------------------------

if (put_conf%level > 0) then
! Leave the advancing to the next entry in the table.
else
! Not within a table, finalize the global definition with a newline.
end if

if (present(vname)) then
& trim(vname)//" = ", val
else
end if

end subroutine aot_out_val_int
! *****************************************************************************!

! *****************************************************************************!
!>  Put long variables into the Lua script.
!!
!! The value is passed in with val, optionally you can assign a name to it
!! with the vname argument. If it should be put on the same line as the
!! previous entry, you have to set advance_previous=.false.
!------------------------------------------------------------------------
type(aot_out_type), intent(inout)  :: put_conf
character(len=*), optional, intent(in) :: vname
integer(kind=long_k), intent(in) :: val
!------------------------------------------------------------------------
!------------------------------------------------------------------------

if (put_conf%level > 0) then
! Leave the advancing to the next entry in the table.
else
! Not within a table, finalize the global definition with a newline.
end if

if (present(vname)) then
& trim(vname)//" = ", val
else
end if

end subroutine aot_out_val_long
! *****************************************************************************!

! *****************************************************************************!
!>  Put real variables into the Lua script.
!!
!! The value is passed in with val, optionally you can assign a name to it
!! with the vname argument. If it should be put on the same line as the
!! previous entry, you have to set advance_previous=.false.
!------------------------------------------------------------------------
type(aot_out_type), intent(inout)  :: put_conf
character(len=*), optional, intent(in) :: vname
real(kind=single_k), intent(in) :: val
!------------------------------------------------------------------------
!------------------------------------------------------------------------

if (put_conf%level > 0) then
! Leave the advancing to the next entry in the table.
else
! Not within a table, finalize the global definition with a newline.
end if

if (present(vname)) then
& trim(vname)//" = ", val
else
end if

end subroutine aot_out_val_real
! *****************************************************************************!

! *****************************************************************************!
!>  Put double variables into the Lua script.
!!
!! The value is passed in with val, optionally you can assign a name to it
!! with the vname argument. If it should be put on the same line as the
!! previous entry, you have to set advance_previous=.false.
!------------------------------------------------------------------------
type(aot_out_type), intent(inout)  :: put_conf
character(len=*), optional, intent(in) :: vname
real(kind=double_k), intent(in) :: val
!------------------------------------------------------------------------
!------------------------------------------------------------------------

if (put_conf%level > 0) then
! Leave the advancing to the next entry in the table.
else
! Not within a table, finalize the global definition with a newline.
end if

if (present(vname)) then
& trim(vname)//" = ", val
else
end if

end subroutine aot_out_val_double
! *****************************************************************************!

! *****************************************************************************!
!>  Put logical variables into the Lua script.
!!
!! The value is passed in with val, optionally you can assign a name to it
!! with the vname argument. If it should be put on the same line as the
!! previous entry, you have to set advance_previous=.false.
!------------------------------------------------------------------------
type(aot_out_type), intent(inout)  :: put_conf
character(len=*), optional, intent(in) :: vname
logical, intent(in) :: val
!------------------------------------------------------------------------
character(len=5) :: valstring
!------------------------------------------------------------------------

if (put_conf%level > 0) then
! Leave the advancing to the next entry in the table.
else
! Not within a table, finalize the global definition with a newline.
end if

if (val) then
valstring = 'true'
else
valstring = 'false'
end if

if (present(vname)) then
&   trim(vname)//" = "//trim(valstring)
else
end if

end subroutine aot_out_val_logical
! *****************************************************************************!

! *****************************************************************************!
!>  Put string variables into the Lua script.
!!
!! The value is passed in with val, optionally you can assign a name to it
!! with the vname argument. If it should be put on the same line as the
!! previous entry, you have to set advance_previous=.false.
!------------------------------------------------------------------------
type(aot_out_type), intent(inout)  :: put_conf
character(len=*), optional, intent(in) :: vname
character(len=*), intent(in) :: val
!------------------------------------------------------------------------
!------------------------------------------------------------------------

if (put_conf%level > 0) then
! Leave the advancing to the next entry in the table.
else
! Not within a table, finalize the global definition with a newline.
end if

if (present(vname)) then
& trim(vname)//" = '"//trim(val)//"'"
else
&  "'"//trim(val)//"'"
end if

end subroutine aot_out_val_string
! *****************************************************************************!

! *****************************************************************************!
!> This is a vectorized version of the value output.
!!
!! It takes a one-dimensional array and puts it into a table. The parameters
!! have the usual meanings, as in the scalar routines, however and additional
!! argument (max_per_line) allows the specification of the number of elements
!! that might be put onto a single line.
!! The first entry will be placed into the same line as the opening brace, and
!! the closing brace will be put on the same line, as the last entry.
subroutine aot_out_val_arr_int(put_conf, val, vname, advance_previous, &
&                            max_per_line)
!------------------------------------------------------------------------
!> Lua script to write the array into.
type(aot_out_type), intent(inout)  :: put_conf

!> Name for this array
character(len=*), optional, intent(in) :: vname

!> Actual data to write into the script
integer(kind=int_k), intent(in) :: val(:)

!> Flag if this array should be put on the same line as the last entry of
!! the parent table.

!> Maximal number of entries to put into a single line.
!! Defaults to 8.
integer, optional, intent(in) :: max_per_line
!------------------------------------------------------------------------
integer :: i
integer :: nVals
integer :: mpl
logical :: bline
!------------------------------------------------------------------------

if (present(max_per_line)) then
mpl = max_per_line
else
mpl = 8
end if

! Opening the table(subtable for array actually)
call aot_out_open_table(put_conf, vname, &

nVals = size(val)
if (nVals > 0) then
! Always put the first entry on the same line as the opening brace.
call aot_out_val(put_conf, val(1), advance_previous = .false.)

do i=2,nVals
! Output each entry and break the line after mpl entries on a line.
bline = (mod(i-1, mpl) == 0)
call aot_out_val(put_conf, val(i), advance_previous = bline)
end do
end if

! Always put the closing brace on the same line as the last entry.

end subroutine aot_out_val_arr_int
! *****************************************************************************!

! *****************************************************************************!
!> This is a vectorized version of the value output.
!!
!! It takes a one-dimensional array and puts it into a table. The parameters
!! have the usual meanings, as in the scalar routines, however and additional
!! argument (max_per_line) allows the specification of the number of elements
!! that might be put onto a single line.
!! The first entry will be placed into the same line as the opening brace, and
!! the closing brace will be put on the same line, as the last entry.
subroutine aot_out_val_arr_long(put_conf, val, vname, advance_previous, &
&                             max_per_line)
!------------------------------------------------------------------------
!> Lua script to write the array into.
type(aot_out_type), intent(inout)  :: put_conf

!> Name for this array
character(len=*), optional, intent(in) :: vname

!> Actual data to write into the script
integer(kind=long_k), intent(in) :: val(:)

!> Flag if this array should be put on the same line as the last entry of
!! the parent table.

!> Maximal number of entries to put into a single line.
!! Defaults to 8.
integer, optional, intent(in) :: max_per_line
!------------------------------------------------------------------------
integer :: i
integer :: nVals
integer :: mpl
logical :: bline
!------------------------------------------------------------------------

if (present(max_per_line)) then
mpl = max_per_line
else
mpl = 8
end if

! Opening the table(subtable for array actually)
call aot_out_open_table(put_conf, vname, &

nVals = size(val)
if (nVals > 0) then
! Always put the first entry on the same line as the opening brace.
call aot_out_val(put_conf, val(1), advance_previous = .false.)

do i=2,nVals
! Output each entry and break the line after mpl entries on a line.
bline = (mod(i-1, mpl) == 0)
call aot_out_val(put_conf, val(i), advance_previous = bline)
end do
end if

! Always put the closing brace on the same line as the last entry.

end subroutine aot_out_val_arr_long
! *****************************************************************************!

! *****************************************************************************!
!> This is a vectorized version of the value output.
!!
!! It takes a one-dimensional array and puts it into a table. The parameters
!! have the usual meanings, as in the scalar routines, however and additional
!! argument (max_per_line) allows the specification of the number of elements
!! that might be put onto a single line.
!! The first entry will be placed into the same line as the opening brace, and
!! the closing brace will be put on the same line, as the last entry.
subroutine aot_out_val_arr_real(put_conf, val, vname, advance_previous, &
&                             max_per_line)
!------------------------------------------------------------------------
!> Lua script to write the array into.
type(aot_out_type), intent(inout)  :: put_conf

!> Name for this array
character(len=*), optional, intent(in) :: vname

!> Actual data to write into the script
real(kind=single_k), intent(in) :: val(:)

!> Flag if this array should be put on the same line as the last entry of
!! the parent table.

!> Maximal number of entries to put into a single line.
!! Defaults to 5.
integer, optional, intent(in) :: max_per_line
!------------------------------------------------------------------------
integer :: i
integer :: nVals
integer :: mpl
logical :: bline
!------------------------------------------------------------------------

if (present(max_per_line)) then
mpl = max_per_line
else
mpl = 5
end if

! Opening the table(subtable for array actually)
call aot_out_open_table(put_conf, vname, &

nVals = size(val)
if (nVals > 0) then
! Always put the first entry on the same line as the opening brace.
call aot_out_val(put_conf, val(1), advance_previous = .false.)

do i=2,nVals
! Output each entry and break the line after mpl entries on a line.
bline = (mod(i-1, mpl) == 0)
call aot_out_val(put_conf, val(i), advance_previous = bline)
end do
end if

! Always put the closing brace on the same line as the last entry.

end subroutine aot_out_val_arr_real
! *****************************************************************************!

! *****************************************************************************!
!> This is a vectorized version of the value output.
!!
!! It takes a one-dimensional array and puts it into a table. The parameters
!! have the usual meanings, as in the scalar routines, however and additional
!! argument (max_per_line) allows the specification of the number of elements
!! that might be put onto a single line.
!! The first entry will be placed into the same line as the opening brace, and
!! the closing brace will be put on the same line, as the last entry.
subroutine aot_out_val_arr_double(put_conf, val, vname, advance_previous, &
&                               max_per_line)
!------------------------------------------------------------------------
!> Lua script to write the array into.
type(aot_out_type), intent(inout)  :: put_conf

!> Name for this array
character(len=*), optional, intent(in) :: vname

!> Actual data to write into the script
real(kind=double_k), intent(in) :: val(:)

!> Flag if this array should be put on the same line as the last entry of
!! the parent table.

!> Maximal number of entries to put into a single line.
!! Defaults to 3.
integer, optional, intent(in) :: max_per_line
!------------------------------------------------------------------------
integer :: i
integer :: nVals
integer :: mpl
logical :: bline
!------------------------------------------------------------------------

if (present(max_per_line)) then
mpl = max_per_line
else
mpl = 3
end if

! Opening the table(subtable for array actually)
call aot_out_open_table(put_conf, vname, &

nVals = size(val)
if (nVals > 0) then
! Always put the first entry on the same line as the opening brace.
call aot_out_val(put_conf, val(1), advance_previous = .false.)

do i=2,nVals
! Output each entry and break the line after mpl entries on a line.
bline = (mod(i-1, mpl) == 0)
call aot_out_val(put_conf, val(i), advance_previous = bline)
end do
end if

! Always put the closing brace on the same line as the last entry.

end subroutine aot_out_val_arr_double
! *****************************************************************************!

! *****************************************************************************!
!> This is a vectorized version of the value output.
!!
!! It takes a one-dimensional array and puts it into a table. The parameters
!! have the usual meanings, as in the scalar routines, however and additional
!! argument (max_per_line) allows the specification of the number of elements
!! that might be put onto a single line.
!! The first entry will be placed into the same line as the opening brace, and
!! the closing brace will be put on the same line, as the last entry.
subroutine aot_out_val_arr_logical(put_conf, val, vname, advance_previous, &
&                                max_per_line)
!------------------------------------------------------------------------
!> Lua script to write the array into.
type(aot_out_type), intent(inout)  :: put_conf

!> Name for this array
character(len=*), optional, intent(in) :: vname

!> Actual data to write into the script
logical, intent(in) :: val(:)

!> Flag if this array should be put on the same line as the last entry of
!! the parent table.

!> Maximal number of entries to put into a single line.
!! Defaults to 10.
integer, optional, intent(in) :: max_per_line
!------------------------------------------------------------------------
integer :: i
integer :: nVals
integer :: mpl
logical :: bline
!------------------------------------------------------------------------

if (present(max_per_line)) then
mpl = max_per_line
else
mpl = 10
end if

! Opening the table(subtable for array actually)
call aot_out_open_table(put_conf, vname, &

nVals = size(val)
if (nVals > 0) then
! Always put the first entry on the same line as the opening brace.
call aot_out_val(put_conf, val(1), advance_previous = .false.)

do i=2,nVals
! Output each entry and break the line after mpl entries on a line.
bline = (mod(i-1, mpl) == 0)
call aot_out_val(put_conf, val(i), advance_previous = bline)
end do
end if

! Always put the closing brace on the same line as the last entry.

end subroutine aot_out_val_arr_logical
! *****************************************************************************!

! *****************************************************************************!
!> This is a vectorized version of the value output.
!!
!! It takes a one-dimensional array and puts it into a table. The parameters
!! have the usual meanings, as in the scalar routines, however and additional
!! argument (max_per_line) allows the specification of the number of elements
!! that might be put onto a single line.
!! The first entry will be placed into the same line as the opening brace, and
!! the closing brace will be put on the same line, as the last entry.
subroutine aot_out_val_arr_string(put_conf, val, vname, advance_previous, &
&                                max_per_line)
!------------------------------------------------------------------------
!> Lua script to write the array into.
type(aot_out_type), intent(inout)  :: put_conf

!> Name for this array
character(len=*), optional, intent(in) :: vname

!> Actual data to write into the script
character(len=*), intent(in) :: val(:)

!> Flag if this array should be put on the same line as the last entry of
!! the parent table.

!> Maximal number of entries to put into a single line.
!! Defaults to 1.
integer, optional, intent(in) :: max_per_line
!------------------------------------------------------------------------
integer :: i
integer :: nVals
integer :: mpl
logical :: bline
!------------------------------------------------------------------------

if (present(max_per_line)) then
mpl = max_per_line
else
mpl = 1
end if

! Opening the table(subtable for array actually)
call aot_out_open_table(put_conf, vname, &

nVals = size(val)
if (nVals > 0) then
! Always put the first entry on the same line as the opening brace.
call aot_out_val(put_conf, trim(val(1)), advance_previous = .false.)

do i=2,nVals
! Output each entry and break the line after mpl entries on a line.
bline = (mod(i-1, mpl) == 0)
call aot_out_val(put_conf, trim(val(i)), advance_previous = bline)
end do
end if

! Always put the closing brace on the same line as the last entry.