atcflib/key_value.h at master · atthecodeface/atcflib · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/** Copyright (C) 2016,  Gavin J Stark.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @file          key_value.h
 * @brief         Key/value pair library
 *
 */

/*a Wrapper
 */
#ifdef __INC_KEY_VALUE
#else
#define __INC_KEY_VALUE

/*a Defines
 */

/*a Types
 */
/*t t_key_value_entry_ptr
 */
typedef struct t_key_value_entry *t_key_value_entry_ptr;

/*f t_key_value_entry
 */
typedef struct t_key_value_entry
{
    t_key_value_entry_ptr next;
    t_key_value_entry_ptr prev;
    char *key;
    char *value;
    void *data;
} t_key_value_entry;

/*t t_key_values
 */
typedef struct
{
    t_key_value_entry_ptr kv_head;
    t_key_value_entry_ptr kv_tail;
    size_t extra_room;
} t_key_values;

#define key_value_entry_key(a) (a->key)
#define key_value_entry_value(a) (a->value)
#define key_value_entry_data(a,t) ((t *)(&(a->data)))

/*a External functions
 */
extern void
key_value_set(t_key_values *kv, const char *key, const char *value);
extern int
key_value_delete(t_key_values *kv, const char *key);

/*f key_value_parse
 * Parse a string and create a list of key_values from it
 * The string should be [&]<key>=<value>[&<key>=<value>]*
 */
extern const char *
key_value_parse(const char *string, const char *string_end, t_key_values *kv);

/*f key_value_iter
 * iterate over all the key/value pairs in the t_key_values
 */
extern t_key_value_entry_ptr
key_value_iter(t_key_values *kv, t_key_value_entry_ptr kve);

/*f key_value_find
 * iterate over all the key/value pairs in the t_key_values
 */
extern t_key_value_entry_ptr
key_value_find(t_key_values *kv, const char *key);

/*f key_value_init
 * Initialize a t_key_values structure
 */
extern void
key_value_init(t_key_values *kv, size_t extra_room);

/*f key_value_free
 * Free data in a key values structure
 */
extern void
key_value_free(t_key_values *kv);

/*a Wrapper
 */
#endif

/*a Editor preferences and notes
mode: c ***
c-basic-offset: 4 ***
c-default-style: (quote ((c-mode . "k&r") (c++-mode . "k&r"))) ***
outline-regexp: "/\\\*a\\\|[\t ]*\/\\\*[b-z][\t ]" ***
*/