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           isARepeat:(BOOL)isARepeat;
  43 - (void)hideMouseCursor;
  44 - (void)startDragTimerWithInterval:(NSTimeInterval)t;
  45 - (void)dragTimerFired:(NSTimer *)timer;
  46 - (void)setCursor;
  47 - (NSRect)trackingRect;
  48 @end
  49
  50
  51 @implementation MMTextViewHelper
  52
  53 - (void)dealloc
  54 {
  55     [insertionPointColor release];  insertionPointColor = nil;
  56     [markedText release];  markedText = nil;
  57     [markedTextAttributes release];  markedTextAttributes = nil;
  58
  59     [super dealloc];
  60 }
  61
  62 - (void)setTextView:(id)view
  63 {
  64     // Only keep a weak reference to owning text view.
  65     textView = view;
  66 }
  67
  68 - (void)setInsertionPointColor:(NSColor *)color
  69 {
  70     if (color != insertionPointColor) {
  71         [insertionPointColor release];
  72         insertionPointColor = [color retain];
  73     }
  74 }
  75
  76 - (NSColor *)insertionPointColor
  77 {
  78     return insertionPointColor;
  79 }
  80
  81 - (void)keyDown:(NSEvent *)event
  82 {
  83     //NSLog(@"%s %@", _cmd, event);
  84     // HACK! If control modifier is held, don't pass the event along to
  85     // interpretKeyEvents: since some keys are bound to multiple commands which
  86     // means doCommandBySelector: is called several times.  Do the same for
  87     // Alt+Function key presses (Alt+Up and Alt+Down are bound to two
  88     // commands).  This hack may break input management, but unless we can
  89     // figure out a way to disable key bindings there seems little else to do.
  90     //
  91     // TODO: Figure out a way to disable Cocoa key bindings entirely, without
  92     // affecting input management.
  93
  94     // When the Input Method is activated, some special key inputs
  95     // should be treated as key inputs for Input Method.
  96     if ([textView hasMarkedText]) {
  97         [textView interpretKeyEvents:[NSArray arrayWithObject:event]];
  98         [textView setNeedsDisplay:YES];
  99         return;
 100     }
 101
 102     int flags = [event modifierFlags];
 103     if ((flags & NSControlKeyMask) ||
 104             ((flags & NSAlternateKeyMask) && (flags & NSFunctionKeyMask))) {
 105         NSString *chars = [event characters];
 106         if ([chars length] == 1 && [chars characterAtIndex:0] < 0x20) {
 107             // HACK! Send unprintable characters (such as C-@, C-[, C-\, C-],
 108             // C-^, C-_) as normal text to be added to the Vim input buffer.
 109             // This must be done in order for the backend to be able to
 110             // separate e.g. Ctrl-i and Ctrl-tab.
 111             [self insertText:chars];
 112         } else {
 113             [self dispatchKeyEvent:event];
 114         }
 115     } else if ((flags & NSAlternateKeyMask) &&
 116             [[[[self vimController] vimState] objectForKey:@"p_mmta"]
 117                                                                 boolValue]) {
 118         // If the 'macmeta' option is set, then send Alt+key presses directly
 119         // to Vim without interpreting the key press.
 120         NSString *unmod = [event charactersIgnoringModifiers];
 121         int len = [unmod lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 122         const char *bytes = [unmod UTF8String];
 123
 124         [self sendKeyDown:bytes length:len modifiers:flags
 125                 isARepeat:[event isARepeat]];
 126     } else {
 127         [textView interpretKeyEvents:[NSArray arrayWithObject:event]];
 128     }
 129 }
 130
 131 - (void)insertText:(id)string
 132 {
 133     //NSLog(@"%s %@", _cmd, string);
 134     // NOTE!  This method is called for normal key presses but also for
 135     // Option-key presses --- even when Ctrl is held as well as Option.  When
 136     // Ctrl is held, the AppKit translates the character to a Ctrl+key stroke,
 137     // so 'string' need not be a printable character!  In this case it still
 138     // works to pass 'string' on to Vim as a printable character (since
 139     // modifiers are already included and should not be added to the input
 140     // buffer using CSI, K_MODIFIER).
 141
 142     if ([textView hasMarkedText]) {
 143         [textView unmarkText];
 144     }
 145
 146     NSEvent *event = [NSApp currentEvent];
 147
 148     // HACK!  In order to be able to bind to <S-Space>, <S-M-Tab>, etc. we have
 149     // to watch for them here.
 150     if ([event type] == NSKeyDown
 151             && [[event charactersIgnoringModifiers] length] > 0
 152             && [event modifierFlags]
 153                 & (NSShiftKeyMask|NSControlKeyMask|NSAlternateKeyMask)) {
 154         unichar c = [[event charactersIgnoringModifiers] characterAtIndex:0];
 155
 156         // <S-M-Tab> translates to 0x19
 157         if (' ' == c || 0x19 == c) {
 158             [self dispatchKeyEvent:event];
 159             return;
 160         }
 161     }
 162
 163     [self hideMouseCursor];
 164
 165     // NOTE: 'string' is either an NSString or an NSAttributedString.  Since we
 166     // do not support attributes, simply pass the corresponding NSString in the
 167     // latter case.
 168     if ([string isKindOfClass:[NSAttributedString class]])
 169         string = [string string];
 170
 171     //NSLog(@"send InsertTextMsgID: %@", string);
 172
 173     NSMutableData *data = [NSMutableData data];
 174     int len = [string lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 175     int flags = [event modifierFlags] & 0xffff0000U;
 176     if ([event type] == NSKeyDown && [event isARepeat])
 177         flags |= 1;
 178
 179     [data appendBytes:&flags length:sizeof(int)];
 180     [data appendBytes:&len length:sizeof(int)];
 181     [data appendBytes:[string UTF8String] length:len];
 182
 183     [[self vimController] sendMessage:InsertTextMsgID data:data];
 184 }
 185
 186 - (void)doCommandBySelector:(SEL)selector
 187 {
 188     //NSLog(@"%s %@", _cmd, NSStringFromSelector(selector));
 189     // By ignoring the selector we effectively disable the key binding
 190     // mechanism of Cocoa.  Hopefully this is what the user will expect
 191     // (pressing Ctrl+P would otherwise result in moveUp: instead of previous
 192     // match, etc.).
 193     //
 194     // We usually end up here if the user pressed Ctrl+key (but not
 195     // Ctrl+Option+key).
 196
 197     NSEvent *event = [NSApp currentEvent];
 198
 199     if (selector == @selector(cancelOperation:)
 200             || selector == @selector(insertNewline:)) {
 201         // HACK! If there was marked text which got abandoned as a result of
 202         // hitting escape or enter, then 'insertText:' is called with the
 203         // abandoned text but '[event characters]' includes the abandoned text
 204         // as well.  Since 'dispatchKeyEvent:' looks at '[event characters]' we
 205         // must intercept these keys here or the abandonded text gets inserted
 206         // twice.
 207         NSString *key = [event charactersIgnoringModifiers];
 208         const char *chars = [key UTF8String];
 209         int len = [key lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 210
 211         if (0x3 == chars[0]) {
 212             // HACK! AppKit turns enter (not return) into Ctrl-C, so we need to
 213             // handle it separately (else Ctrl-C doesn't work).
 214             len = sizeof(MMKeypadEnter)/sizeof(MMKeypadEnter[0]);
 215             chars = MMKeypadEnter;
 216         }
 217
 218         [self sendKeyDown:chars length:len modifiers:[event modifierFlags]
 219                 isARepeat:[event isARepeat]];
 220     } else {
 221         [self dispatchKeyEvent:event];
 222     }
 223 }
 224
 225 - (BOOL)performKeyEquivalent:(NSEvent *)event
 226 {
 227     //NSLog(@"%s %@", _cmd, event);
 228     // Called for Cmd+key keystrokes, function keys, arrow keys, page
 229     // up/down, home, end.
 230     //
 231     // NOTE: This message cannot be ignored since Cmd+letter keys never are
 232     // passed to keyDown:.  It seems as if the main menu consumes Cmd-key
 233     // strokes, unless the key is a function key.
 234
 235     // NOTE: If the event that triggered this method represents a function key
 236     // down then we do nothing, otherwise the input method never gets the key
 237     // stroke (some input methods use e.g. arrow keys).  The function key down
 238     // event will still reach Vim though (via keyDown:).  The exceptions to
 239     // this rule are: PageUp/PageDown (keycode 116/121).
 240     int flags = [event modifierFlags] & 0xffff0000U;
 241     if ([event type] != NSKeyDown || flags & NSFunctionKeyMask
 242             && !(116 == [event keyCode] || 121 == [event keyCode]))
 243         return NO;
 244
 245     // HACK!  KeyCode 50 represent the key which switches between windows
 246     // within an application (like Cmd+Tab is used to switch between
 247     // applications).  Return NO here, else the window switching does not work.
 248     if ([event keyCode] == 50)
 249         return NO;
 250
 251     // HACK!  Let the main menu try to handle any key down event, before
 252     // passing it on to vim, otherwise key equivalents for menus will
 253     // effectively be disabled.
 254     if ([[NSApp mainMenu] performKeyEquivalent:event])
 255         return YES;
 256
 257     // HACK!  On Leopard Ctrl-key events end up here instead of keyDown:.
 258     if (flags & NSControlKeyMask) {
 259         [self keyDown:event];
 260         return YES;
 261     }
 262
 263     // HACK!  Don't handle Cmd-? or the "Help" menu does not work on Leopard.
 264     NSString *unmodchars = [event charactersIgnoringModifiers];
 265     if ([unmodchars isEqual:@"?"])
 266         return NO;
 267
 268     // Cmd-. is hard-wired to send SIGINT unlike Ctrl-C which is just another
 269     // key press which Vim has to interpret.  This means that Cmd-. always
 270     // works to interrupt a Vim process whereas Ctrl-C can suffer from problems
 271     // such as dropped DO messages (or if Vim is stuck in a loop without
 272     // checking for keyboard input).
 273     if ((flags & NSDeviceIndependentModifierFlagsMask) == NSCommandKeyMask &&
 274             [unmodchars isEqual:@"."]) {
 275         kill([[self vimController] pid], SIGINT);
 276         return YES;
 277     }
 278
 279     //NSLog(@"%s%@", _cmd, event);
 280
 281     NSString *chars = [event characters];
 282     int len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 283     NSMutableData *data = [NSMutableData data];
 284
 285     if (len <= 0)
 286         return NO;
 287
 288     // If 'chars' and 'unmodchars' differs when shift flag is present, then we
 289     // can clear the shift flag as it is already included in 'unmodchars'.
 290     // Failing to clear the shift flag means <D-Bar> turns into <S-D-Bar> (on
 291     // an English keyboard).
 292     if (flags & NSShiftKeyMask && ![chars isEqual:unmodchars])
 293         flags &= ~NSShiftKeyMask;
 294
 295     if (0x3 == [unmodchars characterAtIndex:0]) {
 296         // HACK! AppKit turns enter (not return) into Ctrl-C, so we need to
 297         // handle it separately (else Cmd-enter turns into Ctrl-C).
 298         unmodchars = MMKeypadEnterString;
 299         len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 300     }
 301
 302     if ([event isARepeat])
 303         flags |= 1;
 304
 305     [data appendBytes:&flags length:sizeof(int)];
 306     [data appendBytes:&len length:sizeof(int)];
 307     [data appendBytes:[unmodchars UTF8String] length:len];
 308
 309     [[self vimController] sendMessage:CmdKeyMsgID data:data];
 310
 311     return YES;
 312 }
 313
 314 - (void)scrollWheel:(NSEvent *)event
 315 {
 316     if ([event deltaY] == 0)
 317         return;
 318
 319     int row, col;
 320     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 321     if ([textView convertPoint:pt toRow:&row column:&col]) {
 322         int flags = [event modifierFlags];
 323         float dy = [event deltaY];
 324         NSMutableData *data = [NSMutableData data];
 325
 326         [data appendBytes:&row length:sizeof(int)];
 327         [data appendBytes:&col length:sizeof(int)];
 328         [data appendBytes:&flags length:sizeof(int)];
 329         [data appendBytes:&dy length:sizeof(float)];
 330
 331         [[self vimController] sendMessage:ScrollWheelMsgID data:data];
 332     }
 333 }
 334
 335 - (void)mouseDown:(NSEvent *)event
 336 {
 337     int row, col;
 338     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 339     if (![textView convertPoint:pt toRow:&row column:&col])
 340         return;
 341
 342     int button = [event buttonNumber];
 343     int flags = [event modifierFlags];
 344     int count = [event clickCount];
 345     NSMutableData *data = [NSMutableData data];
 346
 347     // If desired, intepret Ctrl-Click as a right mouse click.
 348     BOOL translateCtrlClick = [[NSUserDefaults standardUserDefaults]
 349             boolForKey:MMTranslateCtrlClickKey];
 350     flags = flags & NSDeviceIndependentModifierFlagsMask;
 351     if (translateCtrlClick && button == 0 &&
 352             (flags == NSControlKeyMask ||
 353              flags == (NSControlKeyMask|NSAlphaShiftKeyMask))) {
 354         button = 1;
 355         flags &= ~NSControlKeyMask;
 356     }
 357
 358     [data appendBytes:&row length:sizeof(int)];
 359     [data appendBytes:&col length:sizeof(int)];
 360     [data appendBytes:&button length:sizeof(int)];
 361     [data appendBytes:&flags length:sizeof(int)];
 362     [data appendBytes:&count length:sizeof(int)];
 363
 364     [[self vimController] sendMessage:MouseDownMsgID data:data];
 365 }
 366
 367 - (void)mouseUp:(NSEvent *)event
 368 {
 369     int row, col;
 370     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 371     if (![textView convertPoint:pt toRow:&row column:&col])
 372         return;
 373
 374     int flags = [event modifierFlags];
 375     NSMutableData *data = [NSMutableData data];
 376
 377     [data appendBytes:&row length:sizeof(int)];
 378     [data appendBytes:&col length:sizeof(int)];
 379     [data appendBytes:&flags length:sizeof(int)];
 380
 381     [[self vimController] sendMessage:MouseUpMsgID data:data];
 382
 383     isDragging = NO;
 384 }
 385
 386 - (void)mouseDragged:(NSEvent *)event
 387 {
 388     int flags = [event modifierFlags];
 389     int row, col;
 390     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 391     if (![textView convertPoint:pt toRow:&row column:&col])
 392         return;
 393
 394     // Autoscrolling is done in dragTimerFired:
 395     if (!isAutoscrolling) {
 396         NSMutableData *data = [NSMutableData data];
 397
 398         [data appendBytes:&row length:sizeof(int)];
 399         [data appendBytes:&col length:sizeof(int)];
 400         [data appendBytes:&flags length:sizeof(int)];
 401
 402         [[self vimController] sendMessage:MouseDraggedMsgID data:data];
 403     }
 404
 405     dragPoint = pt;
 406     dragRow = row;
 407     dragColumn = col;
 408     dragFlags = flags;
 409
 410     if (!isDragging) {
 411         [self startDragTimerWithInterval:.5];
 412         isDragging = YES;
 413     }
 414 }
 415
 416 - (void)mouseMoved:(NSEvent *)event
 417 {
 418     // HACK! NSTextView has a nasty habit of resetting the cursor to the
 419     // default I-beam cursor at random moments.  The only reliable way we know
 420     // of to work around this is to set the cursor each time the mouse moves.
 421     [self setCursor];
 422
 423     NSPoint pt = [textView convertPoint:[event locationInWindow] fromView:nil];
 424     int row, col;
 425     if (![textView convertPoint:pt toRow:&row column:&col])
 426         return;
 427
 428     // HACK! It seems impossible to get the tracking rects set up before the
 429     // view is visible, which means that the first mouseEntered: or
 430     // mouseExited: events are never received.  This forces us to check if the
 431     // mouseMoved: event really happened over the text.
 432     int rows, cols;
 433     [textView getMaxRows:&rows columns:&cols];
 434     if (row >= 0 && row < rows && col >= 0 && col < cols) {
 435         NSMutableData *data = [NSMutableData data];
 436
 437         [data appendBytes:&row length:sizeof(int)];
 438         [data appendBytes:&col length:sizeof(int)];
 439
 440         [[self vimController] sendMessage:MouseMovedMsgID data:data];
 441
 442         //NSLog(@"Moved %d %d\n", col, row);
 443     }
 444 }
 445
 446 - (void)mouseEntered:(NSEvent *)event
 447 {
 448     //NSLog(@"%s", _cmd);
 449
 450     // NOTE: This event is received even when the window is not key; thus we
 451     // have to take care not to enable mouse moved events unless our window is
 452     // key.
 453     if ([[textView window] isKeyWindow]) {
 454         [[textView window] setAcceptsMouseMovedEvents:YES];
 455     }
 456 }
 457
 458 - (void)mouseExited:(NSEvent *)event
 459 {
 460     //NSLog(@"%s", _cmd);
 461
 462     [[textView window] setAcceptsMouseMovedEvents:NO];
 463
 464     // NOTE: This event is received even when the window is not key; if the
 465     // mouse shape is set when our window is not key, the hollow (unfocused)
 466     // cursor will become a block (focused) cursor.
 467     if ([[textView window] isKeyWindow]) {
 468         int shape = 0;
 469         NSMutableData *data = [NSMutableData data];
 470         [data appendBytes:&shape length:sizeof(int)];
 471         [[self vimController] sendMessage:SetMouseShapeMsgID data:data];
 472     }
 473 }
 474
 475 - (void)setFrame:(NSRect)frame
 476 {
 477     //NSLog(@"%s", _cmd);
 478
 479     // When the frame changes we also need to update the tracking rect.
 480     [textView removeTrackingRect:trackingRectTag];
 481     trackingRectTag = [textView addTrackingRect:[self trackingRect]
 482                                           owner:textView
 483                                        userData:NULL
 484                                    assumeInside:YES];
 485 }
 486
 487 - (void)viewDidMoveToWindow
 488 {
 489     //NSLog(@"%s (window=%@)", _cmd, [self window]);
 490
 491     // Set a tracking rect which covers the text.
 492     // NOTE: While the mouse cursor is in this rect the view will receive
 493     // 'mouseMoved:' events so that Vim can take care of updating the mouse
 494     // cursor.
 495     if ([textView window]) {
 496         [[textView window] setAcceptsMouseMovedEvents:YES];
 497         trackingRectTag = [textView addTrackingRect:[self trackingRect]
 498                                               owner:textView
 499                                            userData:NULL
 500                                        assumeInside:YES];
 501     }
 502 }
 503
 504 - (void)viewWillMoveToWindow:(NSWindow *)newWindow
 505 {
 506     //NSLog(@"%s%@", _cmd, newWindow);
 507
 508     // Remove tracking rect if view moves or is removed.
 509     if ([textView window] && trackingRectTag) {
 510         [textView removeTrackingRect:trackingRectTag];
 511         trackingRectTag = 0;
 512     }
 513 }
 514
 515 - (BOOL)performDragOperation:(id <NSDraggingInfo>)sender
 516 {
 517     NSPasteboard *pboard = [sender draggingPasteboard];
 518
 519     if ([[pboard types] containsObject:NSStringPboardType]) {
 520         NSString *string = [pboard stringForType:NSStringPboardType];
 521         [[self vimController] dropString:string];
 522         return YES;
 523     } else if ([[pboard types] containsObject:NSFilenamesPboardType]) {
 524         NSArray *files = [pboard propertyListForType:NSFilenamesPboardType];
 525         [[self vimController] dropFiles:files forceOpen:NO];
 526         return YES;
 527     }
 528
 529     return NO;
 530 }
 531
 532 - (NSDragOperation)draggingEntered:(id <NSDraggingInfo>)sender
 533 {
 534     NSDragOperation sourceDragMask = [sender draggingSourceOperationMask];
 535     NSPasteboard *pboard = [sender draggingPasteboard];
 536
 537     if ( [[pboard types] containsObject:NSFilenamesPboardType]
 538             && (sourceDragMask & NSDragOperationCopy) )
 539         return NSDragOperationCopy;
 540     if ( [[pboard types] containsObject:NSStringPboardType]
 541             && (sourceDragMask & NSDragOperationCopy) )
 542         return NSDragOperationCopy;
 543
 544     return NSDragOperationNone;
 545 }
 546
 547 - (NSDragOperation)draggingUpdated:(id <NSDraggingInfo>)sender
 548 {
 549     NSDragOperation sourceDragMask = [sender draggingSourceOperationMask];
 550     NSPasteboard *pboard = [sender draggingPasteboard];
 551
 552     if ( [[pboard types] containsObject:NSFilenamesPboardType]
 553             && (sourceDragMask & NSDragOperationCopy) )
 554         return NSDragOperationCopy;
 555     if ( [[pboard types] containsObject:NSStringPboardType]
 556             && (sourceDragMask & NSDragOperationCopy) )
 557         return NSDragOperationCopy;
 558
 559     return NSDragOperationNone;
 560 }
 561
 562 - (void)setMouseShape:(int)shape
 563 {
 564     mouseShape = shape;
 565     [self setCursor];
 566 }
 567
 568 - (BOOL)hasMarkedText
 569 {
 570     return markedRange.length > 0 ? YES : NO;
 571 }
 572
 573 - (NSRange)markedRange
 574 {
 575     if ([self hasMarkedText])
 576         return markedRange;
 577     else
 578         return NSMakeRange(NSNotFound, 0);
 579 }
 580
 581 - (NSDictionary *)markedTextAttributes
 582 {
 583     return markedTextAttributes;
 584 }
 585
 586 - (void)setMarkedTextAttributes:(NSDictionary *)attr
 587 {
 588     if (attr != markedTextAttributes) {
 589         [markedTextAttributes release];
 590         markedTextAttributes = [attr retain];
 591     }
 592 }
 593
 594 - (void)setMarkedText:(id)text selectedRange:(NSRange)range
 595 {
 596     [self unmarkText];
 597
 598     if (!(text && [text length] > 0))
 599         return;
 600
 601     // HACK! Determine if the marked text is wide or normal width.  This seems
 602     // to always use 'wide' when there are both wide and normal width
 603     // characters.
 604     NSString *string = text;
 605     NSFont *theFont = [textView font];
 606     if ([text isKindOfClass:[NSAttributedString class]]) {
 607         theFont = [textView fontWide];
 608         string = [text string];
 609     }
 610
 611     // TODO: Use special colors for marked text.
 612     [self setMarkedTextAttributes:
 613         [NSDictionary dictionaryWithObjectsAndKeys:
 614             theFont, NSFontAttributeName,
 615             [textView defaultBackgroundColor], NSBackgroundColorAttributeName,
 616             [textView defaultForegroundColor], NSForegroundColorAttributeName,
 617             nil]];
 618
 619     markedText = [[NSMutableAttributedString alloc]
 620            initWithString:string
 621                attributes:[self markedTextAttributes]];
 622
 623     markedRange = NSMakeRange(0, [markedText length]);
 624     if (markedRange.length) {
 625         [markedText addAttribute:NSUnderlineStyleAttributeName
 626                            value:[NSNumber numberWithInt:1]
 627                            range:markedRange];
 628     }
 629     imRange = range;
 630     if (range.length) {
 631         [markedText addAttribute:NSUnderlineStyleAttributeName
 632                            value:[NSNumber numberWithInt:2]
 633                            range:range];
 634     }
 635
 636     [textView setNeedsDisplay:YES];
 637 }
 638
 639 - (void)unmarkText
 640 {
 641     imRange = NSMakeRange(0, 0);
 642     markedRange = NSMakeRange(NSNotFound, 0);
 643     [markedText release];
 644     markedText = nil;
 645 }
 646
 647 - (NSMutableAttributedString *)markedText
 648 {
 649     return markedText;
 650 }
 651
 652 - (void)setPreEditRow:(int)row column:(int)col
 653 {
 654     preEditRow = row;
 655     preEditColumn = col;
 656 }
 657
 658 - (int)preEditRow
 659 {
 660     return preEditRow;
 661 }
 662
 663 - (int)preEditColumn
 664 {
 665     return preEditColumn;
 666 }
 667
 668 - (void)setImRange:(NSRange)range
 669 {
 670     imRange = range;
 671 }
 672
 673 - (NSRange)imRange
 674 {
 675     return imRange;
 676 }
 677
 678 - (void)setMarkedRange:(NSRange)range
 679 {
 680     markedRange = range;
 681 }
 682
 683 - (NSRect)firstRectForCharacterRange:(NSRange)range
 684 {
 685     // This method is called when the input manager wants to pop up an
 686     // auxiliary window.  The position where this should be is controlled by
 687     // Vim by sending SetPreEditPositionMsgID so compute a position based on
 688     // the pre-edit (row,column) pair.
 689     int col = preEditColumn;
 690     int row = preEditRow + 1;
 691
 692     NSFont *theFont = [[textView markedTextAttributes]
 693             valueForKey:NSFontAttributeName];
 694     if (theFont == [textView fontWide]) {
 695         col += imRange.location * 2;
 696         if (col >= [textView maxColumns] - 1) {
 697             row += (col / [textView maxColumns]);
 698             col = col % 2 ? col % [textView maxColumns] + 1 :
 699                             col % [textView maxColumns];
 700         }
 701     } else {
 702         col += imRange.location;
 703         if (col >= [textView maxColumns]) {
 704             row += (col / [textView maxColumns]);
 705             col = col % [textView maxColumns];
 706         }
 707     }
 708
 709     NSRect rect = [textView rectForRow:row
 710                                 column:col
 711                                numRows:1
 712                             numColumns:range.length];
 713
 714     rect.origin = [textView convertPoint:rect.origin toView:nil];
 715     rect.origin = [[textView window] convertBaseToScreen:rect.origin];
 716
 717     return rect;
 718 }
 719
 720 @end // MMTextViewHelper
 721
 722
 723
 724
 725 @implementation MMTextViewHelper (Private)
 726
 727 - (MMWindowController *)windowController
 728 {
 729     id windowController = [[textView window] windowController];
 730     if ([windowController isKindOfClass:[MMWindowController class]])
 731         return (MMWindowController*)windowController;
 732     return nil;
 733 }
 734
 735 - (MMVimController *)vimController
 736 {
 737     return [[self windowController] vimController];
 738 }
 739
 740 - (void)dispatchKeyEvent:(NSEvent *)event
 741 {
 742     // Only handle the command if it came from a keyDown event
 743     if ([event type] != NSKeyDown)
 744         return;
 745
 746     NSString *chars = [event characters];
 747     NSString *unmodchars = [event charactersIgnoringModifiers];
 748     unichar c = [chars characterAtIndex:0];
 749     unichar imc = [unmodchars length] > 0 ? [unmodchars characterAtIndex:0] : 0;
 750     int len = 0;
 751     const char *bytes = 0;
 752     int mods = [event modifierFlags];
 753
 754     //NSLog(@"%s chars[0]=0x%x unmodchars[0]=0x%x (chars=%@ unmodchars=%@)",
 755     //        _cmd, c, imc, chars, unmodchars);
 756
 757     if (' ' == imc && 0xa0 != c) {
 758         // HACK!  The AppKit turns <C-Space> into <C-@> which is not standard
 759         // Vim behaviour, so bypass this problem.  (0xa0 is <M-Space>, which
 760         // should be passed on as is.)
 761         len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 762         bytes = [unmodchars UTF8String];
 763     } else if (imc == c && '2' == c) {
 764         // HACK!  Translate Ctrl+2 to <C-@>.
 765         static char ctrl_at = 0;
 766         len = 1;  bytes = &ctrl_at;
 767     } else if (imc == c && '6' == c) {
 768         // HACK!  Translate Ctrl+6 to <C-^>.
 769         static char ctrl_hat = 0x1e;
 770         len = 1;  bytes = &ctrl_hat;
 771     } else if (c == 0x19 && imc == 0x19) {
 772         // HACK! AppKit turns back tab into Ctrl-Y, so we need to handle it
 773         // separately (else Ctrl-Y doesn't work).
 774         static char tab = 0x9;
 775         len = 1;  bytes = &tab;  mods |= NSShiftKeyMask;
 776     } else {
 777         len = [chars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 778         bytes = [chars UTF8String];
 779     }
 780
 781     [self sendKeyDown:bytes length:len modifiers:mods
 782             isARepeat:[event isARepeat]];
 783 }
 784
 785 - (void)sendKeyDown:(const char *)chars length:(int)len modifiers:(int)flags
 786           isARepeat:(BOOL)isARepeat
 787 {
 788     if (chars && len > 0) {
 789         NSMutableData *data = [NSMutableData data];
 790
 791         // The low 16 bits are not used for modifier flags by NSEvent.  Use
 792         // these bits for custom flags.
 793         flags &= 0xffff0000;
 794         if (isARepeat)
 795             flags |= 1;
 796
 797         [data appendBytes:&flags length:sizeof(int)];
 798         [data appendBytes:&len length:sizeof(int)];
 799         [data appendBytes:chars length:len];
 800
 801         [self hideMouseCursor];
 802
 803         //NSLog(@"%s len=%d chars=0x%x", _cmd, len, chars[0]);
 804         [[self vimController] sendMessage:KeyDownMsgID data:data];
 805     }
 806 }
 807
 808 - (void)hideMouseCursor
 809 {
 810     // Check 'mousehide' option
 811     id mh = [[[self vimController] vimState] objectForKey:@"p_mh"];
 812     if (mh && ![mh boolValue])
 813         [NSCursor setHiddenUntilMouseMoves:NO];
 814     else
 815         [NSCursor setHiddenUntilMouseMoves:YES];
 816 }
 817
 818 - (void)startDragTimerWithInterval:(NSTimeInterval)t
 819 {
 820     [NSTimer scheduledTimerWithTimeInterval:t target:self
 821                                    selector:@selector(dragTimerFired:)
 822                                    userInfo:nil repeats:NO];
 823 }
 824
 825 - (void)dragTimerFired:(NSTimer *)timer
 826 {
 827     // TODO: Autoscroll in horizontal direction?
 828     static unsigned tick = 1;
 829
 830     isAutoscrolling = NO;
 831
 832     if (isDragging && (dragRow < 0 || dragRow >= [textView maxRows])) {
 833         // HACK! If the mouse cursor is outside the text area, then send a
 834         // dragged event.  However, if row&col hasn't changed since the last
 835         // dragged event, Vim won't do anything (see gui_send_mouse_event()).
 836         // Thus we fiddle with the column to make sure something happens.
 837         int col = dragColumn + (dragRow < 0 ? -(tick % 2) : +(tick % 2));
 838         NSMutableData *data = [NSMutableData data];
 839
 840         [data appendBytes:&dragRow length:sizeof(int)];
 841         [data appendBytes:&col length:sizeof(int)];
 842         [data appendBytes:&dragFlags length:sizeof(int)];
 843
 844         [[self vimController] sendMessage:MouseDraggedMsgID data:data];
 845
 846         isAutoscrolling = YES;
 847     }
 848
 849     if (isDragging) {
 850         // Compute timer interval depending on how far away the mouse cursor is
 851         // from the text view.
 852         NSRect rect = [self trackingRect];
 853         float dy = 0;
 854         if (dragPoint.y < rect.origin.y) dy = rect.origin.y - dragPoint.y;
 855         else if (dragPoint.y > NSMaxY(rect)) dy = dragPoint.y - NSMaxY(rect);
 856         if (dy > MMDragAreaSize) dy = MMDragAreaSize;
 857
 858         NSTimeInterval t = MMDragTimerMaxInterval -
 859             dy*(MMDragTimerMaxInterval-MMDragTimerMinInterval)/MMDragAreaSize;
 860
 861         [self startDragTimerWithInterval:t];
 862     }
 863
 864     ++tick;
 865 }
 866
 867 - (void)setCursor
 868 {
 869     static NSCursor *customIbeamCursor = nil;
 870
 871     if (!customIbeamCursor) {
 872         // Use a custom Ibeam cursor that has better contrast against dark
 873         // backgrounds.
 874         // TODO: Is the hotspot ok?
 875         NSImage *ibeamImage = [NSImage imageNamed:@"ibeam"];
 876         if (ibeamImage) {
 877             NSSize size = [ibeamImage size];
 878             NSPoint hotSpot = { size.width*.5f, size.height*.5f };
 879
 880             customIbeamCursor = [[NSCursor alloc]
 881                     initWithImage:ibeamImage hotSpot:hotSpot];
 882         }
 883         if (!customIbeamCursor) {
 884             NSLog(@"WARNING: Failed to load custom Ibeam cursor");
 885             customIbeamCursor = [NSCursor IBeamCursor];
 886         }
 887     }
 888
 889     // This switch should match mshape_names[] in misc2.c.
 890     //
 891     // TODO: Add missing cursor shapes.
 892     switch (mouseShape) {
 893         case 2: [customIbeamCursor set]; break;
 894         case 3: case 4: [[NSCursor resizeUpDownCursor] set]; break;
 895         case 5: case 6: [[NSCursor resizeLeftRightCursor] set]; break;
 896         case 9: [[NSCursor crosshairCursor] set]; break;
 897         case 10: [[NSCursor pointingHandCursor] set]; break;
 898         case 11: [[NSCursor openHandCursor] set]; break;
 899         default:
 900             [[NSCursor arrowCursor] set]; break;
 901     }
 902
 903     // Shape 1 indicates that the mouse cursor should be hidden.
 904     if (1 == mouseShape)
 905         [NSCursor setHiddenUntilMouseMoves:YES];
 906 }
 907
 908 - (NSRect)trackingRect
 909 {
 910     NSRect rect = [textView frame];
 911     NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
 912     int left = [ud integerForKey:MMTextInsetLeftKey];
 913     int top = [ud integerForKey:MMTextInsetTopKey];
 914     int right = [ud integerForKey:MMTextInsetRightKey];
 915     int bot = [ud integerForKey:MMTextInsetBottomKey];
 916
 917     rect.origin.x = left;
 918     rect.origin.y = top;
 919     rect.size.width -= left + right - 1;
 920     rect.size.height -= top + bot - 1;
 921
 922     return rect;
 923 }
 924
 925 @end // MMTextViewHelper (Private)