1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
use std::slice; use binding::vm; use types::{Argc, Value}; use {AnyObject, Class, Object, Proc}; /// Virtual Machine and helpers pub struct VM; impl VM { /// Initializes Ruby virtual machine. /// /// This function should **ONLY** be used if you write a standalone application which calls /// Ruby itself, for example: /// /// - Sidekiq-like background processing /// /// - Unicorn-like web server /// /// In these cases it should be called before any interaction with Ruby. /// /// If you write a library which is being connected to Ruby in runtime (e.g. some gem), this /// function should not be used. /// /// # Examples /// /// ``` /// use ruru::{Class, VM}; /// /// VM::init(); /// /// // VM started, able to use Ruby now /// // ... /// /// Class::new("SomeClass", None); // etc /// ``` pub fn init() { vm::init(); } /// Requires Ruby source file. /// /// # Examples /// /// ```no_run /// use ruru::VM; /// # VM::init(); /// /// VM::require("some_ruby_file"); /// ``` /// /// Ruby: /// /// ```ruby /// require 'some_ruby_file' /// ``` pub fn require(name: &str) { vm::require(name); } /// Raises an exception. /// /// # Examples /// /// ### Built-in exceptions /// /// ```no_run /// use ruru::{Class, VM}; /// # VM::init(); /// /// VM::raise(Class::from_existing("ArgumentError"), "Wrong argument"); /// ``` /// /// Ruby: /// /// ```ruby /// raise ArgumentError, 'Wrong argument' /// ``` /// /// ### Custom exceptions /// /// ```no_run /// use ruru::{Class, VM}; /// # VM::init(); /// /// let standard_error = Class::from_existing("StandardError"); /// let custom_exception = Class::new("CustomException", Some(&standard_error)); /// /// VM::raise(custom_exception, "Something went wrong"); /// ``` /// /// Ruby: /// /// ```ruby /// class CustomException < StandardError /// end /// /// raise CustomException, 'Something went wrong' /// ``` pub fn raise(exception: Class, message: &str) { vm::raise(exception.value(), message); } /// Converts a block given to current method to a `Proc` /// /// It works similarly to `def method(&block)` which converts block to `Proc` /// /// # Examples /// /// ```no_run /// #[macro_use] /// extern crate ruru; /// /// use ruru::{Class, Object, Proc, RString, VM}; /// /// class!(Greeter); /// /// methods!( /// Greeter, /// itself, /// /// fn greet_rust_with() -> RString { /// let greeting_template = VM::block_proc(); /// let name = RString::new("Rust").to_any_object(); /// /// greeting_template.call(vec![name]).try_convert_to::<RString>().unwrap() /// } /// ); /// /// fn main() { /// Class::new("Greeter", None).define(|itself| { /// itself.def_self("greet_rust_with", greet_rust_with); /// }); /// } /// ``` /// /// Ruby: /// /// ```ruby /// class Greeter /// def self.greet_rust_with(&greeting_template) /// greeting_template.call('Rust') /// end /// end /// /// Greeter.greet_rust_with do |name| /// "Hello, #{name}!" /// end /// # => "Hello, Rust!" /// ``` pub fn block_proc() -> Proc { Proc::from(vm::block_proc()) } /// Checks if a block is given to current method. /// /// # Examples /// /// ``` /// #[macro_use] extern crate ruru; /// /// use ruru::{Class, Fixnum, Object, VM}; /// /// class!(Calculator); /// /// methods!( /// Calculator, /// itself, /// /// fn calculate(a: Fixnum, b: Fixnum) -> Fixnum { /// let a = a.unwrap(); /// let b = b.unwrap(); /// /// if VM::is_block_given() { /// let result = VM::block_proc().call(vec![a.to_any_object(), b.to_any_object()]); /// /// result.try_convert_to::<Fixnum>().unwrap() /// } else { /// Fixnum::new(a.to_i64() + b.to_i64()) /// } /// } /// ); /// /// fn main() { /// # VM::init(); /// /// Class::new("Calculator", None).define(|itself| { /// itself.def("calculate", calculate); /// }); /// } /// ``` /// /// Ruby: /// /// ```ruby /// class Calculator /// def calculate(a, b, &block) /// if block_given? /// block.call(a, b) /// else /// a + b /// end /// end /// end /// ``` pub fn is_block_given() -> bool { vm::is_block_given() } // TODO: Move to other struct /// Converts a pointer to array of `AnyObject`s to `Vec<AnyObject>`. /// /// This function is a helper for callbacks, do not use it directly. /// /// It will be moved to other struct, because it is not related to VM itself. /// /// # Examples /// /// ```no_run /// use ruru::types::Argc; /// use ruru::{AnyObject, Boolean, Class, Object, RString, VM}; /// /// #[no_mangle] /// pub extern fn string_eq(argc: Argc, argv: *const AnyObject, itself: RString) -> Boolean { /// let argv = VM::parse_arguments(argc, argv); /// let other_string = argv[0].try_convert_to::<RString>().unwrap(); /// /// Boolean::new(itself.to_string() == other_string.to_string()) /// } /// /// fn main() { /// Class::from_existing("String").define_method("==", string_eq); /// } /// ``` pub fn parse_arguments(argc: Argc, arguments: *const AnyObject) -> Vec<AnyObject> { unsafe { slice::from_raw_parts(arguments, argc as usize).to_vec() } } /// Release GVL for current thread. /// /// **Warning!** Due to MRI limitations, interaction with Ruby objects is not allowed while /// GVL is released, it may cause unexpected behaviour. /// [Read more at Ruby documentation](https://github.com/ruby/ruby/blob/2fc5210f31ad23463d7b0a0e36bcfbeee7b41b3e/thread.c#L1314-L1398) /// /// You should extract all the information from Ruby world before invoking /// `thread_call_without_gvl`. /// /// GVL will be re-acquired when the closure is finished. /// /// # Examples /// /// ```no_run /// #[macro_use] extern crate ruru; /// /// use ruru::{Class, Fixnum, Object, VM}; /// /// class!(Calculator); /// /// methods!( /// Calculator, /// itself, /// /// fn heavy_computation() -> Fixnum { /// let computation = || { 2 * 2 }; /// let unblocking_function = || {}; /// /// // release GVL for current thread until `computation` is completed /// let result = VM::thread_call_without_gvl( /// computation, /// Some(unblocking_function) /// ); /// /// // GVL is re-acquired, we can interact with Ruby-world /// Fixnum::new(result) /// } /// ); /// /// fn main() { /// Class::new("Calculator", None).define(|itself| { /// itself.def("heavy_computation", heavy_computation); /// }); /// } /// ``` pub fn thread_call_without_gvl<F, R, G>(func: F, unblock_func: Option<G>) -> R where F: FnOnce() -> R, G: FnOnce() { vm::thread_call_without_gvl(func, unblock_func) } pub fn thread_call_without_gvl2<F, R, G>(func: F, unblock_func: Option<G>) -> R where F: FnOnce() -> R, G: FnOnce() { vm::thread_call_without_gvl2(func, unblock_func) } pub fn thread_call_with_gvl<F, R>(func: F) -> R where F: FnOnce() -> R { vm::thread_call_with_gvl(func) } pub fn protect<F>(func: F) -> Result<Value, i32> where F: FnOnce() { vm::protect(func) } }