Ruby  3.4.0dev (2024-11-22 revision 80cfa57234255667a86d46096093099349a7262a)
Data Structures | Macros | Functions
robject.h File Reference

(80cfa57234255667a86d46096093099349a7262a)

Defines struct RObject. More...

#include "ruby/internal/config.h"
#include "ruby/internal/attr/artificial.h"
#include "ruby/internal/attr/deprecated.h"
#include "ruby/internal/attr/pure.h"
#include "ruby/internal/cast.h"
#include "ruby/internal/fl_type.h"
#include "ruby/internal/value.h"
#include "ruby/internal/value_type.h"
Include dependency graph for robject.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  RObject
 Ruby's ordinal objects. More...
 

Macros

#define ROBJECT(obj)   RBIMPL_CAST((struct RObject *)(obj))
 Convenient casting macro. More...
 

Functions

static VALUEROBJECT_IVPTR (VALUE obj)
 Queries the instance variables. More...
 

Detailed Description

Defines struct RObject.

Author
Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org
Warning
Symbols prefixed with either RBIMPL or rbimpl are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.
Note
To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance __VA_ARGS__ is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Definition in file robject.h.

Macro Definition Documentation

◆ ROBJECT

#define ROBJECT (   obj)    RBIMPL_CAST((struct RObject *)(obj))

Convenient casting macro.

Parameters
objAn object, which is in fact an RObject.
Returns
The passed object casted to RObject.

Definition at line 43 of file robject.h.

Function Documentation

◆ ROBJECT_IVPTR()

static VALUE* ROBJECT_IVPTR ( VALUE  obj)
inlinestatic

Queries the instance variables.

Parameters
[in]objObject in question.
Returns
Its instance variables, in C array.
Precondition
obj must be an instance of RObject.

Definition at line 136 of file robject.h.