/usr/include/eina-1/eina/eina_iterator.h is in libeina-dev 1.8.6-2.5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | /* EINA - EFL data type library
* Copyright (C) 2008 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/>.
*/
#ifndef EINA_ITERATOR_H__
#define EINA_ITERATOR_H__
#include "eina_config.h"
#include "eina_types.h"
#include "eina_magic.h"
/**
* @page eina_iterator_example_page Eina_Iterator usage
* @dontinclude eina_iterator_01.c
*
* As always when using eina we need to include it:
* @skip #include
* @until Eina.h
*
* Here we a declare an unimpressive @ref Eina_Each_Cb "function" that prints
* some data:
* @until }
* @note Returning EINA_TRUE is important so we don't stop iterating over the
* container.
*
* And here a more interesting function, it uses an iterator to print the
* contents of a container. What's interesting about it is that it doesn't care
* the type of container, it works for anything that can provide an iterator:
* @until }
*
* And on to our main function were we declare some variables and initialize
* eina, nothing too special:
* @until eina_init
*
* Next we populate both an array and a list with our strings, for more details
* see @ref eina_list_01_example_page and @ref eina_array_01_example_page :
* @until }
*
* And now we create an array and because the first element of the container
* doesn't interest us we skip it:
* @until iterator_next
*
* Having our iterator now pointing to interesting data we go ahead and print:
* @until print_eina_container
*
* As always once data with a structure we free it, but just because we can we
* do it by asking the iterator for it's container, and then of course free the
* iterator itself:
* @until eina_iterator_free
*
* But so far you're not impressed in @ref eina_array_01_example_page an array is
* also printed, so now we go to the cool stuff and use an iterator to do same
* stuff to a list:
* @until eina_iterator_free
* @note The only significant diference to the block above is in the
* function used to create the iterator.
*
* And now we free the list and shut eina down:
* @until }
*/
/**
* @page eina_iterator_01_c Eina_Iterator usage
* @page eina_iterator_01_c Eina_Iterator usage
*
* @include eina_iterator_01.c
* @example eina_iterator_01.c
*/
/**
* @addtogroup Eina_Iterator_Group Iterator Functions
*
* @brief These functions manage iterators on containers.
*
* These functions allow to access elements of a container in a
* generic way, without knowing which container is used (a bit like
* iterators in the C++ STL). Iterators only allows sequential access
* (that is, from an element to the next one). For random access, see
* @ref Eina_Accessor_Group.
*
* Getting an iterator to access elements of a given container is done through
* the functions of that particular container. There is no function to create
* a generic iterator as iterators absolutely depend on the container. This
* means you won't find iterator creation function here, those can be found on
* the documentation of the container type you're using. Though created with
* container specific functions iterators are always deleted with the same
* function: eina_iterator_free().
*
* To get the data and iterate, use eina_iterator_next(). To call a function on
* all the elements of a container, use eina_iterator_foreach().
*
* Here an @ref eina_iterator_example_page "example"
*/
/**
* @addtogroup Eina_Content_Access_Group Content Access
*
* @{
*/
/**
* @defgroup Eina_Iterator_Group Iterator Functions
*
* @{
*/
/**
* @typedef Eina_Iterator
* Abstract type for iterators.
*/
typedef struct _Eina_Iterator Eina_Iterator;
/**
* @typedef Eina_Iterator_Next_Callback
* Type for a callback that returns the next element in a container.
*/
typedef Eina_Bool (*Eina_Iterator_Next_Callback)(Eina_Iterator *it, void **data);
/**
* @typedef Eina_Iterator_Get_Container_Callback
* Type for a callback that returns the container.
*/
typedef void *(*Eina_Iterator_Get_Container_Callback)(Eina_Iterator *it);
/**
* @typedef Eina_Iterator_Free_Callback
* Type for a callback that frees the container.
*/
typedef void (*Eina_Iterator_Free_Callback)(Eina_Iterator *it);
/**
* @typedef Eina_Iterator_Lock_Callback
* Type for a callback that lock the container.
*/
typedef Eina_Bool (*Eina_Iterator_Lock_Callback)(Eina_Iterator *it);
/**
* @struct _Eina_Iterator
* structure of an iterator
*
* If creating an iterator remember to set the type using @ref EINA_MAGIC_SET.
*/
struct _Eina_Iterator
{
#define EINA_ITERATOR_VERSION 1
int version; /**< Version of the Iterator API. */
Eina_Iterator_Next_Callback next EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; /**< Callback called when a next element is requested. */
Eina_Iterator_Get_Container_Callback get_container EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; /**< Callback called when the container is requested. */
Eina_Iterator_Free_Callback free EINA_ARG_NONNULL(1); /**< Callback called when the container is freed. */
Eina_Iterator_Lock_Callback lock EINA_WARN_UNUSED_RESULT; /**< Callback called when the container is locked. */
Eina_Iterator_Lock_Callback unlock EINA_WARN_UNUSED_RESULT; /**< Callback called when the container is unlocked. */
#define EINA_MAGIC_ITERATOR 0x98761233
EINA_MAGIC
};
/**
* @def FUNC_ITERATOR_NEXT(Function)
* Helper macro to cast @p Function to a Eina_Iterator_Next_Callback.
*/
#define FUNC_ITERATOR_NEXT(Function) ((Eina_Iterator_Next_Callback)Function)
/**
* @def FUNC_ITERATOR_GET_CONTAINER(Function)
* Helper macro to cast @p Function to a Eina_Iterator_Get_Container_Callback.
*/
#define FUNC_ITERATOR_GET_CONTAINER(Function) ((Eina_Iterator_Get_Container_Callback)Function)
/**
* @def FUNC_ITERATOR_FREE(Function)
* Helper macro to cast @p Function to a Eina_Iterator_Free_Callback.
*/
#define FUNC_ITERATOR_FREE(Function) ((Eina_Iterator_Free_Callback)Function)
/**
* @def FUNC_ITERATOR_LOCK(Function)
* Helper macro to cast @p Function to a Eina_Iterator_Lock_Callback.
*/
#define FUNC_ITERATOR_LOCK(Function) ((Eina_Iterator_Lock_Callback)Function)
/**
* @brief Free an iterator.
*
* @param iterator The iterator to free.
*
* This function frees @p iterator if it is not @c NULL;
*/
EAPI void eina_iterator_free(Eina_Iterator *iterator);
/**
* @brief Return the container of an iterator.
*
* @param iterator The iterator.
* @return The container which created the iterator.
*
* This function returns the container which created @p iterator. If
* @p iterator is @c NULL, this function returns @c NULL.
*/
EAPI void *eina_iterator_container_get(Eina_Iterator *iterator) EINA_ARG_NONNULL(1) EINA_PURE;
/**
* @brief Return the value of the current element and go to the next one.
*
* @param iterator The iterator.
* @param data The data of the element.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function returns the value of the current element pointed by
* @p iterator in @p data, then goes to the next element. If @p
* iterator is @c NULL or if a problem occurred, #EINA_FALSE is
* returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_iterator_next(Eina_Iterator *iterator,
void **data) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
/**
* @brief Iterate over the container and execute a callback on each element.
*
* @param iterator The iterator.
* @param callback The callback called on each iteration.
* @param fdata The data passed to the callback.
*
* This function iterates over the elements pointed by @p iterator,
* beginning from the current element. For Each element, the callback
* @p cb is called with the data @p fdata. If @p iterator is @c NULL,
* the function returns immediately. Also, if @p cb returns #EINA_FALSE,
* the iteration stops at that point, if @p cb returns #EINA_TRUE
* the iteration continues.
*/
EAPI void eina_iterator_foreach(Eina_Iterator *iterator,
Eina_Each_Cb callback,
const void *fdata) EINA_ARG_NONNULL(2);
/**
* @brief Lock the container of the iterator.
*
* @param iterator The iterator.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* If the container of the @p iterator permits it, it will be locked. When a
* container is locked calling eina_iterator_foreach() on it will return
* immediately. If @p iterator is @c NULL or if a problem occurred, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned. If the container isn't
* lockable, it will return #EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
EAPI Eina_Bool eina_iterator_lock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1);
/**
* @brief Unlock the container of the iterator.
*
* @param iterator The iterator.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* If the container of the @p iterator permits it and was previously
* locked, it will be unlocked. If @p iterator is @c NULL or if a
* problem occurred, #EINA_FALSE is returned, otherwise #EINA_TRUE
* is returned. If the container is not lockable, it will
* return #EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
EAPI Eina_Bool eina_iterator_unlock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1);
/**
* @def EINA_ITERATOR_FOREACH
* @brief Macro to iterate over all elements easily.
*
* @param itr The iterator to use.
* @param data Where to store * data, must be a pointer support getting
* its address since * eina_iterator_next() requires a pointer
* to pointer!
*
* This macro is a convenient way to use iterators, very similar to
* EINA_LIST_FOREACH().
*
* This macro can be used for freeing the data of a list, like in the
* following example. It has the same goal as the one documented in
* EINA_LIST_FOREACH(), but using iterators:
*
* @code
* Eina_List *list;
* Eina_Iterator *itr;
* char *data;
*
* // list is already filled,
* // its elements are just duplicated strings
*
* itr = eina_list_iterator_new(list);
* EINA_ITERATOR_FOREACH(itr, data)
* free(data);
* eina_iterator_free(itr);
* eina_list_free(list);
* @endcode
*
* @note this example is not optimal algorithm to release a list since
* it will walk the list twice, but it serves as an example. For
* optimized version use EINA_LIST_FREE()
*
* @warning The order in which the elements will be traversed depends on the
* underlying container and @b shouldn't be relied upon.
*
* @warning unless explicitly stated in functions returning iterators,
* do not modify the iterated object while you walk it, in this
* example using lists, do not remove list nodes or you might
* crash! This is not a limitiation of iterators themselves,
* rather in the iterators implementations to keep them as simple
* and fast as possible.
*/
#define EINA_ITERATOR_FOREACH(itr, \
data) while (eina_iterator_next((itr), \
(void **)(void *)&(data)))
/**
* @}
*/
/**
* @}
*/
#endif
|