Checking in improvements to the effect availability heuristic.
[MenuTunes.git] / MenuController.m
1 //
2 //  MenuController.m
3 //  MenuTunes
4 //
5 //  Created by Joseph Spiros on Wed Apr 30 2003.
6 //  Copyright (c) 2003 iThink Software. All rights reserved.
7 //
8
9 #import "MenuController.h"
10 #import "MainController.h"
11 #import "ITMTRemote.h"
12 #import <ITFoundation/ITDebug.h>
13 #import <ITKit/ITHotKeyCenter.h>
14 #import <ITKit/ITHotKey.h>
15 #import <ITKit/ITKeyCombo.h>
16 #import <ITKit/ITCategory-NSMenu.h>
17
18 @interface MenuController (SubmenuMethods)
19 - (NSMenu *)ratingMenu;
20 - (NSMenu *)upcomingSongsMenu;
21 - (NSMenu *)playlistsMenu;
22 - (NSMenu *)eqMenu;
23 - (void)setKeyEquivalentForCode:(short)code andModifiers:(long)modifiers
24         onItem:(NSMenuItem *)item;
25 @end
26
27 @implementation MenuController
28
29 - (id)init
30 {
31     if ( (self = [super init]) ) {
32         _menuLayout = [[NSMutableArray alloc] initWithCapacity:0];
33     }
34     return self;
35 }
36
37 - (NSMenu *)menu
38 {
39     NSMenu *menu = [[NSMenu alloc] initWithTitle:@""];
40     NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
41     NSArray *menuArray = [defaults arrayForKey:@"menu"];
42     NSEnumerator *enumerator = [menuArray objectEnumerator];
43     NSString *nextObject;
44     NSMenuItem *tempItem;
45     NSEnumerator *itemEnum;
46     ITHotKey *hotKey;
47     NSArray *hotKeys = [[ITHotKeyCenter sharedCenter] allHotKeys];
48     int currentSongRating;
49     
50     //Get the information
51     NS_DURING
52         _currentPlaylist = [[[MainController sharedController] currentRemote] currentPlaylistIndex];
53         _playingRadio = ([[[MainController sharedController] currentRemote] currentPlaylistClass] == ITMTRemotePlayerRadioPlaylist);
54         currentSongRating = ( [[[MainController sharedController] currentRemote] currentSongRating] != -1 );
55     NS_HANDLER
56         [[MainController sharedController] networkError:localException];
57     NS_ENDHANDLER
58     
59     ITDebugLog(@"Reset menu if required.");
60     
61     //Kill the old submenu items
62     if ( (tempItem = [_currentMenu itemWithTag:1]) ) {
63         ITDebugLog(@"Removing \"Song Rating\" submenu.");
64         [tempItem setSubmenu:nil];
65     }
66     
67     if ( (tempItem = [_currentMenu itemWithTag:2]) ) {
68         ITDebugLog(@"Removing \"Upcoming Songs\" submenu.");
69         [tempItem setSubmenu:nil];
70     }
71     
72     if ( (tempItem = [_currentMenu itemWithTag:3]) ) {
73         ITDebugLog(@"Removing \"Playlists\" submenu.");
74         [tempItem setSubmenu:nil];
75     }
76     
77     if ( (tempItem = [_currentMenu itemWithTag:4]) ) {
78         ITDebugLog(@"Removing \"EQ Presets\" submenu.");
79         [tempItem setSubmenu:nil];
80     }
81     
82     ITDebugLog(@"Begin building menu.");
83     
84     //create our menu
85     while ( (nextObject = [enumerator nextObject]) ) {
86         //Main menu items
87         if ([nextObject isEqualToString:@"playPause"]) {
88             ITDebugLog(@"Add \"Play\"/\"Pause\" menu item.");
89             tempItem = [menu addItemWithTitle:NSLocalizedString(@"play", @"Play")
90                     action:@selector(performMainMenuAction:)
91                     keyEquivalent:@""];
92             [tempItem setTag:MTMenuPlayPauseItem];
93             [tempItem setTarget:self];
94             
95             itemEnum = [hotKeys objectEnumerator];
96             while ( (hotKey = [itemEnum nextObject]) ) {
97                 if ([[hotKey name] isEqualToString:@"PlayPause"]) {
98                     ITKeyCombo *combo = [hotKey keyCombo];
99                     [self setKeyEquivalentForCode:[combo keyCode]
100                           andModifiers:[combo modifiers]
101                           onItem:tempItem];
102                 }
103             }
104             
105             ITDebugLog(@"Set \"Play\"/\"Pause\" menu item's title to correct state.");
106             NS_DURING
107                 switch ([[[MainController sharedController] currentRemote] playerPlayingState]) {
108                     case ITMTRemotePlayerPlaying:
109                         [tempItem setTitle:NSLocalizedString(@"pause", @"Pause")];
110                     break;
111                     case ITMTRemotePlayerRewinding:
112                     case ITMTRemotePlayerForwarding:
113                         [tempItem setTitle:NSLocalizedString(@"resume", @"Resume")];
114                     break;
115                     default:
116                     break;
117                 }
118             NS_HANDLER
119                 [[MainController sharedController] networkError:localException];
120             NS_ENDHANDLER
121         } else if ([nextObject isEqualToString:@"nextTrack"]) {
122             ITDebugLog(@"Add \"Next Track\" menu item.");
123             tempItem = [menu addItemWithTitle:NSLocalizedString(@"nextTrack", @"Next Track")
124                     action:@selector(performMainMenuAction:)
125                     keyEquivalent:@""];
126             
127             itemEnum = [hotKeys objectEnumerator];
128             while ( (hotKey = [itemEnum nextObject]) ) {
129                 if ([[hotKey name] isEqualToString:@"NextTrack"]) {
130                     ITKeyCombo *combo = [hotKey keyCombo];
131                     [self setKeyEquivalentForCode:[combo keyCode]
132                           andModifiers:[combo modifiers]
133                           onItem:tempItem];
134                 }
135             }
136             
137             if (_currentPlaylist) {
138                 [tempItem setTag:MTMenuNextTrackItem];
139                 [tempItem setTarget:self];
140             }
141         } else if ([nextObject isEqualToString:@"prevTrack"]) {
142             ITDebugLog(@"Add \"Previous Track\" menu item.");
143             tempItem = [menu addItemWithTitle:NSLocalizedString(@"prevTrack", @"Previous Track")
144                     action:@selector(performMainMenuAction:)
145                     keyEquivalent:@""];
146             
147             itemEnum = [hotKeys objectEnumerator];
148             while ( (hotKey = [itemEnum nextObject]) ) {
149                 if ([[hotKey name] isEqualToString:@"PrevTrack"]) {
150                     ITKeyCombo *combo = [hotKey keyCombo];
151                     [self setKeyEquivalentForCode:[combo keyCode]
152                           andModifiers:[combo modifiers]
153                           onItem:tempItem];
154                 }
155             }
156             
157             if (_currentPlaylist) {
158                 [tempItem setTag:MTMenuPreviousTrackItem];
159                 [tempItem setTarget:self];
160             }
161         } else if ([nextObject isEqualToString:@"fastForward"]) {
162             ITDebugLog(@"Add \"Fast Forward\" menu item.");
163             tempItem = [menu addItemWithTitle:NSLocalizedString(@"fastForward", @"Fast Forward")
164                     action:@selector(performMainMenuAction:)
165                     keyEquivalent:@""];
166             if (_currentPlaylist) {
167                 [tempItem setTag:MTMenuFastForwardItem];
168                 [tempItem setTarget:self];
169             }
170         } else if ([nextObject isEqualToString:@"rewind"]) {
171             ITDebugLog(@"Add \"Rewind\" menu item.");
172             tempItem = [menu addItemWithTitle:NSLocalizedString(@"rewind", @"Rewind")
173                     action:@selector(performMainMenuAction:)
174                     keyEquivalent:@""];
175             if (_currentPlaylist) {
176                 [tempItem setTag:MTMenuRewindItem];
177                 [tempItem setTarget:self];
178             }
179         } else if ([nextObject isEqualToString:@"showPlayer"]) {
180             ITDebugLog(@"Add \"Show Player\" menu item.");
181             NS_DURING
182                 tempItem = [menu addItemWithTitle:[NSString stringWithFormat:@"%@ %@",
183                                 NSLocalizedString(@"show", @"Show"),
184                                     [[[MainController sharedController] currentRemote] playerSimpleName]]
185                                 action:@selector(performMainMenuAction:)
186                                 keyEquivalent:@""];
187             NS_HANDLER
188                 [[MainController sharedController] networkError:localException];
189             NS_ENDHANDLER
190             
191             itemEnum = [hotKeys objectEnumerator];
192             while ( (hotKey = [itemEnum nextObject]) ) {
193                 if ([[hotKey name] isEqualToString:@"ShowPlayer"]) {
194                     ITKeyCombo *combo = [hotKey keyCombo];
195                     [self setKeyEquivalentForCode:[combo keyCode]
196                           andModifiers:[combo modifiers]
197                           onItem:tempItem];
198                 }
199             }
200             
201             [tempItem setTarget:self];
202             [tempItem setTag:MTMenuShowPlayerItem];
203         } else if ([nextObject isEqualToString:@"preferences"]) {
204             ITDebugLog(@"Add \"Preferences...\" menu item.");
205             tempItem = [menu addItemWithTitle:NSLocalizedString(@"preferences", @"Preferences...")
206                     action:@selector(performMainMenuAction:)
207                     keyEquivalent:@""];
208             [tempItem setTag:MTMenuPreferencesItem];
209             [tempItem setTarget:self];
210         } else if ([nextObject isEqualToString:@"quit"]) {
211             if ([[MainController sharedController] blingBling] == NO) {
212                 ITDebugLog(@"Add \"Register MenuTunes...\" menu item.");
213                 tempItem = [menu addItemWithTitle:NSLocalizedString(@"register", @"Register MenuTunes...") action:@selector(performMainMenuAction:) keyEquivalent:@""];
214                 [tempItem setTag:MTMenuRegisterItem];
215                 [tempItem setTarget:self];
216             }
217             ITDebugLog(@"Add \"Quit\" menu item.");
218             tempItem = [menu addItemWithTitle:NSLocalizedString(@"quit", @"Quit")
219                     action:@selector(performMainMenuAction:)
220                     keyEquivalent:@""];
221             [tempItem setTag:MTMenuQuitItem];
222             [tempItem setTarget:self];
223         } else if ([nextObject isEqualToString:@"trackInfo"]) {
224             ITDebugLog(@"Check to see if a Track is playing...");
225             //Handle playing radio too
226             if (_currentPlaylist) {
227                 NSString *title;
228                 NS_DURING
229                     title = [[[MainController sharedController] currentRemote] currentSongTitle];
230                 NS_HANDLER
231                     [[MainController sharedController] networkError:localException];
232                 NS_ENDHANDLER
233                 ITDebugLog(@"A Track is Playing, Add \"Track Info\" menu items.");
234                 ITDebugLog(@"Add \"Now Playing\" menu item.");
235                 [menu addItemWithTitle:NSLocalizedString(@"nowPlaying", @"Now Playing") action:NULL keyEquivalent:@""];
236                 
237                 if ([title length] > 0) {
238                     ITDebugLog(@"Add Track Title (\"%@\") menu item.", title);
239                     [menu indentItem:
240                         [menu addItemWithTitle:title action:nil keyEquivalent:@""]];
241                 }
242                 
243                 if (!_playingRadio) {
244                     if ([defaults boolForKey:@"showAlbum"]) {
245                         NSString *curAlbum;
246                         NS_DURING
247                             curAlbum = [[[MainController sharedController] currentRemote] currentSongAlbum];
248                         NS_HANDLER
249                             [[MainController sharedController] networkError:localException];
250                         NS_ENDHANDLER
251                         ITDebugLog(@"Add Track Album (\"%@\") menu item.", curAlbum);
252                         if ( curAlbum ) {
253                             [menu indentItem:
254                                 [menu addItemWithTitle:curAlbum action:nil keyEquivalent:@""]];
255                         }
256                     }
257                     
258                     if ([defaults boolForKey:@"showArtist"]) {
259                         NSString *curArtist;
260                         NS_DURING
261                             curArtist = [[[MainController sharedController] currentRemote] currentSongArtist];
262                         NS_HANDLER
263                             [[MainController sharedController] networkError:localException];
264                         NS_ENDHANDLER
265                         ITDebugLog(@"Add Track Artist (\"%@\") menu item.", curArtist);
266                         if ( curArtist ) {
267                             [menu indentItem:
268                                 [menu addItemWithTitle:curArtist action:nil keyEquivalent:@""]];
269                         }
270                     }
271                     
272                     if ([defaults boolForKey:@"showTrackNumber"]) {
273                         int track;
274                         NS_DURING
275                             track = [[[MainController sharedController] currentRemote] currentSongTrack];
276                         NS_HANDLER
277                             [[MainController sharedController] networkError:localException];
278                         NS_ENDHANDLER
279                         ITDebugLog(@"Add Track Number (\"Track %i\") menu item.", track);
280                         if ( track > 0 ) {
281                             [menu indentItem:
282                                 [menu addItemWithTitle:[NSString stringWithFormat:@"%@ %i", NSLocalizedString(@"track", @"Track"), track] action:nil keyEquivalent:@""]];
283                         }
284                     }
285                 }
286                 
287                 NS_DURING
288                     if ([defaults boolForKey:@"showTime"] && ( ([[[MainController sharedController] currentRemote] currentSongElapsed] != nil) || ([[[MainController sharedController] currentRemote] currentSongLength] != nil) )) {
289                         ITDebugLog(@"Add Track Elapsed (\"%@/%@\") menu item.", [[[MainController sharedController] currentRemote] currentSongElapsed], [[[MainController sharedController] currentRemote] currentSongLength]);
290                         [menu indentItem:[menu addItemWithTitle:[NSString stringWithFormat:@"%@/%@", [[[MainController sharedController] currentRemote] currentSongElapsed], [[[MainController sharedController] currentRemote] currentSongLength]] action:nil keyEquivalent:@""]];
291                     }
292                 NS_HANDLER
293                     [[MainController sharedController] networkError:localException];
294                 NS_ENDHANDLER
295                 
296                 if (!_playingRadio) {
297                     NS_DURING
298                         if ([defaults boolForKey:@"showTrackRating"] && ( [[[MainController sharedController] currentRemote] currentSongRating] != -1.0 )) {
299                             NSString *string = nil;
300                             switch ((int)([[[MainController sharedController] currentRemote] currentSongRating] * 5)) {
301                                 case 0:
302                                     string = [NSString stringWithUTF8String:"☆☆☆☆☆"];
303                                 break;
304                                 case 1:
305                                     string = [NSString stringWithUTF8String:"★☆☆☆☆"];
306                                 break;
307                                 case 2:
308                                     string = [NSString stringWithUTF8String:"★★☆☆☆"];
309                                 break;
310                                 case 3:
311                                     string = [NSString stringWithUTF8String:"★★★☆☆"];
312                                 break;
313                                 case 4:
314                                     string = [NSString stringWithUTF8String:"★★★★☆"];
315                                 break;
316                                 case 5:
317                                     string = [NSString stringWithUTF8String:"★★★★★"];
318                                 break;
319                             }
320                             ITDebugLog(@"Add Track Rating (\"%@\") menu item.", string);
321                             [menu indentItem:[menu addItemWithTitle:string action:nil keyEquivalent:@""]];
322                         }
323                     NS_HANDLER
324                         [[MainController sharedController] networkError:localException];
325                     NS_ENDHANDLER
326                 }
327             } else {
328                 ITDebugLog(@"No Track is Playing, Add \"No Song\" menu item.");
329                 [menu addItemWithTitle:NSLocalizedString(@"noSong", @"No Song") action:NULL keyEquivalent:@""];
330             }
331         } else if ([nextObject isEqualToString:@"separator"]) {
332             ITDebugLog(@"Add a separator menu item.");
333             [menu addItem:[NSMenuItem separatorItem]];
334         //Submenu items
335         } else if ([nextObject isEqualToString:@"playlists"]) {
336             ITDebugLog(@"Add \"Playlists\" submenu.");
337             tempItem = [menu addItemWithTitle:NSLocalizedString(@"playlists", @"Playlists")
338                     action:nil
339                     keyEquivalent:@""];
340             [tempItem setSubmenu:_playlistsMenu];
341             [tempItem setTag:3];
342         } else if ([nextObject isEqualToString:@"eqPresets"]) {
343             ITDebugLog(@"Add \"EQ Presets\" submenu.");
344             tempItem = [menu addItemWithTitle:NSLocalizedString(@"eqPresets", @"EQ Presets")
345                     action:nil
346                     keyEquivalent:@""];
347             [tempItem setSubmenu:_eqMenu];
348             [tempItem setTag:4];
349             
350             itemEnum = [[_eqMenu itemArray] objectEnumerator];
351             while ( (tempItem = [itemEnum nextObject]) ) {
352                 [tempItem setState:NSOffState];
353             }
354             NS_DURING
355                 [[_eqMenu itemAtIndex:([[[MainController sharedController] currentRemote] currentEQPresetIndex] - 1)] setState:NSOnState];
356             NS_HANDLER
357                 [[MainController sharedController] networkError:localException];
358             NS_ENDHANDLER
359         } else if ([nextObject isEqualToString:@"songRating"] && currentSongRating) {
360                 ITDebugLog(@"Add \"Song Rating\" submenu.");
361                 tempItem = [menu addItemWithTitle:NSLocalizedString(@"songRating", @"Song Rating")
362                         action:nil
363                         keyEquivalent:@""];
364                 [tempItem setSubmenu:_ratingMenu];
365                 [tempItem setTag:1];
366                 if (_playingRadio || !_currentPlaylist) {
367                     [tempItem setEnabled:NO];
368                 }
369                 
370                 itemEnum = [[_ratingMenu itemArray] objectEnumerator];
371                 while ( (tempItem = [itemEnum nextObject]) ) {
372                     [tempItem setState:NSOffState];
373                 }
374                 
375                 NS_DURING
376                     [[_ratingMenu itemAtIndex:([[[MainController sharedController] currentRemote] currentSongRating] * 5)] setState:NSOnState];
377                 NS_HANDLER
378                     [[MainController sharedController] networkError:localException];
379                 NS_ENDHANDLER
380             } else if ([nextObject isEqualToString:@"upcomingSongs"]) {
381                 ITDebugLog(@"Add \"Upcoming Songs\" submenu.");
382                 tempItem = [menu addItemWithTitle:NSLocalizedString(@"upcomingSongs", @"Upcoming Songs")
383                         action:nil
384                         keyEquivalent:@""];
385                 [tempItem setSubmenu:_upcomingSongsMenu];
386                 [tempItem setTag:2];
387                 if (_playingRadio || !_currentPlaylist) {
388                     [tempItem setEnabled:NO];
389                 }
390             }
391         }
392     ITDebugLog(@"Finished building menu.");
393     [_currentMenu release];
394     _currentMenu = menu;
395     return _currentMenu;
396 }
397
398 - (NSMenu *)menuForNoPlayer
399 {
400     NSMenu *menu = [[NSMenu alloc] initWithTitle:@""];
401     NSMenuItem *tempItem;
402     ITDebugLog(@"Creating menu for when player isn't running.");
403     NS_DURING
404         ITDebugLog(@"Add \"Open %@\" menu item.", [[[MainController sharedController] currentRemote] playerSimpleName]);
405         tempItem = [menu addItemWithTitle:[NSString stringWithFormat:@"%@ %@", NSLocalizedString(@"open", @"Open"), [[[MainController sharedController] currentRemote] playerSimpleName]] action:@selector(performMainMenuAction:) keyEquivalent:@""];
406     NS_HANDLER
407         [[MainController sharedController] networkError:localException];
408     NS_ENDHANDLER
409     [tempItem setTag:MTMenuShowPlayerItem];
410     [tempItem setTarget:self];
411     ITDebugLog(@"Add a separator menu item.");
412     [menu addItem:[NSMenuItem separatorItem]];
413     ITDebugLog(@"Add \"Preferences...\" menu item.");
414     tempItem = [menu addItemWithTitle:NSLocalizedString(@"preferences", @"Preferences...") action:@selector(performMainMenuAction:) keyEquivalent:@""];
415     [tempItem setTag:MTMenuPreferencesItem];
416     [tempItem setTarget:self];
417     if ([[MainController sharedController] blingBling] == NO) {
418         ITDebugLog(@"Add \"Register MenuTunes...\" menu item.");
419         tempItem = [menu addItemWithTitle:NSLocalizedString(@"register", @"Register MenuTunes...") action:@selector(performMainMenuAction:) keyEquivalent:@""];
420         [tempItem setTag:MTMenuRegisterItem];
421         [tempItem setTarget:self];
422     }
423     ITDebugLog(@"Add \"Quit\" menu item.");
424     tempItem = [menu addItemWithTitle:NSLocalizedString(@"quit", @"Quit") action:@selector(performMainMenuAction:) keyEquivalent:@""];
425     [tempItem setTag:MTMenuQuitItem];
426     [tempItem setTarget:self];
427     return [menu autorelease];
428 }
429
430 - (void)rebuildSubmenus
431 {
432     ITDebugLog(@"Rebuilding all of the submenus.");
433     
434     NS_DURING
435         _currentPlaylist = [[[MainController sharedController] currentRemote] currentPlaylistIndex];
436         _currentTrack = [[[MainController sharedController] currentRemote] currentSongIndex];
437         _playingRadio = ([[[MainController sharedController] currentRemote] currentPlaylistClass] == ITMTRemotePlayerRadioPlaylist);
438     NS_HANDLER
439         [[MainController sharedController] networkError:localException];
440     NS_ENDHANDLER
441     
442     [_ratingMenu release];
443     [_upcomingSongsMenu release];
444     [_playlistsMenu release];
445     [_eqMenu release];
446     ITDebugLog(@"Beginning Rebuild of \"Song Rating\" submenu.");
447     _ratingMenu = [self ratingMenu];
448     ITDebugLog(@"Beginning Rebuild of \"Upcoming Songs\" submenu.");
449     _upcomingSongsMenu = [self upcomingSongsMenu];
450     ITDebugLog(@"Beginning Rebuild of \"Playlists\" submenu.");
451     _playlistsMenu = [self playlistsMenu];
452     ITDebugLog(@"Beginning Rebuild of \"EQ Presets\" submenu.");
453     _eqMenu = [self eqMenu];
454     ITDebugLog(@"Done rebuilding all of the submenus.");
455 }
456
457 - (NSMenu *)ratingMenu
458 {
459     NSMenu *ratingMenu = [[NSMenu alloc] initWithTitle:@""];
460     NSEnumerator *itemEnum;
461     id  anItem;
462     int itemTag = 0;
463     SEL itemSelector = @selector(performRatingMenuAction:);
464     
465     ITDebugLog(@"Building \"Song Rating\" menu.");
466     
467     [ratingMenu addItemWithTitle:[NSString stringWithUTF8String:"☆☆☆☆☆"] action:nil keyEquivalent:@""];
468     [ratingMenu addItemWithTitle:[NSString stringWithUTF8String:"★☆☆☆☆"] action:nil keyEquivalent:@""];
469     [ratingMenu addItemWithTitle:[NSString stringWithUTF8String:"★★☆☆☆"] action:nil keyEquivalent:@""];
470     [ratingMenu addItemWithTitle:[NSString stringWithUTF8String:"★★★☆☆"] action:nil keyEquivalent:@""];
471     [ratingMenu addItemWithTitle:[NSString stringWithUTF8String:"★★★★☆"] action:nil keyEquivalent:@""];
472     [ratingMenu addItemWithTitle:[NSString stringWithUTF8String:"★★★★★"] action:nil keyEquivalent:@""];
473     
474     itemEnum = [[ratingMenu itemArray] objectEnumerator];
475     while ( (anItem = [itemEnum nextObject]) ) {
476         ITDebugLog(@"Setting up \"%@\" menu item.", [anItem title]);
477         [anItem setAction:itemSelector];
478         [anItem setTarget:self];
479         [anItem setTag:itemTag];
480         itemTag += 20;
481     }
482     ITDebugLog(@"Done Building \"Song Rating\" menu.");
483     return ratingMenu;
484 }
485
486 - (NSMenu *)upcomingSongsMenu
487 {
488     NSMenu *upcomingSongsMenu = [[NSMenu alloc] initWithTitle:@""];
489     int numSongs, numSongsInAdvance = [[NSUserDefaults standardUserDefaults] integerForKey:@"SongsInAdvance"];
490     
491     NS_DURING
492         numSongs = [[[MainController sharedController] currentRemote] numberOfSongsInPlaylistAtIndex:_currentPlaylist];
493     NS_HANDLER
494         [[MainController sharedController] networkError:localException];
495     NS_ENDHANDLER
496     
497     ITDebugLog(@"Building \"Upcoming Songs\" menu.");
498     
499     if (_currentPlaylist && !_playingRadio) {
500         if (numSongs > 0) {
501             int i;
502
503             for (i = _currentTrack + 1; i <= _currentTrack + numSongsInAdvance; i++) {
504                 if (i <= numSongs) {
505                     NSString *curSong;
506                     NS_DURING
507                         curSong = [[[MainController sharedController] currentRemote] songTitleAtIndex:i];
508                     NS_HANDLER
509                         [[MainController sharedController] networkError:localException];
510                     NS_ENDHANDLER
511                     NSMenuItem *songItem;
512                     ITDebugLog(@"Adding song: %@", curSong);
513                     songItem = [upcomingSongsMenu addItemWithTitle:curSong action:@selector(performUpcomingSongsMenuAction:) keyEquivalent:@""];
514                     [songItem setTag:i];
515                     [songItem setTarget:self];
516                 } else {
517                     break;
518                 }
519             }
520         }
521         
522         if ([upcomingSongsMenu numberOfItems] == 0) {
523             [upcomingSongsMenu addItemWithTitle:NSLocalizedString(@"noUpcomingSongs", @"No upcoming songs.") action:NULL keyEquivalent:@""];
524         }
525     }
526     ITDebugLog(@"Done Building \"Upcoming Songs\" menu.");
527     return upcomingSongsMenu;
528 }
529
530 - (NSMenu *)playlistsMenu
531 {
532     NSMenu *playlistsMenu = [[NSMenu alloc] initWithTitle:@""];
533     NSArray *playlists;
534     NSMenuItem *tempItem;
535     int i;
536     
537     NS_DURING
538         playlists = [[[MainController sharedController] currentRemote] playlists];
539     NS_HANDLER
540         [[MainController sharedController] networkError:localException];
541     NS_ENDHANDLER
542     
543     ITDebugLog(@"Building \"Playlists\" menu.");
544     
545     for (i = 0; i < [playlists count]; i++) {
546         NSString *curPlaylist = [playlists objectAtIndex:i];
547         ITDebugLog(@"Adding playlist: %@", curPlaylist);
548         tempItem = [playlistsMenu addItemWithTitle:curPlaylist action:@selector(performPlaylistMenuAction:) keyEquivalent:@""];
549         [tempItem setTag:i + 1];
550         [tempItem setTarget:self];
551     }
552     
553     if (!_playingRadio && _currentPlaylist) {
554         [[playlistsMenu itemAtIndex:_currentPlaylist - 1] setState:NSOnState];
555     }
556     ITDebugLog(@"Done Building \"Playlists\" menu");
557     return playlistsMenu;
558 }
559
560 - (NSMenu *)eqMenu
561 {
562     NSMenu *eqMenu = [[NSMenu alloc] initWithTitle:@""];
563     NSArray *eqPresets;
564     NSMenuItem *tempItem;
565     int i;
566     
567     NS_DURING
568         eqPresets = [[[MainController sharedController] currentRemote] eqPresets];
569     NS_HANDLER
570         [[MainController sharedController] networkError:localException];
571     NS_ENDHANDLER
572     
573     ITDebugLog(@"Building \"EQ Presets\" menu.");
574     
575     for (i = 0; i < [eqPresets count]; i++) {
576         NSString *name;
577            if ( ( name = [eqPresets objectAtIndex:i] ) ) {
578             ITDebugLog(@"Adding EQ Preset: %@", name);
579             tempItem = [eqMenu addItemWithTitle:name
580                     action:@selector(performEqualizerMenuAction:)
581                     keyEquivalent:@""];
582             [tempItem setTag:i];
583             [tempItem setTarget:self];
584            }
585     }
586     ITDebugLog(@"Done Building \"EQ Presets\" menu");
587     return eqMenu;
588 }
589
590 - (void)performMainMenuAction:(id)sender
591 {
592     switch ( [sender tag] )
593     {
594         case MTMenuPlayPauseItem:
595             ITDebugLog(@"Performing Menu Action: Play/Pause");
596             [[MainController sharedController] playPause];
597             break;
598         case MTMenuFastForwardItem:
599             ITDebugLog(@"Performing Menu Action: Fast Forward");
600             [[MainController sharedController] fastForward];
601             break;
602         case MTMenuRewindItem:
603             ITDebugLog(@"Performing Menu Action: Rewind");
604             [[MainController sharedController] rewind];
605             break;
606         case MTMenuPreviousTrackItem:
607             ITDebugLog(@"Performing Menu Action: Previous Track");
608             [[MainController sharedController] prevSong];
609             break;
610         case MTMenuNextTrackItem:
611             ITDebugLog(@"Performing Menu Action: Next Track");
612             [[MainController sharedController] nextSong];
613             break;
614         case MTMenuShowPlayerItem:
615             ITDebugLog(@"Performing Menu Action: Show Main Interface");
616             [[MainController sharedController] showPlayer];
617             break;
618         case MTMenuPreferencesItem:
619             ITDebugLog(@"Performing Menu Action: Preferences...");
620             [[MainController sharedController] showPreferences];
621             break;
622         case MTMenuQuitItem:
623             ITDebugLog(@"Performing Menu Action: Quit");
624             [[MainController sharedController] quitMenuTunes];
625             break;
626         case MTMenuRegisterItem:
627             ITDebugLog(@"Performing Menu Action: Register");
628             [[MainController sharedController] blingNow];
629             break;
630         default:
631             ITDebugLog(@"Performing Menu Action: Unimplemented Menu Item OR Child-bearing Menu Item");
632             break;
633     }
634 }
635
636 - (void)performRatingMenuAction:(id)sender
637 {
638     ITDebugLog(@"Rating action selected on item with tag %i", [sender tag]);
639     [[MainController sharedController] selectSongRating:[sender tag]];
640 }
641
642 - (void)performPlaylistMenuAction:(id)sender
643 {
644     ITDebugLog(@"Playlist action selected on item with tag %i", [sender tag]);
645     [[MainController sharedController] selectPlaylistAtIndex:[sender tag]];
646 }
647
648 - (void)performEqualizerMenuAction:(id)sender
649 {
650     ITDebugLog(@"EQ action selected on item with tag %i", [sender tag]);
651     [[MainController sharedController] selectEQPresetAtIndex:[sender tag]];
652 }
653
654 - (void)performUpcomingSongsMenuAction:(id)sender
655 {
656     ITDebugLog(@"Song action selected on item with tag %i", [sender tag]);
657     [[MainController sharedController] selectSongAtIndex:[sender tag]];
658 }
659
660 - (void)updateMenu
661 {
662     ITDebugLog(@"Update Menu");
663     [_currentMenu update];
664 }
665
666 - (BOOL)validateMenuItem:(id <NSMenuItem>)menuItem
667 {
668     return YES;
669 }
670
671 //This is never used I know, keep it though
672 - (NSString *)systemUIColor
673 {
674     NSDictionary *tmpDict;
675     NSNumber *tmpNumber;
676     if ( (tmpDict = [NSDictionary dictionaryWithContentsOfFile:[@"~/Library/Preferences/.GlobalPreferences.plist" stringByExpandingTildeInPath]]) ) {
677         if ( (tmpNumber = [tmpDict objectForKey:@"AppleAquaColorVariant"]) ) {
678             if ( ([tmpNumber intValue] == 1) ) {
679                 return @"Aqua";
680             } else {
681                 return @"Graphite";
682             }
683         } else {
684             return @"Aqua";
685         }
686     } else {
687         return @"Aqua";
688     }
689 }
690
691 - (void)setKeyEquivalentForCode:(short)code andModifiers:(long)modifiers
692         onItem:(NSMenuItem *)item
693 {
694     unichar charcode = 'a';
695     int i;
696     long cocoaModifiers = 0;
697     static long carbonToCocoa[6][2] = 
698     {
699         { cmdKey, NSCommandKeyMask },
700         { optionKey, NSAlternateKeyMask },
701         { controlKey, NSControlKeyMask },
702         { shiftKey, NSShiftKeyMask },
703     };
704     
705     ITDebugLog(@"Setting Key Equivelent on menu item \"%@\".", [item title]);
706     
707     for (i = 0; i < 6; i++) {
708         if (modifiers & carbonToCocoa[i][0]) {
709             cocoaModifiers += carbonToCocoa[i][1];
710         }
711     }
712     [item setKeyEquivalentModifierMask:cocoaModifiers];
713     
714     //Missing key combos for some keys. Must find them later.
715     switch (code)
716     {
717         case 36:
718             ITDebugLog(@"Keycode for menu item \"%@\": 36 (Return)", [item title]);
719             charcode = '\r';
720         break;
721         
722         case 48:
723             ITDebugLog(@"Keycode for menu item \"%@\": 48 (Tab)", [item title]);
724             charcode = '\t';
725         break;
726         
727         //Space -- ARGH!
728         case 49:
729         {
730             ITDebugLog(@"Keycode for menu item \"%@\": 49 (Space)", [item title]);
731             // Haven't tested this, though it should work.
732             // This doesn't work. :'(
733             //unichar buffer;
734             //[[NSString stringWithString:@"Space"] getCharacters:&buffer];
735             //charcode = buffer;
736             /*MenuRef menuRef = _NSGetCarbonMenu([item menu]);
737             ITDebugLog(@"%@", menuRef);
738             SetMenuItemCommandKey(menuRef, 0, NO, 49);
739             SetMenuItemModifiers(menuRef, 0, kMenuNoCommandModifier);
740             SetMenuItemKeyGlyph(menuRef, 0, kMenuBlankGlyph);
741             charcode = 'b';*/
742             unichar buffer;
743             [[NSString stringWithString:@" "] getCharacters:&buffer]; // this will have to do for now :(
744             charcode = buffer;
745         }
746         break;
747         
748         case 51:
749             ITDebugLog(@"Keycode for menu item \"%@\": 51 (Delete)", [item title]);
750             charcode = NSDeleteFunctionKey;
751         break;
752         
753         case 53:
754             ITDebugLog(@"Keycode for menu item \"%@\": 53 (Escape)", [item title]);
755             charcode = '\e';
756         break;
757         
758         case 71:
759             ITDebugLog(@"Keycode for menu item \"%@\": 71 (Escape)", [item title]);
760             charcode = '\e';
761         break;
762         
763         case 76:
764             ITDebugLog(@"Keycode for menu item \"%@\": 76 (Return)", [item title]);
765             charcode = '\r';
766         break;
767         
768         case 96:
769             ITDebugLog(@"Keycode for menu item \"%@\": 96 (F5)", [item title]);
770             charcode = NSF5FunctionKey;
771         break;
772         
773         case 97:
774             ITDebugLog(@"Keycode for menu item \"%@\": 97 (F6)", [item title]);
775             charcode = NSF6FunctionKey;
776         break;
777         
778         case 98:
779             ITDebugLog(@"Keycode for menu item \"%@\": 98 (F7)", [item title]);
780             charcode = NSF7FunctionKey;
781         break;
782         
783         case 99:
784             ITDebugLog(@"Keycode for menu item \"%@\": 99 (F3)", [item title]);
785             charcode = NSF3FunctionKey;
786         break;
787         
788         case 100:
789             ITDebugLog(@"Keycode for menu item \"%@\": 100 (F8)", [item title]);
790             charcode = NSF8FunctionKey;
791         break;
792         
793         case 101:
794             ITDebugLog(@"Keycode for menu item \"%@\": 101 (F9)", [item title]);
795             charcode = NSF9FunctionKey;
796         break;
797         
798         case 103:
799             ITDebugLog(@"Keycode for menu item \"%@\": 103 (F11)", [item title]);
800             charcode = NSF11FunctionKey;
801         break;
802         
803         case 105:
804             ITDebugLog(@"Keycode for menu item \"%@\": 105 (F13)", [item title]);
805             charcode = NSF13FunctionKey;
806         break;
807         
808         case 107:
809             ITDebugLog(@"Keycode for menu item \"%@\": 107 (F14)", [item title]);
810             charcode = NSF14FunctionKey;
811         break;
812         
813         case 109:
814             ITDebugLog(@"Keycode for menu item \"%@\": 109 (F10)", [item title]);
815             charcode = NSF10FunctionKey;
816         break;
817         
818         case 111:
819             ITDebugLog(@"Keycode for menu item \"%@\": 111 (F12)", [item title]);
820             charcode = NSF12FunctionKey;
821         break;
822         
823         case 113:
824             ITDebugLog(@"Keycode for menu item \"%@\": 113 (F13)", [item title]);
825             charcode = NSF13FunctionKey;
826         break;
827         
828         case 114:
829             ITDebugLog(@"Keycode for menu item \"%@\": 114 (Insert)", [item title]);
830             charcode = NSInsertFunctionKey;
831         break;
832         
833         case 115:
834             ITDebugLog(@"Keycode for menu item \"%@\": 115 (Home)", [item title]);
835             charcode = NSHomeFunctionKey;
836         break;
837         
838         case 116:
839             ITDebugLog(@"Keycode for menu item \"%@\": 116 (PgUp)", [item title]);
840             charcode = NSPageUpFunctionKey;
841         break;
842         
843         case 117:
844             ITDebugLog(@"Keycode for menu item \"%@\": 117 (Delete)", [item title]);
845             charcode = NSDeleteFunctionKey;
846         break;
847         
848         case 118:
849             ITDebugLog(@"Keycode for menu item \"%@\": 118 (F4)", [item title]);
850             charcode = NSF4FunctionKey;
851         break;
852         
853         case 119:
854             ITDebugLog(@"Keycode for menu item \"%@\": 119 (End)", [item title]);
855             charcode = NSEndFunctionKey;
856         break;
857         
858         case 120:
859             ITDebugLog(@"Keycode for menu item \"%@\": 120 (F2)", [item title]);
860             charcode = NSF2FunctionKey;
861         break;
862         
863         case 121:
864             ITDebugLog(@"Keycode for menu item \"%@\": 121 (PgDown)", [item title]);
865             charcode = NSPageDownFunctionKey;
866         break;
867         
868         case 122:
869             ITDebugLog(@"Keycode for menu item \"%@\": 122 (F1)", [item title]);
870             charcode = NSF1FunctionKey;
871         break;
872         
873         case 123:
874             ITDebugLog(@"Keycode for menu item \"%@\": 123 (Left Arrow)", [item title]);
875             charcode = NSLeftArrowFunctionKey;
876         break;
877         
878         case 124:
879             ITDebugLog(@"Keycode for menu item \"%@\": 124 (Right Arrow)", [item title]);
880             charcode = NSRightArrowFunctionKey;
881         break;
882         
883         case 125:
884             ITDebugLog(@"Keycode for menu item \"%@\": 125 (Down Arrow)", [item title]);
885             charcode = NSDownArrowFunctionKey;
886         break;
887         
888         case 126:
889             ITDebugLog(@"Keycode for menu item \"%@\": 126 (Up Arrow)", [item title]);
890             charcode = NSUpArrowFunctionKey;
891         break;
892     }
893     
894     if (charcode == 'a') {
895         unsigned long state;
896         long keyTrans;
897         char charCode;
898         Ptr kchr;
899         state = 0;
900         kchr = (Ptr) GetScriptVariable(smCurrentScript, smKCHRCache);
901         keyTrans = KeyTranslate(kchr, code, &state);
902         charCode = keyTrans;
903         ITDebugLog(@"Keycode for menu item \"%@\": %i (%c)", [item title], code, charCode);
904         [item setKeyEquivalent:[NSString stringWithCString:&charCode length:1]];
905     } else if (charcode != 'b') {
906         [item setKeyEquivalent:[NSString stringWithCharacters:&charcode length:1]];
907     }
908     ITDebugLog(@"Done setting key equivalent on menu item: %@", [item title]);
909 }
910
911 @end