1 /*****************************************************************************
2 * prefs.m: MacOS X module for vlc
3 *****************************************************************************
4 * Copyright (C) 2002-2005 VideoLAN
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];
106 /* load our nib (if not already loaded) */
107 [NSBundle loadNibNamed:@"Preferences" owner:self];
109 [o_prefs_window center];
110 [o_prefs_window makeKeyAndOrderFront:self];
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")];
122 - (IBAction)savePrefs: (id)sender
124 /* TODO: call savePrefs on Root item */
125 [[VLCTreeItem rootItem] applyChanges];
126 config_SaveConfigFile( p_intf, NULL );
127 [o_prefs_window orderOut:self];
130 - (IBAction)closePrefs: (id)sender
132 [o_prefs_window orderOut:self];
135 - (IBAction)resetAll: (id)sender
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?") );
144 - (void)sheetDidEnd:(NSWindow *)o_sheet returnCode:(int)i_return
145 contextInfo:(void *)o_context
147 if( i_return == NSAlertAlternateReturn )
149 config_ResetAll( p_intf );
150 [[o_tree itemAtRow:[o_tree selectedRow]]
151 showView:o_prefs_view advancedView:
152 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
156 - (IBAction)advancedToggle: (id)sender
158 b_advanced = !b_advanced;
159 [o_advanced_ckb setState: b_advanced];
160 /* refresh the view of the current treeitem */
161 [[o_tree itemAtRow:[o_tree selectedRow]] showView:o_prefs_view advancedView:
162 ( [o_advanced_ckb state] == NSOnState ) ? VLC_TRUE : VLC_FALSE];
165 - (void)loadConfigTree
169 - (void)outlineViewSelectionIsChanging:(NSNotification *)o_notification
173 /* update the document view to the view of the selected tree item */
174 - (void)outlineViewSelectionDidChange:(NSNotification *)o_notification
176 [[o_tree itemAtRow:[o_tree selectedRow]] showView: o_prefs_view
177 advancedView:( [o_advanced_ckb state] == NSOnState ) ?
178 VLC_TRUE : VLC_FALSE];
183 @implementation VLCPrefs (NSTableDataSource)
185 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item {
186 return (item == nil) ? [[VLCTreeItem rootItem] numberOfChildren] :
187 [item numberOfChildren];
190 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
192 return (item == nil) ? YES : ( ([item numberOfChildren] != -1) &&
193 ([item numberOfChildren] != 0));
196 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item {
197 return (item == nil) ? [[VLCTreeItem rootItem] childAtIndex:index] :
198 [item childAtIndex:index];
201 - (id)outlineView:(NSOutlineView *)outlineView
202 objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
204 return (item == nil) ? @"" : (id)[item getName];
209 @implementation VLCTreeItem
211 static VLCTreeItem *o_root_item = nil;
213 #define IsALeafNode ((id)-1)
215 - (id)initWithName: (NSString *)o_item_name ID: (int)i_id
216 parent:(VLCTreeItem *)o_parent_item
217 children:(NSMutableArray *)o_children_array
218 whithCategory: (int) i_category
224 o_name = [o_item_name copy];
226 o_parent = o_parent_item;
227 o_children = o_children_array;
228 i_object_category = i_category;
234 + (VLCTreeItem *)rootItem
236 if (o_root_item == nil)
237 o_root_item = [[VLCTreeItem alloc] initWithName:@"main" ID:0
238 parent:nil children:[[NSMutableArray alloc] initWithCapacity:10]
245 if (o_children != IsALeafNode) [o_children release];
250 /* Creates and returns the array of children
251 * Loads children incrementally */
252 - (NSArray *)children
254 if( o_children == IsALeafNode )
256 if( [ o_children count] == 0 )
258 intf_thread_t *p_intf = VLCIntf;
260 module_t *p_module = NULL;
261 module_config_t *p_item;
264 /* List the modules */
265 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
266 if( !p_list ) return nil;
268 if( [[self getName] isEqualToString: @"main"] )
271 * Find the main module
273 for( i_index = 0; i_index < p_list->i_count; i_index++ )
275 p_module = (module_t *)p_list->p_values[i_index].p_object;
276 if( !strcmp( p_module->psz_object_name, "main" ) )
279 if( p_module == NULL )
282 "could not find the main module in our preferences" );
285 if( i_index < p_list->i_count )
287 /* We found the main module */
288 /* Enumerate config categories and store a reference so we can
289 * generate their config panel them when it is asked by the user. */
290 VLCTreeItem *p_last_category = NULL;
291 p_item = p_module->p_config;
292 o_children = [[NSMutableArray alloc] initWithCapacity:10];
295 NSString *o_child_name;
296 switch( p_item->i_type )
298 case CONFIG_CATEGORY:
299 o_child_name = [[VLCMain sharedInstance]
300 localizedString: config_CategoryNameGet(p_item->i_value ) ];
301 p_last_category = [VLCTreeItem alloc];
302 [o_children addObject:[p_last_category
303 initWithName: o_child_name
306 children:[[NSMutableArray alloc]
308 whithCategory: p_item - p_module->p_config]];
310 case CONFIG_SUBCATEGORY:
311 o_child_name = [[VLCMain sharedInstance]
312 localizedString: config_CategoryNameGet(p_item->i_value ) ];
313 if( p_item->i_value != SUBCAT_VIDEO_GENERAL &&
314 p_item->i_value != SUBCAT_AUDIO_GENERAL )
315 [p_last_category->o_children
316 addObject:[[VLCTreeItem alloc]
317 initWithName: o_child_name
319 parent:p_last_category
320 children:[[NSMutableArray alloc]
322 whithCategory: p_item - p_module->p_config]];
327 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
330 /* Build a tree of the plugins */
331 /* Add the capabilities */
332 for( i_index = 0; i_index < p_list->i_count; i_index++ )
334 p_module = (module_t *)p_list->p_values[i_index].p_object;
336 /* Exclude the main module */
337 if( !strcmp( p_module->psz_object_name, "main" ) )
340 /* Exclude empty plugins (submodules don't have config */
341 /* options, they are stored in the parent module) */
342 if( p_module->b_submodule )
345 p_item = p_module->p_config;
347 if( !p_item ) continue;
349 int i_subcategory = -1;
353 if( p_item->i_type == CONFIG_CATEGORY )
354 i_category = p_item->i_value;
355 else if( p_item->i_type == CONFIG_SUBCATEGORY )
356 i_subcategory = p_item->i_value;
358 if( p_item->i_type & CONFIG_ITEM )
360 if( i_options > 0 && i_category >= 0 && i_subcategory >= 0 )
362 } while( p_item->i_type != CONFIG_HINT_END && p_item++ );
363 if( !i_options ) continue;
365 /* Find the right category item */
368 vlc_bool_t b_found = VLC_FALSE;
370 VLCTreeItem* p_category_item, * p_subcategory_item;
371 for (i = 0 ; i < [o_children count] ; i++)
373 p_category_item = [o_children objectAtIndex: i];
374 if( p_category_item->i_object_id == i_category )
380 if( !b_found ) continue;
382 /* Find subcategory item */
385 for (i = 0 ; i < [p_category_item->o_children count] ; i++)
387 p_subcategory_item = [p_category_item->o_children
389 if( p_subcategory_item->i_object_id == i_subcategory )
396 p_subcategory_item = p_category_item;
398 [p_subcategory_item->o_children addObject:[[VLCTreeItem alloc]
399 initWithName:[[VLCMain sharedInstance]
400 localizedString: p_module->psz_object_name ]
401 ID: p_module->i_object_id
402 parent:p_subcategory_item
407 vlc_list_release( p_list );
417 - (NSString *)getName
422 - (VLCTreeItem *)childAtIndex:(int)i_index
424 return [[self children] objectAtIndex:i_index];
427 - (int)numberOfChildren {
428 id i_tmp = [self children];
429 return (i_tmp == IsALeafNode) ? (-1) : (int)[i_tmp count];
432 - (BOOL)hasPrefs:(NSString *)o_module_name
434 intf_thread_t *p_intf = VLCIntf;
437 char *psz_module_name;
440 psz_module_name = (char *)[o_module_name UTF8String];
442 /* look for module */
443 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
445 for( i_index = 0; i_index < p_list->i_count; i_index++ )
447 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
449 if( !strcmp( p_parser->psz_object_name, psz_module_name ) )
451 BOOL b_has_prefs = p_parser->i_config_items != 0;
452 vlc_list_release( p_list );
453 return( b_has_prefs );
457 vlc_list_release( p_list );
462 - (NSView *)showView:(NSScrollView *)o_prefs_view
463 advancedView:(vlc_bool_t) b_advanced
465 fprintf( stderr, "[%s] showView\n", [o_name UTF8String] );
469 s_vrc = [[o_prefs_view contentView] bounds]; s_vrc.size.height -= 4;
470 o_view = [[VLCFlippedView alloc] initWithFrame: s_vrc];
471 [o_view setAutoresizingMask: NSViewWidthSizable | NSViewMinYMargin |
474 /* Create all subviews if it isn't already done because we cannot use */
475 /* setHiden for MacOS < 10.3*/
476 if( o_subviews == nil )
478 intf_thread_t *p_intf = VLCIntf;
480 module_t *p_parser = NULL;
481 module_config_t *p_item;
483 o_subviews = [[NSMutableArray alloc] initWithCapacity:10];
484 /* Get a pointer to the module */
485 if( i_object_category == -1 )
487 p_parser = (module_t *) vlc_object_get( p_intf, i_object_id );
488 if( !p_parser || p_parser->i_object_type != VLC_OBJECT_MODULE )
490 /* 0OOoo something went really bad */
493 p_item = p_parser->p_config;
496 p_item = p_parser->p_config + 1;
502 msg_Err( p_intf, "null item found" );
505 switch(p_item->i_type)
507 case CONFIG_SUBCATEGORY:
508 fprintf( stderr, "drawing subcategory %s\n", [o_name UTF8String] );
511 fprintf( stderr, "drawing section %s\n", p_item->psz_text );
513 case CONFIG_CATEGORY:
514 fprintf( stderr, "drawing category %s\n", [o_name UTF8String] );
516 case CONFIG_HINT_END:
517 fprintf( stderr, "end of (sub)category\n" );
519 case CONFIG_HINT_USAGE:
520 fprintf( stderr, "skipping hint usage\n" );
523 fprintf( stderr, "%s (%d)", p_item->psz_name, p_item->i_type );
525 VLCConfigControl *o_control = nil;
526 o_control = [VLCConfigControl newControl:p_item
528 if( o_control != nil )
530 [o_control setAutoresizingMask: NSViewMaxYMargin |
532 [o_subviews addObject: o_control];
534 fprintf( stderr, "\n" );
538 } while( p_item++->i_type != CONFIG_HINT_END );
540 vlc_object_release( p_parser );
546 p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE );
547 if( !p_list ) return o_view;
550 * Find the main module
552 for( i_index = 0; i_index < p_list->i_count; i_index++ )
554 p_parser = (module_t *)p_list->p_values[i_index].p_object;
555 if( !strcmp( p_parser->psz_object_name, "main" ) )
558 if( p_parser == NULL )
560 msg_Err( p_intf, "could not find the main module in our "
564 p_item = (p_parser->p_config + i_object_category);
565 if( ( p_item->i_type == CONFIG_CATEGORY ) &&
566 ( ( p_item->i_value == CAT_AUDIO ) ||
567 ( p_item->i_value == CAT_VIDEO ) ) )
575 msg_Err( p_intf, "null item found" );
578 switch(p_item->i_type)
580 case CONFIG_SUBCATEGORY:
581 fprintf( stderr, "drawing subcategory %s\n", [o_name UTF8String] );
584 fprintf( stderr, "drawing section %s\n", p_item->psz_text );
586 case CONFIG_CATEGORY:
587 fprintf( stderr, "drawing category %s\n", [o_name UTF8String] );
589 case CONFIG_HINT_END:
590 fprintf( stderr, "end of (sub)category\n" );
592 case CONFIG_HINT_USAGE:
593 fprintf( stderr, "skipping hint usage\n" );
596 fprintf( stderr, "%s (%d)", p_item->psz_name, p_item->i_type );
598 VLCConfigControl *o_control = nil;
599 o_control = [VLCConfigControl newControl:p_item
601 if( o_control != nil )
603 [o_control setAutoresizingMask: NSViewMaxYMargin |
605 [o_subviews addObject: o_control];
610 } while ( ( p_item->i_type != CONFIG_HINT_END ) &&
611 ( p_item->i_type != CONFIG_SUBCATEGORY ) );
613 vlc_list_release( p_list );
622 NSEnumerator *enumerator = [o_subviews objectEnumerator];
623 VLCConfigControl *o_widget;
626 while( ( o_widget = [enumerator nextObject] ) )
627 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
629 else if( i_max_label < [o_widget getLabelSize] )
630 i_max_label = [o_widget getLabelSize];
632 enumerator = [o_subviews objectEnumerator];
633 while( ( o_widget = [enumerator nextObject] ) )
636 if( ( [o_widget isAdvanced] ) && (! b_advanced) )
639 i_widget = [o_widget getViewType];
640 i_yPos += [VLCConfigControl calcVerticalMargin:i_widget
641 lastItem:i_lastItem];
642 [o_widget setYPos:i_yPos];
643 o_frame = [o_widget frame];
644 o_frame.size.width = [o_view frame].size.width -
645 LEFTMARGIN - RIGHTMARGIN;
646 [o_widget setFrame:o_frame];
647 [o_widget alignWithXPosition: i_max_label];
648 i_yPos += [o_widget frame].size.height;
649 i_lastItem = i_widget;
650 [o_view addSubview:o_widget];
652 o_frame = [o_view frame];
653 o_frame.size.height = i_yPos;
654 [o_view setFrame:o_frame];
655 [o_prefs_view setDocumentView:o_view];
664 if( o_subviews != nil )
665 //Item has been shown
666 for( i = 0 ; i < [o_subviews count] ; i++ )
667 [[o_subviews objectAtIndex:i] applyChanges];
669 if( o_children != IsALeafNode )
670 for( i = 0 ; i < [o_children count] ; i++ )
671 [[o_children objectAtIndex:i] applyChanges];
677 @implementation VLCFlippedView