Utilities/cmcurl/lib/u32_ptrset.h

#ifndef HEADER_CURL_U32_PTRSET_H
#define HEADER_CURL_U32_PTRSET_H
/***************************************************************************
 *                                  _   _ ____  _
 *  Project                     ___| | | |  _ \| |
 *                             / __| | | | |_) | |
 *                            | (__| |_| |  _ <| |___
 *                             \___|\___/|_| \_\_____|
 *
 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
 *
 * This software is licensed as described in the file COPYING, which
 * you should have received as part of this distribution. The terms
 * are also available at https://curl.se/docs/copyright.html.
 *
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
 * copies of the Software, and permit persons to whom the Software is
 * furnished to do so, under the terms of the COPYING file.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 * SPDX-License-Identifier: curl
 *
 ***************************************************************************/
#include "curl_setup.h"

typedef void Curl_u32_ptrset_dtor(uint32_t id, void *ptr);

/* A set that can hold up to INT32_MAX+1 pointers identified by an `id'.
 * Setting a pointer for an existing id replaces the previous one.
 * Getting the pointer for an id not in the set returns NULL.
 * Setting an id to NULL unsets the id.
 */
struct u32_ptrset {
  void **data; /* #slots array of pointers */
  uint32_t *ids; /* #slots array of `id` values */
  uint32_t *psl; /* #slots array of "probe sequence length" values */
  uint32_t slotmask;
  uint32_t count;
  Curl_u32_ptrset_dtor *dtor;
  uint8_t slotbits;
#ifdef DEBUGBUILD
  int32_t init;
#endif
};

void Curl_u32_ptrset_init(struct u32_ptrset *set,
                          Curl_u32_ptrset_dtor *dtor);
void Curl_u32_ptrset_clear(struct u32_ptrset *set);

uint32_t Curl_u32_ptrset_count(struct u32_ptrset *set);

void *Curl_u32_ptrset_get(struct u32_ptrset *set, uint32_t id);

/* Set pointer for id. */
CURLcode Curl_u32_ptrset_set(struct u32_ptrset *set,
                             uint32_t id, void *ptr);

void Curl_u32_ptrset_unset(struct u32_ptrset *set, uint32_t id);

typedef bool Curl_u32_ptrset_visit_cb(uint32_t id, void *ptr,
                                       void *user_data);

/* Visit all entries in the set until the callback returns FALSE */
void Curl_u32_ptrset_visit(struct u32_ptrset *set,
                            Curl_u32_ptrset_visit_cb *cb,
                            void *user_data);

#endif /* HEADER_CURL_U32_PTRSET_H */