Ruby: include/ruby/internal/core/rclass.h File Reference

Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)

Macros | Enumerations | Functions
rclass.h File Reference

Routines to manipulate struct RClass. More...

`#include "ruby/internal/dllexport.h"`
`#include "ruby/internal/value.h"`
`#include "ruby/internal/cast.h"`

Go to the source code of this file.

## Macros
#define | RMODULE_IS_OVERLAID RMODULE_IS_OVERLAID
#define | RMODULE_IS_REFINEMENT RMODULE_IS_REFINEMENT
#define | RMODULE_INCLUDED_INTO_REFINEMENT RMODULE_INCLUDED_INTO_REFINEMENT
#define | RCLASS(obj) RBIMPL_CAST((struct RClass *)(obj))
#define | RMODULE RCLASS
#define | RCLASS_SUPER rb_class_get_superclass

## Enumerations
enum | ruby_rmodule_flags { RMODULE_IS_OVERLAID = RUBY_FL_USER2 , RMODULE_IS_REFINEMENT = RUBY_FL_USER3 , RMODULE_INCLUDED_INTO_REFINEMENT = RUBY_FL_USER4 }

## Functions
VALUE | rb_class_get_superclass (VALUE)
| Returns the superclass of klass The return value might be an iclass of a module, unlike rb_class_superclass. 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

Copyright
  This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.

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 rclass.h.

## Macro Definition Documentation

## ◆ RCLASS

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

Definition at line 31 of file rclass.h.

## ◆ RCLASS_SUPER

#define RCLASS_SUPER rb_class_get_superclass

Definition at line 33 of file rclass.h.

## ◆ RMODULE

#define RMODULE RCLASS

Definition at line 32 of file rclass.h.

## ◆ RMODULE_INCLUDED_INTO_REFINEMENT

#define RMODULE_INCLUDED_INTO_REFINEMENT RMODULE_INCLUDED_INTO_REFINEMENT

Definition at line 29 of file rclass.h.

## ◆ RMODULE_IS_OVERLAID

#define RMODULE_IS_OVERLAID RMODULE_IS_OVERLAID

Definition at line 27 of file rclass.h.

## ◆ RMODULE_IS_REFINEMENT

#define RMODULE_IS_REFINEMENT RMODULE_IS_REFINEMENT

Definition at line 28 of file rclass.h.

## Enumeration Type Documentation

## ◆ ruby_rmodule_flags

enum ruby_rmodule_flags

Enumerator
RMODULE_IS_OVERLAID |
RMODULE_IS_REFINEMENT |
RMODULE_INCLUDED_INTO_REFINEMENT |

Definition at line 35 of file rclass.h.