# aotus / source / aotus_module.f90

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 !> This module provides high level Fortran interfaces to retrieve values from a !! Lua script. !! !! Its central interface is aot_get_val, which is a generic interface that !! allows access to scalars and vectors in global Lua variables as well as !! nested tables. module aotus_module use flu_binding use aot_kinds_module, only: double_k, single_k, long_k use aot_top_module, only: aot_top_get_val, aot_err_handler, & & aoterr_Fatal, aoterr_NonExistent, aoterr_WrongType use aot_table_module, only: aot_get_val use aot_vector_module, only: aot_get_val, aot_top_get_val ! The following module enables an interface for quadruple precision numbers, ! if the compiler supports them. However, you should be aware, that this is ! merely a convenience interface, as the values provided by Lua are only ! double precision. use aot_quadruple_module ! Support for extdouble precision. use aot_extdouble_module implicit none private public :: aot_get_val public :: open_config_file, close_config public :: open_config_chunk ! Entities inherited from aot_top_module, published here to ! allow most functionality by "use aotus_module". public :: aoterr_Fatal, aoterr_NonExistent, aoterr_WrongType public :: aot_err_handler public :: aot_top_get_val ! Inherited from the flu_binding module, publish for convenience. public :: flu_State !> Get a global configuration value from the script. !! !! This provides a convenient direct access to !! global variables from the Lua script. !! The interface is also used for other values than the global ones, and the !! general shape of it looks like !! call aot_{top}_get_val(, , default). !! Where the "outputs" are val and errCode. While "id" is !! at least the Lua context L. For the global variables there has to !! be a key for the identification of the variable. !! !! The errCode returns an error code with various bits set for !! different errors, that might happen while retrieving the variable. !! They can be checked by btest and the different error codes are: !!- aoterr_fatal: Something went irrecoverably wrong !!- aoterr_nonExistent: The requested variable is not set in the Lua script !!- aoterr_wrongType: The requested variable in the Lua script does not meet !! the requested data type !! !! For example a check for a fatal error can be done by !! btest(errCode, aoterr_fatal). !! !! For the access to global variables in the Lua script the interface !! therefore looks like: !! call aot_get_val(val, errCode, L, key, default). !! See for example aotus_module#get_config_real for a more detailed !! description of the parameters. interface aot_get_val module procedure get_config_real module procedure get_config_double module procedure get_config_integer module procedure get_config_long module procedure get_config_string module procedure get_config_logical end interface contains !> Subroutine to load and execute a script from a file. subroutine open_config_file(L, filename, ErrCode, ErrString) type(flu_State) :: L !< Handle to the Lua script !> Name of file to load the Lua code from character(len=*), intent(in) :: filename !> Error code returned by Lua during loading or executing the file. !! !! This optional parameter might be used to react on errors in the calling !! side. If neither ErrCode nor ErrString are given, this subroutine will !! stop the program execution and print the error message from Lua to the !! stdout. integer, intent(out), optional :: ErrCode !> Obtained error description from the Lua stack. !! !! This optional argument holds the Lua error message in case somehting !! went wrong. It can be used to provide some feedback to the user in the !! calling routine. If neither ErrCode nor ErrString are provided, !! open_config() will print the error message and stop program execution. character(len=*), intent(out), optional :: ErrString integer :: err if (.not.flu_isopen(L)) L = fluL_newstate() err = fluL_loadfile(L, filename) call aot_err_handler(L, err, 'Cannot load configuration file:', ErrString, & & ErrCode) if (err == 0) then call fluL_openlibs(L) err = flu_pcall(L, 0, 0, 0) call aot_err_handler(L, err, 'Cannot run configuration file:', & & ErrString, ErrCode) end if end subroutine open_config_file !> Subroutine to load and execute a script given in a string. subroutine open_config_chunk(L, chunk, ErrCode, ErrString) type(flu_State) :: L !< Handle to the Lua script !> String with Lua code to load. character(len=*), intent(in) :: chunk !> Error code returned by Lua during loading or executing the file. !! !! This optional parameter might be used to react on errors in the calling !! side. If neither ErrCode nor ErrString are given, this subroutine will !! stop the program execution and print the error message from Lua to the !! stdout. integer, intent(out), optional :: ErrCode !> Obtained error description from the Lua stack. !! !! This optional argument holds the Lua error message in case somehting !! went wrong. It can be used to provide some feedback to the user in the !! calling routine. If neither ErrCode nor ErrString are provided, !! open_config() will print the error message and stop program execution. character(len=*), intent(out), optional :: ErrString integer :: err if (.not.flu_isopen(L)) L = fluL_newstate() err = fluL_loadstring(L, chunk) call aot_err_handler(L, err, 'Cannot load chunk:', ErrString, ErrCode) if (err == 0) then call fluL_openlibs(L) err = flu_pcall(L, 0, 0, 0) call aot_err_handler(L, err, 'Cannot run chunk:', ErrString, ErrCode) end if end subroutine open_config_chunk !> Close an opened Lua script again. subroutine close_config(L) type(flu_State) :: L !< Handle to the Lua script to close. call flu_close(L) end subroutine close_config subroutine get_config_real(val, ErrCode, L, key, default) type(flu_State) :: L !< Handle for the Lua script to get the value from. character(len=*), intent(in) :: key !< Variable name to look for. !> Value of the Variable in the script real(kind=single_k), intent(out) :: val !> ErrorCode to indicate what kind of problem might have occured. integer, intent(out) :: ErrCode !> Some default value that should be used, if the variable is not set in the !! Lua script. real(kind=single_k), optional, intent(in) :: default call flu_getglobal(L, key) call aot_top_get_val(val, ErrCode, L, default) end subroutine get_config_real subroutine get_config_double(val, ErrCode, L, key, default) type(flu_State) :: L !< Handle for the Lua script to get the value from. character(len=*), intent(in) :: key !< Variable name to look for. !> Value of the Variable in the script real(kind=double_k), intent(out) :: val !> ErrorCode to indicate what kind of problem might have occured. integer, intent(out) :: ErrCode !> Some default value that should be used, if the variable is not set in the !! Lua script. real(kind=double_k), optional, intent(in) :: default call flu_getglobal(L, key) call aot_top_get_val(val, ErrCode, L, default) end subroutine get_config_double subroutine get_config_integer(val, ErrCode, L, key, default) type(flu_State) :: L !< Handle for the Lua script to get the value from. character(len=*), intent(in) :: key !< Variable name to look for. !> Value of the Variable in the script integer, intent(out) :: val !> ErrorCode to indicate what kind of problem might have occured. integer, intent(out) :: ErrCode !> Some default value that should be used, if the variable is not set in the !! Lua script. integer, optional, intent(in) :: default call flu_getglobal(L, key) call aot_top_get_val(val, ErrCode, L, default) end subroutine get_config_integer subroutine get_config_long(val, ErrCode, L, key, default) type(flu_State) :: L !< Handle for the Lua script to get the value from. character(len=*), intent(in) :: key !< Variable name to look for. !> Value of the Variable in the script integer(kind=long_k), intent(out) :: val !> ErrorCode to indicate what kind of problem might have occured. integer, intent(out) :: ErrCode !> Some default value that should be used, if the variable is not set in the !! Lua script. integer(kind=long_k), optional, intent(in) :: default call flu_getglobal(L, key) call aot_top_get_val(val, ErrCode, L, default) end subroutine get_config_long subroutine get_config_logical(val, ErrCode, L, key, default) type(flu_State) :: L !< Handle for the Lua script to get the value from. character(len=*), intent(in) :: key !< Variable name to look for. !> Value of the Variable in the script logical, intent(out) :: val !> ErrorCode to indicate what kind of problem might have occured. integer, intent(out) :: ErrCode !> Some default value that should be used, if the variable is not set in the !! Lua script. logical, optional, intent(in) :: default call flu_getglobal(L, key) call aot_top_get_val(val, ErrCode, L, default) end subroutine get_config_logical subroutine get_config_string(val, ErrCode, L, key, default) type(flu_State) :: L !< Handle for the Lua script to get the value from. character(len=*), intent(in) :: key !< Variable name to look for. !> Value of the Variable in the script character(len=*) :: val !> ErrorCode to indicate what kind of problem might have occured. integer, intent(out) :: ErrCode !> Some default value that should be used, if the variable is not set in the !! Lua script. character(len=*), optional, intent(in) :: default call flu_getglobal(L, key) call aot_top_get_val(val, ErrCode, L, default) end subroutine get_config_string end module aotus_module !> \page Aotus !! !! Aotus stands for *Advanced Options in Tables and Universal Scripting*. !! !! It is a Fortran wrapper for the [Lua](http://www.lua.org/) scripting !! language. !! The aim of this wrapper is to provide flexible configuration files to Fortran !! applications with the full user experience provided by Lua. !! Aotus is also known as the !! [night monkey](http://en.wikipedia.org/wiki/Night_monkey), living in south !! america. !! Thus we saw the name as fitting as it interacts with the moon (Lua, provided !! by the Pontifical Catholic University of Rio de Janeiro in Brazil). !! !! The most prominent data structure in Lua are !! [tables](http://www.lua.org/manual/5.2/manual.html#2), which provide the !! possibility to store complex data structures. !! Thus the configuration is mainly done in global variables in the lua script !! or tables. !! !! Aotus provides several layers, encapsulating the bare !! [Lua C-API](http://www.lua.org/manual/5.2/manual.html#4): !! - Lua_fif: this just provides the !! [ISO_C_Binding](http://www.fortran.bcs.org/2002/interop.htm) !! interface declarations. !! - Flu_binding: this the actural Fortran binding wrapped around Lua_fif, to !! provide a more Fortran like interface. !! Especially the Flu_binding::flu_state type is declared which maintains the !! handle for the !! [Lua state](http://www.lua.org/manual/5.2/manual.html#lua_state). !! - AOT_table_module: provides some convenience functions to work on Lua tables !! in Fortran. !! - AOT_fun_module: provides some convenience functions to work with Lua !! functions in Fortran. !! - Aotus_module: provides the high end level to easily retrieve data from a !! Lua script. !! - On top of those there is an additional AOT_vector_module, which allows the !! concise reading of values into arrays of rank one. !! - Finally there is and additional AOT_out_module, that allows output of !! Fortran values into nested Lua tables. !! !! The library can be compiled by various modern Fortran compilers as described !! in \ref compiler_support "Compiler Support". !! !! An example showing the usage of the library in a Fortran application is given !! in sample/aotus_sample.f90 in the Aotus main directory. !! The corresponding Lua script used as input is given in sample/config.lua. !! !! *Please see also the README.rst.* !! !! *Sources are available at .*