sds_util.h

Go to the documentation of this file.

/*******************************************************************************
*
*  COPYRIGHT (C) 2006 Battelle Memorial Institute.  All Rights Reserved.
*
********************************************************************************
*
*  Author:
*     name:  Brian Ermold
*     phone: (509) 375-2277
*     email: brian.ermold@pnl.gov
*
********************************************************************************
*
*  RCS INFORMATION:
*    $RCSfile: sds_util.h,v $
*    $Revision: 1.7 $
*    $Locker:  $
*    $Date: 2006/08/04 02:21:28 $
*    $State: ds-dsutil-ingest_lib-1.1-0 $
*
*******************************************************************************/

#ifndef SDS_UTIL_H
#define SDS_UTIL_H

#include <stdio.h>
#include <time.h>

/*******************************************************************************
*  Definitions:
*/

#define MAXPATHNAME    512   /* The maximum length of a path name           */
#define MAXPLATNAME    32    /* The maximum length of a platform name       */

#define SHORTSTRLEN    128   /* The maximum length of a short string        */
#define MAXSTRLEN      1024  /* The maximum length of a typical string      */
#define MSLEN          1024  /* The maximum length of a typical string      */
#define LONGSTRLEN     4096  /* The maximum length of a long string         */

#define SUCCESS        1     /* The return value for success                */
#define FAILURE        0     /* The return value for failure                */

#define TRUE           1     /* The true value for boolean operations       */
#define FALSE          0     /* The false value for boolean operations      */

#define DEBUGCHECK     0     /* Used by set_debug to check the debug state  */
#define DEBUGON        1     /* Used by set_debug to turn debugging on      */
#define DEBUGOFF       2     /* Used by set_debug to turn debugging off     */

/* End Definitions */

/*******************************************************************************
*  Prototypes:
*/

void   print_debug(char *file, int line, char* format, ...);
void   print_error(char *file, int line, char* format, ...);

int    set_debug(int state);

int    bin2dec(char *number);

int    check_file(char *file);
int    check_path(char *path);
int    file_copy(char *src_file, char *dest_file);
int    file_move(char *src_file, char *dest_file);

int    get_next_line(FILE *fp, char *buf, int buf_size);
int    get_line_count();

char  *get_collection_home(void);
char  *get_datastream_home(void);
char  *get_hostname(void);
char  *get_log_home(void);

int    namecompare(const void *s1, const void *s2);

int    split(char *str, double *val);

int    days_since1970(int year);
int    days_sinceJan(int month, int year);
int    four_digit_year(int year);
int    get_julian_day(int month, int day, int year);
int    monthnum(char *month);
time_t seconds_since1970(int hourmin, int jday, int year, int seconds);
void   set_date(int jday, int year, int *mon, int *day);
int    validate_time(int hour, int minute, int second);
int    validate_date(int year, int month, int day);

/* End Prototypes */

/*******************************************************************************
*  Macros:
*/
#define get_debug()    set_debug(DEBUGCHECK)

#define ISLEAP(y) (y<1900 \
                   ? (((y+1900) % 4) == 0 && ((y+1900) % 100) != 0 \
                     || ((y+1900) % 400) == 0) \
                   : (((y) % 4) == 0 && ((y) % 100) !=0 || ((y) % 400) == 0))

#define DYSIZE(y) 365 + ISLEAP(y)

/* End Macros */

/*******************************************************************************
*  Macros:  For backward compatability with old shared library calls
*/

#define getdebug()        set_debug(DEBUGCHECK)
#define setdebug(state)   set_debug(state)

/* End Macros */

#endif /* !SDS_UTIL_H */

---