internal.h File Reference

Go to the source code of this file.

Defines

#define RUBY_INTERNAL_H   1
#define VALGRIND_MAKE_MEM_DEFINED(p, n)   0
#define VALGRIND_MAKE_MEM_UNDEFINED(p, n)   0
#define numberof(array)   ((int)(sizeof(array) / sizeof((array)[0])))
#define STATIC_ASSERT(name, expr)   typedef int static_assert_##name##_check[1 - 2*!(expr)]
#define GCC_VERSION_SINCE(major, minor, patchlevel)
#define SIGNED_INTEGER_TYPE_P(int_type)   (0 > ((int_type)0)-1)
#define SIGNED_INTEGER_MAX(sint_type)
#define SIGNED_INTEGER_MIN(sint_type)   (-SIGNED_INTEGER_MAX(sint_type)-1)
#define UNSIGNED_INTEGER_MAX(uint_type)   (~(uint_type)0)
#define TIMET_MAX_PLUS_ONE   (2*(double)(TIMET_MAX/2+1))
#define MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, min, max)
#define MUL_OVERFLOW_FIXNUM_P(a, b)   MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, FIXNUM_MIN, FIXNUM_MAX)
#define MUL_OVERFLOW_LONG_P(a, b)   MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, LONG_MIN, LONG_MAX)
#define MUL_OVERFLOW_INT_P(a, b)   MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, INT_MIN, INT_MAX)
#define swap16(x)   ((uint16_t)((((x)&0xFF)<<8) | (((x)>>8)&0xFF)))
#define swap32(x)
#define bit_length(x)
#define SERIALT2NUM   ULONG2NUM
#define RCLASS_EXT(c)   (RCLASS(c)->ptr)
#define RCLASS_IV_TBL(c)   (RCLASS_EXT(c)->iv_tbl)
#define RCLASS_CONST_TBL(c)   (RCLASS_EXT(c)->const_tbl)
#define RCLASS_M_TBL_WRAPPER(c)   (RCLASS(c)->m_tbl_wrapper)
#define RCLASS_M_TBL(c)   (RCLASS_M_TBL_WRAPPER(c) ? RCLASS_M_TBL_WRAPPER(c)->tbl : 0)
#define RCLASS_IV_INDEX_TBL(c)   (RCLASS_EXT(c)->iv_index_tbl)
#define RCLASS_ORIGIN(c)   (RCLASS_EXT(c)->origin)
#define RCLASS_REFINED_CLASS(c)   (RCLASS_EXT(c)->refined_class)
#define RCLASS_SERIAL(c)   (RCLASS_EXT(c)->class_serial)
#define rb_ascii8bit_encindex()   ENCINDEX_ASCII
#define rb_utf8_encindex()   ENCINDEX_UTF_8
#define rb_usascii_encindex()   ENCINDEX_US_ASCII
#define rb_sys_fail_path(path)   rb_sys_fail_str(path)
#define rb_syserr_fail_path(err, path)   rb_syserr_fail_str((err), (path))
#define SIZED_REALLOC_N(var, type, n, old_n)   ((var)=(type*)ruby_sized_xrealloc((char*)(var), (n) * sizeof(type), (old_n) * sizeof(type)))
#define RHASH_TBL_RAW(h)   rb_hash_tbl_raw(h)
#define HASH_DELETED   FL_USER1
#define HASH_PROC_DEFAULT   FL_USER2
#define RUBY_BIT_ROTL(v, n)   (((v) << (n)) | ((v) >> ((sizeof(v) * 8) - n)))
#define RUBY_BIT_ROTR(v, n)   (((v) >> (n)) | ((v) << ((sizeof(v) * 8) - n)))
#define rb_float_value(v)   rb_float_value_inline(v)
#define rb_float_new(d)   rb_float_new_inline(d)
#define RBASIC_CLEAR_CLASS(obj)   (((struct RBasicRaw *)((VALUE)(obj)))->klass = 0)
#define RBASIC_SET_CLASS_RAW(obj, cls)   (((struct RBasicRaw *)((VALUE)(obj)))->klass = (cls))
#define RBASIC_SET_CLASS(obj, cls)
#define RB_MAX_GROUPS   (65536)
#define ARGVSTR2ARGC(argv_str)   (RSTRING_LEN(argv_str) / sizeof(char *) - 2)
#define ARGVSTR2ARGV(argv_str)   ((char **)RSTRING_PTR(argv_str) + 1)
#define QUOTE(str)   rb_str_quote_unprintable(str)
#define QUOTE_ID(id)   rb_id_quote_unprintable(id)
#define STR_NOEMBED   FL_USER1
#define STR_SHARED   FL_USER2
#define STR_ASSOC   FL_USER3
#define STR_SHARED_P(s)   FL_ALL_RAW((s), STR_NOEMBED|ELTS_SHARED)
#define STR_ASSOC_P(s)   FL_ALL_RAW((s), STR_NOEMBED|STR_ASSOC)
#define STR_NOCAPA   (STR_NOEMBED|ELTS_SHARED|STR_ASSOC)
#define STR_NOCAPA_P(s)   (FL_TEST_RAW((s),STR_NOEMBED) && FL_ANY_RAW((s),ELTS_SHARED|STR_ASSOC))
#define STR_EMBED_P(str)   (!FL_TEST_RAW((str), STR_NOEMBED))
#define is_ascii_string(str)   (rb_enc_str_coderange(str) == ENC_CODERANGE_7BIT)
#define is_broken_string(str)   (rb_enc_str_coderange(str) == ENC_CODERANGE_BROKEN)
#define RB_OBJ_GC_FLAGS_MAX   5

Define Documentation

#define ARGVSTR2ARGC ( argv_str   )     (RSTRING_LEN(argv_str) / sizeof(char *) - 2)

Referenced by rb_spawn_process().

#define ARGVSTR2ARGV ( argv_str   )     ((char **)RSTRING_PTR(argv_str) + 1)

Referenced by pipe_open(), proc_exec_cmd(), and rb_spawn_process().

#define bit_length ( x   ) 
Value:
(sizeof(x) <= SIZEOF_INT ? SIZEOF_INT * CHAR_BIT - nlz_int((unsigned int)(x)) : \
     SIZEOF_LONG * CHAR_BIT - nlz_long((unsigned long)(x)))

Referenced by bary_mul_precheck(), big_shift2(), bigdivrem_single1(), rb_big_lshift(), rb_big_rshift(), rb_cstr_to_inum(), rb_fix_bit_length(), and rb_str2big_poweroftwo().

#define GCC_VERSION_SINCE ( major,
minor,
patchlevel   ) 
Value:
(defined(__GNUC__) && !defined(__INTEL_COMPILER) && \
   ((__GNUC__ > (major)) ||  \
    (__GNUC__ == (major) && __GNUC_MINOR__ > (minor)) || \
    (__GNUC__ == (major) && __GNUC_MINOR__ == (minor) && __GNUC_PATCHLEVEL__ >= (patchlevel))))
#define HASH_DELETED   FL_USER1

Referenced by hash_foreach_ensure(), hash_foreach_iter(), and rb_hash_delete_key().

#define HASH_PROC_DEFAULT   FL_USER2

Referenced by dump_object(), hash_default_value(), hash_equal(), rb_hash_default(), rb_hash_default_proc(), rb_hash_dup_empty(), rb_hash_initialize(), rb_hash_initialize_copy(), rb_hash_reject(), rb_hash_replace(), rb_hash_set_default(), rb_hash_set_default_proc(), rb_hash_to_h(), and w_object().

#define is_ascii_string ( str   )     (rb_enc_str_coderange(str) == ENC_CODERANGE_7BIT)

Referenced by dump_object(), rb_str_conv_enc_opts(), rb_str_split_m(), and rb_str_upto().

#define is_broken_string ( str   )     (rb_enc_str_coderange(str) == ENC_CODERANGE_BROKEN)

Referenced by dump_object(), rb_str_chomp_bang(), rb_str_count(), rb_str_index(), rb_str_rindex(), and rb_str_split_m().

#define MUL_OVERFLOW_FIXNUM_P ( a,
b   )     MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, FIXNUM_MIN, FIXNUM_MAX)

Referenced by fix_mul(), and int_pow().

#define MUL_OVERFLOW_INT_P ( a,
b   )     MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, INT_MIN, INT_MAX)
#define MUL_OVERFLOW_LONG_P ( a,
b   )     MUL_OVERFLOW_SIGNED_INTEGER_P(a, b, LONG_MIN, LONG_MAX)

Referenced by f_imul(), and rb_ary_product().

#define MUL_OVERFLOW_SIGNED_INTEGER_P ( a,
b,
min,
max   ) 
Value:
( \
    (a) == 0 ? 0 : \
    (a) == -1 ? (b) < -(max) : \
    (a) > 0 ? \
      ((b) > 0 ? (max) / (a) < (b) : (min) / (a) > (b)) : \
      ((b) > 0 ? (min) / (a) < (b) : (max) / (a) > (b)))
#define numberof ( array   )     ((int)(sizeof(array) / sizeof((array)[0])))
#define QUOTE ( str   )     rb_str_quote_unprintable(str)

Referenced by check_setter_id(), new_struct(), rb_f_untrace_var(), rb_method_name_error(), rb_mod_const_defined(), rb_mod_const_get(), rb_mod_cvar_defined(), rb_mod_cvar_get(), rb_mod_remove_const(), rb_mod_remove_cvar(), rb_obj_ivar_defined(), rb_obj_ivar_get(), rb_obj_remove_instance_variable(), rb_obj_singleton_method(), rb_path_to_class(), rb_print_undef_str(), rb_struct_aref(), rb_struct_aset(), ruby__sfvextra(), and set_const_visibility().

#define QUOTE_ID ( id   )     rb_id_quote_unprintable(id)

Referenced by check_setter_id(), not_a_member(), rb_autoload(), rb_check_attr_id(), rb_const_get_0(), rb_const_remove(), rb_const_set(), rb_cvar_get(), rb_cvar_set(), rb_f_untrace_var(), rb_ivar_get(), rb_mod_const_defined(), rb_mod_const_get(), rb_mod_cvar_defined(), rb_mod_cvar_get(), rb_mod_remove_const(), rb_mod_remove_cvar(), rb_obj_ivar_defined(), rb_obj_ivar_get(), rb_obj_remove_instance_variable(), rb_obj_respond_to(), rb_obj_singleton_method(), rb_print_undef(), rb_undef(), readonly_setter(), set_const_visibility(), set_method_visibility(), undef_getter(), and uninitialized_constant().

#define rb_ascii8bit_encindex ( void   )     ENCINDEX_ASCII

Referenced by code_page(), pack_unpack(), parser_regx_options(), rb_ascii8bit_encindex(), and rb_char_to_option_kcode().

#define rb_float_new ( d   )     rb_float_new_inline(d)

Referenced by BigDecimal_to_f(), callback(), generic_to_value(), JSON_parse_float(), ole_variant2val(), rand_random(), rand_range(), rb_float_new(), and tkstr_to_float().

#define rb_float_value ( v   )     rb_float_value_inline(v)

Referenced by rb_any_hash(), and rb_float_value().

#define RB_MAX_GROUPS   (65536)

Referenced by rb_group_member().

#define RB_OBJ_GC_FLAGS_MAX   5

Referenced by dump_object().

#define rb_sys_fail_path ( path   )     rb_sys_fail_str(path)

Referenced by chmod_internal(), chown_internal(), dir_chdir(), dir_initialize(), dir_s_mkdir(), dir_s_rmdir(), fptr_finalize(), io_fillbuf(), io_fread(), io_getpartial(), io_reopen(), io_write(), io_write_nonblock(), pipe_open(), rb_f_test(), rb_file_atime(), rb_file_chmod(), rb_file_chown(), rb_file_ctime(), rb_file_flock(), rb_file_lstat(), rb_file_mtime(), rb_file_s_atime(), rb_file_s_ctime(), rb_file_s_ftype(), rb_file_s_lstat(), rb_file_s_mtime(), rb_file_s_size(), rb_file_s_stat(), rb_file_size(), rb_io_close_read(), rb_io_close_write(), rb_io_reopen(), rb_io_rewind(), rb_io_seek(), rb_io_set_nonblock(), rb_io_set_pos(), rb_io_stat(), rb_io_sysread(), rb_io_sysseek(), rb_io_syswrite(), rb_io_tell(), rb_ioctl(), rb_stat_init(), rb_sysopen(), realpath_rec(), swallow(), sys_fail2(), and unlink_internal().

#define rb_syserr_fail_path ( err,
path   )     rb_syserr_fail_str((err), (path))

Referenced by rb_io_reopen().

#define rb_usascii_encindex ( void   )     ENCINDEX_US_ASCII

Referenced by code_page(), id2encidx(), rb_find_file_ext_safe(), rb_find_file_safe(), rb_usascii_encindex(), rb_usascii_str_new(), rb_usascii_str_new_cstr(), w_encoding(), and w_symbol().

#define rb_utf8_encindex ( void   )     ENCINDEX_UTF_8

Referenced by id2encidx(), io_strip_bom(), parse(), rb_char_to_option_kcode(), rb_str_scrub(), rb_utf8_encindex(), and w_encoding().

#define RBASIC_CLEAR_CLASS ( obj   )     (((struct RBasicRaw *)((VALUE)(obj)))->klass = 0)

Referenced by add_modules(), ary_tmp_hash_new(), coverage(), define_final0(), enum_cycle(), enum_sort_by(), env_reject_bang(), env_select_bang(), hidden_identity_hash_new(), hide_obj(), Init_Encoding(), Init_VM(), rb_apply(), rb_ary_combination(), rb_ary_permutation(), rb_ary_product(), rb_ary_repeated_combination(), rb_ary_repeated_permutation(), rb_ary_sample(), rb_ary_sort_bang(), rb_enc_vsprintf(), rb_file_join(), rb_find_file_ext_safe(), rb_io_s_popen(), rb_iseq_add_mark_object(), rb_obj_hide(), rb_str_associate(), rb_str_conv_enc_opts(), rb_str_vcatf(), run_final(), and thread_create_core().

#define RBASIC_SET_CLASS ( obj,
cls   ) 
Value:
do { \
    VALUE _obj_ = (obj); \
    RB_OBJ_WRITE(_obj_, &((struct RBasicRaw *)(_obj_))->klass, cls); \
} while (0)

Referenced by copy_path_class(), encoded_dup(), flatten(), fstring_set_class_i(), Init_class_hierarchy(), io_reopen(), make_singleton_class(), proc_new(), r_object0(), rb_ary_slice_bang(), rb_ary_uniq(), rb_include_class_new(), rb_io_s_popen(), rb_mod_init_copy(), rb_module_s_alloc(), rb_obj_clone(), rb_obj_reveal(), rb_obj_setup(), rb_singleton_class_clone_and_attach(), str_gsub(), and syserr_initialize().

#define RBASIC_SET_CLASS_RAW ( obj,
cls   )     (((struct RBasicRaw *)((VALUE)(obj)))->klass = (cls))

Referenced by enum_sort_by(), newobj_of(), rb_ary_combination(), rb_ary_permutation(), rb_ary_repeated_combination(), rb_ary_repeated_permutation(), rb_ary_sample(), rb_ary_sort_bang(), rb_enc_vsprintf(), rb_file_join(), rb_id2str(), rb_str_vcatf(), require_libraries(), setup_fake_str(), and token_info_push().

#define RCLASS_CONST_TBL ( c   )     (RCLASS_EXT(c)->const_tbl)

Referenced by autoload_defined_p(), autoload_delete(), class_alloc(), fc_i(), find_class_path(), init_copy(), obj_free(), rb_autoload(), rb_const_defined_0(), rb_const_get_0(), rb_const_remove(), rb_const_set(), rb_include_class_new(), rb_local_constants(), rb_mod_const_at(), rb_mod_init_copy(), rb_singleton_class_clone_and_attach(), set_const_visibility(), and vm_get_ev_const().

#define RCLASS_EXT ( c   )     (RCLASS(c)->ptr)

Referenced by class_alloc(), obj_free(), obj_memsize_of(), rb_class_foreach_subclass(), rb_class_remove_from_module_subclasses(), rb_class_remove_from_super_subclasses(), rb_class_subclass_add(), rb_define_alloc_func(), rb_get_alloc_func(), rb_method_entry(), rb_method_entry_get_without_cache(), rb_mod_init_copy(), rb_module_add_to_subclasses_list(), and rb_singleton_class_clone_and_attach().

#define RCLASS_IV_INDEX_TBL ( c   )     (RCLASS_EXT(c)->iv_index_tbl)

Referenced by class_alloc(), obj_free(), obj_memsize_of(), and rb_ivar_set().

#define RCLASS_IV_TBL ( c   )     (RCLASS_EXT(c)->iv_tbl)

Referenced by autoload_data(), autoload_delete(), class_alloc(), classname(), cvar_lookup_at(), fc_path(), find_class_path(), init_copy(), mod_cvar_at(), obj_free(), obj_memsize_of(), rb_autoload(), rb_class_path_cached(), rb_cvar_get(), rb_cvar_set(), rb_include_class_new(), rb_ivar_count(), rb_ivar_defined(), rb_ivar_foreach(), rb_ivar_lookup(), rb_ivar_set(), rb_mod_init_copy(), rb_mod_remove_cvar(), rb_obj_remove_instance_variable(), rb_singleton_class_attached(), rb_singleton_class_clone_and_attach(), and rb_tmp_class_path().

#define RCLASS_M_TBL ( c   )     (RCLASS_M_TBL_WRAPPER(c) ? RCLASS_M_TBL_WRAPPER(c)->tbl : 0)

Referenced by add_opt_method(), class_instance_method_list(), has_extra_methods(), include_modules_at(), lookup_method_table(), obj_memsize_of(), rb_method_entry_make(), rb_mod_init_copy(), rb_obj_singleton_methods(), rb_prepend_module(), rb_singleton_class_clone_and_attach(), rb_vm_check_redefinition_by_prepend(), and remove_method().

#define RCLASS_M_TBL_WRAPPER ( c   )     (RCLASS(c)->m_tbl_wrapper)

Referenced by class_alloc(), class_search_ancestor(), include_modules_at(), obj_free(), obj_memsize_of(), rb_include_class_new(), rb_mod_init_copy(), rb_prepend_module(), and rb_using_refinement().

#define RCLASS_ORIGIN ( c   )     (RCLASS_EXT(c)->origin)

Referenced by class_alloc(), class_instance_method_list(), include_modules_at(), rb_alias(), rb_class_inherited_p(), rb_class_search_ancestor(), rb_export_method(), rb_include_class_new(), rb_include_module(), rb_method_entry_make(), rb_mod_ancestors(), rb_mod_included_modules(), rb_obj_is_kind_of(), rb_obj_singleton_methods(), rb_prepend_module(), rb_vm_check_redefinition_by_prepend(), remove_method(), vm_call_method(), vm_call_super(), vm_search_normal_superclass(), and w_extended().

#define RCLASS_REFINED_CLASS ( c   )     (RCLASS_EXT(c)->refined_class)

Referenced by add_activated_refinement(), class_alloc(), rb_using_refinement(), and vm_search_super_method().

#define RCLASS_SERIAL ( c   )     (RCLASS_EXT(c)->class_serial)

Referenced by class_alloc(), rb_class_clear_method_cache(), vm_getivar(), vm_search_method(), and vm_setivar().

#define RHASH_TBL_RAW ( h   )     rb_hash_tbl_raw(h)

Referenced by count_objects(), kwmerge_i(), rb_ary_or(), and rb_execarg_fixup().

#define RUBY_BIT_ROTL ( v,
n   )     (((v) << (n)) | ((v) >> ((sizeof(v) * 8) - n)))
#define RUBY_BIT_ROTR ( v,
n   )     (((v) >> (n)) | ((v) << ((sizeof(v) * 8) - n)))
#define RUBY_INTERNAL_H   1
#define SERIALT2NUM   ULONG2NUM
#define SIGNED_INTEGER_MAX ( sint_type   ) 
Value:
(sint_type) \
  ((((sint_type)1) << (sizeof(sint_type) * CHAR_BIT - 2)) | \
  ((((sint_type)1) << (sizeof(sint_type) * CHAR_BIT - 2)) - 1))
#define SIGNED_INTEGER_MIN ( sint_type   )     (-SIGNED_INTEGER_MAX(sint_type)-1)
#define SIGNED_INTEGER_TYPE_P ( int_type   )     (0 > ((int_type)0)-1)
#define SIZED_REALLOC_N ( var,
type,
n,
old_n   )     ((var)=(type*)ruby_sized_xrealloc((char*)(var), (n) * sizeof(type), (old_n) * sizeof(type)))

Referenced by ary_resize_capa(), and rb_ary_resize().

#define STATIC_ASSERT ( name,
expr   )     typedef int static_assert_##name##_check[1 - 2*!(expr)]

Referenced by STATIC_ASSERT().

#define STR_ASSOC   FL_USER3

Referenced by rb_str_associate(), rb_str_new_frozen(), str_buf_cat(), and str_replace().

#define STR_ASSOC_P ( s   )     FL_ALL_RAW((s), STR_NOEMBED|STR_ASSOC)

Referenced by dump_object(), rb_str_append(), rb_str_associate(), rb_str_associated(), rb_str_cat(), rb_str_freeze(), rb_str_new_frozen(), str_buf_cat(), str_new4(), and str_replace().

#define STR_EMBED_P ( str   )     (!FL_TEST_RAW((str), STR_NOEMBED))

Referenced by dump_object(), rb_str_associate(), rb_str_capacity(), rb_str_free(), rb_str_modify_expand(), rb_str_new_frozen(), rb_str_resize(), str_buf_cat(), str_discard(), str_independent(), and tr_trans().

#define STR_NOCAPA   (STR_NOEMBED|ELTS_SHARED|STR_ASSOC)

Referenced by rb_str_shared_replace().

#define STR_NOCAPA_P ( s   )     (FL_TEST_RAW((s),STR_NOEMBED) && FL_ANY_RAW((s),ELTS_SHARED|STR_ASSOC))

Referenced by dump_object(), rb_str_capacity(), and rb_str_shared_replace().

#define STR_NOEMBED   FL_USER1

Referenced by rb_str_buf_new(), rb_str_drop_bytes(), rb_str_memsize(), and str_replace_shared_without_enc().

#define STR_SHARED   FL_USER2
#define STR_SHARED_P ( s   )     FL_ALL_RAW((s), STR_NOEMBED|ELTS_SHARED)

Referenced by dump_object(), fstr_update_callback(), rb_str_associate(), rb_str_associated(), rb_str_drop_bytes(), rb_str_free(), rb_str_new_frozen(), rb_str_set_len(), str_discard(), str_independent(), str_new4(), and str_replace().

#define swap16 ( x   )     ((uint16_t)((((x)&0xFF)<<8) | (((x)>>8)&0xFF)))

Referenced by bary_pack(), and bary_unpack_internal().

#define swap32 ( x   ) 
Value:
((uint32_t)((((x)&0xFF)<<24)    \
                        |(((x)>>24)&0xFF)       \
                        |(((x)&0x0000FF00)<<8)  \
                        |(((x)&0x00FF0000)>>8)  ))

Referenced by bary_pack(), bary_unpack_internal(), and define_swapx().

#define TIMET_MAX_PLUS_ONE   (2*(double)(TIMET_MAX/2+1))
#define UNSIGNED_INTEGER_MAX ( uint_type   )     (~(uint_type)0)
#define VALGRIND_MAKE_MEM_DEFINED ( p,
n   )     0

Referenced by gc_mark_maybe(), signal_ignored(), and zlib_mem_alloc().

#define VALGRIND_MAKE_MEM_UNDEFINED ( p,
n   )     0

Referenced by bignew_1(), gc_page_sweep(), and rb_big_realloc().

Generated on 18 May 2020 for Ruby by  doxygen 1.6.1