]> git.sesse.net Git - vlc/blobdiff - src/interface/interaction.c
* additional interaction enhancements
[vlc] / src / interface / interaction.c
index 111360a876042c602b376ae989117d4fd90e1bfe..e0bf1b8adcdd7669cea45c74a3fa6d67a0607de6 100644 (file)
@@ -143,8 +143,6 @@ void intf_InteractionManage( playlist_t *p_playlist )
 
             // Give default answer
             p_dialog->i_return = DIALOG_DEFAULT;
-            if( p_dialog->i_flags & DIALOG_OK_CANCEL )
-                p_dialog->i_return = DIALOG_CANCELLED;
 
             // Pretend we have hidden and destroyed it
             if( p_dialog->i_status == HIDDEN_DIALOG )
@@ -224,6 +222,11 @@ void intf_InteractionManage( playlist_t *p_playlist )
                         sizeof( interaction_dialog_t ) );               \
         new->psz_title = NULL;                                          \
         new->psz_description = NULL;                                    \
+        new->psz_defaultButton = NULL;                                  \
+        new->psz_alternateButton = NULL;                                \
+        new->psz_otherButton = NULL;                                    \
+        new->i_timeToGo = 0;                                            \
+        new->b_cancelled = VLC_FALSE;                                   \
         new->p_private = NULL;                                          \
         new->i_id = 0;                                                  \
         new->i_flags = 0;                                               \
@@ -233,82 +236,76 @@ void intf_InteractionManage( playlist_t *p_playlist )
         if( new->psz_title ) free( new->psz_title );                    \
         if( new->psz_description ) free( new->psz_description );
 
-/** Helper function to send an error message
+/** Helper function to send an error message, both in a blocking and non-blocking way
  *  \param p_this     Parent vlc_object
- *  \param i_id       A predefined ID, 0 if not applicable
+ *  \param b_blocking Is this dialog blocking or not?
  *  \param psz_title  Title for the dialog
  *  \param psz_format The message to display
  *  */
 void __intf_UserFatal( vlc_object_t *p_this,
+                       vlc_bool_t b_blocking,
                        const char *psz_title,
                        const char *psz_format, ... )
 {
     va_list args;
     interaction_dialog_t *p_new = NULL;
-    int i_id = DIALOG_ERRORS;
-
-    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
-    {
-        p_new->i_status = UPDATED_DIALOG;
-    }
-
-    p_new->i_flags |= DIALOG_REUSABLE;
-
-    p_new->i_type = INTERACT_DIALOG_ONEWAY;
+    
+    INTERACT_INIT( p_new );
+    
     p_new->psz_title = strdup( psz_title );
 
     va_start( args, psz_format );
     vasprintf( &p_new->psz_description, psz_format, args );
     va_end( args );
 
-    p_new->i_flags |= DIALOG_CLEAR_NOSHOW;
+    if( b_blocking )
+        p_new->i_flags = DIALOG_BLOCKING_ERROR;
+    else
+        p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
 
     intf_Interact( p_this, p_new );
 }
 
-/** Helper function to ask a yes-no question
- *  \param p_this           Parent vlc_object
- *  \param psz_title        Title for the dialog
- *  \param psz_description  A description
- *  \return                 Clicked button code
- */
-int __intf_UserYesNo( vlc_object_t *p_this,
-                      const char *psz_title,
-                      const char *psz_description )
+/** Helper function to send an 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
+ *  */
+void __intf_UserWarn( vlc_object_t *p_this,
+                       const char *psz_title,
+                       const char *psz_format, ... )
 {
-    int i_ret;
+    va_list args;
     interaction_dialog_t *p_new = NULL;
-
+    
     INTERACT_INIT( p_new );
-
-    p_new->i_type = INTERACT_DIALOG_TWOWAY;
+    
     p_new->psz_title = strdup( psz_title );
-    p_new->psz_description = strdup( psz_description );
-    p_new->i_flags = DIALOG_YES_NO_CANCEL;
 
-    i_ret = intf_Interact( p_this, p_new );
+    va_start( args, psz_format );
+    vasprintf( &p_new->psz_description, psz_format, args );
+    va_end( args );
 
-    return i_ret;
+    p_new->i_flags = DIALOG_WARNING;
+
+    intf_Interact( p_this, p_new );
 }
 
-/** Helper function to trigger a okay-cancel dialogue
+/** Helper function to ask a yes-no-cancel question
  *  \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
  */
-int __intf_UserOkayCancel( vlc_object_t *p_this,
+int __intf_UserYesNo( vlc_object_t *p_this,
                       const char *psz_title,
-                      const char *psz_description )
+                      const char *psz_description,
+                      const char *psz_default,
+                      const char *psz_alternate,
+                      const char *psz_other )
 {
     int i_ret;
     interaction_dialog_t *p_new = NULL;
@@ -318,7 +315,13 @@ int __intf_UserOkayCancel( vlc_object_t *p_this,
     p_new->i_type = INTERACT_DIALOG_TWOWAY;
     p_new->psz_title = strdup( psz_title );
     p_new->psz_description = strdup( psz_description );
-    p_new->i_flags = DIALOG_OK_CANCEL;
+    p_new->i_flags = DIALOG_YES_NO_CANCEL;
+    p_new->psz_defaultButton = strdup( psz_default );
+    p_new->psz_alternateButton = strdup( psz_alternate );
+    if( psz_other )
+        p_new->psz_otherButton = strdup( psz_other );
+    else
+        p_new->psz_otherButton = NULL;
 
     i_ret = intf_Interact( p_this, p_new );
 
@@ -330,12 +333,14 @@ int __intf_UserOkayCancel( vlc_object_t *p_this,
  *  \param psz_title        Title for the dialog
  *  \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_UserProgress( vlc_object_t *p_this,
                          const char *psz_title,
                          const char *psz_status,
-                         float f_pos )
+                         float f_pos,
+                         int i_time )
 {
     int i_ret;
     interaction_dialog_t *p_new = NULL;
@@ -346,6 +351,7 @@ int __intf_UserProgress( vlc_object_t *p_this,
     p_new->psz_title = strdup( psz_title );
     p_new->psz_description = strdup( psz_status );
     p_new->val.f_float = f_pos;
+    p_new->i_timeToGo = i_time;
 
     p_new->i_flags = DIALOG_USER_PROGRESS;
 
@@ -359,10 +365,12 @@ int __intf_UserProgress( vlc_object_t *p_this,
  *  \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_UserProgressUpdate( vlc_object_t *p_this, int i_id,
-                                const char *psz_status, float f_pos )
+                                const char *psz_status, float f_pos, 
+                                int i_time )
 {
     interaction_t *p_interaction = intf_InteractionGet( p_this );
     interaction_dialog_t *p_dialog;
@@ -383,11 +391,37 @@ void __intf_UserProgressUpdate( vlc_object_t *p_this, int i_id,
     p_dialog->psz_description = strdup( psz_status );
 
     p_dialog->val.f_float = f_pos;
+    p_dialog->i_timeToGo = i_time;
 
     p_dialog->i_status = UPDATED_DIALOG;
     vlc_mutex_unlock( &p_interaction->object_lock) ;
 }
 
+/** Helper function to communicate dialogue cancellations between the intf-module and caller
+ *  \param p_this           Parent vlc_object
+ *  \param i_id             Identifier of the dialogue
+ *  \return                 Either true or false
+ */
+vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
+{
+    interaction_t *p_interaction = intf_InteractionGet( p_this );
+    interaction_dialog_t *p_dialog;
+
+    if( !p_interaction ) return VLC_TRUE;
+
+    vlc_mutex_lock( &p_interaction->object_lock );
+    p_dialog  =  intf_InteractionGetById( p_this, i_id );
+
+    if( !p_dialog )
+    {
+        vlc_mutex_unlock( &p_interaction->object_lock ) ;
+        return VLC_TRUE;
+    }
+
+    vlc_mutex_unlock( &p_interaction->object_lock) ;
+    return p_dialog->b_cancelled;
+}
+
 /** Helper function to make a login/password dialogue
  *  \param p_this           Parent vlc_object
  *  \param psz_title        Title for the dialog
@@ -457,6 +491,67 @@ int __intf_UserStringInput( vlc_object_t *p_this,
     return i_ret;
 }
 
+/** Helper function to create a progress-bar in the main interface with a
+ *  single-line description
+ *  \param p_this           Parent vlc_object
+ *  \param psz_status       Current status
+ *  \param f_position       Current position (0.0->100.0)
+ *  \return                 Dialog id, to give to IntfProgressUpdate
+ */
+int __intf_IntfProgress( vlc_object_t *p_this,
+                         const char *psz_status,
+                         float f_pos )
+{
+    int i_ret;
+    interaction_dialog_t *p_new = NULL;
+
+    INTERACT_INIT( p_new );
+
+    p_new->i_type = INTERACT_DIALOG_ONEWAY;
+    p_new->psz_description = strdup( psz_status );
+    p_new->val.f_float = f_pos;
+
+    p_new->i_flags = DIALOG_INTF_PROGRESS;
+
+    i_ret = intf_Interact( p_this, p_new );
+
+    return p_new->i_id;
+}
+
+/** Update the progress bar in the main interface
+ *  \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)
+ *  \return                 nothing
+ */
+void __intf_IntfProgressUpdate( vlc_object_t *p_this, int i_id,
+                                const char *psz_status, float f_pos )
+{
+    interaction_t *p_interaction = intf_InteractionGet( p_this );
+    interaction_dialog_t *p_dialog;
+
+    if( !p_interaction ) return;
+
+    vlc_mutex_lock( &p_interaction->object_lock );
+    p_dialog  =  intf_InteractionGetById( p_this, i_id );
+
+    if( !p_dialog )
+    {
+        vlc_mutex_unlock( &p_interaction->object_lock ) ;
+        return;
+    }
+
+    if( p_dialog->psz_description )
+        free( p_dialog->psz_description );
+    p_dialog->psz_description = strdup( psz_status );
+
+    p_dialog->val.f_float = f_pos;
+
+    p_dialog->i_status = UPDATED_DIALOG;
+    vlc_mutex_unlock( &p_interaction->object_lock) ;
+}
+
 /** Hide an interaction dialog
  * \param p_this the parent vlc object
  * \param i_id the id of the item to hide
@@ -662,13 +757,11 @@ static interaction_dialog_t *intf_InteractionGetById( vlc_object_t* p_this,
 
 static void intf_InteractionDialogDestroy( interaction_dialog_t *p_dialog )
 {
- /*   FREE( p_dialog->val.psz_string );
-
     FREE( p_dialog->psz_title );
     FREE( p_dialog->psz_description );
-    
-    FREE( p_dialog->psz_returned[0] );
-    FREE( p_dialog->psz_returned[1] ); */
+    FREE( p_dialog->psz_defaultButton );
+    FREE( p_dialog->psz_alternateButton );
+    FREE( p_dialog->psz_otherButton );
 
     free( p_dialog );
 }