mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-11-27 02:10:55 +08:00
a4329aaa47
Code cleanup & speedup Description: Refactor h5dump & related code to be considerably cleaner & faster for files with large #'s of objects. Platforms tested: FreeBS 4.11 (sleipnir) Linux 2.4
122 lines
4.4 KiB
C
122 lines
4.4 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* 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. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* Programmer: Bill Wendling <wendling@ncsa.uiuc.edu>
|
|
* Tuesday, 6. March 2001
|
|
*
|
|
* Purpose: Support functions for the various tools.
|
|
*/
|
|
#ifndef H5TOOLS_UTILS_H__
|
|
#define H5TOOLS_UTILS_H__
|
|
|
|
#include "hdf5.h"
|
|
|
|
/*
|
|
* begin get_option section
|
|
*/
|
|
extern int opt_err; /* getoption prints errors if this is on */
|
|
extern int opt_ind; /* token pointer */
|
|
extern const char *opt_arg; /* flag argument (or value) */
|
|
|
|
enum {
|
|
no_arg = 0, /* doesn't take an argument */
|
|
require_arg, /* requires an argument */
|
|
optional_arg /* argument is optional */
|
|
};
|
|
|
|
/*
|
|
* get_option determines which options are specified on the command line and
|
|
* returns a pointer to any arguments possibly associated with the option in
|
|
* the ``opt_arg'' variable. get_option returns the shortname equivalent of
|
|
* the option. The long options are specified in the following way:
|
|
*
|
|
* struct long_options foo[] = {
|
|
* { "filename", require_arg, 'f' },
|
|
* { "append", no_arg, 'a' },
|
|
* { "width", require_arg, 'w' },
|
|
* { NULL, 0, 0 }
|
|
* };
|
|
*
|
|
* Long named options can have arguments specified as either:
|
|
*
|
|
* ``--param=arg'' or ``--param arg''
|
|
*
|
|
* Short named options can have arguments specified as either:
|
|
*
|
|
* ``-w80'' or ``-w 80''
|
|
*
|
|
* and can have more than one short named option specified at one time:
|
|
*
|
|
* -aw80
|
|
*
|
|
* in which case those options which expect an argument need to come at the
|
|
* end.
|
|
*/
|
|
typedef struct long_options {
|
|
const char *name; /* name of the long option */
|
|
int has_arg; /* whether we should look for an arg */
|
|
char shortval; /* the shortname equivalent of long arg
|
|
* this gets returned from get_option */
|
|
} long_options;
|
|
|
|
extern int get_option(int argc, const char **argv, const char *opt,
|
|
const struct long_options *l_opt);
|
|
/*
|
|
* end get_option section
|
|
*/
|
|
|
|
/*struct taken from the dumper. needed in table struct*/
|
|
typedef struct obj_t {
|
|
haddr_t objno;
|
|
char *objname;
|
|
hbool_t displayed; /* Flag to indicate that the object has been displayed */
|
|
hbool_t recorded; /* Flag for named datatypes to indicate they were found in the group hierarchy */
|
|
} obj_t;
|
|
|
|
/*struct for the tables that the find_objs function uses*/
|
|
typedef struct table_t {
|
|
size_t size;
|
|
size_t nobjs;
|
|
obj_t *objs;
|
|
} table_t;
|
|
|
|
/*this struct stores the information that is passed to the find_objs function*/
|
|
typedef struct find_objs_t {
|
|
char *prefix;
|
|
table_t *group_table;
|
|
table_t *type_table;
|
|
table_t *dset_table;
|
|
} find_objs_t;
|
|
|
|
extern int nCols; /*max number of columns for outputting */
|
|
|
|
/* Definitions of useful routines */
|
|
extern void indentation(int);
|
|
extern void print_version(const char *progname);
|
|
extern void error_msg(const char *progname, const char *fmt, ...);
|
|
extern void warn_msg(const char *progname, const char *fmt, ...);
|
|
extern void free_table(table_t *table);
|
|
#ifdef H5DUMP_DEBUG
|
|
extern void dump_tables(find_objs_t *info)
|
|
#endif /* H5DUMP_DEBUG */
|
|
extern herr_t init_objs(hid_t fid, find_objs_t *info, table_t **group_table,
|
|
table_t **dset_table, table_t **type_table);
|
|
extern obj_t *search_obj(table_t *temp, haddr_t objno);
|
|
#ifndef H5_HAVE_TMPFILE
|
|
extern FILE * tmpfile(void);
|
|
#endif
|
|
|
|
#endif /* H5TOOLS_UTILS_H__ */
|