Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)
Macros
assume.h File Reference

Defines ASSUME / RB_LIKELY / UNREACHABLE. More...

#include "ruby/internal/config.h"
#include "ruby/internal/assume.h"
#include "ruby/internal/has/builtin.h"

Go to the source code of this file.

Macros

#define ASSUME   RBIMPL_ASSUME
 
#define UNREACHABLE   RBIMPL_UNREACHABLE()
 
#define UNREACHABLE_RETURN   RBIMPL_UNREACHABLE_RETURN
 
#define RB_LIKELY(x)   (x)
 
#define RB_UNLIKELY(x)   (x)
 

Detailed Description

Defines ASSUME / RB_LIKELY / UNREACHABLE.

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

Macro Definition Documentation

◆ ASSUME

#define ASSUME   RBIMPL_ASSUME

Definition at line 29 of file assume.h.

◆ RB_LIKELY

#define RB_LIKELY (   x)    (x)

Definition at line 39 of file assume.h.

◆ RB_UNLIKELY

#define RB_UNLIKELY (   x)    (x)

Definition at line 40 of file assume.h.

◆ UNREACHABLE

#define UNREACHABLE   RBIMPL_UNREACHABLE()

Definition at line 30 of file assume.h.

◆ UNREACHABLE_RETURN

#define UNREACHABLE_RETURN   RBIMPL_UNREACHABLE_RETURN

Definition at line 31 of file assume.h.