Metainfo.h

/*===-- serialbox-c/Metainfo.h ------------------------------------------------------*- C++ -*-===*\
 *
 *                                    S E R I A L B O X
 *
 * This file is distributed under terms of BSD license.
 * See LICENSE.txt for more information
 *
 *===------------------------------------------------------------------------------------------===//
 *
 *! \file
 *! This file contains the C implementation of the Metainfo.
 *
\*===------------------------------------------------------------------------------------------===*/

#ifndef SERIALBOX_C_METAINFO_H
#define SERIALBOX_C_METAINFO_H

#include "serialbox-c/Api.h"
#include "serialbox-c/Array.h"
#include "serialbox-c/Type.h"

#ifdef __cplusplus
extern "C" {
#endif

/*===------------------------------------------------------------------------------------------===*\
 *     Construction & Destruction
\*===------------------------------------------------------------------------------------------===*/

SERIALBOX_API serialboxMetainfo_t* serialboxMetainfoCreate(void);

SERIALBOX_API serialboxMetainfo_t*
serialboxMetainfoCreateFromMetainfo(const serialboxMetainfo_t* other);

SERIALBOX_API void serialboxMetainfoDestroy(serialboxMetainfo_t* metaInfo);

/*===------------------------------------------------------------------------------------------===*\
 *     Utility
\*===------------------------------------------------------------------------------------------===*/

SERIALBOX_API int serialboxMetainfoGetSize(const serialboxMetainfo_t* metaInfo);
SERIALBOX_API int serialboxMetainfoIsEmpty(const serialboxMetainfo_t* metaInfo);

SERIALBOX_API void serialboxMetainfoClear(serialboxMetainfo_t* metaInfo);

SERIALBOX_API int serialboxMetainfoEqual(const serialboxMetainfo_t* m1,
                                         const serialboxMetainfo_t* m2);

SERIALBOX_API int serialboxMetainfoHasKey(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API enum serialboxTypeID
serialboxMetainfoGetTypeIDOfKey(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API char* serialboxMetainfoToString(const serialboxMetainfo_t* metaInfo);

SERIALBOX_API typedef struct {
  char** keys;
  int* types;
  int len;
} serialboxMetainfoElementInfo_t;

SERIALBOX_API serialboxMetainfoElementInfo_t*
serialboxMetainfoCreateElementInfo(const serialboxMetainfo_t* metaInfo);

SERIALBOX_API void serialboxMetainfoDestroyElementInfo(serialboxMetainfoElementInfo_t* elementInfo);

SERIALBOX_API int serialboxMetainfoDeleteKey(serialboxMetainfo_t* metaInfo, const char* key);

/*===------------------------------------------------------------------------------------------===*\
 *     Add meta-information
\*===------------------------------------------------------------------------------------------===*/

SERIALBOX_API int serialboxMetainfoAddBoolean(serialboxMetainfo_t* metaInfo, const char* key,
                                              serialboxBoolean_t value);
SERIALBOX_API int serialboxMetainfoAddInt32(serialboxMetainfo_t* metaInfo, const char* key,
                                            serialboxInt32_t value);
SERIALBOX_API int serialboxMetainfoAddInt64(serialboxMetainfo_t* metaInfo, const char* key,
                                            serialboxInt64_t value);
SERIALBOX_API int serialboxMetainfoAddFloat32(serialboxMetainfo_t* metaInfo, const char* key,
                                              serialboxFloat32_t value);
SERIALBOX_API int serialboxMetainfoAddFloat64(serialboxMetainfo_t* metaInfo, const char* key,
                                              serialboxFloat64_t value);
SERIALBOX_API int serialboxMetainfoAddString(serialboxMetainfo_t* metaInfo, const char* key,
                                             const char* value);
SERIALBOX_API int serialboxMetainfoAddArrayOfBoolean(serialboxMetainfo_t* metaInfo, const char* key,
                                                     const serialboxArrayOfBoolean_t* array);
SERIALBOX_API int serialboxMetainfoAddArrayOfInt32(serialboxMetainfo_t* metaInfo, const char* key,
                                                   const serialboxArrayOfInt32_t* array);
SERIALBOX_API int serialboxMetainfoAddArrayOfInt64(serialboxMetainfo_t* metaInfo, const char* key,
                                                   const serialboxArrayOfInt64_t* array);
SERIALBOX_API int serialboxMetainfoAddArrayOfFloat32(serialboxMetainfo_t* metaInfo, const char* key,
                                                     const serialboxArrayOfFloat32_t* array);
SERIALBOX_API int serialboxMetainfoAddArrayOfFloat64(serialboxMetainfo_t* metaInfo, const char* key,
                                                     const serialboxArrayOfFloat64_t* array);
SERIALBOX_API int serialboxMetainfoAddArrayOfString(serialboxMetainfo_t* metaInfo, const char* key,
                                                    const serialboxArrayOfString_t* array);
/*===------------------------------------------------------------------------------------------===*\
 *     Query meta-information
\*===------------------------------------------------------------------------------------------===*/

SERIALBOX_API serialboxBoolean_t serialboxMetainfoGetBoolean(const serialboxMetainfo_t* metaInfo,
                                                             const char* key);
SERIALBOX_API serialboxInt32_t serialboxMetainfoGetInt32(const serialboxMetainfo_t* metaInfo,
                                                         const char* key);
SERIALBOX_API serialboxInt64_t serialboxMetainfoGetInt64(const serialboxMetainfo_t* metaInfo,
                                                         const char* key);
SERIALBOX_API serialboxFloat32_t serialboxMetainfoGetFloat32(const serialboxMetainfo_t* metaInfo,
                                                             const char* key);
SERIALBOX_API serialboxFloat64_t serialboxMetainfoGetFloat64(const serialboxMetainfo_t* metaInfo,
                                                             const char* key);
SERIALBOX_API serialboxString_t serialboxMetainfoGetString(const serialboxMetainfo_t* metaInfo,
                                                           const char* key);
SERIALBOX_API serialboxArrayOfBoolean_t*
serialboxMetainfoGetArrayOfBoolean(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API serialboxArrayOfInt32_t*
serialboxMetainfoGetArrayOfInt32(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API serialboxArrayOfInt64_t*
serialboxMetainfoGetArrayOfInt64(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API serialboxArrayOfFloat32_t*
serialboxMetainfoGetArrayOfFloat32(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API serialboxArrayOfFloat64_t*
serialboxMetainfoGetArrayOfFloat64(const serialboxMetainfo_t* metaInfo, const char* key);

SERIALBOX_API serialboxArrayOfString_t*
serialboxMetainfoGetArrayOfString(const serialboxMetainfo_t* metaInfo, const char* key);
#ifdef __cplusplus
}
#endif

#endif