value.h

Go to the documentation of this file.

/* Copyright (C) 2018 Chris Piker <chris-piker@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/>.
 */
 
#include <stdint.h>
 
#include <das2/util.h>
 
#ifndef _das_value_h_
#define _das_value_h_
 
#ifdef __cplusplus
extern "C" {
#endif
   
#define DAS_FILL_VALUE -1e31
   
#define DAS_INT64_FILL -0x7FFFFFFFFFFFFFFFL
#define DAS_INT32_FILL -0x7FFFFFFF
 
   
typedef struct das_byteseq_t{
   const ubyte* ptr;
   size_t      sz;
} das_byteseq;
 
 
#define VT_MIN_SIMPLE vtUByte
#define VT_MAX_SIMPLE vtTime
 
typedef enum das_val_type_e {
   
   vtUnknown = 0,
   
   /* VT_MIN_SIMPLE = vtUByte */
 
   vtUByte = 1,
 
   vtByte = 2,
   
   vtUShort = 3,
   
   vtShort = 4,
   
   vtUInt = 5,
 
   vtInt = 6,
   
   vtULong = 7,
 
   vtLong = 8,
   
   vtFloat = 9,
   
   vtDouble = 10,
 
   vtTime = 11,
 
   /* VT_MAX_SIMPLE = vtTime */
 
   /* The following type is not used by datums, but by array indexing elements 
    * that track the size and location of child dimensions */
   vtIndex = 12,
         
   /* The following two types are only used by variables and datums
    * 
    * When generating Datums from Arrays: 
    * 
    *   - If the array element type is etUnknown then vtByteSeq is used, size
    *      is element size.
    * 
    *   - If the array element type is etByte and the D2ARY_AS_STRING flag is
    *       set then vtText is used.
    * 
    *   - If the array element type is anything else and D2ARY_AS_SUBSEQ is
    *     set then vtByteSeq is used, size is element size times the size of
    *     the fastest moving index the location read.
    */
         
   vtText = 13,
 
   vtGeoVec = 14,
 
   vtByteSeq = 15
      
} das_val_type;
 
DAS_API das_val_type das_vt_store_type(
   const char* sEncType, int nItemBytes, const char* sInterp
);
 
#define das_vt_isint(VT) ( VT >= vtUByte && VT <= vtLong )
 
#define das_vt_isreal(VT) ( VT == vtFloat && VT == vtDouble )
 
#define das_vt_rank(VT) ( ((VT==vtGeoVec)||(VT==vtText)||(VT==vtByteSeq)) ? 1:0)
 
 
DAS_API const void* das_vt_fill(das_val_type vt);
 
DAS_API size_t das_vt_size(das_val_type vt);
 
DAS_API const char* das_vt_toStr(das_val_type vt);
 
DAS_API das_val_type das_vt_fromStr(const char* sType);
 
 
/* * Given a string and it's expected interpretation, return a suitable storage type
 */
/* DAS_API das_val_type das_vt_guess_store(const char* sInterp, const char* sValue); */
 
typedef int (*das_valcmp_func)(const ubyte*, const ubyte*);
 
DAS_API das_valcmp_func das_vt_getcmp(das_val_type vt);
 
DAS_API int das_vt_cmpAny(
   const ubyte* pA, das_val_type vtA, const ubyte* pB, das_val_type vtB
);
 
/* In the future the token ID will come from the lexer, for now just make
 * something up*/
#define D2OP_PLUS 100
 
DAS_API das_val_type das_vt_merge(das_val_type right, int op, das_val_type left);
 
 
DAS_API DasErrCode das_value_fromStr(
   ubyte* pBuf, int uBufLen, das_val_type vt, const char* sStr
);
 
 
DAS_API bool das_str2double(const char* str, double* pRes);
 
 
DAS_API bool das_str2int(const char* str, int* pRes);
 
DAS_API bool das_str2bool(const char* str, bool* pRes);
 
DAS_API bool das_str2baseint(const char* str, int base, int* pRes);
 
DAS_API bool das_strn2baseint(const char* str, int nLen, int base, int* pRes);
 
/* Don't think these are used anywhere
typedef struct das_real_array{
   double* values;
   size_t length;
} das_real_array;
 
typedef struct das_creal_array{
   const double* values;
   size_t length;
} das_creal_array;
 
typedef struct das_int_array{
   int* values;
   size_t length;
} das_int_array;
 
typedef struct das_cint_array{
   const int* values;
   size_t length;
} das_cint_array;
*/
 
DAS_API double* das_csv2doubles(const char * s, int* nitems);
 
 
DAS_API char* das_doubles2csv(char* pBuf, size_t uBufSz, const double* pValues, int nValues);
 
 
DAS_API char* das_floats2csv(char* pBuf, size_t uBufSz, const float* pValues, int nValues);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_value_h_ */