comin_keyval_ifc.F90

Go to the documentation of this file.

!> @file comin_keyval_ifc.F90
!! @brief Interfaces for key-value maps based on std::unordered_map.
!
!  @authors 06/2025 :: ICON Community Interface  <icon@dwd.de>
!
!  SPDX-License-Identifier: BSD-3-Clause
!
!  See LICENSES for license information.
!  Where software is supplied by third parties, it is indicated in the
!  headers of the routines.
!
MODULE comin_keyval_ifc
  use, INTRINSIC :: iso_c_binding, only: c_int, c_ptr, c_bool, c_double
 
  PRIVATE
 
  PUBLIC :: comin_keyval_create_c
  PUBLIC :: comin_keyval_delete_c
  PUBLIC :: comin_keyval_query_c
  PUBLIC :: comin_keyval_set_int_c
  PUBLIC :: comin_keyval_get_int_c
  PUBLIC :: comin_keyval_set_double_c
  PUBLIC :: comin_keyval_get_double_c
  PUBLIC :: comin_keyval_set_char_c
  PUBLIC :: comin_keyval_get_char_c
  PUBLIC :: comin_keyval_set_bool_c
  PUBLIC :: comin_keyval_get_bool_c
  PUBLIC :: comin_keyval_iterator_begin_c
  PUBLIC :: comin_keyval_iterator_end_c
  PUBLIC :: comin_keyval_iterator_get_key_c
  PUBLIC :: comin_keyval_iterator_next_c
  PUBLIC :: comin_keyval_iterator_delete_c
  PUBLIC :: comin_keyval_iterator_compare_c
 
  INTERFACE
    SUBROUTINE comin_keyval_create_c(comin_keyval_c) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr) :: comin_keyval_c
    END SUBROUTINE comin_keyval_create_c
 
    SUBROUTINE comin_keyval_delete_c(comin_keyval_c) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: comin_keyval_c
    END SUBROUTINE comin_keyval_delete_c
 
    SUBROUTINE comin_keyval_query_c(ckey, idx, keyval_c) BIND(C)
      IMPORT c_ptr, c_int
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      INTEGER(KIND=c_int), INTENT(out) :: idx
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_query_c
 
    SUBROUTINE comin_keyval_set_int_c(ckey,  val, keyval_c) BIND(C)
      IMPORT c_ptr, c_int
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      INTEGER(KIND=c_int), VALUE, INTENT(in) :: val
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_set_int_c
 
    SUBROUTINE comin_keyval_get_int_c(ckey, val, keyval_c) BIND(C)
      IMPORT c_ptr, c_int
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      INTEGER(KIND=c_int), INTENT(out) :: val
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_get_int_c
 
    SUBROUTINE comin_keyval_set_double_c(ckey,  val, keyval_c) BIND(C)
      IMPORT c_ptr, c_double
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      REAL(KIND=c_double), VALUE, INTENT(in) :: val
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_set_double_c
 
    SUBROUTINE comin_keyval_get_double_c(ckey, val, keyval_c) BIND(C)
      IMPORT c_ptr, c_double
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      REAL(KIND=c_double), INTENT(out) :: val
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_get_double_c
 
    SUBROUTINE comin_keyval_set_char_c(ckey,  cval, keyval_c) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      TYPE(c_ptr), VALUE, INTENT(in) :: cval
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_set_char_c
 
    SUBROUTINE comin_keyval_get_char_c(ckey,  cval, keyval_c) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      TYPE(c_ptr) :: cval
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_get_char_c
 
    SUBROUTINE comin_keyval_set_bool_c(ckey,  val, keyval_c) BIND(C)
      IMPORT c_ptr, c_bool
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      LOGICAL(KIND=c_bool), VALUE, INTENT(in) :: val
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_set_bool_c
 
    SUBROUTINE comin_keyval_get_bool_c(ckey, val, keyval_c) BIND(C)
      IMPORT c_ptr, c_bool
      TYPE(c_ptr), VALUE, INTENT(in) :: ckey
      LOGICAL(KIND=c_bool), INTENT(out) :: val
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
    END SUBROUTINE comin_keyval_get_bool_c
 
    SUBROUTINE comin_keyval_iterator_begin_c(keyval_c, iterator) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
      TYPE(c_ptr) :: iterator
    END SUBROUTINE comin_keyval_iterator_begin_c
 
    SUBROUTINE comin_keyval_iterator_end_c(keyval_c, iterator) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: keyval_c
      TYPE(c_ptr) :: iterator
    END SUBROUTINE comin_keyval_iterator_end_c
 
    FUNCTION comin_keyval_iterator_get_key_c(iterator) RESULT(ckey) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: iterator
      TYPE(c_ptr) :: ckey
    END FUNCTION comin_keyval_iterator_get_key_c
 
    SUBROUTINE comin_keyval_iterator_next_c(iterator) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: iterator
    END SUBROUTINE comin_keyval_iterator_next_c
 
    SUBROUTINE comin_keyval_iterator_delete_c(iterator) BIND(C)
      IMPORT c_ptr
      TYPE(c_ptr), VALUE, INTENT(in) :: iterator
    END SUBROUTINE comin_keyval_iterator_delete_c
 
    FUNCTION comin_keyval_iterator_compare_c(iterator1, iterator2) BIND(C)
      IMPORT c_ptr, c_bool
      TYPE(c_ptr), VALUE, INTENT(in) :: iterator1, iterator2
      LOGICAL(KIND=c_bool) :: comin_keyval_iterator_compare_c
    END FUNCTION comin_keyval_iterator_compare_c
  END INTERFACE
 
END MODULE