nix_api_util.h

Go to the documentation of this file.

#ifndef NIX_API_UTIL_H
#define NIX_API_UTIL_H
 
#ifdef __cplusplus
extern "C" {
#endif
// cffi start

// Error codes
enum nix_err {

    NIX_OK = 0,

    NIX_ERR_UNKNOWN = -1,

    NIX_ERR_OVERFLOW = -2,

    NIX_ERR_KEY = -3,

    NIX_ERR_NIX_ERROR = -4,

    NIX_ERR_RECOVERABLE = -5,
};
 
typedef enum nix_err nix_err;

enum nix_verbosity {
    NIX_LVL_ERROR = 0,
    NIX_LVL_WARN,
    NIX_LVL_NOTICE,
    NIX_LVL_INFO,
    NIX_LVL_TALKATIVE,
    NIX_LVL_CHATTY,
    NIX_LVL_DEBUG,
    NIX_LVL_VOMIT,
};
 
typedef enum nix_verbosity nix_verbosity;

typedef struct nix_c_context nix_c_context;

typedef void (*nix_get_string_callback)(const char * start, unsigned int n, void * user_data);
 
// Function prototypes

nix_c_context * nix_c_context_create();
void nix_c_context_free(nix_c_context * context);

nix_err nix_libutil_init(nix_c_context * context);

nix_err nix_setting_get(nix_c_context * context, const char * key, nix_get_string_callback callback, void * user_data);

nix_err nix_setting_set(nix_c_context * context, const char * key, const char * value);

// todo: nix_plugins_init()

const char * nix_version_get();

const char * nix_err_msg(nix_c_context * context, const nix_c_context * ctx, unsigned int * n);

nix_err nix_err_info_msg(
    nix_c_context * context, const nix_c_context * read_context, nix_get_string_callback callback, void * user_data);

nix_err nix_err_name(
    nix_c_context * context, const nix_c_context * read_context, nix_get_string_callback callback, void * user_data);

nix_err nix_err_code(const nix_c_context * read_context);

nix_err nix_set_err_msg(nix_c_context * context, nix_err err, const char * msg);

void nix_clear_err(nix_c_context * context);

nix_err nix_set_verbosity(nix_c_context * context, nix_verbosity level);

 
// cffi end
#ifdef __cplusplus
}
#endif

#endif // NIX_API_UTIL_H