Rice  1.5.2
 All Classes Files Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Rice::Builtin_Object< T, Builtin_Type > Class Template Reference

A smartpointer-like wrapper for Ruby builtin objects. More...

#include <Builtin_Object_defn.hpp>

Inheritance diagram for Rice::Builtin_Object< T, Builtin_Type >:
Rice::Object

Public Member Functions

 Builtin_Object (Object value)
 Wrap an already allocated Ruby object. More...
 
 Builtin_Object (Builtin_Object const &other)
 Make a copy of a Builtin_Object. More...
 
T & operator* () const
 Return a reference to obj_.
 
T * operator-> () const
 Return a pointer to obj_.
 
T * get () const
 Return a pointer to obj_.
 
void swap (Builtin_Object< T, Builtin_Type > &ref)
 Swap with another builtin object of the same type. More...
 
- Public Member Functions inherited from Rice::Object
 Object (VALUE value=Qnil)
 Encapsulate an existing ruby object.
 
 Object (Object const &other)
 Copy constructor.
 
virtual ~Object ()
 Destructor.
 
bool test () const
 
 operator bool () const
 
bool is_nil () const
 Returns true if the object is nil, false otherwise.
 
 operator VALUE () const
 Implicit conversion to VALUE.
 
VALUE const volatile & value () const
 Explicitly get the encapsulated VALUE.
 
Class class_of () const
 Get the class of an object. More...
 
int compare (Object const &other) const
 Compare this object to another object. More...
 
String to_s () const
 Return a string representation of an object. More...
 
String inspect () const
 Inspect the object. More...
 
void freeze ()
 Freeze the object.
 
bool is_frozen () const
 Determine if the object is frozen. More...
 
void swap (Object &other)
 Swap with another Object.
 
Object instance_eval (String const &s)
 Evaluate the given string in the context of the object. More...
 
int rb_type () const
 Return the type of the underlying C object. More...
 
bool is_a (Object klass) const
 Determine whether the object is an instance of a class/module. More...
 
bool respond_to (Identifier id) const
 Determine if the objects responds to a method. More...
 
bool is_instance_of (Object klass) const
 Determine whether class is the object's class. More...
 
template<typename T >
void iv_set (Identifier name, T const &value)
 Set an instance variable. More...
 
Object iv_get (Identifier name) const
 Get the value of an instance variable. More...
 
Object attr_get (Identifier name) const
 Get the value of an instance variable, but don't warn if it is. More...
 
template<typename Retval_T >
Retval_T call (Identifier id, T1 arg1, T2 arg2,...) const
 Call the Ruby method specified by 'id' on object 'obj'. More...
 
Object call (Identifier id, T1 arg1, T2 arg2,...) const
 Version of call which defaults to Object return type.
 
Object vcall (Identifier id, Array args)
 Vectorized call. More...
 
void mark () const
 Mark the object with the garbage collector.
 

Additional Inherited Members

- Protected Member Functions inherited from Rice::Object
void set_value (VALUE v)
 Set the encapsulated value.
 

Detailed Description

template<typename T, int Builtin_Type>
class Rice::Builtin_Object< T, Builtin_Type >

A smartpointer-like wrapper for Ruby builtin objects.

A builtin object is one of Ruby's internal types, e.g. RArray or RString. Every builtin type structure has a corresponding integer type number (e.g T_ARRAY for RArray or T_STRING for RString). This class is a wrapper for those types of objects, primarily useful as a base class for other wrapper classes like Array and Hash.

Constructor & Destructor Documentation

template<typename T, int Builtin_Type>
Rice::Builtin_Object< T, Builtin_Type >::Builtin_Object ( Object  value)

Wrap an already allocated Ruby object.

Checks to see if the object is an object of type Builtin_Type; a C++ exception is thrown if this is not the case.

Parameters
valuethe object to be wrapped.
template<typename T, int Builtin_Type>
Rice::Builtin_Object< T, Builtin_Type >::Builtin_Object ( Builtin_Object< T, Builtin_Type > const &  other)

Make a copy of a Builtin_Object.

Parameters
otherthe Builtin_Object to be copied.

Member Function Documentation

template<typename T, int Builtin_Type>
void Rice::Builtin_Object< T, Builtin_Type >::swap ( Builtin_Object< T, Builtin_Type > &  ref)

Swap with another builtin object of the same type.

Parameters
refthe object with which to swap.

The documentation for this class was generated from the following file: