1 /*****************************************************************************
2 * interaction.c: User interaction functions
3 *****************************************************************************
4 * Copyright (C) 1998-2004 VideoLAN
5 * $Id: interface.c 10147 2005-03-05 17:18:30Z gbazin $
7 * Authors: Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
26 * This file contains functions related to user interaction management
29 /*****************************************************************************
31 *****************************************************************************/
32 #include <stdlib.h> /* free(), strtol() */
33 #include <stdio.h> /* FILE */
34 #include <string.h> /* strerror() */
37 #include <vlc/input.h>
39 #include "vlc_interaction.h"
40 #include "vlc_interface.h"
41 #include "vlc_playlist.h"
43 /*****************************************************************************
45 *****************************************************************************/
46 static void intf_InteractionInit( playlist_t *p_playlist );
47 static interaction_t * intf_InteractionGet( vlc_object_t *p_this );
48 static void intf_InteractionSearchInterface( interaction_t *
50 static int intf_WaitAnswer( interaction_t *p_interact,
51 interaction_dialog_t *p_dialog );
52 static int intf_Send( interaction_t *p_interact,
53 interaction_dialog_t *p_dialog );
54 static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* , int );
55 static void intf_InteractionDialogDestroy(
56 interaction_dialog_t *p_dialog );
59 * Send an interaction element to the user
61 * \param p_this the calling vlc_object_t
62 * \param p_interact the interaction element
63 * \return VLC_SUCCESS or an error code
65 int __intf_Interact( vlc_object_t *p_this, interaction_dialog_t *
68 interaction_t *p_interaction = intf_InteractionGet( p_this );
70 /* Get an id, if we don't already have one */
71 if( p_dialog->i_id == 0 )
73 p_dialog->i_id = ++p_interaction->i_last_id;
76 p_dialog->p_interaction = p_interaction;
77 p_dialog->p_parent = p_this;
79 if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY )
81 return intf_WaitAnswer( p_interaction, p_dialog );
85 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
86 return intf_Send( p_interaction, p_dialog );
91 * Destroy the interaction system
93 void intf_InteractionDestroy( interaction_t *p_interaction )
97 // Remove all dialogs - Interfaces must be able to clean up their data
99 for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
101 interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
102 intf_InteractionDialogDestroy( p_dialog );
103 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
106 vlc_object_destroy( p_interaction );
110 * The main interaction processing loop
111 * This function is called from the playlist loop
113 * \param p_playlist the parent playlist
116 void intf_InteractionManage( playlist_t *p_playlist )
120 interaction_t *p_interaction;
122 p_interaction = p_playlist->p_interaction;
125 if( p_interaction->i_dialogs == 0 ) return;
127 vlc_mutex_lock( &p_interaction->object_lock );
129 intf_InteractionSearchInterface( p_interaction );
131 if( !p_interaction->p_intf )
133 // We mark all dialogs as answered with their "default" answer
134 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
136 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
138 // Give default answer
139 p_dialog->i_return = DIALOG_DEFAULT;
140 if( p_dialog->i_flags & DIALOG_OK_CANCEL )
141 p_dialog->i_return = DIALOG_CANCELLED;
143 // Pretend we have hidden and destroyed it
144 if( p_dialog->i_status == HIDDEN_DIALOG )
146 p_dialog->i_status = DESTROYED_DIALOG;
150 p_dialog->i_status = HIDING_DIALOG;
156 vlc_object_yield( p_interaction->p_intf );
159 for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
161 interaction_dialog_t *p_dialog = p_interaction->pp_dialogs[i_index];
162 switch( p_dialog->i_status )
164 case ANSWERED_DIALOG:
165 // Ask interface to hide it
166 msg_Dbg( p_interaction, "Hiding dialog %i", p_dialog->i_id );
167 p_dialog->i_action = INTERACT_HIDE;
168 val.p_address = p_dialog;
169 if( p_interaction->p_intf )
170 var_Set( p_interaction->p_intf, "interaction", val );
171 p_dialog->i_status = HIDING_DIALOG;
174 p_dialog->i_action = INTERACT_UPDATE;
175 val.p_address = p_dialog;
176 if( p_interaction->p_intf )
177 var_Set( p_interaction->p_intf, "interaction", val );
178 p_dialog->i_status = SENT_DIALOG;
179 msg_Dbg( p_interaction, "Updating dialog %i, %i widgets",
180 p_dialog->i_id, p_dialog->i_widgets );
183 if( !(p_dialog->i_flags & DIALOG_GOT_ANSWER) ) break;
184 if( !(p_dialog->i_flags & DIALOG_REUSABLE) )
186 msg_Dbg( p_interaction, "Destroying dialog %i",
188 p_dialog->i_action = INTERACT_DESTROY;
189 val.p_address = p_dialog;
190 if( p_interaction->p_intf )
191 var_Set( p_interaction->p_intf, "interaction", val );
194 case DESTROYED_DIALOG:
195 msg_Dbg( p_interaction, "Removing dialog %i",
197 // Interface has now destroyed it, remove it
198 REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs,
201 intf_InteractionDialogDestroy( p_dialog );
204 // This is truly a new dialog, send it.
205 p_dialog->i_action = INTERACT_NEW;
206 val.p_address = p_dialog;
207 if( p_interaction->p_intf )
208 var_Set( p_interaction->p_intf, "interaction", val );
209 p_dialog->i_status = SENT_DIALOG;
214 if( p_interaction->p_intf )
216 vlc_object_release( p_interaction->p_intf );
219 vlc_mutex_unlock( &p_playlist->p_interaction->object_lock );
224 #define INTERACT_INIT( new ) \
225 new = (interaction_dialog_t*)malloc( \
226 sizeof( interaction_dialog_t ) ); \
227 new->i_widgets = 0; \
228 new->pp_widgets = NULL; \
229 new->psz_title = NULL; \
230 new->psz_description = NULL; \
233 new->i_status = NEW_DIALOG;
235 #define INTERACT_FREE( new ) \
236 if( new->psz_title ) free( new->psz_title ); \
237 if( new->psz_description ) free( new->psz_description );
239 /** Helper function to send an error message
240 * \param p_this Parent vlc_object
241 * \param i_id A predefined ID, 0 if not applicable
242 * \param psz_title Title for the dialog
243 * \param psz_format The message to display
245 void __intf_UserFatal( vlc_object_t *p_this,
246 const char *psz_title,
247 const char *psz_format, ... )
250 interaction_dialog_t *p_new = NULL;
251 user_widget_t *p_widget = NULL;
252 int i_id = DIALOG_ERRORS;
256 p_new = intf_InteractionGetById( p_this, i_id );
260 INTERACT_INIT( p_new );
261 if( i_id > 0 ) p_new->i_id = i_id ;
265 p_new->i_status = UPDATED_DIALOG;
268 p_new->i_flags |= DIALOG_REUSABLE;
270 p_new->i_type = INTERACT_DIALOG_ONEWAY;
271 p_new->psz_title = strdup( psz_title );
273 p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
275 p_widget->i_type = WIDGET_TEXT;
276 p_widget->val.psz_string = NULL;
278 va_start( args, psz_format );
279 vasprintf( &p_widget->psz_text, psz_format, args );
282 INSERT_ELEM ( p_new->pp_widgets,
287 p_new->i_flags |= DIALOG_CLEAR_NOSHOW;
289 intf_Interact( p_this, p_new );
292 /** Helper function to ask a yes-no question
293 * \param p_this Parent vlc_object
294 * \param psz_title Title for the dialog
295 * \param psz_description A description
296 * \param ppsz_login Returned login
297 * \param ppsz_password Returned password
298 * \return Clicked button code
300 int __intf_UserYesNo( vlc_object_t *p_this,
301 const char *psz_title,
302 const char *psz_description )
305 interaction_dialog_t *p_new = NULL;
306 user_widget_t *p_widget = NULL;
308 INTERACT_INIT( p_new );
310 p_new->i_type = INTERACT_DIALOG_TWOWAY;
311 p_new->psz_title = strdup( psz_title );
314 p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
315 p_widget->i_type = WIDGET_TEXT;
316 p_widget->psz_text = strdup( psz_description );
317 p_widget->val.psz_string = NULL;
318 INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
319 p_new->i_widgets, p_widget );
321 p_new->i_flags = DIALOG_YES_NO_CANCEL;
323 i_ret = intf_Interact( p_this, p_new );
328 /** Helper function to make a progressbar box
329 * \param p_this Parent vlc_object
330 * \param psz_title Title for the dialog
331 * \param psz_status Current status
332 * \param f_position Current position (0.0->100.0)
333 * \return Dialog id, to give to UserProgressUpdate
335 int __intf_UserProgress( vlc_object_t *p_this,
336 const char *psz_title,
337 const char *psz_status,
341 interaction_dialog_t *p_new = NULL;
342 user_widget_t *p_widget = NULL;
344 INTERACT_INIT( p_new );
346 p_new->i_type = INTERACT_DIALOG_ONEWAY;
347 p_new->psz_title = strdup( psz_title );
350 p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
351 p_widget->i_type = WIDGET_PROGRESS;
352 p_widget->psz_text = strdup( psz_status );
353 p_widget->val.f_float = f_pos;
354 INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
355 p_new->i_widgets, p_widget );
357 i_ret = intf_Interact( p_this, p_new );
362 /** Update a progress bar
363 * \param p_this Parent vlc_object
364 * \param i_id Identifier of the dialog
365 * \param psz_status New status
366 * \param f_position New position (0.0->100.0)
369 void __intf_UserProgressUpdate( vlc_object_t *p_this, int i_id,
370 const char *psz_status, float f_pos )
372 interaction_t *p_interaction = intf_InteractionGet( p_this );
373 interaction_dialog_t *p_dialog;
375 if( !p_interaction ) return;
377 vlc_mutex_lock( &p_interaction->object_lock );
378 p_dialog = intf_InteractionGetById( p_this, i_id );
382 vlc_mutex_unlock( &p_interaction->object_lock ) ;
386 if( p_dialog->pp_widgets[0]->psz_text )
387 free( p_dialog->pp_widgets[0]->psz_text );
388 p_dialog->pp_widgets[0]->psz_text = strdup( psz_status );
390 p_dialog->pp_widgets[0]->val.f_float = f_pos;
392 p_dialog->i_status = UPDATED_DIALOG;
393 vlc_mutex_unlock( &p_interaction->object_lock) ;
396 /** Helper function to make a login/password box
397 * \param p_this Parent vlc_object
398 * \param psz_title Title for the dialog
399 * \param psz_description A description
400 * \return Clicked button code
402 int __intf_UserLoginPassword( vlc_object_t *p_this,
403 const char *psz_title,
404 const char *psz_description,
406 char **ppsz_password )
409 interaction_dialog_t *p_new = NULL;
410 user_widget_t *p_widget = NULL;
412 INTERACT_INIT( p_new );
414 p_new->i_type = INTERACT_DIALOG_TWOWAY;
415 p_new->psz_title = strdup( psz_title );
418 p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
419 p_widget->i_type = WIDGET_TEXT;
420 p_widget->psz_text = strdup( psz_description );
421 p_widget->val.psz_string = NULL;
422 INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
423 p_new->i_widgets, p_widget );
426 p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
427 p_widget->i_type = WIDGET_INPUT_TEXT;
428 p_widget->psz_text = strdup( _("Login") );
429 p_widget->val.psz_string = NULL;
430 INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
431 p_new->i_widgets, p_widget );
434 p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
435 p_widget->i_type = WIDGET_INPUT_TEXT;
436 p_widget->psz_text = strdup( _("Password") );
437 p_widget->val.psz_string = NULL;
438 INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
439 p_new->i_widgets, p_widget );
441 p_new->i_flags = DIALOG_OK_CANCEL;
443 i_ret = intf_Interact( p_this, p_new );
445 if( i_ret != DIALOG_CANCELLED )
447 *ppsz_login = strdup( p_new->pp_widgets[1]->val.psz_string );
448 *ppsz_password = strdup( p_new->pp_widgets[2]->val.psz_string );
453 /** Hide an interaction dialog
454 * \param p_this the parent vlc object
455 * \param i_id the id of the item to hide
458 void __intf_UserHide( vlc_object_t *p_this, int i_id )
460 interaction_t *p_interaction = intf_InteractionGet( p_this );
461 interaction_dialog_t *p_dialog;
463 if( !p_interaction ) return;
465 vlc_mutex_lock( &p_interaction->object_lock );
466 p_dialog = intf_InteractionGetById( p_this, i_id );
470 vlc_mutex_unlock( &p_interaction->object_lock );
474 p_dialog->i_status = ANSWERED_DIALOG;
475 vlc_mutex_unlock( &p_interaction->object_lock );
480 /**********************************************************************
481 * The following functions are local
482 **********************************************************************/
484 /* Get the interaction object. Create it if needed */
485 static interaction_t * intf_InteractionGet( vlc_object_t *p_this )
487 playlist_t *p_playlist;
488 interaction_t *p_interaction;
490 p_playlist = (playlist_t*) vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
498 if( p_playlist->p_interaction == NULL )
500 intf_InteractionInit( p_playlist );
503 p_interaction = p_playlist->p_interaction;
505 vlc_object_release( p_playlist );
507 return p_interaction;
510 /* Create the interaction object in the given playlist object */
511 static void intf_InteractionInit( playlist_t *p_playlist )
513 interaction_t *p_interaction;
515 msg_Dbg( p_playlist, "initializing interaction system" );
517 p_interaction = vlc_object_create( VLC_OBJECT( p_playlist ),
518 sizeof( interaction_t ) );
521 msg_Err( p_playlist,"out of memory" );
525 p_interaction->i_dialogs = 0;
526 p_interaction->pp_dialogs = NULL;
527 p_interaction->p_intf = NULL;
528 p_interaction->i_last_id = DIALOG_LAST_PREDEFINED + 1;
530 vlc_mutex_init( p_interaction , &p_interaction->object_lock );
532 p_playlist->p_interaction = p_interaction;
535 /* Look for an interface suitable for interaction */
536 static void intf_InteractionSearchInterface( interaction_t *p_interaction )
541 p_interaction->p_intf = NULL;
543 p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
546 msg_Err( p_interaction, "Unable to create module list" );
550 for( i_index = 0; i_index < p_list->i_count; i_index ++ )
552 intf_thread_t *p_intf = (intf_thread_t *)
553 p_list->p_values[i_index].p_object;
554 if( p_intf->b_interaction )
556 p_interaction->p_intf = p_intf;
560 vlc_list_release ( p_list );
563 /* Add a dialog to the queue and wait for answer */
564 static int intf_WaitAnswer( interaction_t *p_interact, interaction_dialog_t *p_dialog )
567 vlc_bool_t b_found = VLC_FALSE;
568 vlc_mutex_lock( &p_interact->object_lock );
569 for( i = 0 ; i< p_interact->i_dialogs; i++ )
571 if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id )
578 INSERT_ELEM( p_interact->pp_dialogs,
579 p_interact->i_dialogs,
580 p_interact->i_dialogs,
584 p_dialog->i_status = UPDATED_DIALOG;
585 vlc_mutex_unlock( &p_interact->object_lock );
587 /// \todo Check that the initiating object is not dying
588 while( p_dialog->i_status != ANSWERED_DIALOG &&
589 p_dialog->i_status != HIDING_DIALOG &&
590 p_dialog->i_status != HIDDEN_DIALOG &&
591 !p_dialog->p_parent->b_die )
596 if( p_dialog->p_parent->b_die )
598 p_dialog->i_return = DIALOG_CANCELLED;
599 p_dialog->i_status = ANSWERED_DIALOG;
601 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
602 return p_dialog->i_return;
605 /* Add a dialog to the queue and return */
606 static int intf_Send( interaction_t *p_interact, interaction_dialog_t *p_dialog )
609 vlc_bool_t b_found = VLC_FALSE;
610 vlc_mutex_lock( &p_interact->object_lock );
612 for( i = 0 ; i< p_interact->i_dialogs; i++ )
614 if( p_interact->pp_dialogs[i]->i_id == p_dialog->i_id )
621 INSERT_ELEM( p_interact->pp_dialogs,
622 p_interact->i_dialogs,
623 p_interact->i_dialogs,
627 p_dialog->i_status = UPDATED_DIALOG;
628 // Pretend we already retrieved the "answer"
629 p_dialog->i_flags |= DIALOG_GOT_ANSWER;
630 vlc_mutex_unlock( &p_interact->object_lock );
634 /* Find an interaction dialog by its id */
635 static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* p_this,
638 interaction_t *p_interaction = intf_InteractionGet( p_this );
641 if( !p_interaction ) return NULL;
643 for( i = 0 ; i< p_interaction->i_dialogs; i++ )
645 if( p_interaction->pp_dialogs[i]->i_id == i_id )
647 return p_interaction->pp_dialogs[i];
653 #define FREE( i ) { if( i ) free( i ); i = NULL; }
655 static void intf_InteractionDialogDestroy( interaction_dialog_t *p_dialog )
658 for( i = p_dialog->i_widgets - 1 ; i >= 0 ; i-- )
660 user_widget_t *p_widget = p_dialog->pp_widgets[i];
661 FREE( p_widget->psz_text );
662 if( p_widget->i_type == WIDGET_INPUT_TEXT )
664 FREE( p_widget->val.psz_string );
667 REMOVE_ELEM( p_dialog->pp_widgets, p_dialog->i_widgets, i );
670 FREE( p_dialog->psz_title );
671 FREE( p_dialog->psz_description );