src/util/util.h

Go to the documentation of this file.

#ifndef _UTIL
#define _UTIL

#include <stdio.h>
#include <ctype.h>
#include <math.h>

#if HAVE_UNISTD_H
#  include <unistd.h>
#endif

#if HAVE_SYS_TYPES_H
#  include <sys/types.h>
#endif

#if HAVE_VARARGS_H
#  include <varargs.h>
#endif

#if STDC_HEADERS
#  include <stdlib.h>
#  include <string.h>
#else
#  ifdef HAVE_STRCHR
char * strchr(const char *, int);
int strcmp(const char *, const char *);
#  else
#    define strchr index
#  endif
#  ifdef HAVE_GETENV
char * getenv(const char *);
#  endif
#endif /* STDC_HEADERS */

#if HAVE_ERRNO_H
#  include <errno.h>
#endif

/*
 * Ensure we have reasonable assert() and fail() functions
 */

#if HAVE_ASSERT_H
#  include <assert.h>
#else
#  ifdef NDEBUG
#    define assert(ex) ;
#  else
#    define assert(ex) {\
    if (! (ex)) {\
        (void) fprintf(stderr,\
            "Assertion failed: file %s, line %d\n\"%s\"\n",\
            __FILE__, __LINE__, "ex");\
        (void) fflush(stdout);\
        abort();\
    }\
}
#  endif
#endif

#define fail(why) {\
    (void) fprintf(stderr, "Fatal error: file %s, line %d\n%s\n",\
        __FILE__, __LINE__, why);\
    (void) fflush(stdout);\
    abort();\
}

/*
 * Support for ANSI function prototypes in non-ANSI compilers
 *
 * Usage:
 *   extern int foo ARGS((char *, double))
 */

#ifndef ARGS
#  ifdef __STDC__
#     define ARGS(args) args
#  else
#     define ARGS(args) ()
# endif
#endif

#ifndef NULLARGS
#  ifdef __STDC__
#    define NULLARGS    (void)
#  else
#    define NULLARGS    ()
#  endif
#endif

/*
 * A little support for C++ compilers
 */

#ifdef __cplusplus
#  define EXTERN        extern "C"
#else
#  define EXTERN        extern
#endif

/*
 * Support to define unused varibles
 */
#if defined (__GNUC__)
#if (__GNUC__ >2 || __GNUC_MINOR__ >=7) && !defined(UNUSED)
#define UNUSED __attribute__ ((unused))
#else
#define UNUSED
#endif
#else
#define UNUSED
#endif

/*
 * A neater way to define zero pointers
 *
 * Usage:
 *  int * fred;
 *  fred = NIL(int);
 */

#define NIL(type)               ((type *) 0)

/* #define USE_MM */

#ifdef USE_MM
/*
 *  assumes the memory manager is libmm.a (a deprecated (?) Octtools library)
 *      - allows malloc(0) or realloc(obj, 0)
 *      - catches out of memory (and calls MMout_of_memory())
 *      - catch free(0) and realloc(0, size) in the macros
 */
#  define ALLOC(type, num)      \
    ((type *) malloc(sizeof(type) * (num)))
#  define REALLOC(type, obj, num)       \
    (obj) ? ((type *) realloc((void *) obj, sizeof(type) * (num))) : \
            ((type *) malloc(sizeof(type) * (num)))
#  define FREE(obj)             \
    ((obj) ? (free((void *) (obj)), (obj) = 0) : 0)
#else
/*
 *  enforce strict semantics on the memory allocator
 */
#  define ALLOC(type, num)      \
    ((type *) MMalloc(sizeof(type) * (unsigned long) (num)))
#  define REALLOC(type, obj, num)       \
    ((type *) MMrealloc((void *) (obj), sizeof(type) * (unsigned long) (num)))
#  define FREE(obj)             \
    ((obj) ? (free((void *) (obj)), (obj) = 0) : 0)
#endif

#ifndef TRUE
#  define TRUE 1
#endif

#ifndef FALSE
#  define FALSE 0
#endif

#ifndef ABS
#  define ABS(a)                        ((a) < 0 ? -(a) : (a))
#endif

#ifndef MAX
#  define MAX(a,b)              ((a) > (b) ? (a) : (b))
#endif

#ifndef MIN
#  define MIN(a,b)              ((a) < (b) ? (a) : (b))
#endif

#define ptime()         util_cpu_time()
#define print_time(t)   util_print_time(t)

#ifndef HUGE_VAL
#  ifndef HUGE
#    define HUGE  8.9884656743115790e+307
#  endif
#  define HUGE_VAL HUGE
#endif

#ifndef MAXINT
#  define MAXINT (1 << 30)
#endif

EXTERN void util_print_cpu_stats ARGS((FILE *));
EXTERN long util_cpu_time ARGS((void));
EXTERN long util_cpu_ctime ARGS((void));
EXTERN void util_getopt_reset ARGS((void));
EXTERN int util_getopt ARGS((int, char * const *, char const *));
EXTERN int util_check_file ARGS((char const *, char const *));
EXTERN char *util_path_search ARGS((char const *));
EXTERN char *util_file_search ARGS((char const *, char *, char const *));
EXTERN char *util_print_time ARGS((long));
EXTERN int util_save_image ARGS((char const *, char const *));
EXTERN char *util_strsav ARGS((char const *));
EXTERN char *util_inttostr ARGS((int));
EXTERN char *util_strcat3 ARGS((char const *, char const *, char const *));
EXTERN char *util_strcat4 ARGS((char const *, char const *, char const *, char const *));
EXTERN int util_do_nothing ARGS((void));
EXTERN char *util_tilde_expand ARGS((char const *));
EXTERN char *util_tempnam ARGS((char const *, char const *));
EXTERN FILE *util_tmpfile ARGS((void));
EXTERN void util_srandom ARGS((long));
EXTERN long util_random ARGS((void));
EXTERN unsigned long getSoftDataLimit ARGS((void));
EXTERN void MMout_of_memory ARGS((unsigned long));
EXTERN void *MMalloc ARGS((unsigned long));
EXTERN void *MMrealloc ARGS((void *, unsigned long));
EXTERN void MMfree ARGS((void *));

/*
 * Global variables for util_getopt()
 */

extern int util_optind;
extern char *util_optarg;

/*---------------------------------------------------------------------------*/
/* Function prototypes                                                       */
/*---------------------------------------------------------------------------*/

#endif /* _UTIL */

---