1 /*****************************************************************************
2 * prefs.m: MacOS X module for vlc
3 *****************************************************************************
4 * Copyright (C) 2002-2005 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., 59 Temple Place - Suite 330, Boston, MA 02111, 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];
109 - (void)setHelp: (NSString *) o_help_name
111 [o_help setStringValue: o_help_name];
116 /* load our nib (if not already loaded) */
117 [NSBundle loadNibNamed:@"Preferences" owner:self];
119 [o_prefs_window center];
120 [o_prefs_window makeKeyAndOrderFront:self];
125 [o_prefs_window setTitle: _NS("Preferences")];
126 [o_save_btn setTitle: _NS("Save")];
127 [o_cancel_btn setTitle: _NS("Cancel")];
128 [o_reset_btn setTitle: _NS("Reset All")];
129 [o_advanced_ckb setTitle: _NS("Advanced")];
132 - (IBAction)savePrefs: (id)sender
134 /* TODO: call savePrefs on Root item */
135 [[VLCTreeItem rootItem] applyChanges];
136 config_SaveConfigFile( p_intf, NULL );
137 [o_prefs_window orderOut:self];
140 - (IBAction)closePrefs: (id)sender
142 [o_prefs_window orderOut:self];
145 - (IBAction)resetAll: (id)sender
147 NSBeginInformationalAlertSheet(_NS("Reset Preferences"), _NS("Cancel"),
148 _NS("Continue"), nil, o_prefs_window, self,
149 @selector(sheetDidEnd: returnCode: contextInfo:), NULL, nil,
150 _NS("Beware this will reset your VLC media player preferences.\n"
151 "Are you sure you want to continue?") );
154 - (void)sheetDidEnd:(NSWindow *)o_sheet returnCode:(int)i_return
155 contextInfo:(void *)o_context
157 if( i_return == NSAlertAlternateReturn )
159 [o_prefs_view setDocumentView: o_empty_view];
160 config_ResetAll( p_intf );
161 [[VLCTreeItem rootItem] resetView];
162 [[o_tree itemAtRow:[o_tree selectedRow]]
163 showView:o_prefs_view advancedView:
164 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
168 - (IBAction)advancedToggle: (id)sender
170 b_advanced = !b_advanced;
171 [o_advanced_ckb setState: b_advanced];
172 /* refresh the view of the current treeitem */
173 [[o_tree itemAtRow:[o_tree selectedRow]] showView:o_prefs_view advancedView:
174 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
177 - (void)loadConfigTree
181 - (void)outlineViewSelectionIsChanging:(NSNotification *)o_notification
185 /* update the document view to the view of the selected tree item */
186 - (void)outlineViewSelectionDidChange:(NSNotification *)o_notification
188 [[o_tree itemAtRow:[o_tree selectedRow]] showView: o_prefs_view
189 advancedView:( [o_advanced_ckb state] == NSOnState ) ?
190 VLC_TRUE : VLC_FALSE];
195 @implementation VLCPrefs (NSTableDataSource)
197 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item {
198 return (item == nil) ? [[VLCTreeItem rootItem] numberOfChildren] :
199 [item numberOfChildren];
202 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
204 return (item == nil) ? YES : ( ([item numberOfChildren] != -1) &&
205 ([item numberOfChildren] != 0));
208 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item {
209 return (item == nil) ? [[VLCTreeItem rootItem] childAtIndex:index] :
210 [item childAtIndex:index];
213 - (id)outlineView:(NSOutlineView *)outlineView
214 objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
216 return (item == nil) ? @"" : (id)[item getName];
221 @implementation VLCTreeItem
223 static VLCTreeItem *o_root_item = nil;
225 #define IsALeafNode ((id)-1)
227 - (id)initWithName: (NSString *)o_item_name
228 withTitle: (NSString *)o_item_title
229 withHelp: (NSString *)o_item_help
231 parent:(VLCTreeItem *)o_parent_item
232 children:(NSMutableArray *)o_children_array
233 whithCategory: (int) i_category
239 o_name = [o_item_name copy];
240 o_title= [o_item_title copy];
241 o_help= [o_item_help copy];
243 o_parent = o_parent_item;
244 o_children = o_children_array;
245 i_object_category = i_category;
251 + (VLCTreeItem *)rootItem
253 if (o_root_item == nil)
254 o_root_item = [[VLCTreeItem alloc] initWithName:@"main" withTitle:@"main" withHelp:@"" ID:0
255 parent:nil children:[[NSMutableArray alloc] initWithCapacity:10]
262 if (o_children != IsALeafNode) [o_children release];
269 /* Creates and returns the array of children
270 * Loads children incrementally */
271 - (NSArray *)children
273 if( o_children == IsALeafNode )
275 if( [ o_children count] == 0 )
277 intf_thread_t *p_intf = VLCIntf;
279 module_t *p_module = NULL;
280 module_config_t *p_item;
283 /* List the modules */
284 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
285 if( !p_list ) return nil;
287 if( [[self getName] isEqualToString: @"main"] )
290 * Find the main module
292 for( i_index = 0; i_index < p_list->i_count; i_index++ )
294 p_module = (module_t *)p_list->p_values[i_index].p_object;
295 if( !strcmp( p_module->psz_object_name, "main" ) )
298 if( p_module == NULL )
301 "could not find the main module in our preferences" );
304 if( i_index < p_list->i_count )
306 /* We found the main module */
307 /* Enumerate config categories and store a reference so we can
308 * generate their config panel them when it is asked by the user. */
309 VLCTreeItem *p_last_category = NULL;
310 p_item = p_module->p_config;
311 o_children = [[NSMutableArray alloc] initWithCapacity:10];
314 NSString *o_child_name;
315 NSString *o_child_title;
316 NSString *o_child_help;
317 switch( p_item->i_type )
319 case CONFIG_CATEGORY:
320 o_child_name = [[VLCMain sharedInstance]
321 localizedString: config_CategoryNameGet( p_item->i_value ) ];
322 o_child_title = o_child_name;
323 o_child_help = [[VLCMain sharedInstance]
324 localizedString: config_CategoryHelpGet( p_item->i_value ) ];
325 p_last_category = [VLCTreeItem alloc];
326 [o_children addObject:[p_last_category
327 initWithName: o_child_name
328 withTitle: o_child_title
329 withHelp: o_child_help
332 children:[[NSMutableArray alloc]
334 whithCategory: p_item - p_module->p_config]];
336 case CONFIG_SUBCATEGORY:
337 o_child_name = [[VLCMain sharedInstance]
338 localizedString: config_CategoryNameGet( p_item->i_value ) ];
339 o_child_title = o_child_name;
340 o_child_help = [[VLCMain sharedInstance]
341 localizedString: config_CategoryHelpGet( p_item->i_value ) ];
342 if( p_item->i_value != SUBCAT_PLAYLIST_GENERAL &&
343 p_item->i_value != SUBCAT_VIDEO_GENERAL &&
344 p_item->i_value != SUBCAT_AUDIO_GENERAL )
345 [p_last_category->o_children
346 addObject:[[VLCTreeItem alloc]
347 initWithName: o_child_name
348 withTitle: o_child_title
349 withHelp: o_child_help
351 parent:p_last_category
352 children:[[NSMutableArray alloc]
354 whithCategory: p_item - p_module->p_config]];
359 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
362 /* Build a tree of the plugins */
363 /* Add the capabilities */
364 for( i_index = 0; i_index < p_list->i_count; i_index++ )
366 p_module = (module_t *)p_list->p_values[i_index].p_object;
368 /* Exclude the main module */
369 if( !strcmp( p_module->psz_object_name, "main" ) )
372 /* Exclude empty plugins (submodules don't have config */
373 /* options, they are stored in the parent module) */
374 if( p_module->b_submodule )
377 p_item = p_module->p_config;
379 if( !p_item ) continue;
381 int i_subcategory = -1;
385 if( p_item->i_type == CONFIG_CATEGORY )
386 i_category = p_item->i_value;
387 else if( p_item->i_type == CONFIG_SUBCATEGORY )
388 i_subcategory = p_item->i_value;
390 if( p_item->i_type & CONFIG_ITEM )
392 if( i_options > 0 && i_category >= 0 && i_subcategory >= 0 )
394 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
395 if( !i_options ) continue;
397 /* Find the right category item */
400 vlc_bool_t b_found = VLC_FALSE;
402 VLCTreeItem* p_category_item, * p_subcategory_item;
403 for (i = 0 ; i < [o_children count] ; i++)
405 p_category_item = [o_children objectAtIndex: i];
406 if( p_category_item->i_object_id == i_category )
412 if( !b_found ) continue;
414 /* Find subcategory item */
417 for (i = 0 ; i < [p_category_item->o_children count] ; i++)
419 p_subcategory_item = [p_category_item->o_children
421 if( p_subcategory_item->i_object_id == i_subcategory )
428 p_subcategory_item = p_category_item;
430 [p_subcategory_item->o_children addObject:[[VLCTreeItem alloc]
431 initWithName:[[VLCMain sharedInstance]
432 localizedString: p_module->psz_shortname ?
433 p_module->psz_shortname : p_module->psz_object_name ]
434 withTitle:[[VLCMain sharedInstance]
435 localizedString: p_module->psz_longname ?
436 p_module->psz_longname : p_module->psz_object_name ]
438 ID: p_module->i_object_id
439 parent:p_subcategory_item
444 vlc_list_release( p_list );
454 - (NSString *)getName
459 - (NSString *)getTitle
464 - (NSString *)getHelp
469 - (VLCTreeItem *)childAtIndex:(int)i_index
471 return [[self children] objectAtIndex:i_index];
474 - (int)numberOfChildren {
475 id i_tmp = [self children];
476 return (i_tmp == IsALeafNode) ? (-1) : (int)[i_tmp count];
479 - (BOOL)hasPrefs:(NSString *)o_module_name
481 intf_thread_t *p_intf = VLCIntf;
484 char *psz_module_name;
487 psz_module_name = (char *)[o_module_name UTF8String];
489 /* look for module */
490 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
492 for( i_index = 0; i_index < p_list->i_count; i_index++ )
494 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
496 if( !strcmp( p_parser->psz_object_name, psz_module_name ) )
498 BOOL b_has_prefs = p_parser->i_config_items != 0;
499 vlc_list_release( p_list );
500 return( b_has_prefs );
504 vlc_list_release( p_list );
509 - (NSView *)showView:(NSScrollView *)o_prefs_view
510 advancedView:(vlc_bool_t) b_advanced
515 [[VLCPrefs sharedInstance] setTitle: [self getTitle]];
516 [[VLCPrefs sharedInstance] setHelp: [self getHelp]];
517 /* NSLog( [self getHelp] ); */
518 s_vrc = [[o_prefs_view contentView] bounds]; s_vrc.size.height -= 4;
519 o_view = [[VLCFlippedView alloc] initWithFrame: s_vrc];
520 [o_view setAutoresizingMask: NSViewWidthSizable | NSViewMinYMargin |
523 /* Create all subviews if it isn't already done because we cannot use */
524 /* setHiden for MacOS < 10.3*/
525 if( o_subviews == nil )
527 intf_thread_t *p_intf = VLCIntf;
529 module_t *p_parser = NULL;
530 module_config_t *p_item;
532 o_subviews = [[NSMutableArray alloc] initWithCapacity:10];
533 /* Get a pointer to the module */
534 if( i_object_category == -1 )
536 p_parser = (module_t *) vlc_object_get( p_intf, i_object_id );
537 if( !p_parser || p_parser->i_object_type != VLC_OBJECT_MODULE )
539 /* 0OOoo something went really bad */
542 p_item = p_parser->p_config;
545 p_item = p_parser->p_config + 1;
551 msg_Err( p_intf, "null item found" );
554 switch(p_item->i_type)
556 case CONFIG_SUBCATEGORY:
558 case CONFIG_CATEGORY:
562 case CONFIG_HINT_END:
564 case CONFIG_HINT_USAGE:
568 VLCConfigControl *o_control = nil;
569 o_control = [VLCConfigControl newControl:p_item
571 if( o_control != nil )
573 [o_control setAutoresizingMask: NSViewMaxYMargin |
575 [o_subviews addObject: o_control];
580 } while( p_item++->i_type != CONFIG_HINT_END );
582 vlc_object_release( p_parser );
588 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
589 if( !p_list ) return o_view;
592 * Find the main module
594 for( i_index = 0; i_index < p_list->i_count; i_index++ )
596 p_parser = (module_t *)p_list->p_values[i_index].p_object;
597 if( !strcmp( p_parser->psz_object_name, "main" ) )
600 if( p_parser == NULL )
602 msg_Err( p_intf, "could not find the main module in our "
606 p_item = (p_parser->p_config + i_object_category);
607 if( ( p_item->i_type == CONFIG_CATEGORY ) &&
608 ( ( p_item->i_value == CAT_PLAYLIST ) ||
609 ( p_item->i_value == CAT_AUDIO ) ||
610 ( p_item->i_value == CAT_VIDEO ) ) )
618 msg_Err( p_intf, "null item found" );
621 switch( p_item->i_type )
623 case CONFIG_SUBCATEGORY:
625 case CONFIG_CATEGORY:
629 case CONFIG_HINT_END:
631 case CONFIG_HINT_USAGE:
635 VLCConfigControl *o_control = nil;
636 o_control = [VLCConfigControl newControl:p_item
638 if( o_control != nil )
640 [o_control setAutoresizingMask: NSViewMaxYMargin |
642 [o_subviews addObject: o_control];
647 } while ( ( p_item->i_type != CONFIG_HINT_END ) &&
648 ( p_item->i_type != CONFIG_SUBCATEGORY ) );
650 vlc_list_release( p_list );
659 int i_show_advanced = 0;
661 NSEnumerator *enumerator = [o_subviews objectEnumerator];
662 VLCConfigControl *o_widget;
665 while( ( o_widget = [enumerator nextObject] ) )
666 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
668 else if( i_max_label < [o_widget getLabelSize] )
669 i_max_label = [o_widget getLabelSize];
671 enumerator = [o_subviews objectEnumerator];
672 while( ( o_widget = [enumerator nextObject] ) )
675 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
681 i_widget = [o_widget getViewType];
682 i_yPos += [VLCConfigControl calcVerticalMargin:i_widget
683 lastItem:i_lastItem];
684 [o_widget setYPos:i_yPos];
685 o_frame = [o_widget frame];
686 o_frame.size.width = [o_view frame].size.width -
687 LEFTMARGIN - RIGHTMARGIN;
688 [o_widget setFrame:o_frame];
689 [o_widget alignWithXPosition: i_max_label];
690 i_yPos += [o_widget frame].size.height;
691 i_lastItem = i_widget;
692 [o_view addSubview:o_widget];
694 if( i_show_advanced != 0 )
696 /* We add the advanced notice... */
697 NSRect s_rc = [o_view frame];
698 NSTextField *o_label;
699 s_rc.size.height = 17;
700 s_rc.origin.x = LEFTMARGIN;
701 s_rc.origin.y = i_yPos += [VLCConfigControl
702 calcVerticalMargin:CONFIG_ITEM_STRING
703 lastItem:i_lastItem];
704 o_label = [[[NSTextField alloc] initWithFrame: s_rc] retain];
705 [o_label setDrawsBackground: NO];
706 [o_label setBordered: NO];
707 [o_label setEditable: NO];
708 [o_label setSelectable: NO];
709 [o_label setStringValue: _NS("Some options are available but " \
710 "hidden. Check \"Advanced\" to see them.")];
711 [o_label setFont:[NSFont systemFontOfSize:10]];
713 [o_view addSubview:o_label];
714 i_yPos += [o_label frame].size.height;
716 o_frame = [o_view frame];
717 o_frame.size.height = i_yPos;
718 [o_view setFrame:o_frame];
719 [o_prefs_view setDocumentView:o_view];
728 if( o_subviews != nil )
729 //Item has been shown
730 for( i = 0 ; i < [o_subviews count] ; i++ )
731 [[o_subviews objectAtIndex:i] applyChanges];
733 if( o_children != IsALeafNode )
734 for( i = 0 ; i < [o_children count] ; i++ )
735 [[o_children objectAtIndex:i] applyChanges];
741 if( o_subviews != nil )
743 //Item has been shown
744 [o_subviews release];
748 if( o_children != IsALeafNode )
749 for( i = 0 ; i < [o_children count] ; i++ )
750 [[o_children objectAtIndex:i] resetView];
756 @implementation VLCFlippedView