Safe Haskell	None
Language	Haskell98

Foreign.Ruby.Bindings

Synopsis

Documentation

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.

type RID = CULong #

The Ruby ID type, mostly used for symbols.

data ShimDispatch #

Constructors

ShimDispatch String String [RValue]

Instances

Storable ShimDispatch #

data RBuiltin #

The ruby built-in types

Constructors

RNONE
RNIL
ROBJECT
RCLASS
RICLASS
RMODULE
RFLOAT
RSTRING
RREGEXP
RARRAY
RFIXNUM
RHASH
RSTRUCT
RBIGNUM
RFILE
RTRUE
RFALSE
RDATA
RMATCH
RSYMBOL
RUNDEF
RNODE

Instances

Show RBuiltin #
Methods showsPrec :: Int -> RBuiltin -> ShowS # show :: RBuiltin -> String # showList :: [RBuiltin] -> ShowS #

data RType #

Ruby native types, as encoded in the Value type.

Constructors

RFixNum
RNil
RFalse
RTrue
RSymbol
RUndef
RBuiltin RBuiltin

Instances

Show RType #
Methods showsPrec :: Int -> RType -> ShowS # show :: RType -> String # showList :: [RType] -> ShowS #

type Registered0 = IO RValue #

type Registered1 = RValue -> IO RValue #

type Registered2 = RValue -> RValue -> IO RValue #

mkRegistered0 :: Registered0 -> IO (FunPtr Registered0) #

Creates a function pointer suitable for usage with rb_define_global_function of type Registered0 (with 0 arguments).

mkRegistered1 :: Registered1 -> IO (FunPtr Registered1) #

Creates a function pointer suitable for usage with rb_define_global_function of type Registered1 (with 1 RValue arguments).

mkRegistered2 :: Registered2 -> IO (FunPtr Registered2) #

Creates a function pointer suitable for usage with rb_define_global_function of type Registered2 (with 2 RValue arguments).

type RegisteredCB3 = RValue -> RValue -> RValue -> IO Int #

mkRegisteredCB3 :: RegisteredCB3 -> IO (FunPtr RegisteredCB3) #

ruby_finalize :: IO () #

ruby_initialization :: IO () #

c_rb_str_new2 :: CString -> IO RValue #

rb_ary_new2 :: CLong -> IO RValue #

rb_ary_new4 :: CLong -> Ptr RValue -> IO RValue #

c_rb_load_protect :: RValue -> Int -> Ptr Int -> IO () #

c_rb_funcall_0 :: RValue -> RID -> Int -> IO RValue #

c_rb_funcall_1 :: RValue -> RID -> Int -> RValue -> IO RValue #

c_rb_funcall_2 :: RValue -> RID -> Int -> RValue -> RValue -> IO RValue #

c_rb_funcall_3 :: RValue -> RID -> Int -> RValue -> RValue -> RValue -> IO RValue #

c_rb_funcall_4 :: RValue -> RID -> Int -> RValue -> RValue -> RValue -> RValue -> IO RValue #

c_rb_funcall_5 :: RValue -> RID -> Int -> RValue -> RValue -> RValue -> RValue -> RValue -> IO RValue #

c_rb_funcall_with_block :: RValue -> RID -> Int -> Ptr RValue -> RValue -> IO RValue #

c_rb_gv_get :: CString -> IO RValue #

c_rb_intern :: CString -> IO RID #

rb_id2name :: RID -> IO CString #

c_rb_string_value_ptr :: Ptr RValue -> IO CString #

rb_cObject :: Ptr RValue #

c_rb_iv_set :: RValue -> CString -> RValue -> IO RValue #

c_rb_define_class :: CString -> RValue -> IO RValue #

c_rb_define_method :: RValue -> CString -> FunPtr a -> Int -> IO () #

c_rb_define_global_function :: CString -> FunPtr a -> Int -> IO () #

rb_const_get :: RValue -> RID -> IO RValue #

safeCallback :: FunPtr (RValue -> IO RValue) #

c_rb_protect :: FunPtr (RValue -> IO RValue) -> RValue -> Ptr Int -> IO RValue #

c_rb_string_value_cstr :: Ptr RValue -> IO CString #

rb_ary_new :: IO RValue #

rb_ary_push :: RValue -> RValue -> IO RValue #

rb_ary_entry :: RValue -> CLong -> IO RValue #

rb_hash_foreach :: RValue -> FunPtr a -> RValue -> IO () #

rb_big2str :: RValue -> CInt -> IO RValue #

rb_cstr_to_inum :: CString -> CInt -> CInt -> IO RValue #

newFloat :: Double -> IO RValue #

rb_hash_new :: IO RValue #

rb_hash_aset :: RValue -> RValue -> RValue -> IO RValue #

c_rb_define_module :: CString -> IO () #

arrayLength :: RValue -> IO CLong #

rubyType :: RValue -> IO CInt #

num2dbl :: RValue -> IO Double #

int2num :: CLong -> IO RValue #

num2long :: RValue -> IO CLong #

id2sym :: RID -> RValue #

sym2id :: RValue -> RID #

rbFalse :: RValue #

rbTrue :: RValue #

rbNil :: RValue #

rbUndef :: RValue #

rtype :: RValue -> IO RType #

rb_string_value_cstr :: RValue -> IO String #

rb_define_global_function #

Arguments

:: String	Name of the function
-> FunPtr a	Pointer to the function (created with something like `mkRegistered0`)
-> Int	Number of arguments the function accepts.
-> IO ()

Defines a global function that can be called from the Ruby world. This function must only accept RValues as arguments.

rb_define_method :: RValue -> String -> FunPtr a -> Int -> IO () #

rb_define_class :: String -> RValue -> IO RValue #

rb_str_new2 :: String -> IO RValue #

rb_define_module :: String -> IO () #

rb_iv_set #

Arguments

:: RValue	The object
-> String	The variable name (without the @)
-> RValue	The value to set
-> IO RValue	The value you just set

Sets an instance variable

rb_load_protect #

Arguments

:: String	Path to the script
-> Int	Just set this to 0, unless you know what you are doing
-> IO Int	Return code, equal to 0 if everything went right. `showErrorStack` can be used in case of errors.

Loads a ruby script (and executes it).

rb_funcall :: RValue -> RID -> [RValue] -> IO RValue #

rbMethodCall :: String -> String -> [RValue] -> IO RValue #

getClass :: String -> IO RValue #

rb_gv_get :: String -> IO RValue #

rb_intern :: String -> IO RID #

rb_string_value_ptr :: RValue -> IO String #