#ifndef RBIMPL_ARITHMETIC_INTPTR_T_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_ARITHMETIC_INTPTR_T_H /** * @file * @author Ruby developers * @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. * @brief Arithmetic conversion between C's `intptr_t` and Ruby's. */ #include "ruby/internal/config.h" #ifdef HAVE_STDINT_H # include #endif #include "ruby/internal/value.h" #include "ruby/internal/dllexport.h" #define rb_int_new rb_int2inum /**< @alias{rb_int2inum} */ #define rb_uint_new rb_uint2inum /**< @alias{rb_uint2inum} */ RBIMPL_SYMBOL_EXPORT_BEGIN() /** * Converts a C's `intptr_t` into an instance of ::rb_cInteger. * * @param[in] i Arbitrary `intptr_t` value. * @return An instance of ::rb_cInteger. * @note This function always allocates Bignums, even if the given number * is small enough to fit into a Fixnum. */ VALUE rb_int2big(intptr_t i); /** * Converts a C's `intptr_t` into an instance of ::rb_cInteger. * * @param[in] i Arbitrary `intptr_t` value. * @return An instance of ::rb_cInteger. */ VALUE rb_int2inum(intptr_t i); /** * Converts a C's `intptr_t` into an instance of ::rb_cInteger. * * @param[in] i Arbitrary `intptr_t` value. * @return An instance of ::rb_cInteger. * @note This function always allocates Bignums, even if the given number * is small enough to fit into a Fixnum. */ VALUE rb_uint2big(uintptr_t i); /** * Converts a C's `uintptr_t` into an instance of ::rb_cInteger. * * @param[in] i Arbitrary `uintptr_t` value. * @return An instance of ::rb_cInteger. */ VALUE rb_uint2inum(uintptr_t i); RBIMPL_SYMBOL_EXPORT_END() #endif /* RBIMPL_ARITHMETIC_INTPTR_T_H */