diff options
Diffstat (limited to 'libparc/parc/algol/parc_KeyValue.h')
| -rwxr-xr-x | libparc/parc/algol/parc_KeyValue.h | 273 |
1 files changed, 0 insertions, 273 deletions
diff --git a/libparc/parc/algol/parc_KeyValue.h b/libparc/parc/algol/parc_KeyValue.h deleted file mode 100755 index a4bc3915..00000000 --- a/libparc/parc/algol/parc_KeyValue.h +++ /dev/null @@ -1,273 +0,0 @@ -/* - * 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_KeyValue.h - * @ingroup datastructures - * @brief A key and value tuple. - * - * The `PARCKeyValue` is a simple key-value tuple. - * - */ -#ifndef libparc_parc_KeyValue_h -#define libparc_parc_KeyValue_h - -#include "parc_Object.h" - -struct parc_key_value; - -/** - * @typedef `PARCKeyValue` - * @brief A `PARCKeyValue` is a tuple consisting of a key and a value - */ -typedef struct parc_key_value PARCKeyValue; - -/** - * Create a `PARCKeyValue` Element. The key and value must be PARCObjects. - * - * Neither the data nor the key will be copied, but referenced. - * The key may not be `NULL`. - * - * @param [in] key A pointer to the key data - * @param [in] value A pointer to the value data - * - * Example: - * @code - * { - * ... - * PARCKeyValue *kv = parcKeyValue_Create(key, value); - * ... - * parcKeyValue_Release(&kv); - * } - * @endcode - */ -PARCKeyValue *parcKeyValue_Create(const PARCObject *key, - const PARCObject *value); - -/** - * Create a copy of a `PARCKeyValue` Element. - * - * The source PARCKeyValue may not be `NULL`. - * - * @param [in] keyValue Source PARCKeyValue element - * - * Example: - * @code - * { - * ... - * PARCKeyValue *keyValueCopy = parcKeyValue_Copy(sourcKeyValue); - * ... - * parcKeyValue_Release(&keyValueCopy); - * } - * @endcode - */ -PARCKeyValue *parcKeyValue_Copy(const PARCKeyValue *keyValue); - -/** - * Acquire a reference to a `PARCKeyValue` Element. - * - * The source PARCKeyValue may not be `NULL`. - * - * @param [in] keyValue Source PARCKeyValue element - * - * Example: - * @code - * { - * ... - * PARCKeyValue *keyValue = parcKeyValue_Acquire(sourcKeyValue); - * ... - * parcKeyValue_Release(&keyValue); - * } - * @endcode - */ -PARCKeyValue *parcKeyValue_Acquire(const PARCKeyValue *keyValue); - -/** - * Release a `PARCKeyValue`. - * - * Releases a reference to a PARCKeyValue element, if it is the last reference then the - * contained key & value objects are released and the elements memory is freed. - * - * @param [in,out] keyValuePointer A pointer to the pointer to the `PARCKeyValue` to be released - * - * Example: - * @code - * ... - * PARCKeyValue *kv = parcKeyValue_Create(key, value); - * ... - * parcKeyValue_Release(&kv); - * @endcode - */ -void parcKeyValue_Release(PARCKeyValue **keyValuePointer); - -/** - * Set the value for a `PARCKeyValue`. - * The previous value will be released. - * - * @param [in,out] keyValue A pointer to the keyValue - * @param [in] value A pointer to the new value - * - * Example: - * @code - * ... - * PARCKeyValue *kv = parcKeyValue_Create(key, value); - * ... - * parcKeyValue_SetKey(kv, newKey); - * ... - * parcKeyValue_Release(&kv); - * @endcode - */ -void parcKeyValue_SetValue(PARCKeyValue *keyValue, PARCObject *value); - -/** - * Set the key for a `PARCKeyValue`. - * The previous key will be released. - * - * @param [in,out] keyValue A pointer to the `PARCKeyValue` - * @param [in] key A pointer to the new key - * - * Example: - * @code - * ... - * PARCKeyValue *kv = parcKeyValue_Create(key, value); - * ... - * parcKeyValue_SetValue(kv, newValue); - * ... - * parcKeyValue_Release(&kv); - * @endcode - */ -void parcKeyValue_SetKey(PARCKeyValue *keyValue, PARCObject *key); - -/** - * Get the value pointer for the `PARCKeyValue`. No extra reference is created. - * - * @param [in] keyValue A pointer to the `PARCKeyValue` - * - * Example: - * @code - * ... - * PARCKeyValue *kv = parcKeyValue_Create(key, value); - * ... - * PARCObject *value = parcKeyValue_GetValue(kv); - * ... - * parcKeyValue_Release(&kv); - * @endcode - */ -PARCObject *parcKeyValue_GetValue(PARCKeyValue *keyValue); - -/** - * Get the key pointer for the `PARCKeyValue`. No extra reference is created. - * - * @param [in] keyValue A pointer to the `PARCKeyValue` - * - * Example: - * @code - * ... - * PARCKeyValue *kv = parcKeyValue_Create(key, value); - * ... - * PARCObject *key = parcKeyValue_GetKey(kv); - * ... - * parcKeyValue_Release(&kv); - * @endcode - */ -PARCObject *parcKeyValue_GetKey(PARCKeyValue *keyValue); - -/** - * Check for Key equality. Return true if equal. - * - * @param [in] keyValue1 A pointer to the first `PARCKeyValue` - * @param [in] keyValue2 A pointer to the second `PARCKeyValue` - * @return true if the keyValues have the same key - * - * Example: - * @code - * ... - * PARCKeyValue *kv1 = parcKeyValue_Create(key1, value); - * PARCKeyValue *kv2 = parcKeyValue_Create(key2, value); - * ... - * if (parcKeyValue_EqualKeys(kv1, kv2)) { - * ... - * } - * ... - * parcKeyValue_Release(&kv1); - * parcKeyValue_Release(&kv2); - * @endcode - */ -bool parcKeyValue_EqualKeys(const PARCKeyValue *keyValue1, const PARCKeyValue *keyValue2); - -/** - * Check for element equality. Return true if both key & value are equal. - * - * @param [in] keyValue1 A pointer to the first `PARCKeyValue` - * @param [in] keyValue2 A pointer to the second `PARCKeyValue` - * @return true if the keys & values both have the same value - * - * Example: - * @code - * ... - * PARCKeyValue *kv1 = parcKeyValue_Create(key1, value); - * PARCKeyValue *kv2 = parcKeyValue_Create(key2, value); - * ... - * if (parcKeyValue_Equals(kv1, kv2)) { - * ... - * } - * ... - * parcKeyValue_Release(&kv1); - * parcKeyValue_Release(&kv2); - * @endcode - */ -bool parcKeyValue_Equals(const PARCKeyValue *keyValue1, const PARCKeyValue *keyValue2); - -/** - * Compare PARCKeyValue elements. Return an int result based on key compare only. - * - * @param [in] keyValue1 A pointer to the first `PARCKeyValue` - * @param [in] keyValue2 A pointer to the second `PARCKeyValue` - * @return parcObject_Compare(keyValue1->key, keyValue2->key) - * - * Example: - * @code - * ... - * PARCKeyValue *kv1 = parcKeyValue_Create(key1, value); - * PARCKeyValue *kv2 = parcKeyValue_Create(key2, value); - * ... - * if (parcKeyValue_Compare(kv1, kv2) > 0) { - * ... - * } - * ... - * parcKeyValue_Release(&kv1); - * parcKeyValue_Release(&kv2); - * @endcode - */ -int parcKeyValue_Compare(const PARCKeyValue *keyValue1, const PARCKeyValue *keyValue2); - -/** - * Return the HashCode of the PARCKeyValue key. - * - * @param [in] keyValue A pointer to the first `PARCKeyValue` - * @return parcObject_HashCode(keyValue->key); - * - * Example: - * @code - * ... - * PARCKeyValue *keyValue = parcKeyValue_Create(key1, value); - * ... - * PARCHashCode *hashCode = parcKeyValue_HashCode(keyValue); - * ... - * parcKeyValue_Release(&keyValue); - * @endcode - */ -PARCHashCode parcKeyValue_HashCode(const PARCKeyValue *keyValue); -#endif // libparc_parc_KeyValue_h |