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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*!The Treasure Box Library
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*
* Copyright (C) 2009 - 2017, TBOOX Open Source Group.
*
* @author ruki
* @file dictionary.h
* @ingroup object
*
*/
#ifndef TB_OBJECT_DICTIONARY_H
#define TB_OBJECT_DICTIONARY_H
/* //////////////////////////////////////////////////////////////////////////////////////
* includes
*/
#include "prefix.h"
/* //////////////////////////////////////////////////////////////////////////////////////
* extern
*/
__tb_extern_c_enter__
/* //////////////////////////////////////////////////////////////////////////////////////
* macros
*/
#define TB_OC_DICTIONARY_SIZE_MICRO (64)
#define TB_OC_DICTIONARY_SIZE_SMALL (256)
#define TB_OC_DICTIONARY_SIZE_LARGE (65536)
/* //////////////////////////////////////////////////////////////////////////////////////
* types
*/
/// the dictionary item type
typedef struct __tb_oc_dictionary_item_t
{
/// the key
tb_char_t const* key;
/// the value
tb_object_ref_t val;
}tb_oc_dictionary_item_t;
/* //////////////////////////////////////////////////////////////////////////////////////
* interfaces
*/
/*! init dictionary
*
* @code
// init dictionary
// {"key1": "hello", "key2" :"world", "key3": 12345, "key4": true}
tb_object_ref_t dict = tb_oc_dictionary_init(0, tb_false);
if (dict)
{
// key1 => hello
tb_oc_dictionary_insert(dict, "key1", tb_oc_string_init_from_cstr("hello"));
// key2 => world
tb_oc_dictionary_insert(dict, "key2", tb_oc_string_init_from_cstr("world"));
// key3 => 12345
tb_oc_dictionary_insert(dict, "key3", tb_oc_number_init_from_sint32(12345));
// key4 => true
tb_oc_dictionary_insert(dict, "key4", tb_oc_boolean_true());
// exit dictionary
tb_object_exit(dict);
}
* @endcode
*
* @param size the dictionary size, using the default size if be zero
* @param incr is increase refn?
*
* @return the dictionary object
*/
tb_object_ref_t tb_oc_dictionary_init(tb_size_t size, tb_bool_t incr);
/*! the dictionary size
*
* @param dictionary the dictionary object
*
* @return the dictionary size
*/
tb_size_t tb_oc_dictionary_size(tb_object_ref_t dictionary);
/*! set the dictionary incr
*
* @param dictionary the dictionary object
* @param incr is increase refn?
*/
tb_void_t tb_oc_dictionary_incr(tb_object_ref_t dictionary, tb_bool_t incr);
/*! the dictionary iterator
*
* @param dictionary the dictionary object
*
* @return the dictionary iterator
*
* @code
tb_for_all (tb_oc_dictionary_item_t*, item, tb_oc_dictionary_itor(dictionary))
{
if (item)
{
tb_char_t const* key = item->key;
tb_object_ref_t val = item->val;
// ...
}
}
* @endcode
*/
tb_iterator_ref_t tb_oc_dictionary_itor(tb_object_ref_t dictionary);
/*! get the dictionary value
*
* @param dictionary the dictionary object
* @param key the key
*
* @return the dictionary value
*/
tb_object_ref_t tb_oc_dictionary_value(tb_object_ref_t dictionary, tb_char_t const* key);
/*! insert dictionary item
*
* @param dictionary the dictionary object
* @param key the key
* @param val the value
*/
tb_void_t tb_oc_dictionary_insert(tb_object_ref_t dictionary, tb_char_t const* key, tb_object_ref_t val);
/*! remove dictionary item
*
* @param dictionary the dictionary object
* @param key the key
*/
tb_void_t tb_oc_dictionary_remove(tb_object_ref_t dictionary, tb_char_t const* key);
/* //////////////////////////////////////////////////////////////////////////////////////
* extern
*/
__tb_extern_c_leave__
#endif
|
