Ruby  2.4.2p198(2017-09-14revision59899)
Functions
Defining methods

There are some APIs to define a method from C. More...

Functions

void rb_define_method_id (VALUE klass, ID mid, VALUE(*func)(ANYARGS), int argc)
 
void rb_define_method (VALUE klass, const char *name, VALUE(*func)(ANYARGS), int argc)
 
void rb_define_protected_method (VALUE klass, const char *name, VALUE(*func)(ANYARGS), int argc)
 
void rb_define_private_method (VALUE klass, const char *name, VALUE(*func)(ANYARGS), int argc)
 
void rb_undef_method (VALUE klass, const char *name)
 
static enum rb_id_table_iterator_result undef_method_i (ID name, VALUE value, void *data)
 
void rb_undef_methods_from (VALUE klass, VALUE super)
 
void rb_define_singleton_method (VALUE obj, const char *name, VALUE(*func)(ANYARGS), int argc)
 Defines a singleton method for obj. More...
 
void rb_define_module_function (VALUE module, const char *name, VALUE(*func)(ANYARGS), int argc)
 Defines a module function for module. More...
 
void rb_define_global_function (const char *name, VALUE(*func)(ANYARGS), int argc)
 Defines a global function. More...
 
void rb_define_alias (VALUE klass, const char *name1, const char *name2)
 Defines an alias of a method. More...
 
void rb_define_attr (VALUE klass, const char *name, int read, int write)
 Defines (a) public accessor method(s) for an attribute. More...
 
int rb_obj_basic_to_s_p (VALUE obj)
 
VALUE rb_keyword_error_new (const char *error, VALUE keys)
 
 NORETURN (static void rb_keyword_error(const char *error, VALUE keys))
 
static void rb_keyword_error (const char *error, VALUE keys)
 
 NORETURN (static void unknown_keyword_error(VALUE hash, const ID *table, int keywords))
 
static void unknown_keyword_error (VALUE hash, const ID *table, int keywords)
 
static int separate_symbol (st_data_t key, st_data_t value, st_data_t arg)
 
VALUE rb_extract_keywords (VALUE *orighash)
 
int rb_get_kwargs (VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
 
int rb_scan_args (int argc, const VALUE *argv, const char *fmt,...)
 
int rb_class_has_methods (VALUE c)
 

Detailed Description

There are some APIs to define a method from C.

These API takes a C function as a method body.

Method body functions
Method body functions must return a VALUE and can be one of the following form:
Fixed number of parameters

This form is a normal C function, excepting it takes a receiver object as the first argument.

static VALUE my_method(VALUE self, VALUE x, VALUE y);
argc and argv style

This form takes three parameters: argc, argv and self. self is the receiver. argc is the number of arguments. argv is a pointer to an array of the arguments.

static VALUE my_method(int argc, VALUE *argv, VALUE self);
Ruby array style

This form takes two parameters: self and args. self is the receiver. args is an Array object which contains the arguments.

static VALUE my_method(VALUE self, VALUE args);

Number of parameters
Method defining APIs takes the number of parameters which the method will takes. This number is called argc. argc can be:
zero or positive number
This means the method body function takes a fixed number of parameters
-1
This means the method body function is "argc and argv" style.
-2
This means the method body function is "self and args" style.

Function Documentation

◆ NORETURN() [1/2]

NORETURN ( static void   rb_keyword_errorconst char *error, VALUE keys)

◆ NORETURN() [2/2]

NORETURN ( static void   unknown_keyword_errorVALUE hash, const ID *table, int keywords)

◆ rb_class_has_methods()

int rb_class_has_methods ( VALUE  c)

Definition at line 2051 of file class.c.

References FALSE, rb_id_table_size(), RCLASS_M_TBL, and TRUE.

Referenced by has_extra_methods().

◆ rb_define_alias()

void rb_define_alias ( VALUE  klass,
const char *  name1,
const char *  name2 
)

◆ rb_define_attr()

void rb_define_attr ( VALUE  klass,
const char *  name,
int  read,
int  write 
)

Defines (a) public accessor method(s) for an attribute.

Parameters
klassthe class which the attribute will belongs to
namename of the attribute
reada getter method for the attribute will be defined if read is non-zero.
writea setter method for the attribute will be defined if write is non-zero.

Definition at line 1771 of file class.c.

References FALSE, rb_attr(), and rb_intern.

Referenced by Init_zlib().

◆ rb_define_global_function()

void rb_define_global_function ( const char *  name,
VALUE(*)(ANYARGS func,
int  argc 
)

◆ rb_define_method()

void rb_define_method ( VALUE  klass,
const char *  name,
VALUE(*)(ANYARGS func,
int  argc 
)

Definition at line 1515 of file class.c.

References func, METHOD_VISI_PUBLIC, rb_add_method_cfunc(), and rb_intern.

Referenced by Init_Array(), Init_bigdecimal(), Init_Bignum(), Init_Binding(), Init_bubblebabble(), Init_Comparable(), Init_Complex(), Init_Cont(), Init_date_core(), Init_dbm(), Init_digest(), Init_Dir(), Init_Encoding(), Init_Enumerable(), Init_etc(), Init_eval(), Init_eval_method(), Init_Exception(), Init_fiddle_closure(), Init_fiddle_function(), Init_fiddle_handle(), Init_fiddle_pointer(), Init_File(), Init_GC(), Init_gdbm(), Init_generator(), Init_Hash(), Init_IO(), Init_ISeq(), Init_load(), Init_nonblock(), Init_Numeric(), Init_objspace(), Init_ossl_asn1(), Init_ossl_bn(), Init_ossl_cipher(), Init_ossl_dh(), Init_ossl_digest(), Init_ossl_dsa(), Init_ossl_engine(), Init_ossl_hmac(), Init_ossl_ns_spki(), Init_ossl_ocsp(), Init_ossl_pkcs12(), Init_ossl_pkcs7(), Init_ossl_pkey(), Init_ossl_rsa(), Init_ossl_ssl(), Init_ossl_ssl_session(), Init_ossl_x509attr(), Init_ossl_x509cert(), Init_ossl_x509crl(), Init_ossl_x509ext(), Init_ossl_x509name(), Init_ossl_x509req(), Init_ossl_x509revoked(), Init_ossl_x509store(), Init_pack(), Init_parser(), Init_pathname(), Init_Proc(), Init_psych_emitter(), Init_psych_parser(), Init_pty(), Init_Range(), Init_Rational(), Init_Regexp(), Init_sdbm(), Init_signal(), Init_socket(), Init_String(), Init_stringio(), Init_strscan(), Init_syslog(), Init_Thread(), Init_thread_sync(), Init_Time(), Init_vm_backtrace(), Init_vm_eval(), Init_vm_trace(), Init_wait(), Init_win32ole(), Init_win32ole_event(), Init_win32ole_method(), Init_win32ole_param(), Init_win32ole_record(), Init_win32ole_type(), Init_win32ole_typelib(), Init_win32ole_variable(), Init_win32ole_variant(), Init_zlib(), InitVM_console(), InitVM_Enumerator(), InitVM_escape(), InitVM_Object(), InitVM_process(), InitVM_Random(), InitVM_Struct(), InitVM_transcode(), parser_compile_error(), rb_define_singleton_method(), rsock_init_addrinfo(), rsock_init_ancdata(), rsock_init_basicsocket(), rsock_init_ipsocket(), rsock_init_sockifaddr(), rsock_init_sockopt(), rsock_init_sockssocket(), rsock_init_tcpserver(), rsock_init_tcpsocket(), rsock_init_udpsocket(), rsock_init_unixserver(), rsock_init_unixsocket(), ruby_Init_Continuation_body(), and ruby_Init_Fiber_as_Coroutine().

◆ rb_define_method_id()

void rb_define_method_id ( VALUE  klass,
ID  mid,
VALUE(*)(ANYARGS func,
int  argc 
)

Definition at line 1509 of file class.c.

References func, METHOD_VISI_PUBLIC, and rb_add_method_cfunc().

Referenced by Init_VM(), and setup_struct().

◆ rb_define_module_function()

void rb_define_module_function ( VALUE  module,
const char *  name,
VALUE(*)(ANYARGS func,
int  argc 
)

◆ rb_define_private_method()

void rb_define_private_method ( VALUE  klass,
const char *  name,
VALUE(*)(ANYARGS func,
int  argc 
)

◆ rb_define_protected_method()

void rb_define_protected_method ( VALUE  klass,
const char *  name,
VALUE(*)(ANYARGS func,
int  argc 
)

Definition at line 1521 of file class.c.

References func, METHOD_VISI_PROTECTED, rb_add_method_cfunc(), and rb_intern.

◆ rb_define_singleton_method()

void rb_define_singleton_method ( VALUE  obj,
const char *  name,
VALUE(*)(ANYARGS func,
int  argc 
)

Defines a singleton method for obj.

Parameters
objan arbitrary object
namename of the singleton method
functhe method body
argcthe number of parameters, or -1 or -2. see Defining methods.

Definition at line 1716 of file class.c.

References func, rb_define_method(), and singleton_class_of().

Referenced by define_filetest_function(), Init_Array(), Init_bigdecimal(), Init_bubblebabble(), Init_Complex(), Init_Cont(), Init_date_core(), Init_dbm(), Init_digest(), Init_Dir(), Init_Encoding(), Init_etc(), Init_eval(), Init_Exception(), Init_fiddle_handle(), Init_fiddle_pointer(), Init_File(), Init_GC(), Init_gdbm(), Init_generator(), Init_Hash(), Init_IO(), Init_ISeq(), Init_ossl_asn1(), Init_ossl_bn(), Init_ossl_dh(), Init_ossl_dsa(), Init_ossl_engine(), Init_ossl_hmac(), Init_ossl_ocsp(), Init_ossl_pkcs12(), Init_ossl_pkcs7(), Init_ossl_rsa(), Init_pathname(), Init_Proc(), Init_psych(), Init_pty(), Init_readline(), Init_Regexp(), Init_sdbm(), Init_socket(), Init_String(), Init_stringio(), Init_strscan(), Init_syslog(), Init_Thread(), Init_Time(), Init_top_self(), Init_VM(), Init_vm_trace(), Init_win32ole(), Init_win32ole_event(), Init_win32ole_type(), Init_win32ole_typelib(), Init_win32ole_variant(), Init_zlib(), InitVM_console(), InitVM_process(), InitVM_Random(), InitVM_Struct(), InitVM_transcode(), parser_compile_error(), rb_define_module_function(), rb_gzreader_initialize(), rb_gzwriter_initialize(), rsock_init_addrinfo(), rsock_init_ancdata(), rsock_init_basicsocket(), rsock_init_ipsocket(), rsock_init_sockifaddr(), rsock_init_sockopt(), rsock_init_tcpsocket(), rsock_init_unixsocket(), ruby_Init_Fiber_as_Coroutine(), and setup_struct().

◆ rb_extract_keywords()

VALUE rb_extract_keywords ( VALUE orighash)

◆ rb_get_kwargs()

int rb_get_kwargs ( VALUE  keyword_hash,
const ID table,
int  required,
int  optional,
VALUE values 
)

◆ rb_keyword_error()

static void rb_keyword_error ( const char *  error,
VALUE  keys 
)
static

◆ rb_keyword_error_new()

VALUE rb_keyword_error_new ( const char *  error,
VALUE  keys 
)

◆ rb_obj_basic_to_s_p()

int rb_obj_basic_to_s_p ( VALUE  obj)

◆ rb_scan_args()

int rb_scan_args ( int  argc,
const VALUE argv,
const char *  fmt,
  ... 
)

Definition at line 1919 of file class.c.

References argc, hash(), ISDIGIT, last, NIL_P, Qnil, rb_ary_new(), rb_ary_new4, rb_ary_push(), rb_block_given_p(), rb_block_proc(), rb_check_hash_type(), rb_error_arity(), rb_extract_keywords(), rb_fatal(), and UNLIMITED_ARGUMENTS.

Referenced by addrinfo_getnameinfo(), addrinfo_initialize(), addrinfo_s_getaddrinfo(), addrinfo_s_udp(), argf_getpartial(), argf_read(), argf_read_nonblock(), ary_take_first_or_last(), BigDecimal_ceil(), BigDecimal_div3(), BigDecimal_dump(), BigDecimal_floor(), BigDecimal_limit(), BigDecimal_mode(), BigDecimal_new(), BigDecimal_power(), BigDecimal_round(), BigDecimal_to_s(), BigDecimal_truncate(), bind_eval(), bsock_setsockopt(), bsock_shutdown(), class_instance_method_list(), count_objects(), cParser_initialize(), cState_initialize(), d_lite_new_offset(), d_lite_new_start(), d_lite_next_day(), d_lite_next_month(), d_lite_next_year(), d_lite_prev_day(), d_lite_prev_month(), d_lite_prev_year(), d_lite_step(), date_s__parse_internal(), date_s__strptime_internal(), date_s_civil(), date_s_commercial(), date_s_httpdate(), date_s_iso8601(), date_s_jd(), date_s_jisx0301(), date_s_ordinal(), date_s_parse(), date_s_rfc2822(), date_s_rfc3339(), date_s_strptime(), date_s_today(), date_s_valid_civil_p(), date_s_valid_commercial_p(), date_s_valid_jd_p(), date_s_valid_ordinal_p(), date_s_xmlschema(), date_strftime_internal(), datetime_s_civil(), datetime_s_commercial(), datetime_s_httpdate(), datetime_s_iso8601(), datetime_s_jd(), datetime_s_jisx0301(), datetime_s_now(), datetime_s_ordinal(), datetime_s_parse(), datetime_s_rfc2822(), datetime_s_rfc3339(), datetime_s_strptime(), datetime_s_xmlschema(), define_final(), dir_initialize(), dir_s_chdir(), dir_s_glob(), dir_s_mkdir(), do_checksum(), econv_args(), econv_primitive_convert(), econv_putback(), enum_count(), enum_cycle(), enum_find(), enum_find_index(), enum_inject(), enum_max(), enum_max_by(), enum_min(), enum_min_by(), enum_slice_after(), enum_slice_before(), enum_sum(), enumerator_with_index(), etc_getgrgid(), etc_getpwuid(), ev_advise(), ev_on_event(), exc_initialize(), f_round_common(), fdbm_fetch_m(), fdbm_initialize(), fev_off_event(), fgdbm_fetch_m(), fgdbm_initialize(), file_s_fnmatch(), flo_round(), float_rationalize(), fole_initialize(), fole_s_connect(), fole_s_const_load(), fole_s_show_help(), fsdbm_fetch_m(), fsdbm_initialize(), gc_latest_gc_info(), gc_profile_report(), gc_start_internal(), gc_stat(), generator_initialize(), gzreader_gets(), initialize(), int_round(), integer_rationalize(), interrupt_init(), io_getpartial(), io_read(), io_s_write(), iseq_s_load(), iseqw_s_compile(), iseqw_s_compile_file(), iseqw_to_binary(), marshal_dump(), match_aref(), math_log(), memsize_of_all_m(), mObject_to_json(), mSyslog_open(), mutex_sleep(), nilclass_rationalize(), nucomp_rationalize(), nucomp_s_alloc(), nucomp_s_convert(), nucomp_s_new(), nucomp_s_polar(), num_step_scan_args(), nurat_rationalize(), nurat_round_n(), nurat_s_alloc(), nurat_s_convert(), nurat_s_new(), obj_respond_to(), objspace_dump(), objspace_dump_all(), old_to_new(), ole_invoke(), os_each_obj(), ossl_asn1_initialize(), ossl_bn_initialize(), ossl_bn_is_prime(), ossl_bn_is_prime_fasttest(), ossl_bn_s_generate_prime(), ossl_bn_to_s(), ossl_cipher_init(), ossl_cipher_is_authenticated(), ossl_cipher_pkcs5_keyivgen(), ossl_cipher_update(), ossl_dh_initialize(), ossl_dh_s_generate(), ossl_digest_finish(), ossl_digest_initialize(), ossl_dsa_export(), ossl_dsa_initialize(), ossl_engine_ctrl_cmd(), ossl_engine_load_privkey(), ossl_engine_load_pubkey(), ossl_engine_s_load(), ossl_ocspbres_add_nonce(), ossl_ocspbres_initialize(), ossl_ocspbres_sign(), ossl_ocspbres_verify(), ossl_ocspcid_initialize(), ossl_ocspreq_add_nonce(), ossl_ocspreq_initialize(), ossl_ocspreq_sign(), ossl_ocspreq_verify(), ossl_ocspres_initialize(), ossl_ocspsres_check_validity(), ossl_pkcs12_initialize(), ossl_pkcs12_s_create(), ossl_pkcs7_decrypt(), ossl_pkcs7_initialize(), ossl_pkcs7_s_encrypt(), ossl_pkcs7_s_sign(), ossl_pkcs7_s_write_smime(), ossl_pkcs7_verify(), ossl_pkey_new_from_data(), ossl_rsa_export(), ossl_rsa_initialize(), ossl_rsa_private_decrypt(), ossl_rsa_private_encrypt(), ossl_rsa_public_decrypt(), ossl_rsa_public_encrypt(), ossl_rsa_s_generate(), ossl_spki_initialize(), ossl_ssl_accept_nonblock(), ossl_ssl_connect_nonblock(), ossl_ssl_initialize(), ossl_ssl_read_internal(), ossl_ssl_write_nonblock(), ossl_sslctx_flush_sessions(), ossl_x509_initialize(), ossl_x509attr_initialize(), ossl_x509crl_initialize(), ossl_x509ext_initialize(), ossl_x509extfactory_create_ext(), ossl_x509extfactory_initialize(), ossl_x509name_add_entry(), ossl_x509name_initialize(), ossl_x509name_to_s(), ossl_x509req_initialize(), ossl_x509stctx_initialize(), ossl_x509store_verify(), pack_pack(), parse(), parser_compile_error(), path_basename(), path_binread(), path_binwrite(), path_each_line(), path_expand_path(), path_fnmatch(), path_mkdir(), path_open(), path_read(), path_readlines(), path_realdirpath(), path_realpath(), path_s_glob(), path_sysopen(), path_write(), prepare_getline_args(), proc_curry(), pty_check(), range_first(), range_initialize(), range_step(), rawmode_opt(), rb_ary_aref(), rb_ary_count(), rb_ary_cycle(), rb_ary_fetch(), rb_ary_fill(), rb_ary_flatten(), rb_ary_flatten_bang(), rb_ary_initialize(), rb_ary_join_m(), rb_ary_max(), rb_ary_min(), rb_ary_permutation(), rb_ary_rotate_bang(), rb_ary_rotate_m(), rb_ary_sample(), rb_ary_slice_bang(), rb_ary_sum(), rb_class_initialize(), rb_condvar_wait(), rb_deflate_deflate(), rb_deflate_flush(), rb_deflate_initialize(), rb_deflate_s_deflate(), rb_digest_instance_digest(), rb_digest_instance_hexdigest(), rb_f_catch(), rb_f_eval(), rb_f_integer(), rb_f_load(), rb_f_select(), rb_f_throw(), rb_f_trace_var(), rb_f_untrace_var(), rb_fiddle_handle_initialize(), rb_fiddle_ptr_aref(), rb_fiddle_ptr_aset(), rb_fiddle_ptr_initialize(), rb_fiddle_ptr_s_malloc(), rb_fiddle_ptr_to_s(), rb_fiddle_ptr_to_str(), rb_gzreader_initialize(), rb_gzreader_read(), rb_gzreader_readpartial(), rb_gzwriter_flush(), rb_gzwriter_initialize(), rb_inflate_initialize(), rb_io_advise(), rb_io_initialize(), rb_io_reopen(), rb_io_s_binread(), rb_io_s_copy_stream(), rb_io_s_foreach(), rb_io_s_pipe(), rb_io_s_read(), rb_io_s_readlines(), rb_io_s_sysopen(), rb_io_seek_m(), rb_io_set_encoding(), rb_io_sysread(), rb_io_sysseek(), rb_mod_class_variables(), rb_mod_constants(), rb_obj_clone2(), rb_obj_display(), rb_obj_singleton_methods(), rb_reg_match_m(), rb_reg_s_last_match(), rb_scan_open_args(), rb_str_enumerate_lines(), rb_str_index_m(), rb_str_init(), rb_str_justify(), rb_str_rindex_m(), rb_str_split_m(), rb_str_sum(), rb_str_to_i(), rb_str_upto(), rb_thread_pending_interrupt_p(), readline_readline(), rsock_bsock_send(), rsock_s_recvfrom(), setup_hash(), setup_narg(), sock_initialize(), sock_s_getaddrinfo(), sock_s_gethostbyaddr(), sock_s_getnameinfo(), sock_s_getservbyname(), sock_s_getservbyport(), str_transcode(), strio_init(), strio_read_nonblock(), strio_seek(), strio_set_encoding(), strio_syswrite_nonblock(), strscan_initialize(), syserr_initialize(), tcp_init(), tcp_svr_init(), thread_join_m(), time_arg(), time_dump(), time_getlocaltime(), time_init_1(), time_localtime_m(), time_round(), time_s_at(), udp_init(), udp_send(), valid_civil_sub(), valid_commercial_sub(), valid_jd_sub(), valid_ordinal_sub(), vm_backtrace_to_ary(), vm_stat(), and zlib_s_gzip().

◆ rb_undef_method()

void rb_undef_method ( VALUE  klass,
const char *  name 
)

◆ rb_undef_methods_from()

void rb_undef_methods_from ( VALUE  klass,
VALUE  super 
)

Definition at line 1547 of file class.c.

References rb_id_table_foreach(), RCLASS_M_TBL, and undef_method_i().

Referenced by Init_Complex().

◆ separate_symbol()

static int separate_symbol ( st_data_t  key,
st_data_t  value,
st_data_t  arg 
)
static

Definition at line 1829 of file class.c.

References rb_hash_aset(), rb_hash_new(), ST_CONTINUE, and SYMBOL_P.

Referenced by rb_extract_keywords().

◆ undef_method_i()

static enum rb_id_table_iterator_result undef_method_i ( ID  name,
VALUE  value,
void *  data 
)
static

Definition at line 1539 of file class.c.

References ID_TABLE_CONTINUE, METHOD_VISI_UNDEF, rb_add_method(), and VM_METHOD_TYPE_UNDEF.

Referenced by rb_undef_methods_from().

◆ unknown_keyword_error()

static void unknown_keyword_error ( VALUE  hash,
const ID table,
int  keywords 
)
static