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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
/**
* @copyright
* ====================================================================
* 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.
* ====================================================================
* @endcopyright
*
* @file svn_hash.h
* @brief Dumping and reading hash tables to/from files.
*/
#ifndef SVN_HASH_H
#define SVN_HASH_H
#include <apr.h>
#include <apr_pools.h>
#include <apr_hash.h>
#include <apr_tables.h>
#include <apr_file_io.h> /* for apr_file_t */
#include "svn_types.h"
#include "svn_io.h" /* for svn_stream_t */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** The longest the "K <number>" line can be in one of our hashdump files. */
#define SVN_KEYLINE_MAXLEN 100
/**
* @defgroup svn_hash_support Hash table serialization support
* @{
*/
/*----------------------------------------------------*/
/** Reading/writing hashtables to disk
*
* @defgroup svn_hash_read_write Reading and writing hashtables to disk
* @{
*/
/**
* The conventional terminator for hash dumps.
*
* @since New in 1.1.
*/
#define SVN_HASH_TERMINATOR "END"
/**
* Read a hash table from @a stream, storing the resultants names and
* values in @a hash. Use a @a pool for all allocations. @a hash will
* have <tt>const char *</tt> keys and <tt>svn_string_t *</tt> values.
* If @a terminator is NULL, expect the hash to be terminated by the
* end of the stream; otherwise, expect the hash to be terminated by a
* line containing @a terminator. Pass @c SVN_HASH_TERMINATOR to use
* the conventional terminator "END".
*
* @since New in 1.1.
*/
svn_error_t *
svn_hash_read2(apr_hash_t *hash,
svn_stream_t *stream,
const char *terminator,
apr_pool_t *pool);
/**
* Dump @a hash to @a stream. Use @a pool for all allocations. @a
* hash has <tt>const char *</tt> keys and <tt>svn_string_t *</tt>
* values. If @a terminator is not NULL, terminate the hash with a
* line containing @a terminator.
*
* @since New in 1.1.
*/
svn_error_t *
svn_hash_write2(apr_hash_t *hash,
svn_stream_t *stream,
const char *terminator,
apr_pool_t *pool);
/**
* Similar to svn_hash_read2(), but allows @a stream to contain
* deletion lines which remove entries from @a hash as well as adding
* to it.
*
* @since New in 1.1.
*/
svn_error_t *
svn_hash_read_incremental(apr_hash_t *hash,
svn_stream_t *stream,
const char *terminator,
apr_pool_t *pool);
/**
* Similar to svn_hash_write2(), but only writes out entries for
* keys which differ between @a hash and @a oldhash, and also writes
* out deletion lines for keys which are present in @a oldhash but not
* in @a hash.
*
* @since New in 1.1.
*/
svn_error_t *
svn_hash_write_incremental(apr_hash_t *hash,
apr_hash_t *oldhash,
svn_stream_t *stream,
const char *terminator,
apr_pool_t *pool);
/**
* This function behaves like svn_hash_read2(), but it only works
* on an apr_file_t input, empty files are accepted, and the hash is
* expected to be terminated with a line containing "END" or
* "PROPS-END".
*
* @deprecated Provided for backward compatibility with the 1.0 API.
*/
SVN_DEPRECATED
svn_error_t *
svn_hash_read(apr_hash_t *hash,
apr_file_t *srcfile,
apr_pool_t *pool);
/**
* This function behaves like svn_hash_write2(), but it only works
* on an apr_file_t output, and the terminator is always "END".
*
* @deprecated Provided for backward compatibility with the 1.0 API.
*/
SVN_DEPRECATED
svn_error_t *
svn_hash_write(apr_hash_t *hash,
apr_file_t *destfile,
apr_pool_t *pool);
/** @} */
/** Taking the "diff" of two hash tables.
*
* @defgroup svn_hash_diff Taking the diff of two hash tables.
* @{
*/
/** Hash key status indicator for svn_hash_diff_func_t. */
enum svn_hash_diff_key_status
{
/* Key is present in both hashes. */
svn_hash_diff_key_both,
/* Key is present in first hash only. */
svn_hash_diff_key_a,
/* Key is present in second hash only. */
svn_hash_diff_key_b
};
/** Function type for expressing a key's status between two hash tables. */
typedef svn_error_t *(*svn_hash_diff_func_t)
(const void *key, apr_ssize_t klen,
enum svn_hash_diff_key_status status,
void *baton);
/** Take the diff of two hashtables.
*
* For each key in the union of @a hash_a's and @a hash_b's keys, invoke
* @a diff_func exactly once, passing the key, the key's length, an enum
* @c svn_hash_diff_key_status indicating which table(s) the key appears
* in, and @a diff_func_baton.
*
* Process all keys of @a hash_a first, then all remaining keys of @a hash_b.
*
* If @a diff_func returns error, return that error immediately, without
* applying @a diff_func to anything else.
*
* @a hash_a or @a hash_b or both may be NULL; treat a null table as though
* empty.
*
* Use @a pool for temporary allocation.
*/
svn_error_t *
svn_hash_diff(apr_hash_t *hash_a,
apr_hash_t *hash_b,
svn_hash_diff_func_t diff_func,
void *diff_func_baton,
apr_pool_t *pool);
/** @} */
/**
* @defgroup svn_hash_misc Miscellaneous hash APIs
* @{
*/
/**
* Return the keys to @a hash in @a *array. The keys are assumed to be
* (const char *). The keys are in no particular order.
*
* @a *array itself is allocated in @a pool; however, the keys are not
* copied from the hash.
*
* @since New in 1.5.
*/
svn_error_t *
svn_hash_keys(apr_array_header_t **array,
apr_hash_t *hash,
apr_pool_t *pool);
/**
* Set @a *hash to a new hash whose keys come from the items in @a keys
* (an array of <tt>const char *</tt> items), and whose values are
* match their corresponding key. Use @a pool for all allocations
* (including @a *hash, its keys, and its values).
*
* @since New in 1.5.
*/
svn_error_t *
svn_hash_from_cstring_keys(apr_hash_t **hash,
const apr_array_header_t *keys,
apr_pool_t *pool);
/** Shortcut for apr_hash_get() with a const char * key.
*
* @since New in 1.8.
*/
#define svn_hash_gets(ht, key) \
apr_hash_get(ht, key, APR_HASH_KEY_STRING)
/** Shortcut for apr_hash_set() with a const char * key.
*
* @since New in 1.8.
*/
#define svn_hash_sets(ht, key, val) \
apr_hash_set(ht, key, APR_HASH_KEY_STRING, val)
/** @} */
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* SVN_HASH_H */
|
