1 /*****************************************************************************
2 * prefs.m: MacOS X module for vlc
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
7 * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8 * Derk-Jan Hartman <hartman at videolan dot 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 *****************************************************************************/
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)
37 The class is sort of a mix of wxwindows intfs, PrefsTreeCtrl and ConfigTreeData
39 /* VLCConfigControl are subclassed NSView's containing and managing individual config items
40 the classes are VERY closely related to wxwindows ConfigControls */
42 /*****************************************************************************
44 *****************************************************************************/
45 #include <stdlib.h> /* malloc(), free() */
46 #include <sys/param.h> /* for MAXPATHLEN */
54 #include <vlc_config_cat.h>
58 #include "prefs_widgets.h"
61 /*****************************************************************************
62 * VLCPrefs implementation
63 *****************************************************************************/
64 @implementation VLCPrefs
66 static VLCPrefs *_o_sharedMainInstance = nil;
68 + (VLCPrefs *)sharedInstance
70 return _o_sharedMainInstance ? _o_sharedMainInstance : [[self alloc] init];
75 if( _o_sharedMainInstance ) {
80 _o_sharedMainInstance = [super init];
82 o_empty_view = [[NSView alloc] init];
85 return _o_sharedMainInstance;
90 [o_empty_view release];
97 b_advanced = config_GetInt( p_intf, "advanced" );
100 [o_advanced_ckb setState: b_advanced];
101 [o_prefs_view setBorderType: NSGrooveBorder];
102 [o_prefs_view setHasVerticalScroller: YES];
103 [o_prefs_view setDrawsBackground: NO];
104 [o_prefs_view setDocumentView: o_empty_view];
105 [o_tree selectRow:0 byExtendingSelection:NO];
108 - (void)setTitle: (NSString *) o_title_name
110 [o_title setStringValue: o_title_name];
115 [o_prefs_window center];
116 [o_prefs_window makeKeyAndOrderFront:self];
121 [o_prefs_window setTitle: _NS("Preferences")];
122 [o_save_btn setTitle: _NS("Save")];
123 [o_cancel_btn setTitle: _NS("Cancel")];
124 [o_reset_btn setTitle: _NS("Reset All")];
125 [o_advanced_ckb setTitle: _NS("Advanced")];
128 - (IBAction)savePrefs: (id)sender
130 /* TODO: call savePrefs on Root item */
131 [[VLCTreeItem rootItem] applyChanges];
132 config_SaveConfigFile( p_intf, NULL );
133 [o_prefs_window orderOut:self];
136 - (IBAction)closePrefs: (id)sender
138 [o_prefs_window orderOut:self];
141 - (IBAction)resetAll: (id)sender
143 NSBeginInformationalAlertSheet(_NS("Reset Preferences"), _NS("Cancel"),
144 _NS("Continue"), nil, o_prefs_window, self,
145 @selector(sheetDidEnd: returnCode: contextInfo:), NULL, nil,
146 _NS("Beware this will reset the VLC media player preferences.\n"
147 "Are you sure you want to continue?") );
150 - (void)sheetDidEnd:(NSWindow *)o_sheet returnCode:(int)i_return
151 contextInfo:(void *)o_context
153 if( i_return == NSAlertAlternateReturn )
155 [o_prefs_view setDocumentView: o_empty_view];
156 config_ResetAll( p_intf );
157 [[VLCTreeItem rootItem] resetView];
158 [[o_tree itemAtRow:[o_tree selectedRow]]
159 showView:o_prefs_view advancedView:
160 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
164 - (IBAction)advancedToggle: (id)sender
166 b_advanced = !b_advanced;
167 [o_advanced_ckb setState: b_advanced];
168 /* refresh the view of the current treeitem */
169 [[o_tree itemAtRow:[o_tree selectedRow]] showView:o_prefs_view advancedView:
170 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
173 - (void)loadConfigTree
177 - (void)outlineViewSelectionIsChanging:(NSNotification *)o_notification
181 /* update the document view to the view of the selected tree item */
182 - (void)outlineViewSelectionDidChange:(NSNotification *)o_notification
184 [[o_tree itemAtRow:[o_tree selectedRow]] showView: o_prefs_view
185 advancedView:( [o_advanced_ckb state] == NSOnState ) ?
186 VLC_TRUE : VLC_FALSE];
191 @implementation VLCPrefs (NSTableDataSource)
193 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item {
194 return (item == nil) ? [[VLCTreeItem rootItem] numberOfChildren] :
195 [item numberOfChildren];
198 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
200 return (item == nil) ? YES : ( ([item numberOfChildren] != -1) &&
201 ([item numberOfChildren] != 0));
204 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item {
205 return (item == nil) ? [[VLCTreeItem rootItem] childAtIndex:index] :
206 (id)[item childAtIndex:index];
209 - (id)outlineView:(NSOutlineView *)outlineView
210 objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
212 return (item == nil) ? @"" : (id)[item getName];
217 @implementation VLCTreeItem
219 static VLCTreeItem *o_root_item = nil;
221 #define IsALeafNode ((id)-1)
223 - (id)initWithName: (NSString *)o_item_name
224 withTitle: (NSString *)o_item_title
225 withHelp: (NSString *)o_item_help
227 parent:(VLCTreeItem *)o_parent_item
228 children:(NSMutableArray *)o_children_array
229 whithCategory: (int) i_category
235 o_name = [o_item_name copy];
236 o_title= [o_item_title copy];
237 o_help= [o_item_help copy];
239 o_parent = o_parent_item;
240 o_children = o_children_array;
241 i_object_category = i_category;
247 + (VLCTreeItem *)rootItem
249 if (o_root_item == nil)
250 o_root_item = [[VLCTreeItem alloc] initWithName:@"main" withTitle:@"main" withHelp:@"" ID:0
251 parent:nil children:[[NSMutableArray alloc] initWithCapacity:10]
258 if (o_children != IsALeafNode) [o_children release];
265 /* Creates and returns the array of children
266 * Loads children incrementally */
267 - (NSArray *)children
269 if( o_children == IsALeafNode )
271 if( [ o_children count] == 0 )
273 intf_thread_t *p_intf = VLCIntf;
275 module_config_t *p_item,
278 /* Build the tree for the main module */
279 const module_t *p_module = NULL;
280 vlc_list_t *p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE,
282 if( !p_list ) return NULL;
283 for( unsigned i = 0; p_module == NULL; i++ )
285 assert (i < (unsigned)p_list->i_count);
287 const module_t *p_main = (module_t *)p_list->p_values[i].p_object;
288 if( strcmp( module_GetObjName( p_main ), "main" ) == 0 )
292 VLCTreeItem *p_last_category = NULL;
293 unsigned int i_confsize;
294 module_config_t *const p_config = module_GetConfig (p_module, &i_confsize);
295 p_end = p_item + i_confsize;
297 for (size_t i = 0; i < i_confsize; i++)
299 p_item = p_config + i;
301 NSString *o_child_name;
302 NSString *o_child_title;
303 NSString *o_child_help;
305 switch( p_item->i_type )
307 case CONFIG_CATEGORY:
308 if( p_item->value.i == -1 ) break;
310 o_child_name = [[VLCMain sharedInstance]
311 localizedString: config_CategoryNameGet( p_item->value.i )];
312 o_child_title = o_child_name;
313 o_child_help = [[VLCMain sharedInstance]
314 localizedString: config_CategoryHelpGet( p_item->value.i )];
315 p_last_category = [VLCTreeItem alloc];
316 [o_children addObject:[p_last_category
317 initWithName: o_child_name
318 withTitle: o_child_title
319 withHelp: o_child_help
322 children:[[NSMutableArray alloc]
324 whithCategory: p_item - module_GetConfig( p_module, &i_confsize )]];
326 case CONFIG_SUBCATEGORY:
327 if( p_item->value.i == -1 ) break;
329 /* Special cases: move the main subcategories to the parent cat*/
330 if( p_item->value.i != SUBCAT_PLAYLIST_GENERAL &&
331 p_item->value.i != SUBCAT_VIDEO_GENERAL &&
332 p_item->value.i != SUBCAT_INPUT_GENERAL &&
333 p_item->value.i != SUBCAT_INTERFACE_GENERAL &&
334 p_item->value.i != SUBCAT_SOUT_GENERAL &&
335 p_item->value.i != SUBCAT_ADVANCED_MISC &&
336 p_item->value.i != SUBCAT_AUDIO_GENERAL )
338 o_child_name = [[VLCMain sharedInstance]
339 localizedString: config_CategoryNameGet( p_item->value.i ) ];
340 o_child_title = o_child_name;
341 o_child_help = [[VLCMain sharedInstance]
342 localizedString: config_CategoryHelpGet( p_item->value.i ) ];
344 [p_last_category->o_children
345 addObject:[[VLCTreeItem alloc]
346 initWithName: o_child_name
347 withTitle: o_child_title
348 withHelp: o_child_help
350 parent:p_last_category
351 children:[[NSMutableArray alloc]
353 whithCategory: p_item - module_GetConfig( p_module, &i_confsize )]];
362 module_PutConfig (p_config);
364 /* Build the tree of plugins */
365 /* Build a tree of the plugins */
366 /* Add the capabilities */
367 for( i_index = 0; i_index < p_list->i_count; i_index++ )
369 unsigned int confsize;
370 p_module = (module_t *)p_list->p_values[i_index].p_object;
372 /* Exclude the main module */
373 if( !strcmp( module_GetObjName( p_module ), "main" ) )
376 /* Exclude empty plugins (submodules don't have config */
377 /* options, they are stored in the parent module) */
379 // if( modules_IsSubModule( p_module ) )
381 p_item = module_GetConfig( p_module, &confsize );
383 if( !p_item ) continue;
385 int i_subcategory = -1;
389 if( p_item->i_type == CONFIG_CATEGORY )
390 i_category = p_item->value.i;
391 else if( p_item->i_type == CONFIG_SUBCATEGORY )
392 i_subcategory = p_item->value.i;
394 if( p_item->i_type & CONFIG_ITEM )
396 if( i_options > 0 && i_category >= 0 && i_subcategory >= 0 )
398 } while( p_item < p_end && p_item++ );
399 if( !i_options ) continue;
401 /* Find the right category item */
404 vlc_bool_t b_found = VLC_FALSE;
406 VLCTreeItem* p_category_item, * p_subcategory_item;
407 for (i = 0 ; i < [o_children count] ; i++)
409 p_category_item = [o_children objectAtIndex: i];
410 if( p_category_item->i_object_id == i_category )
416 if( !b_found ) continue;
418 /* Find subcategory item */
421 for (i = 0 ; i < [p_category_item->o_children count] ; i++)
423 p_subcategory_item = [p_category_item->o_children
425 if( p_subcategory_item->i_object_id == i_subcategory )
432 p_subcategory_item = p_category_item;
434 [p_subcategory_item->o_children addObject:[[VLCTreeItem alloc]
435 initWithName:[[VLCMain sharedInstance]
436 localizedString: module_GetName( p_module, VLC_FALSE ) ]
437 withTitle:[[VLCMain sharedInstance]
438 localizedString: module_GetLongName( p_module ) ]
440 ID: ((vlc_object_t*)p_module)->i_object_id
441 parent:p_subcategory_item
446 vlc_list_release( p_list );
458 - (NSString *)getName
463 - (NSString *)getTitle
468 - (NSString *)getHelp
473 - (VLCTreeItem *)childAtIndex:(int)i_index
475 return [[self children] objectAtIndex:i_index];
478 - (int)numberOfChildren {
479 id i_tmp = [self children];
480 return (i_tmp == IsALeafNode) ? (-1) : (int)[i_tmp count];
483 - (BOOL)hasPrefs:(NSString *)o_module_name
485 intf_thread_t *p_intf = VLCIntf;
488 char *psz_module_name;
491 psz_module_name = (char *)[o_module_name UTF8String];
493 /* look for module */
494 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
496 for( i_index = 0; i_index < p_list->i_count; i_index++ )
498 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
500 if( !strcmp( module_GetObjName( p_parser ), psz_module_name ) )
502 unsigned int confsize;
503 module_GetConfig( p_parser, &confsize );
504 BOOL b_has_prefs = confsize != 0;
505 vlc_list_release( p_list );
506 return( b_has_prefs );
510 vlc_list_release( p_list );
515 - (NSView *)showView:(NSScrollView *)o_prefs_view
516 advancedView:(vlc_bool_t) b_advanced
521 [[VLCPrefs sharedInstance] setTitle: [self getTitle]];
522 /* NSLog( [self getHelp] ); */
523 s_vrc = [[o_prefs_view contentView] bounds]; s_vrc.size.height -= 4;
524 o_view = [[VLCFlippedView alloc] initWithFrame: s_vrc];
525 [o_view setAutoresizingMask: NSViewWidthSizable | NSViewMinYMargin |
528 /* Create all subviews if it isn't already done because we cannot use */
529 /* setHiden for MacOS < 10.3*/
530 if( o_subviews == nil )
532 intf_thread_t *p_intf = VLCIntf;
534 module_t *p_parser = NULL;
535 module_config_t *p_item,
537 unsigned int confsize;
539 o_subviews = [[NSMutableArray alloc] initWithCapacity:10];
540 /* Get a pointer to the module */
541 if( i_object_category == -1 )
543 p_parser = (module_t *) vlc_object_get( i_object_id );
544 if( !p_parser || ((vlc_object_t*)p_parser)->i_object_type != VLC_OBJECT_MODULE )
546 /* 0OOoo something went really bad */
549 p_item = module_GetConfig( p_parser, &confsize );
550 p_end = p_item + confsize;
556 msg_Err( p_intf, "invalid preference item found" );
561 switch(p_item->i_type)
563 case CONFIG_SUBCATEGORY:
565 case CONFIG_CATEGORY:
569 case CONFIG_HINT_USAGE:
573 VLCConfigControl *o_control = nil;
574 o_control = [VLCConfigControl newControl:p_item
576 if( o_control != nil )
578 [o_control setAutoresizingMask: NSViewMaxYMargin |
580 [o_subviews addObject: o_control];
585 } while( p_item < p_end && p_item++ );
587 vlc_object_release( (vlc_object_t*)p_parser );
592 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
593 if( !p_list ) return o_view;
596 * Find the main module
598 for( i_index = 0; i_index < p_list->i_count; i_index++ )
600 p_parser = (module_t *)p_list->p_values[i_index].p_object;
601 if( !strcmp( module_GetObjName( p_parser ), "main" ) )
604 if( p_parser == NULL )
606 msg_Err( p_intf, "could not load preferences" );
609 unsigned int confsize;
610 p_item = module_GetConfig( p_parser, &confsize );
611 p_end = p_item + confsize;
612 p_item += i_object_category;
614 if( ( p_item->i_type == CONFIG_CATEGORY ) &&
615 ( ( p_item->value.i == CAT_PLAYLIST ) ||
616 ( p_item->value.i == CAT_AUDIO ) ||
617 ( p_item->value.i == CAT_VIDEO ) ||
618 ( p_item->value.i == CAT_INTERFACE ) ||
619 ( p_item->value.i == CAT_INPUT ) ||
620 ( p_item->value.i == CAT_SOUT ) ) )
626 if( !p_item || !p_item->i_type )
628 msg_Err( p_intf, "invalid preference item found" );
633 switch( p_item->i_type )
635 case CONFIG_SUBCATEGORY:
637 case CONFIG_CATEGORY:
641 case CONFIG_HINT_USAGE:
645 VLCConfigControl *o_control = nil;
646 o_control = [VLCConfigControl newControl:p_item
648 if( o_control != nil )
650 [o_control setAutoresizingMask: NSViewMaxYMargin |
652 [o_subviews addObject: o_control];
657 } while ( ( p_item < p_end ) &&
658 ( p_item->i_type != CONFIG_SUBCATEGORY ) );
660 vlc_list_release( p_list );
669 int i_show_advanced = 0;
671 NSEnumerator *enumerator = [o_subviews objectEnumerator];
672 VLCConfigControl *o_widget;
675 while( ( o_widget = [enumerator nextObject] ) )
676 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
678 else if( i_max_label < [o_widget getLabelSize] )
679 i_max_label = [o_widget getLabelSize];
681 enumerator = [o_subviews objectEnumerator];
682 while( ( o_widget = [enumerator nextObject] ) )
685 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
691 i_widget = [o_widget getViewType];
692 i_yPos += [VLCConfigControl calcVerticalMargin:i_widget
693 lastItem:i_lastItem];
694 [o_widget setYPos:i_yPos];
695 o_frame = [o_widget frame];
696 o_frame.size.width = [o_view frame].size.width -
697 LEFTMARGIN - RIGHTMARGIN;
698 [o_widget setFrame:o_frame];
699 [o_widget alignWithXPosition: i_max_label];
700 i_yPos += [o_widget frame].size.height;
701 i_lastItem = i_widget;
702 [o_view addSubview:o_widget];
704 if( i_show_advanced != 0 )
706 /* We add the advanced notice... */
707 NSRect s_rc = [o_view frame];
708 NSTextField *o_label;
709 s_rc.size.height = 17;
710 s_rc.origin.x = LEFTMARGIN;
711 s_rc.origin.y = i_yPos += [VLCConfigControl
712 calcVerticalMargin:CONFIG_ITEM_STRING
713 lastItem:i_lastItem];
714 o_label = [[[NSTextField alloc] initWithFrame: s_rc] retain];
715 [o_label setDrawsBackground: NO];
716 [o_label setBordered: NO];
717 [o_label setEditable: NO];
718 [o_label setSelectable: NO];
719 [o_label setStringValue: _NS("Some options are hidden. " \
720 "Check \"Advanced\" to display them.")];
721 [o_label setFont:[NSFont systemFontOfSize:10]];
723 [o_view addSubview:o_label];
724 i_yPos += [o_label frame].size.height;
726 o_frame = [o_view frame];
727 o_frame.size.height = i_yPos;
728 [o_view setFrame:o_frame];
729 [o_prefs_view setDocumentView:o_view];
738 if( o_subviews != nil )
739 //Item has been shown
740 for( i = 0 ; i < [o_subviews count] ; i++ )
741 [[o_subviews objectAtIndex:i] applyChanges];
743 if( o_children != IsALeafNode )
744 for( i = 0 ; i < [o_children count] ; i++ )
745 [[o_children objectAtIndex:i] applyChanges];
751 if( o_subviews != nil )
753 //Item has been shown
754 [o_subviews release];
758 if( o_children != IsALeafNode )
759 for( i = 0 ; i < [o_children count] ; i++ )
760 [[o_children objectAtIndex:i] resetView];
766 @implementation VLCFlippedView