]> git.sesse.net Git - vlc/blob - modules/gui/macosx/prefs.m
* backport of [11419]
[vlc] / modules / gui / macosx / prefs.m
1 /*****************************************************************************
2  * prefs.m: MacOS X module for vlc
3  *****************************************************************************
4  * Copyright (C) 2002-2005 VideoLAN
5  * $Id$
6  *
7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8  *          Derk-Jan Hartman <hartman at videolan dot org>
9  *
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.
14  *
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.
19  *
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /* VLCPrefs manages the main preferences dialog 
26    the class is related to wxwindows intf, PrefsPanel */
27 /* VLCTreeItem should contain:
28    - the children of the treeitem
29    - the associated prefs widgets
30    - the documentview with all the prefs widgets in it
31    - a saveChanges action
32    - a revertChanges action
33    - an advanced action (to hide/show advanced options)
34    - a redraw view action
35    - the children action should generate a list of the treeitems children (to be used by VLCPrefs datasource)
36
37    The class is sort of a mix of wxwindows intfs, PrefsTreeCtrl and ConfigTreeData
38 */
39 /* VLCConfigControl are subclassed NSView's containing and managing individual config items
40    the classes are VERY closely related to wxwindows ConfigControls */
41
42 /*****************************************************************************
43  * Preamble
44  *****************************************************************************/
45 #include <stdlib.h>                                      /* malloc(), free() */
46 #include <sys/param.h>                                    /* for MAXPATHLEN */
47 #include <string.h>
48
49 #include <vlc/vlc.h>
50 #include <vlc_config_cat.h>
51
52 #include "intf.h"
53 #include "prefs.h"
54 #include "prefs_widgets.h"
55 #include "vlc_keys.h"
56
57 /*****************************************************************************
58  * VLCPrefs implementation
59  *****************************************************************************/
60 @implementation VLCPrefs
61
62 static VLCPrefs *_o_sharedMainInstance = nil;
63
64 + (VLCPrefs *)sharedInstance
65 {
66     return _o_sharedMainInstance ? _o_sharedMainInstance : [[self alloc] init];
67 }
68
69 - (id)init
70 {
71     if( _o_sharedMainInstance ) {
72         [self dealloc];
73     }
74     else
75     {
76         _o_sharedMainInstance = [super init];
77         p_intf = VLCIntf;
78         o_empty_view = [[NSView alloc] init];
79     }
80
81     return _o_sharedMainInstance;
82 }
83
84 - (void)dealloc
85 {
86     [o_empty_view release];
87     [super dealloc];
88 }
89
90 - (void)awakeFromNib
91 {
92     p_intf = VLCIntf;
93     b_advanced = config_GetInt( p_intf, "advanced" );
94
95     [self initStrings];
96     [o_advanced_ckb setState: b_advanced];
97     [o_prefs_view setBorderType: NSGrooveBorder];
98     [o_prefs_view setHasVerticalScroller: YES];
99     [o_prefs_view setDrawsBackground: NO];
100     [o_prefs_view setDocumentView: o_empty_view];
101     [o_tree selectRow:0 byExtendingSelection:NO];
102 }
103
104 - (void)showPrefs
105 {
106     /* load our nib (if not already loaded) */
107     [NSBundle loadNibNamed:@"Preferences" owner:self];
108
109     [o_prefs_window center];
110     [o_prefs_window makeKeyAndOrderFront:self];
111 }
112
113 - (void)initStrings
114 {
115     [o_prefs_window setTitle: _NS("Preferences")];
116     [o_save_btn setTitle: _NS("Save")];
117     [o_cancel_btn setTitle: _NS("Cancel")];
118     [o_reset_btn setTitle: _NS("Reset All")];
119     [o_advanced_ckb setTitle: _NS("Advanced")];
120 }
121
122 - (IBAction)savePrefs: (id)sender
123 {
124     /* TODO: call savePrefs on Root item */
125     [[VLCTreeItem rootItem] applyChanges];
126     config_SaveConfigFile( p_intf, NULL );
127     [o_prefs_window orderOut:self];
128 }
129
130 - (IBAction)closePrefs: (id)sender
131 {
132     [o_prefs_window orderOut:self];
133 }
134
135 - (IBAction)resetAll: (id)sender
136 {
137     NSBeginInformationalAlertSheet(_NS("Reset Preferences"), _NS("Cancel"),
138         _NS("Continue"), nil, o_prefs_window, self,
139         @selector(sheetDidEnd: returnCode: contextInfo:), NULL, nil,
140         _NS("Beware this will reset your VLC media player preferences.\n"
141             "Are you sure you want to continue?") );
142 }
143
144 - (void)sheetDidEnd:(NSWindow *)o_sheet returnCode:(int)i_return
145     contextInfo:(void *)o_context
146 {
147     if( i_return == NSAlertAlternateReturn )
148     {
149         [o_prefs_view setDocumentView: o_empty_view];
150         config_ResetAll( p_intf );
151         [[VLCTreeItem rootItem] resetView];
152         [[o_tree itemAtRow:[o_tree selectedRow]]
153             showView:o_prefs_view advancedView:
154             ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
155     }
156 }
157
158 - (IBAction)advancedToggle: (id)sender
159 {
160     b_advanced = !b_advanced;
161     [o_advanced_ckb setState: b_advanced];
162     /* refresh the view of the current treeitem */
163     [[o_tree itemAtRow:[o_tree selectedRow]] showView:o_prefs_view advancedView:
164         ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
165 }
166
167 - (void)loadConfigTree
168 {
169 }
170
171 - (void)outlineViewSelectionIsChanging:(NSNotification *)o_notification
172 {
173 }
174
175 /* update the document view to the view of the selected tree item */
176 - (void)outlineViewSelectionDidChange:(NSNotification *)o_notification
177 {
178     [[o_tree itemAtRow:[o_tree selectedRow]] showView: o_prefs_view
179         advancedView:( [o_advanced_ckb state] == NSOnState ) ?
180         VLC_TRUE : VLC_FALSE];
181 }
182
183 @end
184
185 @implementation VLCPrefs (NSTableDataSource)
186
187 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item {
188     return (item == nil) ? [[VLCTreeItem rootItem] numberOfChildren] :
189                             [item numberOfChildren];
190 }
191
192 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
193 {
194     return (item == nil) ? YES : ( ([item numberOfChildren] != -1) && 
195                                    ([item numberOfChildren] != 0));
196 }
197
198 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item {
199     return (item == nil) ? [[VLCTreeItem rootItem] childAtIndex:index] :
200                             [item childAtIndex:index];
201 }
202
203 - (id)outlineView:(NSOutlineView *)outlineView
204     objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
205 {
206     return (item == nil) ? @"" : (id)[item getName];
207 }
208
209 @end
210
211 @implementation VLCTreeItem
212
213 static VLCTreeItem *o_root_item = nil;
214
215 #define IsALeafNode ((id)-1)
216
217 - (id)initWithName: (NSString *)o_item_name ID: (int)i_id
218     parent:(VLCTreeItem *)o_parent_item
219     children:(NSMutableArray *)o_children_array
220     whithCategory: (int) i_category
221 {
222     self = [super init];
223
224     if( self != nil )
225     {
226         o_name = [o_item_name copy];
227         i_object_id = i_id;
228         o_parent = o_parent_item;
229         o_children = o_children_array;
230         i_object_category = i_category;
231         o_subviews = nil;
232     }
233     return( self );
234 }
235
236 + (VLCTreeItem *)rootItem
237 {
238    if (o_root_item == nil)
239         o_root_item = [[VLCTreeItem alloc] initWithName:@"main" ID:0
240             parent:nil children:[[NSMutableArray alloc] initWithCapacity:10]
241             whithCategory: -1];
242    return o_root_item;
243 }
244
245 - (void)dealloc
246 {
247     if (o_children != IsALeafNode) [o_children release];
248     [o_name release];
249     [super dealloc];
250 }
251
252 /* Creates and returns the array of children
253  * Loads children incrementally */
254 - (NSArray *)children
255 {
256     if( o_children == IsALeafNode )
257         return o_children;
258     if( [ o_children count] == 0 )
259     {
260         intf_thread_t   *p_intf = VLCIntf;
261         vlc_list_t      *p_list;
262         module_t        *p_module = NULL;
263         module_config_t *p_item;
264         int             i_index;
265
266         /* List the modules */
267         p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
268         if( !p_list ) return nil;
269
270         if( [[self getName] isEqualToString: @"main"] )
271         {
272             /*
273             * Find the main module
274             */
275             for( i_index = 0; i_index < p_list->i_count; i_index++ )
276             {
277                 p_module = (module_t *)p_list->p_values[i_index].p_object;
278                 if( !strcmp( p_module->psz_object_name, "main" ) )
279                     break;
280             }
281             if( p_module == NULL )
282             {
283                 msg_Err( p_intf,
284                     "could not find the main module in our preferences" );
285                 return nil;
286             }
287             if( i_index < p_list->i_count )
288             {
289                 /* We found the main module */
290                 /* Enumerate config categories and store a reference so we can
291                  * generate their config panel them when it is asked by the user. */
292                 VLCTreeItem *p_last_category = NULL;
293                 p_item = p_module->p_config;
294                 o_children = [[NSMutableArray alloc] initWithCapacity:10];
295                 if( p_item ) do
296                 {
297                     NSString *o_child_name;
298                     switch( p_item->i_type )
299                     {
300                     case CONFIG_CATEGORY:
301                         o_child_name = [[VLCMain sharedInstance]
302     localizedString: config_CategoryNameGet(p_item->i_value ) ];
303                         p_last_category = [VLCTreeItem alloc];
304                         [o_children addObject:[p_last_category
305                             initWithName: o_child_name
306                             ID: p_item->i_value
307                             parent:self
308                             children:[[NSMutableArray alloc]
309                                 initWithCapacity:10]
310                             whithCategory: p_item - p_module->p_config]];
311                         break;
312                     case CONFIG_SUBCATEGORY:
313                         o_child_name = [[VLCMain sharedInstance]
314     localizedString: config_CategoryNameGet(p_item->i_value ) ];
315                         if( p_item->i_value != SUBCAT_PLAYLIST_GENERAL &&
316                             p_item->i_value != SUBCAT_VIDEO_GENERAL &&
317                             p_item->i_value != SUBCAT_AUDIO_GENERAL )
318                             [p_last_category->o_children
319                                 addObject:[[VLCTreeItem alloc]
320                                 initWithName: o_child_name
321                                 ID: p_item->i_value
322                                 parent:p_last_category
323                                 children:[[NSMutableArray alloc]
324                                     initWithCapacity:10]
325                                 whithCategory: p_item - p_module->p_config]];
326                         break;
327                     default:
328                         break;
329                     }
330                 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
331             }
332
333             /* Build a tree of the plugins */
334             /* Add the capabilities */
335             for( i_index = 0; i_index < p_list->i_count; i_index++ )
336             {
337                 p_module = (module_t *)p_list->p_values[i_index].p_object;
338
339                 /* Exclude the main module */
340                 if( !strcmp( p_module->psz_object_name, "main" ) )
341                     continue;
342
343                 /* Exclude empty plugins (submodules don't have config */
344                 /* options, they are stored in the parent module) */
345                 if( p_module->b_submodule )
346                     continue;
347                 else
348                     p_item = p_module->p_config;
349
350                 if( !p_item ) continue;
351                 int i_category = -1;
352                 int i_subcategory = -1;
353                 int i_options = 0;
354                 do
355                 {
356                     if( p_item->i_type == CONFIG_CATEGORY )
357                         i_category = p_item->i_value;
358                     else if( p_item->i_type == CONFIG_SUBCATEGORY )
359                         i_subcategory = p_item->i_value;
360
361                     if( p_item->i_type & CONFIG_ITEM )
362                         i_options ++;
363                     if( i_options > 0 && i_category >= 0 && i_subcategory >= 0 )
364                         break;
365                 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
366                 if( !i_options ) continue;
367
368                 /* Find the right category item */
369
370                 long cookie;
371                 vlc_bool_t b_found = VLC_FALSE;
372                 unsigned int i;
373                 VLCTreeItem* p_category_item, * p_subcategory_item;
374                 for (i = 0 ; i < [o_children count] ; i++)
375                 {
376                     p_category_item = [o_children objectAtIndex: i];
377                     if( p_category_item->i_object_id == i_category )
378                     {
379                         b_found = VLC_TRUE;
380                         break;
381                     }
382                 }
383                 if( !b_found ) continue;
384
385                 /* Find subcategory item */
386                 b_found = VLC_FALSE;
387                 cookie = -1;
388                 for (i = 0 ; i < [p_category_item->o_children count] ; i++)
389                 {
390                     p_subcategory_item = [p_category_item->o_children
391                                             objectAtIndex: i];
392                     if( p_subcategory_item->i_object_id == i_subcategory )
393                     {
394                         b_found = VLC_TRUE;
395                         break;
396                     }
397                 }
398                 if( !b_found )
399                     p_subcategory_item = p_category_item;
400
401                 [p_subcategory_item->o_children addObject:[[VLCTreeItem alloc]
402                     initWithName:[[VLCMain sharedInstance]
403                         localizedString: p_module->psz_object_name ]
404                     ID: p_module->i_object_id
405                     parent:p_subcategory_item
406                     children:IsALeafNode
407                     whithCategory: -1]];
408             }
409         }
410         vlc_list_release( p_list );
411     }
412     return o_children;
413 }
414
415 - (int)getObjectID
416 {
417     return i_object_id;
418 }
419
420 - (NSString *)getName
421 {
422     return o_name;
423 }
424
425 - (VLCTreeItem *)childAtIndex:(int)i_index
426 {
427     return [[self children] objectAtIndex:i_index];
428 }
429
430 - (int)numberOfChildren {
431     id i_tmp = [self children];
432     return (i_tmp == IsALeafNode) ? (-1) : (int)[i_tmp count];
433 }
434
435 - (BOOL)hasPrefs:(NSString *)o_module_name
436 {
437     intf_thread_t *p_intf = VLCIntf;
438     module_t *p_parser;
439     vlc_list_t *p_list;
440     char *psz_module_name;
441     int i_index;
442
443     psz_module_name = (char *)[o_module_name UTF8String];
444
445     /* look for module */
446     p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
447
448     for( i_index = 0; i_index < p_list->i_count; i_index++ )
449     {
450         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
451
452         if( !strcmp( p_parser->psz_object_name, psz_module_name ) )
453         {
454             BOOL b_has_prefs = p_parser->i_config_items != 0;
455             vlc_list_release( p_list );
456             return( b_has_prefs );
457         }
458     }
459
460     vlc_list_release( p_list );
461
462     return( NO );
463 }
464
465 - (NSView *)showView:(NSScrollView *)o_prefs_view
466     advancedView:(vlc_bool_t) b_advanced
467 {
468     NSRect          s_vrc;
469     NSView          *o_view;
470
471     s_vrc = [[o_prefs_view contentView] bounds]; s_vrc.size.height -= 4;
472     o_view = [[VLCFlippedView alloc] initWithFrame: s_vrc];
473     [o_view setAutoresizingMask: NSViewWidthSizable | NSViewMinYMargin |
474                                     NSViewMaxYMargin];
475
476 /* Create all subviews if it isn't already done because we cannot use */
477 /* setHiden for MacOS < 10.3*/
478     if( o_subviews == nil )
479     {
480         intf_thread_t   *p_intf = VLCIntf;
481         vlc_list_t      *p_list;
482         module_t        *p_parser = NULL;
483         module_config_t *p_item;
484
485         o_subviews = [[NSMutableArray alloc] initWithCapacity:10];
486         /* Get a pointer to the module */
487         if( i_object_category == -1 )
488         {
489             p_parser = (module_t *) vlc_object_get( p_intf, i_object_id );
490             if( !p_parser || p_parser->i_object_type != VLC_OBJECT_MODULE )
491             {
492                 /* 0OOoo something went really bad */
493                 return nil;
494             }
495             p_item = p_parser->p_config;
496             int i = 0;
497
498             p_item = p_parser->p_config + 1;
499
500             do
501             {
502                 if( !p_item )
503                 {
504                     msg_Err( p_intf, "null item found" );
505                     break;
506                 }
507                 switch(p_item->i_type)
508                 {
509                 case CONFIG_SUBCATEGORY:
510                     break;
511                 case CONFIG_SECTION:
512                     break;
513                 case CONFIG_CATEGORY:
514                     break;
515                 case CONFIG_HINT_END:
516                     break;
517                 case CONFIG_HINT_USAGE:
518                     break;
519                 default:
520                 {
521                     VLCConfigControl *o_control = nil;
522                     o_control = [VLCConfigControl newControl:p_item
523                                                   withView:o_view];
524                     if( o_control != nil )
525                     {
526                         [o_control setAutoresizingMask: NSViewMaxYMargin |
527                             NSViewWidthSizable];
528                         [o_subviews addObject: o_control];
529                     }
530                 }
531                     break;
532                 }
533             } while( p_item++->i_type != CONFIG_HINT_END );
534
535             vlc_object_release( p_parser );
536         }
537         else
538         {
539             int i = 0;
540             int i_index;
541             p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
542             if( !p_list ) return o_view;
543
544             /*
545             * Find the main module
546             */
547             for( i_index = 0; i_index < p_list->i_count; i_index++ )
548             {
549                 p_parser = (module_t *)p_list->p_values[i_index].p_object;
550                 if( !strcmp( p_parser->psz_object_name, "main" ) )
551                     break;
552             }
553             if( p_parser == NULL )
554             {
555                 msg_Err( p_intf, "could not find the main module in our "
556                                     "preferences" );
557                 return o_view;
558             }
559             p_item = (p_parser->p_config + i_object_category);
560             if( ( p_item->i_type == CONFIG_CATEGORY ) &&
561               ( ( p_item->i_value == CAT_PLAYLIST )  ||
562                 ( p_item->i_value == CAT_AUDIO )  ||
563                 ( p_item->i_value == CAT_VIDEO ) ) )
564                 p_item++;
565
566             do
567             {
568                 p_item++;
569                 if( !p_item )
570                 {
571                     msg_Err( p_intf, "null item found" );
572                     break;
573                 }
574                 switch(p_item->i_type)
575                 {
576                 case CONFIG_SUBCATEGORY:
577                     break;
578                 case CONFIG_SECTION:
579                     break;
580                 case CONFIG_CATEGORY:
581                     break;
582                 case CONFIG_HINT_END:
583                     break;
584                 case CONFIG_HINT_USAGE:
585                     break;
586                 default:
587                 {
588                     VLCConfigControl *o_control = nil;
589                     o_control = [VLCConfigControl newControl:p_item
590                                                   withView:o_view];
591                     if( o_control != nil )
592                     {
593                         [o_control setAutoresizingMask: NSViewMaxYMargin |
594                                                         NSViewWidthSizable];
595                         [o_subviews addObject: o_control];
596                     }
597                     break;
598                 }
599                 }
600             } while ( ( p_item->i_type != CONFIG_HINT_END ) &&
601                       ( p_item->i_type != CONFIG_SUBCATEGORY ) );
602
603             vlc_list_release( p_list );
604         }
605     }
606
607     if( o_view != nil )
608     {
609         int i_lastItem = 0;
610         int i_yPos = -2;
611         int i_max_label = 0;
612         int i_show_advanced = 0;
613
614         NSEnumerator *enumerator = [o_subviews objectEnumerator];
615         VLCConfigControl *o_widget;
616         NSRect o_frame;
617         
618         while( ( o_widget = [enumerator nextObject] ) )
619             if( ( [o_widget isAdvanced] ) && (! b_advanced) )
620                 continue;
621             else if( i_max_label < [o_widget getLabelSize] )
622                 i_max_label = [o_widget getLabelSize];
623
624         enumerator = [o_subviews objectEnumerator];
625         while( ( o_widget = [enumerator nextObject] ) )
626         {
627             int i_widget;
628             if( ( [o_widget isAdvanced] ) && (! b_advanced) )
629             {
630                 i_show_advanced++;
631                 continue;
632             }
633
634             i_widget = [o_widget getViewType];
635             i_yPos += [VLCConfigControl calcVerticalMargin:i_widget
636                 lastItem:i_lastItem];
637             [o_widget setYPos:i_yPos];
638             o_frame = [o_widget frame];
639             o_frame.size.width = [o_view frame].size.width -
640                                     LEFTMARGIN - RIGHTMARGIN;
641             [o_widget setFrame:o_frame];
642             [o_widget alignWithXPosition: i_max_label];
643             i_yPos += [o_widget frame].size.height;
644             i_lastItem = i_widget;
645             [o_view addSubview:o_widget];
646          }
647         if( i_show_advanced != 0 )
648         {
649             /* We add the advanced notice... */
650             NSRect s_rc = [o_view frame];
651             NSTextField *o_label;
652             s_rc.size.height = 17;
653             s_rc.origin.x = LEFTMARGIN;
654             s_rc.origin.y = i_yPos += [VLCConfigControl
655                                         calcVerticalMargin:CONFIG_ITEM_STRING
656                                         lastItem:i_lastItem];
657             o_label = [[[NSTextField alloc] initWithFrame: s_rc] retain];
658             [o_label setDrawsBackground: NO];
659             [o_label setBordered: NO];
660             [o_label setEditable: NO];
661             [o_label setSelectable: NO];
662             [o_label setStringValue: _NS("Some options are available but " \
663                                 "hidden. Check \"Advanced\" to see them.")];
664             [o_label setFont:[NSFont systemFontOfSize:10]];
665             [o_label sizeToFit];
666             [o_view addSubview:o_label];
667             i_yPos += [o_label frame].size.height;
668         }
669         o_frame = [o_view frame];
670         o_frame.size.height = i_yPos;
671         [o_view setFrame:o_frame];
672         [o_prefs_view setDocumentView:o_view];
673
674     }
675     return o_view;
676 }
677
678 - (void)applyChanges
679 {
680     unsigned int i;
681     if( o_subviews != nil )
682         //Item has been shown
683         for( i = 0 ; i < [o_subviews count] ; i++ )
684             [[o_subviews objectAtIndex:i] applyChanges];
685
686     if( o_children != IsALeafNode )
687         for( i = 0 ; i < [o_children count] ; i++ )
688             [[o_children objectAtIndex:i] applyChanges];
689 }
690
691 - (void)resetView
692 {
693     unsigned int i;
694     if( o_subviews != nil )
695     {
696         //Item has been shown
697         [o_subviews release];
698         o_subviews = nil;
699     }
700
701     if( o_children != IsALeafNode )
702         for( i = 0 ; i < [o_children count] ; i++ )
703             [[o_children objectAtIndex:i] resetView];
704 }
705
706 @end
707
708
709 @implementation VLCFlippedView
710
711 - (BOOL)isFlipped
712 {
713     return( YES );
714 }
715
716 @end