kvargs.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 * Copyright (c) 2014 6WIND S.A.
 */
 
#ifndef __KVARGS_H_
#define __KVARGS_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    KVARGS_PTR,
    KVARGS_INT8,
    KVARGS_UINT8,
    KVARGS_INT16,
    KVARGS_UINT16,
    KVARGS_INT32,
    KVARGS_UINT32,
    KVARGS_INT64,
    KVARGS_UINT64,
    KVARGS_LAST_TYPE
} kvargs_type_t;
 
#define KVARGS_MAX 64
 
#define KVARGS_PAIRS_DELIM_1 ","
#define KVARGS_PAIRS_DELIM_2 ";"
 
#define KVARGS_KV_DELIM "="
 
typedef int (*arg_handler_t)(const char *key, const char *value, void *opaque);
 
struct kvargs_pair {
    char *key;   
    char *value; 
};
 
struct kvargs {
    char *str;                            
    unsigned count;                       
    struct kvargs_pair pairs[KVARGS_MAX]; 
};
 
struct kvargs *kvargs_parse(const char *args, const char *const valid_keys[]);
 
struct kvargs *kvargs_parse_delim(const char *args, const char *const valid_keys[],
                                  const char *valid_ends);
 
void kvargs_free(struct kvargs *kvlist);
 
int kvargs_process(const struct kvargs *kvlist, const char *key_match, arg_handler_t handler,
                   void *opaque_arg);
 
int kvargs_process_type(const struct kvargs *kvlist, const char *key_match, kvargs_type_t typ,
                        void *opaque_arg);
 
static inline int
kvargs_ptr(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_PTR, arg);
}
 
static inline int
kvargs_int8(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_INT8, arg);
}
 
static inline int
kvargs_uint8(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_UINT8, arg);
}
 
static inline int
kvargs_int16(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_INT16, arg);
}
 
static inline int
kvargs_uint16(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_UINT16, arg);
}
 
static inline int
kvargs_int32(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_INT32, arg);
}
 
static inline int
kvargs_uint32(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_UINT32, arg);
}
 
static inline int
kvargs_int64(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_INT64, arg);
}
 
static inline int
kvargs_uint64(const struct kvargs *kv, const char *key, void *arg)
{
    return kvargs_process_type(kv, key, KVARGS_UINT64, arg);
}
 
unsigned kvargs_count(const struct kvargs *kvlist, const char *key_match);
 
int kvargs_strcmp(const char *key, const char *value, void *opaque);
 
#ifdef __cplusplus
}
#endif
 
#endif