* variables.c: routines for object variables handling
*****************************************************************************
* Copyright (C) 2002 VideoLAN
- * $Id: variables.c,v 1.14 2002/12/06 10:10:40 sam Exp $
+ * $Id: variables.c,v 1.30 2003/09/07 22:51:11 fenrir Exp $
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
*****************************************************************************/
static int CmpBool( vlc_value_t v, vlc_value_t w ) { return v.b_bool ? w.b_bool ? 0 : 1 : w.b_bool ? -1 : 0; }
static int CmpInt( vlc_value_t v, vlc_value_t w ) { return v.i_int == w.i_int ? 0 : v.i_int > w.i_int ? 1 : -1; }
+static int CmpTime( vlc_value_t v, vlc_value_t w )
+{
+ return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
+}
static int CmpString( vlc_value_t v, vlc_value_t w ) { return strcmp( v.psz_string, w.psz_string ); }
static int CmpFloat( vlc_value_t v, vlc_value_t w ) { return v.f_float == w.f_float ? 0 : v.f_float > w.f_float ? 1 : -1; }
static int CmpAddress( vlc_value_t v, vlc_value_t w ) { return v.p_address == w.p_address ? 0 : v.p_address > w.p_address ? 1 : -1; }
static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
static void DupString( vlc_value_t *p_val ) { p_val->psz_string = strdup( p_val->psz_string ); }
+static void DupList( vlc_value_t *p_val )
+{
+ int i;
+ vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
+
+ if( p_val->p_list->i_count )
+ {
+ p_list->i_count = p_val->p_list->i_count;
+ p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
+ p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
+ }
+
+ for( i = 0; i < p_list->i_count; i++ )
+ {
+ p_list->p_values[i] = p_val->p_list->p_values[i];
+ switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
+ {
+ case VLC_VAR_STRING:
+
+ DupString( &p_list->p_values[i] );
+ break;
+ default:
+ break;
+ }
+ }
+
+ p_val->p_list = p_list;
+}
+
static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
+static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
+
+static void FreeList( vlc_value_t *p_val )
+{
+ int i;
+ for( i = 0; i < p_val->p_list->i_count; i++ )
+ {
+ switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
+ {
+ case VLC_VAR_STRING:
+ FreeString( &p_val->p_list->p_values[i] );
+ break;
+ case VLC_VAR_MUTEX:
+ FreeMutex( &p_val->p_list->p_values[i] );
+ break;
+ default:
+ break;
+ }
+ }
+
+ if( p_val->p_list->i_count )
+ {
+ free( p_val->p_list->p_values );
+ free( p_val->p_list->pi_types );
+ }
+ free( p_val->p_list );
+}
/*****************************************************************************
* Local prototypes
static void CheckValue ( variable_t *, vlc_value_t * );
+static int InheritValue( vlc_object_t *, const char *, vlc_value_t *,
+ int );
+
/*****************************************************************************
* var_Create: initialize a vlc variable
*****************************************************************************
{
int i_new;
variable_t *p_var;
+ static vlc_list_t dummy_null_list = {0, NULL, NULL};
vlc_mutex_lock( &p_this->var_lock );
if( i_new >= 0 )
{
/* If the types differ, variable creation failed. */
- if( i_type != p_this->p_vars[i_new].i_type )
+ if( (i_type & ~VLC_VAR_DOINHERIT) != p_this->p_vars[i_new].i_type )
{
vlc_mutex_unlock( &p_this->var_lock );
return VLC_EBADVAR;
p_var->i_hash = HashString( psz_name );
p_var->psz_name = strdup( psz_name );
+ p_var->psz_text = NULL;
- p_var->i_type = i_type;
+ p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
memset( &p_var->val, 0, sizeof(vlc_value_t) );
p_var->pf_dup = DupDummy;
p_var->i_usage = 1;
p_var->i_default = -1;
- p_var->i_choices = 0;
- p_var->pp_choices = NULL;
+ p_var->choices.i_count = 0;
+ p_var->choices.p_values = NULL;
+ p_var->choices_text.i_count = 0;
+ p_var->choices_text.p_values = NULL;
p_var->b_incallback = VLC_FALSE;
p_var->i_entries = 0;
case VLC_VAR_STRING:
case VLC_VAR_MODULE:
case VLC_VAR_FILE:
+ case VLC_VAR_DIRECTORY:
+ case VLC_VAR_VARIABLE:
p_var->pf_cmp = CmpString;
p_var->pf_dup = DupString;
p_var->pf_free = FreeString;
p_var->val.f_float = 0.0;
break;
case VLC_VAR_TIME:
- /* FIXME: TODO */
+ p_var->pf_cmp = CmpTime;
+ p_var->val.i_time = 0;
break;
case VLC_VAR_ADDRESS:
- case VLC_VAR_COMMAND:
p_var->pf_cmp = CmpAddress;
p_var->val.p_address = NULL;
break;
case VLC_VAR_MUTEX:
p_var->pf_cmp = CmpAddress;
+ p_var->pf_free = FreeMutex;
p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
vlc_mutex_init( p_this, (vlc_mutex_t*)p_var->val.p_address );
break;
+ case VLC_VAR_LIST:
+ p_var->pf_cmp = CmpAddress;
+ p_var->pf_dup = DupList;
+ p_var->pf_free = FreeList;
+ p_var->val.p_list = &dummy_null_list;
+ break;
}
/* Duplicate the default data we stored. */
p_var->pf_dup( &p_var->val );
+ if( i_type & VLC_VAR_DOINHERIT )
+ {
+ vlc_value_t val;
+
+ if( InheritValue( p_this, psz_name, &val, p_var->i_type )
+ == VLC_SUCCESS );
+ {
+ /* Free data if needed */
+ p_var->pf_free( &p_var->val );
+ /* Check boundaries and list */
+ CheckValue( p_var, &val );
+ /* Set the variable */
+ p_var->val = val;
+ }
+ }
+
vlc_mutex_unlock( &p_this->var_lock );
return VLC_SUCCESS;
/* Free value if needed */
p_var->pf_free( &p_var->val );
- switch( p_var->i_type & VLC_VAR_TYPE )
- {
- /* XXX: find a way to put this in pf_free */
- case VLC_VAR_MUTEX:
- vlc_mutex_destroy( (vlc_mutex_t*)p_var->val.p_address );
- free( p_var->val.p_address );
- break;
- }
-
/* Free choice list if needed */
- if( p_var->pp_choices )
+ if( p_var->choices.i_count )
{
- for( i = 0 ; i < p_var->i_choices ; i++ )
+ for( i = 0 ; i < p_var->choices.i_count ; i++ )
{
- p_var->pf_free( &p_var->pp_choices[i] );
+ p_var->pf_free( &p_var->choices.p_values[i] );
+ if( p_var->choices_text.p_values[i].psz_string )
+ free( p_var->choices_text.p_values[i].psz_string );
}
- free( p_var->pp_choices );
+ free( p_var->choices.p_values );
+ free( p_var->choices_text.p_values );
}
/* Free callbacks if needed */
}
free( p_var->psz_name );
+ if( p_var->psz_text ) free( p_var->psz_text );
memmove( p_this->p_vars + i_var,
p_this->p_vars + i_var + 1,
*
*****************************************************************************/
int __var_Change( vlc_object_t *p_this, const char *psz_name,
- int i_action, vlc_value_t *p_val )
+ int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
{
int i_var, i;
variable_t *p_var;
+ vlc_value_t oldval;
vlc_mutex_lock( &p_this->var_lock );
p_var->pf_dup( &p_var->step );
CheckValue( p_var, &p_var->val );
break;
-
case VLC_VAR_ADDCHOICE:
/* FIXME: the list is sorted, dude. Use something cleverer. */
- for( i = p_var->i_choices ; i-- ; )
+ for( i = p_var->choices.i_count ; i-- ; )
{
- if( p_var->pf_cmp( p_var->pp_choices[i], *p_val ) < 0 )
+ if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) < 0 )
{
break;
}
p_var->i_default++;
}
- INSERT_ELEM( p_var->pp_choices, p_var->i_choices, i, *p_val );
- p_var->pf_dup( &p_var->pp_choices[i] );
+ INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
+ i, *p_val );
+ INSERT_ELEM( p_var->choices_text.p_values,
+ p_var->choices_text.i_count, i, *p_val );
+ p_var->pf_dup( &p_var->choices.p_values[i] );
+ p_var->choices_text.p_values[i].psz_string =
+ ( p_val2 && p_val2->psz_string ) ?
+ strdup( p_val2->psz_string ) : NULL;
CheckValue( p_var, &p_var->val );
break;
case VLC_VAR_DELCHOICE:
/* FIXME: the list is sorted, dude. Use something cleverer. */
- for( i = 0 ; i < p_var->i_choices ; i++ )
+ for( i = 0 ; i < p_var->choices.i_count ; i++ )
{
- if( p_var->pf_cmp( p_var->pp_choices[i], *p_val ) == 0 )
+ if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
{
break;
}
}
- if( i == p_var->i_choices )
+ if( i == p_var->choices.i_count )
{
/* Not found */
vlc_mutex_unlock( &p_this->var_lock );
p_var->i_default = -1;
}
- p_var->pf_free( &p_var->pp_choices[i] );
- REMOVE_ELEM( p_var->pp_choices, p_var->i_choices, i );
+ p_var->pf_free( &p_var->choices.p_values[i] );
+ if( p_var->choices_text.p_values[i].psz_string )
+ free( p_var->choices_text.p_values[i].psz_string );
+ REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
+ REMOVE_ELEM( p_var->choices_text.p_values,
+ p_var->choices_text.i_count, i );
CheckValue( p_var, &p_var->val );
break;
+ case VLC_VAR_CHOICESCOUNT:
+ p_val->i_int = p_var->choices.i_count;
+ break;
+ case VLC_VAR_CLEARCHOICES:
+ for( i = 0 ; i < p_var->choices.i_count ; i++ )
+ {
+ p_var->pf_free( &p_var->choices.p_values[i] );
+ }
+ if( p_var->choices.i_count )
+ free( p_var->choices.p_values );
+
+ p_var->choices.i_count = 0;
+ p_var->choices.p_values = NULL;
+ p_var->i_default = -1;
+ break;
case VLC_VAR_SETDEFAULT:
/* FIXME: the list is sorted, dude. Use something cleverer. */
- for( i = 0 ; i < p_var->i_choices ; i++ )
+ for( i = 0 ; i < p_var->choices.i_count ; i++ )
{
- if( p_var->pf_cmp( p_var->pp_choices[i], *p_val ) == 0 )
+ if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
{
break;
}
}
- if( i == p_var->i_choices )
+ if( i == p_var->choices.i_count )
{
/* Not found */
break;
p_var->i_default = i;
CheckValue( p_var, &p_var->val );
break;
-
+ case VLC_VAR_SETVALUE:
+ /* Duplicate data if needed */
+ p_var->pf_dup( p_val );
+ /* Backup needed stuff */
+ oldval = p_var->val;
+ /* Check boundaries and list */
+ CheckValue( p_var, p_val );
+ /* Set the variable */
+ p_var->val = *p_val;
+ /* Free data if needed */
+ p_var->pf_free( &oldval );
+ break;
+ case VLC_VAR_GETCHOICES:
case VLC_VAR_GETLIST:
- p_val->p_address = malloc( (1 + p_var->i_choices)
- * sizeof(vlc_value_t) );
- ((vlc_value_t*)p_val->p_address)[0].i_int = p_var->i_choices;
- for( i = 0 ; i < p_var->i_choices ; i++ )
+ p_val->p_list = malloc( sizeof(vlc_list_t) );
+ if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
+ if( p_var->choices.i_count )
+ {
+ p_val->p_list->p_values = malloc( p_var->choices.i_count
+ * sizeof(vlc_value_t) );
+ p_val->p_list->pi_types = malloc( p_var->choices.i_count
+ * sizeof(int) );
+ if( p_val2 )
+ {
+ p_val2->p_list->p_values =
+ malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
+ p_val2->p_list->pi_types =
+ malloc( p_var->choices.i_count * sizeof(int) );
+ }
+ }
+ p_val->p_list->i_count = p_var->choices.i_count;
+ if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
+ for( i = 0 ; i < p_var->choices.i_count ; i++ )
{
- ((vlc_value_t*)p_val->p_address)[i+1] = p_var->pp_choices[i];
- p_var->pf_dup( &((vlc_value_t*)p_val->p_address)[i+1] );
+ p_val->p_list->p_values[i] = p_var->choices.p_values[i];
+ p_val->p_list->pi_types[i] = p_var->i_type;
+ p_var->pf_dup( &p_val->p_list->p_values[i] );
+ if( p_val2 )
+ {
+ p_val2->p_list->p_values[i].psz_string =
+ p_var->choices_text.p_values[i].psz_string ?
+ strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
+ p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
+ }
}
break;
case VLC_VAR_FREELIST:
- for( i = ((vlc_value_t*)p_val->p_address)[0].i_int ; i-- ; )
+ FreeList( p_val );
+ break;
+ case VLC_VAR_SETTEXT:
+ if( p_var->psz_text ) free( p_var->psz_text );
+ if( p_val && p_val->psz_string )
+ p_var->psz_text = strdup( p_val->psz_string );
+ break;
+ case VLC_VAR_GETTEXT:
+ p_val->psz_string = NULL;
+ if( p_var->psz_text )
{
- p_var->pf_free( &((vlc_value_t*)p_val->p_address)[i+1] );
+ p_val->psz_string = strdup( p_var->psz_text );
+ }
+ break;
+ case VLC_VAR_INHERITVALUE:
+ {
+ vlc_value_t val;
+
+ if( InheritValue( p_this, psz_name, &val, p_var->i_type )
+ == VLC_SUCCESS );
+ {
+ /* Duplicate already done */
+
+ /* Backup needed stuff */
+ oldval = p_var->val;
+ /* Check boundaries and list */
+ CheckValue( p_var, &val );
+ /* Set the variable */
+ p_var->val = val;
+ /* Free data if needed */
+ p_var->pf_free( &oldval );
+ }
+
+ if( p_val )
+ {
+ *p_val = p_var->val;
+ p_var->pf_dup( p_val );
+ }
}
- free( p_val->p_address );
break;
default:
/*****************************************************************************
* var_Type: request a variable's type
*****************************************************************************
- * This function returns the variable type if it exists, or an error if the
+ * This function returns the variable type if it exists, or 0 if the
* variable could not be found.
*****************************************************************************/
int __var_Type( vlc_object_t *p_this, const char *psz_name )
if( i_var < 0 )
{
vlc_mutex_unlock( &p_this->var_lock );
- return i_var;
+ return 0;
}
i_type = p_this->p_vars[i_var].i_type;
i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
if( i_var < 0 )
{
- msg_Err( p_this, "variable %s has disappeared" );
+ msg_Err( p_this, "variable %s has disappeared", psz_name );
vlc_mutex_unlock( &p_this->var_lock );
return VLC_ENOVAR;
}
p_var = &p_this->p_vars[i_var];
- /* Some variables trigger special behaviour. */
- switch( p_var->i_type & VLC_VAR_TYPE )
- {
- case VLC_VAR_COMMAND:
- if( p_var->val.p_address )
- {
- /* We need to save data before releasing the lock */
- int i_ret;
- int (*pf_command) (vlc_object_t *, char *, char *) =
- p_var->val.p_address;
- char *psz_cmd = strdup( p_var->psz_name );
- char *psz_arg = strdup( p_val->psz_string );
-
- vlc_mutex_unlock( &p_this->var_lock );
-
- i_ret = pf_command( p_this, psz_cmd, psz_arg );
- free( psz_cmd );
- free( psz_arg );
-
- return i_ret;
- }
- break;
- }
-
/* Really get the variable */
*p_val = p_var->val;
for( i_entry = p_var->i_entries ; i_entry-- ; )
{
if( p_var->p_entries[i_entry].pf_callback == pf_callback
- || p_var->p_entries[i_entry].p_data == p_data )
+ && p_var->p_entries[i_entry].p_data == p_data )
{
break;
}
static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
{
/* Check that our variable is in the list */
- if( p_var->i_type & VLC_VAR_ISLIST && p_var->i_choices )
+ if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
{
int i;
/* FIXME: the list is sorted, dude. Use something cleverer. */
- for( i = p_var->i_choices ; i-- ; )
+ for( i = p_var->choices.i_count ; i-- ; )
{
- if( p_var->pf_cmp( *p_val, p_var->pp_choices[i] ) == 0 )
+ if( p_var->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
{
break;
}
{
/* Free the old variable, get the new one, dup it */
p_var->pf_free( p_val );
- *p_val = p_var->pp_choices[p_var->i_default >= 0
- ? p_var->i_default : 0 ];
+ *p_val = p_var->choices.p_values[p_var->i_default >= 0
+ ? p_var->i_default : 0 ];
p_var->pf_dup( p_val );
}
}
}
}
+/*****************************************************************************
+ * InheritValue: try to inherit the value of this variable from the same one
+ * in our closest parent.
+ *****************************************************************************/
+static int InheritValue( vlc_object_t *p_this, const char *psz_name,
+ vlc_value_t *p_val, int i_type )
+{
+ int i_var;
+ variable_t *p_var;
+
+ /* No need to take the structure lock,
+ * we are only looking for our parents */
+
+ if( !p_this->p_parent )
+ {
+ switch( i_type & VLC_VAR_TYPE )
+ {
+ case VLC_VAR_FILE:
+ case VLC_VAR_DIRECTORY:
+ case VLC_VAR_STRING:
+ p_val->psz_string = config_GetPsz( p_this, psz_name );
+ if( !p_val->psz_string ) p_val->psz_string = strdup("");
+ break;
+ case VLC_VAR_FLOAT:
+ p_val->f_float = config_GetFloat( p_this, psz_name );
+ break;
+ case VLC_VAR_INTEGER:
+ p_val->i_int = config_GetInt( p_this, psz_name );
+ break;
+ case VLC_VAR_BOOL:
+ p_val->b_bool = config_GetInt( p_this, psz_name );
+ break;
+ default:
+ return VLC_ENOOBJ;
+ break;
+ }
+
+ return VLC_SUCCESS;
+ }
+
+ /* Look for the variable */
+ vlc_mutex_lock( &p_this->p_parent->var_lock );
+
+ i_var = Lookup( p_this->p_parent->p_vars, p_this->p_parent->i_vars,
+ psz_name );
+
+ if( i_var >= 0 )
+ {
+ /* We found it! */
+
+ p_var = &p_this->p_parent->p_vars[i_var];
+
+ /* Really get the variable */
+ *p_val = p_var->val;
+
+ /* Duplicate value if needed */
+ p_var->pf_dup( p_val );
+
+ vlc_mutex_unlock( &p_this->p_parent->var_lock );
+ return VLC_SUCCESS;
+ }
+
+ vlc_mutex_unlock( &p_this->p_parent->var_lock );
+
+ /* We're still not there */
+
+ return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
+}