src/MacVim/MMAtsuiTextView.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  * MMAtsuiTextView
  12  *
  13  * Dispatches keyboard and mouse input to the backend.  Handles drag-n-drop of
  14  * files onto window.  The rendering is done using ATSUI.
  15  *
  16  * The text view area consists of two parts:
  17  *   1. The text area - this is where text is rendered; the size is governed by
  18  *      the current number of rows and columns.
  19  *   2. The inset area - this is a border around the text area; the size is
  20  *      governed by the user defaults MMTextInset[Left|Right|Top|Bottom].
  21  *
  22  * The current size of the text view frame does not always match the desired
  23  * area, i.e. the area determined by the number of rows, columns plus text
  24  * inset.  This distinction is particularly important when the view is being
  25  * resized.
  26  */
  27
  28 #import "MMAppController.h"
  29 #import "MMAtsuiTextView.h"
  30 #import "MMTextViewHelper.h"
  31 #import "MMVimController.h"
  32 #import "MMWindowController.h"
  33 #import "Miscellaneous.h"
  34
  35
  36 // TODO: What does DRAW_TRANSP flag do?  If the background isn't drawn when
  37 // this flag is set, then sometimes the character after the cursor becomes
  38 // blank.  Everything seems to work fine by just ignoring this flag.
  39 #define DRAW_TRANSP               0x01    /* draw with transparant bg */
  40 #define DRAW_BOLD                 0x02    /* draw bold text */
  41 #define DRAW_UNDERL               0x04    /* draw underline text */
  42 #define DRAW_UNDERC               0x08    /* draw undercurl text */
  43 #define DRAW_ITALIC               0x10    /* draw italic text */
  44 #define DRAW_CURSOR               0x20
  45
  46 #define kUnderlineOffset            (-2)
  47 #define kUnderlineHeight            1
  48 #define kUndercurlHeight            2
  49 #define kUndercurlOffset            (-2)
  50 #define kUndercurlDotWidth          2
  51 #define kUndercurlDotDistance       2
  52
  53
  54 @interface NSFont (AppKitPrivate)
  55 - (ATSUFontID) _atsFontID;
  56 @end
  57
  58
  59 @interface MMAtsuiTextView (Private)
  60 - (void)initAtsuStyles;
  61 - (void)disposeAtsuStyles;
  62 - (void)updateAtsuStyles;
  63 - (MMWindowController *)windowController;
  64 - (MMVimController *)vimController;
  65 @end
  66
  67
  68 @interface MMAtsuiTextView (Drawing)
  69 - (NSPoint)originForRow:(int)row column:(int)column;
  70 - (NSRect)rectFromRow:(int)row1 column:(int)col1
  71                 toRow:(int)row2 column:(int)col2;
  72 - (NSSize)textAreaSize;
  73 - (void)resizeContentImage;
  74 - (void)beginDrawing;
  75 - (void)endDrawing;
  76 - (void)drawString:(UniChar *)string length:(UniCharCount)length
  77              atRow:(int)row column:(int)col cells:(int)cells
  78          withFlags:(int)flags foregroundColor:(NSColor *)fg
  79    backgroundColor:(NSColor *)bg specialColor:(NSColor *)sp;
  80 - (void)deleteLinesFromRow:(int)row lineCount:(int)count
  81               scrollBottom:(int)bottom left:(int)left right:(int)right
  82                      color:(NSColor *)color;
  83 - (void)insertLinesAtRow:(int)row lineCount:(int)count
  84             scrollBottom:(int)bottom left:(int)left right:(int)right
  85                    color:(NSColor *)color;
  86 - (void)clearBlockFromRow:(int)row1 column:(int)col1 toRow:(int)row2
  87                    column:(int)col2 color:(NSColor *)color;
  88 - (void)clearAll;
  89 - (void)drawInsertionPointAtRow:(int)row column:(int)col shape:(int)shape
  90                        fraction:(int)percent;
  91 - (void)drawInvertedRectAtRow:(int)row column:(int)col numRows:(int)nrows
  92                    numColumns:(int)ncols;
  93 @end
  94
  95
  96
  97     static float
  98 defaultLineHeightForFont(NSFont *font)
  99 {
 100     // HACK: -[NSFont defaultLineHeightForFont] is deprecated but since the
 101     // ATSUI renderer does not use NSLayoutManager we create one temporarily.
 102     NSLayoutManager *lm = [[NSLayoutManager alloc] init];
 103     float height = [lm defaultLineHeightForFont:font];
 104     [lm release];
 105
 106     return height;
 107 }
 108
 109 @implementation MMAtsuiTextView
 110
 111 - (id)initWithFrame:(NSRect)frame
 112 {
 113     if (!(self = [super initWithFrame:frame]))
 114         return nil;
 115
 116     // NOTE!  It does not matter which font is set here, Vim will set its
 117     // own font on startup anyway.  Just set some bogus values.
 118     font = [[NSFont userFixedPitchFontOfSize:0] retain];
 119     ascender = 0;
 120     cellSize.width = cellSize.height = 1;
 121     contentImage = nil;
 122     imageSize = NSZeroSize;
 123     insetSize = NSZeroSize;
 124
 125     // NOTE: If the default changes to 'NO' then the intialization of
 126     // p_antialias in option.c must change as well.
 127     antialias = YES;
 128
 129     helper = [[MMTextViewHelper alloc] init];
 130     [helper setTextView:self];
 131
 132     [self initAtsuStyles];
 133
 134     [self registerForDraggedTypes:[NSArray arrayWithObjects:
 135             NSFilenamesPboardType, NSStringPboardType, nil]];
 136
 137     return self;
 138 }
 139
 140 - (void)dealloc
 141 {
 142     LOG_DEALLOC
 143
 144     [self disposeAtsuStyles];
 145     [font release];  font = nil;
 146     [defaultBackgroundColor release];  defaultBackgroundColor = nil;
 147     [defaultForegroundColor release];  defaultForegroundColor = nil;
 148
 149     [helper setTextView:nil];
 150     [helper dealloc];  helper = nil;
 151
 152     [super dealloc];
 153 }
 154
 155 - (int)maxRows
 156 {
 157     return maxRows;
 158 }
 159
 160 - (int)maxColumns
 161 {
 162     return maxColumns;
 163 }
 164
 165 - (void)getMaxRows:(int*)rows columns:(int*)cols
 166 {
 167     if (rows) *rows = maxRows;
 168     if (cols) *cols = maxColumns;
 169 }
 170
 171 - (void)setMaxRows:(int)rows columns:(int)cols
 172 {
 173     // NOTE: Just remember the new values, the actual resizing is done lazily.
 174     maxRows = rows;
 175     maxColumns = cols;
 176 }
 177
 178 - (void)setDefaultColorsBackground:(NSColor *)bgColor
 179                         foreground:(NSColor *)fgColor
 180 {
 181     if (defaultBackgroundColor != bgColor) {
 182         [defaultBackgroundColor release];
 183         defaultBackgroundColor = bgColor ? [bgColor retain] : nil;
 184     }
 185
 186     if (defaultForegroundColor != fgColor) {
 187         [defaultForegroundColor release];
 188         defaultForegroundColor = fgColor ? [fgColor retain] : nil;
 189     }
 190 }
 191
 192 - (NSColor *)defaultBackgroundColor
 193 {
 194     return defaultBackgroundColor;
 195 }
 196
 197 - (NSColor *)defaultForegroundColor
 198 {
 199     return defaultForegroundColor;
 200 }
 201
 202 - (void)setTextContainerInset:(NSSize)size
 203 {
 204     insetSize = size;
 205 }
 206
 207 - (NSRect)rectForRowsInRange:(NSRange)range
 208 {
 209     NSRect rect = { 0, 0, 0, 0 };
 210     unsigned start = range.location > maxRows ? maxRows : range.location;
 211     unsigned length = range.length;
 212
 213     if (start + length > maxRows)
 214         length = maxRows - start;
 215
 216     rect.origin.y = cellSize.height * start + insetSize.height;
 217     rect.size.height = cellSize.height * length;
 218
 219     return rect;
 220 }
 221
 222 - (NSRect)rectForColumnsInRange:(NSRange)range
 223 {
 224     NSRect rect = { 0, 0, 0, 0 };
 225     unsigned start = range.location > maxColumns ? maxColumns : range.location;
 226     unsigned length = range.length;
 227
 228     if (start+length > maxColumns)
 229         length = maxColumns - start;
 230
 231     rect.origin.x = cellSize.width * start + insetSize.width;
 232     rect.size.width = cellSize.width * length;
 233
 234     return rect;
 235 }
 236
 237
 238 - (void)setFont:(NSFont *)newFont
 239 {
 240     if (newFont && font != newFont) {
 241         [font release];
 242         font = [newFont retain];
 243         ascender = roundf([font ascender]);
 244
 245         float em = [@"m" sizeWithAttributes:
 246                 [NSDictionary dictionaryWithObject:newFont
 247                                             forKey:NSFontAttributeName]].width;
 248         float cellWidthMultiplier = [[NSUserDefaults standardUserDefaults]
 249                 floatForKey:MMCellWidthMultiplierKey];
 250
 251         // NOTE! Even though NSFontFixedAdvanceAttribute is a float, it will
 252         // only render at integer sizes.  Hence, we restrict the cell width to
 253         // an integer here, otherwise the window width and the actual text
 254         // width will not match.
 255         cellSize.width = ceilf(em * cellWidthMultiplier);
 256         cellSize.height = linespace + defaultLineHeightForFont(newFont);
 257
 258         [self updateAtsuStyles];
 259     }
 260 }
 261
 262 - (void)setWideFont:(NSFont *)newFont
 263 {
 264     if (!newFont) {
 265         if (font) [self setWideFont:font];
 266     } else if (newFont != fontWide) {
 267         float pointSize = [newFont pointSize];
 268         NSFontDescriptor *desc = [newFont fontDescriptor];
 269         NSDictionary *dictWide = [NSDictionary
 270             dictionaryWithObject:[NSNumber numberWithFloat:2*cellSize.width]
 271                           forKey:NSFontFixedAdvanceAttribute];
 272         desc = [desc fontDescriptorByAddingAttributes:dictWide];
 273         fontWide = [NSFont fontWithDescriptor:desc size:pointSize];
 274         [fontWide retain];
 275     }
 276 }
 277
 278 - (NSFont *)font
 279 {
 280     return font;
 281 }
 282
 283 - (NSFont *)fontWide
 284 {
 285     return fontWide;
 286 }
 287
 288 - (NSSize)cellSize
 289 {
 290     return cellSize;
 291 }
 292
 293 - (void)setLinespace:(float)newLinespace
 294 {
 295     linespace = newLinespace;
 296
 297     // NOTE: The linespace is added to the cell height in order for a multiline
 298     // selection not to have white (background color) gaps between lines.  Also
 299     // this simplifies the code a lot because there is no need to check the
 300     // linespace when calculating the size of the text view etc.  When the
 301     // linespace is non-zero the baseline will be adjusted as well; check
 302     // MMTypesetter.
 303     cellSize.height = linespace + defaultLineHeightForFont(font);
 304 }
 305
 306
 307
 308 - (void)setShouldDrawInsertionPoint:(BOOL)on
 309 {
 310 }
 311
 312 - (void)setPreEditRow:(int)row column:(int)col
 313 {
 314     [helper setPreEditRow:row column:col];
 315 }
 316
 317 - (void)setMouseShape:(int)shape
 318 {
 319     [helper setMouseShape:shape];
 320 }
 321
 322 - (void)setAntialias:(BOOL)state
 323 {
 324     antialias = state;
 325 }
 326
 327 - (void)keyDown:(NSEvent *)event
 328 {
 329     [helper keyDown:event];
 330 }
 331
 332 - (void)insertText:(id)string
 333 {
 334     [helper insertText:string];
 335 }
 336
 337 - (void)doCommandBySelector:(SEL)selector
 338 {
 339     [helper doCommandBySelector:selector];
 340 }
 341
 342 - (BOOL)performKeyEquivalent:(NSEvent *)event
 343 {
 344     return [helper performKeyEquivalent:event];
 345 }
 346
 347 - (BOOL)hasMarkedText
 348 {
 349     return [helper hasMarkedText];
 350 }
 351
 352 - (NSRange)markedRange
 353 {
 354     return [helper markedRange];
 355 }
 356
 357 - (NSDictionary *)markedTextAttributes
 358 {
 359     return [helper markedTextAttributes];
 360 }
 361
 362 - (void)setMarkedTextAttributes:(NSDictionary *)attr
 363 {
 364     [helper setMarkedTextAttributes:attr];
 365 }
 366
 367 - (void)setMarkedText:(id)text selectedRange:(NSRange)range
 368 {
 369     [helper setMarkedText:text selectedRange:range];
 370 }
 371
 372 - (void)unmarkText
 373 {
 374     [helper unmarkText];
 375 }
 376
 377 - (void)scrollWheel:(NSEvent *)event
 378 {
 379     [helper scrollWheel:event];
 380 }
 381
 382 - (void)mouseDown:(NSEvent *)event
 383 {
 384     [helper mouseDown:event];
 385 }
 386
 387 - (void)rightMouseDown:(NSEvent *)event
 388 {
 389     [helper mouseDown:event];
 390 }
 391
 392 - (void)otherMouseDown:(NSEvent *)event
 393 {
 394     [helper mouseDown:event];
 395 }
 396
 397 - (void)mouseUp:(NSEvent *)event
 398 {
 399     [helper mouseUp:event];
 400 }
 401
 402 - (void)rightMouseUp:(NSEvent *)event
 403 {
 404     [helper mouseUp:event];
 405 }
 406
 407 - (void)otherMouseUp:(NSEvent *)event
 408 {
 409     [helper mouseUp:event];
 410 }
 411
 412 - (void)mouseDragged:(NSEvent *)event
 413 {
 414     [helper mouseDragged:event];
 415 }
 416
 417 - (void)rightMouseDragged:(NSEvent *)event
 418 {
 419     [helper mouseDragged:event];
 420 }
 421
 422 - (void)otherMouseDragged:(NSEvent *)event
 423 {
 424     [helper mouseDragged:event];
 425 }
 426
 427 - (void)mouseMoved:(NSEvent *)event
 428 {
 429     [helper mouseMoved:event];
 430 }
 431
 432 - (void)mouseEntered:(NSEvent *)event
 433 {
 434     [helper mouseEntered:event];
 435 }
 436
 437 - (void)mouseExited:(NSEvent *)event
 438 {
 439     [helper mouseExited:event];
 440 }
 441
 442 - (void)setFrame:(NSRect)frame
 443 {
 444     [super setFrame:frame];
 445     [helper setFrame:frame];
 446 }
 447
 448 - (void)viewDidMoveToWindow
 449 {
 450     [helper viewDidMoveToWindow];
 451 }
 452
 453 - (void)viewWillMoveToWindow:(NSWindow *)newWindow
 454 {
 455     [helper viewWillMoveToWindow:newWindow];
 456 }
 457
 458 - (NSMenu*)menuForEvent:(NSEvent *)event
 459 {
 460     // HACK! Return nil to disable default popup menus (Vim provides its own).
 461     // Called when user Ctrl-clicks in the view (this is already handled in
 462     // rightMouseDown:).
 463     return nil;
 464 }
 465
 466 - (BOOL)performDragOperation:(id <NSDraggingInfo>)sender
 467 {
 468     return [helper performDragOperation:sender];
 469 }
 470
 471 - (NSDragOperation)draggingEntered:(id <NSDraggingInfo>)sender
 472 {
 473     return [helper draggingEntered:sender];
 474 }
 475
 476 - (NSDragOperation)draggingUpdated:(id <NSDraggingInfo>)sender
 477 {
 478     return [helper draggingUpdated:sender];
 479 }
 480
 481
 482
 483 - (BOOL)mouseDownCanMoveWindow
 484 {
 485     return NO;
 486 }
 487
 488 - (BOOL)isOpaque
 489 {
 490     return YES;
 491 }
 492
 493 - (BOOL)acceptsFirstResponder
 494 {
 495     return YES;
 496 }
 497
 498 - (BOOL)isFlipped
 499 {
 500     return NO;
 501 }
 502
 503 - (void)drawRect:(NSRect)rect
 504 {
 505     [defaultBackgroundColor set];
 506     NSRectFill(rect);
 507
 508     NSPoint pt = { insetSize.width, insetSize.height };
 509     [contentImage compositeToPoint:pt operation:NSCompositeCopy];
 510
 511     if ([self hasMarkedText]) {
 512         int len = [[helper markedText] length];
 513         int rows = 0;
 514         int cols = maxColumns - [helper preEditColumn];
 515         NSFont *theFont = [[self markedTextAttributes]
 516             valueForKey:NSFontAttributeName];
 517         if (theFont == [self fontWide])
 518             cols = cols / 2;
 519         int done = 0;
 520         int lend = cols > len ? len : cols;
 521         NSAttributedString *aString = [[helper markedText]
 522                 attributedSubstringFromRange:NSMakeRange(done, lend)];
 523         NSPoint pt = [self pointForRow:[helper preEditRow]
 524                                 column:[helper preEditColumn]];
 525         [aString drawAtPoint:pt];
 526         done = lend;
 527         if (done != len) {
 528             int r;
 529             rows = (len - done) / (maxColumns / 2) + 1;
 530             for (r = 1; r <= rows; r++) {
 531             lend = len - done > maxColumns / 2
 532                 ? maxColumns / 2 : len - done;
 533                 aString = [[helper markedText] attributedSubstringFromRange:
 534                         NSMakeRange(done, lend)];
 535                 NSPoint pt = [self pointForRow:[helper preEditRow]+r
 536                                         column:0];
 537                 [aString drawAtPoint:pt];
 538                 done += lend;
 539             }
 540         }
 541
 542         rows = maxRows - 1 - [helper preEditRow];
 543         cols = [helper preEditColumn];
 544         if (theFont == fontWide) {
 545             cols += ([helper imRange].location+[helper imRange].length) * 2;
 546             if (cols >= maxColumns - 1) {
 547                 rows -= cols / maxColumns;
 548                 cols = cols % 2 ? cols % maxColumns + 1 :
 549                                   cols % maxColumns;
 550             }
 551         } else {
 552             cols += ([helper imRange].location+[helper imRange].length);
 553             if (cols >= maxColumns) {
 554                 rows -= cols / maxColumns;
 555                 cols = cols % 2 ? cols % maxColumns + 1 :
 556                                   cols % maxColumns;
 557             }
 558         }
 559
 560         // TODO: Could IM be in "right-left" mode?  If so the insertion point
 561         // will be on the wrong side.
 562         [self drawInsertionPointAtRow:rows
 563                                column:cols
 564                                 shape:MMInsertionPointVertical
 565                              fraction:25];
 566     }
 567 }
 568
 569 - (BOOL) wantsDefaultClipping
 570 {
 571     return NO;
 572 }
 573
 574
 575 #define MM_DEBUG_DRAWING 0
 576
 577 - (void)performBatchDrawWithData:(NSData *)data
 578 {
 579     const void *bytes = [data bytes];
 580     const void *end = bytes + [data length];
 581
 582     if (! NSEqualSizes(imageSize, [self textAreaSize]))
 583         [self resizeContentImage];
 584
 585 #if MM_DEBUG_DRAWING
 586     NSLog(@"====> BEGIN %s", _cmd);
 587 #endif
 588     [self beginDrawing];
 589
 590     // TODO: Sanity check input
 591
 592     while (bytes < end) {
 593         int type = *((int*)bytes);  bytes += sizeof(int);
 594
 595         if (ClearAllDrawType == type) {
 596 #if MM_DEBUG_DRAWING
 597             NSLog(@"   Clear all");
 598 #endif
 599             [self clearAll];
 600         } else if (ClearBlockDrawType == type) {
 601             unsigned color = *((unsigned*)bytes);  bytes += sizeof(unsigned);
 602             int row1 = *((int*)bytes);  bytes += sizeof(int);
 603             int col1 = *((int*)bytes);  bytes += sizeof(int);
 604             int row2 = *((int*)bytes);  bytes += sizeof(int);
 605             int col2 = *((int*)bytes);  bytes += sizeof(int);
 606
 607 #if MM_DEBUG_DRAWING
 608             NSLog(@"   Clear block (%d,%d) -> (%d,%d)", row1, col1,
 609                     row2,col2);
 610 #endif
 611             [self clearBlockFromRow:row1 column:col1
 612                     toRow:row2 column:col2
 613                     color:[NSColor colorWithArgbInt:color]];
 614         } else if (DeleteLinesDrawType == type) {
 615             unsigned color = *((unsigned*)bytes);  bytes += sizeof(unsigned);
 616             int row = *((int*)bytes);  bytes += sizeof(int);
 617             int count = *((int*)bytes);  bytes += sizeof(int);
 618             int bot = *((int*)bytes);  bytes += sizeof(int);
 619             int left = *((int*)bytes);  bytes += sizeof(int);
 620             int right = *((int*)bytes);  bytes += sizeof(int);
 621
 622 #if MM_DEBUG_DRAWING
 623             NSLog(@"   Delete %d line(s) from %d", count, row);
 624 #endif
 625             [self deleteLinesFromRow:row lineCount:count
 626                     scrollBottom:bot left:left right:right
 627                            color:[NSColor colorWithArgbInt:color]];
 628         } else if (DrawStringDrawType == type) {
 629             int bg = *((int*)bytes);  bytes += sizeof(int);
 630             int fg = *((int*)bytes);  bytes += sizeof(int);
 631             int sp = *((int*)bytes);  bytes += sizeof(int);
 632             int row = *((int*)bytes);  bytes += sizeof(int);
 633             int col = *((int*)bytes);  bytes += sizeof(int);
 634             int cells = *((int*)bytes);  bytes += sizeof(int);
 635             int flags = *((int*)bytes);  bytes += sizeof(int);
 636             int len = *((int*)bytes);  bytes += sizeof(int);
 637             // UniChar *string = (UniChar*)bytes;  bytes += len;
 638             NSString *string = [[NSString alloc]
 639                     initWithBytesNoCopy:(void*)bytes
 640                                  length:len
 641                                encoding:NSUTF8StringEncoding
 642                            freeWhenDone:NO];
 643             bytes += len;
 644 #if MM_DEBUG_DRAWING
 645             NSLog(@"   Draw string at (%d,%d) length=%d flags=%d fg=0x%x "
 646                     "bg=0x%x sp=0x%x", row, col, len, flags, fg, bg, sp);
 647 #endif
 648             unichar *characters = malloc(sizeof(unichar) * [string length]);
 649             [string getCharacters:characters];
 650
 651             [self drawString:characters
 652                              length:[string length]
 653                               atRow:row
 654                              column:col
 655                               cells:cells withFlags:flags
 656                     foregroundColor:[NSColor colorWithRgbInt:fg]
 657                     backgroundColor:[NSColor colorWithArgbInt:bg]
 658                        specialColor:[NSColor colorWithRgbInt:sp]];
 659             free(characters);
 660             [string release];
 661         } else if (InsertLinesDrawType == type) {
 662             unsigned color = *((unsigned*)bytes);  bytes += sizeof(unsigned);
 663             int row = *((int*)bytes);  bytes += sizeof(int);
 664             int count = *((int*)bytes);  bytes += sizeof(int);
 665             int bot = *((int*)bytes);  bytes += sizeof(int);
 666             int left = *((int*)bytes);  bytes += sizeof(int);
 667             int right = *((int*)bytes);  bytes += sizeof(int);
 668
 669 #if MM_DEBUG_DRAWING
 670             NSLog(@"   Insert %d line(s) at row %d", count, row);
 671 #endif
 672             [self insertLinesAtRow:row lineCount:count
 673                              scrollBottom:bot left:left right:right
 674                                     color:[NSColor colorWithArgbInt:color]];
 675         } else if (DrawCursorDrawType == type) {
 676             unsigned color = *((unsigned*)bytes);  bytes += sizeof(unsigned);
 677             int row = *((int*)bytes);  bytes += sizeof(int);
 678             int col = *((int*)bytes);  bytes += sizeof(int);
 679             int shape = *((int*)bytes);  bytes += sizeof(int);
 680             int percent = *((int*)bytes);  bytes += sizeof(int);
 681
 682 #if MM_DEBUG_DRAWING
 683             NSLog(@"   Draw cursor at (%d,%d)", row, col);
 684 #endif
 685             [helper setInsertionPointColor:[NSColor colorWithRgbInt:color]];
 686             [self drawInsertionPointAtRow:row column:col shape:shape
 687                                  fraction:percent];
 688         } else if (DrawInvertedRectDrawType == type) {
 689             int row = *((int*)bytes);  bytes += sizeof(int);
 690             int col = *((int*)bytes);  bytes += sizeof(int);
 691             int nr = *((int*)bytes);  bytes += sizeof(int);
 692             int nc = *((int*)bytes);  bytes += sizeof(int);
 693             /*int invert = *((int*)bytes);*/  bytes += sizeof(int);
 694
 695 #if MM_DEBUG_DRAWING
 696             NSLog(@"   Draw inverted rect: row=%d col=%d nrows=%d ncols=%d",
 697                     row, col, nr, nc);
 698 #endif
 699             [self drawInvertedRectAtRow:row column:col numRows:nr
 700                              numColumns:nc];
 701         } else if (SetCursorPosDrawType == type) {
 702             // TODO: This is used for Voice Over support in MMTextView,
 703             // MMAtsuiTextView currently does not support Voice Over.
 704             /*cursorRow = *((int*)bytes);*/  bytes += sizeof(int);
 705             /*cursorCol = *((int*)bytes);*/  bytes += sizeof(int);
 706         } else {
 707             NSLog(@"WARNING: Unknown draw type (type=%d)", type);
 708         }
 709     }
 710
 711     [self endDrawing];
 712
 713     [self setNeedsDisplay:YES];
 714
 715     // NOTE: During resizing, Cocoa only sends draw messages before Vim's rows
 716     // and columns are changed (due to ipc delays). Force a redraw here.
 717     if ([self inLiveResize])
 718         [self display];
 719
 720 #if MM_DEBUG_DRAWING
 721     NSLog(@"<==== END   %s", _cmd);
 722 #endif
 723 }
 724
 725 - (NSSize)constrainRows:(int *)rows columns:(int *)cols toSize:(NSSize)size
 726 {
 727     // TODO:
 728     // - Rounding errors may cause size change when there should be none
 729     // - Desired rows/columns shold not be 'too small'
 730
 731     // Constrain the desired size to the given size.  Values for the minimum
 732     // rows and columns is taken from Vim.
 733     NSSize desiredSize = [self desiredSize];
 734     int desiredRows = maxRows;
 735     int desiredCols = maxColumns;
 736
 737     if (size.height != desiredSize.height) {
 738         float fh = cellSize.height;
 739         float ih = 2 * insetSize.height;
 740         if (fh < 1.0f) fh = 1.0f;
 741
 742         desiredRows = floor((size.height - ih)/fh);
 743         desiredSize.height = fh*desiredRows + ih;
 744     }
 745
 746     if (size.width != desiredSize.width) {
 747         float fw = cellSize.width;
 748         float iw = 2 * insetSize.width;
 749         if (fw < 1.0f) fw = 1.0f;
 750
 751         desiredCols = floor((size.width - iw)/fw);
 752         desiredSize.width = fw*desiredCols + iw;
 753     }
 754
 755     if (rows) *rows = desiredRows;
 756     if (cols) *cols = desiredCols;
 757
 758     return desiredSize;
 759 }
 760
 761 - (NSSize)desiredSize
 762 {
 763     // Compute the size the text view should be for the entire text area and
 764     // inset area to be visible with the present number of rows and columns.
 765     return NSMakeSize(maxColumns * cellSize.width + 2 * insetSize.width,
 766                       maxRows * cellSize.height + 2 * insetSize.height);
 767 }
 768
 769 - (NSSize)minSize
 770 {
 771     // Compute the smallest size the text view is allowed to be.
 772     return NSMakeSize(MMMinColumns * cellSize.width + 2 * insetSize.width,
 773                       MMMinRows * cellSize.height + 2 * insetSize.height);
 774 }
 775
 776 - (void)changeFont:(id)sender
 777 {
 778     NSFont *newFont = [sender convertFont:font];
 779
 780     if (newFont) {
 781         NSString *name = [newFont displayName];
 782         unsigned len = [name lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 783         if (len > 0) {
 784             NSMutableData *data = [NSMutableData data];
 785             float pointSize = [newFont pointSize];
 786
 787             [data appendBytes:&pointSize length:sizeof(float)];
 788
 789             ++len;  // include NUL byte
 790             [data appendBytes:&len length:sizeof(unsigned)];
 791             [data appendBytes:[name UTF8String] length:len];
 792
 793             [[self vimController] sendMessage:SetFontMsgID data:data];
 794         }
 795     }
 796 }
 797
 798
 799 //
 800 // NOTE: The menu items cut/copy/paste/undo/redo/select all/... must be bound
 801 // to the same actions as in IB otherwise they will not work with dialogs.  All
 802 // we do here is forward these actions to the Vim process.
 803 //
 804 - (IBAction)cut:(id)sender
 805 {
 806     [[self windowController] vimMenuItemAction:sender];
 807 }
 808
 809 - (IBAction)copy:(id)sender
 810 {
 811     [[self windowController] vimMenuItemAction:sender];
 812 }
 813
 814 - (IBAction)paste:(id)sender
 815 {
 816     [[self windowController] vimMenuItemAction:sender];
 817 }
 818
 819 - (IBAction)undo:(id)sender
 820 {
 821     [[self windowController] vimMenuItemAction:sender];
 822 }
 823
 824 - (IBAction)redo:(id)sender
 825 {
 826     [[self windowController] vimMenuItemAction:sender];
 827 }
 828
 829 - (IBAction)selectAll:(id)sender
 830 {
 831     [[self windowController] vimMenuItemAction:sender];
 832 }
 833
 834 - (BOOL)convertPoint:(NSPoint)point toRow:(int *)row column:(int *)column
 835 {
 836     // View is not flipped, instead the atsui code draws to a flipped image;
 837     // thus we need to 'flip' the coordinate here since the column number
 838     // increases in an up-to-down order.
 839     point.y = [self frame].size.height - point.y;
 840
 841     NSPoint origin = { insetSize.width, insetSize.height };
 842
 843     if (!(cellSize.width > 0 && cellSize.height > 0))
 844         return NO;
 845
 846     if (row) *row = floor((point.y-origin.y-1) / cellSize.height);
 847     if (column) *column = floor((point.x-origin.x-1) / cellSize.width);
 848
 849     return YES;
 850 }
 851
 852 - (NSPoint)pointForRow:(int)row column:(int)col
 853 {
 854     // Return the lower left coordinate of the cell at (row,column).
 855     NSPoint pt;
 856
 857     pt.x = insetSize.width + col*cellSize.width;
 858     pt.y = [self frame].size.height -
 859            (insetSize.height + (1+row)*cellSize.height);
 860
 861     return pt;
 862 }
 863
 864 - (NSRect)rectForRow:(int)row column:(int)col numRows:(int)nr
 865           numColumns:(int)nc
 866 {
 867     // Return the rect for the block which covers the specified rows and
 868     // columns.  The lower-left corner is the origin of this rect.
 869     NSRect rect;
 870
 871     rect.origin.x = insetSize.width + col*cellSize.width;
 872     rect.origin.y = [self frame].size.height -
 873                     (insetSize.height + (nr+row)*cellSize.height);
 874     rect.size.width = nc*cellSize.width;
 875     rect.size.height = nr*cellSize.height;
 876
 877     return rect;
 878 }
 879
 880 - (NSArray *)validAttributesForMarkedText
 881 {
 882     return nil;
 883 }
 884
 885 - (NSAttributedString *)attributedSubstringFromRange:(NSRange)range
 886 {
 887     return nil;
 888 }
 889
 890 - (NSUInteger)characterIndexForPoint:(NSPoint)point
 891 {
 892     return NSNotFound;
 893 }
 894
 895 // The return type of this message changed with OS X 10.5 so we need this
 896 // kludge in order to avoid compiler warnings on OS X 10.4.
 897 #if (MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_4)
 898 - (NSInteger)conversationIdentifier
 899 {
 900     return (NSInteger)self;
 901 }
 902 #else
 903 - (long)conversationIdentifier
 904 {
 905     return (long)self;
 906 }
 907 #endif
 908
 909 - (NSRange)selectedRange
 910 {
 911     return [helper imRange];
 912 }
 913
 914 - (NSRect)firstRectForCharacterRange:(NSRange)range
 915 {
 916     return [helper firstRectForCharacterRange:range];
 917 }
 918
 919 @end // MMAtsuiTextView
 920
 921
 922
 923
 924 @implementation MMAtsuiTextView (Private)
 925
 926 - (void)initAtsuStyles
 927 {
 928     int i;
 929     for (i = 0; i < MMMaxCellsPerChar; i++)
 930         ATSUCreateStyle(&atsuStyles[i]);
 931 }
 932
 933 - (void)disposeAtsuStyles
 934 {
 935     int i;
 936
 937     for (i = 0; i < MMMaxCellsPerChar; i++)
 938         if (atsuStyles[i] != NULL)
 939         {
 940             if (ATSUDisposeStyle(atsuStyles[i]) != noErr)
 941                 atsuStyles[i] = NULL;
 942         }
 943 }
 944
 945 - (void)updateAtsuStyles
 946 {
 947     ATSUFontID        fontID;
 948     Fixed             fontSize;
 949     Fixed             fontWidth;
 950     int               i;
 951     CGAffineTransform transform = CGAffineTransformMakeScale(1, -1);
 952     ATSStyleRenderingOptions options;
 953
 954     fontID    = [font _atsFontID];
 955     fontSize  = Long2Fix([font pointSize]);
 956     options   = kATSStyleApplyAntiAliasing;
 957
 958     ATSUAttributeTag attribTags[] =
 959     {
 960         kATSUFontTag, kATSUSizeTag, kATSUImposeWidthTag,
 961         kATSUFontMatrixTag, kATSUStyleRenderingOptionsTag,
 962         kATSUMaxATSUITagValue + 1
 963     };
 964
 965     ByteCount attribSizes[] =
 966     {
 967         sizeof(ATSUFontID), sizeof(Fixed), sizeof(fontWidth),
 968         sizeof(CGAffineTransform), sizeof(ATSStyleRenderingOptions),
 969         sizeof(font)
 970     };
 971
 972     ATSUAttributeValuePtr attribValues[] =
 973     {
 974         &fontID, &fontSize, &fontWidth, &transform, &options, &font
 975     };
 976
 977     ATSUFontFeatureType featureTypes[] = {
 978         kLigaturesType, kLigaturesType
 979     };
 980
 981     ATSUFontFeatureSelector featureSelectors[] = {
 982         kCommonLigaturesOffSelector, kRareLigaturesOffSelector
 983     };
 984
 985     for (i = 0; i < MMMaxCellsPerChar; i++)
 986     {
 987         fontWidth = Long2Fix(cellSize.width * (i + 1));
 988
 989         if (ATSUSetAttributes(atsuStyles[i],
 990                               (sizeof attribTags) / sizeof(ATSUAttributeTag),
 991                               attribTags, attribSizes, attribValues) != noErr)
 992         {
 993             ATSUDisposeStyle(atsuStyles[i]);
 994             atsuStyles[i] = NULL;
 995         }
 996
 997         // Turn off ligatures by default
 998         ATSUSetFontFeatures(atsuStyles[i],
 999                             sizeof(featureTypes) / sizeof(featureTypes[0]),
1000                             featureTypes, featureSelectors);
1001     }
1002 }
1003
1004 - (MMWindowController *)windowController
1005 {
1006     id windowController = [[self window] windowController];
1007     if ([windowController isKindOfClass:[MMWindowController class]])
1008         return (MMWindowController*)windowController;
1009     return nil;
1010 }
1011
1012 - (MMVimController *)vimController
1013 {
1014     return [[self windowController] vimController];
1015 }
1016
1017 @end // MMAtsuiTextView (Private)
1018
1019
1020
1021
1022 @implementation MMAtsuiTextView (Drawing)
1023
1024 - (NSPoint)originForRow:(int)row column:(int)col
1025 {
1026     return NSMakePoint(col * cellSize.width, row * cellSize.height);
1027 }
1028
1029 - (NSRect)rectFromRow:(int)row1 column:(int)col1
1030                 toRow:(int)row2 column:(int)col2
1031 {
1032     NSPoint origin = [self originForRow:row1 column:col1];
1033     return NSMakeRect(origin.x, origin.y,
1034                       (col2 + 1 - col1) * cellSize.width,
1035                       (row2 + 1 - row1) * cellSize.height);
1036 }
1037
1038 - (NSSize)textAreaSize
1039 {
1040     // Calculate the (desired) size of the text area, i.e. the text view area
1041     // minus the inset area.
1042     return NSMakeSize(maxColumns * cellSize.width, maxRows * cellSize.height);
1043 }
1044
1045 - (void)resizeContentImage
1046 {
1047     //NSLog(@"resizeContentImage");
1048     [contentImage release];
1049     contentImage = [[NSImage alloc] initWithSize:[self textAreaSize]];
1050     [contentImage setFlipped:YES];
1051     imageSize = [self textAreaSize];
1052 }
1053
1054 - (void)beginDrawing
1055 {
1056     [contentImage lockFocus];
1057 }
1058
1059 - (void)endDrawing
1060 {
1061     [contentImage unlockFocus];
1062 }
1063
1064 #define atsu_style_set_bool(s, t, b) \
1065     ATSUSetAttributes(s, 1, &t, &(sizeof(Boolean)), &&b);
1066 #define FILL_Y(y)    (y * cellSize.height)
1067
1068 - (void)drawString:(UniChar *)string length:(UniCharCount)length
1069              atRow:(int)row column:(int)col cells:(int)cells
1070          withFlags:(int)flags foregroundColor:(NSColor *)fg
1071    backgroundColor:(NSColor *)bg specialColor:(NSColor *)sp
1072 {
1073     // 'string' consists of 'length' utf-16 code pairs and should cover 'cells'
1074     // display cells (a normal character takes up one display cell, a wide
1075     // character takes up two)
1076     ATSUStyle       style = (flags & DRAW_WIDE) ? atsuStyles[1] : atsuStyles[0];
1077     ATSUTextLayout  layout;
1078
1079     // Font selection and rendering options for ATSUI
1080     ATSUAttributeTag      attribTags[3] = { kATSUQDBoldfaceTag,
1081                                             kATSUFontMatrixTag,
1082                                             kATSUStyleRenderingOptionsTag };
1083
1084     ByteCount             attribSizes[] = { sizeof(Boolean),
1085                                             sizeof(CGAffineTransform),
1086                                             sizeof(UInt32) };
1087     Boolean               useBold;
1088     CGAffineTransform     theTransform = CGAffineTransformMakeScale(1.0, -1.0);
1089     UInt32                useAntialias;
1090
1091     ATSUAttributeValuePtr attribValues[3] = { &useBold, &theTransform,
1092                                               &useAntialias };
1093
1094     useBold      = (flags & DRAW_BOLD) ? true : false;
1095
1096     if (flags & DRAW_ITALIC)
1097         theTransform.c = Fix2X(kATSItalicQDSkew);
1098
1099     useAntialias = antialias ? kATSStyleApplyAntiAliasing
1100                              : kATSStyleNoAntiAliasing;
1101
1102     ATSUSetAttributes(style, sizeof(attribValues) / sizeof(attribValues[0]),
1103                       attribTags, attribSizes, attribValues);
1104
1105     // NSLog(@"drawString: %d", length);
1106
1107     ATSUCreateTextLayout(&layout);
1108     ATSUSetTextPointerLocation(layout, string,
1109                                kATSUFromTextBeginning, kATSUToTextEnd,
1110                                length);
1111     ATSUSetRunStyle(layout, style, kATSUFromTextBeginning, kATSUToTextEnd);
1112
1113     NSRect rect = NSMakeRect(col * cellSize.width, row * cellSize.height,
1114                              length * cellSize.width, cellSize.height);
1115     if (flags & DRAW_WIDE)
1116         rect.size.width = rect.size.width * 2;
1117     CGContextRef context = [[NSGraphicsContext currentContext] graphicsPort];
1118
1119     ATSUAttributeTag tags[] = { kATSUCGContextTag };
1120     ByteCount sizes[] = { sizeof(CGContextRef) };
1121     ATSUAttributeValuePtr values[] = { &context };
1122     ATSUSetLayoutControls(layout, 1, tags, sizes, values);
1123
1124     if (! (flags & DRAW_TRANSP))
1125     {
1126         [bg set];
1127         NSRectFill(rect);
1128     }
1129
1130     [fg set];
1131
1132     ATSUSetTransientFontMatching(layout, TRUE);
1133     ATSUDrawText(layout,
1134                  kATSUFromTextBeginning,
1135                  kATSUToTextEnd,
1136                  X2Fix(rect.origin.x),
1137                  X2Fix(rect.origin.y + ascender));
1138     ATSUDisposeTextLayout(layout);
1139
1140     if (flags & DRAW_UNDERL)
1141     {
1142         [fg set];
1143         NSRectFill(NSMakeRect(rect.origin.x,
1144                               (row + 1) * cellSize.height + kUnderlineOffset,
1145                               rect.size.width, kUnderlineHeight));
1146     }
1147
1148     if (flags & DRAW_UNDERC)
1149     {
1150         [sp set];
1151
1152         float line_end_x = rect.origin.x + rect.size.width;
1153         int i = 0;
1154         NSRect line_rect = NSMakeRect(
1155                 rect.origin.x,
1156                 (row + 1) * cellSize.height + kUndercurlOffset,
1157                 kUndercurlDotWidth, kUndercurlHeight);
1158
1159         while (line_rect.origin.x < line_end_x)
1160         {
1161             if (i % 2)
1162                 NSRectFill(line_rect);
1163
1164             line_rect.origin.x += kUndercurlDotDistance;
1165             i++;
1166         }
1167     }
1168 }
1169
1170 - (void)scrollRect:(NSRect)rect lineCount:(int)count
1171 {
1172     NSPoint destPoint = rect.origin;
1173     destPoint.y += count * cellSize.height;
1174
1175     NSCopyBits(0, rect, destPoint);
1176 }
1177
1178 - (void)deleteLinesFromRow:(int)row lineCount:(int)count
1179               scrollBottom:(int)bottom left:(int)left right:(int)right
1180                      color:(NSColor *)color
1181 {
1182     NSRect rect = [self rectFromRow:row + count
1183                              column:left
1184                               toRow:bottom
1185                              column:right];
1186     [color set];
1187     // move rect up for count lines
1188     [self scrollRect:rect lineCount:-count];
1189     [self clearBlockFromRow:bottom - count + 1
1190                      column:left
1191                       toRow:bottom
1192                      column:right
1193                       color:color];
1194 }
1195
1196 - (void)insertLinesAtRow:(int)row lineCount:(int)count
1197             scrollBottom:(int)bottom left:(int)left right:(int)right
1198                    color:(NSColor *)color
1199 {
1200     NSRect rect = [self rectFromRow:row
1201                              column:left
1202                               toRow:bottom - count
1203                              column:right];
1204     [color set];
1205     // move rect down for count lines
1206     [self scrollRect:rect lineCount:count];
1207     [self clearBlockFromRow:row
1208                      column:left
1209                       toRow:row + count - 1
1210                      column:right
1211                       color:color];
1212 }
1213
1214 - (void)clearBlockFromRow:(int)row1 column:(int)col1 toRow:(int)row2
1215                    column:(int)col2 color:(NSColor *)color
1216 {
1217     [color set];
1218     NSRectFill([self rectFromRow:row1 column:col1 toRow:row2 column:col2]);
1219 }
1220
1221 - (void)clearAll
1222 {
1223     [defaultBackgroundColor set];
1224     NSRectFill(NSMakeRect(0, 0, imageSize.width, imageSize.height));
1225 }
1226
1227 - (void)drawInsertionPointAtRow:(int)row column:(int)col shape:(int)shape
1228                        fraction:(int)percent
1229 {
1230     NSPoint origin = [self originForRow:row column:col];
1231     NSRect rect = NSMakeRect(origin.x, origin.y,
1232                              cellSize.width, cellSize.height);
1233
1234     // NSLog(@"shape = %d, fraction: %d", shape, percent);
1235
1236     if (MMInsertionPointHorizontal == shape) {
1237         int frac = (cellSize.height * percent + 99)/100;
1238         rect.origin.y += rect.size.height - frac;
1239         rect.size.height = frac;
1240     } else if (MMInsertionPointVertical == shape) {
1241         int frac = (cellSize.width * percent + 99)/100;
1242         rect.size.width = frac;
1243     } else if (MMInsertionPointVerticalRight == shape) {
1244         int frac = (cellSize.width * percent + 99)/100;
1245         rect.origin.x += rect.size.width - frac;
1246         rect.size.width = frac;
1247     }
1248
1249     [[helper insertionPointColor] set];
1250     if (MMInsertionPointHollow == shape) {
1251         NSFrameRect(rect);
1252     } else {
1253         NSRectFill(rect);
1254     }
1255 }
1256
1257 - (void)drawInvertedRectAtRow:(int)row column:(int)col numRows:(int)nrows
1258                    numColumns:(int)ncols
1259 {
1260     // TODO: THIS CODE HAS NOT BEEN TESTED!
1261     CGContextRef cgctx = [[NSGraphicsContext currentContext] graphicsPort];
1262     CGContextSaveGState(cgctx);
1263     CGContextSetBlendMode(cgctx, kCGBlendModeDifference);
1264     CGContextSetRGBFillColor(cgctx, 1.0, 1.0, 1.0, 1.0);
1265
1266     CGRect rect = { col * cellSize.width, row * cellSize.height,
1267                     ncols * cellSize.width, nrows * cellSize.height };
1268     CGContextFillRect(cgctx, rect);
1269
1270     CGContextRestoreGState(cgctx);
1271 }
1272
1273 @end // MMAtsuiTextView (Drawing)