util.h

Go to the documentation of this file.

/* Copyright (C) 1997-2017 Larry Granroth <larry-granroth@uiowa.edu> 
 *                         Chris Piker <chris-piker@uiowa.edu>
 *                         Jeremy Faden <jeremy-faden@uiowa.edu>
 *
 * This file is part of libdas2, the Core Das2 C Library.
 *
 * Libdas2 is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * Libdas2 is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with libdas2; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _das_util_h_
#define _das_util_h_

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <limits.h>

/* Get compile time byte order, results in faster code that avoids 
 * runtime checks.  For some newer chips this may not work as the
 * processor can be switched from big endian to little endian at runtime.
 *
 * At the end of the day either HOST_IS_LSB_FIRST will be defined, or it won't.
 * If this macro is defined then the host computer stores the least significant
 * byte of a word in the lowest address, i.e. it's a little endian machine.  If
 * this macro is not defined then the host computer stores the list significant
 * byte of a word in the highest address, i.e. it a big endian machine.
 */
 
#if defined __linux || defined __APPLE__

#if defined __linux
#include <endian.h>
#elif defined __APPLE__
#include <machine/endian.h>
#endif

#if __BYTE_ORDER == __LITTLE_ENDIAN
#define HOST_IS_LSB_FIRST
#else
#undef HOST_IS_LSB_FIRST
#endif

#else /* End Linux Section */

#ifdef __sun

#include <sys/isa_defs.h>
#ifdef _LITTLE_ENDIAN
#define HOST_IS_LSB_FIRST
#else
#undef HOST_IS_LSB_FIRST
#endif

#else

#ifdef WIN32

#define HOST_IS_LSB_FIRST

#else

#error "unknown byte order!"

#endif /* WIN32 */
#endif  /* __sun */
#endif  /* __linux */


#ifdef __cplusplus
extern "C" {
#endif

#define DAS_22_STREAM_VER "2.2"


/* On Solaris systems NAME_MAX is not defined because pathconf() is supposed
 * to be used to get the exact limit by filesystem.  Since all the filesystems
 * in common use today have support 255 characters, let's just define that
 * to be NAME_MAX in the absence of something better.
 */
#ifdef __sun
#ifndef NAME_MAX
#define NAME_MAX 255
#endif
#endif

typedef int DasErrCode;

#define DAS_OKAY 0

#define DASERR_DIS_EXIT  0

#define DASERR_DIS_RET   1

#define DASERR_DIS_ABORT 43

typedef void (*das_log_handler_t)(int nLevel, const char* sMsg, bool bPrnTime);

void das_init(
   const char* sProgName, int nErrDis, int nErrBufSz, int nLevel, 
   das_log_handler_t logfunc
);

DasErrCode das_error_func(
   const char* sFile, const char* sFunc, int nLine, DasErrCode nCode,
   const char* sFmt, ...
);

DasErrCode das_error_func_fixed(
   const char* sFile, const char* sFunc, int nLine, DasErrCode nCode,
   const char* sMsg
);

#define DASERR_NOTIMP  8
#define DASERR_ASSERT  9
#define DASERR_INIT   11
#define DASERR_BUF    12
#define DASERR_UTIL   13
#define DASERR_ENC    14
#define DASERR_UNITS  15
#define DASERR_DESC   16
#define DASERR_PLANE  17
#define DASERR_PKT    18
#define DASERR_STREAM 19
#define DASERR_OOB    20
#define DASERR_IO     22
#define DASERR_DSDF   23
#define DASERR_DFT    24
#define DASERR_LOG    25
#define DASERR_ARRAY  26
#define DASERR_VAR    27
#define DASERR_DIM    28
#define DASERR_DS     29
#define DASERR_BLDR   30
#define DASERR_HTTP   31
#define DASERR_DATUM  32
#define DASERR_VALUE  33
#define DASERR_OP     34
#define DASERR_CRED   35
#define DASERR_NODE   36


#define das_error(nErrCode, ...) \
  das_error_func(__FILE__, __func__, __LINE__, nErrCode, __VA_ARGS__ )


void das_abort_on_error(void);

void das_exit_on_error(void);

void das_return_on_error(void);

int das_error_disposition(void);

void das_print_error(void);

bool das_save_error(int maxmsg);

typedef struct das_error_message {
   int nErr;
   char * message;
   size_t maxmsg;
   char sFile[256];
   char sFunc[64];
   int nLine;
} das_error_msg;


das_error_msg* das_get_error(void);

void das_error_free(das_error_msg* pMsg);

#define das_within(A, B, E) (fabs(A - B) < E ? true : false)

#define DAS_XML_MAXPROPS 400

#define DAS_XML_BUF_LEN 1000000

#define DAS_XML_NODE_NAME_LEN 256

const char* das_lib_version( void );

bool das_assert_valid_id(const char* sId);


void das_store_str(char** psDest, size_t* puLen, const char* sSrc);

char* das_string(const char* fmt, ...);

char* das_strdup(const char* sIn);


char* das_vstring(const char* fmt, va_list ap);



bool das_isdir(const char* path);

bool das_isfile(const char* path);

int das_dirlist(
   const char* sPath, char ppDirList[][256], size_t uMaxDirs, char cType
);

#ifdef __cplusplus
}
#endif

#endif /* _das_util_h_ */