git.sesse.net Git - vlc/blob - src/misc/objects.c

   1 /*****************************************************************************
   2  * objects.c: vlc_object_t handling
   3  *****************************************************************************
   4  * Copyright (C) 2004-2008 the VideoLAN team
   5  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 /**
  24  * \file
  25  * This file contains the functions to handle the vlc_object_t type
  26  *
  27  * Unless otherwise stated, functions in this file are not cancellation point.
  28  * All functions in this file are safe w.r.t. deferred cancellation.
  29  */
  30
  31
  32 /*****************************************************************************
  33  * Preamble
  34  *****************************************************************************/
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 #include <vlc_common.h>
  40
  41 #include "../libvlc.h"
  42 #include <vlc_vout.h>
  43 #include <vlc_aout.h>
  44 #include "audio_output/aout_internal.h"
  45
  46 #include <vlc_access.h>
  47 #include <vlc_demux.h>
  48 #include <vlc_stream.h>
  49
  50 #include <vlc_sout.h>
  51 #include "stream_output/stream_output.h"
  52
  53 #include "vlc_interface.h"
  54 #include "vlc_codec.h"
  55 #include "vlc_filter.h"
  56
  57 #include "variables.h"
  58 #ifndef WIN32
  59 # include <unistd.h>
  60 #else
  61 # include <io.h>
  62 # include <fcntl.h>
  63 # include <errno.h> /* ENOSYS */
  64 #endif
  65 #include <assert.h>
  66
  67 /*****************************************************************************
  68  * Local prototypes
  69  *****************************************************************************/
  70 static int  DumpCommand( vlc_object_t *, char const *,
  71                          vlc_value_t, vlc_value_t, void * );
  72
  73 static vlc_object_t * FindObject    ( vlc_object_t *, int, int );
  74 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
  75 static void           PrintObject   ( vlc_object_t *, const char * );
  76 static void           DumpStructure ( vlc_object_t *, int, char * );
  77
  78 static vlc_list_t   * NewList       ( int );
  79 static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
  80 /*static void           ListAppend    ( vlc_list_t *, vlc_object_t * );*/
  81 static int            CountChildren ( vlc_object_t *, int );
  82 static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
  83
  84 static void vlc_object_destroy( vlc_object_t *p_this );
  85 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
  86 static void vlc_object_dump( vlc_object_t *p_this )
  87
  88 /*****************************************************************************
  89  * Local structure lock
  90  *****************************************************************************/
  91 static vlc_mutex_t structure_lock;
  92 static unsigned    object_counter = 0;
  93
  94 static void close_nocancel (int fd)
  95 {
  96     int canc = vlc_savecancel ();
  97     close (fd);
  98     vlc_restorecancel (canc);
  99 }
 100
 101 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
 102                            int i_type, const char *psz_type )
 103 {
 104     vlc_object_t *p_new;
 105     vlc_object_internals_t *p_priv;
 106
 107     /* NOTE:
 108      * VLC objects are laid out as follow:
 109      * - first the LibVLC-private per-object data,
 110      * - then VLC_COMMON members from vlc_object_t,
 111      * - finally, the type-specific data (if any).
 112      *
 113      * This function initializes the LibVLC and common data,
 114      * and zeroes the rest.
 115      */
 116     p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
 117     if( p_priv == NULL )
 118         return NULL;
 119
 120     assert (i_size >= sizeof (vlc_object_t));
 121     p_new = (vlc_object_t *)(p_priv + 1);
 122
 123     p_new->i_object_type = i_type;
 124     p_new->psz_object_type = psz_type;
 125     p_new->psz_object_name = NULL;
 126
 127     p_new->b_die = false;
 128     p_new->b_error = false;
 129     p_new->b_dead = false;
 130     p_new->b_force = false;
 131
 132     p_new->psz_header = NULL;
 133
 134     if (p_this)
 135         p_new->i_flags = p_this->i_flags
 136             & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
 137
 138     p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
 139
 140     if( !p_priv->p_vars )
 141     {
 142         free( p_priv );
 143         return NULL;
 144     }
 145
 146     if( p_this == NULL )
 147     {
 148         if( i_type == VLC_OBJECT_LIBVLC )
 149             p_new->p_libvlc = (libvlc_int_t*)p_new;
 150         else
 151         {
 152             p_new->p_libvlc = NULL;
 153             vlc_mutex_init( &structure_lock );
 154         }
 155
 156         p_this = p_priv->next = p_priv->prev = p_new;
 157     }
 158     else
 159         p_new->p_libvlc = p_this->p_libvlc;
 160
 161     vlc_spin_init( &p_priv->ref_spin );
 162     p_priv->i_refcount = 1;
 163     p_priv->pf_destructor = NULL;
 164     p_priv->b_thread = false;
 165     p_new->p_parent = NULL;
 166     p_priv->pp_children = NULL;
 167     p_priv->i_children = 0;
 168
 169     p_new->p_private = NULL;
 170
 171     /* Initialize mutexes and condvars */
 172     vlc_mutex_init( &p_priv->lock );
 173     vlc_cond_init( p_new, &p_priv->wait );
 174     vlc_mutex_init( &p_priv->var_lock );
 175     vlc_spin_init( &p_priv->spin );
 176     p_priv->pipes[0] = p_priv->pipes[1] = -1;
 177
 178     p_priv->next = p_this;
 179     vlc_mutex_lock( &structure_lock );
 180     p_priv->prev = vlc_internals (p_this)->prev;
 181     vlc_internals (p_this)->prev = p_new;
 182     vlc_internals (p_priv->prev)->next = p_new;
 183     p_new->i_object_id = object_counter++; /* fetch THEN increment */
 184     vlc_mutex_unlock( &structure_lock );
 185
 186     if( i_type == VLC_OBJECT_LIBVLC )
 187     {
 188         int canc = vlc_savecancel ();
 189         var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 190         var_AddCallback( p_new, "list", DumpCommand, NULL );
 191         var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 192         var_AddCallback( p_new, "tree", DumpCommand, NULL );
 193         var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 194         var_AddCallback( p_new, "vars", DumpCommand, NULL );
 195         vlc_restorecancel (canc);
 196     }
 197
 198     return p_new;
 199 }
 200
 201
 202 /**
 203  * Allocates and initializes a vlc object.
 204  *
 205  * @param i_type known object type (all of them are negative integer values),
 206  *               or object byte size (always positive).
 207  *
 208  * @return the new object, or NULL on error.
 209  */
 210 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 211 {
 212     const char   * psz_type;
 213     size_t         i_size;
 214
 215     switch( i_type )
 216     {
 217         case VLC_OBJECT_INTF:
 218             i_size = sizeof(intf_thread_t);
 219             psz_type = "interface";
 220             break;
 221         case VLC_OBJECT_DECODER:
 222             i_size = sizeof(decoder_t);
 223             psz_type = "decoder";
 224             break;
 225         case VLC_OBJECT_PACKETIZER:
 226             i_size = sizeof(decoder_t);
 227             psz_type = "packetizer";
 228             break;
 229         case VLC_OBJECT_ENCODER:
 230             i_size = sizeof(encoder_t);
 231             psz_type = "encoder";
 232             break;
 233         case VLC_OBJECT_AOUT:
 234             i_size = sizeof(aout_instance_t);
 235             psz_type = "audio output";
 236             break;
 237         case VLC_OBJECT_OPENGL:
 238             i_size = sizeof( vout_thread_t );
 239             psz_type = "opengl";
 240             break;
 241         case VLC_OBJECT_ANNOUNCE:
 242             i_size = sizeof( announce_handler_t );
 243             psz_type = "announce";
 244             break;
 245         default:
 246             assert( i_type > 0 ); /* unknown type?! */
 247             i_size = i_type;
 248             i_type = VLC_OBJECT_GENERIC;
 249             psz_type = "generic";
 250             break;
 251     }
 252
 253     return vlc_custom_create( p_this, i_size, i_type, psz_type );
 254 }
 255
 256
 257 /**
 258  ****************************************************************************
 259  * Set the destructor of a vlc object
 260  *
 261  * This function sets the destructor of the vlc object. It will be called
 262  * when the object is destroyed when the its refcount reaches 0.
 263  * (It is called by the internal function vlc_object_destroy())
 264  *****************************************************************************/
 265 void __vlc_object_set_destructor( vlc_object_t *p_this,
 266                                   vlc_destructor_t pf_destructor )
 267 {
 268     vlc_object_internals_t *p_priv = vlc_internals(p_this );
 269     p_priv->pf_destructor = pf_destructor;
 270 }
 271
 272 /**
 273  ****************************************************************************
 274  * Destroy a vlc object (Internal)
 275  *
 276  * This function destroys an object that has been previously allocated with
 277  * vlc_object_create. The object's refcount must be zero and it must not be
 278  * attached to other objects in any way.
 279  *
 280  * This function must be called with cancellation disabled (currently).
 281  *****************************************************************************/
 282 static void vlc_object_destroy( vlc_object_t *p_this )
 283 {
 284     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 285
 286     /* Objects are always detached beforehand */
 287     assert( !p_this->p_parent );
 288
 289     /* Send a kill to the object's thread if applicable */
 290     vlc_object_kill( p_this );
 291
 292     /* Call the custom "subclass" destructor */
 293     if( p_priv->pf_destructor )
 294         p_priv->pf_destructor( p_this );
 295
 296     /* Any thread must have been cleaned up at this point. */
 297     assert( !p_priv->b_thread );
 298
 299     /* Destroy the associated variables, starting from the end so that
 300      * no memmove calls have to be done. */
 301     while( p_priv->i_vars )
 302     {
 303         var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
 304     }
 305
 306     free( p_priv->p_vars );
 307     vlc_mutex_destroy( &p_priv->var_lock );
 308
 309     free( p_this->psz_header );
 310
 311     if( p_this->p_libvlc == NULL )
 312         /* We are the global object ... no need to lock. */
 313         vlc_mutex_destroy( &structure_lock );
 314
 315     FREENULL( p_this->psz_object_name );
 316
 317 #if defined(WIN32) || defined(UNDER_CE)
 318     /* if object has an associated thread, close it now */
 319     if( p_priv->thread_id )
 320        CloseHandle(p_priv->thread_id);
 321 #endif
 322
 323     vlc_spin_destroy( &p_priv->ref_spin );
 324     vlc_mutex_destroy( &p_priv->lock );
 325     vlc_cond_destroy( &p_priv->wait );
 326     vlc_spin_destroy( &p_priv->spin );
 327     if( p_priv->pipes[1] != -1 )
 328         close( p_priv->pipes[1] );
 329     if( p_priv->pipes[0] != -1 )
 330         close( p_priv->pipes[0] );
 331
 332     free( p_priv );
 333 }
 334
 335
 336 /** Inter-object signaling */
 337
 338 void __vlc_object_lock( vlc_object_t *obj )
 339 {
 340     vlc_mutex_lock( &(vlc_internals(obj)->lock) );
 341 }
 342
 343 void __vlc_object_unlock( vlc_object_t *obj )
 344 {
 345     vlc_assert_locked( &(vlc_internals(obj)->lock) );
 346     vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
 347 }
 348
 349 #ifdef WIN32
 350 # include <winsock2.h>
 351 # include <ws2tcpip.h>
 352
 353 /**
 354  * select()-able pipes emulated using Winsock
 355  */
 356 static int pipe (int fd[2])
 357 {
 358     SOCKADDR_IN addr;
 359     int addrlen = sizeof (addr);
 360
 361     SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
 362            c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
 363     if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
 364         goto error;
 365
 366     memset (&addr, 0, sizeof (addr));
 367     addr.sin_family = AF_INET;
 368     addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 369     if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
 370      || getsockname (l, (PSOCKADDR)&addr, &addrlen)
 371      || listen (l, 1)
 372      || connect (c, (PSOCKADDR)&addr, addrlen))
 373         goto error;
 374
 375     a = accept (l, NULL, NULL);
 376     if (a == INVALID_SOCKET)
 377         goto error;
 378
 379     closesocket (l);
 380     //shutdown (a, 0);
 381     //shutdown (c, 1);
 382     fd[0] = c;
 383     fd[1] = a;
 384     return 0;
 385
 386 error:
 387     if (l != INVALID_SOCKET)
 388         closesocket (l);
 389     if (c != INVALID_SOCKET)
 390         closesocket (c);
 391     return -1;
 392 }
 393
 394 #undef  read
 395 #define read( a, b, c )  recv (a, b, c, 0)
 396 #undef  write
 397 #define write( a, b, c ) send (a, b, c, 0)
 398 #undef  close
 399 #define close( a )       closesocket (a)
 400 #endif /* WIN32 */
 401
 402 /**
 403  * Returns the readable end of a pipe that becomes readable once termination
 404  * of the object is requested (vlc_object_kill()).
 405  * This can be used to wake-up out of a select() or poll() event loop, such
 406  * typically when doing network I/O.
 407  *
 408  * Note that the pipe will remain the same for the lifetime of the object.
 409  * DO NOT read the pipe nor close it yourself. Ever.
 410  *
 411  * @param obj object that would be "killed"
 412  * @return a readable pipe descriptor, or -1 on error.
 413  */
 414 int __vlc_object_waitpipe( vlc_object_t *obj )
 415 {
 416     int pfd[2] = { -1, -1 };
 417     vlc_object_internals_t *internals = vlc_internals( obj );
 418     bool killed = false;
 419
 420     vlc_spin_lock (&internals->spin);
 421     if (internals->pipes[0] == -1)
 422     {
 423         /* This can only ever happen if someone killed us without locking: */
 424         assert (internals->pipes[1] == -1);
 425         vlc_spin_unlock (&internals->spin);
 426
 427         if (pipe (pfd))
 428             return -1;
 429
 430         vlc_spin_lock (&internals->spin);
 431         if (internals->pipes[0] == -1)
 432         {
 433             internals->pipes[0] = pfd[0];
 434             internals->pipes[1] = pfd[1];
 435             pfd[0] = pfd[1] = -1;
 436         }
 437         killed = obj->b_die;
 438     }
 439     vlc_spin_unlock (&internals->spin);
 440
 441     if (killed)
 442     {
 443         /* Race condition: vlc_object_kill() already invoked! */
 444         int fd;
 445
 446         vlc_spin_lock (&internals->spin);
 447         fd = internals->pipes[1];
 448         internals->pipes[1] = -1;
 449         vlc_spin_unlock (&internals->spin);
 450
 451         msg_Dbg (obj, "waitpipe: object already dying");
 452         if (fd != -1)
 453             close (fd);
 454     }
 455
 456     /* Race condition: two threads call pipe() - unlikely */
 457     if (pfd[0] != -1)
 458         close (pfd[0]);
 459     if (pfd[1] != -1)
 460         close (pfd[1]);
 461
 462     return internals->pipes[0];
 463 }
 464
 465
 466 /**
 467  * Waits for the object to be signaled (using vlc_object_signal()).
 468  * It is assumed that the caller has locked the object. This function will
 469  * unlock the object, and lock it again before returning.
 470  * If the object was signaled before the caller locked the object, it is
 471  * undefined whether the signal will be lost or will wake the process.
 472  *
 473  * This function is a cancellation point. In case of cancellation, the object
 474  * will be in locked state.
 475  *
 476  * @return true if the object is dying and should terminate.
 477  */
 478 void __vlc_object_wait( vlc_object_t *obj )
 479 {
 480     vlc_object_internals_t *priv = vlc_internals( obj );
 481     vlc_assert_locked( &priv->lock);
 482     vlc_cond_wait( &priv->wait, &priv->lock );
 483 }
 484
 485
 486 /**
 487  * Waits for the object to be signaled (using vlc_object_signal()), or for
 488  * a timer to expire. It is asserted that the caller holds the object lock.
 489  *
 490  * This function is a cancellation point. In case of cancellation, the object
 491  * will be in locked state.
 492  *
 493  * @return 0 if the object was signaled before the timer expiration, or
 494  * ETIMEDOUT if the timer expired without any signal.
 495  */
 496 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
 497 {
 498     vlc_object_internals_t *priv = vlc_internals( obj );
 499     vlc_assert_locked( &priv->lock);
 500     return vlc_cond_timedwait( &priv->wait, &priv->lock, deadline );
 501 }
 502
 503
 504 /**
 505  * Signals an object for which the lock is held.
 506  * At least one thread currently sleeping in vlc_object_wait() or
 507  * vlc_object_timedwait() will wake up, assuming that there is at least one
 508  * such thread in the first place. Otherwise, it is undefined whether the
 509  * signal will be lost or will wake up one or more thread later.
 510  */
 511 void __vlc_object_signal_unlocked( vlc_object_t *obj )
 512 {
 513     vlc_assert_locked (&(vlc_internals(obj)->lock));
 514     vlc_cond_signal( &(vlc_internals(obj)->wait) );
 515 }
 516
 517
 518 /**
 519  * Requests termination of an object.
 520  * If the object is LibVLC, also request to terminate all its children.
 521  */
 522 void __vlc_object_kill( vlc_object_t *p_this )
 523 {
 524     vlc_object_internals_t *priv = vlc_internals( p_this );
 525     int fd;
 526
 527     vlc_thread_cancel( p_this );
 528     vlc_object_lock( p_this );
 529     p_this->b_die = true;
 530
 531     vlc_spin_lock (&priv->spin);
 532     fd = priv->pipes[1];
 533     priv->pipes[1] = -1;
 534     vlc_spin_unlock (&priv->spin);
 535
 536     if( fd != -1 )
 537     {
 538         msg_Dbg (p_this, "waitpipe: object killed");
 539         close_nocancel (fd);
 540     }
 541
 542     vlc_object_signal_unlocked( p_this );
 543     /* This also serves as a memory barrier toward vlc_object_alive(): */
 544     vlc_object_unlock( p_this );
 545 }
 546
 547
 548 /**
 549  * Find an object given its ID.
 550  *
 551  * This function looks for the object whose i_object_id field is i_id.
 552  * This function is slow, and often used to hide bugs. Do not use it.
 553  * If you need to retain reference to an object, yield the object pointer with
 554  * vlc_object_yield(), use the pointer as your reference, and call
 555  * vlc_object_release() when you're done.
 556  */
 557 void * vlc_object_get( libvlc_int_t *p_anchor, int i_id )
 558 {
 559     vlc_object_t *obj = NULL;
 560 #ifndef NDEBUG
 561     int canc = vlc_savecancel ();
 562     fprintf (stderr, "Use of deprecated vlc_object_get(%d)\n", i_id);
 563     vlc_restorecancel (canc);
 564 #endif
 565     vlc_mutex_lock( &structure_lock );
 566
 567     for( obj = vlc_internals (p_anchor)->next;
 568          obj != VLC_OBJECT (p_anchor);
 569          obj = vlc_internals (obj)->next )
 570     {
 571         if( obj->i_object_id == i_id )
 572         {
 573             vlc_object_yield( obj );
 574             goto out;
 575         }
 576     }
 577     obj = NULL;
 578 #ifndef NDEBUG
 579     fprintf (stderr, "Object %d does not exist\n", i_id);
 580 #endif
 581 out:
 582     vlc_mutex_unlock( &structure_lock );
 583     return obj;
 584 }
 585
 586 /**
 587  ****************************************************************************
 588  * find a typed object and increment its refcount
 589  *****************************************************************************
 590  * This function recursively looks for a given object type. i_mode can be one
 591  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 592  *****************************************************************************/
 593 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 594 {
 595     vlc_object_t *p_found;
 596
 597     /* If we are of the requested type ourselves, don't look further */
 598     if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
 599     {
 600         vlc_object_yield( p_this );
 601         return p_this;
 602     }
 603
 604     /* Otherwise, recursively look for the object */
 605     if ((i_mode & 0x000f) == FIND_ANYWHERE)
 606     {
 607 #ifndef NDEBUG
 608         if (i_type == VLC_OBJECT_PLAYLIST)
 609             msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
 610                      "instead of pl_Yield()");
 611 #endif
 612         return vlc_object_find (p_this->p_libvlc, i_type,
 613                                 (i_mode & ~0x000f)|FIND_CHILD);
 614     }
 615
 616     vlc_mutex_lock( &structure_lock );
 617     p_found = FindObject( p_this, i_type, i_mode );
 618     vlc_mutex_unlock( &structure_lock );
 619     return p_found;
 620 }
 621
 622 /**
 623  ****************************************************************************
 624  * find a named object and increment its refcount
 625  *****************************************************************************
 626  * This function recursively looks for a given object name. i_mode can be one
 627  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 628  *****************************************************************************/
 629 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 630                                int i_mode )
 631 {
 632     vlc_object_t *p_found;
 633
 634     /* If have the requested name ourselves, don't look further */
 635     if( !(i_mode & FIND_STRICT)
 636         && p_this->psz_object_name
 637         && !strcmp( p_this->psz_object_name, psz_name ) )
 638     {
 639         vlc_object_yield( p_this );
 640         return p_this;
 641     }
 642
 643     vlc_mutex_lock( &structure_lock );
 644
 645     /* Otherwise, recursively look for the object */
 646     if( (i_mode & 0x000f) == FIND_ANYWHERE )
 647     {
 648         vlc_object_t *p_root = p_this;
 649
 650         /* Find the root */
 651         while( p_root->p_parent != NULL &&
 652                p_root != VLC_OBJECT( p_this->p_libvlc ) )
 653         {
 654             p_root = p_root->p_parent;
 655         }
 656
 657         p_found = FindObjectName( p_root, psz_name,
 658                                  (i_mode & ~0x000f)|FIND_CHILD );
 659         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
 660         {
 661             p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
 662                                       psz_name, (i_mode & ~0x000f)|FIND_CHILD );
 663         }
 664     }
 665     else
 666     {
 667         p_found = FindObjectName( p_this, psz_name, i_mode );
 668     }
 669
 670     vlc_mutex_unlock( &structure_lock );
 671
 672     return p_found;
 673 }
 674
 675 /**
 676  * Increment an object reference counter.
 677  */
 678 void __vlc_object_yield( vlc_object_t *p_this )
 679 {
 680     vlc_object_internals_t *internals = vlc_internals( p_this );
 681
 682     vlc_spin_lock( &internals->ref_spin );
 683     /* Avoid obvious freed object uses */
 684     assert( internals->i_refcount > 0 );
 685     /* Increment the counter */
 686     internals->i_refcount++;
 687     vlc_spin_unlock( &internals->ref_spin );
 688 }
 689
 690 /*****************************************************************************
 691  * Decrement an object refcount
 692  * And destroy the object if its refcount reach zero.
 693  *****************************************************************************/
 694 void __vlc_object_release( vlc_object_t *p_this )
 695 {
 696     vlc_object_internals_t *internals = vlc_internals( p_this );
 697     bool b_should_destroy;
 698
 699     vlc_spin_lock( &internals->ref_spin );
 700     assert( internals->i_refcount > 0 );
 701
 702     if( internals->i_refcount > 1 )
 703     {
 704         /* Fast path */
 705         /* There are still other references to the object */
 706         internals->i_refcount--;
 707         vlc_spin_unlock( &internals->ref_spin );
 708         return;
 709     }
 710     vlc_spin_unlock( &internals->ref_spin );
 711
 712     /* Slow path */
 713     /* Remember that we cannot hold the spin while waiting on the mutex */
 714     vlc_mutex_lock( &structure_lock );
 715     /* Take the spin again. Note that another thread may have yielded the
 716      * object in the (very short) mean time. */
 717     vlc_spin_lock( &internals->ref_spin );
 718     b_should_destroy = --internals->i_refcount == 0;
 719     vlc_spin_unlock( &internals->ref_spin );
 720
 721     if( b_should_destroy )
 722     {
 723 #ifndef NDEBUG
 724         if( VLC_OBJECT(p_this->p_libvlc) == p_this )
 725         {
 726             /* Test for leaks */
 727             vlc_object_t *leaked = internals->next;
 728             while( leaked != p_this )
 729             {
 730                 /* We are leaking this object */
 731                 fprintf( stderr,
 732                          "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
 733                          leaked->i_object_id, leaked->psz_object_type,
 734                          leaked->psz_object_name );
 735                 /* Dump object to ease debugging */
 736                 vlc_object_dump( leaked );
 737                 fflush(stderr);
 738                 leaked = vlc_internals (leaked)->next;
 739             }
 740
 741             if( internals->next != p_this )
 742                 /* Dump libvlc object to ease debugging */
 743                 vlc_object_dump( p_this );
 744         }
 745 #endif
 746         /* Remove the object from object list
 747          * so that it cannot be encountered by vlc_object_get() */
 748         vlc_internals (internals->next)->prev = internals->prev;
 749         vlc_internals (internals->prev)->next = internals->next;
 750
 751         /* Detach from parent to protect against FIND_CHILDREN */
 752         vlc_object_detach_unlocked (p_this);
 753         /* Detach from children to protect against FIND_PARENT */
 754         for (int i = 0; i < internals->i_children; i++)
 755             internals->pp_children[i]->p_parent = NULL;
 756     }
 757
 758     vlc_mutex_unlock( &structure_lock );
 759
 760     if( b_should_destroy )
 761     {
 762         int canc;
 763
 764         free( internals->pp_children );
 765         internals->pp_children = NULL;
 766         internals->i_children = 0;
 767         canc = vlc_savecancel ();
 768         vlc_object_destroy( p_this );
 769         vlc_restorecancel (canc);
 770     }
 771 }
 772
 773 /**
 774  ****************************************************************************
 775  * attach object to a parent object
 776  *****************************************************************************
 777  * This function sets p_this as a child of p_parent, and p_parent as a parent
 778  * of p_this. This link can be undone using vlc_object_detach.
 779  *****************************************************************************/
 780 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 781 {
 782     if( !p_this ) return;
 783
 784     vlc_mutex_lock( &structure_lock );
 785
 786     /* Attach the parent to its child */
 787     assert (!p_this->p_parent);
 788     p_this->p_parent = p_parent;
 789
 790     /* Attach the child to its parent */
 791     vlc_object_internals_t *priv = vlc_internals( p_parent );
 792     INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
 793                  p_this );
 794
 795     vlc_mutex_unlock( &structure_lock );
 796 }
 797
 798
 799 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
 800 {
 801     vlc_assert_locked (&structure_lock);
 802
 803     if (p_this->p_parent == NULL)
 804         return;
 805
 806     vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
 807
 808     int i_index, i;
 809
 810     /* Remove p_this's parent */
 811     p_this->p_parent = NULL;
 812
 813     /* Remove all of p_parent's children which are p_this */
 814     for( i_index = priv->i_children ; i_index-- ; )
 815     {
 816         if( priv->pp_children[i_index] == p_this )
 817         {
 818             priv->i_children--;
 819             for( i = i_index ; i < priv->i_children ; i++ )
 820                 priv->pp_children[i] = priv->pp_children[i+1];
 821         }
 822     }
 823
 824     if( priv->i_children )
 825     {
 826         priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
 827                                priv->i_children * sizeof(vlc_object_t *) );
 828     }
 829     else
 830     {
 831         /* Special case - don't realloc() to zero to avoid leaking */
 832         free( priv->pp_children );
 833         priv->pp_children = NULL;
 834     }
 835 }
 836
 837
 838 /**
 839  ****************************************************************************
 840  * detach object from its parent
 841  *****************************************************************************
 842  * This function removes all links between an object and its parent.
 843  *****************************************************************************/
 844 void __vlc_object_detach( vlc_object_t *p_this )
 845 {
 846     if( !p_this ) return;
 847
 848     vlc_mutex_lock( &structure_lock );
 849     if( !p_this->p_parent )
 850         msg_Err( p_this, "object is not attached" );
 851     else
 852         vlc_object_detach_unlocked( p_this );
 853     vlc_mutex_unlock( &structure_lock );
 854 }
 855
 856
 857 /**
 858  ****************************************************************************
 859  * find a list typed objects and increment their refcount
 860  *****************************************************************************
 861  * This function recursively looks for a given object type. i_mode can be one
 862  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 863  *****************************************************************************/
 864 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 865 {
 866     vlc_list_t *p_list;
 867     int i_count = 0;
 868
 869     /* Look for the objects */
 870     switch( i_mode & 0x000f )
 871     {
 872     case FIND_ANYWHERE:
 873         /* Modules should probably not be object, and the module should perhaps
 874          * not be shared across LibVLC instances. In the mean time, this ugly
 875          * hack is brought to you by Courmisch. */
 876         if (i_type == VLC_OBJECT_MODULE)
 877             return vlc_list_find ((vlc_object_t *)p_module_bank,
 878                                   i_type, FIND_CHILD);
 879         return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
 880
 881     case FIND_CHILD:
 882         vlc_mutex_lock( &structure_lock );
 883         i_count = CountChildren( p_this, i_type );
 884         p_list = NewList( i_count );
 885
 886         /* Check allocation was successful */
 887         if( p_list->i_count != i_count )
 888         {
 889             vlc_mutex_unlock( &structure_lock );
 890             msg_Err( p_this, "list allocation failed!" );
 891             p_list->i_count = 0;
 892             break;
 893         }
 894
 895         p_list->i_count = 0;
 896         ListChildren( p_list, p_this, i_type );
 897         vlc_mutex_unlock( &structure_lock );
 898         break;
 899
 900     default:
 901         msg_Err( p_this, "unimplemented!" );
 902         p_list = NewList( 0 );
 903         break;
 904     }
 905
 906     return p_list;
 907 }
 908
 909 /**
 910  * Gets the list of children of an objects, and increment their reference
 911  * count.
 912  * @return a list (possibly empty) or NULL in case of error.
 913  */
 914 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
 915 {
 916     vlc_list_t *l;
 917     vlc_object_internals_t *priv = vlc_internals( obj );
 918
 919     vlc_mutex_lock( &structure_lock );
 920     l = NewList( priv->i_children );
 921     for (int i = 0; i < l->i_count; i++)
 922     {
 923         vlc_object_yield( priv->pp_children[i] );
 924         l->p_values[i].p_object = priv->pp_children[i];
 925     }
 926     vlc_mutex_unlock( &structure_lock );
 927     return l;
 928 }
 929
 930 /*****************************************************************************
 931  * DumpCommand: print the current vlc structure
 932  *****************************************************************************
 933  * This function prints either an ASCII tree showing the connections between
 934  * vlc objects, and additional information such as their refcount, thread ID,
 935  * etc. (command "tree"), or the same data as a simple list (command "list").
 936  *****************************************************************************/
 937 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
 938                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 939 {
 940     libvlc_int_t *p_libvlc = p_this->p_libvlc;
 941
 942     (void)oldval; (void)p_data;
 943     if( *psz_cmd == 'l' )
 944     {
 945         vlc_object_t *cur = VLC_OBJECT (p_libvlc);
 946
 947         vlc_mutex_lock( &structure_lock );
 948         do
 949         {
 950             PrintObject (cur, "");
 951             cur = vlc_internals (cur)->next;
 952         }
 953         while (cur != VLC_OBJECT(p_libvlc));
 954         vlc_mutex_unlock( &structure_lock );
 955     }
 956     else
 957     {
 958         vlc_object_t *p_object = NULL;
 959
 960         if( *newval.psz_string )
 961         {
 962             char *end;
 963             int i_id = strtol( newval.psz_string, &end, 0 );
 964             if( !*end )
 965                 p_object = vlc_object_get( p_libvlc, i_id );
 966             else
 967                 /* try using the object's name to find it */
 968                 p_object = vlc_object_find_name( p_this, newval.psz_string,
 969                                                  FIND_ANYWHERE );
 970
 971             if( !p_object )
 972             {
 973                 return VLC_ENOOBJ;
 974             }
 975         }
 976
 977         vlc_mutex_lock( &structure_lock );
 978
 979         if( *psz_cmd == 't' )
 980         {
 981             char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
 982
 983             if( !p_object )
 984                 p_object = VLC_OBJECT(p_this->p_libvlc);
 985
 986             psz_foo[0] = '|';
 987             DumpStructure( p_object, 0, psz_foo );
 988         }
 989         else if( *psz_cmd == 'v' )
 990         {
 991             int i;
 992
 993             if( !p_object )
 994                 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
 995
 996             PrintObject( p_object, "" );
 997
 998             if( !vlc_internals( p_object )->i_vars )
 999                 printf( " `-o No variables\n" );
1000             for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1001             {
1002                 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1003
1004                 const char *psz_type = "unknown";
1005                 switch( p_var->i_type & VLC_VAR_TYPE )
1006                 {
1007 #define MYCASE( type, nice )                \
1008                     case VLC_VAR_ ## type:  \
1009                         psz_type = nice;    \
1010                         break;
1011                     MYCASE( VOID, "void" );
1012                     MYCASE( BOOL, "bool" );
1013                     MYCASE( INTEGER, "integer" );
1014                     MYCASE( HOTKEY, "hotkey" );
1015                     MYCASE( STRING, "string" );
1016                     MYCASE( MODULE, "module" );
1017                     MYCASE( FILE, "file" );
1018                     MYCASE( DIRECTORY, "directory" );
1019                     MYCASE( VARIABLE, "variable" );
1020                     MYCASE( FLOAT, "float" );
1021                     MYCASE( TIME, "time" );
1022                     MYCASE( ADDRESS, "address" );
1023                     MYCASE( MUTEX, "mutex" );
1024                     MYCASE( LIST, "list" );
1025 #undef MYCASE
1026                 }
1027                 printf( " %c-o \"%s\" (%s",
1028                         i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1029                         p_var->psz_name, psz_type );
1030                 if( p_var->psz_text )
1031                     printf( ", %s", p_var->psz_text );
1032                 printf( ")" );
1033                 if( p_var->i_type & VLC_VAR_HASCHOICE )
1034                     printf( ", has choices" );
1035                 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1036                     printf( ", command" );
1037                 if( p_var->i_entries )
1038                     printf( ", %d callbacks", p_var->i_entries );
1039                 switch( p_var->i_type & 0x00f0 )
1040                 {
1041                     case VLC_VAR_VOID:
1042                     case VLC_VAR_MUTEX:
1043                         break;
1044                     case VLC_VAR_BOOL:
1045                         printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1046                         break;
1047                     case VLC_VAR_INTEGER:
1048                         printf( ": %d", p_var->val.i_int );
1049                         break;
1050                     case VLC_VAR_STRING:
1051                         printf( ": \"%s\"", p_var->val.psz_string );
1052                         break;
1053                     case VLC_VAR_FLOAT:
1054                         printf( ": %f", p_var->val.f_float );
1055                         break;
1056                     case VLC_VAR_TIME:
1057                         printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1058                         break;
1059                     case VLC_VAR_ADDRESS:
1060                         printf( ": %p", p_var->val.p_address );
1061                         break;
1062                     case VLC_VAR_LIST:
1063                         printf( ": TODO" );
1064                         break;
1065                 }
1066                 printf( "\n" );
1067             }
1068         }
1069
1070         vlc_mutex_unlock( &structure_lock );
1071
1072         if( *newval.psz_string )
1073         {
1074             vlc_object_release( p_object );
1075         }
1076     }
1077
1078     return VLC_SUCCESS;
1079 }
1080
1081 /*****************************************************************************
1082  * vlc_list_release: free a list previously allocated by vlc_list_find
1083  *****************************************************************************
1084  * This function decreases the refcount of all objects in the list and
1085  * frees the list.
1086  *****************************************************************************/
1087 void vlc_list_release( vlc_list_t *p_list )
1088 {
1089     int i_index;
1090
1091     for( i_index = 0; i_index < p_list->i_count; i_index++ )
1092     {
1093         vlc_object_release( p_list->p_values[i_index].p_object );
1094     }
1095
1096     free( p_list->p_values );
1097     free( p_list );
1098 }
1099
1100 /*****************************************************************************
1101  * dump an object. (Debug function)
1102  *****************************************************************************/
1103 static void vlc_object_dump( vlc_object_t *p_this )
1104 {
1105     char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1106     psz_foo[0] = '|';
1107
1108     vlc_assert_locked( &structure_lock );
1109     DumpStructure( p_this, 0, psz_foo );
1110 }
1111
1112 /* Following functions are local */
1113
1114 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1115 {
1116     int i;
1117     vlc_object_t *p_tmp;
1118
1119     switch( i_mode & 0x000f )
1120     {
1121     case FIND_PARENT:
1122         p_tmp = p_this->p_parent;
1123         if( p_tmp )
1124         {
1125             if( p_tmp->i_object_type == i_type )
1126             {
1127                 vlc_object_yield( p_tmp );
1128                 return p_tmp;
1129             }
1130             else
1131             {
1132                 return FindObject( p_tmp, i_type, i_mode );
1133             }
1134         }
1135         break;
1136
1137     case FIND_CHILD:
1138         for( i = vlc_internals( p_this )->i_children; i--; )
1139         {
1140             p_tmp = vlc_internals( p_this )->pp_children[i];
1141             if( p_tmp->i_object_type == i_type )
1142             {
1143                 vlc_object_yield( p_tmp );
1144                 return p_tmp;
1145             }
1146             else if( vlc_internals( p_tmp )->i_children )
1147             {
1148                 p_tmp = FindObject( p_tmp, i_type, i_mode );
1149                 if( p_tmp )
1150                 {
1151                     return p_tmp;
1152                 }
1153             }
1154         }
1155         break;
1156
1157     case FIND_ANYWHERE:
1158         /* Handled in vlc_object_find */
1159         break;
1160     }
1161
1162     return NULL;
1163 }
1164
1165 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1166                                       const char *psz_name,
1167                                       int i_mode )
1168 {
1169     int i;
1170     vlc_object_t *p_tmp;
1171
1172     switch( i_mode & 0x000f )
1173     {
1174     case FIND_PARENT:
1175         p_tmp = p_this->p_parent;
1176         if( p_tmp )
1177         {
1178             if( p_tmp->psz_object_name
1179                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1180             {
1181                 vlc_object_yield( p_tmp );
1182                 return p_tmp;
1183             }
1184             else
1185             {
1186                 return FindObjectName( p_tmp, psz_name, i_mode );
1187             }
1188         }
1189         break;
1190
1191     case FIND_CHILD:
1192         for( i = vlc_internals( p_this )->i_children; i--; )
1193         {
1194             p_tmp = vlc_internals( p_this )->pp_children[i];
1195             if( p_tmp->psz_object_name
1196                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1197             {
1198                 vlc_object_yield( p_tmp );
1199                 return p_tmp;
1200             }
1201             else if( vlc_internals( p_tmp )->i_children )
1202             {
1203                 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1204                 if( p_tmp )
1205                 {
1206                     return p_tmp;
1207                 }
1208             }
1209         }
1210         break;
1211
1212     case FIND_ANYWHERE:
1213         /* Handled in vlc_object_find */
1214         break;
1215     }
1216
1217     return NULL;
1218 }
1219
1220
1221 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1222 {
1223     char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1224          psz_parent[20];
1225
1226     int canc = vlc_savecancel ();
1227     memset( &psz_name, 0, sizeof(psz_name) );
1228     if( p_this->psz_object_name )
1229     {
1230         snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1231         if( psz_name[48] )
1232             psz_name[48] = '\"';
1233     }
1234
1235     psz_children[0] = '\0';
1236     switch( vlc_internals( p_this )->i_children )
1237     {
1238         case 0:
1239             break;
1240         case 1:
1241             strcpy( psz_children, ", 1 child" );
1242             break;
1243         default:
1244             snprintf( psz_children, 19, ", %i children",
1245                       vlc_internals( p_this )->i_children );
1246             break;
1247     }
1248
1249     psz_refcount[0] = '\0';
1250     if( vlc_internals( p_this )->i_refcount > 0 )
1251         snprintf( psz_refcount, 19, ", refcount %u",
1252                   vlc_internals( p_this )->i_refcount );
1253
1254     psz_thread[0] = '\0';
1255     if( vlc_internals( p_this )->b_thread )
1256         snprintf( psz_thread, 29, " (thread %lu)",
1257                   (unsigned long)vlc_internals( p_this )->thread_id );
1258
1259     psz_parent[0] = '\0';
1260     if( p_this->p_parent )
1261         snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1262
1263     printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1264             p_this->i_object_id, p_this->psz_object_type,
1265             psz_name, psz_thread, psz_refcount, psz_children,
1266             psz_parent );
1267     vlc_restorecancel (canc);
1268 }
1269
1270 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1271 {
1272     int i;
1273     char i_back = psz_foo[i_level];
1274     psz_foo[i_level] = '\0';
1275
1276     PrintObject( p_this, psz_foo );
1277
1278     psz_foo[i_level] = i_back;
1279
1280     if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1281     {
1282         msg_Warn( p_this, "structure tree is too deep" );
1283         return;
1284     }
1285
1286     for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1287     {
1288         if( i_level )
1289         {
1290             psz_foo[i_level-1] = ' ';
1291
1292             if( psz_foo[i_level-2] == '`' )
1293             {
1294                 psz_foo[i_level-2] = ' ';
1295             }
1296         }
1297
1298         if( i == vlc_internals( p_this )->i_children - 1 )
1299         {
1300             psz_foo[i_level] = '`';
1301         }
1302         else
1303         {
1304             psz_foo[i_level] = '|';
1305         }
1306
1307         psz_foo[i_level+1] = '-';
1308         psz_foo[i_level+2] = '\0';
1309
1310         DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1311                        psz_foo );
1312     }
1313 }
1314
1315 static vlc_list_t * NewList( int i_count )
1316 {
1317     vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1318     if( p_list == NULL )
1319     {
1320         return NULL;
1321     }
1322
1323     p_list->i_count = i_count;
1324
1325     if( i_count == 0 )
1326     {
1327         p_list->p_values = NULL;
1328         return p_list;
1329     }
1330
1331     p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1332     if( p_list->p_values == NULL )
1333     {
1334         p_list->i_count = 0;
1335         return p_list;
1336     }
1337
1338     return p_list;
1339 }
1340
1341 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1342                          int i_index )
1343 {
1344     if( p_list == NULL || i_index >= p_list->i_count )
1345     {
1346         return;
1347     }
1348
1349     vlc_object_yield( p_object );
1350
1351     p_list->p_values[i_index].p_object = p_object;
1352
1353     return;
1354 }
1355
1356 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1357 {
1358     if( p_list == NULL )
1359     {
1360         return;
1361     }
1362
1363     p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1364                                 * sizeof( vlc_value_t ) );
1365     if( p_list->p_values == NULL )
1366     {
1367         p_list->i_count = 0;
1368         return;
1369     }
1370
1371     vlc_object_yield( p_object );
1372
1373     p_list->p_values[p_list->i_count].p_object = p_object;
1374     p_list->i_count++;
1375
1376     return;
1377 }*/
1378
1379 static int CountChildren( vlc_object_t *p_this, int i_type )
1380 {
1381     vlc_object_t *p_tmp;
1382     int i, i_count = 0;
1383
1384     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1385     {
1386         p_tmp = vlc_internals( p_this )->pp_children[i];
1387
1388         if( p_tmp->i_object_type == i_type )
1389         {
1390             i_count++;
1391         }
1392         i_count += CountChildren( p_tmp, i_type );
1393     }
1394
1395     return i_count;
1396 }
1397
1398 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1399 {
1400     vlc_object_t *p_tmp;
1401     int i;
1402
1403     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1404     {
1405         p_tmp = vlc_internals( p_this )->pp_children[i];
1406
1407         if( p_tmp->i_object_type == i_type )
1408             ListReplace( p_list, p_tmp, p_list->i_count++ );
1409
1410         ListChildren( p_list, p_tmp, i_type );
1411     }
1412 }