Changeset 0a9dbda92034654d20a12e3d616e93e3ac382849

Timestamp:

31/07/06 00:00:44 (2 years ago)

Author:

Felix Paul Kühne <fkuehne@videolan.org>

git-committer:

Felix Paul Kühne <fkuehne@videolan.org> 1154296844 +0000

git-parent:

[87c7bdf06f337b06cd2c19a45d3abd2115ef646f]

git-author:

Felix Paul Kühne <fkuehne@videolan.org> 1154296844 +0000

Message:

* additional interaction enhancements

• intf_UserFatal takes an addition bool-argument now to set whether the error message will be blocking in the interface or not (so TRUE = blocking)
  
• intf_UserWarn is always non-blocking and is used to check important, localised warnings to the user
  

* wx: a compilation fix, but no update to the current API
* osx: complete implementation of the interaction framework using some Carbon (!) functions, because the needed icons aren't accessible through Cocoa. Regrettably, I had to add yet another nib-file to keep the code clean and readable.

The Error-dialogue is no longer re-usable (so the specific ID was removed). The interface needs to keep track of the reported errors and warnings. Thus, it may discard them as requested by the user and doesn't need to care about the core.

Files:

• Makefile.am (modified) (1 diff)
• extras/MacOSX/Resources/English.lproj/InteractionErrorPanel.nib/classes.nib (added)
• extras/MacOSX/Resources/English.lproj/InteractionErrorPanel.nib/info.nib (added)
• extras/MacOSX/Resources/English.lproj/InteractionErrorPanel.nib/keyedobjects.nib (added)
• extras/MacOSX/vlc.pbproj/project.pbxproj (modified) (8 diffs)
• include/vlc_interaction.h (modified) (5 diffs)
• modules/gui/macosx/interaction.h (modified) (3 diffs)
• modules/gui/macosx/interaction.m (modified) (9 diffs)
• modules/gui/wxwidgets/dialogs/interaction.cpp (modified) (1 diff)
• modules/gui/wxwidgets/interface.cpp (modified) (1 diff)
• src/interface/interaction.c (modified) (3 diffs)

Makefile.am

@@ -83 +83 @@
-    extras/MacOSX/Resources/English.lproj/Interaction.nib/info.nib \
-    extras/MacOSX/Resources/English.lproj/Interaction.nib/keyedobjects.nib \
+    extras/MacOSX/Resources/English.lproj/InteractionErrorPanel.nib/classes.nib \
+    extras/MacOSX/Resources/English.lproj/InteractionErrorPanel.nib/info.nib \
+    extras/MacOSX/Resources/English.lproj/InteractionErrorPanel.nib/keyedobjects.nib \
-    extras/MacOSX/Resources/English.lproj/InfoPlist.strings \
-    extras/MacOSX/Resources/a52.icns \

extras/MacOSX/vlc.pbproj/project.pbxproj

@@ -73 +73 @@
-        C2F2A708095AE51700018C74 /* skip_forward_embedded_blue.png in Resources */ = {isa = PBXBuildFile; fileRef = C2F2A704095AE51600018C74 /* skip_forward_embedded_blue.png */; };
-        C2F2A709095AE51700018C74 /* skip_previous_embedded_blue.png in Resources */ = {isa = PBXBuildFile; fileRef = C2F2A705095AE51600018C74 /* skip_previous_embedded_blue.png */; };
+        CC1AC1BC0A7BDA41002478C3 /* InteractionErrorPanel.nib in Resources */ = {isa = PBXBuildFile; fileRef = CC1AC1BA0A7BDA41002478C3 /* InteractionErrorPanel.nib */; };
-        CC1B4B4D09A8CF9E0078AD2E /* Interaction.nib in Resources */ = {isa = PBXBuildFile; fileRef = CC1B4B4B09A8CF9E0078AD2E /* Interaction.nib */; };
-        CC26BF2C09A7A05000E94D62 /* Update.nib in Resources */ = {isa = PBXBuildFile; fileRef = CC26BF2A09A7A05000E94D62 /* Update.nib */; };
+        CC3DC89C0A7CDB9600B53F32 /* ApplicationServices.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = CC3DC89B0A7CDB9600B53F32 /* ApplicationServices.framework */; };
-        CCF3C64C0923B99D00401862 /* SFilters.nib in Resources */ = {isa = PBXBuildFile; fileRef = CCF3C64A0923B99D00401862 /* SFilters.nib */; };
-        DC7F46ED08A183FC0027DB24 /* Extended.nib in Resources */ = {isa = PBXBuildFile; fileRef = DC7F46EB08A183FC0027DB24 /* Extended.nib */; };
@@ -905 +907 @@
-        C2F2A704095AE51600018C74 /* skip_forward_embedded_blue.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; name = skip_forward_embedded_blue.png; path = Resources/skip_forward_embedded_blue.png; sourceTree = "<group>"; };
-        C2F2A705095AE51600018C74 /* skip_previous_embedded_blue.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; name = skip_previous_embedded_blue.png; path = Resources/skip_previous_embedded_blue.png; sourceTree = "<group>"; };
+        CC1AC1BB0A7BDA41002478C3 /* English */ = {isa = PBXFileReference; lastKnownFileType = wrapper.nib; name = English; path = Resources/English.lproj/InteractionErrorPanel.nib; sourceTree = "<group>"; };
-        CC1B4B4C09A8CF9E0078AD2E /* English */ = {isa = PBXFileReference; lastKnownFileType = wrapper.nib; name = English; path = Resources/English.lproj/Interaction.nib; sourceTree = "<group>"; };
-        CC1B4C1409A8EC690078AD2E /* interaction.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = interaction.h; path = ../../modules/gui/macosx/interaction.h; sourceTree = "<group>"; };
@@ -911 +914 @@
-        CC26BF3109A7A08C00E94D62 /* update.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; name = update.h; path = ../../modules/gui/macosx/update.h; sourceTree = SOURCE_ROOT; };
-        CC26BF3209A7A08C00E94D62 /* update.m */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.objc; name = update.m; path = ../../modules/gui/macosx/update.m; sourceTree = SOURCE_ROOT; };
+        CC3DC89B0A7CDB9600B53F32 /* ApplicationServices.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = ApplicationServices.framework; path = /System/Library/Frameworks/ApplicationServices.framework; sourceTree = "<absolute>"; };
-        CCF3C64B0923B99D00401862 /* English */ = {isa = PBXFileReference; lastKnownFileType = wrapper.nib; name = English; path = Resources/English.lproj/SFilters.nib; sourceTree = "<group>"; };
-        CCF3C6500923B9D100401862 /* sfilters.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; name = sfilters.h; path = ../../modules/gui/macosx/sfilters.h; sourceTree = SOURCE_ROOT; };
@@ -944 +948 @@
-            files = (
-                1058C7AFFEA557BF11CA2CBB /* Cocoa.framework in Frameworks */,
+                CC3DC89C0A7CDB9600B53F32 /* ApplicationServices.framework in Frameworks */,
-            );
-            runOnlyForDeploymentPostprocessing = 0;
@@ -1040 +1045 @@
-            isa = PBXGroup;
-            children = (
+                CC3DC89B0A7CDB9600B53F32 /* ApplicationServices.framework */,
-                1058C7ADFEA557BF11CA2CBB /* Cocoa.framework */,
-            );
@@ -1154 +1160 @@
-                CC26BF2A09A7A05000E94D62 /* Update.nib */,
-                CC1B4B4B09A8CF9E0078AD2E /* Interaction.nib */,
+                CC1AC1BA0A7BDA41002478C3 /* InteractionErrorPanel.nib */,
-            );
-            name = nibs;
@@ -1262 +1269 @@
-                CC26BF2C09A7A05000E94D62 /* Update.nib in Resources */,
-                CC1B4B4D09A8CF9E0078AD2E /* Interaction.nib in Resources */,
+                CC1AC1BC0A7BDA41002478C3 /* InteractionErrorPanel.nib in Resources */,
-            );
-            runOnlyForDeploymentPostprocessing = 0;
@@ -1278 +1286 @@
-
-/* Begin PBXVariantGroup section */
+        CC1AC1BA0A7BDA41002478C3 /* InteractionErrorPanel.nib */ = {
+            isa = PBXVariantGroup;
+            children = (
+                CC1AC1BB0A7BDA41002478C3 /* English */,
+            );
+            name = InteractionErrorPanel.nib;
+            sourceTree = "<group>";
+        };
-        CC1B4B4B09A8CF9E0078AD2E /* Interaction.nib */ = {
-            isa = PBXVariantGroup;

include/vlc_interaction.h

@@ -88 +88 @@
-#define DIALOG_GOT_ANSWER           0x10
-#define DIALOG_LOGIN_PW_OK_CANCEL   0x20
+#define DIALOG_BLOCKING_ERROR       0x24
+#define DIALOG_NONBLOCKING_ERROR    0x200
-#define DIALOG_USER_PROGRESS        0x40
-#define DIALOG_PSZ_INPUT_OK_CANCEL      0x80
-#define DIALOG_INTF_PROGRESS        0x100
+#define DIALOG_WARNING              0x400
-
-/**
@@ -122 +125 @@
-enum
-{
-    INTERACT_PROGRESS,          ///< Progress bar (in the main interface ?)
-    INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
-    INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
@@ -133 +135 @@
-{
-    DIALOG_FIRST,
-    DIALOG_ERRORS,
-
-    DIALOG_LAST_PREDEFINED,
@@ -140 +141 @@
-/**
- * This structure contains the active interaction dialogs, and is
-eh
+he
- */
-struct interaction_t
@@ -171 +172 @@
-VLC_EXPORT( int,__intf_Interact,( vlc_object_t *,interaction_dialog_t * ) );
-
-
-
+
+
+
+
-#define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );

modules/gui/macosx/interaction.h

@@ -77 +77 @@
-@end
-
+@interface VLCErrorInteractionPanel : NSObject
+{
+    IBOutlet id o_window;
+    IBOutlet id o_cleanup_button;
+    IBOutlet id o_error_table;
+
+    NSMutableArray * o_errors;
+    NSMutableArray * o_icons;
+
+    NSImage * warnIcon;
+    NSImage * errorIcon;
+
+    BOOL nib_interact_errpanel_loaded;
+}
+- (IBAction)cleanupTable:(id)sender;
+
+-(void)showPanel;
+-(void)addError: (NSString *)o_error withMsg:(NSString *)o_msg;
+-(void)addWarning: (NSString *)o_warning withMsg:(NSString *)o_msg;
+
+@end
+
-/*****************************************************************************
- * VLCInteractionList interface
@@ -83 +105 @@
-{
-    NSMutableArray *o_interaction_list;
+    VLCErrorInteractionPanel *o_error_panel;
-}
-
@@ -89 +112 @@
--(void)removeInteraction: (VLCInteraction *)p_interaction;
-
+-(id)getErrorPanel;
+
-@end

modules/gui/macosx/interaction.m

@@ -26 +26 @@
-#import "interaction.h"
-
+/* for the icons in our custom error panel */
+#import <ApplicationServices/ApplicationServices.h> 
+
-/*****************************************************************************
- * VLCInteractionList implementation
@@ -39 +42 @@
-        name: @"VLCNewInteractionEventNotification"
-        object:self];
+
+    o_error_panel = [[VLCErrorInteractionPanel alloc] init];
-
-    return self;
@@ -73 +78 @@
--(void)addInteraction: (interaction_dialog_t *)p_dialog
-{
-
-    VLCInteraction *o_interaction = [[VLCInteraction alloc] initDialog: p_dialog];
-    
@@ -86 +90 @@
-}
-
+-(id)getErrorPanel
+{
+    return o_error_panel;
+}
+
--(void)dealloc
-{
@@ -93 +102 @@
-    [super dealloc];
-}
-
-@end
-
@@ -129 +137 @@
-    }
-
-"title"
+_("Error")
-    NSString *o_description = [NSString stringWithUTF8String:p_dialog->psz_description ? p_dialog->psz_description : ""];
-[NSString stringWithUTF8String:p_dialog->psz_defaultButton]
-[NSString stringWithUTF8String:p_dialog->psz_alternateButton]
+p_dialog->psz_defaultButton ? [NSString stringWithUTF8String:p_dialog->psz_defaultButton] : nil
+p_dialog->psz_alternateButton ? [NSString stringWithUTF8String:p_dialog->psz_alternateButton] : nil
-    NSString *o_otherButton = p_dialog->psz_otherButton ? [NSString stringWithUTF8String:p_dialog->psz_otherButton] : nil;
-
@@ -155 +163 @@
-    }
-
-    
+
-    msg_Dbg( p_intf, "Title: %s", [o_title UTF8String] );
-    msg_Dbg( p_intf, "Description: %s", [o_description UTF8String] );
-
-
-
+
+
+
+
-    {
-        msg_Dbg( p_intf, "error panel requested" );
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-    else
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-}
-
@@ -345 +358 @@
-- (IBAction)okayAndClose:(id)sender
-{
+    msg_Dbg( p_intf, "running okayAndClose" );
-    vlc_mutex_lock( &p_dialog->p_interaction->object_lock );
-    if( p_dialog->i_flags == DIALOG_LOGIN_PW_OK_CANCEL )
@@ -360 +374 @@
-
-@end
+
+/*****************************************************************************
+ * VLCErrorInteractionPanel implementation
+ *****************************************************************************/
+@implementation VLCErrorInteractionPanel
+-(id)init
+{
+    [super init];
+    nib_interact_errpanel_loaded = [NSBundle loadNibNamed:@"InteractionErrorPanel" owner:self];
+    [o_window setTitle: _NS("Errors and Warnings")];
+    [o_cleanup_button setTitle: _NS("Clean up")];
+    o_errors = [[NSMutableArray alloc] init];
+    o_icons = [[NSMutableArray alloc] init];
+
+    /* ugly Carbon stuff following...
+     * regrettably, you can't get the icons through clean Cocoa */
+
+    /* retrieve our error icon */
+    IconRef ourIconRef;
+    int returnValue;
+    returnValue = GetIconRef(kOnSystemDisk, 'macs', 'stop', &ourIconRef);
+    errorIcon = [[NSImage alloc] initWithSize:NSMakeSize(32,32)];
+    [errorIcon lockFocus];
+    CGRect rect = CGRectMake(0,0,32,32);
+    PlotIconRefInContext((CGContextRef)[[NSGraphicsContext currentContext] 
+        graphicsPort],
+        &rect,
+        kAlignNone,
+        kTransformNone,
+        NULL /*inLabelColor*/,
+        kPlotIconRefNormalFlags,
+        (IconRef)ourIconRef);
+    [errorIcon unlockFocus];
+    returnValue = ReleaseIconRef(ourIconRef);
+
+    /* retrieve our caution icon */
+    returnValue = GetIconRef(kOnSystemDisk, 'macs', 'caut', &ourIconRef);
+    warnIcon = [[NSImage alloc] initWithSize:NSMakeSize(32,32)];
+    [warnIcon lockFocus];
+    PlotIconRefInContext((CGContextRef)[[NSGraphicsContext currentContext] 
+        graphicsPort],
+        &rect,
+        kAlignNone,
+        kTransformNone,
+        NULL /*inLabelColor*/,
+        kPlotIconRefNormalFlags,
+        (IconRef)ourIconRef);
+    [warnIcon unlockFocus];
+    returnValue = ReleaseIconRef(ourIconRef);    
+
+    return self;
+}
+
+-(void)dealloc
+{
+    [errorIcon release];
+    [warnIcon release];
+    [o_errors release];
+    [o_icons release];
+    [super dealloc];
+}
+
+-(void)showPanel
+{
+    [o_window makeKeyAndOrderFront: self];
+}
+
+-(void)addError: (NSString *)o_error withMsg:(NSString *)o_msg
+{
+    /* format our string as desired */
+    NSMutableAttributedString * ourError;
+    ourError = [[NSMutableAttributedString alloc] initWithString:
+        [NSString stringWithFormat:@"%@\n%@", o_error, o_msg]
+        attributes: 
+        [NSDictionary dictionaryWithObject: [NSFont systemFontOfSize:11] forKey: NSFontAttributeName]];
+    [ourError 
+        addAttribute: NSFontAttributeName
+        value: [NSFont boldSystemFontOfSize:11] 
+        range: NSMakeRange( 0, [o_error length])];
+    [o_errors addObject: ourError];
+    [ourError release];
+
+    [o_icons addObject: errorIcon];
+
+    [o_error_table reloadData];
+    [self showPanel];
+}
+
+-(void)addWarning: (NSString *)o_warning withMsg:(NSString *)o_msg
+{
+    /* format our string as desired */
+    NSMutableAttributedString * ourWarning;
+    ourWarning = [[NSMutableAttributedString alloc] initWithString:
+        [NSString stringWithFormat:@"%@\n%@", o_warning, o_msg]
+        attributes: 
+        [NSDictionary dictionaryWithObject: [NSFont systemFontOfSize:11] forKey: NSFontAttributeName]];
+    [ourWarning 
+        addAttribute: NSFontAttributeName
+        value: [NSFont boldSystemFontOfSize:11] 
+        range: NSMakeRange( 0, [o_warning length])];
+    [o_errors addObject: ourWarning];
+    [ourWarning release];
+
+    [o_icons addObject: warnIcon];
+    
+    [o_error_table reloadData];
+
+    [self showPanel];
+}
+
+-(IBAction)cleanupTable:(id)sender
+{
+    [o_errors removeAllObjects];
+    [o_icons removeAllObjects];
+    [o_error_table reloadData];
+}
+
+/*----------------------------------------------------------------------------
+ * data source methods
+ *---------------------------------------------------------------------------*/
+- (int)numberOfRowsInTableView:(NSTableView *)theDataTable
+{
+    return [o_errors count];
+}
+
+- (id)tableView:(NSTableView *)theDataTable objectValueForTableColumn:
+    (NSTableColumn *)theTableColumn row: (int)row
+{
+    if( [[theTableColumn identifier] isEqualToString: @"error_msg"] )
+        return [o_errors objectAtIndex: row];
+
+    if( [[theTableColumn identifier] isEqualToString: @"icon"] )
+        return [o_icons objectAtIndex: row];
+
+    return @"unknown identifier";
+}
+
+@end

modules/gui/wxwidgets/dialogs/interaction.cpp

@@ -110 +110 @@
-
-
-
+NONBLOCKING_
-    {
-        wxTextCtrl *errors ; // Special case

modules/gui/wxwidgets/interface.cpp

@@ -1240 +1240 @@
-    p_arg->p_intf = p_intf;
-
-
-
-
-
-
-
-
+
-                                       0, p_arg );
-
+
-}
-

src/interface/interaction.c

@@ -237 +237 @@
-        if( new->psz_description ) free( new->psz_description );
-
-
+, both in a blocking and non-blocking way
- *  \param p_this     Parent vlc_object
-i_id       A predefined ID, 0 if not applicable
+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, ... )
@@ -249 +250 @@
-    va_list args;
-    interaction_dialog_t *p_new = NULL;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-    p_new->psz_title = strdup( psz_title );
-
@@ -274 +259 @@
-    va_end( args );
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    intf_Interact( p_this, p_new );