/usr/include/d/gtkd-3/gstreamer/Iterator.d is in libgstreamerd-3-dev 3.7.5-2build1.
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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | /*
* This file is part of gtkD.
*
* gtkD 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 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD 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 gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gstreamer.Iterator;
private import glib.ConstructionException;
private import glib.ListG;
private import glib.MemorySlice;
private import glib.Mutex;
private import gobject.ObjectG;
private import gobject.Value;
private import gstreamer.c.functions;
public import gstreamer.c.types;
public import gstreamerc.gstreamertypes;
private import gtkd.Loader;
/**
* A GstIterator is used to retrieve multiple objects from another object in
* a threadsafe way.
*
* Various GStreamer objects provide access to their internal structures using
* an iterator.
*
* Note that if calling a GstIterator function results in your code receiving
* a refcounted object (with, say, g_value_get_object()), the refcount for that
* object will not be increased. Your code is responsible for taking a reference
* if it wants to continue using it later.
*
* The basic use pattern of an iterator is as follows:
* |[<!-- language="C" -->
* GstIterator *it = _get_iterator(object);
* GValue item = G_VALUE_INIT;
* done = FALSE;
* while (!done) {
* switch (gst_iterator_next (it, &item)) {
* case GST_ITERATOR_OK:
* ...get/use/change item here...
* g_value_reset (&item);
* break;
* case GST_ITERATOR_RESYNC:
* ...rollback changes to items...
* gst_iterator_resync (it);
* break;
* case GST_ITERATOR_ERROR:
* ...wrong parameters were given...
* done = TRUE;
* break;
* case GST_ITERATOR_DONE:
* done = TRUE;
* break;
* }
* }
* g_value_unset (&item);
* gst_iterator_free (it);
* ]|
*/
public class Iterator
{
/** the main Gtk struct */
protected GstIterator* gstIterator;
protected bool ownedRef;
/** Get the main Gtk struct */
public GstIterator* getIteratorStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gstIterator;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gstIterator;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GstIterator* gstIterator, bool ownedRef = false)
{
this.gstIterator = gstIterator;
this.ownedRef = ownedRef;
}
~this ()
{
if ( Linker.isLoaded(LIBRARY_GSTREAMER) && ownedRef )
gst_iterator_free(gstIterator);
}
/** */
public static GType getType()
{
return gst_iterator_get_type();
}
/**
* Create a new iterator. This function is mainly used for objects
* implementing the next/resync/free function to iterate a data structure.
*
* For each item retrieved, the @item function is called with the lock
* held. The @free function is called when the iterator is freed.
*
* Params:
* size = the size of the iterator structure
* type = #GType of children
* lock = pointer to a #GMutex.
* masterCookie = pointer to a guint32 that is changed when the items in the
* iterator changed.
* copy = copy function
* next = function to get next item
* item = function to call on each item retrieved
* resync = function to resync the iterator
* free = function to free the iterator
*
* Returns: the new #GstIterator.
*
* MT safe.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(uint size, GType type, Mutex lock, uint* masterCookie, GstIteratorCopyFunction copy, GstIteratorNextFunction next, GstIteratorItemFunction item, GstIteratorResyncFunction resync, GstIteratorFreeFunction free)
{
auto p = gst_iterator_new(size, type, (lock is null) ? null : lock.getMutexStruct(), masterCookie, copy, next, item, resync, free);
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GstIterator*) p);
}
/**
* Create a new iterator designed for iterating @list.
*
* The list you iterate is usually part of a data structure @owner and is
* protected with @lock.
*
* The iterator will use @lock to retrieve the next item of the list and it
* will then call the @item function before releasing @lock again.
*
* When a concurrent update to the list is performed, usually by @owner while
* holding @lock, @master_cookie will be updated. The iterator implementation
* will notice the update of the cookie and will return %GST_ITERATOR_RESYNC to
* the user of the iterator in the next call to gst_iterator_next().
*
* Params:
* type = #GType of elements
* lock = pointer to a #GMutex protecting the list.
* masterCookie = pointer to a guint32 that is incremented when the list
* is changed.
* list = pointer to the list
* owner = object owning the list
* item = function to call on each item retrieved
*
* Returns: the new #GstIterator for @list.
*
* MT safe.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GType type, Mutex lock, uint* masterCookie, ref ListG list, ObjectG owner, GstIteratorItemFunction item)
{
GList* outlist = list.getListGStruct();
auto p = gst_iterator_new_list(type, (lock is null) ? null : lock.getMutexStruct(), masterCookie, &outlist, (owner is null) ? null : owner.getObjectGStruct(), item);
if(p is null)
{
throw new ConstructionException("null returned by new_list");
}
list = new ListG(outlist);
this(cast(GstIterator*) p);
}
/**
* This #GstIterator is a convenient iterator for the common
* case where a #GstIterator needs to be returned but only
* a single object has to be considered. This happens often
* for the #GstPadIterIntLinkFunction.
*
* Params:
* type = #GType of the passed object
* object = object that this iterator should return
*
* Returns: the new #GstIterator for @object.
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(GType type, Value object)
{
auto p = gst_iterator_new_single(type, (object is null) ? null : object.getValueStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_single");
}
this(cast(GstIterator*) p);
}
/**
* Copy the iterator and its state.
*
* Returns: a new copy of @it.
*/
public Iterator copy()
{
auto p = gst_iterator_copy(gstIterator);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Iterator)(cast(GstIterator*) p, true);
}
/**
* Create a new iterator from an existing iterator. The new iterator
* will only return those elements that match the given compare function @func.
* The first parameter that is passed to @func is the #GValue of the current
* iterator element and the second parameter is @user_data. @func should
* return 0 for elements that should be included in the filtered iterator.
*
* When this iterator is freed, @it will also be freed.
*
* Params:
* func = the compare function to select elements
* userData = user data passed to the compare function
*
* Returns: a new #GstIterator.
*
* MT safe.
*/
public Iterator filter(GCompareFunc func, Value userData)
{
auto p = gst_iterator_filter(gstIterator, func, (userData is null) ? null : userData.getValueStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Iterator)(cast(GstIterator*) p, true);
}
/**
* Find the first element in @it that matches the compare function @func.
* @func should return 0 when the element is found. The first parameter
* to @func will be the current element of the iterator and the
* second parameter will be @user_data.
* The result will be stored in @elem if a result is found.
*
* The iterator will not be freed.
*
* This function will return %FALSE if an error happened to the iterator
* or if the element wasn't found.
*
* Params:
* func = the compare function to use
* elem = pointer to a #GValue where to store the result
* userData = user data passed to the compare function
*
* Returns: Returns %TRUE if the element was found, else %FALSE.
*
* MT safe.
*/
public bool findCustom(GCompareFunc func, out Value elem, void* userData)
{
GValue* outelem = sliceNew!GValue();
auto p = gst_iterator_find_custom(gstIterator, func, outelem, userData) != 0;
elem = ObjectG.getDObject!(Value)(outelem, true);
return p;
}
/**
* Folds @func over the elements of @iter. That is to say, @func will be called
* as @func (object, @ret, @user_data) for each object in @it. The normal use
* of this procedure is to accumulate the results of operating on the objects in
* @ret.
*
* This procedure can be used (and is used internally) to implement the
* gst_iterator_foreach() and gst_iterator_find_custom() operations.
*
* The fold will proceed as long as @func returns %TRUE. When the iterator has no
* more arguments, %GST_ITERATOR_DONE will be returned. If @func returns %FALSE,
* the fold will stop, and %GST_ITERATOR_OK will be returned. Errors or resyncs
* will cause fold to return %GST_ITERATOR_ERROR or %GST_ITERATOR_RESYNC as
* appropriate.
*
* The iterator will not be freed.
*
* Params:
* func = the fold function
* ret = the seed value passed to the fold function
* userData = user data passed to the fold function
*
* Returns: A #GstIteratorResult, as described above.
*
* MT safe.
*/
public GstIteratorResult fold(GstIteratorFoldFunction func, Value ret, void* userData)
{
return gst_iterator_fold(gstIterator, func, (ret is null) ? null : ret.getValueStruct(), userData);
}
/**
* Iterate over all element of @it and call the given function @func for
* each element.
*
* Params:
* func = the function to call for each element.
* userData = user data passed to the function
*
* Returns: the result call to gst_iterator_fold(). The iterator will not be
* freed.
*
* MT safe.
*/
public GstIteratorResult foreac(GstIteratorForeachFunction func, void* userData)
{
return gst_iterator_foreach(gstIterator, func, userData);
}
/**
* Free the iterator.
*
* MT safe.
*/
public void free()
{
gst_iterator_free(gstIterator);
ownedRef = false;
}
/**
* Get the next item from the iterator in @elem.
*
* Only when this function returns %GST_ITERATOR_OK, @elem will contain a valid
* value. @elem must have been initialized to the type of the iterator or
* initialized to zeroes with g_value_unset(). The caller is responsible for
* unsetting or resetting @elem with g_value_unset() or g_value_reset()
* after usage.
*
* When this function returns %GST_ITERATOR_DONE, no more elements can be
* retrieved from @it.
*
* A return value of %GST_ITERATOR_RESYNC indicates that the element list was
* concurrently updated. The user of @it should call gst_iterator_resync() to
* get the newly updated list.
*
* A return value of %GST_ITERATOR_ERROR indicates an unrecoverable fatal error.
*
* Params:
* elem = pointer to hold next element
*
* Returns: The result of the iteration. Unset @elem after usage.
*
* MT safe.
*/
public GstIteratorResult next(out Value elem)
{
GValue* outelem = sliceNew!GValue();
auto p = gst_iterator_next(gstIterator, outelem);
elem = ObjectG.getDObject!(Value)(outelem, true);
return p;
}
/**
* Pushes @other iterator onto @it. All calls performed on @it are
* forwarded to @other. If @other returns %GST_ITERATOR_DONE, it is
* popped again and calls are handled by @it again.
*
* This function is mainly used by objects implementing the iterator
* next function to recurse into substructures.
*
* When gst_iterator_resync() is called on @it, @other will automatically be
* popped.
*
* MT safe.
*
* Params:
* other = The #GstIterator to push
*/
public void push(Iterator other)
{
gst_iterator_push(gstIterator, (other is null) ? null : other.getIteratorStruct());
}
/**
* Resync the iterator. this function is mostly called
* after gst_iterator_next() returned %GST_ITERATOR_RESYNC.
*
* When an iterator was pushed on @it, it will automatically be popped again
* with this function.
*
* MT safe.
*/
public void resync()
{
gst_iterator_resync(gstIterator);
}
}
|