1 /*****************************************************************************
2 * interaction.c: User interaction functions
3 *****************************************************************************
4 * Copyright © 2005-2008 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Felix Kühne <fkuehne@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
27 * This file contains functions related to user interaction management
30 /*****************************************************************************
32 *****************************************************************************/
38 #include <vlc_common.h>
40 #include <vlc_interface.h>
41 #include "interface.h"
45 /*****************************************************************************
47 *****************************************************************************/
48 static interaction_t * InteractionGet( vlc_object_t * );
49 static void InteractionSearchInterface( interaction_t * );
50 static void InteractionLoop( vlc_object_t * );
51 static void InteractionManage( interaction_t * );
53 static interaction_dialog_t *DialogGetById( interaction_t* , int );
54 static void DialogDestroy( interaction_dialog_t * );
55 static int DialogSend( vlc_object_t *, interaction_dialog_t * );
57 #define DIALOG_INIT( type ) \
58 DECMALLOC_ERR( p_new, interaction_dialog_t ); \
59 memset( p_new, 0, sizeof( interaction_dialog_t ) ); \
60 p_new->b_cancelled = false; \
61 p_new->i_status = NEW_DIALOG; \
63 p_new->i_type = INTERACT_DIALOG_##type; \
64 p_new->psz_returned[0] = NULL; \
65 p_new->psz_returned[1] = NULL
68 va_start( args, psz_format ); \
69 if( vasprintf( &p_new->psz_description, psz_format, args ) == -1 ) \
70 return VLC_EGENERIC; \
74 * Send an error message, both in a blocking and non-blocking way
76 * \param p_this Parent vlc_object
77 * \param b_blocking Is this dialog blocking or not?
78 * \param psz_title Title for the dialog
79 * \param psz_format The message to display
80 * \return VLC_SUCCESS or VLC_EGENERIC
82 int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking,
83 const char *psz_title,
84 const char *psz_format, ... )
87 DIALOG_INIT( ONEWAY );
89 p_new->psz_title = strdup( psz_title );
93 p_new->i_flags = DIALOG_BLOCKING_ERROR;
95 p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
97 return DialogSend( p_this, p_new );
101 * Helper function to send a warning, which is always shown non-blocking
103 * \param p_this Parent vlc_object
104 * \param psz_title Title for the dialog
105 * \param psz_format The message to display
106 * \return VLC_SUCCESS or VLC_EGENERIC
108 int __intf_UserWarn( vlc_object_t *p_this,
109 const char *psz_title,
110 const char *psz_format, ... )
113 DIALOG_INIT( ONEWAY );
115 p_new->psz_title = strdup( psz_title );
118 p_new->i_flags = DIALOG_WARNING;
120 return DialogSend( p_this, p_new );
124 * Helper function to ask a yes-no-cancel question
126 * \param p_this Parent vlc_object
127 * \param psz_title Title for the dialog
128 * \param psz_description A description
129 * \param psz_default caption for the default button
130 * \param psz_alternate caption for the alternate button
131 * \param psz_other caption for the optional 3rd button (== cancel)
132 * \return Clicked button code
134 int __intf_UserYesNo( vlc_object_t *p_this,
135 const char *psz_title,
136 const char *psz_description,
137 const char *psz_default,
138 const char *psz_alternate,
139 const char *psz_other )
141 DIALOG_INIT( TWOWAY );
143 p_new->psz_title = strdup( psz_title );
144 p_new->psz_description = strdup( psz_description );
145 p_new->i_flags = DIALOG_YES_NO_CANCEL;
146 p_new->psz_default_button = strdup( psz_default );
147 p_new->psz_alternate_button = strdup( psz_alternate );
149 p_new->psz_other_button = strdup( psz_other );
151 return DialogSend( p_this, p_new );
155 * Helper function to create a dialogue showing a progress-bar with some info
157 * \param p_this Parent vlc_object
158 * \param psz_title Title for the dialog (NULL implies main intf )
159 * \param psz_status Current status
160 * \param f_position Current position (0.0->100.0)
161 * \param i_timeToGo Time (in sec) to go until process is finished
162 * \return Dialog id, to give to UserProgressUpdate
164 int __intf_Progress( vlc_object_t *p_this, const char *psz_title,
165 const char *psz_status, float f_pos, int i_time )
167 DIALOG_INIT( ONEWAY );
168 p_new->psz_description = strdup( psz_status );
169 p_new->val.f_float = f_pos;
170 p_new->i_timeToGo = i_time;
171 p_new->psz_alternate_button = strdup( _( "Cancel" ) );
175 p_new->psz_title = strdup( psz_title );
176 p_new->i_flags = DIALOG_USER_PROGRESS;
179 p_new->i_flags = DIALOG_INTF_PROGRESS;
181 DialogSend( p_this, p_new );
186 * Update a progress bar in a dialogue
188 * \param p_this Parent vlc_object
189 * \param i_id Identifier of the dialog
190 * \param psz_status New status
191 * \param f_position New position (0.0->100.0)
192 * \param i_timeToGo Time (in sec) to go until process is finished
195 void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
196 const char *psz_status, float f_pos, int i_time )
198 interaction_t *p_interaction = InteractionGet( p_this );
199 interaction_dialog_t *p_dialog;
201 if( !p_interaction ) return;
203 vlc_object_lock( p_interaction );
204 p_dialog = DialogGetById( p_interaction, i_id );
208 vlc_object_unlock( p_interaction );
209 vlc_object_release( p_interaction );
213 free( p_dialog->psz_description );
214 p_dialog->psz_description = strdup( psz_status );
216 p_dialog->val.f_float = f_pos;
217 p_dialog->i_timeToGo = i_time;
219 p_dialog->i_status = UPDATED_DIALOG;
221 vlc_object_signal_unlocked( p_interaction );
222 vlc_object_unlock( p_interaction );
223 vlc_object_release( p_interaction );
227 * Helper function to communicate dialogue cancellations between the
228 * interface module and the caller
230 * \param p_this Parent vlc_object
231 * \param i_id Identifier of the dialogue
232 * \return Either true or false
234 bool __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
236 interaction_t *p_interaction = InteractionGet( p_this );
237 interaction_dialog_t *p_dialog;
240 if( !p_interaction ) return true;
242 vlc_object_lock( p_interaction );
243 p_dialog = DialogGetById( p_interaction, i_id );
246 vlc_object_unlock( p_interaction ) ;
247 vlc_object_release( p_interaction );
251 b_cancel = p_dialog->b_cancelled;
252 vlc_object_unlock( p_interaction );
253 vlc_object_release( p_interaction );
258 * Helper function to make a login/password dialogue
260 * \param p_this Parent vlc_object
261 * \param psz_title Title for the dialog
262 * \param psz_description A description
263 * \param ppsz_login Returned login
264 * \param ppsz_password Returned password
265 * \return Clicked button code
267 int __intf_UserLoginPassword( vlc_object_t *p_this,
268 const char *psz_title,
269 const char *psz_description,
271 char **ppsz_password )
274 DIALOG_INIT( TWOWAY );
275 p_new->i_type = INTERACT_DIALOG_TWOWAY;
276 p_new->psz_title = strdup( psz_title );
277 p_new->psz_description = strdup( psz_description );
278 p_new->psz_default_button = strdup( _("Ok" ) );
279 p_new->psz_alternate_button = strdup( _("Cancel" ) );
281 p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
283 i_ret = DialogSend( p_this, p_new );
285 if( i_ret != DIALOG_CANCELLED && i_ret != VLC_EGENERIC )
287 *ppsz_login = p_new->psz_returned[0]?
288 strdup( p_new->psz_returned[0] ) : NULL;
289 *ppsz_password = p_new->psz_returned[1]?
290 strdup( p_new->psz_returned[1] ) : NULL;
296 * Helper function to make a dialogue asking the user for !password string
298 * \param p_this Parent vlc_object
299 * \param psz_title Title for the dialog
300 * \param psz_description A description
301 * \param ppsz_usersString Returned login
302 * \return Clicked button code
304 int __intf_UserStringInput( vlc_object_t *p_this,
305 const char *psz_title,
306 const char *psz_description,
307 char **ppsz_usersString )
310 DIALOG_INIT( TWOWAY );
311 p_new->i_type = INTERACT_DIALOG_TWOWAY;
312 p_new->psz_title = strdup( psz_title );
313 p_new->psz_description = strdup( psz_description );
315 p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL;
317 i_ret = DialogSend( p_this, p_new );
319 if( i_ret != DIALOG_CANCELLED )
321 *ppsz_usersString = p_new->psz_returned[0]?
322 strdup( p_new->psz_returned[0] ) : NULL;
328 * Hide an interaction dialog
330 * \param p_this the parent vlc object
331 * \param i_id the id of the item to hide
334 void __intf_UserHide( vlc_object_t *p_this, int i_id )
336 interaction_t *p_interaction = InteractionGet( p_this );
337 interaction_dialog_t *p_dialog;
339 if( !p_interaction ) return;
341 vlc_object_lock( p_interaction );
342 p_dialog = DialogGetById( p_interaction, i_id );
345 p_dialog->i_status = ANSWERED_DIALOG;
347 vlc_object_unlock( p_interaction );
348 vlc_object_release( p_interaction );
352 * Create the initial interaction object
353 * (should only be used in libvlc_InternalInit, LibVLC private)
355 * \return a vlc_object_t that should be freed when done.
357 vlc_object_t * interaction_Init( libvlc_int_t *p_libvlc )
359 interaction_t *p_interaction;
361 /* Make sure we haven't yet created an interaction object */
362 assert( vlc_object_find( p_libvlc, VLC_OBJECT_INTERACTION, FIND_ANYWHERE ) == NULL );
364 p_interaction = vlc_object_create( p_libvlc, VLC_OBJECT_INTERACTION );
368 vlc_object_attach( p_interaction, p_libvlc );
370 p_interaction->i_dialogs = 0;
371 p_interaction->pp_dialogs = NULL;
372 p_interaction->p_intf = NULL;
373 p_interaction->i_last_id = 0;
375 if( vlc_thread_create( p_interaction, "Interaction control",
376 InteractionLoop, VLC_THREAD_PRIORITY_LOW,
379 msg_Err( p_interaction, "Interaction control thread creation failed"
380 ", interaction will not be displayed" );
381 vlc_object_detach( p_interaction );
382 vlc_object_release( p_interaction );
383 p_interaction = NULL;
387 return VLC_OBJECT( p_interaction );
390 /**********************************************************************
391 * The following functions are local
392 **********************************************************************/
394 /* Get the interaction object. Create it if needed */
395 static interaction_t * InteractionGet( vlc_object_t *p_this )
397 return vlc_object_find( p_this, VLC_OBJECT_INTERACTION, FIND_ANYWHERE );
401 /* Look for an interface suitable for interaction */
402 static void InteractionSearchInterface( interaction_t *p_interaction )
407 p_interaction->p_intf = NULL;
409 p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
412 msg_Err( p_interaction, "unable to create module list" );
416 for( i_index = 0; i_index < p_list->i_count; i_index ++ )
418 intf_thread_t *p_intf = (intf_thread_t *)
419 p_list->p_values[i_index].p_object;
420 if( p_intf->b_interaction )
422 p_interaction->p_intf = p_intf;
426 vlc_list_release ( p_list );
429 /* Find an interaction dialog by its id */
430 static interaction_dialog_t *DialogGetById( interaction_t *p_interaction,
434 for( i = 0 ; i< p_interaction->i_dialogs; i++ )
436 if( p_interaction->pp_dialogs[i]->i_id == i_id )
437 return p_interaction->pp_dialogs[i];
442 /* Destroy a dialog */
443 static void DialogDestroy( interaction_dialog_t *p_dialog )
445 free( p_dialog->psz_title );
446 free( p_dialog->psz_description );
447 free( p_dialog->psz_default_button );
448 free( p_dialog->psz_alternate_button );
449 free( p_dialog->psz_other_button );
453 /* Ask for the dialog to be sent to the user. Wait for answer
455 static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
457 interaction_t *p_interaction = InteractionGet( p_this );
459 /* Get an id, if we don't already have one */
460 if( p_dialog->i_id == 0 )
461 p_dialog->i_id = ++p_interaction->i_last_id;
463 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC;
465 if( config_GetInt( p_this, "interact" ) ||
466 p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
467 p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
469 bool b_found = false;
471 p_dialog->p_interaction = p_interaction;
472 p_dialog->p_parent = p_this;
474 /* Check if we have already added this dialog */
475 vlc_object_lock( p_interaction );
476 for( i = 0 ; i< p_interaction->i_dialogs; i++ )
478 if( p_interaction->pp_dialogs[i]->i_id == p_dialog->i_id )
481 /* Add it to the queue, the main loop will send the orders to the
485 INSERT_ELEM( p_interaction->pp_dialogs,
486 p_interaction->i_dialogs,
487 p_interaction->i_dialogs,
491 p_dialog->i_status = UPDATED_DIALOG;
493 if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
495 vlc_object_signal_unlocked( p_interaction );
496 while( p_dialog->i_status != ANSWERED_DIALOG &&
497 p_dialog->i_status != HIDING_DIALOG &&
498 p_dialog->i_status != HIDDEN_DIALOG &&
499 !p_dialog->p_parent->b_die )
501 vlc_object_unlock( p_interaction );
503 vlc_object_lock( p_interaction );
505 if( p_dialog->p_parent->b_die )
507 p_dialog->i_return = DIALOG_CANCELLED;
508 p_dialog->i_status = ANSWERED_DIALOG;
510 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
511 vlc_object_signal_unlocked( p_interaction );
512 vlc_object_unlock( p_interaction );
513 vlc_object_release( p_interaction );
514 return p_dialog->i_return;
518 /* Pretend we already retrieved the "answer" */
519 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
520 vlc_object_signal_unlocked( p_interaction );
521 vlc_object_unlock( p_interaction );
522 vlc_object_release( p_interaction );
528 vlc_object_release( p_interaction );
533 static void InteractionLoop( vlc_object_t *p_this )
536 interaction_t *p_interaction = (interaction_t*) p_this;
538 vlc_object_lock( p_this );
539 while( vlc_object_alive( p_this ) )
541 InteractionManage( p_interaction );
542 vlc_object_wait( p_this );
544 vlc_object_unlock( p_this );
546 /* Remove all dialogs - Interfaces must be able to clean up their data */
547 for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
549 interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
550 DialogDestroy( p_dialog );
551 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
556 * The main interaction processing loop
558 * \param p_interaction the interaction object
562 static void InteractionManage( interaction_t *p_interaction )
568 if( p_interaction->i_dialogs == 0 ) return;
570 InteractionSearchInterface( p_interaction );
571 if( !p_interaction->p_intf )
573 /* We mark all dialogs as answered with their "default" answer */
574 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
576 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
577 p_dialog->i_return = DIALOG_DEFAULT; /* Give default answer */
579 /* Pretend we have hidden and destroyed it */
580 if( p_dialog->i_status == HIDDEN_DIALOG )
581 p_dialog->i_status = DESTROYED_DIALOG;
583 p_dialog->i_status = HIDING_DIALOG;
587 vlc_object_yield( p_interaction->p_intf );
589 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
591 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
592 switch( p_dialog->i_status )
594 case ANSWERED_DIALOG:
595 /* Ask interface to hide it */
596 p_dialog->i_action = INTERACT_HIDE;
597 val.p_address = p_dialog;
598 if( p_interaction->p_intf )
599 var_Set( p_interaction->p_intf, "interaction", val );
600 p_dialog->i_status = HIDING_DIALOG;
603 p_dialog->i_action = INTERACT_UPDATE;
604 val.p_address = p_dialog;
605 if( p_interaction->p_intf )
606 var_Set( p_interaction->p_intf, "interaction", val );
607 p_dialog->i_status = SENT_DIALOG;
610 if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
611 p_dialog->i_action = INTERACT_DESTROY;
612 val.p_address = p_dialog;
613 if( p_interaction->p_intf )
614 var_Set( p_interaction->p_intf, "interaction", val );
616 case DESTROYED_DIALOG:
617 /* Interface has now destroyed it, remove it */
618 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
621 DialogDestroy( p_dialog );
624 /* This is truly a new dialog, send it. */
626 p_dialog->i_action = INTERACT_NEW;
627 val.p_address = p_dialog;
628 if( p_interaction->p_intf )
629 var_Set( p_interaction->p_intf, "interaction", val );
630 p_dialog->i_status = SENT_DIALOG;
635 if( p_interaction->p_intf )
636 vlc_object_release( p_interaction->p_intf );