kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

include/ruby/internal/value.h: add doxygen

Browse source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-01-11 18:39:29 +09:00
parent e2a441bdd4
commit 178ce74597
Notes: git 2021-09-10 20:01:54 +09:00 
Merged: https://github.com/ruby/ruby/pull/4815
1 changed files with 68 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
include/ruby/internal/value.h
View file

@ -24,7 +24,72 @@
#include "ruby/backward/2/long_long.h"
#include "ruby/backward/2/limits.h"
#if defined HAVE_UINTPTR_T && 0
#if defined(__DOXYGEN__)
/**
* Type that represents a Ruby object. It is an unsigned integer of some kind,
* depending on platforms.
*
* ```CXX
* VALUE value = rb_eval_string("ARGF.readlines.map.with_index");
* ```
*
* @warning ::VALUE is not a pointer.
* @warning ::VALUE can be wider than `long`.
*/
typedef uintptr_t VALUE;
/**
* Type that represents a Ruby identifier such as a variable name.
*
* ```CXX
* ID method = rb_intern("method");
* VALUE result = rb_funcall(obj, method, 0);
* ```
*
* @note ::rb_cSymbol is a Ruby-level data type for the same thing.
*/
typedef uintptr_t ID;
/**
* A signed integer type that has the same width with ::VALUE.
*
* @internal
*
* @shyouhei wonders: is it guaranteed that `uintptr_t` and `intptr_t` are the
* same width? As far as I read ISO/IEC 9899:2018 section 7.20.1.4 paragraph 1
* no such description is given... or defined elsewhere?
*/
typedef intptr_t SIGNED_VALUE;
/**
* Identical to `sizeof(VALUE)`, except it is a macro that can also be used
* inside of preprocessor directives such as `#if`. Handy on occasions.
*/
#define SIZEOF_VALUE SIZEOF_UINTPTR_T
/**
* @private
*
* A compile-time constant of type ::VALUE whose value is 0.
*/
#define RBIMPL_VALUE_NULL UINTPTR_C(0)
/**
* @private
*
* A compile-time constant of type ::VALUE whose value is 1.
*/
#define RBIMPL_VALUE_ONE UINTPTR_C(1)
/**
* @private
*
* Maximum possible value that a ::VALUE can take.
*/
#define RBIMPL_VALUE_FULL UINTPTR_MAX
#elif defined HAVE_UINTPTR_T && 0
typedef uintptr_t VALUE;
typedef uintptr_t ID;
# define SIGNED_VALUE intptr_t
@ -59,8 +124,10 @@ typedef unsigned LONG_LONG ID;
# error ---->> ruby requires sizeof(void*) == sizeof(long) or sizeof(LONG_LONG) to be compiled. <<----
#endif
/** @cond INTERNAL_MACRO */
RBIMPL_STATIC_ASSERT(sizeof_int, SIZEOF_INT == sizeof(int));
RBIMPL_STATIC_ASSERT(sizeof_long, SIZEOF_LONG == sizeof(long));
RBIMPL_STATIC_ASSERT(sizeof_long_long, SIZEOF_LONG_LONG == sizeof(LONG_LONG));
RBIMPL_STATIC_ASSERT(sizeof_voidp, SIZEOF_VOIDP == sizeof(void *));
/** @endcond */
#endif /* RBIMPL_VALUE_H */