src/MacVim/MMAppController.m

   1 /* vi:set ts=8 sts=4 sw=4 ft=objc:
   2  *
   3  * VIM - Vi IMproved            by Bram Moolenaar
   4  *                              MacVim GUI port by Bjorn Winckler
   5  *
   6  * Do ":help uganda"  in Vim to read copying and usage conditions.
   7  * Do ":help credits" in Vim to see a list of people who contributed.
   8  * See README.txt for an overview of the Vim source code.
   9  */
  10
  11 #import "MMAppController.h"
  12 #import "MMVimController.h"
  13 #import "MMWindowController.h"
  14
  15
  16
  17 // Default timeout intervals on all connections.
  18 static NSTimeInterval MMRequestTimeout = 5;
  19 static NSTimeInterval MMReplyTimeout = 5;
  20
  21
  22
  23 @interface MMAppController (MMServices)
  24 - (void)openSelection:(NSPasteboard *)pboard userData:(NSString *)userData
  25                 error:(NSString **)error;
  26 - (void)openFile:(NSPasteboard *)pboard userData:(NSString *)userData
  27            error:(NSString **)error;
  28 @end
  29
  30
  31 @interface MMAppController (Private)
  32 - (MMVimController *)keyVimController;
  33 - (MMVimController *)topmostVimController;
  34 - (void)launchVimProcessWithArguments:(NSArray *)args;
  35 @end
  36
  37 @interface NSMenu (MMExtras)
  38 - (void)recurseSetAutoenablesItems:(BOOL)on;
  39 @end
  40
  41 @interface NSNumber (MMExtras)
  42 - (int)tag;
  43 @end
  44
  45
  46
  47 @implementation MMAppController
  48
  49 + (void)initialize
  50 {
  51     NSDictionary *dict = [NSDictionary dictionaryWithObjectsAndKeys:
  52         [NSNumber numberWithBool:NO],   MMNoWindowKey,
  53         [NSNumber numberWithInt:64],    MMTabMinWidthKey,
  54         [NSNumber numberWithInt:6*64],  MMTabMaxWidthKey,
  55         [NSNumber numberWithInt:132],   MMTabOptimumWidthKey,
  56         [NSNumber numberWithInt:2],     MMTextInsetLeftKey,
  57         [NSNumber numberWithInt:1],     MMTextInsetRightKey,
  58         [NSNumber numberWithInt:1],     MMTextInsetTopKey,
  59         [NSNumber numberWithInt:1],     MMTextInsetBottomKey,
  60         [NSNumber numberWithBool:NO],   MMTerminateAfterLastWindowClosedKey,
  61         @"MMTypesetter",                MMTypesetterKey,
  62         [NSNumber numberWithFloat:1],   MMCellWidthMultiplierKey,
  63         [NSNumber numberWithFloat:-1],  MMBaselineOffsetKey,
  64         [NSNumber numberWithBool:YES],  MMTranslateCtrlClickKey,
  65         [NSNumber numberWithBool:NO],   MMOpenFilesInTabsKey,
  66         nil];
  67
  68     [[NSUserDefaults standardUserDefaults] registerDefaults:dict];
  69
  70     NSArray *types = [NSArray arrayWithObject:NSStringPboardType];
  71     [NSApp registerServicesMenuSendTypes:types returnTypes:types];
  72 }
  73
  74 - (id)init
  75 {
  76     if ((self = [super init])) {
  77         fontContainerRef = loadFonts();
  78
  79         vimControllers = [NSMutableArray new];
  80
  81         // NOTE!  If the name of the connection changes here it must also be
  82         // updated in MMBackend.m.
  83         NSConnection *connection = [NSConnection defaultConnection];
  84         NSString *name = [NSString stringWithFormat:@"%@-connection",
  85                  [[NSBundle mainBundle] bundleIdentifier]];
  86         //NSLog(@"Registering connection with name '%@'", name);
  87         if ([connection registerName:name]) {
  88             [connection setRequestTimeout:MMRequestTimeout];
  89             [connection setReplyTimeout:MMReplyTimeout];
  90             [connection setRootObject:self];
  91
  92             // NOTE: When the user is resizing the window the AppKit puts the
  93             // run loop in event tracking mode.  Unless the connection listens
  94             // to request in this mode, live resizing won't work.
  95             [connection addRequestMode:NSEventTrackingRunLoopMode];
  96         } else {
  97             NSLog(@"WARNING: Failed to register connection with name '%@'",
  98                     name);
  99         }
 100     }
 101
 102     return self;
 103 }
 104
 105 - (void)dealloc
 106 {
 107     //NSLog(@"MMAppController dealloc");
 108
 109     [vimControllers release];
 110     [openSelectionString release];
 111
 112     [super dealloc];
 113 }
 114
 115 - (void)applicationDidFinishLaunching:(NSNotification *)notification
 116 {
 117     [NSApp setServicesProvider:self];
 118 }
 119
 120 - (BOOL)applicationShouldOpenUntitledFile:(NSApplication *)sender
 121 {
 122     // NOTE!  This way it possible to start the app with the command-line
 123     // argument '-nowindow yes' and no window will be opened by default.
 124     untitledWindowOpening =
 125         ![[NSUserDefaults standardUserDefaults] boolForKey:MMNoWindowKey];
 126     return untitledWindowOpening;
 127 }
 128
 129 - (BOOL)applicationOpenUntitledFile:(NSApplication *)sender
 130 {
 131     //NSLog(@"%s NSapp=%@ theApp=%@", _cmd, NSApp, sender);
 132
 133     [self newWindow:self];
 134     return YES;
 135 }
 136
 137 - (void)application:(NSApplication *)sender openFiles:(NSArray *)filenames
 138 {
 139     // Go trough 'filenames' array and make sure each file exists.
 140     NSString *firstMissingFile = nil;
 141     NSMutableArray *files = [NSMutableArray array];
 142     int i, count = [filenames count];
 143     for (i = 0; i < count; ++i) {
 144         NSString *name = [filenames objectAtIndex:i];
 145         if ([[NSFileManager defaultManager] fileExistsAtPath:name]) {
 146             [files addObject:name];
 147         } else if (!firstMissingFile) {
 148             firstMissingFile = name;
 149         }
 150     }
 151
 152     if (firstMissingFile) {
 153         NSAlert *alert = [[NSAlert alloc] init];
 154         [alert addButtonWithTitle:@"OK"];
 155
 156         NSString *text;
 157         if ([files count] >= count-1) {
 158             [alert setMessageText:@"File not found"];
 159             text = [NSString stringWithFormat:@"Could not open file with "
 160                 "name %@.", firstMissingFile];
 161         } else {
 162             [alert setMessageText:@"Multiple files not found"];
 163             text = [NSString stringWithFormat:@"Could not open file with "
 164                 "name %@, and %d other files.", firstMissingFile,
 165                 count-[files count]-1];
 166         }
 167
 168         [alert setInformativeText:text];
 169         [alert setAlertStyle:NSWarningAlertStyle];
 170
 171         [alert runModal];
 172         [alert release];
 173
 174         [NSApp replyToOpenOrPrint:NSApplicationDelegateReplyFailure];
 175         return;
 176     }
 177
 178     if ([files count] == 1) {
 179         // Check if the file is already open...if so raise that window.
 180         i, count = [vimControllers count];
 181         for (i = 0; i < count; ++i) {
 182             MMVimController *controller = [vimControllers objectAtIndex:i];
 183             id proxy = [controller backendProxy];
 184
 185             @try {
 186                 NSString *expr = [NSString stringWithFormat:
 187                         @"bufloaded(\"%@\")", [files objectAtIndex:0]];
 188                 NSString *eval = [proxy evaluateExpression:expr];
 189                 if ([eval isEqual:@"1"]) {
 190                     // TODO: Select the tab with 'file' open.
 191                     [controller addVimInput:
 192                                 @"<C-\\><C-N>:cal foreground()<CR>"];
 193                     return;
 194                 }
 195             }
 196             @catch (NSException *e) {
 197                 // Do nothing ...
 198             }
 199         }
 200     }
 201
 202     MMVimController *vc;
 203     BOOL openInTabs = [[NSUserDefaults standardUserDefaults]
 204         boolForKey:MMOpenFilesInTabsKey];
 205
 206     if (openInTabs && (vc = [self topmostVimController])) {
 207         [vc dropFiles:files];
 208     } else {
 209         NSMutableArray *args = [NSMutableArray arrayWithObject:@"-p"];
 210         [args addObjectsFromArray:files];
 211         [self launchVimProcessWithArguments:args];
 212     }
 213
 214     [NSApp replyToOpenOrPrint:NSApplicationDelegateReplySuccess];
 215     // NSApplicationDelegateReplySuccess = 0,
 216     // NSApplicationDelegateReplyCancel = 1,
 217     // NSApplicationDelegateReplyFailure = 2
 218 }
 219
 220 - (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)sender
 221 {
 222     return [[NSUserDefaults standardUserDefaults]
 223             boolForKey:MMTerminateAfterLastWindowClosedKey];
 224 }
 225
 226 - (NSApplicationTerminateReply)applicationShouldTerminate:
 227     (NSApplication *)sender
 228 {
 229     // TODO: Follow Apple's guidelines for 'Graceful Application Termination'
 230     // (in particular, allow user to review changes and save).
 231     int reply = NSTerminateNow;
 232     BOOL modifiedBuffers = NO;
 233
 234     // Go through windows, checking for modified buffers.  (Each Vim process
 235     // tells MacVim when any buffer has been modified and MacVim sets the
 236     // 'documentEdited' flag of the window correspondingly.)
 237     NSEnumerator *e = [[NSApp windows] objectEnumerator];
 238     id window;
 239     while (window = [e nextObject]) {
 240         if ([window isDocumentEdited]) {
 241             modifiedBuffers = YES;
 242             break;
 243         }
 244     }
 245
 246     if (modifiedBuffers) {
 247         NSAlert *alert = [[NSAlert alloc] init];
 248         [alert addButtonWithTitle:@"Quit"];
 249         [alert addButtonWithTitle:@"Cancel"];
 250         [alert setMessageText:@"Quit without saving?"];
 251         [alert setInformativeText:@"There are modified buffers, "
 252             "if you quit now all changes will be lost.  Quit anyway?"];
 253         [alert setAlertStyle:NSWarningAlertStyle];
 254
 255         if ([alert runModal] != NSAlertFirstButtonReturn)
 256             reply = NSTerminateCancel;
 257
 258         [alert release];
 259     }
 260
 261     return reply;
 262 }
 263
 264 - (void)applicationWillTerminate:(NSNotification *)aNotification
 265 {
 266     // This will invalidate all connections (since they were spawned from the
 267     // default connection).
 268     [[NSConnection defaultConnection] invalidate];
 269
 270     // Send a SIGINT to all running Vim processes, so that they are sure to
 271     // receive the connectionDidDie: notification (a process has to be checking
 272     // the run-loop for this to happen).
 273     unsigned i, count = [vimControllers count];
 274     for (i = 0; i < count; ++i) {
 275         MMVimController *controller = [vimControllers objectAtIndex:i];
 276         int pid = [controller pid];
 277         if (pid > 0)
 278             kill(pid, SIGINT);
 279     }
 280
 281     if (fontContainerRef) {
 282         ATSFontDeactivate(fontContainerRef, NULL, kATSOptionFlagsDefault);
 283         fontContainerRef = 0;
 284     }
 285
 286     // TODO: Is this a correct way of releasing the MMAppController?
 287     // (It doesn't seem like dealloc is ever called.)
 288     [NSApp setDelegate:nil];
 289     [self autorelease];
 290 }
 291
 292 - (void)removeVimController:(id)controller
 293 {
 294     //NSLog(@"%s%@", _cmd, controller);
 295
 296     [[controller windowController] close];
 297
 298     [vimControllers removeObject:controller];
 299
 300     if (![vimControllers count]) {
 301         // Turn on autoenabling of menus (because no Vim is open to handle it),
 302         // but do not touch the MacVim menu.  Note that the menus must be
 303         // enabled first otherwise autoenabling does not work.
 304         NSMenu *mainMenu = [NSApp mainMenu];
 305         int i, count = [mainMenu numberOfItems];
 306         for (i = 1; i < count; ++i) {
 307             NSMenuItem *item = [mainMenu itemAtIndex:i];
 308             [item setEnabled:YES];
 309             [[item submenu] recurseSetAutoenablesItems:YES];
 310         }
 311     }
 312 }
 313
 314 - (void)windowControllerWillOpen:(MMWindowController *)windowController
 315 {
 316     NSPoint topLeft = NSZeroPoint;
 317     NSWindow *keyWin = [NSApp keyWindow];
 318     NSWindow *win = [windowController window];
 319
 320     if (!win) return;
 321
 322     // If there is a key window, cascade from it, otherwise use the autosaved
 323     // window position (if any).
 324     if (keyWin) {
 325         NSRect frame = [keyWin frame];
 326         topLeft = NSMakePoint(frame.origin.x, NSMaxY(frame));
 327     } else {
 328         NSString *topLeftString = [[NSUserDefaults standardUserDefaults]
 329             stringForKey:MMTopLeftPointKey];
 330         if (topLeftString)
 331             topLeft = NSPointFromString(topLeftString);
 332     }
 333
 334     if (!NSEqualPoints(topLeft, NSZeroPoint)) {
 335         if (keyWin)
 336             topLeft = [win cascadeTopLeftFromPoint:topLeft];
 337
 338         [win setFrameTopLeftPoint:topLeft];
 339     }
 340
 341     if (openSelectionString) {
 342         // There is some text to paste into this window as a result of the
 343         // services menu "Open selection ..." being used.
 344         [[windowController vimController] dropString:openSelectionString];
 345         [openSelectionString release];
 346         openSelectionString = nil;
 347     }
 348 }
 349
 350 - (IBAction)newWindow:(id)sender
 351 {
 352     [self launchVimProcessWithArguments:nil];
 353 }
 354
 355 - (IBAction)selectNextWindow:(id)sender
 356 {
 357     unsigned i, count = [vimControllers count];
 358     if (!count) return;
 359
 360     NSWindow *keyWindow = [NSApp keyWindow];
 361     for (i = 0; i < count; ++i) {
 362         MMVimController *vc = [vimControllers objectAtIndex:i];
 363         if ([[[vc windowController] window] isEqual:keyWindow])
 364             break;
 365     }
 366
 367     if (i < count) {
 368         if (++i >= count)
 369             i = 0;
 370         MMVimController *vc = [vimControllers objectAtIndex:i];
 371         [[vc windowController] showWindow:self];
 372     }
 373 }
 374
 375 - (IBAction)selectPreviousWindow:(id)sender
 376 {
 377     unsigned i, count = [vimControllers count];
 378     if (!count) return;
 379
 380     NSWindow *keyWindow = [NSApp keyWindow];
 381     for (i = 0; i < count; ++i) {
 382         MMVimController *vc = [vimControllers objectAtIndex:i];
 383         if ([[[vc windowController] window] isEqual:keyWindow])
 384             break;
 385     }
 386
 387     if (i < count) {
 388         if (i > 0) {
 389             --i;
 390         } else {
 391             i = count - 1;
 392         }
 393         MMVimController *vc = [vimControllers objectAtIndex:i];
 394         [[vc windowController] showWindow:self];
 395     }
 396 }
 397
 398 - (IBAction)fontSizeUp:(id)sender
 399 {
 400     [[NSFontManager sharedFontManager] modifyFont:
 401             [NSNumber numberWithInt:NSSizeUpFontAction]];
 402 }
 403
 404 - (IBAction)fontSizeDown:(id)sender
 405 {
 406     [[NSFontManager sharedFontManager] modifyFont:
 407             [NSNumber numberWithInt:NSSizeDownFontAction]];
 408 }
 409
 410 - (byref id <MMFrontendProtocol>)
 411     connectBackend:(byref in id <MMBackendProtocol>)backend
 412                pid:(int)pid
 413 {
 414     //NSLog(@"Frontend got connection request from backend...adding new "
 415     //        "MMVimController");
 416
 417     [(NSDistantObject*)backend
 418             setProtocolForProxy:@protocol(MMBackendProtocol)];
 419
 420     MMVimController *vc = [[[MMVimController alloc]
 421             initWithBackend:backend pid:pid] autorelease];
 422
 423     if (![vimControllers count]) {
 424         // The first window autosaves its position.  (The autosaving features
 425         // of Cocoa are not used because we need more control over what is
 426         // autosaved and when it is restored.)
 427         [[vc windowController] setWindowAutosaveKey:MMTopLeftPointKey];
 428     }
 429
 430     [vimControllers addObject:vc];
 431
 432     // HACK!  MacVim does not get activated if it is launched from the
 433     // terminal, so we forcibly activate here unless it is an untitled window
 434     // opening (i.e. MacVim was opened from the Finder).  Untitled windows are
 435     // treated differently, else MacVim would steal the focus if another app
 436     // was activated while the untitled window was loading.
 437     if (!untitledWindowOpening)
 438         [NSApp activateIgnoringOtherApps:YES];
 439
 440     untitledWindowOpening = NO;
 441
 442     return vc;
 443 }
 444
 445 - (NSArray *)serverList
 446 {
 447     NSMutableArray *array = [NSMutableArray array];
 448
 449     unsigned i, count = [vimControllers count];
 450     for (i = 0; i < count; ++i) {
 451         MMVimController *controller = [vimControllers objectAtIndex:i];
 452         if ([controller serverName])
 453             [array addObject:[controller serverName]];
 454     }
 455
 456     return array;
 457 }
 458
 459 @end // MMAppController
 460
 461
 462
 463
 464 @implementation MMAppController (MMServices)
 465
 466 - (void)openSelection:(NSPasteboard *)pboard userData:(NSString *)userData
 467                 error:(NSString **)error
 468 {
 469     if (![[pboard types] containsObject:NSStringPboardType]) {
 470         NSLog(@"WARNING: Pasteboard contains no object of type "
 471                 "NSStringPboardType");
 472         return;
 473     }
 474
 475     MMVimController *vc = [self topmostVimController];
 476     if (vc) {
 477         // Open a new tab first, since dropString: does not do this.
 478         [vc sendMessage:AddNewTabMsgID data:nil];
 479         [vc dropString:[pboard stringForType:NSStringPboardType]];
 480     } else {
 481         // NOTE: There is no window to paste the selection into, so save the
 482         // text, open a new window, and paste the text when the next window
 483         // opens.  (If this is called several times in a row, then all but the
 484         // last call might be ignored.)
 485         if (openSelectionString) [openSelectionString release];
 486         openSelectionString = [[pboard stringForType:NSStringPboardType] copy];
 487
 488         [self newWindow:self];
 489     }
 490 }
 491
 492 - (void)openFile:(NSPasteboard *)pboard userData:(NSString *)userData
 493            error:(NSString **)error
 494 {
 495     if (![[pboard types] containsObject:NSStringPboardType]) {
 496         NSLog(@"WARNING: Pasteboard contains no object of type "
 497                 "NSStringPboardType");
 498         return;
 499     }
 500
 501     // TODO: Parse multiple filenames and create array with names.
 502     NSString *string = [pboard stringForType:NSStringPboardType];
 503     string = [string stringByTrimmingCharactersInSet:
 504             [NSCharacterSet whitespaceAndNewlineCharacterSet]];
 505     string = [string stringByStandardizingPath];
 506
 507     MMVimController *vc = nil;
 508     if (userData && [userData isEqual:@"Tab"])
 509         vc = [self topmostVimController];
 510
 511     if (vc) {
 512         [vc dropFiles:[NSArray arrayWithObject:string]];
 513     } else {
 514         [self application:NSApp openFiles:[NSArray arrayWithObject:string]];
 515     }
 516 }
 517
 518 @end // MMAppController (MMServices)
 519
 520
 521
 522
 523 @implementation MMAppController (Private)
 524
 525 - (MMVimController *)keyVimController
 526 {
 527     NSWindow *keyWindow = [NSApp keyWindow];
 528     if (keyWindow) {
 529         unsigned i, count = [vimControllers count];
 530         for (i = 0; i < count; ++i) {
 531             MMVimController *vc = [vimControllers objectAtIndex:i];
 532             if ([[[vc windowController] window] isEqual:keyWindow])
 533                 return vc;
 534         }
 535     }
 536
 537     return nil;
 538 }
 539
 540 - (MMVimController *)topmostVimController
 541 {
 542     NSArray *windows = [NSApp orderedWindows];
 543     if ([windows count] > 0) {
 544         NSWindow *window = [windows objectAtIndex:0];
 545         unsigned i, count = [vimControllers count];
 546         for (i = 0; i < count; ++i) {
 547             MMVimController *vc = [vimControllers objectAtIndex:i];
 548             if ([[[vc windowController] window] isEqual:window])
 549                 return vc;
 550         }
 551     }
 552
 553     return nil;
 554 }
 555
 556 - (void)launchVimProcessWithArguments:(NSArray *)args
 557 {
 558     NSString *path = [[NSBundle mainBundle] pathForAuxiliaryExecutable:@"Vim"];
 559     if (!path) {
 560         NSLog(@"ERROR: Vim executable could not be found inside app bundle!");
 561         return;
 562     }
 563
 564     NSMutableString *execArg = [NSMutableString
 565         stringWithFormat:@"exec \"%@\" -g", path];
 566     if (args) {
 567         // Append all arguments while making sure that arguments containing
 568         // spaces are enclosed in quotes.
 569         NSCharacterSet *space = [NSCharacterSet whitespaceCharacterSet];
 570         unsigned i, count = [args count];
 571
 572         for (i = 0; i < count; ++i) {
 573             NSString *arg = [args objectAtIndex:i];
 574             if (NSNotFound != [arg rangeOfCharacterFromSet:space].location)
 575                 [execArg appendFormat:@" \"%@\"", arg];
 576             else
 577                 [execArg appendFormat:@" %@", arg];
 578         }
 579     }
 580
 581     // Launch the process with a login shell so that users environment settings
 582     // get sourced.  This does not always happen when MacVim is started.
 583     NSArray *shellArgs = [NSArray arrayWithObjects:@"-l", @"-c", execArg, nil];
 584     NSString *shell = [[[NSProcessInfo processInfo] environment]
 585         objectForKey:@"SHELL"];
 586     if (!shell)
 587         shell = @"/bin/sh";
 588
 589     //NSLog(@"Launching: %@  args: %@", shell, shellArgs);
 590     [NSTask launchedTaskWithLaunchPath:shell arguments:shellArgs];
 591 }
 592
 593 @end // MMAppController (Private)
 594
 595
 596
 597
 598 @implementation NSMenu (MMExtras)
 599
 600 - (void)recurseSetAutoenablesItems:(BOOL)on
 601 {
 602     [self setAutoenablesItems:on];
 603
 604     int i, count = [self numberOfItems];
 605     for (i = 0; i < count; ++i) {
 606         NSMenuItem *item = [self itemAtIndex:i];
 607         [item setEnabled:YES];
 608         NSMenu *submenu = [item submenu];
 609         if (submenu) {
 610             [submenu recurseSetAutoenablesItems:on];
 611         }
 612     }
 613 }
 614
 615 @end  // NSMenu (MMExtras)
 616
 617
 618
 619
 620 @implementation NSNumber (MMExtras)
 621 - (int)tag
 622 {
 623     return [self intValue];
 624 }
 625 @end // NSNumber (MMExtras)