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     MMBackend *backend = [MMBackend sharedInstance];
 466
 467     // The default colors are taken from system values
 468     gui.def_norm_pixel = gui.norm_pixel =
 469         [backend lookupColorWithKey:@"MacTextColor"];
 470     gui.def_back_pixel = gui.back_pixel =
 471         [backend lookupColorWithKey:@"MacTextBackgroundColor"];
 472 }
 473
 474
 475 /*
 476  * Called when the foreground or background color has been changed.
 477  */
 478     void
 479 gui_mch_new_colors(void)
 480 {
 481     gui.def_back_pixel = gui.back_pixel;
 482     gui.def_norm_pixel = gui.norm_pixel;
 483
 484     //NSLog(@"gui_mch_new_colors(back=%x, norm=%x)", gui.def_back_pixel,
 485     //        gui.def_norm_pixel);
 486
 487     [[MMBackend sharedInstance]
 488         setDefaultColorsBackground:gui.def_back_pixel
 489                         foreground:gui.def_norm_pixel];
 490 }
 491
 492
 493 // -- Tabline ---------------------------------------------------------------
 494
 495
 496 /*
 497  * Set the current tab to "nr".  First tab is 1.
 498  */
 499     void
 500 gui_mch_set_curtab(int nr)
 501 {
 502     [[MMBackend sharedInstance] selectTab:nr];
 503 }
 504
 505
 506 /*
 507  * Return TRUE when tabline is displayed.
 508  */
 509     int
 510 gui_mch_showing_tabline(void)
 511 {
 512     return [[MMBackend sharedInstance] tabBarVisible];
 513 }
 514
 515 /*
 516  * Update the labels of the tabline.
 517  */
 518     void
 519 gui_mch_update_tabline(void)
 520 {
 521     [[MMBackend sharedInstance] updateTabBar];
 522 }
 523
 524 /*
 525  * Show or hide the tabline.
 526  */
 527     void
 528 gui_mch_show_tabline(int showit)
 529 {
 530     [[MMBackend sharedInstance] showTabBar:showit];
 531 }
 532
 533
 534 // -- Clipboard -------------------------------------------------------------
 535
 536
 537     void
 538 clip_mch_lose_selection(VimClipboard *cbd)
 539 {
 540 }
 541
 542
 543     int
 544 clip_mch_own_selection(VimClipboard *cbd)
 545 {
 546     return 0;
 547 }
 548
 549
 550     void
 551 clip_mch_request_selection(VimClipboard *cbd)
 552 {
 553     NSPasteboard *pb = [NSPasteboard generalPasteboard];
 554     NSString *pbType = [pb availableTypeFromArray:
 555             [NSArray arrayWithObject:NSStringPboardType]];
 556     if (pbType) {
 557         NSMutableString *string =
 558                 [[pb stringForType:NSStringPboardType] mutableCopy];
 559
 560         // Replace unrecognized end-of-line sequences with \x0a (line feed).
 561         NSRange range = { 0, [string length] };
 562         unsigned n = [string replaceOccurrencesOfString:@"\x0d\x0a"
 563                                              withString:@"\x0a" options:0
 564                                                   range:range];
 565         if (0 == n) {
 566             n = [string replaceOccurrencesOfString:@"\x0d" withString:@"\x0a"
 567                                            options:0 range:range];
 568         }
 569
 570         // Scan for newline character to decide whether the string should be
 571         // pasted linewise or characterwise.
 572         int type = MCHAR;
 573         if (0 < n || NSNotFound != [string rangeOfString:@"\n"].location)
 574             type = MLINE;
 575
 576         char_u *str = (char_u*)[string UTF8String];
 577         int len = [string lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
 578
 579 #if MM_ENABLE_CONV
 580         if (input_conv.vc_type != CONV_NONE) {
 581             NSLog(@"Converting from: '%@'", string);
 582             char_u *conv_str = string_convert(&input_conv, str, &len);
 583             if (conv_str) {
 584                 NSLog(@"           to: '%s'", conv_str);
 585                 clip_yank_selection(type, conv_str, len, cbd);
 586                 vim_free(conv_str);
 587                 return;
 588             }
 589         }
 590 #endif
 591
 592         clip_yank_selection(type, str, len, cbd);
 593     }
 594 }
 595
 596
 597 /*
 598  * Send the current selection to the clipboard.
 599  */
 600     void
 601 clip_mch_set_selection(VimClipboard *cbd)
 602 {
 603     // If the '*' register isn't already filled in, fill it in now.
 604     cbd->owned = TRUE;
 605     clip_get_selection(cbd);
 606     cbd->owned = FALSE;
 607
 608     // Get the text to put on the pasteboard.
 609     long_u llen = 0; char_u *str = 0;
 610     int type = clip_convert_selection(&str, &llen, cbd);
 611     if (type < 0)
 612         return;
 613
 614     // TODO: Avoid overflow.
 615     int len = (int)llen;
 616 #if MM_ENABLE_CONV
 617     if (output_conv.vc_type != CONV_NONE) {
 618         char_u *conv_str = string_convert(&output_conv, str, &len);
 619         if (conv_str) {
 620             vim_free(str);
 621             str = conv_str;
 622         }
 623     }
 624 #endif
 625
 626     if (len > 0) {
 627         NSString *string = [[NSString alloc]
 628             initWithBytes:str length:len encoding:NSUTF8StringEncoding];
 629
 630         NSPasteboard *pb = [NSPasteboard generalPasteboard];
 631         [pb declareTypes:[NSArray arrayWithObject:NSStringPboardType]
 632                    owner:nil];
 633         [pb setString:string forType:NSStringPboardType];
 634
 635         [string release];
 636     }
 637
 638     vim_free(str);
 639 }
 640
 641
 642 // -- Menu ------------------------------------------------------------------
 643
 644
 645 /*
 646  * Add a sub menu to the menu bar.
 647  */
 648     void
 649 gui_mch_add_menu(vimmenu_T *menu, int idx)
 650 {
 651     // HACK!  If menu has no parent, then we set the parent tag to the type of
 652     // menu it is.  This will not mix up tag and type because pointers can not
 653     // take values close to zero (and the tag is simply the value of the
 654     // pointer).
 655     int parent = (int)menu->parent;
 656     if (!parent) {
 657         parent = menu_is_popup(menu->name) ? MenuPopupType :
 658                  menu_is_toolbar(menu->name) ? MenuToolbarType :
 659                  MenuMenubarType;
 660     }
 661
 662     [[MMBackend sharedInstance]
 663             addMenuWithTag:(int)menu parent:parent name:(char*)menu->dname
 664                    atIndex:idx];
 665 }
 666
 667
 668 /*
 669  * Add a menu item to a menu
 670  */
 671     void
 672 gui_mch_add_menu_item(vimmenu_T *menu, int idx)
 673 {
 674     // NOTE!  If 'iconfile' is not set but 'iconidx' is, use the name of the
 675     // menu item.  (Should correspond to a stock item.)
 676     char *icon = menu->iconfile ? (char*)menu->iconfile :
 677                  menu->iconidx >= 0 ? (char*)menu->dname :
 678                  NULL;
 679     //char *name = menu_is_separator(menu->name) ? NULL : (char*)menu->dname;
 680     char *name = (char*)menu->dname;
 681     char *tip = menu->strings[MENU_INDEX_TIP]
 682             ? (char*)menu->strings[MENU_INDEX_TIP] : (char*)menu->actext;
 683
 684     // HACK!  Check if menu is mapped to ':action actionName:'; if so, pass the
 685     // action along so that MacVim can bind the menu item to this action.  This
 686     // means that if a menu item maps to an action in normal mode, then all
 687     // other modes will also use the same action.
 688     NSString *action = nil;
 689     char_u *map_str = menu->strings[MENU_INDEX_NORMAL];
 690     if (map_str) {
 691         NSString *mapping = [NSString stringWithCString:(char*)map_str
 692                                                encoding:NSUTF8StringEncoding];
 693         NSArray *parts = [mapping componentsSeparatedByString:@" "];
 694         if ([parts count] >=2
 695                 && [[parts objectAtIndex:0] isEqual:@":action"]) {
 696             action = [parts objectAtIndex:1];
 697             action = [action stringByTrimmingCharactersInSet:
 698                     [NSCharacterSet whitespaceAndNewlineCharacterSet]];
 699             if (!gui_macvim_is_valid_action(action))
 700                 action = nil;
 701         }
 702     }
 703
 704     [[MMBackend sharedInstance]
 705             addMenuItemWithTag:(int)menu
 706                         parent:(int)menu->parent
 707                           name:name
 708                            tip:tip
 709                           icon:(char*)icon
 710                  keyEquivalent:menu->ke_key
 711                      modifiers:menu->ke_mods
 712                         action:action
 713                        atIndex:idx];
 714 }
 715
 716
 717 /*
 718  * Destroy the machine specific menu widget.
 719  */
 720     void
 721 gui_mch_destroy_menu(vimmenu_T *menu)
 722 {
 723     [[MMBackend sharedInstance] removeMenuItemWithTag:(int)menu];
 724 }
 725
 726
 727 /*
 728  * Make a menu either grey or not grey.
 729  */
 730     void
 731 gui_mch_menu_grey(vimmenu_T *menu, int grey)
 732 {
 733     [[MMBackend sharedInstance]
 734             enableMenuItemWithTag:(int)menu state:!grey];
 735 }
 736
 737
 738 /*
 739  * Make menu item hidden or not hidden
 740  */
 741     void
 742 gui_mch_menu_hidden(vimmenu_T *menu, int hidden)
 743 {
 744     // HACK! There is no (obvious) way to hide a menu item, so simply
 745     // enable/disable it instead.
 746     [[MMBackend sharedInstance]
 747             enableMenuItemWithTag:(int)menu state:!hidden];
 748 }
 749
 750
 751 /*
 752  * This is called when user right clicks.
 753  */
 754     void
 755 gui_mch_show_popupmenu(vimmenu_T *menu)
 756 {
 757     [[MMBackend sharedInstance] showPopupMenuWithName:(char*)menu->name
 758                                       atMouseLocation:YES];
 759 }
 760
 761
 762 /*
 763  * This is called when a :popup command is executed.
 764  */
 765     void
 766 gui_make_popup(char_u *path_name, int mouse_pos)
 767 {
 768     [[MMBackend sharedInstance] showPopupMenuWithName:(char*)path_name
 769                                       atMouseLocation:mouse_pos];
 770 }
 771
 772
 773 /*
 774  * This is called after setting all the menus to grey/hidden or not.
 775  */
 776     void
 777 gui_mch_draw_menubar(void)
 778 {
 779     // The (main) menu draws itself in Mac OS X.
 780 }
 781
 782
 783     void
 784 gui_mch_enable_menu(int flag)
 785 {
 786     // The (main) menu is always enabled in Mac OS X.
 787 }
 788
 789
 790 #if 0
 791     void
 792 gui_mch_set_menu_pos(int x, int y, int w, int h)
 793 {
 794     // The (main) menu cannot be moved in Mac OS X.
 795 }
 796 #endif
 797
 798
 799     void
 800 gui_mch_show_toolbar(int showit)
 801 {
 802     int flags = 0;
 803     if (toolbar_flags & TOOLBAR_TEXT) flags |= ToolbarLabelFlag;
 804     if (toolbar_flags & TOOLBAR_ICONS) flags |= ToolbarIconFlag;
 805     if (tbis_flags & (TBIS_MEDIUM|TBIS_LARGE)) flags |= ToolbarSizeRegularFlag;
 806
 807     [[MMBackend sharedInstance] showToolbar:showit flags:flags];
 808 }
 809
 810
 811
 812
 813 // -- Fonts -----------------------------------------------------------------
 814
 815
 816 /*
 817  * If a font is not going to be used, free its structure.
 818  */
 819     void
 820 gui_mch_free_font(font)
 821     GuiFont     font;
 822 {
 823 }
 824
 825
 826 /*
 827  * Get a font structure for highlighting.
 828  */
 829     GuiFont
 830 gui_mch_get_font(char_u *name, int giveErrorIfMissing)
 831 {
 832     //NSLog(@"gui_mch_get_font(name=%s, giveErrorIfMissing=%d)", name,
 833     //        giveErrorIfMissing);
 834     return 0;
 835 }
 836
 837
 838 #if defined(FEAT_EVAL) || defined(PROTO)
 839 /*
 840  * Return the name of font "font" in allocated memory.
 841  * Don't know how to get the actual name, thus use the provided name.
 842  */
 843     char_u *
 844 gui_mch_get_fontname(GuiFont font, char_u *name)
 845 {
 846     //NSLog(@"gui_mch_get_fontname(font=%d, name=%s)", font, name);
 847     return 0;
 848 }
 849 #endif
 850
 851
 852 /*
 853  * Initialise vim to use the font with the given name.  Return FAIL if the font
 854  * could not be loaded, OK otherwise.
 855  */
 856     int
 857 gui_mch_init_font(char_u *font_name, int fontset)
 858 {
 859     //NSLog(@"gui_mch_init_font(font_name=%s, fontset=%d)", font_name, fontset);
 860
 861     // HACK!  This gets called whenever the user types :set gfn=fontname, so
 862     // for now we set the font here.
 863     // TODO!  Proper font handling, the way Vim expects it.
 864     return [[MMBackend sharedInstance]
 865             setFontWithName:(char*)font_name];
 866 }
 867
 868
 869 /*
 870  * Set the current text font.
 871  */
 872     void
 873 gui_mch_set_font(GuiFont font)
 874 {
 875 }
 876
 877
 878 // -- Scrollbars ------------------------------------------------------------
 879
 880
 881     void
 882 gui_mch_create_scrollbar(
 883         scrollbar_T *sb,
 884         int orient)     /* SBAR_VERT or SBAR_HORIZ */
 885 {
 886     [[MMBackend sharedInstance]
 887             createScrollbarWithIdentifier:sb->ident type:sb->type];
 888 }
 889
 890
 891     void
 892 gui_mch_destroy_scrollbar(scrollbar_T *sb)
 893 {
 894     [[MMBackend sharedInstance]
 895             destroyScrollbarWithIdentifier:sb->ident];
 896 }
 897
 898
 899     void
 900 gui_mch_enable_scrollbar(
 901         scrollbar_T     *sb,
 902         int             flag)
 903 {
 904     [[MMBackend sharedInstance]
 905             showScrollbarWithIdentifier:sb->ident state:flag];
 906 }
 907
 908
 909     void
 910 gui_mch_set_scrollbar_pos(
 911         scrollbar_T *sb,
 912         int x,
 913         int y,
 914         int w,
 915         int h)
 916 {
 917     int pos = y;
 918     int len = h;
 919     if (SBAR_BOTTOM == sb->type) {
 920         pos = x;
 921         len = w;
 922     }
 923
 924     [[MMBackend sharedInstance]
 925             setScrollbarPosition:pos length:len identifier:sb->ident];
 926 }
 927
 928
 929     void
 930 gui_mch_set_scrollbar_thumb(
 931         scrollbar_T *sb,
 932         long val,
 933         long size,
 934         long max)
 935 {
 936     [[MMBackend sharedInstance]
 937             setScrollbarThumbValue:val size:size max:max identifier:sb->ident];
 938 }
 939
 940
 941 // -- Cursor ----------------------------------------------------------------
 942
 943
 944 /*
 945  * Draw a cursor without focus.
 946  */
 947     void
 948 gui_mch_draw_hollow_cursor(guicolor_T color)
 949 {
 950     return [[MMBackend sharedInstance]
 951         drawCursorAtRow:gui.row column:gui.col shape:MMInsertionPointHollow
 952                fraction:100 color:color];
 953 }
 954
 955
 956 /*
 957  * Draw part of a cursor, only w pixels wide, and h pixels high.
 958  */
 959     void
 960 gui_mch_draw_part_cursor(int w, int h, guicolor_T color)
 961 {
 962     // HACK!  'w' and 'h' are always 1 since we do not tell Vim about the exact
 963     // font dimensions.  Thus these parameters are useless.  Instead we look at
 964     // the shape_table to determine the shape and size of the cursor (just like
 965     // gui_update_cursor() does).
 966     int idx = get_shape_idx(FALSE);
 967     int shape = MMInsertionPointBlock;
 968     switch (shape_table[idx].shape) {
 969         case SHAPE_HOR: shape = MMInsertionPointHorizontal; break;
 970         case SHAPE_VER: shape = MMInsertionPointVertical; break;
 971     }
 972
 973     return [[MMBackend sharedInstance]
 974         drawCursorAtRow:gui.row column:gui.col shape:shape
 975                fraction:shape_table[idx].percentage color:color];
 976 }
 977
 978
 979 /*
 980  * Cursor blink functions.
 981  *
 982  * This is a simple state machine:
 983  * BLINK_NONE   not blinking at all
 984  * BLINK_OFF    blinking, cursor is not shown
 985  * BLINK_ON blinking, cursor is shown
 986  */
 987     void
 988 gui_mch_set_blinking(long wait, long on, long off)
 989 {
 990     [[MMBackend sharedInstance] setBlinkWait:wait on:on off:off];
 991 }
 992
 993
 994 /*
 995  * Start the cursor blinking.  If it was already blinking, this restarts the
 996  * waiting time and shows the cursor.
 997  */
 998     void
 999 gui_mch_start_blink(void)
1000 {
1001     [[MMBackend sharedInstance] startBlink];
1002 }
1003
1004
1005 /*
1006  * Stop the cursor blinking.  Show the cursor if it wasn't shown.
1007  */
1008     void
1009 gui_mch_stop_blink(void)
1010 {
1011     [[MMBackend sharedInstance] stopBlink];
1012 }
1013
1014
1015 // -- Mouse -----------------------------------------------------------------
1016
1017
1018 /*
1019  * Get current mouse coordinates in text window.
1020  */
1021     void
1022 gui_mch_getmouse(int *x, int *y)
1023 {
1024     //NSLog(@"gui_mch_getmouse()");
1025 }
1026
1027
1028     void
1029 gui_mch_setmouse(int x, int y)
1030 {
1031     //NSLog(@"gui_mch_setmouse(x=%d, y=%d)", x, y);
1032 }
1033
1034
1035     void
1036 mch_set_mouse_shape(int shape)
1037 {
1038     [[MMBackend sharedInstance] setMouseShape:shape];
1039 }
1040
1041
1042
1043
1044 // -- Unsorted --------------------------------------------------------------
1045
1046
1047     void
1048 ex_action(eap)
1049     exarg_T     *eap;
1050 {
1051     if (!gui.in_use) {
1052         EMSG(_("E???: Command only available in GUI mode"));
1053         return;
1054     }
1055
1056     NSString *name = [NSString stringWithCString:(char*)eap->arg
1057                                         encoding:NSUTF8StringEncoding];
1058     if (gui_macvim_is_valid_action(name)) {
1059         [[MMBackend sharedInstance] executeActionWithName:name];
1060     } else {
1061         EMSG2(_("E???: \"%s\" is not a valid action"), eap->arg);
1062     }
1063 }
1064
1065
1066 /*
1067  * Adjust gui.char_height (after 'linespace' was changed).
1068  */
1069     int
1070 gui_mch_adjust_charheight(void)
1071 {
1072     [[MMBackend sharedInstance] adjustLinespace:p_linespace];
1073     return OK;
1074 }
1075
1076
1077     void
1078 gui_mch_beep(void)
1079 {
1080 }
1081
1082
1083
1084 #ifdef FEAT_BROWSE
1085 /*
1086  * Pop open a file browser and return the file selected, in allocated memory,
1087  * or NULL if Cancel is hit.
1088  *  saving  - TRUE if the file will be saved to, FALSE if it will be opened.
1089  *  title   - Title message for the file browser dialog.
1090  *  dflt    - Default name of file.
1091  *  ext     - Default extension to be added to files without extensions.
1092  *  initdir - directory in which to open the browser (NULL = current dir)
1093  *  filter  - Filter for matched files to choose from.
1094  *  Has a format like this:
1095  *  "C Files (*.c)\0*.c\0"
1096  *  "All Files\0*.*\0\0"
1097  *  If these two strings were concatenated, then a choice of two file
1098  *  filters will be selectable to the user.  Then only matching files will
1099  *  be shown in the browser.  If NULL, the default allows all files.
1100  *
1101  *  *NOTE* - the filter string must be terminated with TWO nulls.
1102  */
1103     char_u *
1104 gui_mch_browse(
1105     int saving,
1106     char_u *title,
1107     char_u *dflt,
1108     char_u *ext,
1109     char_u *initdir,
1110     char_u *filter)
1111 {
1112     //NSLog(@"gui_mch_browse(saving=%d, title=%s, dflt=%s, ext=%s, initdir=%s,"
1113     //        " filter=%s", saving, title, dflt, ext, initdir, filter);
1114
1115     char_u *s = (char_u*)[[MMBackend sharedInstance]
1116             browseForFileInDirectory:(char*)initdir title:(char*)title
1117                               saving:saving];
1118
1119     return s;
1120 }
1121 #endif /* FEAT_BROWSE */
1122
1123
1124
1125     int
1126 gui_mch_dialog(
1127     int         type,
1128     char_u      *title,
1129     char_u      *message,
1130     char_u      *buttons,
1131     int         dfltbutton,
1132     char_u      *textfield)
1133 {
1134     //NSLog(@"gui_mch_dialog(type=%d title=%s message=%s buttons=%s "
1135     //        "dfltbutton=%d textfield=%s)", type, title, message, buttons,
1136     //        dfltbutton, textfield);
1137
1138     return [[MMBackend sharedInstance] presentDialogWithType:type
1139                                                        title:(char*)title
1140                                                      message:(char*)message
1141                                                      buttons:(char*)buttons
1142                                                    textField:(char*)textfield];
1143 }
1144
1145
1146     void
1147 gui_mch_flash(int msec)
1148 {
1149 }
1150
1151
1152 /*
1153  * Return the Pixel value (color) for the given color name.  This routine was
1154  * pretty much taken from example code in the Silicon Graphics OSF/Motif
1155  * Programmer's Guide.
1156  * Return INVALCOLOR when failed.
1157  */
1158     guicolor_T
1159 gui_mch_get_color(char_u *name)
1160 {
1161     NSString *key = [NSString stringWithUTF8String:(char*)name];
1162     return [[MMBackend sharedInstance] lookupColorWithKey:key];
1163 }
1164
1165
1166 /*
1167  * Return the RGB value of a pixel as long.
1168  */
1169     long_u
1170 gui_mch_get_rgb(guicolor_T pixel)
1171 {
1172     // This is only implemented so that vim can guess the correct value for
1173     // 'background' (which otherwise defaults to 'dark'); it is not used for
1174     // anything else (as far as I know).
1175     // The implementation is simple since colors are stored in an int as
1176     // "rrggbb".
1177     return pixel;
1178 }
1179
1180
1181 /*
1182  * Get the screen dimensions.
1183  * Allow 10 pixels for horizontal borders, 40 for vertical borders.
1184  * Is there no way to find out how wide the borders really are?
1185  * TODO: Add live udate of those value on suspend/resume.
1186  */
1187     void
1188 gui_mch_get_screen_dimensions(int *screen_w, int *screen_h)
1189 {
1190     //NSLog(@"gui_mch_get_screen_dimensions()");
1191     *screen_w = Columns;
1192     *screen_h = Rows;
1193 }
1194
1195
1196 /*
1197  * Get the position of the top left corner of the window.
1198  */
1199     int
1200 gui_mch_get_winpos(int *x, int *y)
1201 {
1202     *x = *y = 0;
1203     return OK;
1204 }
1205
1206
1207 /*
1208  * Return OK if the key with the termcap name "name" is supported.
1209  */
1210     int
1211 gui_mch_haskey(char_u *name)
1212 {
1213     NSString *value = [NSString stringWithUTF8String:(char*)name];
1214     if (value)
1215         return [[MMBackend sharedInstance] hasSpecialKeyWithValue:value];
1216
1217     return NO;
1218 }
1219
1220
1221 /*
1222  * Iconify the GUI window.
1223  */
1224     void
1225 gui_mch_iconify(void)
1226 {
1227 }
1228
1229
1230 /*
1231  * Invert a rectangle from row r, column c, for nr rows and nc columns.
1232  */
1233     void
1234 gui_mch_invert_rectangle(int r, int c, int nr, int nc)
1235 {
1236 }
1237
1238
1239 #if defined(FEAT_EVAL) || defined(PROTO)
1240 /*
1241  * Bring the Vim window to the foreground.
1242  */
1243     void
1244 gui_mch_set_foreground(void)
1245 {
1246     [[MMBackend sharedInstance] activate];
1247 }
1248 #endif
1249
1250
1251
1252     void
1253 gui_mch_set_shellsize(
1254     int         width,
1255     int         height,
1256     int         min_width,
1257     int         min_height,
1258     int         base_width,
1259     int         base_height,
1260     int         direction)
1261 {
1262     //NSLog(@"gui_mch_set_shellsize(width=%d, height=%d, min_width=%d,"
1263     //        " min_height=%d, base_width=%d, base_height=%d, direction=%d)",
1264     //        width, height, min_width, min_height, base_width, base_height,
1265     //        direction);
1266     [[MMBackend sharedInstance] setRows:height columns:width];
1267 }
1268
1269
1270     void
1271 gui_mch_set_text_area_pos(int x, int y, int w, int h)
1272 {
1273 }
1274
1275 /*
1276  * Set the position of the top left corner of the window to the given
1277  * coordinates.
1278  */
1279     void
1280 gui_mch_set_winpos(int x, int y)
1281 {
1282 }
1283
1284
1285 #ifdef FEAT_TITLE
1286 /*
1287  * Set the window title and icon.
1288  * (The icon is not taken care of).
1289  */
1290     void
1291 gui_mch_settitle(char_u *title, char_u *icon)
1292 {
1293     //NSLog(@"gui_mch_settitle(title=%s, icon=%s)", title, icon);
1294
1295     [[MMBackend sharedInstance] setVimWindowTitle:(char*)title];
1296 }
1297 #endif
1298
1299
1300     void
1301 gui_mch_toggle_tearoffs(int enable)
1302 {
1303 }
1304
1305
1306     static BOOL
1307 gui_macvim_is_valid_action(NSString *action)
1308 {
1309     static NSDictionary *actionDict = nil;
1310
1311     if (!actionDict) {
1312         NSBundle *mainBundle = [NSBundle mainBundle];
1313         NSString *path = [mainBundle pathForResource:@"Actions"
1314                                               ofType:@"plist"];
1315         if (path) {
1316             actionDict = [[NSDictionary alloc] initWithContentsOfFile:path];
1317         } else {
1318             // Allocate bogus dictionary so that error only pops up once.
1319             actionDict = [NSDictionary new];
1320             EMSG(_("E???: Failed to load action dictionary"));
1321         }
1322     }
1323
1324     return [actionDict objectForKey:action] != nil;
1325 }
1326
1327
1328
1329 // -- Client/Server ---------------------------------------------------------
1330
1331 #ifdef MAC_CLIENTSERVER
1332
1333 //
1334 // NOTE: Client/Server is only fully supported with a GUI.  Theoretically it
1335 // would be possible to make the server code work with terminal Vim, but it
1336 // would require that a run-loop is set up and checked.  This should not be
1337 // difficult to implement, simply call gui_mch_update() at opportune moments
1338 // and it will take care of the run-loop.  Another (bigger) problem with
1339 // supporting servers in terminal mode is that the server listing code talks to
1340 // MacVim (the GUI) to figure out which servers are running.
1341 //
1342
1343
1344 /*
1345  * Register connection with 'name'.  The actual connection is named something
1346  * like 'org.vim.MacVim.VIM3', whereas the server is called 'VIM3'.
1347  */
1348     void
1349 serverRegisterName(char_u *name)
1350 {
1351     NSString *svrName = [NSString stringWithUTF8String:(char*)name];
1352     [[MMBackend sharedInstance] registerServerWithName:svrName];
1353 }
1354
1355
1356 /*
1357  * Send to an instance of Vim.
1358  * Returns 0 for OK, negative for an error.
1359  */
1360     int
1361 serverSendToVim(char_u *name, char_u *cmd, char_u **result,
1362         int *port, int asExpr, int silent)
1363 {
1364     BOOL ok = [[MMBackend sharedInstance]
1365             sendToServer:[NSString stringWithUTF8String:(char*)name]
1366                   string:[NSString stringWithUTF8String:(char*)cmd]
1367                    reply:result
1368                     port:port
1369               expression:asExpr
1370                   silent:silent];
1371
1372     return ok ? 0 : -1;
1373 }
1374
1375
1376 /*
1377  * Ask MacVim for the names of all Vim servers.
1378  */
1379     char_u *
1380 serverGetVimNames(void)
1381 {
1382     char_u *names = NULL;
1383     NSArray *list = [[MMBackend sharedInstance] serverList];
1384
1385     if (list) {
1386         NSString *string = [list componentsJoinedByString:@"\n"];
1387         names = vim_strsave((char_u*)[string UTF8String]);
1388     }
1389
1390     return names;
1391 }
1392
1393
1394 /*
1395  * 'str' is a hex int representing the send port of the connection.
1396  */
1397     int
1398 serverStrToPort(char_u *str)
1399 {
1400     int port = 0;
1401
1402     sscanf((char *)str, "0x%x", &port);
1403     if (!port)
1404         EMSG2(_("E573: Invalid server id used: %s"), str);
1405
1406     return port;
1407 }
1408
1409
1410 /*
1411  * Check for replies from server with send port 'port'.
1412  * Return TRUE and a non-malloc'ed string if there is.  Else return FALSE.
1413  */
1414     int
1415 serverPeekReply(int port, char_u **str)
1416 {
1417     NSString *reply = [[MMBackend sharedInstance] peekForReplyOnPort:port];
1418     if (str)
1419         *str = (char_u*)[reply UTF8String];
1420
1421     return reply != nil;
1422 }
1423
1424
1425 /*
1426  * Wait for replies from server with send port 'port'.
1427  * Return 0 and the malloc'ed string when a reply is available.
1428  * Return -1 on error.
1429  */
1430     int
1431 serverReadReply(int port, char_u **str)
1432 {
1433     NSString *reply = [[MMBackend sharedInstance] waitForReplyOnPort:port];
1434     if (reply && str) {
1435         *str = vim_strsave((char_u*)[reply UTF8String]);
1436         return 0;
1437     }
1438
1439     return -1;
1440 }
1441
1442
1443 /*
1444  * Send a reply string (notification) to client with port given by "serverid".
1445  * Return -1 if the window is invalid.
1446  */
1447     int
1448 serverSendReply(char_u *serverid, char_u *reply)
1449 {
1450     int retval = -1;
1451     int port = serverStrToPort(serverid);
1452     if (port > 0 && reply) {
1453         BOOL ok = [[MMBackend sharedInstance]
1454                 sendReply:[NSString stringWithUTF8String:(char*)reply]
1455                    toPort:port];
1456         retval = ok ? 0 : -1;
1457     }
1458
1459     return retval;
1460 }
1461
1462 #endif // MAC_CLIENTSERVER