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

Defines RBIMPL_ASSUME / RBIMPL_UNREACHABLE. More...

#include "ruby/internal/config.h"
#include "ruby/internal/cast.h"
#include "ruby/internal/compiler_since.h"
#include "ruby/internal/has/builtin.h"
#include "ruby/internal/warning_push.h"

Go to the source code of this file.

Macros

#define RBIMPL_UNREACHABLE_RETURN(_)   return (_)
 Wraps (or simulates) __builtin_unreachable. More...
 
#define RBIMPL_ASSUME(_)   RBIMPL_CAST((void)(_))
 Wraps (or simulates) __builtin_unreachable. More...
 
#define RBIMPL_UNREACHABLE()   RBIMPL_ASSUME(0)
 

Detailed Description

Defines RBIMPL_ASSUME / RBIMPL_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.

These macros must be defined at once because:

Definition in file assume.h.

Macro Definition Documentation

◆ RBIMPL_ASSUME

#define RBIMPL_ASSUME (   _)    RBIMPL_CAST((void)(_))

Wraps (or simulates) __builtin_unreachable.

Wraps (or simulates) __assume.

Definition at line 79 of file assume.h.

◆ RBIMPL_UNREACHABLE

#define RBIMPL_UNREACHABLE ( )    RBIMPL_ASSUME(0)

Definition at line 87 of file assume.h.

◆ RBIMPL_UNREACHABLE_RETURN

#define RBIMPL_UNREACHABLE_RETURN (   _)    return (_)

Wraps (or simulates) __builtin_unreachable.

Definition at line 51 of file assume.h.