Ruby  3.4.0dev (2024-11-05 revision 348a53415339076afc4a02fcd09f3ae36e9c4c61)
Macros
deprecated.h File Reference

(348a53415339076afc4a02fcd09f3ae36e9c4c61)

Defines RBIMPL_ATTR_DEPRECATED. More...

#include "ruby/internal/compiler_since.h"
#include "ruby/internal/has/attribute.h"
#include "ruby/internal/has/c_attribute.h"
#include "ruby/internal/has/cpp_attribute.h"
#include "ruby/internal/has/declspec_attribute.h"
#include "ruby/internal/has/extension.h"
Include dependency graph for deprecated.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RBIMPL_ATTR_DEPRECATED(msg)   __attribute__((__deprecated__ msg))
 Wraps (or simulates) [[deprecated]] More...
 
#define RBIMPL_ATTR_DEPRECATED_EXT(msg)   RBIMPL_ATTR_DEPRECATED(msg)
 This is when a function is used internally (for backwards compatibility etc.), but extension libraries must consider it deprecated. More...
 

Detailed Description

Defines RBIMPL_ATTR_DEPRECATED.

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

Macro Definition Documentation

◆ RBIMPL_ATTR_DEPRECATED

#define RBIMPL_ATTR_DEPRECATED (   msg)    __attribute__((__deprecated__ msg))

Wraps (or simulates) [[deprecated]]

Definition at line 36 of file deprecated.h.

◆ RBIMPL_ATTR_DEPRECATED_EXT

#define RBIMPL_ATTR_DEPRECATED_EXT (   msg)    RBIMPL_ATTR_DEPRECATED(msg)

This is when a function is used internally (for backwards compatibility etc.), but extension libraries must consider it deprecated.

Definition at line 72 of file deprecated.h.