MMTextView.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 "MMTextView.h"
  12 #import "MMTextStorage.h"
  13 #import "MMWindowController.h"
  14 #import "MMVimController.h"
  15 #import "MacVim.h"
  16
  17
  18
  19 // The max/min drag timer interval in seconds
  20 static NSTimeInterval MMDragTimerMaxInterval = .3f;
  21 static NSTimeInterval MMDragTimerMinInterval = .01f;
  22
  23 // The number of pixels in which the drag timer interval changes
  24 static float MMDragAreaSize = 73.0f;
  25
  26 static char MMKeypadEnter[2] = { 'K', 'A' };
  27 static NSString *MMKeypadEnterString = @"KA";
  28
  29
  30
  31 @interface MMTextView (Private)
  32 - (BOOL)convertPoint:(NSPoint)point toRow:(int *)row column:(int *)column;
  33 - (BOOL)convertRow:(int)row column:(int)column toPoint:(NSPoint *)point;
  34 - (NSRect)trackingRect;
  35 - (void)dispatchKeyEvent:(NSEvent *)event;
  36 - (MMVimController *)vimController;
  37 - (void)startDragTimerWithInterval:(NSTimeInterval)t;
  38 - (void)dragTimerFired:(NSTimer *)timer;
  39 - (void)sendKeyDown:(const char *)chars length:(int)len modifiers:(int)flags;
  40 @end
  41
  42
  43
  44 @implementation MMTextView
  45
  46 - (void)dealloc
  47 {
  48     if (markedTextField) {
  49         [[markedTextField window] autorelease];
  50         [markedTextField release];
  51         markedTextField = nil;
  52     }
  53
  54     [lastMouseDownEvent release];
  55     [super dealloc];
  56 }
  57
  58 - (NSEvent *)lastMouseDownEvent
  59 {
  60     return lastMouseDownEvent;
  61 }
  62
  63 - (BOOL)shouldDrawInsertionPoint
  64 {
  65     // NOTE: The insertion point is drawn manually in drawRect:.  It would be
  66     // nice to be able to use the insertion point related methods of
  67     // NSTextView, but it seems impossible to get them to work properly (search
  68     // the cocoabuilder archives).
  69     return NO;
  70 }
  71
  72 - (void)setShouldDrawInsertionPoint:(BOOL)on
  73 {
  74     shouldDrawInsertionPoint = on;
  75 }
  76
  77 - (void)drawInsertionPointAtRow:(int)row column:(int)col shape:(int)shape
  78                        fraction:(int)percent color:(NSColor *)color
  79 {
  80     //NSLog(@"drawInsertionPointAtRow:%d column:%d shape:%d color:%@",
  81     //        row, col, shape, color);
  82
  83     // This only stores where to draw the insertion point, the actual drawing
  84     // is done in drawRect:.
  85     shouldDrawInsertionPoint = YES;
  86     insertionPointRow = row;
  87     insertionPointColumn = col;
  88     insertionPointShape = shape;
  89     insertionPointFraction = percent;
  90
  91     [self setInsertionPointColor:color];
  92 }
  93
  94 - (void)hideMarkedTextField
  95 {
  96     if (markedTextField) {
  97         NSWindow *win = [markedTextField window];
  98         [win close];
  99         [markedTextField setStringValue:@""];
 100     }
 101 }
 102
 103 - (void)drawRect:(NSRect)rect
 104 {
 105     [super drawRect:rect];
 106
 107     if (shouldDrawInsertionPoint) {
 108         MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 109         NSLayoutManager *lm = [self layoutManager];
 110         NSTextContainer *tc = [self textContainer];
 111
 112         // Given (row,column), calculate the bounds of the glyph at that spot.
 113         // We use the layout manager because this gives us exactly the size and
 114         // location of the glyph so that we can match the insertion point to
 115         // it.
 116         unsigned charIdx = [ts characterIndexForRow:insertionPointRow
 117                                              column:insertionPointColumn];
 118         NSRange glyphRange =
 119             [lm glyphRangeForCharacterRange:NSMakeRange(charIdx,1)
 120                        actualCharacterRange:NULL];
 121         NSRect ipRect = [lm boundingRectForGlyphRange:glyphRange
 122                                       inTextContainer:tc];
 123         ipRect.origin.x += [self textContainerOrigin].x;
 124         ipRect.origin.y += [self textContainerOrigin].y;
 125
 126         if (MMInsertionPointHorizontal == insertionPointShape) {
 127             int frac = ([ts cellSize].height * insertionPointFraction + 99)/100;
 128             ipRect.origin.y += ipRect.size.height - frac;
 129             ipRect.size.height = frac;
 130         } else if (MMInsertionPointVertical == insertionPointShape) {
 131             int frac = ([ts cellSize].width* insertionPointFraction + 99)/100;
 132             ipRect.size.width = frac;
 133         }
 134
 135         [[self insertionPointColor] set];
 136         if (MMInsertionPointHollow == insertionPointShape) {
 137             NSFrameRect(ipRect);
 138         } else {
 139             NSRectFill(ipRect);
 140         }
 141
 142         // NOTE: We only draw the cursor once and rely on Vim to say when it
 143         // should be drawn again.
 144         shouldDrawInsertionPoint = NO;
 145
 146         //NSLog(@"%s draw insertion point %@ shape=%d color=%@", _cmd,
 147         //        NSStringFromRect(ipRect), insertionPointShape,
 148         //        [self insertionPointColor]);
 149     }
 150 }
 151
 152 - (void)keyDown:(NSEvent *)event
 153 {
 154     //NSLog(@"%s %@", _cmd, event);
 155     // HACK! If a modifier is held, don't pass the event along to
 156     // interpretKeyEvents: since some keys are bound to multiple commands which
 157     // means doCommandBySelector: is called several times.
 158     //
 159     // TODO: Figure out a way to disable Cocoa key bindings entirely, without
 160     // affecting input management.
 161
 162     if ([event modifierFlags] & NSControlKeyMask)
 163         [self dispatchKeyEvent:event];
 164     else
 165         [super keyDown:event];
 166 }
 167
 168 - (void)insertText:(id)string
 169 {
 170     //NSLog(@"%s %@", _cmd, string);
 171     // NOTE!  This method is called for normal key presses but also for
 172     // Option-key presses --- even when Ctrl is held as well as Option.  When
 173     // Ctrl is held, the AppKit translates the character to a Ctrl+key stroke,
 174     // so 'string' need not be a printable character!  In this case it still
 175     // works to pass 'string' on to Vim as a printable character (since
 176     // modifiers are already included and should not be added to the input
 177     // buffer using CSI, K_MODIFIER).
 178
 179     [self hideMarkedTextField];
 180
 181     NSEvent *event = [NSApp currentEvent];
 182
 183     // HACK!  In order to be able to bind to <S-Space> etc. we have to watch
 184     // for when space was pressed.
 185     if ([event type] == NSKeyDown
 186             && [[event charactersIgnoringModifiers] length] > 0
 187             && [[event charactersIgnoringModifiers] characterAtIndex:0] == ' '
 188             && [event modifierFlags]
 189                 & (NSShiftKeyMask|NSControlKeyMask|NSAlternateKeyMask))
 190     {
 191         [self dispatchKeyEvent:event];
 192         return;
 193     }
 194
 195     // TODO: Support 'mousehide' (check p_mh)
 196     [NSCursor setHiddenUntilMouseMoves:YES];
 197
 198     // NOTE: 'string' is either an NSString or an NSAttributedString.  Since we
 199     // do not support attributes, simply pass the corresponding NSString in the
 200     // latter case.
 201     if ([string isKindOfClass:[NSAttributedString class]])
 202         string = [string string];
 203
 204     [[self vimController] sendMessage:InsertTextMsgID
 205                  data:[string dataUsingEncoding:NSUTF8StringEncoding]];
 206 }
 207
 208
 209 - (void)doCommandBySelector:(SEL)selector
 210 {
 211     //NSLog(@"%s %@", _cmd, NSStringFromSelector(selector));
 212     // By ignoring the selector we effectively disable the key binding
 213     // mechanism of Cocoa.  Hopefully this is what the user will expect
 214     // (pressing Ctrl+P would otherwise result in moveUp: instead of previous
 215     // match, etc.).
 216     //
 217     // We usually end up here if the user pressed Ctrl+key (but not
 218     // Ctrl+Option+key).
 219
 220     NSEvent *event = [NSApp currentEvent];
 221
 222     if (selector == @selector(cancelOperation:)
 223             || selector == @selector(insertNewline:)) {
 224         // HACK! If there was marked text which got abandoned as a result of
 225         // hitting escape or enter, then 'insertText:' is called with the
 226         // abandoned text but '[event characters]' includes the abandoned text
 227         // as well.  Since 'dispatchKeyEvent:' looks at '[event characters]' we
 228         // must intercept these keys here or the abandonded text gets inserted
 229         // twice.
 230         NSString *key = [event charactersIgnoringModifiers];
 231         const char *chars = [key UTF8String];
 232         int len = [key lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 233
 234         if (0x3 == chars[0]) {
 235             // HACK! AppKit turns enter (not return) into Ctrl-C, so we need to
 236             // handle it separately (else Ctrl-C doesn't work).
 237             len = sizeof(MMKeypadEnter)/sizeof(MMKeypadEnter[0]);
 238             chars = MMKeypadEnter;
 239         }
 240
 241         [self sendKeyDown:chars length:len modifiers:[event modifierFlags]];
 242     } else {
 243         [self dispatchKeyEvent:event];
 244     }
 245 }
 246
 247 - (BOOL)performKeyEquivalent:(NSEvent *)event
 248 {
 249     //NSLog(@"%s %@", _cmd, event);
 250     // Called for Cmd+key keystrokes, function keys, arrow keys, page
 251     // up/down, home, end.
 252     //
 253     // NOTE: This message cannot be ignored since Cmd+letter keys never are
 254     // passed to keyDown:.  It seems as if the main menu consumes Cmd-key
 255     // strokes, unless the key is a function key.
 256
 257     // NOTE: If the event that triggered this method represents a function key
 258     // down then we do nothing, otherwise the input method never gets the key
 259     // stroke (some input methods use e.g.  arrow keys).  The function key down
 260     // event will still reach Vim though (via keyDown:).
 261     int flags = [event modifierFlags];
 262     if ([event type] != NSKeyDown || flags & NSFunctionKeyMask)
 263         return NO;
 264
 265     // HACK!  Let the main menu try to handle any key down event, before
 266     // passing it on to vim, otherwise key equivalents for menus will
 267     // effectively be disabled.
 268     if ([[NSApp mainMenu] performKeyEquivalent:event])
 269         return YES;
 270
 271     // HACK!  KeyCode 50 represent the key which switches between windows
 272     // within an application (like Cmd+Tab is used to switch between
 273     // applications).  Return NO here, else the window switching does not work.
 274     //
 275     // Will this hack work for all languages / keyboard layouts?
 276     if ([event keyCode] == 50)
 277         return NO;
 278
 279     //NSLog(@"%s%@", _cmd, event);
 280
 281     NSString *chars = [event characters];
 282     NSString *unmodchars = [event charactersIgnoringModifiers];
 283     int len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 284     NSMutableData *data = [NSMutableData data];
 285
 286     if (len <= 0)
 287         return NO;
 288
 289     // If 'chars' and 'unmodchars' differs when shift flag is present, then we
 290     // can clear the shift flag as it is already included in 'unmodchars'.
 291     // Failing to clear the shift flag means <D-Bar> turns into <S-D-Bar> (on
 292     // an English keyboard).
 293     if (flags & NSShiftKeyMask && ![chars isEqual:unmodchars])
 294         flags &= ~NSShiftKeyMask;
 295
 296     if (0x3 == [unmodchars characterAtIndex:0]) {
 297         // HACK! AppKit turns enter (not return) into Ctrl-C, so we need to
 298         // handle it separately (else Cmd-enter turns into Ctrl-C).
 299         unmodchars = MMKeypadEnterString;
 300         len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 301     }
 302
 303     [data appendBytes:&flags length:sizeof(int)];
 304     [data appendBytes:&len length:sizeof(int)];
 305     [data appendBytes:[unmodchars UTF8String] length:len];
 306
 307     [[self vimController] sendMessage:CmdKeyMsgID data:data];
 308
 309     return YES;
 310 }
 311
 312 - (BOOL)hasMarkedText
 313 {
 314     //NSLog(@"%s", _cmd);
 315     return markedTextField && [[markedTextField stringValue] length] > 0;
 316 }
 317
 318 - (NSRange)markedRange
 319 {
 320     //NSLog(@"%s", _cmd);
 321     // HACK! If a valid range is returned, then NSTextView changes the
 322     // background color of the returned range.  Since marked text is displayed
 323     // in a separate popup window this behaviour is not wanted.  By setting the
 324     // location of the returned range to NSNotFound NSTextView does nothing.
 325     // This hack is continued in 'firstRectForCharacterRange:'.
 326     return NSMakeRange(NSNotFound, 0);
 327 }
 328
 329 - (void)setMarkedText:(id)text selectedRange:(NSRange)range
 330 {
 331     //NSLog(@"setMarkedText:'%@' selectedRange:%@", text,
 332     //        NSStringFromRange(range));
 333
 334     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 335     if (!ts) return;
 336
 337     if (!markedTextField) {
 338         // Create a text field and put it inside a floating panel.  This field
 339         // is used to display marked text.
 340         NSSize cellSize = [ts cellSize];
 341         NSRect cellRect = { 0, 0, cellSize.width, cellSize.height };
 342
 343         markedTextField = [[NSTextField alloc] initWithFrame:cellRect];
 344         [markedTextField setEditable:NO];
 345         [markedTextField setSelectable:NO];
 346         [markedTextField setBezeled:NO];
 347         [markedTextField setBordered:YES];
 348
 349         NSPanel *panel = [[NSPanel alloc]
 350             initWithContentRect:cellRect
 351                       styleMask:NSBorderlessWindowMask|NSUtilityWindowMask
 352                         backing:NSBackingStoreBuffered
 353                           defer:YES];
 354
 355         //[panel setHidesOnDeactivate:NO];
 356         [panel setFloatingPanel:YES];
 357         [panel setBecomesKeyOnlyIfNeeded:YES];
 358         [panel setContentView:markedTextField];
 359     }
 360
 361     if (text && [text length] > 0) {
 362         [markedTextField setFont:[ts font]];
 363         if ([text isKindOfClass:[NSAttributedString class]])
 364             [markedTextField setAttributedStringValue:text];
 365         else
 366             [markedTextField setStringValue:text];
 367
 368         [markedTextField sizeToFit];
 369         NSSize size = [markedTextField frame].size;
 370
 371         // Convert coordinates (row,col) -> view -> window base -> screen
 372         NSPoint origin;
 373         if (![self convertRow:insertionPointRow+1 column:insertionPointColumn
 374                      toPoint:&origin])
 375             return;
 376         origin = [self convertPoint:origin toView:nil];
 377         origin = [[self window] convertBaseToScreen:origin];
 378
 379         NSWindow *win = [markedTextField window];
 380         [win setContentSize:size];
 381         [win setFrameOrigin:origin];
 382         [win orderFront:nil];
 383     } else {
 384         [self hideMarkedTextField];
 385     }
 386 }
 387
 388 - (void)unmarkText
 389 {
 390     //NSLog(@"%s", _cmd);
 391     [self hideMarkedTextField];
 392 }
 393
 394 - (NSRect)firstRectForCharacterRange:(NSRange)range
 395 {
 396     //NSLog(@"%s%@", _cmd, NSStringFromRange(range));
 397
 398     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 399     NSLayoutManager *lm = [self layoutManager];
 400     NSTextContainer *tc = [self textContainer];
 401
 402     // HACK! Since we always return marked text to have location NSNotFound,
 403     // this method will be called with 'range.location == NSNotFound' whenever
 404     // the input manager tries to position a popup window near the insertion
 405     // point.  For this reason we compute where the insertion point is and
 406     // return a rect which contains it.
 407     if (!(ts && lm && tc) || NSNotFound != range.location)
 408         return [super firstRectForCharacterRange:range];
 409
 410     unsigned charIdx = [ts characterIndexForRow:insertionPointRow
 411                                          column:insertionPointColumn];
 412     NSRange glyphRange =
 413         [lm glyphRangeForCharacterRange:NSMakeRange(charIdx,1)
 414                    actualCharacterRange:NULL];
 415     NSRect ipRect = [lm boundingRectForGlyphRange:glyphRange
 416                                   inTextContainer:tc];
 417     ipRect.origin.x += [self textContainerOrigin].x;
 418     ipRect.origin.y += [self textContainerOrigin].y + [ts cellSize].height;
 419
 420     ipRect.origin = [self convertPoint:ipRect.origin toView:nil];
 421     ipRect.origin = [[self window] convertBaseToScreen:ipRect.origin];
 422
 423     return ipRect;
 424 }
 425
 426 - (void)scrollWheel:(NSEvent *)event
 427 {
 428     if ([event deltaY] == 0)
 429         return;
 430
 431     int row, col;
 432     NSPoint pt = [self convertPoint:[event locationInWindow] fromView:nil];
 433     if (![self convertPoint:pt toRow:&row column:&col])
 434         return;
 435
 436     int flags = [event modifierFlags];
 437     float dy = [event deltaY];
 438     NSMutableData *data = [NSMutableData data];
 439
 440     [data appendBytes:&row length:sizeof(int)];
 441     [data appendBytes:&col length:sizeof(int)];
 442     [data appendBytes:&flags length:sizeof(int)];
 443     [data appendBytes:&dy length:sizeof(float)];
 444
 445     [[self vimController] sendMessage:ScrollWheelMsgID data:data];
 446 }
 447
 448 - (void)mouseDown:(NSEvent *)event
 449 {
 450     int row, col;
 451     NSPoint pt = [self convertPoint:[event locationInWindow] fromView:nil];
 452     if (![self convertPoint:pt toRow:&row column:&col])
 453         return;
 454
 455     lastMouseDownEvent = [event copy];
 456
 457     int button = [event buttonNumber];
 458     int flags = [event modifierFlags];
 459     int count = [event clickCount];
 460     NSMutableData *data = [NSMutableData data];
 461
 462     // If desired, intepret Ctrl-Click as a right mouse click.
 463     if ([[NSUserDefaults standardUserDefaults]
 464             boolForKey:MMTranslateCtrlClickKey]
 465             && button == 0 && flags & NSControlKeyMask) {
 466         button = 1;
 467         flags &= ~NSControlKeyMask;
 468     }
 469
 470     [data appendBytes:&row length:sizeof(int)];
 471     [data appendBytes:&col length:sizeof(int)];
 472     [data appendBytes:&button length:sizeof(int)];
 473     [data appendBytes:&flags length:sizeof(int)];
 474     [data appendBytes:&count length:sizeof(int)];
 475
 476     [[self vimController] sendMessage:MouseDownMsgID data:data];
 477 }
 478
 479 - (void)rightMouseDown:(NSEvent *)event
 480 {
 481     [self mouseDown:event];
 482 }
 483
 484 - (void)otherMouseDown:(NSEvent *)event
 485 {
 486     [self mouseDown:event];
 487 }
 488
 489 - (void)mouseUp:(NSEvent *)event
 490 {
 491     int row, col;
 492     NSPoint pt = [self convertPoint:[event locationInWindow] fromView:nil];
 493     if (![self convertPoint:pt toRow:&row column:&col])
 494         return;
 495
 496     int flags = [event modifierFlags];
 497     NSMutableData *data = [NSMutableData data];
 498
 499     [data appendBytes:&row length:sizeof(int)];
 500     [data appendBytes:&col length:sizeof(int)];
 501     [data appendBytes:&flags length:sizeof(int)];
 502
 503     [[self vimController] sendMessage:MouseUpMsgID data:data];
 504
 505     isDragging = NO;
 506 }
 507
 508 - (void)rightMouseUp:(NSEvent *)event
 509 {
 510     [self mouseUp:event];
 511 }
 512
 513 - (void)otherMouseUp:(NSEvent *)event
 514 {
 515     [self mouseUp:event];
 516 }
 517
 518 - (void)mouseDragged:(NSEvent *)event
 519 {
 520     int flags = [event modifierFlags];
 521     int row, col;
 522     NSPoint pt = [self convertPoint:[event locationInWindow] fromView:nil];
 523     if (![self convertPoint:pt toRow:&row column:&col])
 524         return;
 525
 526     // Autoscrolling is done in dragTimerFired:
 527     if (!isAutoscrolling) {
 528         NSMutableData *data = [NSMutableData data];
 529
 530         [data appendBytes:&row length:sizeof(int)];
 531         [data appendBytes:&col length:sizeof(int)];
 532         [data appendBytes:&flags length:sizeof(int)];
 533
 534         [[self vimController] sendMessage:MouseDraggedMsgID data:data];
 535     }
 536
 537     dragPoint = pt;
 538     dragRow = row; dragColumn = col; dragFlags = flags;
 539     if (!isDragging) {
 540         [self startDragTimerWithInterval:.5];
 541         isDragging = YES;
 542     }
 543 }
 544
 545 - (void)rightMouseDragged:(NSEvent *)event
 546 {
 547     [self mouseDragged:event];
 548 }
 549
 550 - (void)otherMouseDragged:(NSEvent *)event
 551 {
 552     [self mouseDragged:event];
 553 }
 554
 555 - (void)mouseMoved:(NSEvent *)event
 556 {
 557     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 558     if (!ts) return;
 559
 560     NSPoint pt = [self convertPoint:[event locationInWindow] fromView:nil];
 561     int row, col;
 562     if (![self convertPoint:pt toRow:&row column:&col])
 563         return;
 564
 565     // HACK! It seems impossible to get the tracking rects set up before the
 566     // view is visible, which means that the first mouseEntered: or
 567     // mouseExited: events are never received.  This forces us to check if the
 568     // mouseMoved: event really happened over the text.
 569     int rows, cols;
 570     [ts getMaxRows:&rows columns:&cols];
 571     if (row >= 0 && row < rows && col >= 0 && col < cols) {
 572         NSMutableData *data = [NSMutableData data];
 573
 574         [data appendBytes:&row length:sizeof(int)];
 575         [data appendBytes:&col length:sizeof(int)];
 576
 577         [[self vimController] sendMessage:MouseMovedMsgID data:data];
 578     }
 579 }
 580
 581 - (void)mouseEntered:(NSEvent *)event
 582 {
 583     //NSLog(@"%s", _cmd);
 584
 585     // NOTE: This event is received even when the window is not key; thus we
 586     // have to take care not to enable mouse moved events unless our window is
 587     // key.
 588     if ([[self window] isKeyWindow])
 589         [[self window] setAcceptsMouseMovedEvents:YES];
 590 }
 591
 592 - (void)mouseExited:(NSEvent *)event
 593 {
 594     //NSLog(@"%s", _cmd);
 595
 596     [[self window] setAcceptsMouseMovedEvents:NO];
 597
 598     // NOTE: This event is received even when the window is not key; if the
 599     // mouse shape is set when our window is not key, the hollow (unfocused)
 600     // cursor will become a block (focused) cursor.
 601     if ([[self window] isKeyWindow]) {
 602         int shape = 0;
 603         NSMutableData *data = [NSMutableData data];
 604         [data appendBytes:&shape length:sizeof(int)];
 605         [[self vimController] sendMessage:SetMouseShapeMsgID data:data];
 606     }
 607 }
 608
 609 - (void)setFrame:(NSRect)frame
 610 {
 611     //NSLog(@"%s", _cmd);
 612
 613     // When the frame changes we also need to update the tracking rect.
 614     [super setFrame:frame];
 615     [self removeTrackingRect:trackingRectTag];
 616     trackingRectTag = [self addTrackingRect:[self trackingRect] owner:self
 617                                    userData:NULL assumeInside:YES];
 618 }
 619
 620 - (void)viewDidMoveToWindow
 621 {
 622     //NSLog(@"%s (window=%@)", _cmd, [self window]);
 623
 624     // Set a tracking rect which covers the text.
 625     // NOTE: While the mouse cursor is in this rect the view will receive
 626     // 'mouseMoved:' events so that Vim can take care of updating the mouse
 627     // cursor.
 628     if ([self window]) {
 629         [[self window] setAcceptsMouseMovedEvents:YES];
 630         trackingRectTag = [self addTrackingRect:[self trackingRect] owner:self
 631                                        userData:NULL assumeInside:YES];
 632     }
 633 }
 634
 635 - (void)viewWillMoveToWindow:(NSWindow *)newWindow
 636 {
 637     //NSLog(@"%s%@", _cmd, newWindow);
 638
 639     // Remove tracking rect if view moves or is removed.
 640     if ([self window] && trackingRectTag) {
 641         [self removeTrackingRect:trackingRectTag];
 642         trackingRectTag = 0;
 643     }
 644 }
 645
 646 - (NSMenu*)menuForEvent:(NSEvent *)event
 647 {
 648     // HACK! Return nil to disable NSTextView's popup menus (Vim provides its
 649     // own).  Called when user Ctrl-clicks in the view (this is already handled
 650     // in rightMouseDown:).
 651     return nil;
 652 }
 653
 654 - (NSArray *)acceptableDragTypes
 655 {
 656     return [NSArray arrayWithObjects:NSFilenamesPboardType,
 657            NSStringPboardType, nil];
 658 }
 659
 660 - (BOOL)performDragOperation:(id <NSDraggingInfo>)sender
 661 {
 662     NSPasteboard *pboard = [sender draggingPasteboard];
 663
 664     if ([[pboard types] containsObject:NSStringPboardType]) {
 665         NSString *string = [pboard stringForType:NSStringPboardType];
 666         [[self vimController] dropString:string];
 667         return YES;
 668     } else if ([[pboard types] containsObject:NSFilenamesPboardType]) {
 669         NSArray *files = [pboard propertyListForType:NSFilenamesPboardType];
 670         [[self vimController] dropFiles:files];
 671         return YES;
 672     }
 673
 674     return NO;
 675 }
 676
 677 - (NSDragOperation)draggingEntered:(id <NSDraggingInfo>)sender
 678 {
 679     NSDragOperation sourceDragMask = [sender draggingSourceOperationMask];
 680     NSPasteboard *pboard = [sender draggingPasteboard];
 681
 682     if ( [[pboard types] containsObject:NSFilenamesPboardType]
 683             && (sourceDragMask & NSDragOperationCopy) )
 684         return NSDragOperationCopy;
 685     if ( [[pboard types] containsObject:NSStringPboardType]
 686             && (sourceDragMask & NSDragOperationCopy) )
 687         return NSDragOperationCopy;
 688
 689     return NSDragOperationNone;
 690 }
 691
 692 - (NSDragOperation)draggingUpdated:(id <NSDraggingInfo>)sender
 693 {
 694     NSDragOperation sourceDragMask = [sender draggingSourceOperationMask];
 695     NSPasteboard *pboard = [sender draggingPasteboard];
 696
 697     if ( [[pboard types] containsObject:NSFilenamesPboardType]
 698             && (sourceDragMask & NSDragOperationCopy) )
 699         return NSDragOperationCopy;
 700     if ( [[pboard types] containsObject:NSStringPboardType]
 701             && (sourceDragMask & NSDragOperationCopy) )
 702         return NSDragOperationCopy;
 703
 704     return NSDragOperationNone;
 705 }
 706
 707 - (void)changeFont:(id)sender
 708 {
 709     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 710     if (!ts) return;
 711
 712     NSFont *oldFont = [ts font];
 713     NSFont *newFont = [sender convertFont:oldFont];
 714
 715     if (newFont) {
 716         NSString *name = [newFont displayName];
 717         unsigned len = [name lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 718         if (len > 0) {
 719             NSMutableData *data = [NSMutableData data];
 720             float pointSize = [newFont pointSize];
 721
 722             [data appendBytes:&pointSize length:sizeof(float)];
 723
 724             ++len;  // include NUL byte
 725             [data appendBytes:&len length:sizeof(unsigned)];
 726             [data appendBytes:[name UTF8String] length:len];
 727
 728             [[self vimController] sendMessage:SetFontMsgID data:data];
 729         }
 730     }
 731 }
 732
 733 - (void)resetCursorRects
 734 {
 735     // No need to set up cursor rects since Vim handles cursor changes.
 736 }
 737
 738 - (void)updateFontPanel
 739 {
 740     // The font panel is updated whenever the font is set.
 741 }
 742
 743 - (void)viewDidEndLiveResize
 744 {
 745     // HACK! If a SetTextDimensionsMsgID message is lost while dragging to
 746     // resize the window, then the text view and window sizes may become out of
 747     // sync.  To avoid this problem, resize the window when live resizes ends.
 748     // This sometimes makes the window size 'jump' unpleasantly, but that is
 749     // better than the alternative.
 750     id windowController = [[self window] windowController];
 751     [windowController resizeWindowToFit:self];
 752 }
 753
 754 @end // MMTextView
 755
 756
 757
 758
 759 @implementation MMTextView (Private)
 760
 761 - (BOOL)convertPoint:(NSPoint)point toRow:(int *)row column:(int *)column
 762 {
 763 #if 0
 764     NSLayoutManager *lm = [self layoutManager];
 765     NSTextContainer *tc = [self textContainer];
 766     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 767
 768     if (!(lm && tc && ts))
 769         return NO;
 770
 771     unsigned glyphIdx = [lm glyphIndexForPoint:point inTextContainer:tc];
 772     unsigned charIdx = [lm characterIndexForGlyphAtIndex:glyphIdx];
 773
 774     int mod = [ts maxColumns] + 1;
 775
 776     if (row) *row = (int)(charIdx / mod);
 777     if (column) *column = (int)(charIdx % mod);
 778
 779     NSLog(@"convertPoint:%@ toRow:%d column:%d", NSStringFromPoint(point),
 780             *row, *column);
 781
 782     return YES;
 783 #else
 784     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 785     NSSize cellSize = [ts cellSize];
 786     if (!(cellSize.width > 0 && cellSize.height > 0))
 787         return NO;
 788     NSPoint origin = [self textContainerOrigin];
 789
 790     if (row) *row = floor((point.y-origin.y-1) / cellSize.height);
 791     if (column) *column = floor((point.x-origin.x-1) / cellSize.width);
 792
 793     //NSLog(@"convertPoint:%@ toRow:%d column:%d", NSStringFromPoint(point),
 794     //        *row, *column);
 795
 796     return YES;
 797 #endif
 798 }
 799
 800 - (BOOL)convertRow:(int)row column:(int)column toPoint:(NSPoint *)point
 801 {
 802     MMTextStorage *ts = (MMTextStorage*)[self textStorage];
 803     NSSize cellSize = [ts cellSize];
 804     if (!(point && cellSize.width > 0 && cellSize.height > 0))
 805         return NO;
 806
 807     *point = [self textContainerOrigin];
 808     point->x += column * cellSize.width;
 809     point->y += row * cellSize.height;
 810
 811     return YES;
 812 }
 813
 814 - (NSRect)trackingRect
 815 {
 816     NSRect rect = [self frame];
 817     NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
 818     int left = [ud integerForKey:MMTextInsetLeftKey];
 819     int top = [ud integerForKey:MMTextInsetTopKey];
 820     int right = [ud integerForKey:MMTextInsetRightKey];
 821     int bot = [ud integerForKey:MMTextInsetBottomKey];
 822
 823     rect.origin.x = left;
 824     rect.origin.y = top;
 825     rect.size.width -= left + right - 1;
 826     rect.size.height -= top + bot - 1;
 827
 828     return rect;
 829 }
 830
 831 - (void)dispatchKeyEvent:(NSEvent *)event
 832 {
 833     // Only handle the command if it came from a keyDown event
 834     if ([event type] != NSKeyDown)
 835         return;
 836
 837     NSString *chars = [event characters];
 838     NSString *unmodchars = [event charactersIgnoringModifiers];
 839     unichar c = [chars characterAtIndex:0];
 840     unichar imc = [unmodchars characterAtIndex:0];
 841     int len = 0;
 842     const char *bytes = 0;
 843
 844     //NSLog(@"%s chars[0]=0x%x unmodchars[0]=0x%x (chars=%@ unmodchars=%@)",
 845     //        _cmd, c, imc, chars, unmodchars);
 846
 847     if (' ' == imc && 0xa0 != c) {
 848         // HACK!  The AppKit turns <C-Space> into <C-@> which is not standard
 849         // Vim behaviour, so bypass this problem.  (0xa0 is <M-Space>, which
 850         // should be passed on as is.)
 851         len = [unmodchars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 852         bytes = [unmodchars UTF8String];
 853     } else if (imc == c && '2' == c) {
 854         // HACK!  Translate Ctrl+2 to <C-@>.
 855         static char ctrl_at = 0;
 856         len = 1;  bytes = &ctrl_at;
 857     } else if (imc == c && '6' == c) {
 858         // HACK!  Translate Ctrl+6 to <C-^>.
 859         static char ctrl_hat = 0x1e;
 860         len = 1;  bytes = &ctrl_hat;
 861     } else if (c == 0x19 && imc == 0x19) {
 862         // HACK! AppKit turns back tab into Ctrl-Y, so we need to handle it
 863         // separately (else Ctrl-Y doesn't work).
 864         static char back_tab[2] = { 'k', 'B' };
 865         len = 2; bytes = back_tab;
 866     } else {
 867         len = [chars lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 868         bytes = [chars UTF8String];
 869     }
 870
 871     [self sendKeyDown:bytes length:len modifiers:[event modifierFlags]];
 872 }
 873
 874 - (MMVimController *)vimController
 875 {
 876     id windowController = [[self window] windowController];
 877
 878     // TODO: Make sure 'windowController' is a MMWindowController before type
 879     // casting.
 880     return [(MMWindowController*)windowController vimController];
 881 }
 882
 883 - (void)startDragTimerWithInterval:(NSTimeInterval)t
 884 {
 885     [NSTimer scheduledTimerWithTimeInterval:t target:self
 886                                    selector:@selector(dragTimerFired:)
 887                                    userInfo:nil repeats:NO];
 888 }
 889
 890 - (void)dragTimerFired:(NSTimer *)timer
 891 {
 892     // TODO: Autoscroll in horizontal direction?
 893     static unsigned tick = 1;
 894     MMTextStorage *ts = (MMTextStorage *)[self textStorage];
 895
 896     isAutoscrolling = NO;
 897
 898     if (isDragging && ts && (dragRow < 0 || dragRow >= [ts maxRows])) {
 899         // HACK! If the mouse cursor is outside the text area, then send a
 900         // dragged event.  However, if row&col hasn't changed since the last
 901         // dragged event, Vim won't do anything (see gui_send_mouse_event()).
 902         // Thus we fiddle with the column to make sure something happens.
 903         int col = dragColumn + (dragRow < 0 ? -(tick % 2) : +(tick % 2));
 904         NSMutableData *data = [NSMutableData data];
 905
 906         [data appendBytes:&dragRow length:sizeof(int)];
 907         [data appendBytes:&col length:sizeof(int)];
 908         [data appendBytes:&dragFlags length:sizeof(int)];
 909
 910         [[self vimController] sendMessage:MouseDraggedMsgID data:data];
 911
 912         isAutoscrolling = YES;
 913     }
 914
 915     if (isDragging) {
 916         // Compute timer interval depending on how far away the mouse cursor is
 917         // from the text view.
 918         NSRect rect = [self trackingRect];
 919         float dy = 0;
 920         if (dragPoint.y < rect.origin.y) dy = rect.origin.y - dragPoint.y;
 921         else if (dragPoint.y > NSMaxY(rect)) dy = dragPoint.y - NSMaxY(rect);
 922         if (dy > MMDragAreaSize) dy = MMDragAreaSize;
 923
 924         NSTimeInterval t = MMDragTimerMaxInterval -
 925             dy*(MMDragTimerMaxInterval-MMDragTimerMinInterval)/MMDragAreaSize;
 926
 927         [self startDragTimerWithInterval:t];
 928     }
 929
 930     ++tick;
 931 }
 932
 933 - (void)sendKeyDown:(const char *)chars length:(int)len modifiers:(int)flags
 934 {
 935     if (chars && len > 0) {
 936         NSMutableData *data = [NSMutableData data];
 937
 938         [data appendBytes:&flags length:sizeof(int)];
 939         [data appendBytes:&len length:sizeof(int)];
 940         [data appendBytes:chars length:len];
 941
 942         // TODO: Support 'mousehide' (check p_mh)
 943         [NSCursor setHiddenUntilMouseMoves:YES];
 944
 945         //NSLog(@"%s len=%d chars=0x%x", _cmd, len, chars[0]);
 946         [[self vimController] sendMessage:KeyDownMsgID data:data];
 947     }
 948 }
 949
 950 @end // MMTextView (Private)