util.h

Go to the documentation of this file.

/* Copyright (C) 1997-2020 Chris Piker <chris-piker@uiowa.edu>
 *                         Larry Granroth <larry-granroth@uiowa.edu> 
 *                         Jeremy Faden <jeremy-faden@uiowa.edu>
 *
 * This file is part of das2C, the Core Das2 C Library.
 *
 * Das2C 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.
 *
 * Das2C 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 das2C; if not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef _das_util_h_
#define _das_util_h_
 
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <sys/stat.h>
#include <sys/types.h>
 
#include <das3/defs.h>
 
#define DASERR_DIS_EXIT  0
 
#define DASERR_DIS_RET   1
 
#define DASERR_DIS_ABORT 43
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*das_log_handler_t)(int nLevel, const char* sMsg, bool bPrnTime);
 
DAS_API void das_init(
   const char* sProgName, int nErrDis, int nErrBufSz, int nLevel, 
   das_log_handler_t logfunc
);
 
DAS_API const char* das_version(void);
 
DAS_API void das_finish(void);
 
DAS_API DasErrCode das_error_func(
   const char* sFile, const char* sFunc, int nLine, DasErrCode nCode,
   const char* sFmt, ...
) _das_fmt_check(5, 6);
 
DAS_API DasErrCode das_error_func_fixed(
   const char* sFile, const char* sFunc, int nLine, DasErrCode nCode,
   const char* sMsg
);
 
#define das_error(nErrCode, ...) \
  das_error_func(__FILE__, __func__, __LINE__, nErrCode, __VA_ARGS__ )
 
#define das_error_str(nErrCode, sMsg) \
  das_error_func_fixed(__FILE__, __func__, __LINE__, nErrCode, sMsg)
 
#define das_error_false(nErrCode, ...) \
  (das_error_func(__FILE__, __func__, __LINE__, nErrCode, __VA_ARGS__), false)
 
#define das_error_null(nErrCode, ...) \
  (das_error_func(__FILE__, __func__, __LINE__, nErrCode, __VA_ARGS__), NULL)
 
 
DAS_API void das_abort_on_error(void);
 
DAS_API void das_exit_on_error(void);
 
DAS_API void das_return_on_error(void);
 
DAS_API int das_error_disposition(void);
 
DAS_API void das_errdisp_get_lock(void);
 
DAS_API void das_errdisp_release_lock(void);
 
 
 
DAS_API void das_error_setdisp(int nDisp);
 
DAS_API void das_print_error(void);
 
DAS_API 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_API das_error_msg* das_get_error(void);
 
DAS_API void das_error_free(das_error_msg* pMsg);
 
#define das_within(A, B, E) (fabs((A) - (B)) < (E) ? true : false)
 
#define DAS_XML_BUF_LEN 1000000
 
#define DAS_XML_NODE_NAME_LEN 256
 
DAS_API const char* das_lib_version(void);
 
#define DAS_MAX_ID_BUFSZ 64
 
DAS_API bool das_assert_valid_id(const char* sId);
 
 
DAS_API void das_store_str(char** psDest, size_t* puLen, const char* sSrc);
 
DAS_API char* das_string(const char* fmt, ...);
 
DAS_API char* das_strip(char* sLine, char cComment);
 
DAS_API size_t das_tokncpy(char* dest, const char* src, size_t n);
 
 
DAS_API const char* das_xml_escape(char* dest, const char* src, size_t uOutLen);
 
DAS_API char* das_strdup(const char* sIn);
 
DAS_API uint8_t* das_memset(
   uint8_t* pDest, const uint8_t* pSrc, size_t uElemSz, size_t uCount
);
 
 
 
DAS_API char* das_vstring(const char* fmt, va_list ap);
 
 
DAS_API bool das_isdir(const char* path);
 
DAS_API DasErrCode das_mkdirsto(const char* path);
 
 
DAS_API const char* das_userhome(void);
 
#ifdef _WIN32
DAS_API bool das_copyfile(const char* src, const char* dest);
#else
DAS_API bool das_copyfile(const char* src, const char* dest, mode_t mode);
#endif
 
 
DAS_API bool das_isfile(const char* path);
 
DAS_API void das_stdio_binary(FILE* pFile);
 
DAS_API int das_dirlist(
   const char* sPath, char ppDirList[][256], size_t uMaxDirs, char cType
);
 
DAS_API double das_strtod_c(const char *nptr, char **endptr);
 
DAS_API char* das_b64_encode(
   const unsigned char* data, size_t input_length, size_t* output_length
);
 
DAS_API int das_b64_decode_buf(
   const char* data, size_t input_length, unsigned char* out, size_t out_cap,
   size_t* output_length
);
 
DAS_API unsigned char* das_b64_decode(
   const char* data, size_t input_length, size_t* output_length
);
 
DAS_API bool dascmd_isArg(const char* sArg, const char* sShort, const char* sLong, bool* pLong);
 
 
DAS_API bool dascmd_getArgVal(
  char* sDest, size_t uDest, char** argv, int argc, int* pArgIdx, 
  const char* sShort, const char* sLong
);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_util_h_ */