summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Rf.c
blob: d9f4231a62523020f20164b5374cdd43cf5dcc39 (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
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
/****h* H5Rf/H5Rf
 * PURPOSE
 *   This file contains C stubs for H5R 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 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://hdfgroup.org/HDF5/doc/Copyright.html.  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* H5Rf/h5rcreate_object_c
 * NAME
 *     h5rcreate_object_c
 * PURPOSE
 *     Call H5Rcreate to create a reference to an object
 * INPUTS
 *     loc_id - file or group identifier
 *       name - name of the dataset
 *    namelen - name length
 * OUTPUTS
 *     ref  - reference to the object
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, December 1, 1999
 * SOURCE
*/
int_f
nh5rcreate_object_c(haddr_t_f *ref, hid_t_f *loc_id, _fcd name, int_f *namelen)
/******/
{
     char *c_name = NULL;
     hobj_ref_t ref_c;
     int_f ret_value = 0;

     /*
      * Convert FORTRAN name to C name
      */
     if(NULL == (c_name = (char *)HD5f2cstring(name, (size_t)*namelen)))
         HGOTO_DONE(FAIL)

     /*
      * Call H5Rcreate function.
      */
     if(H5Rcreate(&ref_c, *loc_id, c_name, H5R_OBJECT, -1) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the reference created */
     *ref = (haddr_t_f)ref_c;

done:
     if(c_name)
         HDfree(c_name);
     return ret_value;
} /* nh5rcreate_object_c() */

/****if* H5Rf/h5rcreate_region_c
 * NAME
 *        h5rcreate_region_c
 * PURPOSE
 *     Call H5Rcreate to create a reference to dataset region
 *              region
 * INPUTS
 *      loc_id - file or group identifier
 *              name - name of the dataset
 *              namelen - name length
 *              space_id - dataset space identifier
 * OUTPUTS
 *     ref  - reference to the dataset region
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, December 1, 1999
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rcreate_region_c(int_f *ref, hid_t_f *loc_id, _fcd name, int_f *namelen, hid_t_f *space_id)
/******/
{
     char *c_name = NULL;
     hdset_reg_ref_t ref_c;
     int_f ret_value = 0;

     /*
      * Convert FORTRAN name to C name
      */
     if(NULL == (c_name = (char *)HD5f2cstring(name, (size_t)*namelen)))
         HGOTO_DONE(FAIL)

     /*
      * Call H5Rcreate function.
      */
     if(H5Rcreate(&ref_c, (hid_t)*loc_id, c_name, H5R_DATASET_REGION, (hid_t)*space_id) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the reference created */
     HDmemcpy(ref, &ref_c, H5R_DSET_REG_REF_BUF_SIZE);

done:
     if(c_name)
         HDfree(c_name);
     return ret_value;
} /* end nh5rcreate_region_c() */

/****if* H5Rf/h5rcreate_ptr_c
 * NAME
 *  h5rcreate_ptr_c
 * PURPOSE
 *  Call H5Rcreate to create a reference to dataset region
 * INPUTS
 *  loc_id    - file or group identifier
 *  name      - name of the dataset
 *  namelen   - name length
 *  space_id  - dataset space identifier
 * OUTPUTS
 *  ref       - reference to the dataset region
 * RETURNS
 *  0 on success, -1 on failure
 * AUTHOR
 *  M. Scot Breitenfeld
 *  June 20, 2008
 *
 * SOURCE
*/
int_f
nh5rcreate_ptr_c (void *ref, hid_t_f *loc_id, _fcd name, int_f *namelen, int_f *ref_type, hid_t_f *space_id)
/******/
{
     int ret_value = -1;
     char *c_name;
     size_t c_namelen;

     /*
      * Convert FORTRAN name to C name
      */
     c_namelen = *namelen;
     c_name = (char *)HD5f2cstring(name, c_namelen);
     if (c_name == NULL) return ret_value;

     /*
      * Call H5Rcreate function.
      */
     if(H5Rcreate(ref, (hid_t)*loc_id, c_name, (H5R_type_t)*ref_type, (hid_t)*space_id) >= 0)
       ret_value = 0;

     HDfree(c_name);
     return ret_value;
}

/****if* H5Rf/h5rdereference_region_c
 * NAME
 *        h5rdereference_region_c
 * PURPOSE
 *     Call H5Rdereference to dereference to dataset region
 * INPUTS
 *      dset_id - dataset identifier
 *              ref - reference to the dataset region
 * OUTPUTS
 *     obj_id - dereferenced dataset identifier
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, December 1, 1999
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rdereference_region_c(hid_t_f *dset_id, int_f *ref, hid_t_f *obj_id)
/******/
{
     hdset_reg_ref_t ref_c;
     hid_t c_obj_id;
     int_f ret_value = 0;

     /* Copy the reference to dereference */
     HDmemcpy(&ref_c, ref, H5R_DSET_REG_REF_BUF_SIZE);

     /*
      * Call H5Rdereference function.
      */
     if((c_obj_id = H5Rdereference((hid_t)*dset_id, H5R_DATASET_REGION, &ref_c)) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the object's ID */
     *obj_id = (hid_t_f)c_obj_id;

done:
     return ret_value;
} /* end nh5rdereference_region_c() */

/****if* H5Rf/h5rdereference_object_c
 * NAME
 *        h5rdereference_object_c
 * PURPOSE
 *     Call H5Rdereference to dereference an object
 * INPUTS
 *      dset_id - dataset identifier
 *              ref - reference to an object
 * OUTPUTS
 *     obj_id - dereferenced  object identifier
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, December 1, 1999
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rdereference_object_c(hid_t_f *dset_id, haddr_t_f *ref, hid_t_f *obj_id)
/******/
{
     hid_t c_obj_id;
     hobj_ref_t ref_c = (hobj_ref_t)*ref;
     int_f ret_value = 0;

     /*
      * Call H5Rdereference function.
      */
     if((c_obj_id = H5Rdereference((hid_t)*dset_id, H5R_OBJECT, &ref_c)) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the object's ID */
     *obj_id = (hid_t_f)c_obj_id;

done:
     return ret_value;
} /* end nh5rdereference_object_c() */

/****if* H5Rf/h5rdereference_ptr_c
 * NAME
 *        h5rdereference_ptr_c
 * PURPOSE
 *     Call H5Rdereference
 * INPUTS
 *      obj_id - Valid identifier for the file containing the
 *                       referenced object or any object in that file.
 *             ref_typ - The reference type of ref.
 *                 ref - Object reference
 * OUTPUTS
 *     ref_obj_id - Identifier of referenced object
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  M. Scot Breitenfeld
 *  June 20, 2008
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rdereference_ptr_c (hid_t_f *obj_id, int_f *ref_type, void *ref, hid_t_f *ref_obj_id)
/******/
{
  int ret_value = -1;
  hid_t c_ref_obj_id;

  /*
   * Call H5Rdereference function.
   */
  c_ref_obj_id = H5Rdereference((hid_t)*obj_id, (H5R_type_t)*ref_type, ref);
  if(c_ref_obj_id < 0) return ret_value;
  *ref_obj_id = (hid_t_f)c_ref_obj_id;
  ret_value = 0;
  return ret_value;
}

/****if* H5Rf/h5rget_region_region_object_c
 * NAME
 *  h5rget_region_region_object_c
 * PURPOSE
 *  Call H5Rget_region to dereference dataspace region
 * INPUTS
 *   dset_id - dataset identifier
 *       ref - reference to the dataset region
 * OUTPUTS
 *  space_id - dereferenced  dataset dataspace identifier
 * RETURNS
 *  0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, December 1, 1999
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rget_region_region_c(hid_t_f *dset_id, int_f *ref, hid_t_f *space_id)
/******/
{
     hid_t c_space_id;
     hdset_reg_ref_t ref_c;
     int_f ret_value = 0;

     /* Copy the reference to dereference */
     HDmemcpy(&ref_c, ref, H5R_DSET_REG_REF_BUF_SIZE);

     /*
      * Call H5Rget_region function.
      */
     if((c_space_id = H5Rget_region((hid_t)*dset_id, H5R_DATASET_REGION, &ref_c)) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the dataspace ID */
     *space_id = (hid_t_f)c_space_id;

done:
     return ret_value;
} /* end nh5rget_region_region_c() */

/****if* H5Rf/h5rget_region_ptr_c
 * NAME
 *  h5rget_region_ptr_c
 * PURPOSE
 *  Call H5Rget_region to dereference dataspace region
 * INPUTS
 *   dset_id - dataset identifier
 *       ref - reference to the dataset region
 * OUTPUTS
 *  space_id - dereferenced  dataset dataspace identifier
 * RETURNS
 *  0 on success, -1 on failure
 * AUTHOR
 *  M. Scot Breitenfeld
 *  August 4, 2012
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rget_region_ptr_c(hid_t_f *dset_id, void *ref, hid_t_f *space_id)
/******/
{
     hid_t c_space_id;
     hdset_reg_ref_t ref_c;
     int_f ret_value = 0;

     /*
      * Call H5Rget_region function.
      */
     if((c_space_id = H5Rget_region((hid_t)*dset_id, H5R_DATASET_REGION, ref)) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the dataspace ID */
     *space_id = (hid_t_f)c_space_id;

done:
     return ret_value;
} /* end nh5rget_region_ptr_c() */


/****if* H5Rf/h5rget_object_type_obj_c
 * NAME
 *        h5rget_object_type_obj_c
 * PURPOSE
 *     Call H5Rget_object_type to retrieve the type of the object reference points
 *              to
 * INPUTS
 *      dset_id - dataset identifier
 *              ref - reference to the dataset region
 * OUTPUTS
 *     obj_type - type of dereferenced object
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  Elena Pourmal
 *  Wednesday, December 1, 1999
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rget_object_type_obj_c(hid_t_f *dset_id, haddr_t_f *ref, int_f *obj_type)
/******/
{
     H5O_type_t c_obj_type;
     hobj_ref_t ref_c = (hobj_ref_t)*ref;
     int_f ret_value = 0;

     /*
      * Call H5Rget_object_type function.
      */
     if(H5Rget_obj_type2((hid_t)*dset_id, H5R_OBJECT, &ref_c, &c_obj_type) < 0)
         HGOTO_DONE(FAIL)

     /* Copy the object type */
     *obj_type = (int_f)c_obj_type;

done:
     return ret_value;
} /* end nh5rget_object_type_obj_c() */

/****if* H5Rf/h5rget_name_object_c
 * NAME
 *        h5rget_name_object_c
 * PURPOSE
 *     Call H5Rget_name for an object
 * INPUTS
 *
 *       loc_id - Identifier for the dataset containing the reference or for the group that dataset is in.
 *          ref - An object or dataset region reference.
 *
 * OUTPUTS
 *     name - A name associated with the referenced object or dataset region.
 *              size - The size of the name buffer.
 *
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  M. Scot Breitenfeld
 *  March 31, 2008
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rget_name_object_c(hid_t_f *loc_id, haddr_t_f *ref, _fcd name, size_t_f *name_len, size_t_f *size_default)
/******/
{
     hobj_ref_t ref_c = (hobj_ref_t)*ref;
     ssize_t c_size;
     size_t c_bufsize = (size_t)*name_len + 1;
     char *c_buf = NULL;  /* Buffer to hold C string */
     int_f ret_value = 0;


     /*
      * Allocate buffer to hold name of an attribute
      */
     if(NULL == (c_buf = (char *)HDmalloc(c_bufsize)))
         HGOTO_DONE(FAIL)
        
     /*
      * Call H5Rget_name function.
      */
     if((c_size = H5Rget_name((hid_t)*loc_id, H5R_OBJECT, &ref_c, c_buf, c_bufsize)) < 0)
         HGOTO_DONE(FAIL)

     /*
      * Convert C name to FORTRAN and place it in the given buffer
      */
     HD5packFstring(c_buf, _fcdtocp(name), c_bufsize-1);
     *size_default = (size_t_f)c_size;

done:
     if(c_buf) 
         HDfree(c_buf);
     return ret_value;
} /* end nh5rget_name_object_c() */

/****if* H5Rf/h5rget_name_region_c
 * NAME
 *        h5rget_name_region_c
 * PURPOSE
 *     Call H5Rget_name for a dataset region
 * INPUTS
 *
 *       loc_id - Identifier for the dataset containing the reference or for the group that dataset is in.
 *          ref - An object or dataset region reference.
 *
 * OUTPUTS
 *     name - A name associated with the referenced object or dataset region.
 *              size - The size of the name buffer.
 *
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  M. Scot Breitenfeld
 *  March 31, 2008
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rget_name_region_c(hid_t_f *loc_id, int_f *ref, _fcd name, size_t_f *name_len, size_t_f *size_default)
/******/
{
     hdset_reg_ref_t ref_c;
     ssize_t c_size;
     size_t c_bufsize = (size_t)*name_len + 1;
     char *c_buf = NULL;  /* Buffer to hold C string */
     int_f ret_value = 0;

     /* Copy the reference to query */
     HDmemcpy(&ref_c, ref, H5R_DSET_REG_REF_BUF_SIZE);

     /*
      * Allocate buffer to hold name of an attribute
      */
     if(NULL == (c_buf = (char *)HDmalloc(c_bufsize)))
         HGOTO_DONE(FAIL)

     /*
      * Call H5Rget_name function.
      */
     if((c_size = H5Rget_name((hid_t)*loc_id, H5R_DATASET_REGION, &ref_c, c_buf, c_bufsize)) < 0)
         HGOTO_DONE(FAIL)

     /*
      * Convert C name to FORTRAN and place it in the given buffer
      */
     HD5packFstring(c_buf, _fcdtocp(name), c_bufsize - 1);
     *size_default = (size_t_f)c_size;

done:
     if(c_buf) 
         HDfree(c_buf);
     return ret_value;
}

/****if* H5Rf/h5rget_name_ptr_c
 * NAME
 *        h5rget_name_ptr_c
 * PURPOSE
 *     Call H5Rget_name
 * INPUTS
 *
 *       loc_id - Identifier for the dataset containing the reference or for the group that dataset is in.
 *     ref_type - Type of reference.
 *          ref - An object or dataset region reference.
 *
 * OUTPUTS
 *     name - A name associated with the referenced object or dataset region.
 *     size - The size of the name buffer.
 *
 * RETURNS
 *     0 on success, -1 on failure
 * AUTHOR
 *  M. Scot Breitenfeld
 *  June 20, 2008
 * HISTORY
 *
 * SOURCE
*/
int_f
nh5rget_name_ptr_c (hid_t_f *loc_id, int_f *ref_type, void *ref, _fcd name, size_t_f *name_len, size_t_f *size_default)
/******/
{
     int_f ret_value = -1;
     ssize_t c_size;
     size_t c_bufsize;
     char *c_buf= NULL;  /* Buffer to hold C string */

     c_bufsize = (size_t)*name_len+1;
     /*
      * Allocate buffer to hold name of an attribute
      */
     if ((c_buf = HDmalloc(c_bufsize)) == NULL)
       return ret_value;

     /*
      * Call H5Rget_name function.
      */
     if((c_size=H5Rget_name((hid_t)*loc_id, (H5R_type_t)*ref_type, ref, c_buf, c_bufsize)) < 0){
       if(c_buf) HDfree(c_buf);
       return ret_value;
     }
     /*
      * Convert C name to FORTRAN and place it in the given buffer
      */
     HD5packFstring(c_buf, _fcdtocp(name), c_bufsize-1);

     *size_default = (size_t_f)c_size;
     ret_value = 0;
     if(c_buf) HDfree(c_buf);

     return ret_value;
}

/****if* H5Rf/h5rget_obj_type_c
 * NAME
 *   h5rget_obj_type_c
 * PURPOSE
 *   Call H5Rget_obj_type
 * INPUTS
 *   loc_id   - Identifier for the dataset containing the reference or
 *              for the group that dataset is in.
 *   ref_type - Type of reference to query.
 *   ref      - Reference to query.
 *
 * OUTPUTS
 *   obj_type - Type of referenced object. 
 *                H5G_UNKNOWN_F (-1)
 *                H5G_LINK_F      0
 *                H5G_GROUP_F     1
 *                H5G_DATASET_F   2
 *                H5G_TYPE_F      3
 * RETURNS
 *   0 on success, -1 on failure
 * AUTHOR
 *   M. Scot Breitenfeld
 *   December 17, 2008
 *
 * SOURCE
*/
int_f
nh5rget_obj_type_c (hid_t_f *loc_id, int_f *ref_type, void *ref, int_f *obj_type)
/******/
{
  int_f ret_value = -1;
  H5O_type_t obj_type_c;

  /*
   * Call H5Rget_obj_type function.
   */
  if((H5Rget_obj_type2((hid_t)*loc_id, (H5R_type_t)*ref_type, ref, &obj_type_c)) < 0)
    return ret_value;

  *obj_type = (int_f)obj_type_c;

  ret_value = 0;
  return ret_value;
}