1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/* EINA - EFL data type library
* Copyright (C) 2002-2008 Carsten Haitzler, Jorge Luis Zapata Muga, Cedric Bail
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library;
* if not, see <http://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright (C) 2008 Peter Wehrfritz
*
* 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 shall be included in
* all copies of the Software and its Copyright notices. In addition publicly
* documented acknowledgment must be given that this software has been used if no
* source code of this software is made available publicly. This includes
* acknowledgments in either Copyright notices, Manuals, Publicity and Marketing
* documents or any documentation provided with any product containing this
* software. This License does not apply to any software that links to the
* libraries provided by this software (statically or dynamically), but only to
* the software provided.
*
* Please see the OLD-COPYING.PLAIN for a plain-english explanation of this notice
* and it's intent.
*
* 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 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.
*/
#ifndef EINA_BINSHARE_H_
#define EINA_BINSHARE_H_
#include "eina_types.h"
/**
* @page tutorial_binshare_page Binary Share Tutorial
*
*/
/**
* @defgroup Eina_Binshare_Group Binary Share
* @ingroup Eina_Data_Types_Group
*
* @brief This group discusses the functions that allow you to store one copy of an object, and use it
* throughout your program.
*
* This is a method to reduce the number of duplicated objects kept in the
* memory.
*
* For more information, you can look at the @ref tutorial_binshare_page.
*
* @{
*/
/**
* @brief Retrieves an instance of an object for use in a program.
*
* @param[in] obj The binary object to retrieve an instance of
* @param[in] olen The byte size
* @return A pointer to an instance of the object on success,
* otherwise @c NULL on failure
*
* @details This function retrieves an instance of @p obj. If @p obj is
* @c NULL, then @c NULL is returned. If @p obj is already stored, it
* is just returned and its reference counter is increased. Otherwise
* it is added to the objects to be searched and a duplicated object
* of @p obj is returned.
*
* @note This function does not check the object size, but uses the
* exact given size. This can be used to share a part of a larger
* object or subobject.
*
* @see eina_binshare_add()
*/
EAPI const void *eina_binshare_add_length(const void *obj,
unsigned int olen) EINA_WARN_UNUSED_RESULT;
/**
* @brief Increments references of the given shared object.
*
* @param[in] obj The shared object
* @return A pointer to an instance of the object on success,
* otherwise @c NULL on failure
*
* @note This is similar to eina_share_common_add(), but it's faster since it
* avoids lookups if possible, but on the down side it requires the parameter
* to be shared before, in other words, it must be the return of a previous
* eina_binshare_add().
*
* @note There is no unref since this is the work of eina_binshare_del().
*/
EAPI const void *eina_binshare_ref(const void *obj);
/**
* @brief Notes that the given object has lost an instance.
*
* @param[in] obj The given object
*
* @details This function decreases the reference counter associated to @p obj
* if it exists. If that counter reaches @c 0, the memory associated to
* @p obj is freed. If @p obj is @c NULL, the function returns
* immediately.
*
* @warning If the given pointer is not shared, bad things happen, mostly a
* segmentation fault.
*/
EAPI void eina_binshare_del(const void *obj);
/**
* @brief Notes that the given object @b must be shared.
* @details This function is a cheap way to know the length of a shared
* object.
* @param[in] obj The shared object to know the length \n
* It is safe to give @c NULL, in which case @c -1 is returned
* @return The length of the shared object
*
* @warning If the given pointer is not shared, bad things happen, mostly a
* segmentation fault. If in doubt, try strlen().
*/
EAPI int eina_binshare_length(const void *obj) EINA_WARN_UNUSED_RESULT EINA_PURE;
/**
* @brief Dumps the contents of share_common.
*
* @details This function dumps all the objects from share_common to stdout with a
* DDD: prefix per line and a memory usage summary.
*/
EAPI void eina_binshare_dump(void);
/**
* @brief Retrieves an instance of a blob for use in a program.
* @details This macro retrieves an instance of @p obj. If @p obj is
* @c NULL, then @c NULL is returned. If @p obj is already stored, it
* is just returned and its reference counter is increased. Otherwise
* it is added to the blobs to be searched and a duplicated blob
* of @p obj is returned.
* @param[in] ptr The binary blob to retrieve an instance of
* @return A pointer to an instance of the string on success,
* otherwise @c NULL on failure
*
* @note This macro essentially calls eina_binshare_add_length with ptr and sizeof(*ptr)
* as the parameters. It's useful for pointers to structures.
*
* @see eina_stringshare_add_length()
*/
#define eina_binshare_add(ptr) eina_binshare_add_length(ptr, sizeof(*ptr))
/**
* @}
*/
/**
* @}
*/
#endif /* EINA_STRINGSHARE_H_ */
|
