sopc_dict.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel 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.
 */
 
#ifndef SOPC_DICT_H_
#define SOPC_DICT_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
typedef struct _SOPC_Dict SOPC_Dict;
 
typedef void SOPC_Dict_Free_Fct(uintptr_t data);
 
typedef uint64_t SOPC_Dict_KeyHash_Fct(const uintptr_t data);
 
typedef bool SOPC_Dict_KeyEqual_Fct(const uintptr_t a, const uintptr_t b);
 
typedef void SOPC_Dict_ForEach_Fct(const uintptr_t key, uintptr_t value, uintptr_t user_data);
 
SOPC_Dict* SOPC_Dict_Create(uintptr_t empty_key,
                            SOPC_Dict_KeyHash_Fct* key_hash,
                            SOPC_Dict_KeyEqual_Fct* key_equal,
                            SOPC_Dict_Free_Fct* key_free,
                            SOPC_Dict_Free_Fct* value_free);
 
void SOPC_Dict_Delete(SOPC_Dict* d);
 
bool SOPC_Dict_Reserve(SOPC_Dict* d, size_t n_items);
 
void SOPC_Dict_SetTombstoneKey(SOPC_Dict* d, uintptr_t tombstone_key);
 
bool SOPC_Dict_Insert(SOPC_Dict* d, uintptr_t key, uintptr_t value);
 
uintptr_t SOPC_Dict_Get(const SOPC_Dict* d, const uintptr_t key, bool* found);
 
uintptr_t SOPC_Dict_GetKey(const SOPC_Dict* d, const uintptr_t key, bool* found);
 
void SOPC_Dict_Remove(SOPC_Dict* d, const uintptr_t key);
 
SOPC_Dict_Free_Fct* SOPC_Dict_GetKeyFreeFunc(const SOPC_Dict* d);
 
void SOPC_Dict_SetKeyFreeFunc(SOPC_Dict* d, SOPC_Dict_Free_Fct* func);
 
SOPC_Dict_Free_Fct* SOPC_Dict_GetValueFreeFunc(const SOPC_Dict* d);
 
void SOPC_Dict_SetValueFreeFunc(SOPC_Dict* d, SOPC_Dict_Free_Fct* func);
 
size_t SOPC_Dict_Size(const SOPC_Dict* d);
 
size_t SOPC_Dict_Capacity(const SOPC_Dict* d);
 
void SOPC_Dict_ForEach(SOPC_Dict* d, SOPC_Dict_ForEach_Fct* func, uintptr_t user_data);
 
#endif /* SOPC_DICT_H_ */