pressio_options.h

Go to the documentation of this file.

#ifdef __cplusplus
extern "C" {
#endif
 
 
#ifndef LIBPRESSIO_OPTIONS_H
#define LIBPRESSIO_OPTIONS_H
#include "pressio_dtype.h"
#include "pressio_compressor.h"
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
struct pressio_options;
struct pressio_options_iter;
struct pressio_option;
struct pressio_data;
 
enum  pressio_options_key_status{
  pressio_options_key_set=0,
 
  pressio_options_key_exists=1,
 
  pressio_options_key_does_not_exist=2,
};
 
enum pressio_conversion_safety {
  pressio_conversion_implicit=0,
 
  pressio_conversion_explicit=1,
 
  pressio_conversion_special=2,
};
 
enum pressio_option_type {pressio_option_uint32_type=0,pressio_option_int32_type=1,pressio_option_float_type=2,pressio_option_double_type=3,pressio_option_charptr_type=4,pressio_option_userptr_type=5,pressio_option_unset_type=6,pressio_option_charptr_array_type=7,pressio_option_data_type=8,pressio_option_uint8_type=9,pressio_option_int8_type=10,pressio_option_uint16_type=11,pressio_option_int16_type=12,pressio_option_uint64_type=13,pressio_option_int64_type=14,pressio_option_bool_type=15,pressio_option_dtype_type=16,pressio_option_threadsafety_type=17,
};
 
 
struct pressio_options* pressio_options_new();
struct pressio_options* pressio_options_copy(struct pressio_options const* options);
struct pressio_options* pressio_options_merge(struct pressio_options const* lhs, struct pressio_options const* rhs);
void pressio_options_free(struct pressio_options* options);
 
enum pressio_options_key_status pressio_options_exists(struct pressio_options const* options, const char* key);
 
 
struct pressio_option* pressio_options_get(struct pressio_options const* options, const char* key);
void pressio_options_set(struct pressio_options* options, const char* key, struct pressio_option* option);
 
enum pressio_options_key_status pressio_options_cast_set(struct pressio_options* options, const char* key, struct pressio_option const* option, enum pressio_conversion_safety safety);
 
enum pressio_options_key_status pressio_options_as_set(struct pressio_options* options, const char* key, struct pressio_option* option);
 
void pressio_options_set_type(struct pressio_options* options, const char* key, enum pressio_option_type type);
 
void pressio_options_clear(struct pressio_options* options, const char* key);
 
size_t pressio_options_size(struct pressio_options const* options);
 
size_t pressio_options_num_set(struct pressio_options const* options);
 
 
 
#define pressio_options_define_type_set(name, type) \
 \
  void pressio_options_set_##name(struct pressio_options* options, const char* key, type value);
 
#define pressio_options_define_type_get(name, type) \
 \
  enum pressio_options_key_status pressio_options_get_##name(struct pressio_options \
      const* options, const char* key, type * value);
 
#define pressio_options_define_type_cast(name, type) \
 \
  enum pressio_options_key_status pressio_options_cast_##name(struct pressio_options \
      const* options, const char* key, const enum pressio_conversion_safety safety, \
      type * value);
 
#define pressio_options_define_type_as(name, type) \
 \
  enum pressio_options_key_status pressio_options_as_##name(struct pressio_options \
      const* options, const char* key, type * value);
 
#define pressio_options_define_type(name, type) \
  pressio_options_define_type_set(name, type) \
  pressio_options_define_type_get(name, type) \
  pressio_options_define_type_cast(name, type) \
  pressio_options_define_type_as(name, type) 
 
pressio_options_define_type(uinteger8, uint8_t)
pressio_options_define_type(integer8, int8_t)
pressio_options_define_type(uinteger16, uint16_t)
pressio_options_define_type(integer16, int16_t)
pressio_options_define_type(uinteger64, uint64_t)
pressio_options_define_type(integer64, int64_t)
pressio_options_define_type(uinteger, uint32_t)
pressio_options_define_type(integer, int32_t)
pressio_options_define_type(float, float)
pressio_options_define_type(double, double)
pressio_options_define_type(bool, bool)
pressio_options_define_type(userptr, void*)
pressio_options_define_type(dtype, enum pressio_dtype)
pressio_options_define_type(threadsafety, enum pressio_thread_safety)
pressio_options_define_type(data, struct pressio_data*)
 
//special case string -- prefer const on get/set
pressio_options_define_type_get(string, const char*)
pressio_options_define_type_set(string, const char*)
pressio_options_define_type_as(string, char*)
pressio_options_define_type_cast(string, char*)
 
void pressio_options_set_userptr_managed(struct pressio_options* options,
    const char* key,
    void* value,
    void* metadata,
    void(*deleter)(void*, void*),
    void(*copy)(void**, void**, const void*, const void*));
 
//special case strings -- to also pass/get length information
void pressio_options_set_strings(struct pressio_options* options, const char* key, size_t size, const char* const* values);
enum pressio_options_key_status pressio_options_get_strings(struct pressio_options const* options, const char* key, size_t* size, const char***  values); \
enum pressio_options_key_status pressio_options_cast_strings(struct pressio_options \
      const* options, const char* key, const enum pressio_conversion_safety safety, \
      size_t* size, char*** values); \
enum pressio_options_key_status pressio_options_as_strings(struct pressio_options \
      const* options, const char* key, size_t* size, char*** values);
 
char* pressio_options_to_string(struct pressio_options const* options);
 
//undefine the type macro so it is not used by implementations
#undef pressio_options_define_type
#undef pressio_options_define_type_set
#undef pressio_options_define_type_get
#undef pressio_options_define_type_as
#undef pressio_options_define_type_cast
 
#endif
 
#ifdef __cplusplus
}
#endif