summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5If.c
blob: 2305550e4b992c3a53fd978fec2af0a15206b82d (plain)
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
/****h* H5If/H5If
 * PURPOSE
 *  This file contains C stubs for H5I Fortran APIs
 *
 * COPYRIGHT
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * 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 COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://www.hdfgroup.org/licenses.               *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 ******
 */
#include "H5f90.h"
#include "H5Eprivate.h"

/****if* H5If/h5iget_type_c
 * NAME
 *  h5iget_type_c
 * PURPOSE
 *  Call H5Iget_type to get the type of an object
 * INPUTS
 *  obj_id - object identifier
 * OUTPUTS
 *  type - object type
 * RETURNS
 *  0 on success, -1 on failure
 * AUTHOR
 *  Xiangyang Su
 *  Thursday, March 24, 2000
 * HISTORY
 *
 * SOURCE
 */
int_f
h5iget_type_c(hid_t_f *obj_id, int_f *type)
/******/
{
    int        ret_value = -1;
    hid_t      c_obj_id;
    H5I_type_t c_type;

    /*
     * Call H5Iget_type function.
     */
    c_obj_id = *obj_id;
    c_type   = H5Iget_type(c_obj_id);
    if (c_type == H5I_BADID)
        return ret_value;
    *type     = (int_f)c_type;
    ret_value = 0;
    return ret_value;
}
/****if* H5If/h5iget_name_c
 * NAME
 *  h5iget_name_c
 * PURPOSE
 *  Call H5Iget_name to get object's name
 * INPUTS
 *  obj_id - object identifier
 *  buf_size - size of the buffer
 * OUTPUTS
 *  buf - buffer to hold the name
 * RETURNS
 *  length of the name on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, March 12, 2003
 * HISTORY
 *
 *  Changed the size of c_buf_size to c_buf_size + 1, which
 *  fixes the problem of truncating the string by 1 if the
 *  exact size of the string (buf_size) is passed in.
 *               M. Scot Breitenfeld, April 21, 2008
 * SOURCE
 */
int_f
h5iget_name_c(hid_t_f *obj_id, _fcd buf, size_t_f *buf_size, size_t_f *name_size)
/******/
{
    int     ret_value = -1;
    hid_t   c_obj_id;
    ssize_t c_size;
    size_t  c_buf_size;
    char   *c_buf = NULL;

    /*
     * Allocate buffer to hold name of an object
     */
    c_buf_size = (size_t)*buf_size + 1;
    c_buf      = (char *)HDmalloc(c_buf_size);
    if (c_buf == NULL)
        return ret_value;

    /*
     * Call H5IAget_name function
     */
    c_obj_id = (hid_t)*obj_id;
    c_size   = H5Iget_name(c_obj_id, c_buf, c_buf_size);
    if (c_size < 0)
        goto DONE;

    /*
     * Convert C name to FORTRAN and place it in the given buffer
     */
    HD5packFstring(c_buf, _fcdtocp(buf), c_buf_size - 1);
    *name_size = (size_t_f)c_size;
    ret_value  = 0;

DONE:
    HDfree(c_buf);
    return ret_value;
}

/****if* H5If/h5iinc_ref_c
 * NAME
 *  h5iinc_ref_c
 * PURPOSE
 *  Call H5Iinc_ref to increment object's reference count
 * INPUTS
 *  obj_id - object identifier
 * OUTPUTS
 *  ref_count - Reference count of ID
 * RETURNS
 *  current reference count on success, -1 on failure
 * AUTHOR
 *  Quincey Koziol
 *  Tuesday, December  9, 2003
 * SOURCE
 */
int_f
h5iinc_ref_c(hid_t_f *obj_id, int_f *ref_count)
/******/
{
    int ret_value;

    /*
     * Call H5Iinc_ref function
     */
    if ((ret_value = H5Iinc_ref(*obj_id)) < 0)
        HGOTO_DONE(FAIL);

    /* Set output & return values */
    *ref_count = ret_value;
    ret_value  = 0;

done:
    return ret_value;
}

/****if* H5If/h5idec_ref_c
 * NAME
 *  h5idec_ref_c
 * PURPOSE
 *  Call H5Idec_ref to decrement object's reference count
 * INPUTS
 *  obj_id - object identifier
 * OUTPUTS
 *  ref_count - Reference count of ID
 * RETURNS
 *  current reference count on success, -1 on failure
 * AUTHOR
 *  Quincey Koziol
 *  Tuesday, December  9, 2003
 * SOURCE
 */
int_f
h5idec_ref_c(hid_t_f *obj_id, int_f *ref_count)
/******/
{
    int ret_value;

    /*
     * Call H5Idec_ref function
     */
    if ((ret_value = H5Idec_ref(*obj_id)) < 0)
        HGOTO_DONE(FAIL);

    /* Set output & return values */
    *ref_count = ret_value;
    ret_value  = 0;

done:
    return ret_value;
}

/****if* H5If/h5iget_ref_c
 * NAME
 *  h5iget_ref_c
 * PURPOSE
 *  Call H5Iget_ref to retrieve object's reference count
 * INPUTS
 *  obj_id - object identifier
 * OUTPUTS
 *  ref_count - Reference count of ID
 * RETURNS
 *  current reference count on success, -1 on failure
 * AUTHOR
 *  Quincey Koziol
 *  Tuesday, December  9, 2003
 *
 * SOURCE
 */
int_f
h5iget_ref_c(hid_t_f *obj_id, int_f *ref_count)
/******/
{
    int ret_value;

    /*
     * Call H5Iget_ref function
     */
    if ((ret_value = H5Iget_ref(*obj_id)) < 0)
        HGOTO_DONE(FAIL);

    /* Set output & return values */
    *ref_count = ret_value;
    ret_value  = 0;

done:
    return ret_value;
}

/****if* H5If/h5iget_file_id_c
 * NAME
 *  h5iget_file_id_c
 * PURPOSE
 *  Call H5Iget_file_id to obtain file identifier from object identifier
 * INPUTS
 *  obj_id - object identifier
 * OUTPUTS
 *  file_id - file identifier
 * RETURNS
 *  0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Tuesday, August 24, 2004
 *
 * SOURCE
 */
int_f
h5iget_file_id_c(hid_t_f *obj_id, hid_t_f *file_id)
/******/
{
    int   ret_value;
    hid_t c_file_id;

    /*
     * Call H5Iget_file_id
     */
    if ((c_file_id = H5Iget_file_id(*obj_id)) < 0)
        HGOTO_DONE(FAIL);

    /* Set output & return values */
    *file_id  = (hid_t_f)c_file_id;
    ret_value = 0;

done:
    return ret_value;
}

/*----------------------------------------------------------------------------
 *  Name:        h5iis_valid_c
 *  Purpose:     Calls H5Iis_valid
 *  Inputs:      obj_id - object identifier
 *  Outputs:     0 = false, 1 = true
 *  Returns:     0 on success, -1 on failure
 *  Programmer:  Elena Pourmal
 *  Tuesday, August 24, 2004
 *  Modifications:
 *---------------------------------------------------------------------------*/
int_f
h5iis_valid_c(hid_t_f *obj_id, int_f *c_valid)
{
    int    ret_value;
    htri_t c_ret_value;

    /*
     * Call H5Iis_valid
     */
    if ((c_ret_value = H5Iis_valid(*obj_id)) < 0)
        HGOTO_DONE(FAIL);

    /* Set output & return values */
    *c_valid  = (int_f)c_ret_value;
    ret_value = 0;

done:
    return ret_value;
}