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

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

Data Structures | Macros | Enumerations | Functions
rbasic.h File Reference

Defines struct RBasic. More...

`#include "ruby/internal/attr/artificial.h"`
`#include "ruby/internal/attr/constexpr.h"`
`#include "ruby/internal/attr/forceinline.h"`
`#include "ruby/internal/attr/noalias.h"`
`#include "ruby/internal/attr/pure.h"`
`#include "ruby/internal/cast.h"`
`#include "ruby/internal/dllexport.h"`
`#include "ruby/internal/special_consts.h"`
`#include "ruby/internal/value.h"`
`#include "ruby/assert.h"`

Go to the source code of this file.

## Data Structures
struct | RBasic

## Macros
#define | RBASIC(obj) RBIMPL_CAST((struct RBasic *)(obj))
#define | RBASIC_CLASS RBASIC_CLASS
#define | RVALUE_EMBED_LEN_MAX RVALUE_EMBED_LEN_MAX

## Enumerations
enum | ruby_rvalue_flags { RVALUE_EMBED_LEN_MAX = 3 }

## Functions
VALUE | rb_obj_hide (VALUE obj)
| Make the object invisible from Ruby code. More...
VALUE | rb_obj_reveal (VALUE obj, VALUE klass)
| Make a hidden object visible again. More...

## Detailed Description

Defines struct RBasic.

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

## Macro Definition Documentation

## ◆ RBASIC

#define RBASIC | ( |  | obj | ) | RBIMPL_CAST((struct RBasic *)(obj))

Definition at line 34 of file rbasic.h.

## ◆ RBASIC_CLASS

#define RBASIC_CLASS RBASIC_CLASS

Definition at line 35 of file rbasic.h.

## ◆ RVALUE_EMBED_LEN_MAX

#define RVALUE_EMBED_LEN_MAX RVALUE_EMBED_LEN_MAX

Definition at line 36 of file rbasic.h.

## Enumeration Type Documentation

## ◆ ruby_rvalue_flags

enum ruby_rvalue_flags

Enumerator
RVALUE_EMBED_LEN_MAX |

Definition at line 43 of file rbasic.h.