deprecated.h File Reference

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"

Go to the source code of this file.

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

Detailed Description

Defines RBIMPL_ATTR_DEPRECATED.

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

Macro Definition Documentation

RBIMPL_ATTR_DEPRECATED

#define RBIMPL_ATTR_DEPRECATED

(

msg

)

Wraps (or simulates) [[deprecated]].

Definition at line 64 of file deprecated.h.

Referenced by rb_yield_block().

RBIMPL_ATTR_DEPRECATED_EXT

#define RBIMPL_ATTR_DEPRECATED_EXT

(

msg

)

Value:

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.

RBIMPL_ATTR_DEPRECATED_INTERNAL

#define RBIMPL_ATTR_DEPRECATED_INTERNAL

(

ver

)

Value:

RBIMPL_ATTR_DEPRECATED(("since "#ver", also internal"))

Definition at line 77 of file deprecated.h.

RBIMPL_ATTR_DEPRECATED_INTERNAL_ONLY

#define RBIMPL_ATTR_DEPRECATED_INTERNAL_ONLY

(

)

Value:

RBIMPL_ATTR_DEPRECATED(("only for internal use"))

Definition at line 79 of file deprecated.h.

RBIMPL_ATTR_DEPRECATED_SINCE

#define RBIMPL_ATTR_DEPRECATED_SINCE

(

ver

)

Value:

RBIMPL_ATTR_DEPRECATED(("since " #ver))

Definition at line 75 of file deprecated.h.