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