X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Finterface%2Finteraction.c;h=82bd8ca429fca9f2121a54e1010960a35da33da9;hb=b7ccccfb9c01a7a0eeec171dde420e5a3ae6a9a7;hp=81f921863a93f4b4cb2bb03815aa06231001c133;hpb=3fbfb3d4a2960ba8833db55e80711c5279ba45a6;p=vlc diff --git a/src/interface/interaction.c b/src/interface/interaction.c index 81f921863a..82bd8ca429 100644 --- a/src/interface/interaction.c +++ b/src/interface/interaction.c @@ -1,10 +1,11 @@ /***************************************************************************** * interaction.c: User interaction functions ***************************************************************************** - * Copyright (C) 1998-2004 VideoLAN - * $Id: interface.c 10147 2005-03-05 17:18:30Z gbazin $ + * Copyright © 2005-2008 the VideoLAN team + * $Id$ * - * Authors: Clément Stenac + * Authors: Clément Stenac + * Felix Kühne * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,7 +19,7 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ /** @@ -29,514 +30,676 @@ /***************************************************************************** * Preamble *****************************************************************************/ -#include /* free(), strtol() */ -#include /* FILE */ -#include /* strerror() */ -#include -#include +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif -#include "vlc_interaction.h" -#include "vlc_interface.h" -#include "vlc_playlist.h" +#include + +#include +#include "interface.h" +#include "libvlc.h" + +#include /***************************************************************************** * Local prototypes *****************************************************************************/ -static void intf_InteractionInit( playlist_t *p_playlist ); -static interaction_t * intf_InteractionGet( vlc_object_t *p_this ); -static void intf_InteractionSearchInterface( interaction_t * - p_interaction ); -static int intf_WaitAnswer( interaction_t *p_interact, - interaction_dialog_t *p_dialog ); -static int intf_Send( interaction_t *p_interact, - interaction_dialog_t *p_dialog ); -static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* , int ); -static void intf_InteractionDialogDestroy( - interaction_dialog_t *p_dialog ); /** - * Send an interaction element to the user - * - * \param p_this the calling vlc_object_t - * \param p_interact the interaction element - * \return VLC_SUCCESS or an error code + * This structure contains the active interaction dialogs, and is + * used by the manager */ -int __intf_Interact( vlc_object_t *p_this, interaction_dialog_t * - p_dialog ) +struct interaction_t { - interaction_t *p_interaction = intf_InteractionGet( p_this ); + VLC_COMMON_MEMBERS + + vlc_thread_t thread; + vlc_cond_t wait; + + int i_dialogs; ///< Number of dialogs + interaction_dialog_t **pp_dialogs; ///< Dialogs + intf_thread_t *p_intf; ///< Interface to use + int i_last_id; ///< Last attributed ID +}; + +static interaction_t * InteractionGet( vlc_object_t * ); +static intf_thread_t * SearchInterface( interaction_t * ); +static void* InteractionLoop( void * ); +static void InteractionManage( interaction_t * ); + +static interaction_dialog_t *DialogGetById( interaction_t* , int ); +static void DialogDestroy( interaction_dialog_t * ); +static int DialogSend( vlc_object_t *, interaction_dialog_t * ); + +#define DIALOG_INIT( type ) \ + interaction_dialog_t* p_new = calloc( 1, sizeof( interaction_dialog_t ) ); \ + if( !p_new ) return VLC_EGENERIC; \ + p_new->b_cancelled = false; \ + p_new->i_status = NEW_DIALOG; \ + p_new->i_flags = 0; \ + p_new->i_type = INTERACT_DIALOG_##type; \ + p_new->psz_returned[0] = NULL; \ + p_new->psz_returned[1] = NULL + +#define FORMAT_DESC \ + va_start( args, psz_format ); \ + if( vasprintf( &p_new->psz_description, psz_format, args ) == -1 ) \ + return VLC_EGENERIC; \ + va_end( args ) - /* Get an id, if we don't already have one */ - if( p_dialog->i_id == 0 ) - { - p_dialog->i_id = ++p_interaction->i_last_id; - } +/** + * Send an error message, both in a blocking and non-blocking way + * + * \param p_this Parent vlc_object + * \param b_blocking Is this dialog blocking or not? + * \param psz_title Title for the dialog + * \param psz_format The message to display + * \return VLC_SUCCESS or VLC_EGENERIC + */ +int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking, + const char *psz_title, + const char *psz_format, ... ) +{ + va_list args; + DIALOG_INIT( ONEWAY ); - p_dialog->p_interaction = p_interaction; - p_dialog->p_parent = p_this; + p_new->psz_title = strdup( psz_title ); + FORMAT_DESC; - if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) - { - return intf_WaitAnswer( p_interaction, p_dialog ); - } + if( b_blocking ) + p_new->i_flags = DIALOG_BLOCKING_ERROR; else - { - p_dialog->i_flags |= DIALOG_GOT_ANSWER; - return intf_Send( p_interaction, p_dialog ); - } + p_new->i_flags = DIALOG_NONBLOCKING_ERROR; + + return DialogSend( p_this, p_new ); } /** - * Destroy the interaction system + * Helper function to send a warning, which is always shown non-blocking + * + * \param p_this Parent vlc_object + * \param psz_title Title for the dialog + * \param psz_format The message to display + * \return VLC_SUCCESS or VLC_EGENERIC */ -void intf_InteractionDestroy( interaction_t *p_interaction ) +int __intf_UserWarn( vlc_object_t *p_this, + const char *psz_title, + const char *psz_format, ... ) { - int i; + va_list args; + DIALOG_INIT( ONEWAY ); - // Remove all dialogs - Interfaces must be able to clean up their data + p_new->psz_title = strdup( psz_title ); + FORMAT_DESC; - for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- ) - { - interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i]; - intf_InteractionDialogDestroy( p_dialog ); - REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i ); - } + p_new->i_flags = DIALOG_WARNING; - vlc_object_destroy( p_interaction ); + return DialogSend( p_this, p_new ); } /** - * The main interaction processing loop - * This function is called from the playlist loop + * Helper function to ask a yes-no-cancel question * - * \param p_playlist the parent playlist - * \return nothing + * \param p_this Parent vlc_object + * \param psz_title Title for the dialog + * \param psz_description A description + * \param psz_default caption for the default button + * \param psz_alternate caption for the alternate button + * \param psz_other caption for the optional 3rd button (== cancel) + * \return Clicked button code */ -void intf_InteractionManage( playlist_t *p_playlist ) +int __intf_UserYesNo( vlc_object_t *p_this, + const char *psz_title, + const char *psz_description, + const char *psz_default, + const char *psz_alternate, + const char *psz_other ) { - vlc_value_t val; - int i_index; - interaction_t *p_interaction; + DIALOG_INIT( TWOWAY ); - p_interaction = p_playlist->p_interaction; + p_new->psz_title = strdup( psz_title ); + p_new->psz_description = strdup( psz_description ); + p_new->i_flags = DIALOG_YES_NO_CANCEL; + p_new->psz_default_button = strdup( psz_default ); + p_new->psz_alternate_button = strdup( psz_alternate ); + if( psz_other ) + p_new->psz_other_button = strdup( psz_other ); + + return DialogSend( p_this, p_new ); +} - // Nothing to do - if( p_interaction->i_dialogs == 0 ) return; +/** + * Helper function to create a dialogue showing a progress-bar with some info + * + * \param p_this Parent vlc_object + * \param psz_title Title for the dialog (NULL implies main intf ) + * \param psz_status Current status + * \param f_position Current position (0.0->100.0) + * \param i_timeToGo Time (in sec) to go until process is finished + * \return Dialog id, to give to UserProgressUpdate + */ +int __intf_Progress( vlc_object_t *p_this, const char *psz_title, + const char *psz_status, float f_pos, int i_time ) +{ + DIALOG_INIT( ONEWAY ); + p_new->psz_description = strdup( psz_status ); + p_new->val.f_float = f_pos; + p_new->i_timeToGo = i_time; + p_new->psz_alternate_button = strdup( _( "Cancel" ) ); - vlc_mutex_lock( &p_interaction->object_lock ); + if( psz_title ) + { + p_new->psz_title = strdup( psz_title ); + p_new->i_flags = DIALOG_USER_PROGRESS; + } + else + p_new->i_flags = DIALOG_INTF_PROGRESS; - intf_InteractionSearchInterface( p_interaction ); + DialogSend( p_this, p_new ); + return p_new->i_id; +} - if( !p_interaction->p_intf ) - { - // We mark all dialogs as answered with their "default" answer - for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ ) - { - interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index]; +/** + * Update a progress bar in a dialogue + * + * \param p_this Parent vlc_object + * \param i_id Identifier of the dialog + * \param psz_status New status + * \param f_position New position (0.0->100.0) + * \param i_timeToGo Time (in sec) to go until process is finished + * \return nothing + */ +void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id, + const char *psz_status, float f_pos, int i_time ) +{ + interaction_t *p_interaction = InteractionGet( p_this ); + interaction_dialog_t *p_dialog; - // Give default answer - p_dialog->i_return = DIALOG_DEFAULT; - if( p_dialog->i_flags & DIALOG_OK_CANCEL ) - p_dialog->i_return = DIALOG_CANCELLED; - if( p_dialog->i_flags & DIALOG_YES_NO_CANCEL ) - p_dialog->i_return = DIALOG_CANCELLED; + if( !p_interaction ) return; - // Pretend we have hidden and destroyed it - if( p_dialog->i_status == HIDDEN_DIALOG ) - { - p_dialog->i_status = DESTROYED_DIALOG; - } - else - { - p_dialog->i_status = HIDING_DIALOG; - } - } - } - else - { - vlc_object_yield( p_interaction->p_intf ); - } + vlc_object_lock( p_interaction ); + p_dialog = DialogGetById( p_interaction, i_id ); - for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ ) + if( !p_dialog ) { - interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index]; - switch( p_dialog->i_status ) - { - case ANSWERED_DIALOG: - // Ask interface to hide it - msg_Dbg( p_interaction, "Hiding dialog %i", p_dialog->i_id ); - p_dialog->i_action = INTERACT_HIDE; - val.p_address = p_dialog; - if( p_interaction->p_intf ) - var_Set( p_interaction->p_intf, "interaction", val ); - p_dialog->i_status = HIDING_DIALOG; - break; - case UPDATED_DIALOG: - p_dialog->i_action = INTERACT_UPDATE; - val.p_address = p_dialog; - if( p_interaction->p_intf ) - var_Set( p_interaction->p_intf, "interaction", val ); - p_dialog->i_status = SENT_DIALOG; - msg_Dbg( p_interaction, "Updating dialog %i, %i widgets", - p_dialog->i_id, p_dialog->i_widgets ); - break; - case HIDDEN_DIALOG: - if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break; - if( !(p_dialog->i_flags & DIALOG_REUSABLE) ) - { - msg_Dbg( p_interaction, "Destroying dialog %i", - p_dialog->i_id ); - p_dialog->i_action = INTERACT_DESTROY; - val.p_address = p_dialog; - if( p_interaction->p_intf ) - var_Set( p_interaction->p_intf, "interaction", val ); - } - break; - case DESTROYED_DIALOG: - msg_Dbg( p_interaction, "Removing dialog %i", - p_dialog->i_id ); - // Interface has now destroyed it, remove it - REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, - i_index); - i_index--; - intf_InteractionDialogDestroy( p_dialog ); - break; - case NEW_DIALOG: - // This is truly a new dialog, send it. - p_dialog->i_action = INTERACT_NEW; - val.p_address = p_dialog; - if( p_interaction->p_intf ) - var_Set( p_interaction->p_intf, "interaction", val ); - p_dialog->i_status = SENT_DIALOG; - break; - } + vlc_object_unlock( p_interaction ); + vlc_object_release( p_interaction ); + return; } - if( p_interaction->p_intf ) - { - vlc_object_release( p_interaction->p_intf ); - } + free( p_dialog->psz_description ); + p_dialog->psz_description = strdup( psz_status ); - vlc_mutex_unlock( &p_playlist->p_interaction->object_lock ); -} + p_dialog->val.f_float = f_pos; + p_dialog->i_timeToGo = i_time; + p_dialog->i_status = UPDATED_DIALOG; + vlc_cond_signal( &p_interaction->wait ); + vlc_object_unlock( p_interaction ); + vlc_object_release( p_interaction ); +} -#define INTERACT_INIT( new ) \ - new = (interaction_dialog_t*)malloc( \ - sizeof( interaction_dialog_t ) ); \ - new->i_widgets = 0; \ - new->pp_widgets = NULL; \ - new->psz_title = NULL; \ - new->psz_description = NULL; \ - new->i_id = 0; \ - new->i_flags = 0; \ - new->i_status = NEW_DIALOG; - -#define INTERACT_FREE( new ) \ - if( new->psz_title ) free( new->psz_title ); \ - if( new->psz_description ) free( new->psz_description ); - -/** Helper function to send an error message - * \param p_this Parent vlc_object - * \param i_id A predefined ID, 0 if not applicable - * \param psz_title Title for the dialog - * \param psz_format The message to display - * */ -void __intf_UserFatal( vlc_object_t *p_this, - const char *psz_title, - const char *psz_format, ... ) +/** + * Helper function to communicate dialogue cancellations between the + * interface module and the caller + * + * \param p_this Parent vlc_object + * \param i_id Identifier of the dialogue + * \return Either true or false + */ +bool __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id ) { - va_list args; - interaction_dialog_t *p_new = NULL; - user_widget_t *p_widget = NULL; - int i_id = DIALOG_ERRORS; + interaction_t *p_interaction = InteractionGet( p_this ); + interaction_dialog_t *p_dialog; + bool b_cancel; - if( i_id > 0 ) - { - p_new = intf_InteractionGetById( p_this, i_id ); - } - if( !p_new ) - { - INTERACT_INIT( p_new ); - if( i_id > 0 ) p_new->i_id = i_id ; - } - else + if( !p_interaction ) return true; + + vlc_object_lock( p_interaction ); + p_dialog = DialogGetById( p_interaction, i_id ); + if( !p_dialog ) { - p_new->i_status = UPDATED_DIALOG; + vlc_object_unlock( p_interaction ) ; + vlc_object_release( p_interaction ); + return true; } - p_new->i_flags |= DIALOG_REUSABLE; + b_cancel = p_dialog->b_cancelled; + vlc_object_unlock( p_interaction ); + vlc_object_release( p_interaction ); + return b_cancel; +} - p_new->i_type = INTERACT_DIALOG_ONEWAY; +/** + * Helper function to make a login/password dialogue + * + * \param p_this Parent vlc_object + * \param psz_title Title for the dialog + * \param psz_description A description + * \param ppsz_login Returned login + * \param ppsz_password Returned password + * \return Clicked button code + */ +int __intf_UserLoginPassword( vlc_object_t *p_this, + const char *psz_title, + const char *psz_description, + char **ppsz_login, + char **ppsz_password ) +{ + int i_ret; + DIALOG_INIT( TWOWAY ); + p_new->i_type = INTERACT_DIALOG_TWOWAY; p_new->psz_title = strdup( psz_title ); + p_new->psz_description = strdup( psz_description ); + p_new->psz_default_button = strdup( _("OK" ) ); + p_new->psz_alternate_button = strdup( _("Cancel" ) ); - p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) ); - - p_widget->i_type = WIDGET_TEXT; - p_widget->val.psz_string = NULL; - - va_start( args, psz_format ); - vasprintf( &p_widget->psz_text, psz_format, args ); - va_end( args ); + p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL; - INSERT_ELEM ( p_new->pp_widgets, - p_new->i_widgets, - p_new->i_widgets, - p_widget ); + i_ret = DialogSend( p_this, p_new ); - intf_Interact( p_this, p_new ); + if( i_ret != DIALOG_CANCELLED && i_ret != VLC_EGENERIC ) + { + *ppsz_login = p_new->psz_returned[0]? + strdup( p_new->psz_returned[0] ) : NULL; + *ppsz_password = p_new->psz_returned[1]? + strdup( p_new->psz_returned[1] ) : NULL; + } + return i_ret; } -/** Helper function to make a login/password box - * \param p_this Parent vlc_object - * \param psz_title Title for the dialog - * \param psz_description A description - * \param ppsz_login Returned login - * \param ppsz_password Returned password - * \return 1 if user clicked Cancel, 0 if OK +/** + * Helper function to make a dialogue asking the user for !password string + * + * \param p_this Parent vlc_object + * \param psz_title Title for the dialog + * \param psz_description A description + * \param ppsz_usersString Returned login + * \return Clicked button code */ -int __intf_UserLoginPassword( vlc_object_t *p_this, - const char *psz_title, - const char *psz_description, - char **ppsz_login, - char **ppsz_password ) +int __intf_UserStringInput( vlc_object_t *p_this, + const char *psz_title, + const char *psz_description, + char **ppsz_usersString ) { int i_ret; - interaction_dialog_t *p_new = NULL; - user_widget_t *p_widget = NULL; - - INTERACT_INIT( p_new ); - + DIALOG_INIT( TWOWAY ); p_new->i_type = INTERACT_DIALOG_TWOWAY; p_new->psz_title = strdup( psz_title ); + p_new->psz_description = strdup( psz_description ); - /* Text */ - p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) ); - p_widget->i_type = WIDGET_TEXT; - p_widget->psz_text = strdup( psz_description ); - p_widget->val.psz_string = NULL; - INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets, - p_new->i_widgets, p_widget ); - - /* Login */ - p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) ); - p_widget->i_type = WIDGET_INPUT_TEXT; - p_widget->psz_text = strdup( _("Login") ); - p_widget->val.psz_string = NULL; - INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets, - p_new->i_widgets, p_widget ); - - /* Password */ - p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) ); - p_widget->i_type = WIDGET_INPUT_TEXT; - p_widget->psz_text = strdup( _("Password") ); - p_widget->val.psz_string = NULL; - INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets, - p_new->i_widgets, p_widget ); - - p_new->i_flags = DIALOG_OK_CANCEL; - - i_ret = intf_Interact( p_this, p_new ); + p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL; + + i_ret = DialogSend( p_this, p_new ); if( i_ret != DIALOG_CANCELLED ) { - *ppsz_login = strdup( p_new->pp_widgets[1]->val.psz_string ); - *ppsz_password = strdup( p_new->pp_widgets[2]->val.psz_string ); + *ppsz_usersString = p_new->psz_returned[0]? + strdup( p_new->psz_returned[0] ) : NULL; } return i_ret; } -/********************************************************************** - * The following functions are local - **********************************************************************/ - -/* Get the interaction object. Create it if needed */ -static interaction_t * intf_InteractionGet( vlc_object_t *p_this ) +/** + * Hide an interaction dialog + * + * \param p_this the parent vlc object + * \param i_id the id of the item to hide + * \return nothing + */ +void __intf_UserHide( vlc_object_t *p_this, int i_id ) { - playlist_t *p_playlist; - interaction_t *p_interaction; + interaction_t *p_interaction = InteractionGet( p_this ); + interaction_dialog_t *p_dialog; - p_playlist = (playlist_t*) vlc_object_find( p_this, VLC_OBJECT_PLAYLIST, - FIND_ANYWHERE ); + if( !p_interaction ) return; - if( !p_playlist ) - { - return NULL; - } + vlc_object_lock( p_interaction ); + p_dialog = DialogGetById( p_interaction, i_id ); - if( p_playlist->p_interaction == NULL ) + if( p_dialog ) { - intf_InteractionInit( p_playlist ); + p_dialog->i_status = ANSWERED_DIALOG; + vlc_cond_signal( &p_interaction->wait ); } - p_interaction = p_playlist->p_interaction; - - vlc_object_release( p_playlist ); - - return p_interaction; + vlc_object_unlock( p_interaction ); + vlc_object_release( p_interaction ); } -/* Create the interaction object in the given playlist object */ -static void intf_InteractionInit( playlist_t *p_playlist ) +/** + * Create the initial interaction object + * (should only be used in libvlc_InternalInit, LibVLC private) + * + * \return a vlc_object_t that should be freed when done. + */ +interaction_t * interaction_Init( libvlc_int_t *p_libvlc ) { interaction_t *p_interaction; - msg_Dbg( p_playlist, "initializing interaction system" ); + /* Make sure we haven't yet created an interaction object */ + assert( libvlc_priv(p_libvlc)->p_interaction == NULL ); - p_interaction = vlc_object_create( VLC_OBJECT( p_playlist ), - sizeof( interaction_t ) ); + p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc), + sizeof( *p_interaction ), + VLC_OBJECT_GENERIC, "interaction" ); if( !p_interaction ) - { - msg_Err( p_playlist,"out of memory" ); - return; - } + return NULL; + vlc_object_attach( p_interaction, p_libvlc ); p_interaction->i_dialogs = 0; p_interaction->pp_dialogs = NULL; p_interaction->p_intf = NULL; - p_interaction->i_last_id = DIALOG_LAST_PREDEFINED + 1; + p_interaction->i_last_id = 0; + + vlc_cond_init( &p_interaction->wait ); - vlc_mutex_init( p_interaction , &p_interaction->object_lock ); + if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction, + VLC_THREAD_PRIORITY_LOW ) ) + { + msg_Err( p_interaction, "Interaction control thread creation failed, " + "interaction will not be displayed" ); + vlc_object_detach( p_interaction ); + vlc_object_release( p_interaction ); + return NULL; + } - p_playlist->p_interaction = p_interaction; + return p_interaction; } -/* Look for an interface suitable for interaction */ -static void intf_InteractionSearchInterface( interaction_t *p_interaction ) +void interaction_Destroy( interaction_t *p_interaction ) { - vlc_list_t *p_list; - int i_index; + if( !p_interaction ) + return; - p_interaction->p_intf = NULL; + vlc_cancel( p_interaction->thread ); + vlc_join( p_interaction->thread, NULL ); + vlc_cond_destroy( &p_interaction->wait ); - p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE ); - if( !p_list ) + /* Remove all dialogs - Interfaces must be able to clean up their data */ + for( int i = p_interaction->i_dialogs -1 ; i >= 0; i-- ) { - msg_Err( p_interaction, "Unable to create module list" ); - return; + interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i]; + DialogDestroy( p_dialog ); + REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i ); } + vlc_object_release( p_interaction ); +} + +static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX; + +int interaction_Register( intf_thread_t *intf ) +{ + libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc ); + int ret = VLC_EGENERIC; + + vlc_mutex_lock( &intf_lock ); + if( priv->p_interaction_intf == NULL ) + { /* Since the interface is responsible for unregistering itself before + * it terminates, an object reference is not needed. */ + priv->p_interaction_intf = intf; + ret = VLC_SUCCESS; + } + vlc_mutex_unlock( &intf_lock ); + return ret; +} + +int interaction_Unregister( intf_thread_t *intf ) +{ + libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc ); + int ret = VLC_EGENERIC; - for( i_index = 0; i_index < p_list->i_count; i_index ++ ) + vlc_mutex_lock( &intf_lock ); + if( priv->p_interaction_intf == intf ) { - intf_thread_t *p_intf = (intf_thread_t *) - p_list->p_values[i_index].p_object; - if( p_intf->b_interaction ) - { - p_interaction->p_intf = p_intf; - break; - } + priv->p_interaction_intf = NULL; + ret = VLC_SUCCESS; } - vlc_list_release ( p_list ); + vlc_mutex_unlock( &intf_lock ); + return ret; +} + +/********************************************************************** + * The following functions are local + **********************************************************************/ + +/* Get the interaction object. Create it if needed */ +static interaction_t * InteractionGet( vlc_object_t *p_this ) +{ + interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction; + if( obj ) + vlc_object_hold( obj ); + return obj; } -/* Add a dialog to the queue and wait for answer */ -static int intf_WaitAnswer( interaction_t *p_interact, interaction_dialog_t *p_dialog ) + +/* Look for an interface suitable for interaction, and hold it. */ +static intf_thread_t *SearchInterface( interaction_t *p_interaction ) +{ + libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc ); + intf_thread_t *intf; + + vlc_mutex_lock( &intf_lock ); + intf = priv->p_interaction_intf; + if( intf != NULL ) + vlc_object_hold( intf ); + vlc_mutex_unlock( &intf_lock ); + + return intf; +} + +/* Find an interaction dialog by its id */ +static interaction_dialog_t *DialogGetById( interaction_t *p_interaction, + int i_id ) { int i; - vlc_bool_t b_found = VLC_FALSE; - vlc_mutex_lock( &p_interact->object_lock ); - for( i = 0 ; i< p_interact->i_dialogs; i++ ) + for( i = 0 ; i< p_interaction->i_dialogs; i++ ) { - if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id ) - { - b_found = VLC_TRUE; - } + if( p_interaction->pp_dialogs[i]->i_id == i_id ) + return p_interaction->pp_dialogs[i]; } - if( ! b_found ) + return NULL; +} + +/* Destroy a dialog */ +static void DialogDestroy( interaction_dialog_t *p_dialog ) +{ + free( p_dialog->psz_title ); + free( p_dialog->psz_description ); + free( p_dialog->psz_default_button ); + free( p_dialog->psz_alternate_button ); + free( p_dialog->psz_other_button ); + free( p_dialog ); +} + +/* Ask for the dialog to be sent to the user. Wait for answer + * if required */ +static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog ) +{ + interaction_t *p_interaction = InteractionGet( p_this ); + + if( !p_interaction ) + return VLC_EGENERIC; + + /* Get an id, if we don't already have one */ + vlc_object_lock( p_interaction ); + if( p_dialog->i_id == 0 ) + p_dialog->i_id = ++p_interaction->i_last_id; + vlc_object_unlock( p_interaction ); + + if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) { - INSERT_ELEM( p_interact->pp_dialogs, - p_interact->i_dialogs, - p_interact->i_dialogs, - p_dialog ); + vlc_object_release( p_interaction ); + return VLC_EGENERIC; } - else - p_dialog->i_status = UPDATED_DIALOG; - vlc_mutex_unlock( &p_interact->object_lock ); - - /// \todo Check that the initiating object is not dying - while( p_dialog->i_status != ANSWERED_DIALOG && - p_dialog->i_status != HIDING_DIALOG && - p_dialog->i_status != HIDDEN_DIALOG && - !p_dialog->p_parent->b_die ) + + if( config_GetInt( p_this, "interact" ) || + p_dialog->i_flags & DIALOG_BLOCKING_ERROR || + p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR ) { - msleep( 100000 ); + bool b_found = false; + int i; + p_dialog->p_interaction = p_interaction; + p_dialog->p_parent = p_this; + + /* Check if we have already added this dialog */ + vlc_object_lock( p_interaction ); + for( i = 0 ; i< p_interaction->i_dialogs; i++ ) + { + if( p_interaction->pp_dialogs[i]->i_id == p_dialog->i_id ) + b_found = true; + } + /* Add it to the queue, the main loop will send the orders to the + * interface */ + if( ! b_found ) + { + INSERT_ELEM( p_interaction->pp_dialogs, + p_interaction->i_dialogs, + p_interaction->i_dialogs, + p_dialog ); + } + else + p_dialog->i_status = UPDATED_DIALOG; + + if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */ + { + vlc_cond_signal( &p_interaction->wait ); + while( p_dialog->i_status != ANSWERED_DIALOG && + p_dialog->i_status != HIDING_DIALOG && + p_dialog->i_status != HIDDEN_DIALOG && + !p_dialog->p_parent->b_die ) + { + vlc_object_unlock( p_interaction ); + msleep( 100000 ); + vlc_object_lock( p_interaction ); + } + if( p_dialog->p_parent->b_die ) + { + p_dialog->i_return = DIALOG_CANCELLED; + p_dialog->i_status = ANSWERED_DIALOG; + } + p_dialog->i_flags |= DIALOG_GOT_ANSWER; + vlc_cond_signal( &p_interaction->wait ); + vlc_object_unlock( p_interaction ); + vlc_object_release( p_interaction ); + return p_dialog->i_return; + } + else + { + /* Pretend we already retrieved the "answer" */ + p_dialog->i_flags |= DIALOG_GOT_ANSWER; + vlc_cond_signal( &p_interaction->wait ); + vlc_object_unlock( p_interaction ); + vlc_object_release( p_interaction ); + return VLC_SUCCESS; + } } - /// \todo locking - if( p_dialog->p_parent->b_die ) + else { - p_dialog->i_return = DIALOG_CANCELLED; - p_dialog->i_status = ANSWERED_DIALOG; + vlc_object_release( p_interaction ); + return VLC_EGENERIC; } - p_dialog->i_flags |= DIALOG_GOT_ANSWER; - return p_dialog->i_return; } -/* Add a dialog to the queue and return */ -static int intf_Send( interaction_t *p_interact, interaction_dialog_t *p_dialog ) +static void* InteractionLoop( void *p_this ) { - int i; - vlc_bool_t b_found = VLC_FALSE; - vlc_mutex_lock( &p_interact->object_lock ); + interaction_t *p_interaction = p_this; - for( i = 0 ; i< p_interact->i_dialogs; i++ ) - { - if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id ) - { - b_found = VLC_TRUE; - } - } - if( !b_found ) + vlc_object_lock( p_interaction ); + mutex_cleanup_push( &(vlc_internals(p_interaction)->lock) ); + for( ;; ) { - INSERT_ELEM( p_interact->pp_dialogs, - p_interact->i_dialogs, - p_interact->i_dialogs, - p_dialog ); + int canc = vlc_savecancel(); + InteractionManage( p_interaction ); + vlc_restorecancel( canc ); + + vlc_cond_wait( &p_interaction->wait, &(vlc_internals(p_interaction)->lock) ); } - else - p_dialog->i_status = UPDATED_DIALOG; - // Pretend we already retrieved the "answer" - p_dialog->i_flags |= DIALOG_GOT_ANSWER; - vlc_mutex_unlock( &p_interact->object_lock ); - return VLC_SUCCESS; + vlc_cleanup_pop( ); + assert( 0 ); } -/* Find an interaction dialog by its id */ -static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* p_this, - int i_id ) +/** + * The main interaction processing loop + * + * \param p_interaction the interaction object + * \return nothing + */ + +static void InteractionManage( interaction_t *p_interaction ) { - interaction_t *p_interaction = intf_InteractionGet( p_this ); - int i; + vlc_value_t val; + int i_index; - if( !p_interaction ) return NULL; + /* Nothing to do */ + if( p_interaction->i_dialogs == 0 ) return; - for( i = 0 ; i< p_interaction->i_dialogs; i++ ) + p_interaction->p_intf = SearchInterface( p_interaction ); + if( !p_interaction->p_intf ) { - if( p_interaction->pp_dialogs[i]->i_id == i_id ) + /* We mark all dialogs as answered with their "default" answer */ + for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ ) { - return p_interaction->pp_dialogs[i]; + interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index]; + p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */ + + /* Pretend we have hidden and destroyed it */ + if( p_dialog->i_status == HIDDEN_DIALOG ) + p_dialog->i_status = DESTROYED_DIALOG; + else + p_dialog->i_status = HIDING_DIALOG; } } - return NULL; -} - -#define FREE( i ) { if( i ) free( i ); i = NULL; } -static void intf_InteractionDialogDestroy( interaction_dialog_t *p_dialog ) -{ - int i; - for( i = p_dialog->i_widgets - 1 ; i >= 0 ; i-- ) + for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ ) { - user_widget_t *p_widget = p_dialog->pp_widgets[i]; - FREE( p_widget->psz_text ); - FREE( p_widget->val.psz_string ); + interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index]; + switch( p_dialog->i_status ) + { + case ANSWERED_DIALOG: + /* Ask interface to hide it */ + p_dialog->i_action = INTERACT_HIDE; + val.p_address = p_dialog; + if( p_interaction->p_intf ) + var_Set( p_interaction->p_intf, "interaction", val ); + p_dialog->i_status = HIDING_DIALOG; + break; + case UPDATED_DIALOG: + p_dialog->i_action = INTERACT_UPDATE; + val.p_address = p_dialog; + if( p_interaction->p_intf ) + var_Set( p_interaction->p_intf, "interaction", val ); + p_dialog->i_status = SENT_DIALOG; + break; + case HIDDEN_DIALOG: + if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break; + p_dialog->i_action = INTERACT_DESTROY; + val.p_address = p_dialog; + if( p_interaction->p_intf ) + var_Set( p_interaction->p_intf, "interaction", val ); + break; + case DESTROYED_DIALOG: + /* Interface has now destroyed it, remove it */ + REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, + i_index); + i_index--; + DialogDestroy( p_dialog ); + break; + case NEW_DIALOG: + /* This is truly a new dialog, send it. */ - REMOVE_ELEM( p_dialog->pp_widgets, p_dialog->i_widgets, i ); - free( p_widget ); + p_dialog->i_action = INTERACT_NEW; + val.p_address = p_dialog; + if( p_interaction->p_intf ) + var_Set( p_interaction->p_intf, "interaction", val ); + p_dialog->i_status = SENT_DIALOG; + break; + } } - FREE( p_dialog->psz_title ); - FREE( p_dialog->psz_description ); - free( p_dialog ); + if( p_interaction->p_intf ) + vlc_object_release( p_interaction->p_intf ); }