/*
|
* Copyright (c) 2012-2019 Belledonne Communications SARL.
|
*
|
* This file is part of belle-sip.
|
*
|
* This program is free software: you can redistribute it and/or modify
|
* it under the terms of the GNU General Public License as published by
|
* the Free Software Foundation, either version 3 of the License, or
|
* (at your option) any later version.
|
*
|
* This program is distributed in the hope that it will be useful,
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
* GNU General Public License for more details.
|
*
|
* You should have received a copy of the GNU General Public License
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
*/
|
|
#ifndef DICT_H
|
#define DICT_H
|
|
#ifndef _WIN32
|
#include <sys/types.h>
|
#endif
|
|
|
#include "belle-sip/object.h"
|
|
BELLE_SIP_BEGIN_DECLS
|
|
typedef struct belle_sip_dict belle_sip_dict_t;
|
#define BELLE_SIP_DICT(obj) BELLE_SIP_CAST(obj,belle_sip_dict_t)
|
|
/**
|
* @brief belle_sip_dict_create
|
* @return an instance of a belle_sip_dict_t object.
|
* @note The object is not owned by default.
|
* @note all belle_sip_dict_set_* functions will overwrite existing values.
|
*/
|
BELLESIP_EXPORT belle_sip_dict_t* belle_sip_dict_create(void);
|
|
/**
|
* @brief belle_sip_dict_set_int stores an integer into the dictionary
|
* @param obj the dictionary instance
|
* @param key the name of the integer to store
|
* @param value value to store
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_set_int(belle_sip_dict_t* obj, const char* key, int value);
|
|
/**
|
* @brief belle_sip_dict_get_int retrieves an integer from the dictionary
|
* @param obj the dictionary instance
|
* @param key name of the integer to retrieve
|
* @param default_value value to return if the key is not found
|
* @return the searched integer if the key exists, default_value if not found
|
*/
|
BELLESIP_EXPORT int belle_sip_dict_get_int(belle_sip_dict_t* obj, const char* key, int default_value);
|
|
/**
|
* @brief belle_sip_dict_set_string stores a string into the dictionary
|
* @param obj the dictionary instance
|
* @param key the name of the string to store
|
* @param value value to store
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_set_string(belle_sip_dict_t* obj, const char* key, const char*value);
|
/**
|
* @brief belle_sip_dict_get_string retrieves a string from the dictionary
|
* @param obj the dictionary instance
|
* @param key the name of the string to retrieve
|
* @param default_value
|
* @return the searched string if the key exists, default_value if not found
|
*/
|
BELLESIP_EXPORT const char* belle_sip_dict_get_string(belle_sip_dict_t* obj, const char* key, const char* default_value);
|
|
/**
|
* @brief belle_sip_dict_set_int64 stores an int64 in the dictionary
|
* @param obj the dictionary instance
|
* @param key the name of the integer to store
|
* @param value value to store
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_set_int64(belle_sip_dict_t* obj, const char* key, int64_t value);
|
|
/**
|
* @brief belle_sip_dict_get_int64 retrieves an int64 from the dictionary
|
* @param obj the dictionary instance
|
* @param key the name of the integer to retrieve
|
* @param default_value value to return if the key is not found
|
* @return the searched int64 if the key exists, default_value if not found
|
*/
|
BELLESIP_EXPORT int64_t belle_sip_dict_get_int64(belle_sip_dict_t* obj, const char* key, int64_t default_value);
|
|
/**
|
* @brief belle_sip_dict_remove will erase the value for a key
|
* @param obj the dictionary instance
|
* @param key the name of the integer to remove
|
* @return 0 if the key was found, 1 otherwise
|
*/
|
BELLESIP_EXPORT int belle_sip_dict_remove(belle_sip_dict_t* obj, const char* key);
|
|
/**
|
* @brief belle_sip_dict_clear will clear the object's dictionary.
|
* @param obj the dictionary instance
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_clear(belle_sip_dict_t* obj);
|
|
/**
|
* Clones the source dictionary into the dst dictionary. The dst dictionary is cleared before the cloning
|
* is done.
|
* @param src source dictionary
|
* @param dst destination dictionary
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_clone( const belle_sip_dict_t* src, belle_sip_dict_t* dst);
|
|
/**
|
* Merge the source dictionary into the destination dictionary.
|
*
|
* Same function as #belle_sip_dict_clone, except the destination dictionary is not cleared before inserting the source data.
|
* This overwrites common keys, and keeps existing keys.
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_merge( const belle_sip_dict_t* src, belle_sip_dict_t* dst);
|
|
/**
|
* @brief belle_sip_dict_haskey tells if a key exists in the dictionary.
|
* @param obj the dictionary instance
|
* @param key the key to look for
|
* @return 1 if the key exists, 0 otherwise
|
* @todo create unit test
|
*/
|
BELLESIP_EXPORT int belle_sip_dict_haskey(const belle_sip_dict_t* obj, const char* key);
|
|
/**
|
* Apply a function for all keys stored in the dictionary
|
*/
|
BELLESIP_EXPORT void belle_sip_dict_foreach(const belle_sip_dict_t* obj, void (*apply_func)(const char*, void*, void*), void* userdata);
|
|
BELLE_SIP_END_DECLS
|
|
#endif // DICT_H
|
