odc_c_binding.f90

Go to the documentation of this file.

! (C) Copyright 1996-2012 ECMWF.
! 
! This software is licensed under the terms of the Apache Licence Version 2.0
! which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. 
! In applying this licence, ECMWF does not waive the privileges and immunities 
! granted to it by virtue of its status as an intergovernmental organisation nor
! does it submit to any jurisdiction.
!
 
!------------------------------------------------------------------------------
! ECMWF
!------------------------------------------------------------------------------
!
! MODULE: odc_c_binding
!
!> @author Anne Fouilloux, ECMWF
!
! DESCRIPTION: 
!> Provides Fortran bindings for ODB API
!
! REVISION HISTORY:
! DD Mmm YYYY - Initial Version
! TODO_dd_mmm_yyyy - TODO_describe_appropriate_changes - TODO_name
!------------------------------------------------------------------------------
 
module odc_c_binding
  use iso_c_binding
  use, intrinsic :: iso_c_binding
  implicit none
  integer, parameter :: odb_ignore=0
  integer, parameter :: odb_integer=1
  integer, parameter :: odb_real=2
  integer, parameter :: odb_string=3
  integer, parameter :: odb_bitfield=4
  integer, parameter :: odb_double=5
interface 
 
!> Initialize ODB API. This function must be called before any other function from the ODB API.
   subroutine odb_start() bind(C, name = "odb_start")
   end subroutine
 
!> Counts number of rows in an ODB file.
!>
!> @param[in] filename  name of the file
!> @return number       of rows on file
   function odb_count(filename) bind(C, name="odb_count")
     use, intrinsic                       :: iso_c_binding
     character(kind=C_CHAR),dimension(*)  :: filename
     real(kind=c_double)                  :: odb_count
   end function odb_count
 
   function odb_select_new(config, err) bind(C, name = "odb_select_create")
     use, intrinsic                       :: iso_c_binding
     character(kind=C_CHAR),dimension(*)  :: config
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_select_new
   end function odb_select_new
 
   function odb_select_delete(odb) bind(C, name = "odb_select_destroy")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr),VALUE                    :: odb
     integer(kind=C_INT)                  :: odb_select_delete
   end function odb_select_delete
 
   function odb_read_new(config, err) bind(C, name = "odb_read_create")
     use, intrinsic                       :: iso_c_binding
     character(kind=C_CHAR),dimension(*)  :: config
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_read_new
   end function odb_read_new
 
   function odb_read_delete(odb) bind(C, name = "odb_read_destroy")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr),VALUE                    :: odb
     integer(kind=C_INT)                  :: odb_read_delete
   end function odb_read_delete
 
!> Create new read iterator.
   function odb_read_iterator_new(odb, filename, err) bind(C, name="odb_create_read_iterator")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb
     character(kind=C_CHAR),dimension(*)  :: filename
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_read_iterator_new
   end function odb_read_iterator_new
 
   function odb_read_iterator_delete(odb_iterator) bind(C, name="odb_read_iterator_destroy")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT)                  :: odb_read_iterator_delete
   end function odb_read_iterator_delete
 
   function odb_read_get_no_of_columns(odb_iterator, ncols) bind(C, name="odb_read_iterator_get_no_of_columns")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr),VALUE                    :: odb_iterator
     integer(kind=C_INT)                  :: ncols
     integer(kind=C_INT)                  :: odb_read_get_no_of_columns ! return an error code
   end function odb_read_get_no_of_columns
 
   function odb_read_get_column_type(odb_iterator, n, type) bind(C, name="odb_read_iterator_get_column_type")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT),VALUE            :: n
     integer(kind=C_INT)                  :: type
     integer(kind=C_INT)                  :: odb_read_get_column_type
   end function odb_read_get_column_type
 
   function odb_read_get_column_name(odb_iterator, n, colname, nchar) bind(C, name="odb_read_iterator_get_column_name")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: n
     integer(kind=C_INT)                  :: nchar
     type(c_ptr)                          :: colname
     integer(kind=C_INT)                  :: odb_read_get_column_name
   end function odb_read_get_column_name
 
   function odb_read_get_bitfield(odb_iterator, n, bitfield_names, bitfield_sizes, bitfield_names_size, bitfield_sizes_size) &
   bind(C, name="odb_read_iterator_get_bitfield")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: n
     type(c_ptr)                          :: bitfield_names
     type(c_ptr)                          :: bitfield_sizes
     integer(kind=C_INT)                  :: bitfield_names_size
     integer(kind=C_INT)                  :: bitfield_sizes_size
     integer(kind=C_INT)                  :: odb_read_get_bitfield
   end function odb_read_get_bitfield
 
   function odb_read_get_next_row(odb_iterator, count, data, new_dataset) bind(C, name="odb_read_iterator_get_next_row")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: count
     integer(kind=C_INT)                  :: new_dataset
     real(kind=c_double),dimension(*)     :: data
     integer(kind=C_INT)                  :: odb_read_get_next_row
   end function odb_read_get_next_row
 
! odb_read_iterator_get_missing_value(oda_read_iterator_ptr ri, int index, double* value)
   function odb_read_get_missing_value(odb_iterator, n, v) &
   bind(C, name="odb_read_iterator_get_missing_value")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT),VALUE            :: n
     real(kind=c_double)                  :: v
     integer(kind=C_INT)                  :: odb_read_get_missing_value
   end function odb_read_get_missing_value
 
   function odb_read_get_row_buffer_size_doubles(odb_iterator, sz) &
                     result(cerr) &
                     bind(C, name="odb_read_iterator_get_row_buffer_size_doubles")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int)                  :: sz
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_read_get_column_offset_internal(odb_iterator, n, offset) &
                     result(cerr) &
                     bind(C, name="odb_read_iterator_get_column_offset")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: offset
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_read_get_column_size_doubles(odb_iterator, n, sz) &
                     result(cerr) &
                     bind(C, name="odb_read_iterator_get_column_size_doubles")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: sz
     integer(kind=c_int)                  :: cerr
   end function
 
 
! SELECT ITERATOR
   function odb_select_iterator_new(odb, sql, err) bind(C, name="odb_create_select_iterator")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb
     character(kind=C_CHAR),dimension(*)  :: sql
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_select_iterator_new
   end function odb_select_iterator_new
 
   function odb_select_iterator_new_from_file(odb, sql, filename, err) bind(C, name="odb_create_select_iterator_from_file")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb
     character(kind=C_CHAR),dimension(*)  :: sql, filename
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_select_iterator_new_from_file
   end function odb_select_iterator_new_from_file
 
   function odb_select_iterator_delete(odb_iterator) bind(C, name="odb_select_iterator_destroy")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT)                  :: odb_select_iterator_delete
   end function odb_select_iterator_delete
 
   function odb_select_get_no_of_columns(odb_iterator, ncols) bind(C, name="odb_select_iterator_get_no_of_columns")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr),VALUE                    :: odb_iterator
     integer(kind=C_INT)                  :: ncols
     integer(kind=C_INT)                  :: odb_select_get_no_of_columns ! return an error code
   end function odb_select_get_no_of_columns
 
   function odb_select_get_row_buffer_size_doubles(odb_iterator, sz) &
                     result(cerr) &
                     bind(C, name="odb_select_iterator_get_row_buffer_size_doubles")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int)                  :: sz
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_select_get_column_offset_internal(odb_iterator, n, offset) &
                     result(cerr) &
                     bind(C, name="odb_select_iterator_get_column_offset")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: offset
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_select_get_column_size_doubles(odb_iterator, n, sz) &
                     result(cerr) &
                     bind(C, name="odb_select_iterator_get_column_size_doubles")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: sz
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_select_get_column_type(odb_iterator, n, type) bind(C, name="odb_select_iterator_get_column_type")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT),VALUE            :: n
     integer(kind=C_INT)                  :: type
     integer(kind=C_INT)                  :: odb_select_get_column_type
   end function odb_select_get_column_type
 
   function odb_select_get_column_name(odb_iterator, n, colname, nchar) bind(C, name="odb_select_iterator_get_column_name")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: n
     type(c_ptr)                          :: colname
     integer(kind=C_INT)                  :: nchar
     integer(kind=C_INT)                  :: odb_select_get_column_name
   end function odb_select_get_column_name
 
   function odb_select_get_bitfield(odb_iterator, n, bitfield_names, bitfield_sizes, bitfield_names_size, bitfield_sizes_size) &
   bind(C, name="odb_select_iterator_get_bitfield")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: n
     type(c_ptr)                          :: bitfield_names
     type(c_ptr)                          :: bitfield_sizes
     integer(kind=C_INT)                  :: bitfield_names_size
     integer(kind=C_INT)                  :: bitfield_sizes_size
     integer(kind=C_INT)                  :: odb_select_get_bitfield
   end function odb_select_get_bitfield
 
   function odb_select_get_next_row(odb_iterator, count, data, new_dataset) bind(C, name="odb_select_iterator_get_next_row")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: count
     integer(kind=C_INT)                  :: new_dataset
     real(kind=c_double),dimension(*)     :: data
     integer(kind=C_INT)                  :: odb_select_get_next_row
   end function odb_select_get_next_row
  
! WRITE
   function odb_write_new(config, err) bind(C, name = "odb_writer_create")
     use, intrinsic                       :: iso_c_binding
     character(kind=C_CHAR),dimension(*)  :: config
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_write_new
   end function odb_write_new
 
   function odb_write_delete(odb) bind(C, name = "odb_writer_destroy")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr),VALUE                    :: odb
     integer(kind=C_INT)                  :: odb_write_delete
   end function odb_write_delete
 
! WRITE iterator
   function odb_write_iterator_new(odb, filename, err) bind(C, name="odb_create_write_iterator")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb
     character(kind=C_CHAR),dimension(*)  :: filename
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_write_iterator_new
   end function odb_write_iterator_new
 
   function odb_append_iterator_new(odb, filename, err) bind(C, name="odb_create_append_iterator")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb
     character(kind=C_CHAR),dimension(*)  :: filename
     integer(kind=C_INT)                  :: err
     type(c_ptr)                          :: odb_append_iterator_new
   end function odb_append_iterator_new
 
   function odb_write_iterator_delete(odb_iterator) bind(C, name="odb_write_iterator_destroy")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT)                  :: odb_write_iterator_delete
   end function odb_write_iterator_delete
 
   function odb_write_set_no_of_columns(odb_iterator, ncols) bind(C, name="odb_write_iterator_set_no_of_columns")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr),VALUE                    :: odb_iterator
     integer(kind=C_INT), VALUE           :: ncols
     integer(kind=C_INT)                  :: odb_write_set_no_of_columns ! return an error code
   end function odb_write_set_no_of_columns
 
   function odb_write_set_column(odb_iterator, n, type, colname) bind(C, name="odb_write_iterator_set_column")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT),VALUE            :: n
     integer(kind=C_INT),VALUE            :: type
     character(kind=C_CHAR),dimension(*)  :: colname
     integer(kind=C_INT)                  :: odb_write_set_column
   end function odb_write_set_column
 
   function odb_write_set_bitfield(odb_iterator, n, type, colname, bitfield_names, bitfield_sizes) &
 bind(C, name="odb_write_iterator_set_bitfield")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT),VALUE            :: n
     integer(kind=C_INT),VALUE            :: type
     character(kind=C_CHAR),dimension(*)  :: colname
     character(kind=C_CHAR),dimension(*)  :: bitfield_names, bitfield_sizes
     integer(kind=C_INT)                  :: odb_write_set_bitfield
   end function odb_write_set_bitfield
 
   function odb_write_set_missing_value(odb_iterator, n, v) bind(C, name="odb_write_iterator_set_missing_value")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT),VALUE            :: n
     real(kind=c_double),VALUE            :: v
     integer(kind=C_INT)                  :: odb_write_set_missing_value
   end function odb_write_set_missing_value
 
   function odb_write_set_column_size_doubles(odb_iterator, n, sz) &
                     result(cerr) &
                     bind(C, name="odb_write_iterator_set_column_size_doubles")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int), value           :: sz
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_write_get_row_buffer_size_doubles(odb_iterator, sz) &
                     result(cerr) &
                     bind(C, name="odb_write_iterator_get_row_buffer_size_doubles")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int)                  :: sz
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_write_get_column_offset_internal(odb_iterator, n, offset) &
                     result(cerr) &
                     bind(C, name="odb_write_iterator_get_column_offset")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: offset
     integer(kind=c_int)                  :: cerr
   end function
 
   function odb_write_set_next_row(odb_iterator, data, count) bind(C, name="odb_write_iterator_set_next_row")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT), VALUE           :: count
     real(kind=c_double),dimension(*)     :: data
     integer(kind=C_INT)                  :: odb_write_set_next_row
   end function odb_write_set_next_row
 
   function odb_write_header(odb_iterator) bind(C, name="odb_write_iterator_write_header")
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), VALUE                   :: odb_iterator
     integer(kind=C_INT)                  :: odb_write_header
   end function odb_write_header
 
end interface
 
contains
 
   function odb_read_get_column_offset(odb_iterator, n, offset) result(cerr)
     ! Map between C (0-index) and Fortran (1-index) offsets
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: offset
     integer(kind=c_int)                  :: cerr
     cerr = odb_read_get_column_offset_internal(odb_iterator, n, offset)
     offset = offset + 1
   end function
 
   function odb_select_get_column_offset(odb_iterator, n, offset) result(cerr)
     ! Map between C (0-index) and Fortran (1-index) offsets
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: offset
     integer(kind=c_int)                  :: cerr
     cerr = odb_select_get_column_offset_internal(odb_iterator, n, offset)
     offset = offset + 1
   end function
 
   function odb_write_get_column_offset(odb_iterator, n, offset) result(cerr)
     ! Map between C (0-index) and Fortran (1-index) offsets
     use, intrinsic                       :: iso_c_binding
     type(c_ptr), value                   :: odb_iterator
     integer(kind=c_int), value           :: n
     integer(kind=c_int)                  :: offset
     integer(kind=c_int)                  :: cerr
     cerr = odb_write_get_column_offset_internal(odb_iterator, n, offset)
     offset = offset + 1
   end function
 
end module odc_c_binding