property.h

Go to the documentation of this file.

/* Copyright (C) 2024 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/>. 
 */
 
#ifndef _property_h_
#define _property_h_
 
#include <das3/defs.h>
#include <das3/units.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct das_prop {
   uint64_t  flags;   // property type, validity, value offset
   das_units units;   // Units, if any
   char      buffer[16];  // A buffer for the property name and value, 
                      // typically over-malloc'ed.
} DasProp;
 
size_t dasprop_memsz(const char* sName, const char* sValue);
 
DasErrCode DasProp_init(
   ubyte* pBuf, size_t uBufSz, const char* sType, ubyte uType, const char* sName, 
   const char* sValue, char cSep, das_units units, int nStandard
);
 
size_t DasProp_size(const DasProp* pProp);
 
#define DasProp_units(P) ((P)->units)
 
#define DasProp_name(P) ((P)->buffer) 
 
/* const char* DasProp_name(const DasProp* pProp); */
 
const char* DasProp_value(const DasProp* pProp);
 
size_t DasProp_escapeSize(const DasProp* pProp);
 
const char* DasProp_xmlValue(const DasProp* pProp, char* sBuf, size_t uLen);
 
/*
/ * Get a sub value for a multivalued property.
 * 
 * If DasProp_isSet() or DasProp_isRange() returns true, then this property
 * has sub values.  
 * 
 * @param pProp The property in question
 * 
 * @param idx The index of the sub property, index 0 should always be defined.
 * 
 * @param sBuf A buffer to receive the value.  
 * 
 * @param nLen The length of the buffer to receive the value. Up to nLen - 1
 *        bytes will be copied in, then a null is appended.  Output should 
 *        always be null terminated even if there wasn't enough room for the
 *        entire sub-value.
 * 
 * @returns The number of bytes needed to store the sub value along with it's
 *        terminating null.  If this is greater then nLen, then the output 
 *        has been truncated.
 * /
bool DasProp_subValue(const DasProp* pProp, int idx, char* sBuf, size_t nLen);
*/
 
char DasProp_sep(const DasProp* pProp);
 
/* Decode an |Hx| property-value separator (possibly a backslash escape: \n \t
 * \r \\‍) to a single byte.  Empty/NULL -> '\0' so callers fall back to guessing.
 * 0x00 is not representable here -- property values are string-typed, so the
 * larger |Pd| packet-separator set (which can carry 0x00) needs its own decoder.
 * Free function (no DasProp receiver), hence the lowercase name (cf dasprop_memsz). */
char dasprop_unescapeSep(const char* sSep);
 
bool DasProp_equal(const DasProp* pOne, const DasProp* pTwo);
 
const char* DasProp_typeStr2(const DasProp* pProp);
 
const char* DasProp_typeStr3(const DasProp* pProp);
 
int DasProp_convertInt(const DasProp* pProp, int64_t* pBuf, size_t uBufLen);
 
int DasProp_convertReal(const DasProp* pProp, double* pBuf, size_t uBufLen);
 
int DasProp_convertBool(const DasProp* pProp, uint8_t* pBuf, size_t uBufLen);
 
int DasProp_convertTt2k(const DasProp* pProp, int64_t* pBuf, size_t uBufLen);
 
int DasProp_convertTime(const DasProp* pProp, uint64_t* pBuf, size_t uBufLen);
 
int DasProp_extractItems(const DasProp* pProp, char** psBuf, size_t uNumStrs, size_t uLenEa);
 
 
ubyte DasProp_type(const DasProp* pProp);
 
void DasProp_invalidate(DasProp* pProp);
 
bool DasProp_isValid(const DasProp* pProp);
 
int DasProp_items(const DasProp* pProp);
 
#define DASPROP_MULTI_MASK  0x00000003 
 
#define DASPROP_VALID_MASK  0x00000003  // If these bits are 0, the property
 
#define DASPROP_INVALID     0x00000000  //  is invalid, ignore it.
#define DASPROP_SINGLE      0x00000001  
#define DASPROP_RANGE       0x00000002
#define DASPROP_SET         0x00000003
 
#define DASPROP_TYPE_MASK   0x000000F0
 
#define DASPROP_STRING      0x00000010
#define DASPROP_BOOL        0x00000020
#define DASPROP_INT         0x00000030
#define DASPROP_REAL        0x00000040
#define DASPROP_DATETIME    0x00000050
 
#define DASPROP_DAS1        1
#define DASPROP_DAS2        2
#define DASPROP_DAS3        3
 
#define DasProp_isType(P,T) ((P->flags & DASPROP_TYPE_MASK) == T)
 
#define DasProp_isRange(P) ((P->flags & DASPROP_RANGE)==DASPROP_RANGE)
 
#define DasProp_isSet(P) ((P->flags & DASPROP_SET)==DASPROP_SET)
 
#ifdef __cplusplus
}
#endif
 
#endif // _property_h_