Files
hdf5/fortran/src/H5Rff.f90
Quincey Koziol c04b612eb4 [svn-r9801] Purpose:
Bug fix

Description:
    Belatedly chase change of hobj_ref_t in C APIs.

Platforms tested:
    FreeBSD 4.10 (sleipnir) w/backward compatibility turned on
    IRIX64 6.5 (modi4) w/FORTRAN
    h5committest
2005-01-10 17:56:20 -05:00

478 lines
17 KiB
Fortran

! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
! Copyright by the Board of Trustees of the University of Illinois. *
! All rights reserved. *
! *
! This file is part of HDF5. The full HDF5 copyright notice, including *
! terms governing use, modification, and redistribution, is contained in *
! the files COPYING and Copyright.html. COPYING can be found at the root *
! of the source code distribution tree; Copyright.html can be found at the *
! root level of an installed copy of the electronic HDF5 document set and *
! is linked from the top-level documents page. It can also be found at *
! http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
! access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
!
!
! This file contains Fortran90 interfaces for H5R functions.
!
MODULE H5R
USE H5GLOBAL
! If you change the value of these parameters, do not forget to change corresponding
! values in the H5f90.h file.
! INTEGER, PARAMETER :: REF_OBJ_BUF_LEN = 2
! INTEGER, PARAMETER :: REF_REG_BUF_LEN = 3
!
! TYPE hobj_ref_t_f
! INTEGER ref(REF_OBJ_BUF_LEN)
! END TYPE
!
! TYPE hdset_reg_ref_t_f
! INTEGER ref(REF_REG_BUF_LEN)
! END TYPE
!
INTERFACE h5rcreate_f
MODULE PROCEDURE h5rcreate_object_f
MODULE PROCEDURE h5rcreate_region_f
END INTERFACE
INTERFACE h5rdereference_f
MODULE PROCEDURE h5rdereference_object_f
MODULE PROCEDURE h5rdereference_region_f
END INTERFACE
INTERFACE h5rget_region_f
MODULE PROCEDURE h5rget_region_region_f
END INTERFACE
INTERFACE h5rget_object_type_f
MODULE PROCEDURE h5rget_object_type_obj_f
END INTERFACE
CONTAINS
!----------------------------------------------------------------------
! Name: h5rcreate_object_f
!
! Purpose: Creates reference to the object
!
! Inputs:
! loc_id - location identifier
! name - name of the object at the specified location
! Outputs:
! ref - reference to the specified object
! hdferr: - error code
! Success: 0
! Failure: -1
! Optional parameters:
! NONE
!
! Programmer: Elena Pourmal
! August 12, 1999
!
! Modifications: Explicit Fortran interfaces were added for
! called C functions (it is needed for Windows
! port). February 28, 2001
!
! Comment: This is a module procedure for the h5rcreate_f
! subroutine.
!----------------------------------------------------------------------
SUBROUTINE h5rcreate_object_f(loc_id, name, ref, hdferr)
!
!This definition is needed for Windows DLLs
!DEC$if defined(BUILD_HDF5_DLL)
!DEC$attributes dllexport :: h5rcreate_object_f
!DEC$endif
!
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! Location identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object at location specified
! by loc_id identifier
TYPE(hobj_ref_t_f), INTENT(OUT) :: ref ! Object reference
INTEGER, INTENT(OUT) :: hdferr ! Error code
INTEGER :: namelen ! Name length
INTEGER(HADDR_T) :: ref_f ! Local buffer to pass reference
! INTEGER, EXTERNAL :: h5fcreate_object_c
! Interface is needed for MS FORTRAN
!
INTERFACE
INTEGER FUNCTION h5rcreate_object_c(ref_f, loc_id, name, namelen)
USE H5GLOBAL
!DEC$ IF DEFINED(HDF5F90_WINDOWS)
!MS$ATTRIBUTES C,reference,alias:'_H5RCREATE_OBJECT_C':: h5rcreate_object_c
!DEC$ ENDIF
!DEC$ATTRIBUTES reference :: name
INTEGER(HADDR_T) :: ref_f
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER :: namelen
END FUNCTION h5rcreate_object_c
END INTERFACE
namelen = LEN(name)
ref_f = 0
hdferr = h5rcreate_object_c(ref_f, loc_id, name, namelen )
ref%ref = ref_f
END SUBROUTINE h5rcreate_object_f
!----------------------------------------------------------------------
! Name: h5rcreate_region_f
!
! Purpose: Creates r eference to the dataset region
!
! Inputs:
! loc_id - location identifier
! name - name of the dataset at the specified location
! space_id - dataspace identifier that describes selected region
! Outputs:
! ref - reference to the dataset region
! hdferr: - error code
! Success: 0
! Failure: -1
! Optional parameters:
! NONE
!
! Programmer: Elena Pourmal
! August 12, 1999
!
! Modifications: Explicit Fortran interfaces were added for
! called C functions (it is needed for Windows
! port). February 28, 2001
!
! Comment: This is a module procedure for the h5rcreate_f
! subroutine.
!----------------------------------------------------------------------
SUBROUTINE h5rcreate_region_f(loc_id, name, space_id, ref, hdferr)
!
!This definition is needed for Windows DLLs
!DEC$if defined(BUILD_HDF5_DLL)
!DEC$attributes dllexport :: h5rcreate_region_f
!DEC$endif
!
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! Location identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the dataset at location specified
! by loc_id identifier
INTEGER(HID_T), INTENT(IN) :: space_id ! Dataset's dataspace identifier
TYPE(hdset_reg_ref_t_f), INTENT(OUT) :: ref ! Dataset region reference
INTEGER, INTENT(OUT) :: hdferr ! Error code
INTEGER :: namelen ! Name length
INTEGER :: ref_f(REF_REG_BUF_LEN) ! Local buffer to pass reference
! INTEGER, EXTERNAL :: h5fcreate_region_c
! Interface is needed for MS FORTRAN
!
INTERFACE
INTEGER FUNCTION h5rcreate_region_c(ref_f, loc_id, name, namelen, space_id)
USE H5GLOBAL
!DEC$ IF DEFINED(HDF5F90_WINDOWS)
!MS$ATTRIBUTES C,reference,alias:'_H5RCREATE_REGION_C':: h5rcreate_region_c
!DEC$ ENDIF
!DEC$ATTRIBUTES reference :: name
! INTEGER, PARAMETER :: REF_REG_BUF_LEN = 3
INTEGER :: ref_f(REF_REG_BUF_LEN)
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER :: namelen
INTEGER(HID_T), INTENT(IN) :: space_id
END FUNCTION h5rcreate_region_c
END INTERFACE
namelen = LEN(name)
ref_f = 0
hdferr = h5rcreate_region_c(ref_f, loc_id, name, namelen, space_id )
ref%ref = ref_f
END SUBROUTINE h5rcreate_region_f
!----------------------------------------------------------------------
! Name: h5rdereference_object_f
!
! Purpose: Opens the HDF5 object referenced
!
! Inputs:
! dset_id - identifier of the dataset containing
! reference
! ref - reference to open
! Outputs:
! obj_id - object_identifier
! hdferr: - error code
! Success: 0
! Failure: -1
! Optional parameters:
! NONE
!
! Programmer: Elena Pourmal
! August 12, 1999
!
! Modifications: Explicit Fortran interfaces were added for
! called C functions (it is needed for Windows
! port). February 28, 2001
!
! Comment: This is a module procedure for the h5rdereference_f
! subroutine.
!----------------------------------------------------------------------
SUBROUTINE h5rdereference_object_f(dset_id, ref, obj_id, hdferr)
!
!This definition is needed for Windows DLLs
!DEC$if defined(BUILD_HDF5_DLL)
!DEC$attributes dllexport :: h5rdereference_object_f
!DEC$endif
!
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference
INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
INTEGER :: ref_type ! Reference type
INTEGER(HADDR_T) :: ref_f ! Local buffer to pass reference
! INTEGER, EXTERNAL :: h5h5rdereference_object_c
! Interface is needed for MS FORTRAN
!
INTERFACE
INTEGER FUNCTION h5rdereference_object_c(dset_id, ref_f, obj_id)
USE H5GLOBAL
!DEC$ IF DEFINED(HDF5F90_WINDOWS)
!MS$ATTRIBUTES C,reference,alias:'_H5RDEREFERENCE_OBJECT_C':: h5rdereference_object_c
!DEC$ ENDIF
! INTEGER, PARAMETER :: REF_OBJ_BUF_LEN = 2
INTEGER(HID_T), INTENT(IN) :: dset_id
INTEGER(HADDR_T) :: ref_f
INTEGER(HID_T), INTENT(OUT) :: obj_id
END FUNCTION h5rdereference_object_c
END INTERFACE
ref_f = ref%ref
hdferr = h5rdereference_object_c(dset_id, ref_f, obj_id )
END SUBROUTINE h5rdereference_object_f
!----------------------------------------------------------------------
! Name: h5rdereference_region_f
!
! Purpose: Opens the dataset region
!
! Inputs:
! dset_id - identifier of the dataset containing
! reference to teh regions
! ref - reference to open
! Outputs:
! obj_id - dataspace identifier
! hdferr: - error code
! Success: 0
! Failure: -1
! Optional parameters:
! NONE
!
! Programmer: Elena Pourmal
! August 12, 1999
!
! Modifications: Explicit Fortran interfaces were added for
! called C functions (it is needed for Windows
! port). February 28, 2001
!
! Comment: This is a module procedure for the h5rdereference_f
! subroutine.
!----------------------------------------------------------------------
SUBROUTINE h5rdereference_region_f(dset_id, ref, obj_id, hdferr)
!
!This definition is needed for Windows DLLs
!DEC$if defined(BUILD_HDF5_DLL)
!DEC$attributes dllexport :: h5rdereference_region_f
!DEC$endif
!
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Object reference
INTEGER(HID_T), INTENT(OUT) :: obj_id ! Dataspace identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
INTEGER :: ref_type ! Reference type
INTEGER :: ref_f(REF_REG_BUF_LEN) ! Local buffer to pass reference
! INTEGER, EXTERNAL :: h5rdereference_region_c
! Interface is needed for MS FORTRAN
!
INTERFACE
INTEGER FUNCTION h5rdereference_region_c(dset_id, ref_f, obj_id)
USE H5GLOBAL
!DEC$ IF DEFINED(HDF5F90_WINDOWS)
!MS$ATTRIBUTES C,reference,alias:'_H5RDEREFERENCE_REGION_C':: h5rdereference_region_c
!DEC$ ENDIF
INTEGER(HID_T), INTENT(IN) :: dset_id
! INTEGER, PARAMETER :: REF_REG_BUF_LEN = 3
INTEGER :: ref_f(REF_REG_BUF_LEN)
INTEGER(HID_T), INTENT(OUT) :: obj_id
END FUNCTION h5rdereference_region_c
END INTERFACE
ref_type = H5R_DATASET_REGION_F
ref_f = ref%ref
hdferr = h5rdereference_region_c(dset_id, ref_f, obj_id )
END SUBROUTINE h5rdereference_region_f
!----------------------------------------------------------------------
! Name: h5rget_region_region_f
!
! Purpose: Retrieves a dataspace with the specified region selected
!
! Inputs:
! dset_id - identifier of the dataset containing
! reference to the regions
! ref - reference to open
! Outputs:
! space_id - dataspace identifier
! hdferr: - error code
! Success: 0
! Failure: -1
! Optional parameters:
! NONE
!
! Programmer: Elena Pourmal
! August 12, 1999
!
! Modifications: Explicit Fortran interfaces were added for
! called C functions (it is needed for Windows
! port). February 28, 2001
!
! Comment: This is a module procedure for the h5rget_region_f
! subroutine.
!----------------------------------------------------------------------
SUBROUTINE h5rget_region_region_f(dset_id, ref, space_id, hdferr)
!
!This definition is needed for Windows DLLs
!DEC$if defined(BUILD_HDF5_DLL)
!DEC$attributes dllexport :: h5rget_region_region_f
!DEC$endif
!
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Dataset region reference
INTEGER(HID_T), INTENT(OUT) :: space_id ! Space identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
INTEGER :: ref_f(REF_REG_BUF_LEN) ! Local buffer to pass reference
! INTEGER, EXTERNAL :: h5rget_region_region_c
! Interface is needed for MS FORTRAN
!
INTERFACE
INTEGER FUNCTION h5rget_region_region_c(dset_id, ref_f, space_id)
USE H5GLOBAL
!DEC$ IF DEFINED(HDF5F90_WINDOWS)
!MS$ATTRIBUTES C,reference,alias:'_H5RGET_REGION_REGION_C':: h5rget_region_region_c
!DEC$ ENDIF
INTEGER(HID_T), INTENT(IN) :: dset_id
! INTEGER, PARAMETER :: REF_REG_BUF_LEN = 3
INTEGER :: ref_f(REF_REG_BUF_LEN)
INTEGER(HID_T), INTENT(OUT) :: space_id
END FUNCTION h5rget_region_region_c
END INTERFACE
ref_f = ref%ref
hdferr = h5rget_region_region_c(dset_id, ref_f, space_id )
END SUBROUTINE h5rget_region_region_f
!----------------------------------------------------------------------
! Name: h5rget_object_type_obj_f
!
! Purpose: Retrieves the type of object that an object reference points to.
!
! Inputs:
! dset_id - identifier of the dataset containing
! reference to the objects
! ref - reference to open
! Outputs:
! obj_type - object_type, possible values:
! H5G_UNKNOWN_F (-1)
! H5G_LINK_F 0
! H5G_GROUP_F 1
! H5G_DATASET_F 2
! H5G_TYPE_F 3
!
! hdferr: - error code
! Success: 0
! Failure: -1
! Optional parameters:
! NONE
!
! Programmer: Elena Pourmal
! August 12, 1999
!
! Modifications: Explicit Fortran interfaces were added for
! called C functions (it is needed for Windows
! port). February 28, 2001
!
! Comment: This is a module procedure for the h5rget_object_type_f
! subroutine.
!----------------------------------------------------------------------
SUBROUTINE h5rget_object_type_obj_f(dset_id, ref, obj_type, hdferr)
!
!This definition is needed for Windows DLLs
!DEC$if defined(BUILD_HDF5_DLL)
!DEC$attributes dllexport :: h5rget_object_type_obj_f
!DEC$endif
!
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference
INTEGER, INTENT(OUT) :: obj_type ! Object type
! H5G_UNKNOWN_F (-1)
! H5G_LINK_F 0
! H5G_GROUP_F 1
! H5G_DATASET_F 2
! H5G_TYPE_F 3
INTEGER, INTENT(OUT) :: hdferr ! Error code
INTEGER(HADDR_T) :: ref_f ! Local buffer to pass reference
! INTEGER, EXTERNAL :: h5rget_object_type_obj_c
! Interface is needed for MS FORTRAN
!
INTERFACE
INTEGER FUNCTION h5rget_object_type_obj_c(dset_id, ref_f, obj_type)
USE H5GLOBAL
!DEC$ IF DEFINED(HDF5F90_WINDOWS)
!MS$ATTRIBUTES C,reference,alias:'_H5RGET_OBJECT_TYPE_OBJ_C':: h5rget_object_type_obj_c
!DEC$ ENDIF
! INTEGER, PARAMETER :: REF_OBJ_BUF_LEN = 2
INTEGER(HID_T), INTENT(IN) :: dset_id
INTEGER(HADDR_T) :: ref_f
INTEGER, INTENT(OUT) :: obj_type
END FUNCTION h5rget_object_type_obj_c
END INTERFACE
ref_f = ref%ref
hdferr = h5rget_object_type_obj_c(dset_id, ref_f, obj_type )
END SUBROUTINE h5rget_object_type_obj_f
END MODULE H5R