1 /*****************************************************************************
2 * prefs.m: MacOS X module for vlc
3 *****************************************************************************
4 * Copyright (C) 2002-2012 VLC authors and VideoLAN
7 * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8 * Derk-Jan Hartman <hartman at videolan dot org>
9 * Felix Paul Kühne <fkuehne at videolan dot org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /* VLCPrefs manages the main preferences dialog
27 the class is related to wxwindows intf, PrefsPanel */
28 /* VLCTreeItem should contain:
29 - the children of the treeitem
30 - the associated prefs widgets
31 - the documentview with all the prefs widgets in it
32 - a saveChanges action
33 - a revertChanges action
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 */
53 #include <vlc_common.h>
54 #include <vlc_config_cat.h>
56 #import "CompatibilityFixes.h"
59 #import "simple_prefs.h"
60 #import "prefs_widgets.h"
61 #import "CoreInteraction.h"
63 #import <vlc_modules.h>
64 #import <vlc_plugin.h>
66 /* /!\ Warning: Unreadable code :/ */
68 @interface VLCTreeItem : NSObject
71 NSMutableArray *_children;
72 NSMutableArray *_options;
73 NSMutableArray *_subviews;
76 - (id)initWithName:(NSString*)name;
78 - (int)numberOfChildren;
79 - (VLCTreeItem *)childAtIndex:(NSInteger)i_index;
82 - (NSMutableArray *)children;
83 - (NSMutableArray *)options;
84 - (void)showView:(NSScrollView *)o_prefs_view;
91 @interface VLCTreeSubCategoryItem : VLCTreeItem
95 + (VLCTreeSubCategoryItem *)subCategoryTreeItemWithSubCategory:(int)subCategory;
96 - (id)initWithSubCategory:(int)subCategory;
100 /* Plugin daughters */
101 @interface VLCTreePluginItem : VLCTreeItem
103 module_config_t * _configItems;
104 unsigned int _configSize;
106 + (VLCTreePluginItem *)pluginTreeItemWithPlugin:(module_t *)plugin;
107 - (id)initWithPlugin:(module_t *)plugin;
109 - (module_config_t *)configItems;
110 - (unsigned int)configSize;
114 @interface VLCTreeCategoryItem : VLCTreeItem
118 + (VLCTreeCategoryItem *)categoryTreeItemWithCategory:(int)category;
119 - (id)initWithCategory:(int)category;
122 - (VLCTreeSubCategoryItem *)itemRepresentingSubCategory:(int)category;
125 /* individual options. */
126 @interface VLCTreeLeafItem : VLCTreeItem
128 module_config_t * _configItem;
130 - (id)initWithConfigItem:(module_config_t *)configItem;
132 - (module_config_t *)configItem;
135 @interface VLCTreeMainItem : VLCTreePluginItem
138 - (VLCTreeCategoryItem *)itemRepresentingCategory:(int)category;
143 /*****************************************************************************
144 * VLCPrefs implementation
145 *****************************************************************************/
146 @implementation VLCPrefs
148 static VLCPrefs *_o_sharedMainInstance = nil;
150 + (VLCPrefs *)sharedInstance
152 return _o_sharedMainInstance ? _o_sharedMainInstance : [[self alloc] init];
157 if( _o_sharedMainInstance ) {
162 _o_sharedMainInstance = [super init];
164 o_empty_view = [[NSView alloc] init];
165 _rootTreeItem = [[VLCTreeMainItem alloc] init];
168 return _o_sharedMainInstance;
173 [o_empty_view release];
174 [_rootTreeItem release];
183 [o_prefs_window setCollectionBehavior: NSWindowCollectionBehaviorFullScreenAuxiliary];
186 [o_prefs_view setBorderType: NSGrooveBorder];
187 [o_prefs_view setHasVerticalScroller: YES];
188 [o_prefs_view setDrawsBackground: NO];
189 [o_prefs_view setDocumentView: o_empty_view];
190 [o_tree selectRowIndexes: [NSIndexSet indexSetWithIndex: 0] byExtendingSelection: NO];
193 - (void)setTitle: (NSString *) o_title_name
195 [o_title setStringValue: o_title_name];
198 - (void)showPrefsWithLevel:(NSInteger)i_window_level
200 [o_prefs_window setLevel: i_window_level];
201 [o_prefs_window center];
202 [o_prefs_window makeKeyAndOrderFront:self];
203 [_rootTreeItem resetView];
208 [o_prefs_window setTitle: _NS("Preferences")];
209 [o_save_btn setTitle: _NS("Save")];
210 [o_cancel_btn setTitle: _NS("Cancel")];
211 [o_reset_btn setTitle: _NS("Reset All")];
212 [o_showBasic_btn setTitle: _NS("Show Basic")];
215 - (IBAction)savePrefs: (id)sender
217 /* TODO: call savePrefs on Root item */
218 [_rootTreeItem applyChanges];
219 [[VLCCoreInteraction sharedInstance] fixPreferences];
220 config_SaveConfigFile( p_intf );
221 [o_prefs_window orderOut:self];
224 - (IBAction)closePrefs: (id)sender
226 [o_prefs_window orderOut:self];
229 - (IBAction)resetAll: (id)sender
231 NSBeginInformationalAlertSheet(_NS("Reset Preferences"), _NS("Cancel"),
232 _NS("Continue"), nil, o_prefs_window, self,
233 @selector(sheetDidEnd: returnCode: contextInfo:), NULL, nil,
234 _NS("Beware this will reset the VLC media player preferences.\n"
235 "Are you sure you want to continue?") );
238 - (void)sheetDidEnd:(NSWindow *)o_sheet returnCode:(int)i_return
239 contextInfo:(void *)o_context
241 if( i_return == NSAlertAlternateReturn )
243 config_ResetAll( p_intf );
244 [_rootTreeItem resetView];
248 - (IBAction)buttonAction: (id)sender
250 [o_prefs_window orderOut: self];
251 [[[VLCMain sharedInstance] simplePreferences] showSimplePrefs];
254 - (void)loadConfigTree
258 - (void)outlineViewSelectionIsChanging:(NSNotification *)o_notification
262 /* update the document view to the view of the selected tree item */
263 - (void)outlineViewSelectionDidChange:(NSNotification *)o_notification
265 [[o_tree itemAtRow:[o_tree selectedRow]] showView: o_prefs_view];
266 [o_tree expandItem:[o_tree itemAtRow:[o_tree selectedRow]]];
271 @implementation VLCPrefs (NSTableDataSource)
273 - (NSInteger)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item
275 return (item == nil) ? [_rootTreeItem numberOfChildren] : [item numberOfChildren];
278 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
280 return (item == nil) ? [_rootTreeItem numberOfChildren] : [item numberOfChildren];
283 - (id)outlineView:(NSOutlineView *)outlineView child:(NSInteger)index ofItem:(id)item
285 return (item == nil) ? (id)[_rootTreeItem childAtIndex:index]: (id)[item childAtIndex:index];
288 - (id)outlineView:(NSOutlineView *)outlineView
289 objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
291 return (item == nil) ? @"" : [item name];
297 @implementation VLCTreeMainItem
299 - (VLCTreeCategoryItem *)itemRepresentingCategory:(int)category
301 NSUInteger childrenCount = [[self children] count];
302 for( int i = 0; i < childrenCount; i++ )
304 VLCTreeCategoryItem * categoryItem = [[self children] objectAtIndex:i];
305 if( [categoryItem category] == category )
311 - (bool)isSubCategoryGeneral:(int)category
313 if(category == SUBCAT_VIDEO_GENERAL ||
314 category == SUBCAT_ADVANCED_MISC ||
315 category == SUBCAT_INPUT_GENERAL ||
316 category == SUBCAT_INTERFACE_GENERAL ||
317 category == SUBCAT_SOUT_GENERAL||
318 category == SUBCAT_PLAYLIST_GENERAL||
319 category == SUBCAT_AUDIO_GENERAL )
326 /* Creates and returns the array of children
327 * Loads children incrementally */
328 - (NSMutableArray *)children
330 if( _children ) return _children;
331 _children = [[NSMutableArray alloc] init];
333 intf_thread_t *p_intf = VLCIntf;
335 /* List the modules */
337 module_t ** modules = module_list_get( &count );
338 if( !modules ) return nil;
340 /* Build a tree of the plugins */
341 /* Add the capabilities */
342 for( i = 0; i < count; i++ )
344 VLCTreeCategoryItem * categoryItem = nil;
345 VLCTreeSubCategoryItem * subCategoryItem = nil;
346 VLCTreePluginItem * pluginItem = nil;
347 module_config_t *p_configs = NULL;
349 unsigned int confsize;
351 module_t * p_module = modules[i];
353 /* Exclude empty plugins (submodules don't have config */
354 /* options, they are stored in the parent module) */
355 if( module_is_main( p_module ) ) {
357 _configItems = module_config_get( p_module, &confsize );
358 _configSize = confsize;
360 pluginItem = [VLCTreePluginItem pluginTreeItemWithPlugin: p_module];
361 confsize = [pluginItem configSize];
363 p_configs = [pluginItem configItems];
366 for( j = 0; j < confsize; j++ )
368 int configType = p_configs[j].i_type;
369 if( configType == CONFIG_CATEGORY )
371 categoryItem = [self itemRepresentingCategory:p_configs[j].value.i];
374 categoryItem = [VLCTreeCategoryItem categoryTreeItemWithCategory:p_configs[j].value.i];
375 if(categoryItem) [[self children] addObject:categoryItem];
378 else if( configType == CONFIG_SUBCATEGORY )
380 lastsubcat = p_configs[j].value.i;
381 if( categoryItem && ![self isSubCategoryGeneral:lastsubcat] )
383 subCategoryItem = [categoryItem itemRepresentingSubCategory:lastsubcat];
386 subCategoryItem = [VLCTreeSubCategoryItem subCategoryTreeItemWithSubCategory:lastsubcat];
387 if(subCategoryItem) [[categoryItem children] addObject:subCategoryItem];
392 if( module_is_main( p_module) && CONFIG_ITEM(configType) )
394 if( categoryItem && [self isSubCategoryGeneral:lastsubcat] )
396 [[categoryItem options] addObject:[[VLCTreeLeafItem alloc] initWithConfigItem:&p_configs[j]]];
398 else if( subCategoryItem )
400 [[subCategoryItem options] addObject:[[VLCTreeLeafItem alloc] initWithConfigItem:&p_configs[j]]];
403 else if( !module_is_main( p_module) && CONFIG_ITEM(configType))
405 if( ![[subCategoryItem children] containsObject: pluginItem] )
407 [[subCategoryItem children] addObject:pluginItem];
410 [[pluginItem options] addObject:[[VLCTreeLeafItem alloc] initWithConfigItem:&p_configs[j]]];
414 module_list_free( modules );
420 @implementation VLCTreeCategoryItem
421 + (VLCTreeCategoryItem *)categoryTreeItemWithCategory:(int)category
423 if(!config_CategoryNameGet( category )) return nil;
424 return [[[[self class] alloc] initWithCategory:category] autorelease];
426 - (id)initWithCategory:(int)category
428 NSString * name = _NS(config_CategoryNameGet( category ));
429 if(self = [super initWithName:name])
431 _category = category;
432 //_help = [_NS(config_CategoryHelpGet( category )) retain];
437 - (VLCTreeSubCategoryItem *)itemRepresentingSubCategory:(int)subCategory
439 assert( [self isKindOfClass:[VLCTreeCategoryItem class]] );
440 NSUInteger childrenCount = [[self children] count];
441 for( NSUInteger i = 0; i < childrenCount; i++ )
443 VLCTreeSubCategoryItem * subCategoryItem = [[self children] objectAtIndex:i];
444 if( [subCategoryItem subCategory] == subCategory )
445 return subCategoryItem;
457 @implementation VLCTreeSubCategoryItem
458 - (id)initWithSubCategory:(int)subCategory
460 NSString * name = _NS(config_CategoryNameGet( subCategory ));
461 if(self = [super initWithName:name])
463 _subCategory = subCategory;
464 //_help = [_NS(config_CategoryHelpGet( subCategory )) retain];
469 + (VLCTreeSubCategoryItem *)subCategoryTreeItemWithSubCategory:(int)subCategory
471 if(!config_CategoryNameGet( subCategory )) return nil;
472 return [[[[self class] alloc] initWithSubCategory:subCategory] autorelease];
483 @implementation VLCTreePluginItem
484 - (id)initWithPlugin:(module_t *)plugin
486 NSString * name = _NS( module_get_name( plugin, false )?:"" );
487 if(self = [super initWithName:name])
489 _configItems = module_config_get( plugin, &_configSize );
491 //_help = [_NS(config_CategoryHelpGet( subCategory )) retain];
496 + (VLCTreePluginItem *)pluginTreeItemWithPlugin:(module_t *)plugin
498 return [[[[self class] alloc] initWithPlugin:plugin] autorelease];
503 module_config_free( _configItems );
507 - (module_config_t *)configItems
512 - (unsigned int)configSize
520 @implementation VLCTreeLeafItem
522 - (id)initWithConfigItem: (module_config_t *) configItem
524 NSString * name = _NS(configItem->psz_name);
525 self = [super initWithName:name];
529 _configItem = configItem;
534 - (module_config_t *)configItem
541 #pragma mark (Root class for all TreeItems)
542 @implementation VLCTreeItem
544 - (id)initWithName:(NSString*)name
549 _name = [name retain];
563 - (VLCTreeItem *)childAtIndex:(NSInteger)i_index
565 return [[self children] objectAtIndex:i_index];
568 - (int)numberOfChildren
570 return [[self children] count];
575 return [[_name retain] autorelease];
578 - (void)showView:(NSScrollView *)prefsView
583 [[VLCPrefs sharedInstance] setTitle: [self name]];
584 s_vrc = [[prefsView contentView] bounds]; s_vrc.size.height -= 4;
585 view = [[VLCFlippedView alloc] initWithFrame: s_vrc];
586 [view setAutoresizingMask: NSViewWidthSizable | NSViewMinYMargin | NSViewMaxYMargin];
590 _subviews = [[NSMutableArray alloc] initWithCapacity:10];
592 NSUInteger count = [[self options] count];
593 for( NSUInteger i = 0; i < count; i++)
595 VLCTreeLeafItem * item = [[self options] objectAtIndex:i];
597 VLCConfigControl *control;
598 control = [VLCConfigControl newControl:[item configItem] withView:view];
601 [control setAutoresizingMask: NSViewMaxYMargin | NSViewWidthSizable];
602 [_subviews addObject: control];
613 NSEnumerator *enumerator = [_subviews objectEnumerator];
614 VLCConfigControl *widget;
617 while( ( widget = [enumerator nextObject] ) )
618 if( i_max_label < [widget labelSize] )
619 i_max_label = [widget labelSize];
621 enumerator = [_subviews objectEnumerator];
622 while( ( widget = [enumerator nextObject] ) )
626 i_widget = [widget viewType];
627 i_yPos += [VLCConfigControl calcVerticalMargin:i_widget lastItem:i_lastItem];
628 [widget setYPos:i_yPos];
629 frame = [widget frame];
630 frame.size.width = [view frame].size.width - LEFTMARGIN - RIGHTMARGIN;
631 [widget setFrame:frame];
632 [widget alignWithXPosition: i_max_label];
633 i_yPos += [widget frame].size.height;
634 i_lastItem = i_widget;
635 [view addSubview:widget];
638 frame = [view frame];
639 frame.size.height = i_yPos;
640 [view setFrame:frame];
641 [prefsView setDocumentView:view];
647 NSUInteger count = [_subviews count];
648 for( i = 0 ; i < count ; i++ )
649 [[_subviews objectAtIndex:i] applyChanges];
651 count = [_children count];
652 for( i = 0 ; i < count ; i++ )
653 [[_children objectAtIndex:i] applyChanges];
659 NSUInteger count = [_subviews count];
660 for( i = 0 ; i < count ; i++ )
661 [[_subviews objectAtIndex:i] resetValues];
663 count = [_options count];
664 for( i = 0 ; i < count ; i++ )
665 [[_options objectAtIndex:i] resetView];
667 count = [_children count];
668 for( i = 0 ; i < count ; i++ )
669 [[_children objectAtIndex:i] resetView];
673 - (NSMutableArray *)children
675 if(!_children) _children = [[NSMutableArray alloc] init];
679 - (NSMutableArray *)options
681 if(!_options) _options = [[NSMutableArray alloc] init];
687 @implementation VLCFlippedView