1 /* vi:set ts=8 sts=4 sw=4 noet: 2 * 3 * VIM - Vi IMproved by Bram Moolenaar 4 * 5 * Ruby interface by Shugo Maeda 6 * with improvements by SegPhault (Ryan Paul) 7 * with improvements by Jon Maken 8 * 9 * Do ":help uganda" in Vim to read copying and usage conditions. 10 * Do ":help credits" in Vim to see a list of people who contributed. 11 * See README.txt for an overview of the Vim source code. 12 */ 13 14 #include "protodef.h" 15 #ifdef HAVE_CONFIG_H 16 # include "auto/config.h" 17 #endif 18 19 #include <stdio.h> 20 #include <string.h> 21 22 #ifdef _WIN32 23 # if !defined(DYNAMIC_RUBY) || (RUBY_VERSION < 18) 24 # define NT 25 # endif 26 # ifndef DYNAMIC_RUBY 27 # define IMPORT // For static dll usage __declspec(dllimport) 28 # define RUBYEXTERN __declspec(dllimport) 29 # endif 30 #endif 31 #ifndef RUBYEXTERN 32 # define RUBYEXTERN extern 33 #endif 34 35 #if defined(DYNAMIC_RUBY) && RUBY_VERSION >= 24 36 # define USE_RUBY_INTEGER 37 #endif 38 39 #ifdef DYNAMIC_RUBY 40 /* 41 * This is tricky. In ruby.h there is (inline) function rb_class_of() 42 * definition. This function use these variables. But we want function to 43 * use dll_* variables. 44 */ 45 # define rb_cFalseClass (*dll_rb_cFalseClass) 46 # define rb_cFixnum (*dll_rb_cFixnum) 47 # if defined(USE_RUBY_INTEGER) 48 # define rb_cInteger (*dll_rb_cInteger) 49 # endif 50 # if RUBY_VERSION >= 20 51 # define rb_cFloat (*dll_rb_cFloat) 52 # endif 53 # define rb_cNilClass (*dll_rb_cNilClass) 54 # define rb_cString (*dll_rb_cString) 55 # define rb_cSymbol (*dll_rb_cSymbol) 56 # define rb_cTrueClass (*dll_rb_cTrueClass) 57 # if RUBY_VERSION >= 18 58 /* 59 * On ver 1.8, all Ruby functions are exported with "__declspec(dllimport)" 60 * in ruby.h. But it causes trouble for these variables, because it is 61 * defined in this file. When defined this RUBY_EXPORT it modified to 62 * "extern" and be able to avoid this problem. 63 */ 64 # define RUBY_EXPORT 65 # endif 66 67 #endif // ifdef DYNAMIC_RUBY 68 69 // suggested by Ariya Mizutani 70 #if (_MSC_VER == 1200) 71 # undef _WIN32_WINNT 72 #endif 73 74 #if defined(DYNAMIC_RUBY) && RUBY_VERSION >= 19 75 // Ruby 1.9 defines a number of static functions which use rb_num2long and 76 // rb_int2big 77 # define rb_num2long rb_num2long_stub 78 # define rb_int2big rb_int2big_stub 79 #endif 80 81 #if defined(DYNAMIC_RUBY) && RUBY_VERSION >= 19 \ 82 && VIM_SIZEOF_INT < VIM_SIZEOF_LONG 83 // Ruby 1.9 defines a number of static functions which use rb_fix2int and 84 // rb_num2int if VIM_SIZEOF_INT < VIM_SIZEOF_LONG (64bit) 85 # define rb_fix2int rb_fix2int_stub 86 # define rb_num2int rb_num2int_stub 87 #endif 88 89 #if defined(DYNAMIC_RUBY) && RUBY_VERSION == 21 90 // Ruby 2.1 adds new GC called RGenGC and RARRAY_PTR uses 91 // rb_gc_writebarrier_unprotect_promoted if USE_RGENGC 92 # define rb_gc_writebarrier_unprotect_promoted rb_gc_writebarrier_unprotect_promoted_stub 93 #endif 94 #if defined(DYNAMIC_RUBY) && RUBY_VERSION >= 22 95 # define rb_gc_writebarrier_unprotect rb_gc_writebarrier_unprotect_stub 96 #endif 97 98 #if defined(DYNAMIC_RUBY) && RUBY_VERSION >= 26 99 # define rb_ary_detransient rb_ary_detransient_stub 100 #endif 101 102 // On macOS pre-installed Ruby defines "SIZEOF_TIME_T" as "SIZEOF_LONG" so it 103 // conflicts with the definition in config.h then causes a macro-redefined 104 // warning. 105 #ifdef SIZEOF_TIME_T 106 # undef SIZEOF_TIME_T 107 #endif 108 109 #include <ruby.h> 110 #if RUBY_VERSION >= 19 111 # include <ruby/encoding.h> 112 #endif 113 #if RUBY_VERSION <= 18 114 # include <st.h> // for ST_STOP and ST_CONTINUE 115 #endif 116 117 // See above. 118 #ifdef SIZEOF_TIME_T 119 # undef SIZEOF_TIME_T 120 #endif 121 122 #undef off_t // ruby defines off_t as _int64, Mingw uses long 123 #undef EXTERN 124 #undef _ 125 126 // T_DATA defined both by Ruby and Mac header files, hack around it... 127 #if defined(MACOS_X) 128 # define __OPENTRANSPORT__ 129 # define __OPENTRANSPORTPROTOCOL__ 130 # define __OPENTRANSPORTPROVIDERS__ 131 #endif 132 133 /* 134 * The TypedData_XXX macro family can be used since Ruby 1.9.2 but 135 * rb_data_type_t changed in 1.9.3, therefore require at least 2.0. 136 * The old Data_XXX macro family was deprecated on Ruby 2.2. 137 * Use TypedData_XXX if available. 138 */ 139 #if defined(TypedData_Wrap_Struct) && (RUBY_VERSION >= 20) 140 # define USE_TYPEDDATA 1 141 #endif 142 143 /* 144 * Backward compatibility for Ruby 1.8 and earlier. 145 * Ruby 1.9 does not provide STR2CSTR, instead StringValuePtr is provided. 146 * Ruby 1.9 does not provide RXXX(s)->len and RXXX(s)->ptr, instead 147 * RXXX_LEN(s) and RXXX_PTR(s) are provided. 148 */ 149 #ifndef StringValuePtr 150 # define StringValuePtr(s) STR2CSTR(s) 151 #endif 152 #ifndef RARRAY_LEN 153 # define RARRAY_LEN(s) RARRAY(s)->len 154 #endif 155 #ifndef RARRAY_PTR 156 # define RARRAY_PTR(s) RARRAY(s)->ptr 157 #endif 158 #ifndef RSTRING_LEN 159 # define RSTRING_LEN(s) RSTRING(s)->len 160 #endif 161 #ifndef RSTRING_PTR 162 # define RSTRING_PTR(s) RSTRING(s)->ptr 163 #endif 164 165 #ifdef HAVE_DUP 166 # undef HAVE_DUP 167 #endif 168 169 #include "vim.h" 170 #include "version.h" 171 172 #ifdef DYNAMIC_RUBY 173 # if !defined(MSWIN) // must come after including vim.h, where it is defined 174 # include <dlfcn.h> 175 # define HINSTANCE void* 176 # define RUBY_PROC void* 177 # define load_dll(n) dlopen((n), RTLD_LAZY|RTLD_GLOBAL) 178 # define symbol_from_dll dlsym 179 # define close_dll dlclose 180 # else 181 # define RUBY_PROC FARPROC 182 # define load_dll vimLoadLib 183 # define symbol_from_dll GetProcAddress 184 # define close_dll FreeLibrary 185 # endif 186 #endif 187 188 #if defined(PROTO) && !defined(FEAT_RUBY) 189 // Define these to be able to generate the function prototypes. 190 # define VALUE int 191 # define RUBY_DATA_FUNC int 192 #endif 193 194 static int ruby_initialized = 0; 195 static void *ruby_stack_start; 196 static VALUE objtbl; 197 198 static VALUE mVIM; 199 static VALUE cBuffer; 200 static VALUE cVimWindow; 201 static VALUE eDeletedBufferError; 202 static VALUE eDeletedWindowError; 203 204 static int ensure_ruby_initialized(void); 205 static void error_print(int); 206 static void ruby_io_init(void); 207 static void ruby_vim_init(void); 208 static int ruby_convert_to_vim_value(VALUE val, typval_T *rettv); 209 210 #if (RUBY_VERSION >= 19) || defined(RUBY_INIT_STACK) 211 # if defined(__ia64) && !defined(ruby_init_stack) 212 # define ruby_init_stack(addr) ruby_init_stack((addr), rb_ia64_bsp()) 213 # endif 214 #endif 215 216 #if defined(DYNAMIC_RUBY) || defined(PROTO) 217 # if defined(PROTO) && !defined(HINSTANCE) 218 # define HINSTANCE int // for generating prototypes 219 # endif 220 221 /* 222 * Wrapper defines 223 */ 224 // Ruby 2.7 actually expands the following symbols as macro. 225 # if RUBY_VERSION >= 27 226 # undef rb_define_global_function 227 # undef rb_define_method 228 # undef rb_define_module_function 229 # undef rb_define_singleton_method 230 # endif 231 232 # define rb_assoc_new dll_rb_assoc_new 233 # define rb_cObject (*dll_rb_cObject) 234 # define rb_class_new_instance dll_rb_class_new_instance 235 # define rb_check_type dll_rb_check_type 236 # ifdef USE_TYPEDDATA 237 # define rb_check_typeddata dll_rb_check_typeddata 238 # endif 239 # define rb_class_path dll_rb_class_path 240 # ifdef USE_TYPEDDATA 241 # if RUBY_VERSION >= 23 242 # define rb_data_typed_object_wrap dll_rb_data_typed_object_wrap 243 # else 244 # define rb_data_typed_object_alloc dll_rb_data_typed_object_alloc 245 # endif 246 # else 247 # define rb_data_object_alloc dll_rb_data_object_alloc 248 # endif 249 # define rb_define_class_under dll_rb_define_class_under 250 # define rb_define_const dll_rb_define_const 251 # define rb_define_global_function dll_rb_define_global_function 252 # define rb_define_method dll_rb_define_method 253 # define rb_define_module dll_rb_define_module 254 # define rb_define_module_function dll_rb_define_module_function 255 # define rb_define_singleton_method dll_rb_define_singleton_method 256 # define rb_define_virtual_variable dll_rb_define_virtual_variable 257 # define rb_stdout (*dll_rb_stdout) 258 # define rb_stderr (*dll_rb_stderr) 259 # define rb_eArgError (*dll_rb_eArgError) 260 # define rb_eIndexError (*dll_rb_eIndexError) 261 # define rb_eRuntimeError (*dll_rb_eRuntimeError) 262 # define rb_eStandardError (*dll_rb_eStandardError) 263 # define rb_eval_string_protect dll_rb_eval_string_protect 264 # if RUBY_VERSION >= 21 265 # define rb_funcallv dll_rb_funcallv 266 # else 267 # define rb_funcall2 dll_rb_funcall2 268 # endif 269 # define rb_global_variable dll_rb_global_variable 270 # define rb_hash_aset dll_rb_hash_aset 271 # define rb_hash_foreach dll_rb_hash_foreach 272 # define rb_hash_new dll_rb_hash_new 273 # define rb_inspect dll_rb_inspect 274 # define rb_int2inum dll_rb_int2inum 275 276 // ruby.h may redefine rb_intern to use RUBY_CONST_ID_CACHE(), but that won't 277 // work. Not using the cache appears to be the best solution. 278 # undef rb_intern 279 # define rb_intern dll_rb_intern 280 281 # if VIM_SIZEOF_INT < VIM_SIZEOF_LONG // 64 bits only 282 # if RUBY_VERSION <= 18 283 # define rb_fix2int dll_rb_fix2int 284 # define rb_num2int dll_rb_num2int 285 # endif 286 # define rb_num2uint dll_rb_num2uint 287 # endif 288 # define rb_num2dbl dll_rb_num2dbl 289 # define rb_lastline_get dll_rb_lastline_get 290 # define rb_lastline_set dll_rb_lastline_set 291 # define rb_protect dll_rb_protect 292 # define rb_load dll_rb_load 293 # if RUBY_VERSION <= 18 294 # define rb_num2long dll_rb_num2long 295 # endif 296 # if RUBY_VERSION <= 19 297 # define rb_num2ulong dll_rb_num2ulong 298 # endif 299 # define rb_obj_alloc dll_rb_obj_alloc 300 # define rb_obj_as_string dll_rb_obj_as_string 301 # define rb_obj_id dll_rb_obj_id 302 # define rb_raise dll_rb_raise 303 # define rb_str_cat dll_rb_str_cat 304 # define rb_str_concat dll_rb_str_concat 305 # undef rb_str_new 306 # define rb_str_new dll_rb_str_new 307 # ifdef rb_str_new2 308 // Ruby may #define rb_str_new2 to use rb_str_new_cstr. 309 # define need_rb_str_new_cstr 1 310 // Ruby's headers #define rb_str_new_cstr to make use of GCC's 311 // __builtin_constant_p extension. 312 # undef rb_str_new_cstr 313 # define rb_str_new_cstr dll_rb_str_new_cstr 314 # else 315 # define rb_str_new2 dll_rb_str_new2 316 # endif 317 # if RUBY_VERSION >= 18 318 # define rb_string_value dll_rb_string_value 319 # define rb_string_value_ptr dll_rb_string_value_ptr 320 # define rb_float_new dll_rb_float_new 321 # define rb_ary_new dll_rb_ary_new 322 # ifdef rb_ary_new4 323 # define RB_ARY_NEW4_MACRO 1 324 # undef rb_ary_new4 325 # endif 326 # define rb_ary_new4 dll_rb_ary_new4 327 # define rb_ary_push dll_rb_ary_push 328 # if (RUBY_VERSION >= 19) || defined(RUBY_INIT_STACK) 329 # ifdef __ia64 330 # define rb_ia64_bsp dll_rb_ia64_bsp 331 # undef ruby_init_stack 332 # define ruby_init_stack(addr) dll_ruby_init_stack((addr), rb_ia64_bsp()) 333 # else 334 # define ruby_init_stack dll_ruby_init_stack 335 # endif 336 # endif 337 # else 338 # define rb_str2cstr dll_rb_str2cstr 339 # endif 340 # if RUBY_VERSION >= 19 341 # define rb_errinfo dll_rb_errinfo 342 # else 343 # define ruby_errinfo (*dll_ruby_errinfo) 344 # endif 345 # define ruby_init dll_ruby_init 346 # define ruby_init_loadpath dll_ruby_init_loadpath 347 # ifdef MSWIN 348 # if RUBY_VERSION >= 19 349 # define ruby_sysinit dll_ruby_sysinit 350 # else 351 # define NtInitialize dll_NtInitialize 352 # endif 353 # if RUBY_VERSION >= 18 354 # define rb_w32_snprintf dll_rb_w32_snprintf 355 # endif 356 # endif 357 358 # if RUBY_VERSION >= 19 359 # define ruby_script dll_ruby_script 360 # define rb_enc_find_index dll_rb_enc_find_index 361 # define rb_enc_find dll_rb_enc_find 362 # undef rb_enc_str_new 363 # define rb_enc_str_new dll_rb_enc_str_new 364 # define rb_sprintf dll_rb_sprintf 365 # define rb_require dll_rb_require 366 # define ruby_options dll_ruby_options 367 # endif 368 369 /* 370 * Pointers for dynamic link 371 */ 372 static VALUE (*dll_rb_assoc_new) (VALUE, VALUE); 373 VALUE *dll_rb_cFalseClass; 374 VALUE *dll_rb_cFixnum; 375 # if defined(USE_RUBY_INTEGER) 376 VALUE *dll_rb_cInteger; 377 # endif 378 # if RUBY_VERSION >= 20 379 VALUE *dll_rb_cFloat; 380 # endif 381 VALUE *dll_rb_cNilClass; 382 static VALUE *dll_rb_cObject; 383 VALUE *dll_rb_cString; 384 VALUE *dll_rb_cSymbol; 385 VALUE *dll_rb_cTrueClass; 386 static VALUE (*dll_rb_class_new_instance) (int,VALUE*,VALUE); 387 static void (*dll_rb_check_type) (VALUE,int); 388 # ifdef USE_TYPEDDATA 389 static void *(*dll_rb_check_typeddata) (VALUE,const rb_data_type_t *); 390 # endif 391 static VALUE (*dll_rb_class_path) (VALUE); 392 # ifdef USE_TYPEDDATA 393 # if RUBY_VERSION >= 23 394 static VALUE (*dll_rb_data_typed_object_wrap) (VALUE, void*, const rb_data_type_t *); 395 # else 396 static VALUE (*dll_rb_data_typed_object_alloc) (VALUE, void*, const rb_data_type_t *); 397 # endif 398 # else 399 static VALUE (*dll_rb_data_object_alloc) (VALUE, void*, RUBY_DATA_FUNC, RUBY_DATA_FUNC); 400 # endif 401 static VALUE (*dll_rb_define_class_under) (VALUE, const char*, VALUE); 402 static void (*dll_rb_define_const) (VALUE,const char*,VALUE); 403 static void (*dll_rb_define_global_function) (const char*,VALUE(*)(),int); 404 static void (*dll_rb_define_method) (VALUE,const char*,VALUE(*)(),int); 405 static VALUE (*dll_rb_define_module) (const char*); 406 static void (*dll_rb_define_module_function) (VALUE,const char*,VALUE(*)(),int); 407 static void (*dll_rb_define_singleton_method) (VALUE,const char*,VALUE(*)(),int); 408 static void (*dll_rb_define_virtual_variable) (const char*,VALUE(*)(),void(*)()); 409 static VALUE *dll_rb_stdout; 410 static VALUE *dll_rb_stderr; 411 static VALUE *dll_rb_eArgError; 412 static VALUE *dll_rb_eIndexError; 413 static VALUE *dll_rb_eRuntimeError; 414 static VALUE *dll_rb_eStandardError; 415 static VALUE (*dll_rb_eval_string_protect) (const char*, int*); 416 # if RUBY_VERSION >= 21 417 static VALUE (*dll_rb_funcallv) (VALUE, ID, int, const VALUE*); 418 # else 419 static VALUE (*dll_rb_funcall2) (VALUE, ID, int, const VALUE*); 420 # endif 421 static void (*dll_rb_global_variable) (VALUE*); 422 static VALUE (*dll_rb_hash_aset) (VALUE, VALUE, VALUE); 423 static VALUE (*dll_rb_hash_foreach) (VALUE, int (*)(VALUE, VALUE, VALUE), VALUE); 424 static VALUE (*dll_rb_hash_new) (void); 425 static VALUE (*dll_rb_inspect) (VALUE); 426 static VALUE (*dll_rb_int2inum) (long); 427 static ID (*dll_rb_intern) (const char*); 428 # if VIM_SIZEOF_INT < VIM_SIZEOF_LONG // 64 bits only 429 static long (*dll_rb_fix2int) (VALUE); 430 static long (*dll_rb_num2int) (VALUE); 431 static unsigned long (*dll_rb_num2uint) (VALUE); 432 # endif 433 static double (*dll_rb_num2dbl) (VALUE); 434 static VALUE (*dll_rb_lastline_get) (void); 435 static void (*dll_rb_lastline_set) (VALUE); 436 static VALUE (*dll_rb_protect) (VALUE (*)(VALUE), VALUE, int*); 437 static void (*dll_rb_load) (VALUE, int); 438 static long (*dll_rb_num2long) (VALUE); 439 static unsigned long (*dll_rb_num2ulong) (VALUE); 440 static VALUE (*dll_rb_obj_alloc) (VALUE); 441 static VALUE (*dll_rb_obj_as_string) (VALUE); 442 static VALUE (*dll_rb_obj_id) (VALUE); 443 static void (*dll_rb_raise) (VALUE, const char*, ...); 444 # if RUBY_VERSION >= 18 445 static VALUE (*dll_rb_string_value) (volatile VALUE*); 446 # else 447 static char *(*dll_rb_str2cstr) (VALUE,int*); 448 # endif 449 static VALUE (*dll_rb_str_cat) (VALUE, const char*, long); 450 static VALUE (*dll_rb_str_concat) (VALUE, VALUE); 451 static VALUE (*dll_rb_str_new) (const char*, long); 452 # ifdef need_rb_str_new_cstr 453 // Ruby may #define rb_str_new2 to use rb_str_new_cstr. 454 static VALUE (*dll_rb_str_new_cstr) (const char*); 455 # else 456 static VALUE (*dll_rb_str_new2) (const char*); 457 # endif 458 # if RUBY_VERSION >= 19 459 static VALUE (*dll_rb_errinfo) (void); 460 # else 461 static VALUE *dll_ruby_errinfo; 462 # endif 463 static void (*dll_ruby_init) (void); 464 static void (*dll_ruby_init_loadpath) (void); 465 # ifdef MSWIN 466 # if RUBY_VERSION >= 19 467 static void (*dll_ruby_sysinit) (int*, char***); 468 # else 469 static void (*dll_NtInitialize) (int*, char***); 470 # endif 471 # if RUBY_VERSION >= 18 472 static int (*dll_rb_w32_snprintf)(char*, size_t, const char*, ...); 473 # endif 474 # endif 475 # if RUBY_VERSION >= 18 476 static char * (*dll_rb_string_value_ptr) (volatile VALUE*); 477 static VALUE (*dll_rb_float_new) (double); 478 static VALUE (*dll_rb_ary_new) (void); 479 static VALUE (*dll_rb_ary_new4) (long n, const VALUE *elts); 480 static VALUE (*dll_rb_ary_push) (VALUE, VALUE); 481 # if RUBY_VERSION >= 26 482 static void (*dll_rb_ary_detransient) (VALUE); 483 # endif 484 # if (RUBY_VERSION >= 19) || defined(RUBY_INIT_STACK) 485 # ifdef __ia64 486 static void * (*dll_rb_ia64_bsp) (void); 487 static void (*dll_ruby_init_stack)(VALUE*, void*); 488 # else 489 static void (*dll_ruby_init_stack)(VALUE*); 490 # endif 491 # endif 492 # endif 493 # if RUBY_VERSION >= 19 494 static VALUE (*dll_rb_int2big)(SIGNED_VALUE); 495 # endif 496 497 # if RUBY_VERSION >= 19 498 static void (*dll_ruby_script) (const char*); 499 static int (*dll_rb_enc_find_index) (const char*); 500 static rb_encoding* (*dll_rb_enc_find) (const char*); 501 static VALUE (*dll_rb_enc_str_new) (const char*, long, rb_encoding*); 502 static VALUE (*dll_rb_sprintf) (const char*, ...); 503 static VALUE (*dll_rb_require) (const char*); 504 static void* (*ruby_options)(int, char**); 505 # endif 506 507 # if defined(USE_RGENGC) && USE_RGENGC 508 # if RUBY_VERSION == 21 509 static void (*dll_rb_gc_writebarrier_unprotect_promoted)(VALUE); 510 # else 511 static void (*dll_rb_gc_writebarrier_unprotect)(VALUE obj); 512 # endif 513 # endif 514 515 # if (RUBY_VERSION >= 19) && !defined(PROTO) 516 # if RUBY_VERSION >= 22 517 long 518 rb_num2long_stub(VALUE x) 519 # else 520 SIGNED_VALUE 521 rb_num2long_stub(VALUE x) 522 # endif 523 { 524 return dll_rb_num2long(x); 525 } 526 # if RUBY_VERSION >= 26 527 VALUE 528 rb_int2big_stub(intptr_t x) 529 # else 530 VALUE 531 rb_int2big_stub(SIGNED_VALUE x) 532 # endif 533 { 534 return dll_rb_int2big(x); 535 } 536 # if (RUBY_VERSION >= 19) && (VIM_SIZEOF_INT < VIM_SIZEOF_LONG) 537 long 538 rb_fix2int_stub(VALUE x) 539 { 540 return dll_rb_fix2int(x); 541 } 542 long 543 rb_num2int_stub(VALUE x) 544 { 545 return dll_rb_num2int(x); 546 } 547 # endif 548 # if RUBY_VERSION >= 20 549 VALUE 550 rb_float_new_in_heap(double d) 551 { 552 return dll_rb_float_new(d); 553 } 554 # if RUBY_VERSION >= 22 555 unsigned long 556 rb_num2ulong(VALUE x) 557 # else 558 VALUE 559 rb_num2ulong(VALUE x) 560 # endif 561 { 562 return (long)RSHIFT((SIGNED_VALUE)(x),1); 563 } 564 # endif 565 # endif 566 567 // Do not generate a prototype here, VALUE isn't always defined. 568 # if defined(USE_RGENGC) && USE_RGENGC && !defined(PROTO) 569 # if RUBY_VERSION == 21 570 void 571 rb_gc_writebarrier_unprotect_promoted_stub(VALUE obj) 572 { 573 dll_rb_gc_writebarrier_unprotect_promoted(obj); 574 } 575 # else 576 void 577 rb_gc_writebarrier_unprotect_stub(VALUE obj) 578 { 579 dll_rb_gc_writebarrier_unprotect(obj); 580 } 581 # endif 582 # endif 583 584 # if RUBY_VERSION >= 26 585 void 586 rb_ary_detransient_stub(VALUE x) 587 { 588 dll_rb_ary_detransient(x); 589 } 590 # endif 591 592 static HINSTANCE hinstRuby = NULL; // Instance of ruby.dll 593 594 /* 595 * Table of name to function pointer of ruby. 596 */ 597 static struct 598 { 599 char *name; 600 RUBY_PROC *ptr; 601 } ruby_funcname_table[] = 602 { 603 {"rb_assoc_new", (RUBY_PROC*)&dll_rb_assoc_new}, 604 {"rb_cFalseClass", (RUBY_PROC*)&dll_rb_cFalseClass}, 605 # if defined(USE_RUBY_INTEGER) 606 {"rb_cInteger", (RUBY_PROC*)&dll_rb_cInteger}, 607 # else 608 {"rb_cFixnum", (RUBY_PROC*)&dll_rb_cFixnum}, 609 # endif 610 # if RUBY_VERSION >= 20 611 {"rb_cFloat", (RUBY_PROC*)&dll_rb_cFloat}, 612 # endif 613 {"rb_cNilClass", (RUBY_PROC*)&dll_rb_cNilClass}, 614 {"rb_cObject", (RUBY_PROC*)&dll_rb_cObject}, 615 {"rb_cString", (RUBY_PROC*)&dll_rb_cString}, 616 {"rb_cSymbol", (RUBY_PROC*)&dll_rb_cSymbol}, 617 {"rb_cTrueClass", (RUBY_PROC*)&dll_rb_cTrueClass}, 618 {"rb_class_new_instance", (RUBY_PROC*)&dll_rb_class_new_instance}, 619 {"rb_check_type", (RUBY_PROC*)&dll_rb_check_type}, 620 # ifdef USE_TYPEDDATA 621 {"rb_check_typeddata", (RUBY_PROC*)&dll_rb_check_typeddata}, 622 # endif 623 {"rb_class_path", (RUBY_PROC*)&dll_rb_class_path}, 624 # ifdef USE_TYPEDDATA 625 # if RUBY_VERSION >= 23 626 {"rb_data_typed_object_wrap", (RUBY_PROC*)&dll_rb_data_typed_object_wrap}, 627 # else 628 {"rb_data_typed_object_alloc", (RUBY_PROC*)&dll_rb_data_typed_object_alloc}, 629 # endif 630 # else 631 {"rb_data_object_alloc", (RUBY_PROC*)&dll_rb_data_object_alloc}, 632 # endif 633 {"rb_define_class_under", (RUBY_PROC*)&dll_rb_define_class_under}, 634 {"rb_define_const", (RUBY_PROC*)&dll_rb_define_const}, 635 {"rb_define_global_function", (RUBY_PROC*)&dll_rb_define_global_function}, 636 {"rb_define_method", (RUBY_PROC*)&dll_rb_define_method}, 637 {"rb_define_module", (RUBY_PROC*)&dll_rb_define_module}, 638 {"rb_define_module_function", (RUBY_PROC*)&dll_rb_define_module_function}, 639 {"rb_define_singleton_method", (RUBY_PROC*)&dll_rb_define_singleton_method}, 640 {"rb_define_virtual_variable", (RUBY_PROC*)&dll_rb_define_virtual_variable}, 641 {"rb_stdout", (RUBY_PROC*)&dll_rb_stdout}, 642 {"rb_stderr", (RUBY_PROC*)&dll_rb_stderr}, 643 {"rb_eArgError", (RUBY_PROC*)&dll_rb_eArgError}, 644 {"rb_eIndexError", (RUBY_PROC*)&dll_rb_eIndexError}, 645 {"rb_eRuntimeError", (RUBY_PROC*)&dll_rb_eRuntimeError}, 646 {"rb_eStandardError", (RUBY_PROC*)&dll_rb_eStandardError}, 647 {"rb_eval_string_protect", (RUBY_PROC*)&dll_rb_eval_string_protect}, 648 # if RUBY_VERSION >= 21 649 {"rb_funcallv", (RUBY_PROC*)&dll_rb_funcallv}, 650 # else 651 {"rb_funcall2", (RUBY_PROC*)&dll_rb_funcall2}, 652 # endif 653 {"rb_global_variable", (RUBY_PROC*)&dll_rb_global_variable}, 654 {"rb_hash_aset", (RUBY_PROC*)&dll_rb_hash_aset}, 655 {"rb_hash_foreach", (RUBY_PROC*)&dll_rb_hash_foreach}, 656 {"rb_hash_new", (RUBY_PROC*)&dll_rb_hash_new}, 657 {"rb_inspect", (RUBY_PROC*)&dll_rb_inspect}, 658 {"rb_int2inum", (RUBY_PROC*)&dll_rb_int2inum}, 659 {"rb_intern", (RUBY_PROC*)&dll_rb_intern}, 660 # if VIM_SIZEOF_INT < VIM_SIZEOF_LONG // 64 bits only 661 {"rb_fix2int", (RUBY_PROC*)&dll_rb_fix2int}, 662 {"rb_num2int", (RUBY_PROC*)&dll_rb_num2int}, 663 {"rb_num2uint", (RUBY_PROC*)&dll_rb_num2uint}, 664 # endif 665 {"rb_num2dbl", (RUBY_PROC*)&dll_rb_num2dbl}, 666 {"rb_lastline_get", (RUBY_PROC*)&dll_rb_lastline_get}, 667 {"rb_lastline_set", (RUBY_PROC*)&dll_rb_lastline_set}, 668 {"rb_protect", (RUBY_PROC*)&dll_rb_protect}, 669 {"rb_load", (RUBY_PROC*)&dll_rb_load}, 670 {"rb_num2long", (RUBY_PROC*)&dll_rb_num2long}, 671 {"rb_num2ulong", (RUBY_PROC*)&dll_rb_num2ulong}, 672 {"rb_obj_alloc", (RUBY_PROC*)&dll_rb_obj_alloc}, 673 {"rb_obj_as_string", (RUBY_PROC*)&dll_rb_obj_as_string}, 674 {"rb_obj_id", (RUBY_PROC*)&dll_rb_obj_id}, 675 {"rb_raise", (RUBY_PROC*)&dll_rb_raise}, 676 # if RUBY_VERSION >= 18 677 {"rb_string_value", (RUBY_PROC*)&dll_rb_string_value}, 678 # else 679 {"rb_str2cstr", (RUBY_PROC*)&dll_rb_str2cstr}, 680 # endif 681 {"rb_str_cat", (RUBY_PROC*)&dll_rb_str_cat}, 682 {"rb_str_concat", (RUBY_PROC*)&dll_rb_str_concat}, 683 {"rb_str_new", (RUBY_PROC*)&dll_rb_str_new}, 684 # ifdef need_rb_str_new_cstr 685 {"rb_str_new_cstr", (RUBY_PROC*)&dll_rb_str_new_cstr}, 686 # else 687 {"rb_str_new2", (RUBY_PROC*)&dll_rb_str_new2}, 688 # endif 689 # if RUBY_VERSION >= 19 690 {"rb_errinfo", (RUBY_PROC*)&dll_rb_errinfo}, 691 # else 692 {"ruby_errinfo", (RUBY_PROC*)&dll_ruby_errinfo}, 693 # endif 694 {"ruby_init", (RUBY_PROC*)&dll_ruby_init}, 695 {"ruby_init_loadpath", (RUBY_PROC*)&dll_ruby_init_loadpath}, 696 # ifdef MSWIN 697 # if RUBY_VERSION >= 19 698 {"ruby_sysinit", (RUBY_PROC*)&dll_ruby_sysinit}, 699 # else 700 {"NtInitialize", (RUBY_PROC*)&dll_NtInitialize}, 701 # endif 702 # if RUBY_VERSION >= 18 703 {"rb_w32_snprintf", (RUBY_PROC*)&dll_rb_w32_snprintf}, 704 # endif 705 # endif 706 # if RUBY_VERSION >= 18 707 {"rb_string_value_ptr", (RUBY_PROC*)&dll_rb_string_value_ptr}, 708 # if RUBY_VERSION <= 19 709 {"rb_float_new", (RUBY_PROC*)&dll_rb_float_new}, 710 # else 711 {"rb_float_new_in_heap", (RUBY_PROC*)&dll_rb_float_new}, 712 # endif 713 {"rb_ary_new", (RUBY_PROC*)&dll_rb_ary_new}, 714 # ifdef RB_ARY_NEW4_MACRO 715 {"rb_ary_new_from_values", (RUBY_PROC*)&dll_rb_ary_new4}, 716 # else 717 {"rb_ary_new4", (RUBY_PROC*)&dll_rb_ary_new4}, 718 # endif 719 {"rb_ary_push", (RUBY_PROC*)&dll_rb_ary_push}, 720 # if RUBY_VERSION >= 26 721 {"rb_ary_detransient", (RUBY_PROC*)&dll_rb_ary_detransient}, 722 # endif 723 # endif 724 # if RUBY_VERSION >= 19 725 {"rb_int2big", (RUBY_PROC*)&dll_rb_int2big}, 726 {"ruby_script", (RUBY_PROC*)&dll_ruby_script}, 727 {"rb_enc_find_index", (RUBY_PROC*)&dll_rb_enc_find_index}, 728 {"rb_enc_find", (RUBY_PROC*)&dll_rb_enc_find}, 729 {"rb_enc_str_new", (RUBY_PROC*)&dll_rb_enc_str_new}, 730 {"rb_sprintf", (RUBY_PROC*)&dll_rb_sprintf}, 731 {"rb_require", (RUBY_PROC*)&dll_rb_require}, 732 {"ruby_options", (RUBY_PROC*)&dll_ruby_options}, 733 # endif 734 # if (RUBY_VERSION >= 19) || defined(RUBY_INIT_STACK) 735 # ifdef __ia64 736 {"rb_ia64_bsp", (RUBY_PROC*)&dll_rb_ia64_bsp}, 737 # endif 738 {"ruby_init_stack", (RUBY_PROC*)&dll_ruby_init_stack}, 739 # endif 740 # if defined(USE_RGENGC) && USE_RGENGC 741 # if RUBY_VERSION == 21 742 {"rb_gc_writebarrier_unprotect_promoted", (RUBY_PROC*)&dll_rb_gc_writebarrier_unprotect_promoted}, 743 # else 744 {"rb_gc_writebarrier_unprotect", (RUBY_PROC*)&dll_rb_gc_writebarrier_unprotect}, 745 # endif 746 # endif 747 {"", NULL}, 748 }; 749 750 /* 751 * Load library and get all pointers. 752 * Parameter 'libname' provides name of DLL. 753 * Return OK or FAIL. 754 */ 755 static int 756 ruby_runtime_link_init(char *libname, int verbose) 757 { 758 int i; 759 760 if (hinstRuby) 761 return OK; 762 hinstRuby = load_dll(libname); 763 if (!hinstRuby) 764 { 765 if (verbose) 766 semsg(_(e_loadlib), libname); 767 return FAIL; 768 } 769 770 for (i = 0; ruby_funcname_table[i].ptr; ++i) 771 { 772 if (!(*ruby_funcname_table[i].ptr = symbol_from_dll(hinstRuby, 773 ruby_funcname_table[i].name))) 774 { 775 close_dll(hinstRuby); 776 hinstRuby = NULL; 777 if (verbose) 778 semsg(_(e_loadfunc), ruby_funcname_table[i].name); 779 return FAIL; 780 } 781 } 782 return OK; 783 } 784 785 /* 786 * If ruby is enabled (there is installed ruby on Windows system) return TRUE, 787 * else FALSE. 788 */ 789 int 790 ruby_enabled(int verbose) 791 { 792 return ruby_runtime_link_init((char *)p_rubydll, verbose) == OK; 793 } 794 #endif // defined(DYNAMIC_RUBY) || defined(PROTO) 795 796 void 797 ruby_end(void) 798 { 799 } 800 801 void 802 ex_ruby(exarg_T *eap) 803 { 804 int state; 805 char *script = NULL; 806 807 script = (char *)script_get(eap, eap->arg); 808 if (!eap->skip && ensure_ruby_initialized()) 809 { 810 if (script == NULL) 811 rb_eval_string_protect((char *)eap->arg, &state); 812 else 813 rb_eval_string_protect(script, &state); 814 if (state) 815 error_print(state); 816 } 817 vim_free(script); 818 } 819 820 /* 821 * In Ruby 1.9 or later, ruby String object has encoding. 822 * conversion buffer string of vim to ruby String object using 823 * VIM encoding option. 824 */ 825 static VALUE 826 vim_str2rb_enc_str(const char *s) 827 { 828 #if RUBY_VERSION >= 19 829 int isnum; 830 long lval; 831 char_u *sval; 832 rb_encoding *enc; 833 834 isnum = get_option_value((char_u *)"enc", &lval, &sval, 0); 835 if (isnum == 0) 836 { 837 enc = rb_enc_find((char *)sval); 838 vim_free(sval); 839 if (enc) 840 return rb_enc_str_new(s, (long)strlen(s), enc); 841 } 842 #endif 843 return rb_str_new2(s); 844 } 845 846 static VALUE 847 eval_enc_string_protect(const char *str, int *state) 848 { 849 #if RUBY_VERSION >= 19 850 int isnum; 851 long lval; 852 char_u *sval; 853 rb_encoding *enc; 854 VALUE v; 855 856 isnum = get_option_value((char_u *)"enc", &lval, &sval, 0); 857 if (isnum == 0) 858 { 859 enc = rb_enc_find((char *)sval); 860 vim_free(sval); 861 if (enc) 862 { 863 v = rb_sprintf("#-*- coding:%s -*-\n%s", rb_enc_name(enc), str); 864 return rb_eval_string_protect(StringValuePtr(v), state); 865 } 866 } 867 #endif 868 return rb_eval_string_protect(str, state); 869 } 870 871 void 872 ex_rubydo(exarg_T *eap) 873 { 874 int state; 875 linenr_T i; 876 buf_T *was_curbuf = curbuf; 877 878 if (ensure_ruby_initialized()) 879 { 880 if (u_save(eap->line1 - 1, eap->line2 + 1) != OK) 881 return; 882 for (i = eap->line1; i <= eap->line2; i++) 883 { 884 VALUE line; 885 886 if (i > curbuf->b_ml.ml_line_count) 887 break; 888 line = vim_str2rb_enc_str((char *)ml_get(i)); 889 rb_lastline_set(line); 890 eval_enc_string_protect((char *) eap->arg, &state); 891 if (state) 892 { 893 error_print(state); 894 break; 895 } 896 if (was_curbuf != curbuf) 897 break; 898 line = rb_lastline_get(); 899 if (!NIL_P(line)) 900 { 901 if (TYPE(line) != T_STRING) 902 { 903 emsg(_("E265: $_ must be an instance of String")); 904 return; 905 } 906 ml_replace(i, (char_u *) StringValuePtr(line), 1); 907 changed(); 908 #ifdef SYNTAX_HL 909 syn_changed(i); // recompute syntax hl. for this line 910 #endif 911 } 912 } 913 check_cursor(); 914 update_curbuf(NOT_VALID); 915 } 916 } 917 918 static VALUE 919 rb_load_wrap(VALUE file_to_load) 920 { 921 rb_load(file_to_load, 0); 922 return Qnil; 923 } 924 925 void 926 ex_rubyfile(exarg_T *eap) 927 { 928 int state; 929 930 if (ensure_ruby_initialized()) 931 { 932 VALUE file_to_load = rb_str_new2((const char *)eap->arg); 933 rb_protect(rb_load_wrap, file_to_load, &state); 934 if (state) 935 error_print(state); 936 } 937 } 938 939 void 940 ruby_buffer_free(buf_T *buf) 941 { 942 if (buf->b_ruby_ref) 943 { 944 rb_hash_aset(objtbl, rb_obj_id((VALUE) buf->b_ruby_ref), Qnil); 945 RDATA(buf->b_ruby_ref)->data = NULL; 946 } 947 } 948 949 void 950 ruby_window_free(win_T *win) 951 { 952 if (win->w_ruby_ref) 953 { 954 rb_hash_aset(objtbl, rb_obj_id((VALUE) win->w_ruby_ref), Qnil); 955 RDATA(win->w_ruby_ref)->data = NULL; 956 } 957 } 958 959 static int 960 ensure_ruby_initialized(void) 961 { 962 if (!ruby_initialized) 963 { 964 #ifdef DYNAMIC_RUBY 965 if (ruby_enabled(TRUE)) 966 { 967 #endif 968 #ifdef MSWIN 969 // suggested by Ariya Mizutani 970 int argc = 1; 971 char *argv[] = {"gvim.exe"}; 972 char **argvp = argv; 973 # if RUBY_VERSION >= 19 974 ruby_sysinit(&argc, &argvp); 975 # else 976 NtInitialize(&argc, &argvp); 977 # endif 978 #endif 979 { 980 #if (RUBY_VERSION >= 19) || defined(RUBY_INIT_STACK) 981 ruby_init_stack(ruby_stack_start); 982 #endif 983 ruby_init(); 984 } 985 #if RUBY_VERSION >= 19 986 { 987 int dummy_argc = 2; 988 char *dummy_argv[] = {"vim-ruby", "-e_=0"}; 989 ruby_options(dummy_argc, dummy_argv); 990 } 991 ruby_script("vim-ruby"); 992 #else 993 ruby_init_loadpath(); 994 #endif 995 ruby_io_init(); 996 ruby_vim_init(); 997 ruby_initialized = 1; 998 #ifdef DYNAMIC_RUBY 999 } 1000 else 1001 { 1002 emsg(_("E266: Sorry, this command is disabled, the Ruby library could not be loaded.")); 1003 return 0; 1004 } 1005 #endif 1006 } 1007 return ruby_initialized; 1008 } 1009 1010 static void 1011 error_print(int state) 1012 { 1013 #if !defined(DYNAMIC_RUBY) && (RUBY_VERSION <= 18) 1014 RUBYEXTERN VALUE ruby_errinfo; 1015 #endif 1016 VALUE error; 1017 VALUE eclass; 1018 VALUE einfo; 1019 VALUE bt; 1020 int attr; 1021 char buff[BUFSIZ]; 1022 long i; 1023 1024 #define TAG_RETURN 0x1 1025 #define TAG_BREAK 0x2 1026 #define TAG_NEXT 0x3 1027 #define TAG_RETRY 0x4 1028 #define TAG_REDO 0x5 1029 #define TAG_RAISE 0x6 1030 #define TAG_THROW 0x7 1031 #define TAG_FATAL 0x8 1032 #define TAG_MASK 0xf 1033 1034 switch (state) 1035 { 1036 case TAG_RETURN: 1037 emsg(_("E267: unexpected return")); 1038 break; 1039 case TAG_NEXT: 1040 emsg(_("E268: unexpected next")); 1041 break; 1042 case TAG_BREAK: 1043 emsg(_("E269: unexpected break")); 1044 break; 1045 case TAG_REDO: 1046 emsg(_("E270: unexpected redo")); 1047 break; 1048 case TAG_RETRY: 1049 emsg(_("E271: retry outside of rescue clause")); 1050 break; 1051 case TAG_RAISE: 1052 case TAG_FATAL: 1053 #if RUBY_VERSION >= 19 1054 error = rb_errinfo(); 1055 #else 1056 error = ruby_errinfo; 1057 #endif 1058 eclass = CLASS_OF(error); 1059 einfo = rb_obj_as_string(error); 1060 if (eclass == rb_eRuntimeError && RSTRING_LEN(einfo) == 0) 1061 { 1062 emsg(_("E272: unhandled exception")); 1063 } 1064 else 1065 { 1066 VALUE epath; 1067 char *p; 1068 1069 epath = rb_class_path(eclass); 1070 vim_snprintf(buff, BUFSIZ, "%s: %s", 1071 RSTRING_PTR(epath), RSTRING_PTR(einfo)); 1072 p = strchr(buff, '\n'); 1073 if (p) *p = '\0'; 1074 emsg(buff); 1075 } 1076 1077 attr = syn_name2attr((char_u *)"Error"); 1078 #if RUBY_VERSION >= 21 1079 bt = rb_funcallv(error, rb_intern("backtrace"), 0, 0); 1080 for (i = 0; i < RARRAY_LEN(bt); i++) 1081 msg_attr(RSTRING_PTR(RARRAY_AREF(bt, i)), attr); 1082 #else 1083 bt = rb_funcall2(error, rb_intern("backtrace"), 0, 0); 1084 for (i = 0; i < RARRAY_LEN(bt); i++) 1085 msg_attr(RSTRING_PTR(RARRAY_PTR(bt)[i]), attr); 1086 #endif 1087 break; 1088 default: 1089 vim_snprintf(buff, BUFSIZ, _("E273: unknown longjmp status %d"), state); 1090 emsg(buff); 1091 break; 1092 } 1093 } 1094 1095 static VALUE 1096 vim_message(VALUE self UNUSED, VALUE str) 1097 { 1098 char *buff, *p; 1099 1100 str = rb_obj_as_string(str); 1101 if (RSTRING_LEN(str) > 0) 1102 { 1103 // Only do this when the string isn't empty, alloc(0) causes trouble. 1104 buff = ALLOCA_N(char, RSTRING_LEN(str) + 1); 1105 strcpy(buff, RSTRING_PTR(str)); 1106 p = strchr(buff, '\n'); 1107 if (p) *p = '\0'; 1108 msg(buff); 1109 } 1110 else 1111 { 1112 msg(""); 1113 } 1114 return Qnil; 1115 } 1116 1117 static VALUE 1118 vim_set_option(VALUE self UNUSED, VALUE str) 1119 { 1120 do_set((char_u *)StringValuePtr(str), 0); 1121 update_screen(NOT_VALID); 1122 return Qnil; 1123 } 1124 1125 static VALUE 1126 vim_command(VALUE self UNUSED, VALUE str) 1127 { 1128 do_cmdline_cmd((char_u *)StringValuePtr(str)); 1129 return Qnil; 1130 } 1131 1132 #ifdef FEAT_EVAL 1133 static VALUE 1134 vim_to_ruby(typval_T *tv) 1135 { 1136 VALUE result = Qnil; 1137 1138 if (tv->v_type == VAR_STRING) 1139 { 1140 result = rb_str_new2(tv->vval.v_string == NULL 1141 ? "" : (char *)(tv->vval.v_string)); 1142 } 1143 else if (tv->v_type == VAR_NUMBER) 1144 { 1145 result = INT2NUM(tv->vval.v_number); 1146 } 1147 # ifdef FEAT_FLOAT 1148 else if (tv->v_type == VAR_FLOAT) 1149 { 1150 result = rb_float_new(tv->vval.v_float); 1151 } 1152 # endif 1153 else if (tv->v_type == VAR_LIST) 1154 { 1155 list_T *list = tv->vval.v_list; 1156 listitem_T *curr; 1157 1158 result = rb_ary_new(); 1159 1160 if (list != NULL) 1161 { 1162 FOR_ALL_LIST_ITEMS(list, curr) 1163 rb_ary_push(result, vim_to_ruby(&curr->li_tv)); 1164 } 1165 } 1166 else if (tv->v_type == VAR_DICT) 1167 { 1168 result = rb_hash_new(); 1169 1170 if (tv->vval.v_dict != NULL) 1171 { 1172 hashtab_T *ht = &tv->vval.v_dict->dv_hashtab; 1173 long_u todo = ht->ht_used; 1174 hashitem_T *hi; 1175 dictitem_T *di; 1176 1177 for (hi = ht->ht_array; todo > 0; ++hi) 1178 { 1179 if (!HASHITEM_EMPTY(hi)) 1180 { 1181 --todo; 1182 1183 di = dict_lookup(hi); 1184 rb_hash_aset(result, rb_str_new2((char *)hi->hi_key), 1185 vim_to_ruby(&di->di_tv)); 1186 } 1187 } 1188 } 1189 } 1190 else if (tv->v_type == VAR_BOOL || tv->v_type == VAR_SPECIAL) 1191 { 1192 if (tv->vval.v_number == VVAL_TRUE) 1193 result = Qtrue; 1194 else if (tv->vval.v_number == VVAL_FALSE) 1195 result = Qfalse; 1196 } 1197 else if (tv->v_type == VAR_BLOB) 1198 { 1199 result = rb_str_new(tv->vval.v_blob->bv_ga.ga_data, 1200 tv->vval.v_blob->bv_ga.ga_len); 1201 } 1202 // else return Qnil; 1203 1204 return result; 1205 } 1206 #endif 1207 1208 static VALUE 1209 vim_evaluate(VALUE self UNUSED, VALUE str) 1210 { 1211 #ifdef FEAT_EVAL 1212 typval_T *tv; 1213 VALUE result; 1214 1215 tv = eval_expr((char_u *)StringValuePtr(str), NULL); 1216 if (tv == NULL) 1217 return Qnil; 1218 result = vim_to_ruby(tv); 1219 1220 free_tv(tv); 1221 1222 return result; 1223 #else 1224 return Qnil; 1225 #endif 1226 } 1227 1228 #ifdef USE_TYPEDDATA 1229 static size_t buffer_dsize(const void *buf); 1230 1231 static const rb_data_type_t buffer_type = { 1232 "vim_buffer", 1233 {0, 0, buffer_dsize, 1234 # if RUBY_VERSION >= 27 1235 0, {0} 1236 # else 1237 {0, 0} 1238 # endif 1239 }, 1240 0, 0, 1241 # ifdef RUBY_TYPED_FREE_IMMEDIATELY 1242 0, 1243 # endif 1244 }; 1245 1246 static size_t 1247 buffer_dsize(const void *buf UNUSED) 1248 { 1249 return sizeof(buf_T); 1250 } 1251 #endif 1252 1253 static VALUE 1254 buffer_new(buf_T *buf) 1255 { 1256 if (buf->b_ruby_ref) 1257 { 1258 return (VALUE) buf->b_ruby_ref; 1259 } 1260 else 1261 { 1262 #ifdef USE_TYPEDDATA 1263 VALUE obj = TypedData_Wrap_Struct(cBuffer, &buffer_type, buf); 1264 #else 1265 VALUE obj = Data_Wrap_Struct(cBuffer, 0, 0, buf); 1266 #endif 1267 buf->b_ruby_ref = (void *) obj; 1268 rb_hash_aset(objtbl, rb_obj_id(obj), obj); 1269 return obj; 1270 } 1271 } 1272 1273 static buf_T * 1274 get_buf(VALUE obj) 1275 { 1276 buf_T *buf; 1277 1278 #ifdef USE_TYPEDDATA 1279 TypedData_Get_Struct(obj, buf_T, &buffer_type, buf); 1280 #else 1281 Data_Get_Struct(obj, buf_T, buf); 1282 #endif 1283 if (buf == NULL) 1284 rb_raise(eDeletedBufferError, "attempt to refer to deleted buffer"); 1285 return buf; 1286 } 1287 1288 static VALUE 1289 vim_blob(VALUE self UNUSED, VALUE str) 1290 { 1291 VALUE result = rb_str_new("0z", 2); 1292 char buf[4]; 1293 int i; 1294 for (i = 0; i < RSTRING_LEN(str); i++) 1295 { 1296 sprintf(buf, "%02X", (unsigned char)(RSTRING_PTR(str)[i])); 1297 rb_str_concat(result, rb_str_new2(buf)); 1298 } 1299 return result; 1300 } 1301 1302 static VALUE 1303 buffer_s_current(void) 1304 { 1305 return buffer_new(curbuf); 1306 } 1307 1308 static VALUE 1309 buffer_s_count(void) 1310 { 1311 buf_T *b; 1312 int n = 0; 1313 1314 FOR_ALL_BUFFERS(b) 1315 { 1316 // Deleted buffers should not be counted 1317 // SegPhault - 01/07/05 1318 if (b->b_p_bl) 1319 n++; 1320 } 1321 1322 return INT2NUM(n); 1323 } 1324 1325 static VALUE 1326 buffer_s_aref(VALUE self UNUSED, VALUE num) 1327 { 1328 buf_T *b; 1329 int n = NUM2INT(num); 1330 1331 FOR_ALL_BUFFERS(b) 1332 { 1333 // Deleted buffers should not be counted 1334 // SegPhault - 01/07/05 1335 if (!b->b_p_bl) 1336 continue; 1337 1338 if (n == 0) 1339 return buffer_new(b); 1340 1341 n--; 1342 } 1343 return Qnil; 1344 } 1345 1346 static VALUE 1347 buffer_name(VALUE self) 1348 { 1349 buf_T *buf = get_buf(self); 1350 1351 return buf->b_ffname ? rb_str_new2((char *)buf->b_ffname) : Qnil; 1352 } 1353 1354 static VALUE 1355 buffer_number(VALUE self) 1356 { 1357 buf_T *buf = get_buf(self); 1358 1359 return INT2NUM(buf->b_fnum); 1360 } 1361 1362 static VALUE 1363 buffer_count(VALUE self) 1364 { 1365 buf_T *buf = get_buf(self); 1366 1367 return INT2NUM(buf->b_ml.ml_line_count); 1368 } 1369 1370 static VALUE 1371 get_buffer_line(buf_T *buf, linenr_T n) 1372 { 1373 if (n <= 0 || n > buf->b_ml.ml_line_count) 1374 rb_raise(rb_eIndexError, "line number %ld out of range", (long)n); 1375 return vim_str2rb_enc_str((char *)ml_get_buf(buf, n, FALSE)); 1376 } 1377 1378 static VALUE 1379 buffer_aref(VALUE self, VALUE num) 1380 { 1381 buf_T *buf = get_buf(self); 1382 1383 if (buf != NULL) 1384 return get_buffer_line(buf, (linenr_T)NUM2LONG(num)); 1385 return Qnil; // For stop warning 1386 } 1387 1388 static VALUE 1389 set_buffer_line(buf_T *buf, linenr_T n, VALUE str) 1390 { 1391 char *line = StringValuePtr(str); 1392 aco_save_T aco; 1393 1394 if (n > 0 && n <= buf->b_ml.ml_line_count && line != NULL) 1395 { 1396 // set curwin/curbuf for "buf" and save some things 1397 aucmd_prepbuf(&aco, buf); 1398 1399 if (u_savesub(n) == OK) 1400 { 1401 ml_replace(n, (char_u *)line, TRUE); 1402 changed(); 1403 #ifdef SYNTAX_HL 1404 syn_changed(n); // recompute syntax hl. for this line 1405 #endif 1406 } 1407 1408 // restore curwin/curbuf and a few other things 1409 aucmd_restbuf(&aco); 1410 // Careful: autocommands may have made "buf" invalid! 1411 1412 update_curbuf(NOT_VALID); 1413 } 1414 else 1415 { 1416 rb_raise(rb_eIndexError, "line number %ld out of range", (long)n); 1417 } 1418 return str; 1419 } 1420 1421 static VALUE 1422 buffer_aset(VALUE self, VALUE num, VALUE str) 1423 { 1424 buf_T *buf = get_buf(self); 1425 1426 if (buf != NULL) 1427 return set_buffer_line(buf, (linenr_T)NUM2LONG(num), str); 1428 return str; 1429 } 1430 1431 static VALUE 1432 buffer_delete(VALUE self, VALUE num) 1433 { 1434 buf_T *buf = get_buf(self); 1435 long n = NUM2LONG(num); 1436 aco_save_T aco; 1437 1438 if (n > 0 && n <= buf->b_ml.ml_line_count) 1439 { 1440 // set curwin/curbuf for "buf" and save some things 1441 aucmd_prepbuf(&aco, buf); 1442 1443 if (u_savedel(n, 1) == OK) 1444 { 1445 ml_delete(n); 1446 1447 // Changes to non-active buffers should properly refresh 1448 // SegPhault - 01/09/05 1449 deleted_lines_mark(n, 1L); 1450 1451 changed(); 1452 } 1453 1454 // restore curwin/curbuf and a few other things 1455 aucmd_restbuf(&aco); 1456 // Careful: autocommands may have made "buf" invalid! 1457 1458 update_curbuf(NOT_VALID); 1459 } 1460 else 1461 { 1462 rb_raise(rb_eIndexError, "line number %ld out of range", n); 1463 } 1464 return Qnil; 1465 } 1466 1467 static VALUE 1468 buffer_append(VALUE self, VALUE num, VALUE str) 1469 { 1470 buf_T *buf = get_buf(self); 1471 char *line = StringValuePtr(str); 1472 long n = NUM2LONG(num); 1473 aco_save_T aco; 1474 1475 if (line == NULL) 1476 { 1477 rb_raise(rb_eIndexError, "NULL line"); 1478 } 1479 else if (n >= 0 && n <= buf->b_ml.ml_line_count) 1480 { 1481 // set curwin/curbuf for "buf" and save some things 1482 aucmd_prepbuf(&aco, buf); 1483 1484 if (u_inssub(n + 1) == OK) 1485 { 1486 ml_append(n, (char_u *) line, (colnr_T) 0, FALSE); 1487 1488 // Changes to non-active buffers should properly refresh screen 1489 // SegPhault - 12/20/04 1490 appended_lines_mark(n, 1L); 1491 1492 changed(); 1493 } 1494 1495 // restore curwin/curbuf and a few other things 1496 aucmd_restbuf(&aco); 1497 // Careful: autocommands may have made "buf" invalid! 1498 1499 update_curbuf(NOT_VALID); 1500 } 1501 else 1502 { 1503 rb_raise(rb_eIndexError, "line number %ld out of range", n); 1504 } 1505 return str; 1506 } 1507 1508 #ifdef USE_TYPEDDATA 1509 static size_t window_dsize(const void *buf); 1510 1511 static const rb_data_type_t window_type = { 1512 "vim_window", 1513 {0, 0, window_dsize, 1514 # if RUBY_VERSION >= 27 1515 0, {0} 1516 # else 1517 {0, 0} 1518 # endif 1519 }, 1520 0, 0, 1521 # ifdef RUBY_TYPED_FREE_IMMEDIATELY 1522 0, 1523 # endif 1524 }; 1525 1526 static size_t 1527 window_dsize(const void *win UNUSED) 1528 { 1529 return sizeof(win_T); 1530 } 1531 #endif 1532 1533 static VALUE 1534 window_new(win_T *win) 1535 { 1536 if (win->w_ruby_ref) 1537 { 1538 return (VALUE) win->w_ruby_ref; 1539 } 1540 else 1541 { 1542 #ifdef USE_TYPEDDATA 1543 VALUE obj = TypedData_Wrap_Struct(cVimWindow, &window_type, win); 1544 #else 1545 VALUE obj = Data_Wrap_Struct(cVimWindow, 0, 0, win); 1546 #endif 1547 win->w_ruby_ref = (void *) obj; 1548 rb_hash_aset(objtbl, rb_obj_id(obj), obj); 1549 return obj; 1550 } 1551 } 1552 1553 static win_T * 1554 get_win(VALUE obj) 1555 { 1556 win_T *win; 1557 1558 #ifdef USE_TYPEDDATA 1559 TypedData_Get_Struct(obj, win_T, &window_type, win); 1560 #else 1561 Data_Get_Struct(obj, win_T, win); 1562 #endif 1563 if (win == NULL) 1564 rb_raise(eDeletedWindowError, "attempt to refer to deleted window"); 1565 return win; 1566 } 1567 1568 static VALUE 1569 window_s_current(void) 1570 { 1571 return window_new(curwin); 1572 } 1573 1574 /* 1575 * Added line manipulation functions 1576 * SegPhault - 03/07/05 1577 */ 1578 static VALUE 1579 line_s_current(void) 1580 { 1581 return get_buffer_line(curbuf, curwin->w_cursor.lnum); 1582 } 1583 1584 static VALUE 1585 set_current_line(VALUE self UNUSED, VALUE str) 1586 { 1587 return set_buffer_line(curbuf, curwin->w_cursor.lnum, str); 1588 } 1589 1590 static VALUE 1591 current_line_number(void) 1592 { 1593 return INT2FIX((int)curwin->w_cursor.lnum); 1594 } 1595 1596 static VALUE 1597 window_s_count(void) 1598 { 1599 win_T *w; 1600 int n = 0; 1601 1602 FOR_ALL_WINDOWS(w) 1603 n++; 1604 return INT2NUM(n); 1605 } 1606 1607 static VALUE 1608 window_s_aref(VALUE self UNUSED, VALUE num) 1609 { 1610 win_T *w; 1611 int n = NUM2INT(num); 1612 1613 for (w = firstwin; w != NULL; w = w->w_next, --n) 1614 if (n == 0) 1615 return window_new(w); 1616 return Qnil; 1617 } 1618 1619 static VALUE 1620 window_buffer(VALUE self) 1621 { 1622 win_T *win = get_win(self); 1623 1624 return buffer_new(win->w_buffer); 1625 } 1626 1627 static VALUE 1628 window_height(VALUE self) 1629 { 1630 win_T *win = get_win(self); 1631 1632 return INT2NUM(win->w_height); 1633 } 1634 1635 static VALUE 1636 window_set_height(VALUE self, VALUE height) 1637 { 1638 win_T *win = get_win(self); 1639 win_T *savewin = curwin; 1640 1641 curwin = win; 1642 win_setheight(NUM2INT(height)); 1643 curwin = savewin; 1644 return height; 1645 } 1646 1647 static VALUE 1648 window_width(VALUE self UNUSED) 1649 { 1650 return INT2NUM(get_win(self)->w_width); 1651 } 1652 1653 static VALUE 1654 window_set_width(VALUE self UNUSED, VALUE width) 1655 { 1656 win_T *win = get_win(self); 1657 win_T *savewin = curwin; 1658 1659 curwin = win; 1660 win_setwidth(NUM2INT(width)); 1661 curwin = savewin; 1662 return width; 1663 } 1664 1665 static VALUE 1666 window_cursor(VALUE self) 1667 { 1668 win_T *win = get_win(self); 1669 1670 return rb_assoc_new(INT2NUM(win->w_cursor.lnum), INT2NUM(win->w_cursor.col)); 1671 } 1672 1673 static VALUE 1674 window_set_cursor(VALUE self, VALUE pos) 1675 { 1676 VALUE lnum, col; 1677 win_T *win = get_win(self); 1678 1679 Check_Type(pos, T_ARRAY); 1680 if (RARRAY_LEN(pos) != 2) 1681 rb_raise(rb_eArgError, "array length must be 2"); 1682 lnum = RARRAY_PTR(pos)[0]; 1683 col = RARRAY_PTR(pos)[1]; 1684 win->w_cursor.lnum = NUM2LONG(lnum); 1685 win->w_cursor.col = NUM2UINT(col); 1686 win->w_set_curswant = TRUE; 1687 check_cursor(); // put cursor on an existing line 1688 update_screen(NOT_VALID); 1689 return Qnil; 1690 } 1691 1692 static VALUE 1693 f_nop(VALUE self UNUSED) 1694 { 1695 return Qnil; 1696 } 1697 1698 static VALUE 1699 f_p(int argc, VALUE *argv, VALUE self UNUSED) 1700 { 1701 int i; 1702 VALUE str = rb_str_new("", 0); 1703 VALUE ret = Qnil; 1704 1705 for (i = 0; i < argc; i++) 1706 { 1707 if (i > 0) rb_str_cat(str, ", ", 2); 1708 rb_str_concat(str, rb_inspect(argv[i])); 1709 } 1710 msg(RSTRING_PTR(str)); 1711 1712 if (argc == 1) 1713 ret = argv[0]; 1714 else if (argc > 1) 1715 ret = rb_ary_new4(argc, argv); 1716 return ret; 1717 } 1718 1719 static void 1720 ruby_io_init(void) 1721 { 1722 #ifndef DYNAMIC_RUBY 1723 RUBYEXTERN VALUE rb_stdout; 1724 RUBYEXTERN VALUE rb_stderr; 1725 #endif 1726 1727 rb_stdout = rb_obj_alloc(rb_cObject); 1728 rb_stderr = rb_obj_alloc(rb_cObject); 1729 rb_define_singleton_method(rb_stdout, "write", vim_message, 1); 1730 rb_define_singleton_method(rb_stdout, "flush", f_nop, 0); 1731 rb_define_singleton_method(rb_stderr, "write", vim_message, 1); 1732 rb_define_singleton_method(rb_stderr, "flush", f_nop, 0); 1733 rb_define_global_function("p", f_p, -1); 1734 } 1735 1736 static void 1737 ruby_vim_init(void) 1738 { 1739 objtbl = rb_hash_new(); 1740 rb_global_variable(&objtbl); 1741 1742 // The Vim module used to be called "VIM", but "Vim" is better. Make an 1743 // alias "VIM" for backwards compatibility. 1744 mVIM = rb_define_module("Vim"); 1745 rb_define_const(rb_cObject, "VIM", mVIM); 1746 rb_define_const(mVIM, "VERSION_MAJOR", INT2NUM(VIM_VERSION_MAJOR)); 1747 rb_define_const(mVIM, "VERSION_MINOR", INT2NUM(VIM_VERSION_MINOR)); 1748 rb_define_const(mVIM, "VERSION_BUILD", INT2NUM(VIM_VERSION_BUILD)); 1749 rb_define_const(mVIM, "VERSION_PATCHLEVEL", INT2NUM(VIM_VERSION_PATCHLEVEL)); 1750 rb_define_const(mVIM, "VERSION_SHORT", rb_str_new2(VIM_VERSION_SHORT)); 1751 rb_define_const(mVIM, "VERSION_MEDIUM", rb_str_new2(VIM_VERSION_MEDIUM)); 1752 rb_define_const(mVIM, "VERSION_LONG", rb_str_new2(VIM_VERSION_LONG)); 1753 rb_define_const(mVIM, "VERSION_LONG_DATE", rb_str_new2(VIM_VERSION_LONG_DATE)); 1754 rb_define_module_function(mVIM, "message", vim_message, 1); 1755 rb_define_module_function(mVIM, "set_option", vim_set_option, 1); 1756 rb_define_module_function(mVIM, "command", vim_command, 1); 1757 rb_define_module_function(mVIM, "evaluate", vim_evaluate, 1); 1758 rb_define_module_function(mVIM, "blob", vim_blob, 1); 1759 1760 eDeletedBufferError = rb_define_class_under(mVIM, "DeletedBufferError", 1761 rb_eStandardError); 1762 eDeletedWindowError = rb_define_class_under(mVIM, "DeletedWindowError", 1763 rb_eStandardError); 1764 1765 cBuffer = rb_define_class_under(mVIM, "Buffer", rb_cObject); 1766 rb_define_singleton_method(cBuffer, "current", buffer_s_current, 0); 1767 rb_define_singleton_method(cBuffer, "count", buffer_s_count, 0); 1768 rb_define_singleton_method(cBuffer, "[]", buffer_s_aref, 1); 1769 rb_define_method(cBuffer, "name", buffer_name, 0); 1770 rb_define_method(cBuffer, "number", buffer_number, 0); 1771 rb_define_method(cBuffer, "count", buffer_count, 0); 1772 rb_define_method(cBuffer, "length", buffer_count, 0); 1773 rb_define_method(cBuffer, "[]", buffer_aref, 1); 1774 rb_define_method(cBuffer, "[]=", buffer_aset, 2); 1775 rb_define_method(cBuffer, "delete", buffer_delete, 1); 1776 rb_define_method(cBuffer, "append", buffer_append, 2); 1777 1778 // Added line manipulation functions 1779 // SegPhault - 03/07/05 1780 rb_define_method(cBuffer, "line_number", current_line_number, 0); 1781 rb_define_method(cBuffer, "line", line_s_current, 0); 1782 rb_define_method(cBuffer, "line=", set_current_line, 1); 1783 1784 1785 cVimWindow = rb_define_class_under(mVIM, "Window", rb_cObject); 1786 rb_define_singleton_method(cVimWindow, "current", window_s_current, 0); 1787 rb_define_singleton_method(cVimWindow, "count", window_s_count, 0); 1788 rb_define_singleton_method(cVimWindow, "[]", window_s_aref, 1); 1789 rb_define_method(cVimWindow, "buffer", window_buffer, 0); 1790 rb_define_method(cVimWindow, "height", window_height, 0); 1791 rb_define_method(cVimWindow, "height=", window_set_height, 1); 1792 rb_define_method(cVimWindow, "width", window_width, 0); 1793 rb_define_method(cVimWindow, "width=", window_set_width, 1); 1794 rb_define_method(cVimWindow, "cursor", window_cursor, 0); 1795 rb_define_method(cVimWindow, "cursor=", window_set_cursor, 1); 1796 1797 rb_define_virtual_variable("$curbuf", buffer_s_current, 0); 1798 rb_define_virtual_variable("$curwin", window_s_current, 0); 1799 } 1800 1801 void 1802 vim_ruby_init(void *stack_start) 1803 { 1804 // should get machine stack start address early in main function 1805 ruby_stack_start = stack_start; 1806 } 1807 1808 static int 1809 convert_hash2dict(VALUE key, VALUE val, VALUE arg) 1810 { 1811 dict_T *d = (dict_T *)arg; 1812 dictitem_T *di; 1813 1814 di = dictitem_alloc((char_u *)RSTRING_PTR(RSTRING(rb_obj_as_string(key)))); 1815 if (di == NULL || ruby_convert_to_vim_value(val, &di->di_tv) != OK 1816 || dict_add(d, di) != OK) 1817 { 1818 d->dv_hashtab.ht_error = TRUE; 1819 return ST_STOP; 1820 } 1821 return ST_CONTINUE; 1822 } 1823 1824 static int 1825 ruby_convert_to_vim_value(VALUE val, typval_T *rettv) 1826 { 1827 switch (TYPE(val)) 1828 { 1829 case T_NIL: 1830 rettv->v_type = VAR_SPECIAL; 1831 rettv->vval.v_number = VVAL_NULL; 1832 break; 1833 case T_TRUE: 1834 rettv->v_type = VAR_BOOL; 1835 rettv->vval.v_number = VVAL_TRUE; 1836 break; 1837 case T_FALSE: 1838 rettv->v_type = VAR_BOOL; 1839 rettv->vval.v_number = VVAL_FALSE; 1840 break; 1841 case T_BIGNUM: 1842 case T_FIXNUM: 1843 rettv->v_type = VAR_NUMBER; 1844 rettv->vval.v_number = (varnumber_T)NUM2LONG(val); 1845 break; 1846 #ifdef FEAT_FLOAT 1847 case T_FLOAT: 1848 rettv->v_type = VAR_FLOAT; 1849 rettv->vval.v_float = (float_T)NUM2DBL(val); 1850 break; 1851 #endif 1852 default: 1853 val = rb_obj_as_string(val); 1854 // FALLTHROUGH 1855 case T_STRING: 1856 { 1857 VALUE str = (VALUE)RSTRING(val); 1858 1859 rettv->v_type = VAR_STRING; 1860 rettv->vval.v_string = vim_strnsave((char_u *)RSTRING_PTR(str), 1861 (int)RSTRING_LEN(str)); 1862 } 1863 break; 1864 case T_ARRAY: 1865 { 1866 list_T *l; 1867 long i; 1868 typval_T v; 1869 1870 l = list_alloc(); 1871 if (l == NULL) 1872 return FAIL; 1873 1874 for (i = 0; i < RARRAY_LEN(val); ++i) 1875 { 1876 if (ruby_convert_to_vim_value((VALUE)RARRAY_PTR(val)[i], 1877 &v) != OK) 1878 { 1879 list_unref(l); 1880 return FAIL; 1881 } 1882 list_append_tv(l, &v); 1883 clear_tv(&v); 1884 } 1885 1886 rettv->v_type = VAR_LIST; 1887 rettv->vval.v_list = l; 1888 ++l->lv_refcount; 1889 } 1890 break; 1891 case T_HASH: 1892 { 1893 dict_T *d; 1894 1895 d = dict_alloc(); 1896 if (d == NULL) 1897 return FAIL; 1898 1899 rb_hash_foreach(val, convert_hash2dict, (VALUE)d); 1900 if (d->dv_hashtab.ht_error) 1901 { 1902 dict_unref(d); 1903 return FAIL; 1904 } 1905 1906 rettv->v_type = VAR_DICT; 1907 rettv->vval.v_dict = d; 1908 ++d->dv_refcount; 1909 } 1910 break; 1911 } 1912 return OK; 1913 } 1914 1915 void 1916 do_rubyeval(char_u *str, typval_T *rettv) 1917 { 1918 int retval = FAIL; 1919 1920 if (ensure_ruby_initialized()) 1921 { 1922 int state; 1923 VALUE obj; 1924 1925 obj = rb_eval_string_protect((const char *)str, &state); 1926 if (state) 1927 error_print(state); 1928 else 1929 retval = ruby_convert_to_vim_value(obj, rettv); 1930 } 1931 if (retval == FAIL) 1932 { 1933 rettv->v_type = VAR_NUMBER; 1934 rettv->vval.v_number = 0; 1935 } 1936 } 1937