Merge branch 'rightlib' into mergelibs-241019-1758

1 files changed, 130 insertions, 0 deletions

diff --git a/contrib/libs/c-ares/src/lib/include/ares_htable_strvp.h b/contrib/libs/c-ares/src/lib/include/ares_htable_strvp.h
new file mode 100644
index 0000000000..eaaf6d3be0
--- /dev/null
+++ b/contrib/libs/c-ares/src/lib/include/ares_htable_strvp.h
@@ -0,0 +1,130 @@
+/* MIT License
+ *
+ * Copyright (c) 2023 Brad House
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+#ifndef __ARES__HTABLE_STRVP_H
+#define __ARES__HTABLE_STRVP_H
+
+/*! \addtogroup ares_htable_strvp HashTable with string Key and void pointer
+ * Value
+ *
+ * This data structure wraps the base ares_htable data structure in order to
+ * split the key and value data types as string and void pointer, respectively.
+ *
+ * Average time complexity:
+ *  - Insert: O(1)
+ *  - Search: O(1)
+ *  - Delete: O(1)
+ *
+ * @{
+ */
+
+struct ares_htable_strvp;
+
+/*! Opaque data type for size_t key, void pointer hash table implementation */
+typedef struct ares_htable_strvp ares_htable_strvp_t;
+
+/*! Callback to free value stored in hashtable
+ *
+ *  \param[in] val  user-supplied value
+ */
+typedef void (*ares_htable_strvp_val_free_t)(void *val);
+
+/*! Destroy hashtable
+ *
+ *  \param[in] htable  Initialized hashtable
+ */
+CARES_EXTERN void ares_htable_strvp_destroy(ares_htable_strvp_t *htable);
+
+/*! Create string, void pointer value hash table
+ *
+ *  \param[in] val_free  Optional. Call back to free user-supplied value.  If
+ *                       NULL it is expected the caller will clean up any user
+ *                       supplied values.
+ */
+CARES_EXTERN ares_htable_strvp_t *
+  ares_htable_strvp_create(ares_htable_strvp_val_free_t val_free);
+
+/*! Insert key/value into hash table
+ *
+ *  \param[in] htable Initialized hash table
+ *  \param[in] key    key to associate with value
+ *  \param[in] val    value to store (takes ownership). May be NULL.
+ *  \return ARES_TRUE on success, ARES_FALSE on failure or out of memory
+ */
+CARES_EXTERN ares_bool_t ares_htable_strvp_insert(ares_htable_strvp_t *htable,
+                                                  const char *key, void *val);
+
+/*! Retrieve value from hashtable based on key
+ *
+ *  \param[in]  htable  Initialized hash table
+ *  \param[in]  key     key to use to search
+ *  \param[out] val     Optional.  Pointer to store value.
+ *  \return ARES_TRUE on success, ARES_FALSE on failure
+ */
+CARES_EXTERN ares_bool_t ares_htable_strvp_get(
+  const ares_htable_strvp_t *htable, const char *key, void **val);
+
+/*! Retrieve value from hashtable directly as return value.  Caveat to this
+ *  function over ares_htable_strvp_get() is that if a NULL value is stored
+ *  you cannot determine if the key is not found or the value is NULL.
+ *
+ *  \param[in] htable  Initialized hash table
+ *  \param[in] key     key to use to search
+ *  \return value associated with key in hashtable or NULL
+ */
+CARES_EXTERN void *
+  ares_htable_strvp_get_direct(const ares_htable_strvp_t *htable,
+                               const char                *key);
+
+/*! Remove a value from the hashtable by key
+ *
+ *  \param[in] htable  Initialized hash table
+ *  \param[in] key     key to use to search
+ *  \return ARES_TRUE if found, ARES_FALSE if not
+ */
+CARES_EXTERN ares_bool_t ares_htable_strvp_remove(ares_htable_strvp_t *htable,
+                                                  const char          *key);
+
+/*! Remove the value from the hashtable, and return the value instead of
+ *  calling the val_free passed to ares_htable_strvp_create().
+ *
+ *  \param[in] htable  Initialized hash table
+ *  \param[in] key     key to use to search
+ *  \return value in hashtable or NULL on error
+ */
+CARES_EXTERN void       *ares_htable_strvp_claim(ares_htable_strvp_t *htable,
+                                                 const char          *key);
+
+/*! Retrieve the number of keys stored in the hash table
+ *
+ *  \param[in] htable  Initialized hash table
+ *  \return count
+ */
+CARES_EXTERN size_t
+  ares_htable_strvp_num_keys(const ares_htable_strvp_t *htable);
+
+/*! @} */
+
+#endif /* __ARES__HTABLE_STRVP_H */