rave_value.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2025 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of RAVE.
 
RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
RAVE 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
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef RAVE_VALUE_H
#define RAVE_VALUE_H
#include "rave_object.h"
#include "raveobject_hashtable.h"
#include <stdarg.h>
 
typedef enum RaveValue_Type {
  RaveValue_Type_Undefined = -1,  
  RaveValue_Type_String = 0,      
  RaveValue_Type_Long = 1,        
  RaveValue_Type_Double = 2,      
  RaveValue_Type_Boolean = 3,     
  RaveValue_Type_Null = 4,        
  RaveValue_Type_Data2D = 5,      
  RaveValue_Type_Hashtable = 6,   
  RaveValue_Type_List = 7
} RaveValue_Type;

typedef struct _RaveValue_t RaveValue_t;

extern RaveCoreObjectType RaveValue_TYPE;

RaveValue_Type RaveValue_type(RaveValue_t* self);

void RaveValue_reset(RaveValue_t* self);

RaveValue_t* RaveValue_createString(const char* value);

RaveValue_t* RaveValue_createStringFmt(const char* fmt, ...);

int RaveValue_setString(RaveValue_t* self, const char* value);

int RaveValue_getString(RaveValue_t* self, char** value);

const char* RaveValue_toString(RaveValue_t* self);

RaveValue_t* RaveValue_createLong(long value);

void RaveValue_setLong(RaveValue_t* self, long value);

int RaveValue_getLong(RaveValue_t* self, long* value);

long RaveValue_toLong(RaveValue_t* self);
 

RaveValue_t* RaveValue_createDouble(double value);

void RaveValue_setDouble(RaveValue_t* self, double value);

int RaveValue_getDouble(RaveValue_t* self, double* value);

double RaveValue_toDouble(RaveValue_t* self);

 RaveValue_t* RaveValue_createBoolean(int value);

 void RaveValue_setBoolean(RaveValue_t* self, int value);
 
 int RaveValue_getBoolean(RaveValue_t* self, int* value);
 
 int RaveValue_toBoolean(RaveValue_t* self);

RaveValue_t* RaveValue_createNull();

void RaveValue_setNull(RaveValue_t* self);

int RaveValue_isNull(RaveValue_t* self);

int RaveValue_isStringArray(RaveValue_t* self);

RaveValue_t* RaveValue_createStringArray(const char** value, int len);

int RaveValue_setStringArray(RaveValue_t* self, const char** value, int len);

int RaveValue_getStringArray(RaveValue_t* self, char*** value, int* len);

 int RaveValue_isLongArray(RaveValue_t* self);

RaveValue_t* RaveValue_createLongArray(long* value, int len);

int RaveValue_setLongArray(RaveValue_t* self, long* value, int len);

int RaveValue_getLongArray(RaveValue_t* self, long** value, int* len);

 int RaveValue_isDoubleArray(RaveValue_t* self);

RaveValue_t* RaveValue_createDoubleArray(double* value, int len);

int RaveValue_setDoubleArray(RaveValue_t* self, double* value, int len);

int RaveValue_getDoubleArray(RaveValue_t* self, double** value, int* len);

RaveValue_t* RaveValue_createHashTable(RaveObjectHashTable_t* hashtable);

int RaveValue_setHashTable(RaveValue_t* self, RaveObjectHashTable_t* table);

int RaveValue_getHashTable(RaveValue_t* self, RaveObjectHashTable_t** table);

RaveObjectHashTable_t* RaveValue_toHashTable(RaveValue_t* self);

int RaveValueHash_put(RaveValue_t* self, const char* key, RaveValue_t* value);

 RaveValue_t* RaveValueHash_get(RaveValue_t* self, const char* key);
 

int RaveValueHash_size(RaveValue_t* self);

int RaveValueHash_exists(RaveValue_t* self, const char* key);

void RaveValueHash_remove(RaveValue_t* self, const char* key);

void RaveValueHash_clear(RaveValue_t* self);

RaveList_t* RaveValueHash_keys(RaveValue_t* self);

RaveValue_t* RaveValue_createList(RaveObjectList_t* rlist);

int RaveValue_setList(RaveValue_t* self, RaveObjectList_t* rlist);
 
int RaveValue_getList(RaveValue_t* self, RaveObjectList_t** rlist);
 
RaveObjectList_t* RaveValue_toList(RaveValue_t* self);

int RaveValueList_add(RaveValue_t* self, RaveValue_t* value);

int RaveValueList_insert(RaveValue_t* self, int index, RaveValue_t* value);

RaveValue_t* RaveValueList_join(RaveValue_t* self, const char* sep);

int RaveValueList_size(RaveValue_t* self);

RaveValue_t* RaveValueList_get(RaveValue_t* self, int index);

void RaveValueList_release(RaveValue_t* self, int index);

 void RaveValueList_clear(RaveValue_t* self);

char* RaveValue_toJSON(RaveValue_t* self);

RaveValue_t* RaveValue_fromJSON(const char* json);

RaveValue_t* RaveValue_loadJSON(const char* filename);
 
#endif /* RAVE_VALUE_H */