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 */
50 #include <vlc_config_cat.h>
54 #include "prefs_widgets.h"
57 /*****************************************************************************
58 * VLCPrefs implementation
59 *****************************************************************************/
60 @implementation VLCPrefs
62 static VLCPrefs *_o_sharedMainInstance = nil;
64 + (VLCPrefs *)sharedInstance
66 return _o_sharedMainInstance ? _o_sharedMainInstance : [[self alloc] init];
71 if( _o_sharedMainInstance ) {
76 _o_sharedMainInstance = [super init];
78 o_empty_view = [[NSView alloc] init];
81 return _o_sharedMainInstance;
86 [o_empty_view release];
93 b_advanced = config_GetInt( p_intf, "advanced" );
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];
104 - (void)setTitle: (NSString *) o_title_name
106 [o_title setStringValue: o_title_name];
111 /* load our nib (if not already loaded) */
112 [NSBundle loadNibNamed:@"Preferences" owner:self];
114 [o_prefs_window center];
115 [o_prefs_window makeKeyAndOrderFront:self];
120 [o_prefs_window setTitle: _NS("Preferences")];
121 [o_save_btn setTitle: _NS("Save")];
122 [o_cancel_btn setTitle: _NS("Cancel")];
123 [o_reset_btn setTitle: _NS("Reset All")];
124 [o_advanced_ckb setTitle: _NS("Advanced")];
127 - (IBAction)savePrefs: (id)sender
129 /* TODO: call savePrefs on Root item */
130 [[VLCTreeItem rootItem] applyChanges];
131 config_SaveConfigFile( p_intf, NULL );
132 [o_prefs_window orderOut:self];
135 - (IBAction)closePrefs: (id)sender
137 [o_prefs_window orderOut:self];
140 - (IBAction)resetAll: (id)sender
142 NSBeginInformationalAlertSheet(_NS("Reset Preferences"), _NS("Cancel"),
143 _NS("Continue"), nil, o_prefs_window, self,
144 @selector(sheetDidEnd: returnCode: contextInfo:), NULL, nil,
145 _NS("Beware this will reset the VLC media player preferences.\n"
146 "Are you sure you want to continue?") );
149 - (void)sheetDidEnd:(NSWindow *)o_sheet returnCode:(int)i_return
150 contextInfo:(void *)o_context
152 if( i_return == NSAlertAlternateReturn )
154 [o_prefs_view setDocumentView: o_empty_view];
155 config_ResetAll( p_intf );
156 [[VLCTreeItem rootItem] resetView];
157 [[o_tree itemAtRow:[o_tree selectedRow]]
158 showView:o_prefs_view advancedView:
159 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
163 - (IBAction)advancedToggle: (id)sender
165 b_advanced = !b_advanced;
166 [o_advanced_ckb setState: b_advanced];
167 /* refresh the view of the current treeitem */
168 [[o_tree itemAtRow:[o_tree selectedRow]] showView:o_prefs_view advancedView:
169 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
172 - (void)loadConfigTree
176 - (void)outlineViewSelectionIsChanging:(NSNotification *)o_notification
180 /* update the document view to the view of the selected tree item */
181 - (void)outlineViewSelectionDidChange:(NSNotification *)o_notification
183 [[o_tree itemAtRow:[o_tree selectedRow]] showView: o_prefs_view
184 advancedView:( [o_advanced_ckb state] == NSOnState ) ?
185 VLC_TRUE : VLC_FALSE];
190 @implementation VLCPrefs (NSTableDataSource)
192 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item {
193 return (item == nil) ? [[VLCTreeItem rootItem] numberOfChildren] :
194 [item numberOfChildren];
197 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
199 return (item == nil) ? YES : ( ([item numberOfChildren] != -1) &&
200 ([item numberOfChildren] != 0));
203 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item {
204 return (item == nil) ? [[VLCTreeItem rootItem] childAtIndex:index] :
205 (id)[item childAtIndex:index];
208 - (id)outlineView:(NSOutlineView *)outlineView
209 objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
211 return (item == nil) ? @"" : (id)[item getName];
216 @implementation VLCTreeItem
218 static VLCTreeItem *o_root_item = nil;
220 #define IsALeafNode ((id)-1)
222 - (id)initWithName: (NSString *)o_item_name
223 withTitle: (NSString *)o_item_title
224 withHelp: (NSString *)o_item_help
226 parent:(VLCTreeItem *)o_parent_item
227 children:(NSMutableArray *)o_children_array
228 whithCategory: (int) i_category
234 o_name = [o_item_name copy];
235 o_title= [o_item_title copy];
236 o_help= [o_item_help copy];
238 o_parent = o_parent_item;
239 o_children = o_children_array;
240 i_object_category = i_category;
246 + (VLCTreeItem *)rootItem
248 if (o_root_item == nil)
249 o_root_item = [[VLCTreeItem alloc] initWithName:@"main" withTitle:@"main" withHelp:@"" ID:0
250 parent:nil children:[[NSMutableArray alloc] initWithCapacity:10]
257 if (o_children != IsALeafNode) [o_children release];
264 /* Creates and returns the array of children
265 * Loads children incrementally */
266 - (NSArray *)children
268 if( o_children == IsALeafNode )
270 if( [ o_children count] == 0 )
272 intf_thread_t *p_intf = VLCIntf;
274 module_t *p_module = NULL;
275 module_config_t *p_item;
278 /* List the modules */
279 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
280 if( !p_list ) return nil;
282 if( [[self getName] isEqualToString: @"main"] )
285 * Find the main module
287 for( i_index = 0; i_index < p_list->i_count; i_index++ )
289 p_module = (module_t *)p_list->p_values[i_index].p_object;
290 if( !strcmp( p_module->psz_object_name, "main" ) )
293 if( p_module == NULL )
296 "could not load the preferences" );
299 if( i_index < p_list->i_count )
301 /* We found the main module */
302 /* Enumerate config categories and store a reference so we can
303 * generate their config panel them when it is asked by the user. */
304 VLCTreeItem *p_last_category = NULL;
305 p_item = p_module->p_config;
306 o_children = [[NSMutableArray alloc] initWithCapacity:10];
309 NSString *o_child_name;
310 NSString *o_child_title;
311 NSString *o_child_help;
312 switch( p_item->i_type )
314 case CONFIG_CATEGORY:
315 if( p_item->i_value == -1 ) break;
317 o_child_name = [[VLCMain sharedInstance]
318 localizedString: config_CategoryNameGet( p_item->i_value ) ];
319 o_child_title = o_child_name;
320 o_child_help = [[VLCMain sharedInstance]
321 localizedString: config_CategoryHelpGet( p_item->i_value ) ];
322 p_last_category = [VLCTreeItem alloc];
323 [o_children addObject:[p_last_category
324 initWithName: o_child_name
325 withTitle: o_child_title
326 withHelp: o_child_help
329 children:[[NSMutableArray alloc]
331 whithCategory: p_item - p_module->p_config]];
333 case CONFIG_SUBCATEGORY:
334 if( p_item->i_value == -1 ) break;
336 if( p_item->i_value != SUBCAT_PLAYLIST_GENERAL &&
337 p_item->i_value != SUBCAT_VIDEO_GENERAL &&
338 p_item->i_value != SUBCAT_INPUT_GENERAL &&
339 p_item->i_value != SUBCAT_INTERFACE_GENERAL &&
340 p_item->i_value != SUBCAT_SOUT_GENERAL &&
341 p_item->i_value != SUBCAT_ADVANCED_MISC &&
342 p_item->i_value != SUBCAT_AUDIO_GENERAL )
344 o_child_name = [[VLCMain sharedInstance]
345 localizedString: config_CategoryNameGet( p_item->i_value ) ];
346 o_child_title = o_child_name;
347 o_child_help = [[VLCMain sharedInstance]
348 localizedString: config_CategoryHelpGet( p_item->i_value ) ];
350 [p_last_category->o_children
351 addObject:[[VLCTreeItem alloc]
352 initWithName: o_child_name
353 withTitle: o_child_title
354 withHelp: o_child_help
356 parent:p_last_category
357 children:[[NSMutableArray alloc]
359 whithCategory: p_item - p_module->p_config]];
366 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
369 /* Build a tree of the plugins */
370 /* Add the capabilities */
371 for( i_index = 0; i_index < p_list->i_count; i_index++ )
373 p_module = (module_t *)p_list->p_values[i_index].p_object;
375 /* Exclude the main module */
376 if( !strcmp( p_module->psz_object_name, "main" ) )
379 /* Exclude empty plugins (submodules don't have config */
380 /* options, they are stored in the parent module) */
381 if( p_module->b_submodule )
384 p_item = p_module->p_config;
386 if( !p_item ) continue;
388 int i_subcategory = -1;
392 if( p_item->i_type == CONFIG_CATEGORY )
393 i_category = p_item->i_value;
394 else if( p_item->i_type == CONFIG_SUBCATEGORY )
395 i_subcategory = p_item->i_value;
397 if( p_item->i_type & CONFIG_ITEM )
399 if( i_options > 0 && i_category >= 0 && i_subcategory >= 0 )
401 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
402 if( !i_options ) continue;
404 /* Find the right category item */
407 vlc_bool_t b_found = VLC_FALSE;
409 VLCTreeItem* p_category_item, * p_subcategory_item;
410 for (i = 0 ; i < [o_children count] ; i++)
412 p_category_item = [o_children objectAtIndex: i];
413 if( p_category_item->i_object_id == i_category )
419 if( !b_found ) continue;
421 /* Find subcategory item */
424 for (i = 0 ; i < [p_category_item->o_children count] ; i++)
426 p_subcategory_item = [p_category_item->o_children
428 if( p_subcategory_item->i_object_id == i_subcategory )
435 p_subcategory_item = p_category_item;
437 [p_subcategory_item->o_children addObject:[[VLCTreeItem alloc]
438 initWithName:[[VLCMain sharedInstance]
439 localizedString: p_module->psz_shortname ?
440 p_module->psz_shortname : p_module->psz_object_name ]
441 withTitle:[[VLCMain sharedInstance]
442 localizedString: p_module->psz_longname ?
443 p_module->psz_longname : p_module->psz_object_name ]
445 ID: p_module->i_object_id
446 parent:p_subcategory_item
451 vlc_list_release( p_list );
461 - (NSString *)getName
466 - (NSString *)getTitle
471 - (NSString *)getHelp
476 - (VLCTreeItem *)childAtIndex:(int)i_index
478 return [[self children] objectAtIndex:i_index];
481 - (int)numberOfChildren {
482 id i_tmp = [self children];
483 return (i_tmp == IsALeafNode) ? (-1) : (int)[i_tmp count];
486 - (BOOL)hasPrefs:(NSString *)o_module_name
488 intf_thread_t *p_intf = VLCIntf;
491 char *psz_module_name;
494 psz_module_name = (char *)[o_module_name UTF8String];
496 /* look for module */
497 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
499 for( i_index = 0; i_index < p_list->i_count; i_index++ )
501 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
503 if( !strcmp( p_parser->psz_object_name, psz_module_name ) )
505 BOOL b_has_prefs = p_parser->i_config_items != 0;
506 vlc_list_release( p_list );
507 return( b_has_prefs );
511 vlc_list_release( p_list );
516 - (NSView *)showView:(NSScrollView *)o_prefs_view
517 advancedView:(vlc_bool_t) b_advanced
522 [[VLCPrefs sharedInstance] setTitle: [self getTitle]];
523 /* NSLog( [self getHelp] ); */
524 s_vrc = [[o_prefs_view contentView] bounds]; s_vrc.size.height -= 4;
525 o_view = [[VLCFlippedView alloc] initWithFrame: s_vrc];
526 [o_view setAutoresizingMask: NSViewWidthSizable | NSViewMinYMargin |
529 /* Create all subviews if it isn't already done because we cannot use */
530 /* setHiden for MacOS < 10.3*/
531 if( o_subviews == nil )
533 intf_thread_t *p_intf = VLCIntf;
535 module_t *p_parser = NULL;
536 module_config_t *p_item;
538 o_subviews = [[NSMutableArray alloc] initWithCapacity:10];
539 /* Get a pointer to the module */
540 if( i_object_category == -1 )
542 p_parser = (module_t *) vlc_object_get( p_intf, i_object_id );
543 if( !p_parser || p_parser->i_object_type != VLC_OBJECT_MODULE )
545 /* 0OOoo something went really bad */
548 p_item = p_parser->p_config;
551 p_item = p_parser->p_config + 1;
557 msg_Err( p_intf, "invalid preference item found" );
560 switch(p_item->i_type)
562 case CONFIG_SUBCATEGORY:
564 case CONFIG_CATEGORY:
568 case CONFIG_HINT_END:
570 case CONFIG_HINT_USAGE:
574 VLCConfigControl *o_control = nil;
575 o_control = [VLCConfigControl newControl:p_item
577 if( o_control != nil )
579 [o_control setAutoresizingMask: NSViewMaxYMargin |
581 [o_subviews addObject: o_control];
586 } while( p_item++->i_type != CONFIG_HINT_END );
588 vlc_object_release( p_parser );
594 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
595 if( !p_list ) return o_view;
598 * Find the main module
600 for( i_index = 0; i_index < p_list->i_count; i_index++ )
602 p_parser = (module_t *)p_list->p_values[i_index].p_object;
603 if( !strcmp( p_parser->psz_object_name, "main" ) )
606 if( p_parser == NULL )
608 msg_Err( p_intf, "could not load preferences" );
611 p_item = (p_parser->p_config + i_object_category);
612 if( ( p_item->i_type == CONFIG_CATEGORY ) &&
613 ( ( p_item->i_value == CAT_PLAYLIST ) ||
614 ( p_item->i_value == CAT_AUDIO ) ||
615 ( p_item->i_value == CAT_VIDEO ) ||
616 ( p_item->i_value == CAT_INTERFACE ) ||
617 ( p_item->i_value == CAT_INPUT ) ||
618 ( p_item->i_value == CAT_SOUT ) ) )
626 msg_Err( p_intf, "invalid preference item found" );
629 switch( p_item->i_type )
631 case CONFIG_SUBCATEGORY:
633 case CONFIG_CATEGORY:
637 case CONFIG_HINT_END:
639 case CONFIG_HINT_USAGE:
643 VLCConfigControl *o_control = nil;
644 o_control = [VLCConfigControl newControl:p_item
646 if( o_control != nil )
648 [o_control setAutoresizingMask: NSViewMaxYMargin |
650 [o_subviews addObject: o_control];
655 } while ( ( p_item->i_type != CONFIG_HINT_END ) &&
656 ( p_item->i_type != CONFIG_SUBCATEGORY ) );
658 vlc_list_release( p_list );
667 int i_show_advanced = 0;
669 NSEnumerator *enumerator = [o_subviews objectEnumerator];
670 VLCConfigControl *o_widget;
673 while( ( o_widget = [enumerator nextObject] ) )
674 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
676 else if( i_max_label < [o_widget getLabelSize] )
677 i_max_label = [o_widget getLabelSize];
679 enumerator = [o_subviews objectEnumerator];
680 while( ( o_widget = [enumerator nextObject] ) )
683 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
689 i_widget = [o_widget getViewType];
690 i_yPos += [VLCConfigControl calcVerticalMargin:i_widget
691 lastItem:i_lastItem];
692 [o_widget setYPos:i_yPos];
693 o_frame = [o_widget frame];
694 o_frame.size.width = [o_view frame].size.width -
695 LEFTMARGIN - RIGHTMARGIN;
696 [o_widget setFrame:o_frame];
697 [o_widget alignWithXPosition: i_max_label];
698 i_yPos += [o_widget frame].size.height;
699 i_lastItem = i_widget;
700 [o_view addSubview:o_widget];
702 if( i_show_advanced != 0 )
704 /* We add the advanced notice... */
705 NSRect s_rc = [o_view frame];
706 NSTextField *o_label;
707 s_rc.size.height = 17;
708 s_rc.origin.x = LEFTMARGIN;
709 s_rc.origin.y = i_yPos += [VLCConfigControl
710 calcVerticalMargin:CONFIG_ITEM_STRING
711 lastItem:i_lastItem];
712 o_label = [[[NSTextField alloc] initWithFrame: s_rc] retain];
713 [o_label setDrawsBackground: NO];
714 [o_label setBordered: NO];
715 [o_label setEditable: NO];
716 [o_label setSelectable: NO];
717 [o_label setStringValue: _NS("Some options are hidden. " \
718 "Check \"Advanced\" to display them.")];
719 [o_label setFont:[NSFont systemFontOfSize:10]];
721 [o_view addSubview:o_label];
722 i_yPos += [o_label frame].size.height;
724 o_frame = [o_view frame];
725 o_frame.size.height = i_yPos;
726 [o_view setFrame:o_frame];
727 [o_prefs_view setDocumentView:o_view];
736 if( o_subviews != nil )
737 //Item has been shown
738 for( i = 0 ; i < [o_subviews count] ; i++ )
739 [[o_subviews objectAtIndex:i] applyChanges];
741 if( o_children != IsALeafNode )
742 for( i = 0 ; i < [o_children count] ; i++ )
743 [[o_children objectAtIndex:i] applyChanges];
749 if( o_subviews != nil )
751 //Item has been shown
752 [o_subviews release];
756 if( o_children != IsALeafNode )
757 for( i = 0 ; i < [o_children count] ; i++ )
758 [[o_children objectAtIndex:i] resetView];
764 @implementation VLCFlippedView