ytKeyValues.h

/*
  util/ytKeyValues.{h,c} : Key-value pairs.
  Copyright (C) 2018, Yoshinori Tamada <tamada A T ytlab.jp>
  All rights reserved.
 
  See LICENSE.txt for details of the licensing agreement.
*/
 
#ifndef __YTLIB_KEY_VALUES_H
#define __YTLIB_KEY_VALUES_H
 
#include "ytStrArray.h"
#include "ytArray.h"
#include "ytIntArray.h"
#include "ytDoubleArray.h"
 
extern char * ytKeyValues_DEFAULT_VALUE;
 
extern char * ytKeyValues_DEFAULT_KEY;
 
extern char * ytKeyValues_ERROR_KEY;
 
extern int * ytKeyValues_DEFAULT_VALUE_ON;
 
extern int * ytKeyValues_DEFAULT_VALUE_OFF;
 
#ifdef DOXY
#define ytKeyValues_ERROR_VALUE
#else
#define ytKeyValues_ERROR_VALUE ((size_t) -1)
#endif
 
typedef struct ytKeyValues_t ytKeyValues;
 
 
 
#ifdef YTLIB_MEMCHECK
ytKeyValues * ytKeyValues_newm(const char * file, int line);
void ytKeyValues_deletem(ytKeyValues * this, const char * file, int line);
#define ytKeyValues_new() ytKeyValues_newm(__FILE__,__LINE__)
#define ytKeyValues_delete(this) ytKeyValues_deletem(this,__FILE__,__LINE__)
#else
ytKeyValues * ytKeyValues_new();
void ytKeyValues_delete(ytKeyValues * this);
#endif
 
void ytKeyValues_deleteAll(ytKeyValues * this);
void ytKeyValues_deleteAllv(void * this);
ytKeyValues * ytKeyValues_clone(const ytKeyValues * this);
ytObject * ytKeyValues_cloneI(const ytObject * this);
ytObject * ytKeyValues_obj(ytKeyValues * kv);
ytKeyValues * ytKeyValues_from(ytObject * this);
ytObject * ytKeyValues_pObj(ytKeyValues ** ptr);
ytKeyValues ** ytKeyValues_objP(ytObject * obj);
void ytKeyValues_dump(ytKeyValues * this, FILE * fp);
void ytKeyValues_setPR(ytObject * a, ytKeyValues * v);
void ytKeyValues_add(ytKeyValues * this,
                     const char * key, ytObject * value);
void ytKeyValues_add2(ytKeyValues * this,
                      char * key, ytObject * value);
void ytKeyValues_addInt(ytKeyValues * this,
                        const char * key, int value);
void ytKeyValues_addString(ytKeyValues * this,
                           const char * key, const char * value);
void ytKeyValues_addIntArray(ytKeyValues * this,
                             const char * key, ytIntArray * value);
void ytKeyValues_addDoubleArray(ytKeyValues * this,
                                const char * key, ytDoubleArray * value);
void ytKeyValues_set(ytKeyValues * this, const char * key, ytObject * value);
void ytKeyValues_setDelete(ytKeyValues * this, const char * key, ytObject * value);
ytObject * ytKeyValues_get(const ytKeyValues * this, const char * key);
int ytKeyValues_getInt(const ytKeyValues * this, const char * key, int def);
double ytKeyValues_getDouble(const ytKeyValues * this, const char * key, double def);
char * ytKeyValues_getString(const ytKeyValues * this, const char * key);
ytIntArray * ytKeyValues_getIntArray(const ytKeyValues * this, const char * key);
ytStrArray * ytKeyValues_getStrArray(const ytKeyValues * this, const char * key);
ytObject * ytKeyValues_remove(ytKeyValues * this, const char * key);
size_t ytKeyValues_size(const ytKeyValues * this);
const char * ytKeyValues_getKey(const ytKeyValues * this, size_t index);
ytObject * ytKeyValues_getValue(const ytKeyValues * this, size_t index);
int ytKeyValues_getKeyIndex(const ytKeyValues * this, const char * key);
ytKeyValues * ytKeyValues_parse(const char * str);
ytStrArray * ytKeyValues_getKeys(const ytKeyValues * this, ytStrArray * ar);
void ytKeyValues_print(const ytKeyValues * this, FILE * fp);
void ytKeyValues_printI(const ytObject * this, FILE * fp);
size_t ytKeyValues_memorySize(const ytKeyValues * this);
ytByte * ytKeyValues_serialize(const ytKeyValues * this, ytByte ** pptr);
ytKeyValues * ytKeyValues_deserialize(ytByte ** const pptr);
ytByte * ytKeyValues_serializeI(const ytObject * obj, ytByte ** pptr);
ytObject * ytKeyValues_deserializeI(ytByte ** const pptr);
 
 
#define ytKV(str) ytKeyValues_parse(str)
 
int ytKeyValues_test(int argc, char * argv[]);
 
#ifdef USE_MPI
#include <mpi.h>
void ytKeyValues_MPI_Bcast(ytKeyValues ** pObject, int root, MPI_Comm comm);
#endif /* USE_MPI */
 
 
#endif /* __YTLIB_KEY_VALUES_H */