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
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* 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 parc_BufferDictionary.h
* @ingroup datastructures
* @brief A key/value dictionary built around PARCBuffer as the Key and the Value.
*
* The key/value dictionary models the Java MAP interface. It is built around Put, Get, and Remove.
* The dictionary stores references to the Key and Value, so the caller may destroy its references
* if no longer needed.
*
*/
#ifndef libparc_parc_BufferDictionary_h
#define libparc_parc_BufferDictionary_h
typedef struct parc_buffer_dictionary PARCBufferDictionary;
#include <parc/algol/parc_Buffer.h>
/**
* Creates an empty dictionary. You must use {@link parcBufferDictionary_Release} to destroy it.
*
* @return A pointer to the new `PARCBufferDictionary`
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBufferDictionary *parcBufferDictionary_Create(void);
/**
* Increase the number of references to a `PARCBufferDictionary`.
*
* Note that a new `PARCBufferDictionary` is not created,
* only that the given `PARCBufferDictionary` reference count is incremented.
* Discard the reference by invoking {@link parcBufferDictionary_Release}.
*
* @param [in] dictionary is a pointer to a `PARCBufferDictionary` instance
* @return The pointer to the @p dictionary instance.
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBufferDictionary *parcBufferDictionary_Acquire(const PARCBufferDictionary *dictionary);
/**
* Release a `PARCBufferDictionary` reference.
*
* Only the last invocation where the reference count is decremented to zero,
* will actually destroy the `PARCBufferDictionary`.
*
* @param [in,out] dictionaryPtr is a pointer to the `PARCBufferDictionary` reference.
*
* Example:
* @code
* <#example#>
* @endcode
*/
void parcBufferDictionary_Release(PARCBufferDictionary **dictionaryPtr);
/**
* Add a key/value to the dictionary, returns previous value or NULL
*
* The Dictionary will store a reference (PARCBuffer::aquire) to the key and to the value.
* The Key and Value must be non-NULL. If a previous entry for the key is in the dictionary,
* the previous value is returned. THE CALLER MUST USE {@link parcBuffer_Release} on the returned
* value if it is non-NULL;
*
* @param [in,out] dictionary The dictionary to modify
* @param [in] key The dictionary key
* @param [in] value The value for the key
*
* @return NULL The inserted key is unique
* @return non-NULL Returns the previous value of the key, must use {@link parcBuffer_Release}
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBuffer *parcBufferDictionary_Put(PARCBufferDictionary *dictionary, PARCBuffer *key, PARCBuffer *value);
/**
* Returns the value associated with the key, or NULL if does not exist
*
* The returned value is what's stored in the dictionary in a `PARCBuffer` instance. If the user wishes to keep the
* value beyond the current calling scope, she should use {@link parcBuffer_Acquire} on the
* returned value.
*
* @param [in] dictionary The dictionary to query
* @param [in] key The dictionary key
*
* @return NULL The key is not in the dictionary
* @return non-NULL Returns the current value of the key, DO NOT use {@link parcBuffer_Release}
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCBuffer *parcBufferDictionary_Get(PARCBufferDictionary *dictionary, PARCBuffer *key);
/**
* Removes a key from the dictionary, returning the current value or NULL. The caller MUST
* call {@link parcBuffer_Release} on the returned value.
*
* @param [in,out] dictionary The dictionary to modify
* @param [in] key The dictionary key
*
* @return NULL The inserted key is not in the dictionary
* @return non-NULL Returns the current value of the key, DO NOT use {@link parcBuffer_Release}
*
* Example:
* @code
* {
* uint8_t phone[] = "6505551212";
* PARCBufferDictionary *dict = parcBufferDictionary_Create();
*
* parcBuffer *key = parcBuffer_Wrap(phone, sizeof(phone), 0);
* parcBuffer_Release(parcBufferDictionary_Remove(dict, key));
*
* parcBuffer_Release(&key);
* parcBufferDictionary_Destroy(&dict);
* }
* @endcode
*/
PARCBuffer *parcBufferDictionary_Remove(PARCBufferDictionary *dictionary, PARCBuffer *key);
#endif // libparc_parc_BufferDictionary_h
|
