Ruby  3.4.0dev (2024-12-06 revision 892c46283a5ea4179500d951c9d4866c0051f27b)
Macros | Functions
rclass.h File Reference

(892c46283a5ea4179500d951c9d4866c0051f27b)

Routines to manipulate struct RClass. More...

#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
#include "ruby/internal/cast.h"
Include dependency graph for rclass.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RCLASS(obj)   RBIMPL_CAST((struct RClass *)(obj))
 Convenient casting macro. More...
 
#define RMODULE   RCLASS
 Just another name of RCLASS. More...
 
#define RCLASS_SUPER   rb_class_get_superclass
 Just another name of rb_class_get_superclass. More...
 

Functions

VALUE rb_class_get_superclass (VALUE klass)
 Returns the superclass of a class. More...
 

Detailed Description

Routines to manipulate struct RClass.

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.
The struct RClass itself is opaque.

Definition in file rclass.h.

Macro Definition Documentation

◆ RCLASS

#define RCLASS (   obj)    RBIMPL_CAST((struct RClass *)(obj))

Convenient casting macro.

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

Definition at line 38 of file rclass.h.

◆ RCLASS_SUPER

#define RCLASS_SUPER   rb_class_get_superclass

Just another name of rb_class_get_superclass.

Definition at line 44 of file rclass.h.

◆ RMODULE

#define RMODULE   RCLASS

Just another name of RCLASS.

Definition at line 41 of file rclass.h.