]> git.sesse.net Git - vlc/blobdiff - src/misc/objects.c
Re-checking src/interface/interface.h.
[vlc] / src / misc / objects.c
index 1ff65ec30d951739afca6fc9d3c00a8c78d081b5..3b7c24bdd79beaab76b945abceb97f351d3411d7 100644 (file)
 #endif
 #include <assert.h>
 
+/*****************************************************************************
+ * Constants
+ *****************************************************************************/
+
+const vlc_destructor_t kVLCDestructor = NULL;
+
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
@@ -93,6 +99,7 @@ static int            CountChildren ( vlc_object_t *, int );
 static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
 
 static void vlc_object_destroy( vlc_object_t *p_this );
+static void vlc_object_yield_locked( vlc_object_t *p_this );
 
 /*****************************************************************************
  * Local structure lock
@@ -192,6 +199,8 @@ vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
     }
 
     p_priv->i_refcount = 1;
+    p_priv->pf_destructor = kVLCDestructor;
+    p_priv->b_thread = VLC_FALSE;
     p_new->p_parent = NULL;
     p_new->pp_children = NULL;
     p_new->i_children = 0;
@@ -335,6 +344,10 @@ void * __vlc_object_create( vlc_object_t *p_this, int i_type )
             i_size = sizeof( osd_menu_t );
             psz_type = "osd menu";
             break;
+        case VLC_OBJECT_INTERACTION:
+            i_size = sizeof( interaction_t );
+            psz_type = "interaction";
+            break;
         default:
             i_size = i_type > (int)sizeof(vlc_object_t)
                          ? i_type : (int)sizeof(vlc_object_t);
@@ -347,6 +360,24 @@ void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 }
 
 
+/**
+ ****************************************************************************
+ * Set the destructor of a vlc object
+ *
+ * This function sets the destructor of the vlc object. It will be called
+ * when the object is destroyed when the its refcount reaches 0.
+ * (It is called by the internal function vlc_object_destroy())
+ *****************************************************************************/
+void __vlc_object_set_destructor( vlc_object_t *p_this,
+                                  vlc_destructor_t pf_destructor )
+{
+    vlc_object_internals_t *p_priv = vlc_internals(p_this );
+
+    vlc_mutex_lock( &structure_lock );
+    p_priv->pf_destructor = pf_destructor;
+    vlc_mutex_unlock( &structure_lock );
+}
+
 /**
  ****************************************************************************
  * Destroy a vlc object (Internal)
@@ -359,6 +390,9 @@ static void vlc_object_destroy( vlc_object_t *p_this )
 {
     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 
+    /* Automatically detach the object from its parents */
+    if( p_this->p_parent ) vlc_object_detach( p_this );
+
     /* Sanity checks */
     if( p_this->i_children )
     {
@@ -382,18 +416,18 @@ static void vlc_object_destroy( vlc_object_t *p_this )
         abort();
     }
 
-    if( p_this->p_parent )
-    {
-        fprintf( stderr,
-                 "ERROR: cannot delete object (id:%i, type:%s, name:%s) "
-                 "with a parent (id:%i, type:%s, name:%s)\n",
-                 p_this->i_object_id, p_this->psz_object_type,
-                 p_this->psz_object_name, p_this->p_parent->i_object_id,
-                 p_this->p_parent->psz_object_type,
-                 p_this->p_parent->psz_object_name );
-        fflush(stderr);
-        abort();
-    }
+
+    /* Send a kill to the object's thread if applicable */
+    vlc_object_kill( p_this );
+
+    /* If we are running on a thread, wait until it ends */
+    if( p_priv->b_thread )
+        vlc_thread_join( p_this );
+
+    /* Call the custom "subclass" destructor */
+    if( p_priv->pf_destructor )
+        p_priv->pf_destructor( p_this );
+
 
     /* Destroy the associated variables, starting from the end so that
      * no memmove calls have to be done. */
@@ -405,7 +439,7 @@ static void vlc_object_destroy( vlc_object_t *p_this )
     free( p_priv->p_vars );
     vlc_mutex_destroy( &p_priv->var_lock );
 
-    if( p_this->psz_header ) free( p_this->psz_header );
+    free( p_this->psz_header );
 
     if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
     {
@@ -732,8 +766,8 @@ void * vlc_object_get( int i_id )
                 /* This happens when there are only two remaining objects */
                 if( pp_objects[i_middle+1]->i_object_id == i_id )
                 {
+                    vlc_object_yield_locked( pp_objects[i_middle+1] );
                     vlc_mutex_unlock( &structure_lock );
-                    pp_objects[i_middle+1]->p_internals->i_refcount++;
                     return pp_objects[i_middle+1];
                 }
                 break;
@@ -741,8 +775,8 @@ void * vlc_object_get( int i_id )
         }
         else
         {
+            vlc_object_yield_locked( pp_objects[i_middle] );
             vlc_mutex_unlock( &structure_lock );
-            pp_objects[i_middle]->p_internals->i_refcount++;
             return pp_objects[i_middle];
         }
 
@@ -771,10 +805,13 @@ void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 
     vlc_mutex_lock( &structure_lock );
 
+    /* Avoid obvious freed object uses */
+    assert( p_this->p_internals->i_refcount > 0 );
+
     /* If we are of the requested type ourselves, don't look further */
     if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
     {
-        p_this->p_internals->i_refcount++;
+        vlc_object_yield_locked( p_this );
         vlc_mutex_unlock( &structure_lock );
         return p_this;
     }
@@ -822,12 +859,15 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 
     vlc_mutex_lock( &structure_lock );
 
+    /* Avoid obvious freed object uses */
+    assert( p_this->p_internals->i_refcount > 0 );
+
     /* If have the requested name ourselves, don't look further */
     if( !(i_mode & FIND_STRICT)
         && p_this->psz_object_name
         && !strcmp( p_this->psz_object_name, psz_name ) )
     {
-        p_this->p_internals->i_refcount++;
+        vlc_object_yield_locked( p_this );
         vlc_mutex_unlock( &structure_lock );
         return p_this;
     }
@@ -866,13 +906,28 @@ void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
  ****************************************************************************
  * increment an object refcount
  *****************************************************************************/
+
+/* When the structure_lock is locked */
+static void vlc_object_yield_locked( vlc_object_t *p_this )
+{
+    vlc_assert_locked (&structure_lock);
+
+    /* Avoid obvious freed object uses */
+    assert( p_this->p_internals->i_refcount > 0 );
+
+    /* Increment the counter */
+    p_this->p_internals->i_refcount++;
+}
+
+/* Public function */
 void __vlc_object_yield( vlc_object_t *p_this )
 {
     vlc_mutex_lock( &structure_lock );
-    p_this->p_internals->i_refcount++;
+    vlc_object_yield_locked( p_this );
     vlc_mutex_unlock( &structure_lock );
 }
 
+
 /*****************************************************************************
  * decrement an object refcount
  * And destroy the object if its refcount reach zero.
@@ -921,6 +976,9 @@ void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 
     vlc_mutex_lock( &structure_lock );
 
+    /* Avoid obvious freed object uses */
+    assert( p_this->p_internals->i_refcount > 0 );
+
     /* Attach the parent to its child */
     p_this->p_parent = p_parent;
 
@@ -948,6 +1006,7 @@ void __vlc_object_detach( vlc_object_t *p_this )
     if( !p_this ) return;
 
     vlc_mutex_lock( &structure_lock );
+
     if( !p_this->p_parent )
     {
         msg_Err( p_this, "object is not attached" );
@@ -982,6 +1041,9 @@ vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 
     vlc_mutex_lock( &structure_lock );
 
+    /* Avoid obvious freed object uses */
+    assert( p_this->p_internals->i_refcount > 0 );
+
     /* Look for the objects */
     switch( i_mode & 0x000f )
     {
@@ -1290,7 +1352,7 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
         {
             if( p_tmp->i_object_type == i_type )
             {
-                p_tmp->p_internals->i_refcount++;
+                vlc_object_yield_locked( p_tmp );
                 return p_tmp;
             }
             else
@@ -1306,7 +1368,7 @@ static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
             p_tmp = p_this->pp_children[i];
             if( p_tmp->i_object_type == i_type )
             {
-                p_tmp->p_internals->i_refcount++;
+                vlc_object_yield_locked( p_tmp );
                 return p_tmp;
             }
             else if( p_tmp->i_children )
@@ -1344,7 +1406,7 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
             if( p_tmp->psz_object_name
                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
-                p_tmp->p_internals->i_refcount++;
+                vlc_object_yield_locked( p_tmp );
                 return p_tmp;
             }
             else
@@ -1361,7 +1423,7 @@ static vlc_object_t * FindObjectName( vlc_object_t *p_this,
             if( p_tmp->psz_object_name
                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
             {
-                p_tmp->p_internals->i_refcount++;
+                vlc_object_yield_locked( p_tmp );
                 return p_tmp;
             }
             else if( p_tmp->i_children )
@@ -1562,7 +1624,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    p_object->p_internals->i_refcount++;
+    vlc_object_yield_locked( p_object );
 
     p_list->p_values[i_index].p_object = p_object;
 
@@ -1584,7 +1646,7 @@ static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
         return;
     }
 
-    p_object->p_internals->i_refcount++;
+    vlc_object_yield_locked( p_object );
 
     p_list->p_values[p_list->i_count].p_object = p_object;
     p_list->i_count++;