summaryrefslogtreecommitdiffstats
path: root/fortran/src/H5Git.c
blob: b4e41fc7d8d07c4482123f86b526f0099c99eab6 (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
/*-------------------------------------------------------------------------
 * Copyright (C) 1999	National Center for Supercomputing Applications.
 *			All rights reserved.
 *
 *-------------------------------------------------------------------------
 */

#include "hdf5.h"
#include "H5Git.h"
#define FALSE 0

static herr_t count_elems(hid_t loc_id, const char *name, void *opdata);
static herr_t obj_info(hid_t loc_id, const char *name, void *opdata);

typedef struct retval {
	char * name;
	int type;
} retval_t;


/*-------------------------------------------------------------------------
 * Function:	H5Gn_members
 *
 * Purpose:	Return the number of members of a group.  The "members"
 *		are the datasets, groups, and named datatypes in the
 *		group.
 *
 *		This function wraps the H5Ginterate() function in
 *		a completely obvious way, uses the operator
 *		function 'count_members()' below;
 *
 * See also:	H5Giterate()
 *
 *		IN:  hid_t file:  the file id
 *		IN:  char *group_name: the name of the group
 *
 * Errors:
 *
 * Return:	Success:	The object number of members of
 *				the group.
 *
 *		Failure:	FAIL
 *
 * Programmer:	REMcG
 *		Monday, Aug 2, 1999
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
int
H5Gn_members( hid_t loc_id, char *group_name )
{
	int res;
	int nelems = 0;

	res = H5Giterate(loc_id, group_name, NULL, count_elems, (void *)&nelems);
	if (res < 0) {
		return res;
	} else {
		return( nelems );
	}
}



/*-------------------------------------------------------------------------
 * Function:	H5Gget_obj_info_idx
 *
 * Purpose:	Return the name and type of the member of the group
 *		at index 'idx', as defined by the H5Giterator()
 *		function.
 *
 *		This function wraps the H5Ginterate() function in
 *		a completely obvious way, uses the operator
 *		function 'get_objinfo()' below;
 *
 * See also:	H5Giterate()
 *
 *		IN:  hid_t file:  the file id
 *		IN:  char *group_name: the name of the group
 *		IN:  int idx:  the index of the member object (see
 *		               H5Giterate()
 * 		OUT:  char **objname:  the name of the member object 
 * 		OUT:  int *type:  the type of the object (dataset, 
 *			group, or named datatype)
 *
 * Errors:
 *
 * Return:	Success:	The object number of members of
 *				the group.
 *
 *		Failure:	FAIL
 *
 * Programmer:	REMcG
 *		Monday, Aug 2, 1999
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Gget_obj_info_idx( hid_t loc_id, char *group_name, int idx, char **objname, size_t max_objname_len, int *type )
{
	int res;
	retval_t retVal;

	res = H5Giterate(loc_id, group_name, &idx, obj_info, (void *)&retVal);
	if (res < 0) {
		return res;
	}

	/* Only play with the string if it was returned */
	if(retVal.name!=NULL) {
		/* Copy the name to return & truncate if necessary */
		strncpy(*objname,retVal.name,max_objname_len);
		(*objname)[max_objname_len]='\0';

		/* Free the name we strdup'ed in obj_info() */
		free(retVal.name);
   	} /* end if */
	else
	 	*(*objname)='\0';

	*type = retVal.type;
	return 0;
}



/*-------------------------------------------------------------------------
 * Function:	count_elems
 *
 * Purpose:	this is the operator function called by H5Gn_members().
 *
 *		This function is passed to H5Ginterate().
 *
 * See also:	H5Giterate()
 *
 * 		OUT:  'opdata' is returned as an integer with the
 *			number of members in the group.
 *
 * Errors:
 *
 * Return:	Success:	The object number of members of
 *				the group.
 *
 *		Failure:	FAIL
 *
 * Programmer:	REMcG
 *		Monday, Aug 2, 1999
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */

static herr_t 
count_elems(hid_t loc_id, const char *name, void *opdata)
{
	herr_t res;
	H5G_stat_t statbuf;

	res = H5Gget_objinfo(loc_id, name, FALSE, &statbuf);
	if (res < 0) {
		return 1;
	} 
	switch (statbuf.type) {
	case H5G_GROUP: 
		(*(int *)opdata)++;
		 break;
	case H5G_DATASET: 
		(*(int *)opdata)++;
		 break;
	case H5G_TYPE: 
		(*(int *)opdata)++;
		 break;
	default:
		(*(int *)opdata)++; /* ???? count links or no? */
		 break;
	}
	return 0;
 }


/*-------------------------------------------------------------------------
 * Function:	obj_info
 *
 * Purpose:	this is the operator function called by H5Gn_members().
 *
 *		This function is passed to H5Ginterate().
 *
 * See also:	H5Giterate()
 *
 * 		OUT:  'opdata' is returned as a 'recvar_t', containing
 *			the object name and type.
 *
 * Errors:
 *
 * Return:	Success:	The object number of members of
 *				the group.
 *
 *		Failure:	FAIL
 *
 * Programmer:	REMcG
 *		Monday, Aug 2, 1999
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 *			group, or named datatype)
 */
static herr_t 
obj_info(hid_t loc_id, const char *name, void *opdata)
{
	herr_t res;
	H5G_stat_t statbuf;

	res = H5Gget_objinfo(loc_id, name, FALSE, &statbuf);
	if (res < 0) {
		((retval_t *)opdata)->type = 0;
		((retval_t *)opdata)->name = NULL;
		return 1;
	} else {
		((retval_t *)opdata)->type = statbuf.type;
  		((retval_t *)opdata)->name = strdup(name);
		return 1;
	}
 }