src/MacVim/MMTextViewHelper.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  * MMTextViewHelper
  12  *
  13  * Contains code shared between the different text renderers.  Unfortunately it
  14  * is not possible to let the text renderers inherit from this class since
  15  * MMTextView needs to inherit from NSTextView whereas MMAtsuiTextView needs to
  16  * inherit from NSView.
  17  */
  18
  19 #import "MMTextView.h"
  20 #import "MMTextViewHelper.h"
  21 #import "MMVimController.h"
  22 #import "MMWindowController.h"
  23 #import "Miscellaneous.h"
  24
  25
  26 static char MMKeypadEnter[2] = { 'K', 'A' };
  27 static NSString *MMKeypadEnterString = @"KA";
  28
  29 // The max/min drag timer interval in seconds
  30 static NSTimeInterval MMDragTimerMaxInterval = 0.3;
  31 static NSTimeInterval MMDragTimerMinInterval = 0.01;
  32
  33 // The number of pixels in which the drag timer interval changes
  34 static float MMDragAreaSize = 73.0f;
  35
  36
  37 @interface MMTextViewHelper (Private)
  38 - (MMWindowController *)windowController;
  39 - (MMVimController *)vimController;
  40 - (void)dispatchKeyEvent:(NSEvent *)event;
  41 - (void)sendKeyDown:(const char *)chars length:(int)len modifiers:(int)flags;
  42 - (void)hideMouseCursor;
  43 - (void)startDragTimerWithInterval:(NSTimeInterval)t;
  44 - (void)dragTimerFired:(NSTimer *)timer;
  45 - (void)setCursor;
  46 - (NSRect)trackingRect;
  47 @end
  48
  49
  50 @implementation MMTextViewHelper
  51
  52 - (void)setTextView:(id)view
  53 {
  54     // Only keep a weak reference to owning text view.
  55     textView = view;
  56 }
  57
  58 - (void)keyDown:(NSEvent *)event
  59 {
  60     //NSLog(@"%s %@", _cmd, event);
  61     // HACK! If control modifier is held, don't pass the event along to
  62     // interpretKeyEvents: since some keys are bound to multiple commands which
  63     // means doCommandBySelector: is called several times.  Do the same for
  64     // Alt+Function key presses (Alt+Up and Alt+Down are bound to two
  65     // commands).  This hack may break input management, but unless we can
  66     // figure out a way to disable key bindings there seems little else to do.
  67     //
  68     // TODO: Figure out a way to disable Cocoa key bindings entirely, without
  69     // affecting input management.
  70
  71     // When the Input Method is activated, some special key inputs
  72     // should be treated as key inputs for Input Method.
  73     if ([textView hasMarkedText]) {
  74         [textView interpretKeyEvents:[NSArray arrayWithObject:event]];
  75         [textView setNeedsDisplay:YES];
  76         return;
  77     }
  78
  79     int flags = [event modifierFlags];
  80     if ((flags & NSControlKeyMask) ||
  81             ((flags & NSAlternateKeyMask) && (flags & NSFunctionKeyMask))) {
  82         NSString *unmod = [event charactersIgnoringModifiers];
  83         if ([unmod length] == 1 && [unmod characterAtIndex:0] <= 0x7f
  84                                 && [unmod characterAtIndex:0] >= 0x60) {
  85             // HACK! Send Ctrl-letter keys (and C-@, C-[, C-\, C-], C-^, C-_)
  86             // as normal text to be added to the Vim input buffer.  This must
  87             // be done in order for the backend to be able to separate e.g.
  88             // Ctrl-i and Ctrl-tab.
  89             [self insertText:[event characters]];
  90         } else {
  91             [self dispatchKeyEvent:event];
  92         }
  93     } else {
  94         [textView interpretKeyEvents:[NSArray arrayWithObject:event]];
  95     }
  96 }
  97
  98 - (void)insertText:(id)string
  99 {
 100     //NSLog(@"%s %@", _cmd, string);
 101     // NOTE!  This method is called for normal key presses but also for
 102     // Option-key presses --- even when Ctrl is held as well as Option.  When
 103     // Ctrl is held, the AppKit translates the character to a Ctrl+key stroke,
 104     // so 'string' need not be a printable character!  In this case it still
 105     // works to pass 'string' on to Vim as a printable character (since
 106     // modifiers are already included and should not be added to the input
 107     // buffer using CSI, K_MODIFIER).
 108
 109     if ([textView hasMarkedText]) {
 110         [textView unmarkText];
 111     }
 112
 113     NSEvent *event = [NSApp currentEvent];
 114
 115     // HACK!  In order to be able to bind to <S-Space>, <S-M-Tab>, etc. we have
 116     // to watch for them here.
 117     if ([event type] == NSKeyDown
 118             && [[event charactersIgnoringModifiers] length] > 0
 119             && [event modifierFlags]
 120                 & (NSShiftKeyMask|NSControlKeyMask|NSAlternateKeyMask)) {
 121         unichar c = [[event charactersIgnoringModifiers] characterAtIndex:0];
 122
 123         // <S-M-Tab> translates to 0x19
 124         if (' ' == c || 0x19 == c) {
 125             [self dispatchKeyEvent:event];
 126             return;
 127         }
 128     }
 129
 130     [self hideMouseCursor];
 131
 132     // NOTE: 'string' is either an NSString or an NSAttributedString.  Since we
 133     // do not support attributes, simply pass the corresponding NSString in the
 134     // latter case.
 135     if ([string isKindOfClass:[NSAttributedString class]])
 136         string = [string string];
 137
 138     //NSLog(@"send InsertTextMsgID: %@", string);
 139
 140     [[self vimController] sendMessage:InsertTextMsgID
 141                  data:[string dataUsingEncoding:NSUTF8StringEncoding]];
 142 }
 143
 144 - (void)doCommandBySelector:(SEL)selector
 145 {
 146     //NSLog(@"%s %@", _cmd, NSStringFromSelector(selector));
 147     // By ignoring the selector we effectively disable the key binding
 148     // mechanism of Cocoa.  Hopefully this is what the user will expect
 149     // (pressing Ctrl+P would otherwise result in moveUp: instead of previous
 150     // match, etc.).
 151     //
 152     // We usually end up here if the user pressed Ctrl+key (but not
 153     // Ctrl+Option+key).
 154
 155     NSEvent *event = [NSApp currentEvent];
 156
 157     if (selector == @selector(cancelOperation:)
 158             || selector == @selector(insertNewline:)) {
 159         // HACK! If there was marked text which got abandoned as a result of
 160         // hitting escape or enter, then 'insertText:' is called with the
 161         // abandoned text but '[event characters]' includes the abandoned text
 162         // as well.  Since 'dispatchKeyEvent:' looks at '[event characters]' we
 163         // must intercept these keys here or the abandonded text gets inserted
 164         // twice.
 165         NSString *key = [event charactersIgnoringModifiers];
 166         const char *chars = [key UTF8String];
 167         int len = [key lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 168
 169         if (0x3 == chars[0]) {
 170             // HACK! AppKit turns enter (not return) into Ctrl-C, so we need to
 171             // handle it separately (else Ctrl-C doesn't work).
 172             len = sizeof(MMKeypadEnter)/sizeof(MMKeypadEnter[0]);
 173             chars = MMKeypadEnter;
 174         }
 175
 176         [self sendKeyDown:chars length:len modifiers:[event modifierFlags]];
 177     } else {
 178         [self dispatchKeyEvent:event];
 179     }
 180 }
 181
 182 - (BOOL)performKeyEquivalent:(NSEvent *)event
 183 {
 184     //NSLog(@"%s %@", _cmd, event);
 185     // Called for Cmd+key keystrokes, function keys, arrow keys, page
 186     // up/down, home, end.
 187     //
 188     // NOTE: This message cannot be ignored since Cmd+letter keys never are
 189     // passed to keyDown:.  It seems as if the main menu consumes Cmd-key
 190     // strokes, unless the key is a function key.
 191
 192     // NOTE: If the event that triggered this method represents a function key
 193     // down then we do nothing, otherwise the input method never gets the key
 194     // stroke (some input methods use e.g. arrow keys).  The function key down
 195     // event will still reach Vim though (via keyDown:).  The exceptions to
 196     // this rule are: PageUp/PageDown (keycode 116/121).
 197     int flags = [event modifierFlags];
 198     if ([event type] != NSKeyDown || flags & NSFunctionKeyMask
 199             && !(116 == [event keyCode] || 121 == [event keyCode]))
 200         return NO;
 201
 202     // HACK!  KeyCode 50 represent the key which switches between windows
 203     // within an application (like Cmd+Tab is used to switch between
 204     // applications).  Return NO here, else the window switching does not work.
 205     if ([event keyCode] == 50)
 206         return NO;
 207
 208     // HACK!  Let the main menu try to handle any key down event, before
 209     // passing it on to vim, otherwise key equivalents for menus will
 210     // effectively be disabled.
 211     if ([[NSApp mainMenu] performKeyEquivalent:event])
 212         return YES;
 213
 214     // HACK!  On Leopard Ctrl-key events end up here instead of keyDown:.
 215     if (flags & NSControlKeyMask) {
 216         [self keyDown:event];
 217         return YES;
 218     }
 219
 220     // HACK!  Don't handle Cmd-? or the "Help" menu does not work on Leopard.
 221     NSString *unmodchars = [event charactersIgnoringModifiers];
 222     if ([unmodchars isEqual:@"?"])
 223         return NO;
 224
 225     // Cmd-. is hard-wired to send an interrupt (like Ctrl-C).
 226     if ((flags & NSDeviceIndependentModifierFlagsMask) == NSCommandKeyMask &&
 227             [unmodchars isEqual:@"."]) {
 228         [[self vimController] sendMessage:InterruptMsgID data:nil];
 229         return YES;
 230     }
 231
 232     //NSLog(@"%s%@", _cmd, event);
 233
 234     NSString *chars = [event characters];
 235     int len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 236     NSMutableData *data = [NSMutableData data];
 237
 238     if (len <= 0)
 239         return NO;
 240
 241     // If 'chars' and 'unmodchars' differs when shift flag is present, then we
 242     // can clear the shift flag as it is already included in 'unmodchars'.
 243     // Failing to clear the shift flag means <D-Bar> turns into <S-D-Bar> (on
 244     // an English keyboard).
 245     if (flags & NSShiftKeyMask && ![chars isEqual:unmodchars])
 246         flags &= ~NSShiftKeyMask;
 247
 248     if (0x3 == [unmodchars characterAtIndex:0]) {
 249         // HACK! AppKit turns enter (not return) into Ctrl-C, so we need to
 250         // handle it separately (else Cmd-enter turns into Ctrl-C).
 251         unmodchars = MMKeypadEnterString;
 252         len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 253     }
 254
 255     [data appendBytes:&flags length:sizeof(int)];
 256     [data appendBytes:&len length:sizeof(int)];
 257     [data appendBytes:[unmodchars UTF8String] length:len];
 258
 259     [[self vimController] sendMessage:CmdKeyMsgID data:data];
 260
 261     return YES;
 262 }
 263
 264 - (void)scrollWheel:(NSEvent *)event
 265 {
 266     if ([event deltaY] == 0)
 267         return;
 268
 269     int row, col;
 270     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 271     if ([textView convertPoint:pt toRow:&row column:&col]) {
 272         int flags = [event modifierFlags];
 273         float dy = [event deltaY];
 274         NSMutableData *data = [NSMutableData data];
 275
 276         [data appendBytes:&row length:sizeof(int)];
 277         [data appendBytes:&col length:sizeof(int)];
 278         [data appendBytes:&flags length:sizeof(int)];
 279         [data appendBytes:&dy length:sizeof(float)];
 280
 281         [[self vimController] sendMessage:ScrollWheelMsgID data:data];
 282     }
 283 }
 284
 285 - (void)mouseDown:(NSEvent *)event
 286 {
 287     int row, col;
 288     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 289     if (![textView convertPoint:pt toRow:&row column:&col])
 290         return;
 291
 292     int button = [event buttonNumber];
 293     int flags = [event modifierFlags];
 294     int count = [event clickCount];
 295     NSMutableData *data = [NSMutableData data];
 296
 297     // If desired, intepret Ctrl-Click as a right mouse click.
 298     BOOL translateCtrlClick = [[NSUserDefaults standardUserDefaults]
 299             boolForKey:MMTranslateCtrlClickKey];
 300     flags = flags & NSDeviceIndependentModifierFlagsMask;
 301     if (translateCtrlClick && button == 0 &&
 302             (flags == NSControlKeyMask ||
 303              flags == (NSControlKeyMask|NSAlphaShiftKeyMask))) {
 304         button = 1;
 305         flags &= ~NSControlKeyMask;
 306     }
 307
 308     [data appendBytes:&row length:sizeof(int)];
 309     [data appendBytes:&col length:sizeof(int)];
 310     [data appendBytes:&button length:sizeof(int)];
 311     [data appendBytes:&flags length:sizeof(int)];
 312     [data appendBytes:&count length:sizeof(int)];
 313
 314     [[self vimController] sendMessage:MouseDownMsgID data:data];
 315 }
 316
 317 - (void)mouseUp:(NSEvent *)event
 318 {
 319     int row, col;
 320     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 321     if (![textView convertPoint:pt toRow:&row column:&col])
 322         return;
 323
 324     int flags = [event modifierFlags];
 325     NSMutableData *data = [NSMutableData data];
 326
 327     [data appendBytes:&row length:sizeof(int)];
 328     [data appendBytes:&col length:sizeof(int)];
 329     [data appendBytes:&flags length:sizeof(int)];
 330
 331     [[self vimController] sendMessage:MouseUpMsgID data:data];
 332
 333     isDragging = NO;
 334 }
 335
 336 - (void)mouseDragged:(NSEvent *)event
 337 {
 338     int flags = [event modifierFlags];
 339     int row, col;
 340     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 341     if (![textView convertPoint:pt toRow:&row column:&col])
 342         return;
 343
 344     // Autoscrolling is done in dragTimerFired:
 345     if (!isAutoscrolling) {
 346         NSMutableData *data = [NSMutableData data];
 347
 348         [data appendBytes:&row length:sizeof(int)];
 349         [data appendBytes:&col length:sizeof(int)];
 350         [data appendBytes:&flags length:sizeof(int)];
 351
 352         [[self vimController] sendMessage:MouseDraggedMsgID data:data];
 353     }
 354
 355     dragPoint = pt;
 356     dragRow = row;
 357     dragColumn = col;
 358     dragFlags = flags;
 359
 360     if (!isDragging) {
 361         [self startDragTimerWithInterval:.5];
 362         isDragging = YES;
 363     }
 364 }
 365
 366 - (void)mouseMoved:(NSEvent *)event
 367 {
 368     // HACK! NSTextView has a nasty habit of resetting the cursor to the
 369     // default I-beam cursor at random moments.  The only reliable way we know
 370     // of to work around this is to set the cursor each time the mouse moves.
 371     [self setCursor];
 372
 373     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 374     int row, col;
 375     if (![textView convertPoint:pt toRow:&row column:&col])
 376         return;
 377
 378     // HACK! It seems impossible to get the tracking rects set up before the
 379     // view is visible, which means that the first mouseEntered: or
 380     // mouseExited: events are never received.  This forces us to check if the
 381     // mouseMoved: event really happened over the text.
 382     int rows, cols;
 383     [textView getMaxRows:&rows columns:&cols];
 384     if (row >= 0 && row < rows && col >= 0 && col < cols) {
 385         NSMutableData *data = [NSMutableData data];
 386
 387         [data appendBytes:&row length:sizeof(int)];
 388         [data appendBytes:&col length:sizeof(int)];
 389
 390         [[self vimController] sendMessage:MouseMovedMsgID data:data];
 391
 392         //NSLog(@"Moved %d %d\n", col, row);
 393     }
 394 }
 395
 396 - (void)mouseEntered:(NSEvent *)event
 397 {
 398     //NSLog(@"%s", _cmd);
 399
 400     // NOTE: This event is received even when the window is not key; thus we
 401     // have to take care not to enable mouse moved events unless our window is
 402     // key.
 403     if ([[textView window] isKeyWindow]) {
 404         [[textView window] setAcceptsMouseMovedEvents:YES];
 405     }
 406 }
 407
 408 - (void)mouseExited:(NSEvent *)event
 409 {
 410     //NSLog(@"%s", _cmd);
 411
 412     [[textView window] setAcceptsMouseMovedEvents:NO];
 413
 414     // NOTE: This event is received even when the window is not key; if the
 415     // mouse shape is set when our window is not key, the hollow (unfocused)
 416     // cursor will become a block (focused) cursor.
 417     if ([[textView window] isKeyWindow]) {
 418         int shape = 0;
 419         NSMutableData *data = [NSMutableData data];
 420         [data appendBytes:&shape length:sizeof(int)];
 421         [[self vimController] sendMessage:SetMouseShapeMsgID data:data];
 422     }
 423 }
 424
 425 - (void)setFrame:(NSRect)frame
 426 {
 427     //NSLog(@"%s", _cmd);
 428
 429     // When the frame changes we also need to update the tracking rect.
 430     [textView removeTrackingRect:trackingRectTag];
 431     trackingRectTag = [textView addTrackingRect:[self trackingRect]
 432                                           owner:textView
 433                                        userData:NULL
 434                                    assumeInside:YES];
 435 }
 436
 437 - (void)viewDidMoveToWindow
 438 {
 439     //NSLog(@"%s (window=%@)", _cmd, [self window]);
 440
 441     // Set a tracking rect which covers the text.
 442     // NOTE: While the mouse cursor is in this rect the view will receive
 443     // 'mouseMoved:' events so that Vim can take care of updating the mouse
 444     // cursor.
 445     if ([textView window]) {
 446         [[textView window] setAcceptsMouseMovedEvents:YES];
 447         trackingRectTag = [textView addTrackingRect:[self trackingRect]
 448                                               owner:textView
 449                                            userData:NULL
 450                                        assumeInside:YES];
 451     }
 452 }
 453
 454 - (void)viewWillMoveToWindow:(NSWindow *)newWindow
 455 {
 456     //NSLog(@"%s%@", _cmd, newWindow);
 457
 458     // Remove tracking rect if view moves or is removed.
 459     if ([textView window] && trackingRectTag) {
 460         [textView removeTrackingRect:trackingRectTag];
 461         trackingRectTag = 0;
 462     }
 463 }
 464
 465 - (BOOL)performDragOperation:(id <NSDraggingInfo>)sender
 466 {
 467     NSPasteboard *pboard = [sender draggingPasteboard];
 468
 469     if ([[pboard types] containsObject:NSStringPboardType]) {
 470         NSString *string = [pboard stringForType:NSStringPboardType];
 471         [[self vimController] dropString:string];
 472         return YES;
 473     } else if ([[pboard types] containsObject:NSFilenamesPboardType]) {
 474         NSArray *files = [pboard propertyListForType:NSFilenamesPboardType];
 475         [[self vimController] dropFiles:files forceOpen:NO];
 476         return YES;
 477     }
 478
 479     return NO;
 480 }
 481
 482 - (NSDragOperation)draggingEntered:(id <NSDraggingInfo>)sender
 483 {
 484     NSDragOperation sourceDragMask = [sender draggingSourceOperationMask];
 485     NSPasteboard *pboard = [sender draggingPasteboard];
 486
 487     if ( [[pboard types] containsObject:NSFilenamesPboardType]
 488             && (sourceDragMask & NSDragOperationCopy) )
 489         return NSDragOperationCopy;
 490     if ( [[pboard types] containsObject:NSStringPboardType]
 491             && (sourceDragMask & NSDragOperationCopy) )
 492         return NSDragOperationCopy;
 493
 494     return NSDragOperationNone;
 495 }
 496
 497 - (NSDragOperation)draggingUpdated:(id <NSDraggingInfo>)sender
 498 {
 499     NSDragOperation sourceDragMask = [sender draggingSourceOperationMask];
 500     NSPasteboard *pboard = [sender draggingPasteboard];
 501
 502     if ( [[pboard types] containsObject:NSFilenamesPboardType]
 503             && (sourceDragMask & NSDragOperationCopy) )
 504         return NSDragOperationCopy;
 505     if ( [[pboard types] containsObject:NSStringPboardType]
 506             && (sourceDragMask & NSDragOperationCopy) )
 507         return NSDragOperationCopy;
 508
 509     return NSDragOperationNone;
 510 }
 511
 512 - (void)setMouseShape:(int)shape
 513 {
 514     mouseShape = shape;
 515     [self setCursor];
 516 }
 517
 518 @end // MMTextViewHelper
 519
 520
 521
 522
 523 @implementation MMTextViewHelper (Private)
 524
 525 - (MMWindowController *)windowController
 526 {
 527     id windowController = [[textView window] windowController];
 528     if ([windowController isKindOfClass:[MMWindowController class]])
 529         return (MMWindowController*)windowController;
 530     return nil;
 531 }
 532
 533 - (MMVimController *)vimController
 534 {
 535     return [[self windowController] vimController];
 536 }
 537
 538 - (void)dispatchKeyEvent:(NSEvent *)event
 539 {
 540     // Only handle the command if it came from a keyDown event
 541     if ([event type] != NSKeyDown)
 542         return;
 543
 544     NSString *chars = [event characters];
 545     NSString *unmodchars = [event charactersIgnoringModifiers];
 546     unichar c = [chars characterAtIndex:0];
 547     unichar imc = [unmodchars characterAtIndex:0];
 548     int len = 0;
 549     const char *bytes = 0;
 550     int mods = [event modifierFlags];
 551
 552     //NSLog(@"%s chars[0]=0x%x unmodchars[0]=0x%x (chars=%@ unmodchars=%@)",
 553     //        _cmd, c, imc, chars, unmodchars);
 554
 555     if (' ' == imc && 0xa0 != c) {
 556         // HACK!  The AppKit turns <C-Space> into <C-@> which is not standard
 557         // Vim behaviour, so bypass this problem.  (0xa0 is <M-Space>, which
 558         // should be passed on as is.)
 559         len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 560         bytes = [unmodchars UTF8String];
 561     } else if (imc == c && '2' == c) {
 562         // HACK!  Translate Ctrl+2 to <C-@>.
 563         static char ctrl_at = 0;
 564         len = 1;  bytes = &ctrl_at;
 565     } else if (imc == c && '6' == c) {
 566         // HACK!  Translate Ctrl+6 to <C-^>.
 567         static char ctrl_hat = 0x1e;
 568         len = 1;  bytes = &ctrl_hat;
 569     } else if (c == 0x19 && imc == 0x19) {
 570         // HACK! AppKit turns back tab into Ctrl-Y, so we need to handle it
 571         // separately (else Ctrl-Y doesn't work).
 572         static char tab = 0x9;
 573         len = 1;  bytes = &tab;  mods |= NSShiftKeyMask;
 574     } else {
 575         len = [chars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 576         bytes = [chars UTF8String];
 577     }
 578
 579     [self sendKeyDown:bytes length:len modifiers:mods];
 580 }
 581
 582 - (void)sendKeyDown:(const char *)chars length:(int)len modifiers:(int)flags
 583 {
 584     if (chars && len > 0) {
 585         NSMutableData *data = [NSMutableData data];
 586
 587         [data appendBytes:&flags length:sizeof(int)];
 588         [data appendBytes:&len length:sizeof(int)];
 589         [data appendBytes:chars length:len];
 590
 591         [self hideMouseCursor];
 592
 593         //NSLog(@"%s len=%d chars=0x%x", _cmd, len, chars[0]);
 594         [[self vimController] sendMessage:KeyDownMsgID data:data];
 595     }
 596 }
 597
 598 - (void)hideMouseCursor
 599 {
 600     // Check 'mousehide' option
 601     id mh = [[[self vimController] vimState] objectForKey:@"p_mh"];
 602     if (mh && ![mh boolValue])
 603         [NSCursor setHiddenUntilMouseMoves:NO];
 604     else
 605         [NSCursor setHiddenUntilMouseMoves:YES];
 606 }
 607
 608 - (void)startDragTimerWithInterval:(NSTimeInterval)t
 609 {
 610     [NSTimer scheduledTimerWithTimeInterval:t target:self
 611                                    selector:@selector(dragTimerFired:)
 612                                    userInfo:nil repeats:NO];
 613 }
 614
 615 - (void)dragTimerFired:(NSTimer *)timer
 616 {
 617     // TODO: Autoscroll in horizontal direction?
 618     static unsigned tick = 1;
 619
 620     isAutoscrolling = NO;
 621
 622     if (isDragging && (dragRow < 0 || dragRow >= [textView maxRows])) {
 623         // HACK! If the mouse cursor is outside the text area, then send a
 624         // dragged event.  However, if row&col hasn't changed since the last
 625         // dragged event, Vim won't do anything (see gui_send_mouse_event()).
 626         // Thus we fiddle with the column to make sure something happens.
 627         int col = dragColumn + (dragRow < 0 ? -(tick % 2) : +(tick % 2));
 628         NSMutableData *data = [NSMutableData data];
 629
 630         [data appendBytes:&dragRow length:sizeof(int)];
 631         [data appendBytes:&col length:sizeof(int)];
 632         [data appendBytes:&dragFlags length:sizeof(int)];
 633
 634         [[self vimController] sendMessage:MouseDraggedMsgID data:data];
 635
 636         isAutoscrolling = YES;
 637     }
 638
 639     if (isDragging) {
 640         // Compute timer interval depending on how far away the mouse cursor is
 641         // from the text view.
 642         NSRect rect = [self trackingRect];
 643         float dy = 0;
 644         if (dragPoint.y < rect.origin.y) dy = rect.origin.y - dragPoint.y;
 645         else if (dragPoint.y > NSMaxY(rect)) dy = dragPoint.y - NSMaxY(rect);
 646         if (dy > MMDragAreaSize) dy = MMDragAreaSize;
 647
 648         NSTimeInterval t = MMDragTimerMaxInterval -
 649             dy*(MMDragTimerMaxInterval-MMDragTimerMinInterval)/MMDragAreaSize;
 650
 651         [self startDragTimerWithInterval:t];
 652     }
 653
 654     ++tick;
 655 }
 656
 657 - (void)setCursor
 658 {
 659     static NSCursor *customIbeamCursor = nil;
 660
 661     if (!customIbeamCursor) {
 662         // Use a custom Ibeam cursor that has better contrast against dark
 663         // backgrounds.
 664         // TODO: Is the hotspot ok?
 665         NSImage *ibeamImage = [NSImage imageNamed:@"ibeam"];
 666         if (ibeamImage) {
 667             NSSize size = [ibeamImage size];
 668             NSPoint hotSpot = { size.width*.5f, size.height*.5f };
 669
 670             customIbeamCursor = [[NSCursor alloc]
 671                     initWithImage:ibeamImage hotSpot:hotSpot];
 672         }
 673         if (!customIbeamCursor) {
 674             NSLog(@"WARNING: Failed to load custom Ibeam cursor");
 675             customIbeamCursor = [NSCursor IBeamCursor];
 676         }
 677     }
 678
 679     // This switch should match mshape_names[] in misc2.c.
 680     //
 681     // TODO: Add missing cursor shapes.
 682     switch (mouseShape) {
 683         case 2: [customIbeamCursor set]; break;
 684         case 3: case 4: [[NSCursor resizeUpDownCursor] set]; break;
 685         case 5: case 6: [[NSCursor resizeLeftRightCursor] set]; break;
 686         case 9: [[NSCursor crosshairCursor] set]; break;
 687         case 10: [[NSCursor pointingHandCursor] set]; break;
 688         case 11: [[NSCursor openHandCursor] set]; break;
 689         default:
 690             [[NSCursor arrowCursor] set]; break;
 691     }
 692
 693     // Shape 1 indicates that the mouse cursor should be hidden.
 694     if (1 == mouseShape)
 695         [NSCursor setHiddenUntilMouseMoves:YES];
 696 }
 697
 698 - (NSRect)trackingRect
 699 {
 700     NSRect rect = [textView frame];
 701     NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
 702     int left = [ud integerForKey:MMTextInsetLeftKey];
 703     int top = [ud integerForKey:MMTextInsetTopKey];
 704     int right = [ud integerForKey:MMTextInsetRightKey];
 705     int bot = [ud integerForKey:MMTextInsetBottomKey];
 706
 707     rect.origin.x = left;
 708     rect.origin.y = top;
 709     rect.size.width -= left + right - 1;
 710     rect.size.height -= top + bot - 1;
 711
 712     return rect;
 713 }
 714
 715 @end // MMTextViewHelper (Private)