diff options
Diffstat (limited to 'internal.h')
| -rw-r--r-- | internal.h | 300 |
1 files changed, 77 insertions, 223 deletions
diff --git a/internal.h b/internal.h index 59bb3fda2d..002044cfa1 100644 --- a/internal.h +++ b/internal.h @@ -1,251 +1,105 @@ -/********************************************************************** +#ifndef RUBY_INTERNAL_H /*-*-C-*-vi:se ft=c:*/ +#define RUBY_INTERNAL_H 1 +/** + * @author $Author$ + * @date Tue May 17 11:42:20 JST 2011 + * @copyright Copyright (C) 2011 Yukihiro Matsumoto + * @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. + */ +#include "ruby/internal/config.h" - internal.h - +#ifdef __cplusplus +# error not for C++ +#endif - $Author$ - created at: Tue May 17 11:42:20 JST 2011 +#define LIKELY(x) RB_LIKELY(x) +#define UNLIKELY(x) RB_UNLIKELY(x) - Copyright (C) 2011 Yukihiro Matsumoto +#define numberof(array) ((int)(sizeof(array) / sizeof((array)[0]))) +#define roomof(x, y) (((x) + (y) - 1) / (y)) +#define type_roomof(x, y) roomof(sizeof(x), sizeof(y)) -**********************************************************************/ +/* Prevent compiler from reordering access */ +#define ACCESS_ONCE(type,x) (*((volatile type *)&(x))) -#ifndef RUBY_INTERNAL_H -#define RUBY_INTERNAL_H 1 +#define UNDEF_P RB_UNDEF_P +#define NIL_OR_UNDEF_P RB_NIL_OR_UNDEF_P -#if defined(__cplusplus) -extern "C" { -#if 0 -} /* satisfy cc-mode */ -#endif -#endif +#include "ruby/ruby.h" -struct rb_deprecated_classext_struct { - char conflict[sizeof(VALUE) * 3]; -}; +/* Following macros were formerly defined in this header but moved to somewhere + * else. In order to detect them we undef here. */ -struct rb_classext_struct { - VALUE super; - struct st_table *iv_tbl; - struct st_table *const_tbl; -}; +/* internal/array.h */ +#undef RARRAY_AREF +/* internal/class.h */ +#undef RClass #undef RCLASS_SUPER -#define RCLASS_EXT(c) (RCLASS(c)->ptr) -#define RCLASS_SUPER(c) (RCLASS_EXT(c)->super) -#define RCLASS_IV_TBL(c) (RCLASS_EXT(c)->iv_tbl) -#define RCLASS_CONST_TBL(c) (RCLASS_EXT(c)->const_tbl) -#define RCLASS_M_TBL(c) (RCLASS(c)->m_tbl) -#define RCLASS_IV_INDEX_TBL(c) (RCLASS(c)->iv_index_tbl) - -struct vtm; /* defined by timev.h */ - -/* array.c */ -VALUE rb_ary_last(int, VALUE *, VALUE); -void rb_ary_set_len(VALUE, long); - -/* bignum.c */ -VALUE rb_big_fdiv(VALUE x, VALUE y); -VALUE rb_big_uminus(VALUE x); - -/* class.c */ -VALUE rb_obj_methods(int argc, VALUE *argv, VALUE obj); -VALUE rb_obj_protected_methods(int argc, VALUE *argv, VALUE obj); -VALUE rb_obj_private_methods(int argc, VALUE *argv, VALUE obj); -VALUE rb_obj_public_methods(int argc, VALUE *argv, VALUE obj); -int rb_obj_basic_to_s_p(VALUE); -void Init_class_hierarchy(void); - -/* compile.c */ -int rb_dvar_defined(ID); -int rb_local_defined(ID); -int rb_parse_in_eval(void); -int rb_parse_in_main(void); -VALUE rb_insns_name_array(void); - -/* cont.c */ -VALUE rb_obj_is_fiber(VALUE); -void rb_fiber_reset_root_local_storage(VALUE); -/* debug.c */ -PRINTF_ARGS(void ruby_debug_printf(const char*, ...), 1, 2); +/* internal/hash.h */ +#undef RHASH_IFNONE +#undef RHASH_SIZE +#undef RHASH_TBL +#undef RHASH_EMPTY_P + +/* internal/struct.h */ +#undef RSTRUCT_LEN +#undef RSTRUCT_PTR +#undef RSTRUCT_SET +#undef RSTRUCT_GET -/* dmyext.c */ -void Init_ext(void); +/* Also, we keep the following macros here. They are expected to be + * overridden in each headers. */ -/* encoding.c */ -ID rb_id_encoding(void); +/* internal/array.h */ +#define rb_ary_new_from_args(...) rb_nonexistent_symbol(__VA_ARGS__) -/* encoding.c */ -void rb_gc_mark_encodings(void); +/* internal/string.h */ +#define rb_fstring_cstr(...) rb_nonexistent_symbol(__VA_ARGS__) -/* error.c */ -NORETURN(PRINTF_ARGS(void rb_compile_bug(const char*, int, const char*, ...), 3, 4)); -VALUE rb_check_backtrace(VALUE); -NORETURN(void rb_async_bug_errno(const char *,int)); +/* internal/symbol.h */ +#define rb_sym_intern_ascii_cstr(...) rb_nonexistent_symbol(__VA_ARGS__) -/* eval_error.c */ -void ruby_error_print(void); -VALUE rb_get_backtrace(VALUE info); +/* internal/vm.h */ +#define rb_funcallv(...) rb_nonexistent_symbol(__VA_ARGS__) +#define rb_method_basic_definition_p(...) rb_nonexistent_symbol(__VA_ARGS__) -/* eval_jump.c */ -void rb_call_end_proc(VALUE data); -/* file.c */ -VALUE rb_home_dir(const char *user, VALUE result); -VALUE rb_realpath_internal(VALUE basedir, VALUE path, int strict); -void Init_File(void); +/* MRI debug support */ /* gc.c */ -void Init_heap(void); -void *ruby_mimmalloc(size_t size); - -/* inits.c */ -void rb_call_inits(void); - -/* io.c */ -const char *ruby_get_inplace_mode(void); -void ruby_set_inplace_mode(const char *); -ssize_t rb_io_bufread(VALUE io, void *buf, size_t size); -void rb_stdio_set_default_encoding(void); - -/* iseq.c */ -VALUE rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE filepath, VALUE line, VALUE opt); -VALUE rb_iseq_clone(VALUE iseqval, VALUE newcbase); - -/* load.c */ -VALUE rb_get_load_path(void); - -/* math.c */ -VALUE rb_math_atan2(VALUE, VALUE); -VALUE rb_math_cos(VALUE); -VALUE rb_math_cosh(VALUE); -VALUE rb_math_exp(VALUE); -VALUE rb_math_hypot(VALUE, VALUE); -VALUE rb_math_log(int argc, VALUE *argv); -VALUE rb_math_sin(VALUE); -VALUE rb_math_sinh(VALUE); -VALUE rb_math_sqrt(VALUE); - -/* newline.c */ -void Init_newline(void); - -/* numeric.c */ -int rb_num_to_uint(VALUE val, unsigned int *ret); -int ruby_float_step(VALUE from, VALUE to, VALUE step, int excl); - -/* object.c */ -VALUE rb_obj_equal(VALUE obj1, VALUE obj2); - -/* parse.y */ -VALUE rb_parser_get_yydebug(VALUE); -VALUE rb_parser_set_yydebug(VALUE, VALUE); -int rb_is_const_name(VALUE name); -int rb_is_class_name(VALUE name); -int rb_is_global_name(VALUE name); -int rb_is_instance_name(VALUE name); -int rb_is_attrset_name(VALUE name); -int rb_is_local_name(VALUE name); -int rb_is_method_name(VALUE name); -int rb_is_junk_name(VALUE name); - -/* proc.c */ -VALUE rb_proc_location(VALUE self); -st_index_t rb_hash_proc(st_index_t hash, VALUE proc); - -/* rational.c */ -VALUE rb_lcm(VALUE x, VALUE y); -VALUE rb_rational_reciprocal(VALUE x); - -/* re.c */ -VALUE rb_reg_compile(VALUE str, int options, const char *sourcefile, int sourceline); -VALUE rb_reg_check_preprocess(VALUE); - -/* signal.c */ -int rb_get_next_signal(void); - -/* strftime.c */ -#ifdef RUBY_ENCODING_H -size_t rb_strftime_timespec(char *s, size_t maxsize, const char *format, rb_encoding *enc, - const struct vtm *vtm, struct timespec *ts, int gmt); -size_t rb_strftime(char *s, size_t maxsize, const char *format, rb_encoding *enc, - const struct vtm *vtm, VALUE timev, int gmt); -#endif +void rb_obj_info_dump(VALUE obj); +void rb_obj_info_dump_loc(VALUE obj, const char *file, int line, const char *func); -/* string.c */ -int rb_str_buf_cat_escaped_char(VALUE result, unsigned int c, int unicode_p); - -/* struct.c */ -VALUE rb_struct_init_copy(VALUE copy, VALUE s); - -/* time.c */ -struct timeval rb_time_timeval(VALUE); - -/* thread.c */ -VALUE rb_obj_is_mutex(VALUE obj); -VALUE ruby_suppress_tracing(VALUE (*func)(VALUE, int), VALUE arg, int always); -void rb_thread_execute_interrupts(VALUE th); -void rb_clear_trace_func(void); -VALUE rb_thread_backtrace(VALUE thval); -VALUE rb_get_coverages(void); - -/* thread_pthread.c, thread_win32.c */ -void Init_native_thread(void); - -/* vm.c */ -VALUE rb_obj_is_thread(VALUE obj); -void rb_vm_mark(void *ptr); -void Init_BareVM(void); -VALUE rb_vm_top_self(void); -void rb_thread_recycle_stack_release(VALUE *); -void rb_vm_change_state(void); -void rb_vm_inc_const_missing_count(void); -void rb_thread_mark(void *th); -const void **rb_vm_get_insns_address_table(void); -VALUE rb_sourcefilename(void); - -/* vm_dump.c */ -void rb_vm_bugreport(void); - -/* vm_eval.c */ -void Init_vm_eval(void); -VALUE rb_current_realfilepath(void); - -/* vm_method.c */ -void Init_eval_method(void); - -/* miniprelude.c, prelude.c */ -void Init_prelude(void); - -#if defined __GNUC__ && __GNUC__ >= 4 -#pragma GCC visibility push(default) -#endif -const char *rb_objspace_data_type_name(VALUE obj); +/* debug.c */ -/* Temporary. This API will be removed (renamed). */ -VALUE rb_thread_io_blocking_region(rb_blocking_function_t *func, void *data1, int fd); +RUBY_SYMBOL_EXPORT_BEGIN +void ruby_debug_breakpoint(void); +PRINTF_ARGS(void ruby_debug_printf(const char*, ...), 1, 2); +RUBY_SYMBOL_EXPORT_END -/* experimental. - * These APIs can be changed on Ruby 1.9.4 or later. - * We will change these APIs (spac, name and so on) if there are something wrong. - * If you use these APIs, catch up future changes. - */ -void *rb_thread_call_with_gvl(void *(*func)(void *), void *data1); -VALUE rb_thread_call_without_gvl( - rb_blocking_function_t *func, void *data1, - rb_unblock_function_t *ubf, void *data2); +// show obj data structure without any side-effect +#define rp(obj) rb_obj_info_dump_loc((VALUE)(obj), __FILE__, __LINE__, RUBY_FUNCTION_NAME_STRING) -/* io.c */ -void rb_maygvl_fd_fix_cloexec(int fd); +// same as rp, but add message header +#define rp_m(msg, obj) do { \ + fputs((msg), stderr); \ + rb_obj_info_dump((VALUE)(obj)); \ +} while (0) -#if defined __GNUC__ && __GNUC__ >= 4 -#pragma GCC visibility pop -#endif +// `ruby_debug_breakpoint()` does nothing, +// but breakpoint is set in run.gdb, so `make gdb` can stop here. +#define bp() ruby_debug_breakpoint() -#if defined(__cplusplus) -#if 0 -{ /* satisfy cc-mode */ -#endif -} /* extern "C" { */ -#endif +#define RBOOL(v) ((v) ? Qtrue : Qfalse) +#define RB_BIGNUM_TYPE_P(x) RB_TYPE_P((x), T_BIGNUM) +#ifndef __MINGW32__ +#undef memcpy +#define memcpy ruby_nonempty_memcpy +#endif #endif /* RUBY_INTERNAL_H */ |