Foreign.Ruby.Safe

This modules materializes the ruby interpreters as the RubyInterpreter data type. All the calls using these APIs are garanteed to run in the OS thread that the interpreter expects.

Initialization and finalization

startRubyInterpreter :: IO RubyInterpreter

Initializes a Ruby interpreter. This should only be called once. It actually runs an internal server in a dedicated OS thread.

closeRubyInterpreter :: RubyInterpreter -> IO ()

This will shut the internal server down.

withRubyInterpreter :: (RubyInterpreter -> IO a) -> IO a

This is basically :

bracket startRubyInterpreter closeRubyInterpreter

Data types

data RubyError

Constructors

Stack String String

WithOutput String RValue

OtherError String

Instances

Show RubyError

Defined in Foreign.Ruby.Safe

Methods

showsPrec :: Int -> RubyError -> ShowS

show :: RubyError -> String

showList :: [RubyError] -> ShowS

type RValue = Ptr CULong

This is the type of Ruby values. It is defined as a pointer to some unsigned long, just like Ruby does. The actual value is either pointed to, or encoded in the pointer.

data RubyInterpreter

This is actually a newtype around a TQueue.

Safe variants of other funtions

loadFile :: RubyInterpreter -> FilePath -> IO (Either RubyError ())

embedHaskellValue :: RubyInterpreter -> a -> IO (Either RubyError RValue)

This transforms any Haskell value into a Ruby big integer encoding the address of the corresponding StablePtr. This is useful when you want to pass such values to a Ruby program that will call Haskell functions.

This is probably a bad idea to do this. The use case is for calling Haskell functions from Ruby, using values generated from the Haskell world. If your main program is in Haskell, you should probably wrap a function partially applied with the value you would want to embed.

safeMethodCall :: RubyInterpreter -> String -> String -> [RValue] -> IO (Either RubyError RValue)

A safe version of the corresponding Foreign.Ruby.Helper function.

safeFunCall :: RubyInterpreter -> RValue -> String -> [RValue] -> IO (Either RubyError RValue)

A safe version of the corresponding Foreign.Ruby.Helper function.

makeSafe :: RubyInterpreter -> IO a -> IO (Either RubyError a)

Runs an arbitrary computation in the Ruby interpreter thread. This is useful if you want to embed calls from lower level functions. You still need to be careful about the GC's behavior.

fromRuby :: FromRuby a => RubyInterpreter -> RValue -> IO (Either RubyError a)

Converts a Ruby value to some Haskell type..

toRuby :: ToRuby a => RubyInterpreter -> a -> IO (Either RubyError RValue)

Insert a value in the Ruby runtime. You must always use such a function and the resulting RValue ina freezeGC call.

freezeGC :: RubyInterpreter -> IO a -> IO a

Runs a computation with the Ruby GC disabled. Once the computation is over, GC will be re-enabled and the startGC function run.

Wrapping Haskell function and registering them

type RubyFunction1 = RValue -> IO RValue

All those function types can be used to register functions to the Ruby runtime. Please note that the first argument is always set (it is "self"). For this reason, there is no RubyFunction0 type.

type RubyFunction2 = RValue -> RValue -> IO RValue

type RubyFunction3 = RValue -> RValue -> RValue -> IO RValue

type RubyFunction4 = RValue -> RValue -> RValue -> RValue -> IO RValue

type RubyFunction5 = RValue -> RValue -> RValue -> RValue -> RValue -> IO RValue

registerGlobalFunction1 :: RubyInterpreter -> String -> RubyFunction1 -> IO (Either RubyError ())

registerGlobalFunction2 :: RubyInterpreter -> String -> RubyFunction2 -> IO (Either RubyError ())

registerGlobalFunction3 :: RubyInterpreter -> String -> RubyFunction3 -> IO (Either RubyError ())

registerGlobalFunction4 :: RubyInterpreter -> String -> RubyFunction4 -> IO (Either RubyError ())

registerGlobalFunction5 :: RubyInterpreter -> String -> RubyFunction5 -> IO (Either RubyError ())