Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)
method.h
Go to the documentation of this file.
1#ifndef RUBY_METHOD_H
2#define RUBY_METHOD_H 1
3/**********************************************************************
4
5 method.h -
6
7 $Author$
8 created at: Wed Jul 15 20:02:33 2009
9
10 Copyright (C) 2009 Koichi Sasada
11
12**********************************************************************/
13
14#include "internal.h"
15#include "internal/imemo.h"
16#include "internal/compilers.h"
17#include "internal/static_assert.h"
18
19#ifndef END_OF_ENUMERATION
20# if defined(__GNUC__) &&! defined(__STRICT_ANSI__)
21# define END_OF_ENUMERATION(key)
22# else
23# define END_OF_ENUMERATION(key) END_OF_##key##_PLACEHOLDER = 0
24# endif
25#endif
26
27/* cref */
28
29typedef enum {
34
35 METHOD_VISI_MASK = 0x03
37
38typedef struct rb_scope_visi_struct {
40 unsigned int module_func : 1;
42
44typedef struct rb_cref_struct {
51
52/* method data type */
53
54typedef struct rb_method_entry_struct {
61
62typedef struct rb_callable_method_entry_struct { /* same fields with rb_method_entry_t */
67 const VALUE owner;
69
70#define METHOD_ENTRY_VISI(me) (rb_method_visibility_t)(((me)->flags & (IMEMO_FL_USER0 | IMEMO_FL_USER1)) >> (IMEMO_FL_USHIFT+0))
71#define METHOD_ENTRY_BASIC(me) (int) (((me)->flags & (IMEMO_FL_USER2 )) >> (IMEMO_FL_USHIFT+2))
72#define METHOD_ENTRY_COMPLEMENTED(me) ((me)->flags & IMEMO_FL_USER3)
73#define METHOD_ENTRY_COMPLEMENTED_SET(me) ((me)->flags |= IMEMO_FL_USER3)
74#define METHOD_ENTRY_CACHED(me) ((me)->flags & IMEMO_FL_USER4)
75#define METHOD_ENTRY_CACHED_SET(me) ((me)->flags |= IMEMO_FL_USER4)
76#define METHOD_ENTRY_INVALIDATED(me) ((me)->flags & IMEMO_FL_USER5)
77#define METHOD_ENTRY_INVALIDATED_SET(me) ((me)->flags |= IMEMO_FL_USER5)
78#define METHOD_ENTRY_CACHEABLE(me) !(METHOD_ENTRY_VISI(me) == METHOD_VISI_PROTECTED)
79
80static inline void
81METHOD_ENTRY_VISI_SET(rb_method_entry_t *me, rb_method_visibility_t visi)
82{
83 VM_ASSERT((int)visi >= 0 && visi <= 3);
84 me->flags = (me->flags & ~(IMEMO_FL_USER0 | IMEMO_FL_USER1)) | (visi << (IMEMO_FL_USHIFT+0));
85}
86static inline void
87METHOD_ENTRY_BASIC_SET(rb_method_entry_t *me, unsigned int basic)
88{
89 VM_ASSERT(basic <= 1);
90 me->flags = (me->flags & ~(IMEMO_FL_USER2 )) | (basic << (IMEMO_FL_USHIFT+2));
91}
92static inline void
93METHOD_ENTRY_FLAGS_SET(rb_method_entry_t *me, rb_method_visibility_t visi, unsigned int basic)
94{
95 VM_ASSERT((int)visi >= 0 && visi <= 3);
96 VM_ASSERT(basic <= 1);
97 me->flags =
99 ((visi << (IMEMO_FL_USHIFT+0)) | (basic << (IMEMO_FL_USHIFT+2)));
100}
101static inline void
102METHOD_ENTRY_FLAGS_COPY(rb_method_entry_t *dst, const rb_method_entry_t *src)
103{
104 dst->flags =
107}
108
109typedef enum {
123 END_OF_ENUMERATION(VM_METHOD_TYPE)
125#define VM_METHOD_TYPE_MINIMUM_BITS 4
128
129#ifndef rb_iseq_t
131#define rb_iseq_t rb_iseq_t
132#endif
133
134typedef struct rb_method_iseq_struct {
137} rb_method_iseq_t; /* check rb_add_method_iseq() when modify the fields */
138
141 VALUE (*invoker)(VALUE recv, int argc, const VALUE *argv, VALUE (*func)(ANYARGS));
142 int argc;
144
145typedef struct rb_method_attr_struct {
147 VALUE location; /* should be marked */
149
151 struct rb_method_entry_struct * original_me; /* original_me->klass is original owner */
153
158
160 VALUE proc; /* should be marked */
164
171
174 int alias_count : 28;
176 unsigned int no_redef_warning: 1;
177
178 union {
185
188
191};
192
193struct rb_id_table;
194
197
198#define UNDEFINED_METHOD_ENTRY_P(me) (!(me) || !(me)->def || (me)->def->type == VM_METHOD_TYPE_UNDEF)
199#define UNDEFINED_REFINED_METHOD_P(def) \
200 ((def)->type == VM_METHOD_TYPE_REFINED && \
201 UNDEFINED_METHOD_ENTRY_P((def)->body.refined.orig_me))
202
203void rb_add_method_cfunc(VALUE klass, ID mid, VALUE (*func)(ANYARGS), int argc, rb_method_visibility_t visi);
204void rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi);
205void rb_add_refined_method_entry(VALUE refined_class, ID mid);
206void rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *option, rb_method_visibility_t visi);
207
210
212
213const rb_method_entry_t *rb_method_entry(VALUE klass, ID id);
214const rb_method_entry_t *rb_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class);
215const rb_method_entry_t *rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class);
217RUBY_SYMBOL_EXPORT_BEGIN
219RUBY_SYMBOL_EXPORT_END
220
224
228
230
232
236
237void rb_method_table_insert(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me);
238
240
242
243void rb_clear_method_cache(VALUE klass_or_module, ID mid);
245
246#endif /* RUBY_METHOD_H */
#define offsetof(p_type, field)
Definition: addrinfo.h:186
Internal header absorbing C compipler differences.
IMEMO: Internal memo object.
#define IMEMO_FL_USER1
Definition: imemo.h:28
#define IMEMO_FL_USER0
Definition: imemo.h:27
#define IMEMO_FL_USHIFT
Definition: imemo.h:26
#define IMEMO_FL_USER2
Definition: imemo.h:29
#define STATIC_ASSERT
Definition: static_assert.h:14
const rb_method_entry_t * rb_method_entry_clone(const rb_method_entry_t *me)
Definition: vm_method.c:606
int rb_method_entry_eq(const rb_method_entry_t *m1, const rb_method_entry_t *m2)
Definition: vm_method.c:1821
const rb_callable_method_entry_t * rb_callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class)
Definition: vm_method.c:1253
struct rb_method_cfunc_struct rb_method_cfunc_t
const rb_method_entry_t * rb_method_entry(VALUE klass, ID id)
Definition: vm_method.c:1023
int rb_method_entry_arity(const rb_method_entry_t *me)
Definition: proc.c:2684
const rb_callable_method_entry_t * rb_callable_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class)
Definition: vm_method.c:1235
void rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi)
Definition: vm_method.c:910
struct rb_method_attr_struct rb_method_attr_t
const rb_method_entry_t * rb_resolve_refined_method(VALUE refinements, const rb_method_entry_t *me)
Definition: vm_method.c:1294
void rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *option, rb_method_visibility_t visi)
Definition: vm_method.c:900
void rb_method_entry_copy(rb_method_entry_t *dst, const rb_method_entry_t *src)
Definition: vm_method.c:655
void rb_add_refined_method_entry(VALUE refined_class, ID mid)
Definition: vm_method.c:709
void rb_clear_method_cache_all(void)
Definition: vm_method.c:280
struct rb_callable_method_entry_struct rb_callable_method_entry_t
void rb_method_table_insert(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me)
Definition: vm_method.c:286
void rb_free_method_entry(const rb_method_entry_t *me)
Definition: vm_method.c:358
struct rb_method_entry_struct rb_method_entry_t
rb_method_visibility_t
Definition: method.h:29
@ METHOD_VISI_PRIVATE
Definition: method.h:32
@ METHOD_VISI_MASK
Definition: method.h:35
@ METHOD_VISI_PROTECTED
Definition: method.h:33
@ METHOD_VISI_PUBLIC
Definition: method.h:31
@ METHOD_VISI_UNDEF
Definition: method.h:30
rb_method_entry_t * rb_method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *, rb_method_visibility_t noex)
Definition: vm_method.c:939
#define VM_METHOD_TYPE_MINIMUM_BITS
Definition: method.h:125
const rb_callable_method_entry_t * rb_callable_method_entry(VALUE klass, ID id)
Definition: vm_method.c:1177
struct rb_method_iseq_struct rb_method_iseq_t
rb_method_type_t
Definition: method.h:109
@ VM_METHOD_TYPE_ISEQ
Ruby method.
Definition: method.h:110
@ VM_METHOD_TYPE_ATTRSET
attr_writer or attr_accessor
Definition: method.h:112
@ VM_METHOD_TYPE_CFUNC
C method.
Definition: method.h:111
@ VM_METHOD_TYPE_OPTIMIZED
Kernel::send, Proc::call, etc.
Definition: method.h:119
@ VM_METHOD_TYPE_REFINED
refinement
Definition: method.h:121
@ VM_METHOD_TYPE_NOTIMPLEMENTED
Definition: method.h:118
@ VM_METHOD_TYPE_MISSING
wrapper for method_missing(id)
Definition: method.h:120
@ VM_METHOD_TYPE_BMETHOD
Definition: method.h:114
@ VM_METHOD_TYPE_IVAR
attr_reader or attr_accessor
Definition: method.h:113
@ VM_METHOD_TYPE_ZSUPER
Definition: method.h:115
@ VM_METHOD_TYPE_ALIAS
Definition: method.h:116
@ VM_METHOD_TYPE_UNDEF
Definition: method.h:117
method_optimized_type
Definition: method.h:165
@ OPTIMIZED_METHOD_TYPE_CALL
Definition: method.h:167
@ OPTIMIZED_METHOD_TYPE__MAX
Definition: method.h:169
@ OPTIMIZED_METHOD_TYPE_BLOCK_CALL
Definition: method.h:168
@ OPTIMIZED_METHOD_TYPE_SEND
Definition: method.h:166
VALUE rb_unnamed_parameters(int arity)
Definition: proc.c:1393
const rb_method_entry_t * rb_resolve_me_location(const rb_method_entry_t *, VALUE[5])
Definition: thread.c:5694
struct rb_scope_visi_struct rb_scope_visibility_t
const rb_method_entry_t * rb_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class)
Definition: vm_method.c:1208
void rb_clear_method_cache(VALUE klass_or_module, ID mid)
Definition: vm_method.c:236
const rb_method_entry_t * rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class)
Definition: vm_method.c:1247
struct rb_method_bmethod_struct rb_method_bmethod_t
VALUE rb_method_entry_location(const rb_method_entry_t *me)
Definition: proc.c:2869
struct rb_method_refined_struct rb_method_refined_t
void rb_scope_visibility_set(rb_method_visibility_t)
Definition: vm_method.c:1483
const rb_method_entry_t * rb_method_entry_at(VALUE obj, ID id)
Definition: vm_method.c:973
void rb_add_method_cfunc(VALUE klass, ID mid, VALUE(*func)(ANYARGS), int argc, rb_method_visibility_t visi)
Definition: vm_method.c:313
const rb_callable_method_entry_t * rb_method_entry_complement_defined_class(const rb_method_entry_t *src_me, ID called_id, VALUE defined_class)
Definition: vm_method.c:619
st_index_t rb_hash_method_entry(st_index_t hash, const rb_method_entry_t *me)
Definition: vm_method.c:1920
struct rb_cref_struct rb_cref_t
CREF (Class REFerence)
rb_method_entry_t * rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, const rb_method_definition_t *def)
Definition: vm_method.c:597
#define END_OF_ENUMERATION(key)
Definition: method.h:21
struct rb_method_alias_struct rb_method_alias_t
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition: cxxanyargs.hpp:56
int argc
Definition: ruby.c:240
char ** argv
Definition: ruby.c:241
st_data_t st_index_t
Definition: st.h:50
#define ANYARGS
Definition: stdarg.h:42
Definition: method.h:62
ID called_id
Definition: method.h:66
VALUE flags
Definition: method.h:63
const VALUE defined_class
Definition: method.h:64
const VALUE owner
Definition: method.h:67
struct rb_method_definition_struct *const def
Definition: method.h:65
CREF (Class REFerence)
Definition: method.h:44
const rb_scope_visibility_t scope_visi
Definition: method.h:49
VALUE flags
Definition: method.h:45
VALUE refinements
Definition: method.h:46
struct rb_cref_struct * next
Definition: method.h:48
VALUE klass
Definition: method.h:47
struct rb_method_entry_struct * original_me
Definition: method.h:151
struct rb_hook_list_struct * hooks
Definition: method.h:161
VALUE(* invoker)(VALUE recv, int argc, const VALUE *argv, VALUE(*func)(ANYARGS))
Definition: method.h:141
VALUE(* func)(ANYARGS)
Definition: method.h:140
unsigned int no_redef_warning
Definition: method.h:176
rb_method_iseq_t iseq
Definition: method.h:179
BITFIELD(rb_method_type_t, type, VM_METHOD_TYPE_MINIMUM_BITS)
rb_method_alias_t alias
Definition: method.h:182
rb_method_bmethod_t bmethod
Definition: method.h:184
union rb_method_definition_struct::@123 body
rb_method_attr_t attr
Definition: method.h:181
enum method_optimized_type optimize_type
Definition: method.h:186
rb_method_cfunc_t cfunc
Definition: method.h:180
rb_method_refined_t refined
Definition: method.h:183
Definition: method.h:54
ID called_id
Definition: method.h:58
VALUE flags
Definition: method.h:55
struct rb_method_definition_struct *const def
Definition: method.h:57
VALUE defined_class
Definition: method.h:56
VALUE owner
Definition: method.h:59
rb_cref_t * cref
class reference, should be marked
Definition: method.h:136
rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
Definition: method.h:135
struct rb_method_entry_struct * orig_me
Definition: method.h:155
unsigned int module_func
Definition: method.h:40
BITFIELD(rb_method_visibility_t, method_visi, 3)
unsigned long VALUE
Definition: value.h:38
unsigned long ID
Definition: value.h:39
#define VM_ASSERT(expr)
Definition: vm_core.h:61
unsigned int uintptr_t
Definition: win32.h:106
int def(FILE *source, FILE *dest, int level)
Definition: zpipe.c:36