| /* SPDX-License-Identifier: BSD-3-Clause or GPL-2.0-only */ |
| |
| #ifndef FLASHMAP_LIB_KV_PAIR_H__ |
| #define FLASHMAP_LIB_KV_PAIR_H__ |
| |
| #include <stdio.h> |
| #include <inttypes.h> |
| #include <string.h> |
| |
| /* key=value string pair list */ |
| #define KV_PAIR_MAX_VALUE_LEN 1024 |
| |
| enum kv_pair_style { |
| KV_STYLE_PAIR, /* key1="value1" key2="value2" */ |
| KV_STYLE_VALUE, /* | value1 | value2 | */ |
| KV_STYLE_LONG, /* key1 | value1 */ |
| /* key2 | value2 */ |
| }; |
| |
| struct kv_pair { |
| char *key; |
| char *value; |
| struct kv_pair *next; |
| }; |
| |
| extern enum kv_pair_style kv_pair_get_style(void); |
| |
| extern void kv_pair_set_style(enum kv_pair_style style); |
| |
| /* |
| * kv_pair_new - create new key=value pair |
| * |
| * returns pointer to new key=value pair |
| * returns NULL to indicate error |
| */ |
| extern struct kv_pair *kv_pair_new(void); |
| |
| /* |
| * kv_pair_add - add new key=value pair to list |
| * |
| * @kv_list: key=value pair list |
| * @key: key string |
| * @value: value string |
| * |
| * returns pointer to new key=value pair |
| * returns NULL to indicate error |
| */ |
| extern struct kv_pair *kv_pair_add(struct kv_pair *kv_list, |
| const char *key, const char *value); |
| |
| /* |
| * kv_pair_add_bool - add new boolean kvpair to list |
| * |
| * @kv_list: key=value pair list |
| * @key: key string |
| * @value: value |
| * |
| * returns pointer to new key=value pair |
| * returns NULL to indicate error |
| */ |
| extern struct kv_pair *kv_pair_add_bool(struct kv_pair *kv_list, |
| const char *key, int value); |
| |
| /* |
| * kv_pair_fmt - add key=value pair based on printf format |
| * NOTE: uses variable argument list |
| * |
| * @kv_list: list of key=value pairs |
| * @kv_key: key string |
| * @format: printf-style format for value input |
| * @...: arguments to format |
| * |
| * returns pointer to new key=value pair |
| * returns NULL to indicate error |
| */ |
| extern struct kv_pair *kv_pair_fmt(struct kv_pair *kv_list, |
| const char *kv_key, const char *format, ...) |
| #if defined(_WIN32) || (_WIN64) |
| __attribute__((format(gnu_printf, 3, 4))); |
| #else |
| __attribute__((format(printf, 3, 4))); |
| #endif |
| |
| /* |
| * kv_pair_free - clean a key=value pair list |
| * |
| * @kv_list: pointer to key=value list |
| */ |
| extern void kv_pair_free(struct kv_pair *kv_list); |
| |
| /* |
| * kv_pair_print - print a key=value pair list |
| * |
| * @kv_list: pointer to key=value list |
| * @style: print style |
| */ |
| extern void kv_pair_print_to_file(FILE* fp, struct kv_pair *kv_list, |
| enum kv_pair_style style); |
| |
| /* |
| * kv_pair_print - print a key=value pair list to gsys output |
| * |
| * @kv_list: pointer to key=value list |
| */ |
| extern void kv_pair_print(struct kv_pair *kv_list); |
| |
| |
| /* |
| * kv_pair_get_value - return first value with key match |
| * |
| * @kv_list: pointer to key=value list |
| * @kv_key: key string |
| */ |
| extern const char *kv_pair_get_value(struct kv_pair *kv_list, |
| const char *kv_key); |
| |
| /* |
| * kv_pair_size - return number of kv pairs in the chain |
| * |
| * @kv_list: pointer to key=value list |
| */ |
| extern int kv_pair_size(struct kv_pair *kv_list); |
| |
| #endif /* FLASHMAP_LIB_KV_PAIR_H__ */ |