Rice  1.5.2
 All Classes Files Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Rice::Module Class Reference

A helper for defining a Module and its methods. More...

#include <Module_defn.hpp>

Inheritance diagram for Rice::Module:
Rice::Module_impl< Module_base, Module > Rice::Module_base Rice::Object Rice::Module_impl< Module, Class > Rice::Class Rice::Module_impl< Class, Data_Type_Base > Rice::Module_impl< Class, Struct > Rice::Data_Type_Base Rice::Struct Rice::Module_impl< Data_Type_Base, Data_Type< T > > Rice::Data_Type< T >

Public Member Functions

 Module ()
 Default construct a Module and initialize it to rb_cObject.
 
 Module (VALUE v)
 Construct a Module from an existing Module object.
 
String name () const
 Return the name of the module.
 
void swap (Module &other)
 Swap with another Module.
 
Array ancestors () const
 Return an array containing the Module's ancestors. More...
 
Class singleton_class () const
 Return the module's singleton class. More...
 
- Public Member Functions inherited from Rice::Module_impl< Module_base, Module >
 Module_impl (T const &arg)
 
Moduleadd_handler (Functor_T functor)
 Define an exception handler. More...
 
Moduledefine_method (Identifier name, Func_T func, Arguments *arguments=0)
 Define an instance method. More...
 
Moduledefine_method (Identifier name, Func_T func, Arg const &arg)
 
Moduledefine_singleton_method (Identifier name, Func_T func, Arguments *arguments=0)
 Define a singleton method. More...
 
Moduledefine_singleton_method (Identifier name, Func_T func, Arg const &arg)
 
Moduledefine_module_function (Identifier name, Func_T func, Arguments *arguments=0)
 Define a module function. More...
 
Moduledefine_module_function (Identifier name, Func_T func, Arg const &arg)
 
Moduledefine_iterator (Iterator_T(T::*begin)(), Iterator_T(T::*end)(), Identifier name="each")
 Define an iterator. More...
 
Moduleinclude_module (Module const &inc)
 Include a module. More...
 
Moduleconst_set (Identifier name, Object value)
 Set a constant. More...
 
Object const_get (Identifier name) const
 Get a constant. More...
 
bool const_defined (Identifier name) const
 Determine whether a constant is defined. More...
 
void remove_const (Identifier name)
 Remove a constant. More...
 
Module define_module (char const *name)
 Define a module under this module. More...
 
Class define_class (char const *name, Object superclass=rb_cObject)
 Define a class under this module. More...
 
Data_Type< T > define_class (char const *name)
 Define a new data class under this module. More...
 
Data_Type< T > define_class (char const *name)
 Define a new data class under this module. More...
 
- Public Member Functions inherited from Rice::Module_base
 Module_base (VALUE v=rb_cObject)
 
 Module_base (Module_base const &other)
 
Module_baseoperator= (Module_base const &other)
 
void swap (Module_base &other)
 
- 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::Module_base
template<typename Exception_T , typename Functor_T >
void add_handler (Functor_T functor)
 
Object handler () const
 
- Protected Member Functions inherited from Rice::Object
void set_value (VALUE v)
 Set the encapsulated value.
 

Detailed Description

A helper for defining a Module and its methods.

This class provides a C++-style interface to ruby's Module class and for defining methods on that module.

Many of the methods are defined in Module_impl.hpp so that they can return a reference to the most derived type.

Examples:
map/map.cpp.

Member Function Documentation

Array Rice::Module::ancestors ( ) const

Return an array containing the Module's ancestors.

You will need to include Array.hpp to use this function.

Class Rice::Module::singleton_class ( ) const

Return the module's singleton class.

You will need to include Class.hpp to use this function.


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