gui_macvim.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 <Foundation/Foundation.h>
  12 #import "MMBackend.h"
  13 #import "MacVim.h"
  14 #import "vim.h"
  15
  16
  17 static BOOL gui_macvim_is_valid_action(NSString *action);
  18
  19
  20 // -- Initialization --------------------------------------------------------
  21
  22 /*
  23  * Parse the GUI related command-line arguments.  Any arguments used are
  24  * deleted from argv, and *argc is decremented accordingly.  This is called
  25  * when vim is started, whether or not the GUI has been started.
  26  */
  27     void
  28 gui_mch_prepare(int *argc, char **argv)
  29 {
  30     //NSLog(@"gui_mch_prepare(argc=%d)", *argc);
  31
  32     // Set environment variables $VIM and $VIMRUNTIME
  33     // NOTE!  If vim_getenv is called with one of these as parameters before
  34     // they have been set here, they will most likely end up with the wrong
  35     // values!
  36     //
  37     // TODO:
  38     // - ensure this is called first to avoid above problem
  39     // - encoding
  40
  41     NSString *path = [[[NSBundle mainBundle] resourcePath]
  42         stringByAppendingPathComponent:@"vim"];
  43     vim_setenv((char_u*)"VIM", (char_u*)[path UTF8String]);
  44
  45     path = [path stringByAppendingPathComponent:@"runtime"];
  46     vim_setenv((char_u*)"VIMRUNTIME", (char_u*)[path UTF8String]);
  47 }
  48
  49
  50 /*
  51  * Check if the GUI can be started.  Called before gvimrc is sourced.
  52  * Return OK or FAIL.
  53  */
  54     int
  55 gui_mch_init_check(void)
  56 {
  57     //NSLog(@"gui_mch_init_check()");
  58     return OK;
  59 }
  60
  61
  62 /*
  63  * Initialise the GUI.  Create all the windows, set up all the call-backs etc.
  64  * Returns OK for success, FAIL when the GUI can't be started.
  65  */
  66     int
  67 gui_mch_init(void)
  68 {
  69     //NSLog(@"gui_mch_init()");
  70
  71     if (![[MMBackend sharedInstance] checkin])
  72         return FAIL;
  73
  74     // HACK!  Force the 'termencoding to utf-8.  For the moment also force
  75     // 'encoding', although this will change in the future.  The user can still
  76     // change 'encoding'; doing so WILL crash the program.
  77     set_option_value((char_u *)"termencoding", 0L, (char_u *)"utf-8", 0);
  78     set_option_value((char_u *)"encoding", 0L, (char_u *)"utf-8", 0);
  79
  80     // Set values so that pixels and characters are in one-to-one
  81     // correspondence (assuming all characters have the same dimensions).
  82     gui.scrollbar_width = gui.scrollbar_height = 0;
  83
  84     gui.char_height = 1;
  85     gui.char_width = 1;
  86     gui.char_ascent = 0;
  87
  88     gui_mch_def_colors();
  89
  90     [[MMBackend sharedInstance]
  91         setDefaultColorsBackground:gui.back_pixel foreground:gui.norm_pixel];
  92     [[MMBackend sharedInstance] setBackgroundColor:gui.back_pixel];
  93     [[MMBackend sharedInstance] setForegroundColor:gui.norm_pixel];
  94
  95     // NOTE: If this call is left out the cursor is opaque.
  96     highlight_gui_started();
  97
  98     return OK;
  99 }
 100
 101
 102
 103     void
 104 gui_mch_exit(int rc)
 105 {
 106     //NSLog(@"gui_mch_exit(rc=%d)", rc);
 107
 108     [[MMBackend sharedInstance] exit];
 109 }
 110
 111
 112 /*
 113  * Open the GUI window which was created by a call to gui_mch_init().
 114  */
 115     int
 116 gui_mch_open(void)
 117 {
 118     //NSLog(@"gui_mch_open()");
 119
 120     return [[MMBackend sharedInstance] openVimWindow];
 121 }
 122
 123
 124 // -- Updating --------------------------------------------------------------
 125
 126
 127 /*
 128  * Catch up with any queued X events.  This may put keyboard input into the
 129  * input buffer, call resize call-backs, trigger timers etc.  If there is
 130  * nothing in the X event queue (& no timers pending), then we return
 131  * immediately.
 132  */
 133     void
 134 gui_mch_update(void)
 135 {
 136     // TODO: Ensure that this causes no problems.
 137     [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode
 138                              beforeDate:[NSDate distantPast]];
 139 }
 140
 141
 142 /* Flush any output to the screen */
 143     void
 144 gui_mch_flush(void)
 145 {
 146     [[MMBackend sharedInstance] flushQueue:NO];
 147 }
 148
 149
 150 /*
 151  * GUI input routine called by gui_wait_for_chars().  Waits for a character
 152  * from the keyboard.
 153  *  wtime == -1     Wait forever.
 154  *  wtime == 0      This should never happen.
 155  *  wtime > 0       Wait wtime milliseconds for a character.
 156  * Returns OK if a character was found to be available within the given time,
 157  * or FAIL otherwise.
 158  */
 159     int
 160 gui_mch_wait_for_chars(int wtime)
 161 {
 162     // NOTE! In all likelihood Vim will take a nap when waitForInput: is
 163     // called, so force a flush of the command queue here.
 164     [[MMBackend sharedInstance] flushQueue:YES];
 165
 166     return [[MMBackend sharedInstance] waitForInput:wtime];
 167 }
 168
 169
 170 // -- Drawing ---------------------------------------------------------------
 171
 172
 173 /*
 174  * Clear the whole text window.
 175  */
 176     void
 177 gui_mch_clear_all(void)
 178 {
 179     [[MMBackend sharedInstance] clearAll];
 180 }
 181
 182
 183 /*
 184  * Clear a rectangular region of the screen from text pos (row1, col1) to
 185  * (row2, col2) inclusive.
 186  */
 187     void
 188 gui_mch_clear_block(int row1, int col1, int row2, int col2)
 189 {
 190     [[MMBackend sharedInstance] clearBlockFromRow:row1 column:col1
 191                                                     toRow:row2 column:col2];
 192 }
 193
 194
 195 /*
 196  * Delete the given number of lines from the given row, scrolling up any
 197  * text further down within the scroll region.
 198  */
 199     void
 200 gui_mch_delete_lines(int row, int num_lines)
 201 {
 202     [[MMBackend sharedInstance] deleteLinesFromRow:row count:num_lines
 203             scrollBottom:gui.scroll_region_bot
 204                     left:gui.scroll_region_left
 205                    right:gui.scroll_region_right];
 206 }
 207
 208
 209     void
 210 gui_mch_draw_string(int row, int col, char_u *s, int len, int flags)
 211 {
 212     [[MMBackend sharedInstance] replaceString:(char*)s length:len
 213             row:row column:col flags:flags];
 214 }
 215
 216
 217     int
 218 gui_macvim_draw_string(int row, int col, char_u *s, int len, int flags)
 219 {
 220 #if 0
 221     NSString *string = [[NSString alloc]
 222             initWithBytesNoCopy:(void*)s
 223                          length:len
 224                        encoding:NSUTF8StringEncoding
 225                    freeWhenDone:NO];
 226     int cells = [string length];
 227     [string release];
 228
 229     NSLog(@"gui_macvim_draw_string(row=%d, col=%d, len=%d, cells=%d, flags=%d)",
 230             row, col, len, cells, flags);
 231
 232     [[MMBackend sharedInstance] replaceString:(char*)s length:len
 233             row:row column:col flags:flags];
 234
 235     return cells;
 236 #elif 0
 237     int c;
 238     int cn;
 239     int cl;
 240     int i;
 241     BOOL wide = NO;
 242     int start = 0;
 243     int endcol = col;
 244     int startcol = col;
 245     MMBackend *backend = [MMBackend sharedInstance];
 246
 247     for (i = 0; i < len; i += cl) {
 248         c = utf_ptr2char(s + i);
 249         cl = utf_ptr2len(s + i);
 250         cn = utf_char2cells(c);
 251         comping = utf_iscomposing(c);
 252
 253         if (!comping)
 254             endcol += cn;
 255
 256         if (cn > 1 && !wide) {
 257             // Start of wide characters.
 258             wide = YES;
 259
 260             // Output non-wide characters.
 261             if (start > i) {
 262                 NSLog(@"Outputting %d non-wide chars (%d bytes)",
 263                         endcol-startcol, start-i);
 264                 [backend replaceString:(char*)(s+start) length:start-i
 265                         row:row column:startcol flags:flags];
 266                 startcol = endcol;
 267                 start = i;
 268             }
 269         } else if (cn <= 1 && !comping && wide) {
 270             // End of wide characters.
 271             wide = NO;
 272
 273             // Output wide characters.
 274             if (start > i) {
 275                 NSLog(@"Outputting %d wide chars (%d bytes)",
 276                         endcol-startcol, start-i);
 277                 [backend replaceString:(char*)(s+start) length:start-i
 278                         row:row column:startcol flags:(flags|0x80)];
 279                 startcol = endcol;
 280                 start = i;
 281             }
 282         }
 283     }
 284
 285     // Output remaining characters.
 286     flags = wide ? flags|0x80 : flags;
 287     NSLog(@"Outputting %d %s chars (%d bytes)", endcol-startcol, wide ? "wide"
 288             : "non-wide", len-start);
 289     [backend replaceString:(char*)(s+start) length:len-start
 290             row:row column:startcol flags:flags];
 291
 292     return endcol - col;
 293 #elif 1
 294     //
 295     // Output chars until a wide char found.  If a wide char is found, output a
 296     // zero-width space after it so that a wide char looks like two chars to
 297     // MMTextStorage.  This way 1 char corresponds to 1 column.
 298     //
 299
 300     int c;
 301     int cn;
 302     int cl;
 303     int i;
 304     int start = 0;
 305     int endcol = col;
 306     int startcol = col;
 307     BOOL outPad = NO;
 308     MMBackend *backend = [MMBackend sharedInstance];
 309     static char ZeroWidthSpace[] = { 0xe2, 0x80, 0x8b };
 310 #if MM_ENABLE_CONV
 311     char_u *conv_str = NULL;
 312
 313     if (output_conv.vc_type != CONV_NONE) {
 314         char_u *conv_str = string_convert(&output_conv, s, &len);
 315         if (conv_str)
 316             s = conv_str;
 317     }
 318 #endif
 319
 320     for (i = 0; i < len; i += cl) {
 321         c = utf_ptr2char(s + i);
 322         cl = utf_ptr2len(s + i);
 323         cn = utf_char2cells(c);
 324
 325         if (!utf_iscomposing(c)) {
 326             if (outPad) {
 327                 outPad = NO;
 328 #if 0
 329                 NSString *string = [[NSString alloc]
 330                         initWithBytesNoCopy:(void*)(s+start)
 331                                      length:i-start
 332                                    encoding:NSUTF8StringEncoding
 333                                freeWhenDone:NO];
 334                 NSLog(@"Flushing string=%@ len=%d row=%d col=%d end=%d",
 335                         string, i-start, row, startcol, endcol);
 336                 [string release];
 337 #endif
 338                 [backend replaceString:(char*)(s+start) length:i-start
 339                         row:row column:startcol flags:flags];
 340                 start = i;
 341                 startcol = endcol;
 342 #if 0
 343                 NSLog(@"Padding len=%d row=%d col=%d", sizeof(ZeroWidthSpace),
 344                         row, endcol-1);
 345 #endif
 346                 [backend replaceString:ZeroWidthSpace
 347                              length:sizeof(ZeroWidthSpace)
 348                         row:row column:endcol-1 flags:flags];
 349             }
 350
 351             endcol += cn;
 352         }
 353
 354         if (cn > 1) {
 355 #if 0
 356             NSLog(@"Wide char detected! (char=%C hex=%x cells=%d)", c, c, cn);
 357 #endif
 358             outPad = YES;
 359         }
 360     }
 361
 362 #if 0
 363     if (row < 1) {
 364         NSString *string = [[NSString alloc]
 365                 initWithBytesNoCopy:(void*)(s+start)
 366                              length:len-start
 367                            encoding:NSUTF8StringEncoding
 368                        freeWhenDone:NO];
 369         NSLog(@"Output string=%@ len=%d row=%d col=%d", string, len-start, row,
 370                 startcol);
 371         [string release];
 372     }
 373 #endif
 374
 375     // Output remaining characters.
 376     [backend replaceString:(char*)(s+start) length:len-start
 377             row:row column:startcol flags:flags];
 378
 379     if (outPad) {
 380 #if 0
 381         NSLog(@"Padding len=%d row=%d col=%d", sizeof(ZeroWidthSpace), row,
 382                 endcol-1);
 383 #endif
 384         [backend replaceString:ZeroWidthSpace
 385                      length:sizeof(ZeroWidthSpace)
 386                 row:row column:endcol-1 flags:flags];
 387     }
 388
 389 #if MM_ENABLE_CONV
 390     if (conv_str)
 391         vim_free(conv_str);
 392 #endif
 393
 394     return endcol - col;
 395 #else
 396     // This will fail abysmally when wide or composing characters are used.
 397     [[MMBackend sharedInstance]
 398             replaceString:(char*)s length:len row:row column:col flags:flags];
 399
 400     int i, c, cl, cn, cells = 0;
 401     for (i = 0; i < len; i += cl) {
 402         c = utf_ptr2char(s + i);
 403         cl = utf_ptr2len(s + i);
 404         cn = utf_char2cells(c);
 405
 406         if (!utf_iscomposing(c))
 407             cells += cn;
 408     }
 409
 410     return cells;
 411 #endif
 412 }
 413
 414
 415 /*
 416  * Insert the given number of lines before the given row, scrolling down any
 417  * following text within the scroll region.
 418  */
 419     void
 420 gui_mch_insert_lines(int row, int num_lines)
 421 {
 422     [[MMBackend sharedInstance] insertLinesFromRow:row count:num_lines
 423             scrollBottom:gui.scroll_region_bot
 424                     left:gui.scroll_region_left
 425                    right:gui.scroll_region_right];
 426 }
 427
 428
 429 /*
 430  * Set the current text foreground color.
 431  */
 432     void
 433 gui_mch_set_fg_color(guicolor_T color)
 434 {
 435     [[MMBackend sharedInstance] setForegroundColor:color];
 436 }
 437
 438
 439 /*
 440  * Set the current text background color.
 441  */
 442     void
 443 gui_mch_set_bg_color(guicolor_T color)
 444 {
 445     [[MMBackend sharedInstance] setBackgroundColor:color];
 446 }
 447
 448
 449 /*
 450  * Set the current text special color (used for underlines).
 451  */
 452     void
 453 gui_mch_set_sp_color(guicolor_T color)
 454 {
 455     [[MMBackend sharedInstance] setSpecialColor:color];
 456 }
 457
 458
 459 /*
 460  * Set default colors.
 461  */
 462     void
 463 gui_mch_def_colors()
 464 {
 465     // Default foreground and background colors are black and white.
 466     gui.def_norm_pixel = gui.norm_pixel = 0;
 467     gui.def_back_pixel = gui.back_pixel = 0xffffff;
 468 }
 469
 470
 471 /*
 472  * Called when the foreground or background color has been changed.
 473  */
 474     void
 475 gui_mch_new_colors(void)
 476 {
 477     gui.def_back_pixel = gui.back_pixel;
 478     gui.def_norm_pixel = gui.norm_pixel;
 479
 480     //NSLog(@"gui_mch_new_colors(back=%x, norm=%x)", gui.def_back_pixel,
 481     //        gui.def_norm_pixel);
 482
 483     [[MMBackend sharedInstance]
 484         setDefaultColorsBackground:gui.def_back_pixel
 485                         foreground:gui.def_norm_pixel];
 486 }
 487
 488
 489 // -- Tabline ---------------------------------------------------------------
 490
 491
 492 /*
 493  * Set the current tab to "nr".  First tab is 1.
 494  */
 495     void
 496 gui_mch_set_curtab(int nr)
 497 {
 498     [[MMBackend sharedInstance] selectTab:nr];
 499 }
 500
 501
 502 /*
 503  * Return TRUE when tabline is displayed.
 504  */
 505     int
 506 gui_mch_showing_tabline(void)
 507 {
 508     return [[MMBackend sharedInstance] tabBarVisible];
 509 }
 510
 511 /*
 512  * Update the labels of the tabline.
 513  */
 514     void
 515 gui_mch_update_tabline(void)
 516 {
 517     [[MMBackend sharedInstance] updateTabBar];
 518 }
 519
 520 /*
 521  * Show or hide the tabline.
 522  */
 523     void
 524 gui_mch_show_tabline(int showit)
 525 {
 526     [[MMBackend sharedInstance] showTabBar:showit];
 527 }
 528
 529
 530 // -- Clipboard -------------------------------------------------------------
 531
 532
 533     void
 534 clip_mch_lose_selection(VimClipboard *cbd)
 535 {
 536 }
 537
 538
 539     int
 540 clip_mch_own_selection(VimClipboard *cbd)
 541 {
 542     return 0;
 543 }
 544
 545
 546     void
 547 clip_mch_request_selection(VimClipboard *cbd)
 548 {
 549     NSPasteboard *pb = [NSPasteboard generalPasteboard];
 550     NSString *pbType = [pb availableTypeFromArray:
 551             [NSArray arrayWithObject:NSStringPboardType]];
 552     if (pbType) {
 553         NSMutableString *string =
 554                 [[pb stringForType:NSStringPboardType] mutableCopy];
 555
 556         // Replace unrecognized end-of-line sequences with \x0a (line feed).
 557         NSRange range = { 0, [string length] };
 558         unsigned n = [string replaceOccurrencesOfString:@"\x0d\x0a"
 559                                              withString:@"\x0a" options:0
 560                                                   range:range];
 561         if (0 == n) {
 562             n = [string replaceOccurrencesOfString:@"\x0d" withString:@"\x0a"
 563                                            options:0 range:range];
 564         }
 565
 566         // Scan for newline character to decide whether the string should be
 567         // pasted linewise or characterwise.
 568         int type = MCHAR;
 569         if (0 < n || NSNotFound != [string rangeOfString:@"\n"].location)
 570             type = MLINE;
 571
 572         char_u *str = (char_u*)[string UTF8String];
 573         int len = [string lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 574
 575 #if MM_ENABLE_CONV
 576         if (input_conv.vc_type != CONV_NONE) {
 577             NSLog(@"Converting from: '%@'", string);
 578             char_u *conv_str = string_convert(&input_conv, str, &len);
 579             if (conv_str) {
 580                 NSLog(@"           to: '%s'", conv_str);
 581                 clip_yank_selection(type, conv_str, len, cbd);
 582                 vim_free(conv_str);
 583                 return;
 584             }
 585         }
 586 #endif
 587
 588         clip_yank_selection(type, str, len, cbd);
 589     }
 590 }
 591
 592
 593 /*
 594  * Send the current selection to the clipboard.
 595  */
 596     void
 597 clip_mch_set_selection(VimClipboard *cbd)
 598 {
 599     // If the '*' register isn't already filled in, fill it in now.
 600     cbd->owned = TRUE;
 601     clip_get_selection(cbd);
 602     cbd->owned = FALSE;
 603
 604     // Get the text to put on the pasteboard.
 605     long_u llen = 0; char_u *str = 0;
 606     int type = clip_convert_selection(&str, &llen, cbd);
 607     if (type < 0)
 608         return;
 609
 610     // TODO: Avoid overflow.
 611     int len = (int)llen;
 612 #if MM_ENABLE_CONV
 613     if (output_conv.vc_type != CONV_NONE) {
 614         char_u *conv_str = string_convert(&output_conv, str, &len);
 615         if (conv_str) {
 616             vim_free(str);
 617             str = conv_str;
 618         }
 619     }
 620 #endif
 621
 622     if (len > 0) {
 623         NSString *string = [[NSString alloc]
 624             initWithBytes:str length:len encoding:NSUTF8StringEncoding];
 625
 626         NSPasteboard *pb = [NSPasteboard generalPasteboard];
 627         [pb declareTypes:[NSArray arrayWithObject:NSStringPboardType]
 628                    owner:nil];
 629         [pb setString:string forType:NSStringPboardType];
 630
 631         [string release];
 632     }
 633
 634     vim_free(str);
 635 }
 636
 637
 638 // -- Menu ------------------------------------------------------------------
 639
 640
 641 /*
 642  * Add a sub menu to the menu bar.
 643  */
 644     void
 645 gui_mch_add_menu(vimmenu_T *menu, int idx)
 646 {
 647     // HACK!  If menu has no parent, then we set the parent tag to the type of
 648     // menu it is.  This will not mix up tag and type because pointers can not
 649     // take values close to zero (and the tag is simply the value of the
 650     // pointer).
 651     int parent = (int)menu->parent;
 652     if (!parent) {
 653         parent = menu_is_popup(menu->name) ? MenuPopupType :
 654                  menu_is_toolbar(menu->name) ? MenuToolbarType :
 655                  MenuMenubarType;
 656     }
 657
 658     [[MMBackend sharedInstance]
 659             addMenuWithTag:(int)menu parent:parent name:(char*)menu->dname
 660                    atIndex:idx];
 661 }
 662
 663
 664 /*
 665  * Add a menu item to a menu
 666  */
 667     void
 668 gui_mch_add_menu_item(vimmenu_T *menu, int idx)
 669 {
 670     // NOTE!  If 'iconfile' is not set but 'iconidx' is, use the name of the
 671     // menu item.  (Should correspond to a stock item.)
 672     char *icon = menu->iconfile ? (char*)menu->iconfile :
 673                  menu->iconidx >= 0 ? (char*)menu->dname :
 674                  NULL;
 675     //char *name = menu_is_separator(menu->name) ? NULL : (char*)menu->dname;
 676     char *name = (char*)menu->dname;
 677     char *tip = menu->strings[MENU_INDEX_TIP]
 678             ? (char*)menu->strings[MENU_INDEX_TIP] : (char*)menu->actext;
 679
 680     // HACK!  Check if menu is mapped to ':action actionName:'; if so, pass the
 681     // action along so that MacVim can bind the menu item to this action.  This
 682     // means that if a menu item maps to an action in normal mode, then all
 683     // other modes will also use the same action.
 684     NSString *action = nil;
 685     char_u *map_str = menu->strings[MENU_INDEX_NORMAL];
 686     if (map_str) {
 687         NSString *mapping = [NSString stringWithCString:(char*)map_str
 688                                                encoding:NSUTF8StringEncoding];
 689         NSArray *parts = [mapping componentsSeparatedByString:@" "];
 690         if ([parts count] >=2
 691                 && [[parts objectAtIndex:0] isEqual:@":action"]) {
 692             action = [parts objectAtIndex:1];
 693             action = [action stringByTrimmingCharactersInSet:
 694                     [NSCharacterSet whitespaceAndNewlineCharacterSet]];
 695             if (!gui_macvim_is_valid_action(action))
 696                 action = nil;
 697         }
 698     }
 699
 700     [[MMBackend sharedInstance]
 701             addMenuItemWithTag:(int)menu
 702                         parent:(int)menu->parent
 703                           name:name
 704                            tip:tip
 705                           icon:(char*)icon
 706                  keyEquivalent:menu->ke_key
 707                      modifiers:menu->ke_mods
 708                         action:action
 709                        atIndex:idx];
 710 }
 711
 712
 713 /*
 714  * Destroy the machine specific menu widget.
 715  */
 716     void
 717 gui_mch_destroy_menu(vimmenu_T *menu)
 718 {
 719     [[MMBackend sharedInstance] removeMenuItemWithTag:(int)menu];
 720 }
 721
 722
 723 /*
 724  * Make a menu either grey or not grey.
 725  */
 726     void
 727 gui_mch_menu_grey(vimmenu_T *menu, int grey)
 728 {
 729     [[MMBackend sharedInstance]
 730             enableMenuItemWithTag:(int)menu state:!grey];
 731 }
 732
 733
 734 /*
 735  * Make menu item hidden or not hidden
 736  */
 737     void
 738 gui_mch_menu_hidden(vimmenu_T *menu, int hidden)
 739 {
 740     // HACK! There is no (obvious) way to hide a menu item, so simply
 741     // enable/disable it instead.
 742     [[MMBackend sharedInstance]
 743             enableMenuItemWithTag:(int)menu state:!hidden];
 744 }
 745
 746
 747 /*
 748  * This is called when user right clicks.
 749  */
 750     void
 751 gui_mch_show_popupmenu(vimmenu_T *menu)
 752 {
 753     [[MMBackend sharedInstance] showPopupMenuWithName:(char*)menu->name
 754                                       atMouseLocation:YES];
 755 }
 756
 757
 758 /*
 759  * This is called when a :popup command is executed.
 760  */
 761     void
 762 gui_make_popup(char_u *path_name, int mouse_pos)
 763 {
 764     [[MMBackend sharedInstance] showPopupMenuWithName:(char*)path_name
 765                                       atMouseLocation:mouse_pos];
 766 }
 767
 768
 769 /*
 770  * This is called after setting all the menus to grey/hidden or not.
 771  */
 772     void
 773 gui_mch_draw_menubar(void)
 774 {
 775     // The (main) menu draws itself in Mac OS X.
 776 }
 777
 778
 779     void
 780 gui_mch_enable_menu(int flag)
 781 {
 782     // The (main) menu is always enabled in Mac OS X.
 783 }
 784
 785
 786 #if 0
 787     void
 788 gui_mch_set_menu_pos(int x, int y, int w, int h)
 789 {
 790     // The (main) menu cannot be moved in Mac OS X.
 791 }
 792 #endif
 793
 794
 795     void
 796 gui_mch_show_toolbar(int showit)
 797 {
 798     int flags = 0;
 799     if (toolbar_flags & TOOLBAR_TEXT) flags |= ToolbarLabelFlag;
 800     if (toolbar_flags & TOOLBAR_ICONS) flags |= ToolbarIconFlag;
 801     if (tbis_flags & (TBIS_MEDIUM|TBIS_LARGE)) flags |= ToolbarSizeRegularFlag;
 802
 803     [[MMBackend sharedInstance] showToolbar:showit flags:flags];
 804 }
 805
 806
 807
 808
 809 // -- Fonts -----------------------------------------------------------------
 810
 811
 812 /*
 813  * If a font is not going to be used, free its structure.
 814  */
 815     void
 816 gui_mch_free_font(font)
 817     GuiFont     font;
 818 {
 819 }
 820
 821
 822 /*
 823  * Get a font structure for highlighting.
 824  */
 825     GuiFont
 826 gui_mch_get_font(char_u *name, int giveErrorIfMissing)
 827 {
 828     //NSLog(@"gui_mch_get_font(name=%s, giveErrorIfMissing=%d)", name,
 829     //        giveErrorIfMissing);
 830     return 0;
 831 }
 832
 833
 834 #if defined(FEAT_EVAL) || defined(PROTO)
 835 /*
 836  * Return the name of font "font" in allocated memory.
 837  * Don't know how to get the actual name, thus use the provided name.
 838  */
 839     char_u *
 840 gui_mch_get_fontname(GuiFont font, char_u *name)
 841 {
 842     //NSLog(@"gui_mch_get_fontname(font=%d, name=%s)", font, name);
 843     return 0;
 844 }
 845 #endif
 846
 847
 848 /*
 849  * Initialise vim to use the font with the given name.  Return FAIL if the font
 850  * could not be loaded, OK otherwise.
 851  */
 852     int
 853 gui_mch_init_font(char_u *font_name, int fontset)
 854 {
 855     //NSLog(@"gui_mch_init_font(font_name=%s, fontset=%d)", font_name, fontset);
 856
 857     // HACK!  This gets called whenever the user types :set gfn=fontname, so
 858     // for now we set the font here.
 859     // TODO!  Proper font handling, the way Vim expects it.
 860     return [[MMBackend sharedInstance]
 861             setFontWithName:(char*)font_name];
 862 }
 863
 864
 865 /*
 866  * Set the current text font.
 867  */
 868     void
 869 gui_mch_set_font(GuiFont font)
 870 {
 871 }
 872
 873
 874 // -- Scrollbars ------------------------------------------------------------
 875
 876
 877     void
 878 gui_mch_create_scrollbar(
 879         scrollbar_T *sb,
 880         int orient)     /* SBAR_VERT or SBAR_HORIZ */
 881 {
 882     [[MMBackend sharedInstance]
 883             createScrollbarWithIdentifier:sb->ident type:sb->type];
 884 }
 885
 886
 887     void
 888 gui_mch_destroy_scrollbar(scrollbar_T *sb)
 889 {
 890     [[MMBackend sharedInstance]
 891             destroyScrollbarWithIdentifier:sb->ident];
 892 }
 893
 894
 895     void
 896 gui_mch_enable_scrollbar(
 897         scrollbar_T     *sb,
 898         int             flag)
 899 {
 900     [[MMBackend sharedInstance]
 901             showScrollbarWithIdentifier:sb->ident state:flag];
 902 }
 903
 904
 905     void
 906 gui_mch_set_scrollbar_pos(
 907         scrollbar_T *sb,
 908         int x,
 909         int y,
 910         int w,
 911         int h)
 912 {
 913     int pos = y;
 914     int len = h;
 915     if (SBAR_BOTTOM == sb->type) {
 916         pos = x;
 917         len = w;
 918     }
 919
 920     [[MMBackend sharedInstance]
 921             setScrollbarPosition:pos length:len identifier:sb->ident];
 922 }
 923
 924
 925     void
 926 gui_mch_set_scrollbar_thumb(
 927         scrollbar_T *sb,
 928         long val,
 929         long size,
 930         long max)
 931 {
 932     [[MMBackend sharedInstance]
 933             setScrollbarThumbValue:val size:size max:max identifier:sb->ident];
 934 }
 935
 936
 937 // -- Cursor ----------------------------------------------------------------
 938
 939
 940 /*
 941  * Draw a cursor without focus.
 942  */
 943     void
 944 gui_mch_draw_hollow_cursor(guicolor_T color)
 945 {
 946     return [[MMBackend sharedInstance]
 947         drawCursorAtRow:gui.row column:gui.col shape:MMInsertionPointHollow
 948                fraction:100 color:color];
 949 }
 950
 951
 952 /*
 953  * Draw part of a cursor, only w pixels wide, and h pixels high.
 954  */
 955     void
 956 gui_mch_draw_part_cursor(int w, int h, guicolor_T color)
 957 {
 958     // HACK!  'w' and 'h' are always 1 since we do not tell Vim about the exact
 959     // font dimensions.  Thus these parameters are useless.  Instead we look at
 960     // the shape_table to determine the shape and size of the cursor (just like
 961     // gui_update_cursor() does).
 962     int idx = get_shape_idx(FALSE);
 963     int shape = MMInsertionPointBlock;
 964     switch (shape_table[idx].shape) {
 965         case SHAPE_HOR: shape = MMInsertionPointHorizontal; break;
 966         case SHAPE_VER: shape = MMInsertionPointVertical; break;
 967     }
 968
 969     return [[MMBackend sharedInstance]
 970         drawCursorAtRow:gui.row column:gui.col shape:shape
 971                fraction:shape_table[idx].percentage color:color];
 972 }
 973
 974
 975 /*
 976  * Cursor blink functions.
 977  *
 978  * This is a simple state machine:
 979  * BLINK_NONE   not blinking at all
 980  * BLINK_OFF    blinking, cursor is not shown
 981  * BLINK_ON blinking, cursor is shown
 982  */
 983     void
 984 gui_mch_set_blinking(long wait, long on, long off)
 985 {
 986     [[MMBackend sharedInstance] setBlinkWait:wait on:on off:off];
 987 }
 988
 989
 990 /*
 991  * Start the cursor blinking.  If it was already blinking, this restarts the
 992  * waiting time and shows the cursor.
 993  */
 994     void
 995 gui_mch_start_blink(void)
 996 {
 997     [[MMBackend sharedInstance] startBlink];
 998 }
 999
1000
1001 /*
1002  * Stop the cursor blinking.  Show the cursor if it wasn't shown.
1003  */
1004     void
1005 gui_mch_stop_blink(void)
1006 {
1007     [[MMBackend sharedInstance] stopBlink];
1008 }
1009
1010
1011 // -- Mouse -----------------------------------------------------------------
1012
1013
1014 /*
1015  * Get current mouse coordinates in text window.
1016  */
1017     void
1018 gui_mch_getmouse(int *x, int *y)
1019 {
1020     //NSLog(@"gui_mch_getmouse()");
1021 }
1022
1023
1024     void
1025 gui_mch_setmouse(int x, int y)
1026 {
1027     //NSLog(@"gui_mch_setmouse(x=%d, y=%d)", x, y);
1028 }
1029
1030
1031     void
1032 mch_set_mouse_shape(int shape)
1033 {
1034     [[MMBackend sharedInstance] setMouseShape:shape];
1035 }
1036
1037
1038
1039
1040 // -- Unsorted --------------------------------------------------------------
1041
1042
1043     void
1044 ex_action(eap)
1045     exarg_T     *eap;
1046 {
1047     if (!gui.in_use) {
1048         EMSG(_("E???: Command only available in GUI mode"));
1049         return;
1050     }
1051
1052     NSString *name = [NSString stringWithCString:(char*)eap->arg
1053                                         encoding:NSUTF8StringEncoding];
1054     if (gui_macvim_is_valid_action(name)) {
1055         [[MMBackend sharedInstance] executeActionWithName:name];
1056     } else {
1057         EMSG2(_("E???: \"%s\" is not a valid action"), eap->arg);
1058     }
1059 }
1060
1061
1062 /*
1063  * Adjust gui.char_height (after 'linespace' was changed).
1064  */
1065     int
1066 gui_mch_adjust_charheight(void)
1067 {
1068     return 0;
1069 }
1070
1071
1072     void
1073 gui_mch_beep(void)
1074 {
1075 }
1076
1077
1078
1079 #ifdef FEAT_BROWSE
1080 /*
1081  * Pop open a file browser and return the file selected, in allocated memory,
1082  * or NULL if Cancel is hit.
1083  *  saving  - TRUE if the file will be saved to, FALSE if it will be opened.
1084  *  title   - Title message for the file browser dialog.
1085  *  dflt    - Default name of file.
1086  *  ext     - Default extension to be added to files without extensions.
1087  *  initdir - directory in which to open the browser (NULL = current dir)
1088  *  filter  - Filter for matched files to choose from.
1089  *  Has a format like this:
1090  *  "C Files (*.c)\0*.c\0"
1091  *  "All Files\0*.*\0\0"
1092  *  If these two strings were concatenated, then a choice of two file
1093  *  filters will be selectable to the user.  Then only matching files will
1094  *  be shown in the browser.  If NULL, the default allows all files.
1095  *
1096  *  *NOTE* - the filter string must be terminated with TWO nulls.
1097  */
1098     char_u *
1099 gui_mch_browse(
1100     int saving,
1101     char_u *title,
1102     char_u *dflt,
1103     char_u *ext,
1104     char_u *initdir,
1105     char_u *filter)
1106 {
1107     //NSLog(@"gui_mch_browse(saving=%d, title=%s, dflt=%s, ext=%s, initdir=%s,"
1108     //        " filter=%s", saving, title, dflt, ext, initdir, filter);
1109
1110     char_u *s = (char_u*)[[MMBackend sharedInstance]
1111             browseForFileInDirectory:(char*)initdir title:(char*)title
1112                               saving:saving];
1113
1114     return s;
1115 }
1116 #endif /* FEAT_BROWSE */
1117
1118
1119
1120     int
1121 gui_mch_dialog(
1122     int         type,
1123     char_u      *title,
1124     char_u      *message,
1125     char_u      *buttons,
1126     int         dfltbutton,
1127     char_u      *textfield)
1128 {
1129     //NSLog(@"gui_mch_dialog(type=%d title=%s message=%s buttons=%s "
1130     //        "dfltbutton=%d textfield=%s)", type, title, message, buttons,
1131     //        dfltbutton, textfield);
1132
1133     return [[MMBackend sharedInstance] presentDialogWithType:type
1134                                                        title:(char*)title
1135                                                      message:(char*)message
1136                                                      buttons:(char*)buttons
1137                                                    textField:(char*)textfield];
1138 }
1139
1140
1141     void
1142 gui_mch_flash(int msec)
1143 {
1144 }
1145
1146
1147 /*
1148  * Return the Pixel value (color) for the given color name.  This routine was
1149  * pretty much taken from example code in the Silicon Graphics OSF/Motif
1150  * Programmer's Guide.
1151  * Return INVALCOLOR when failed.
1152  */
1153     guicolor_T
1154 gui_mch_get_color(char_u *name)
1155 {
1156     NSString *key = [NSString stringWithUTF8String:(char*)name];
1157     return [[MMBackend sharedInstance] lookupColorWithKey:key];
1158 }
1159
1160
1161 /*
1162  * Return the RGB value of a pixel as long.
1163  */
1164     long_u
1165 gui_mch_get_rgb(guicolor_T pixel)
1166 {
1167     // This is only implemented so that vim can guess the correct value for
1168     // 'background' (which otherwise defaults to 'dark'); it is not used for
1169     // anything else (as far as I know).
1170     // The implementation is simple since colors are stored in an int as
1171     // "rrggbb".
1172     return pixel;
1173 }
1174
1175
1176 /*
1177  * Get the screen dimensions.
1178  * Allow 10 pixels for horizontal borders, 40 for vertical borders.
1179  * Is there no way to find out how wide the borders really are?
1180  * TODO: Add live udate of those value on suspend/resume.
1181  */
1182     void
1183 gui_mch_get_screen_dimensions(int *screen_w, int *screen_h)
1184 {
1185     //NSLog(@"gui_mch_get_screen_dimensions()");
1186     *screen_w = Columns;
1187     *screen_h = Rows;
1188 }
1189
1190
1191 /*
1192  * Get the position of the top left corner of the window.
1193  */
1194     int
1195 gui_mch_get_winpos(int *x, int *y)
1196 {
1197     *x = *y = 0;
1198     return OK;
1199 }
1200
1201
1202 /*
1203  * Return OK if the key with the termcap name "name" is supported.
1204  */
1205     int
1206 gui_mch_haskey(char_u *name)
1207 {
1208     NSLog(@"gui_mch_haskey(name=%s)", name);
1209     return 0;
1210 }
1211
1212
1213 /*
1214  * Iconify the GUI window.
1215  */
1216     void
1217 gui_mch_iconify(void)
1218 {
1219 }
1220
1221
1222 /*
1223  * Invert a rectangle from row r, column c, for nr rows and nc columns.
1224  */
1225     void
1226 gui_mch_invert_rectangle(int r, int c, int nr, int nc)
1227 {
1228 }
1229
1230
1231 #if defined(FEAT_EVAL) || defined(PROTO)
1232 /*
1233  * Bring the Vim window to the foreground.
1234  */
1235     void
1236 gui_mch_set_foreground(void)
1237 {
1238 }
1239 #endif
1240
1241
1242
1243     void
1244 gui_mch_set_shellsize(
1245     int         width,
1246     int         height,
1247     int         min_width,
1248     int         min_height,
1249     int         base_width,
1250     int         base_height,
1251     int         direction)
1252 {
1253     //NSLog(@"gui_mch_set_shellsize(width=%d, height=%d, min_width=%d,"
1254     //        " min_height=%d, base_width=%d, base_height=%d, direction=%d)",
1255     //        width, height, min_width, min_height, base_width, base_height,
1256     //        direction);
1257     [[MMBackend sharedInstance] setRows:height columns:width];
1258 }
1259
1260
1261     void
1262 gui_mch_set_text_area_pos(int x, int y, int w, int h)
1263 {
1264 }
1265
1266 /*
1267  * Set the position of the top left corner of the window to the given
1268  * coordinates.
1269  */
1270     void
1271 gui_mch_set_winpos(int x, int y)
1272 {
1273 }
1274
1275
1276 #ifdef FEAT_TITLE
1277 /*
1278  * Set the window title and icon.
1279  * (The icon is not taken care of).
1280  */
1281     void
1282 gui_mch_settitle(char_u *title, char_u *icon)
1283 {
1284     //NSLog(@"gui_mch_settitle(title=%s, icon=%s)", title, icon);
1285
1286     [[MMBackend sharedInstance] setVimWindowTitle:(char*)title];
1287 }
1288 #endif
1289
1290
1291     void
1292 gui_mch_toggle_tearoffs(int enable)
1293 {
1294 }
1295
1296
1297     static BOOL
1298 gui_macvim_is_valid_action(NSString *action)
1299 {
1300     static NSDictionary *actionDict = nil;
1301
1302     if (!actionDict) {
1303         NSBundle *mainBundle = [NSBundle mainBundle];
1304         NSString *path = [mainBundle pathForResource:@"Actions"
1305                                               ofType:@"plist"];
1306         if (path) {
1307             actionDict = [[NSDictionary alloc] initWithContentsOfFile:path];
1308         } else {
1309             // Allocate bogus dictionary so that error only pops up once.
1310             actionDict = [NSDictionary new];
1311             EMSG(_("E???: Failed to load action dictionary"));
1312         }
1313     }
1314
1315     return [actionDict objectForKey:action] != nil;
1316 }