Ruby  2.0.0p594(2014-10-27revision48167)
Data Structures | Macros | Typedefs | Enumerations | Functions
method.h File Reference

Go to the source code of this file.

Data Structures

struct  rb_method_cfunc_struct
 
struct  rb_method_attr_struct
 
struct  rb_method_definition_struct
 
struct  rb_method_entry_struct
 
struct  unlinked_method_entry_list_entry
 

Macros

#define END_OF_ENUMERATION(key)   END_OF_##key##_PLACEHOLDER = 0
 
#define NOEX_SAFE(n)   ((int)((n) >> NOEX_SAFE_SHIFT_OFFSET) & 0x0F)
 
#define NOEX_WITH(n, s)   (((s) << NOEX_SAFE_SHIFT_OFFSET) | (n) | (ruby_running ? 0 : NOEX_BASIC))
 
#define NOEX_WITH_SAFE(n)   NOEX_WITH((n), rb_safe_level())
 
#define UNDEFINED_METHOD_ENTRY_P(me)   (!(me) || !(me)->def || (me)->def->type == VM_METHOD_TYPE_UNDEF)
 

Typedefs

typedef struct
rb_method_cfunc_struct 
rb_method_cfunc_t
 
typedef struct
rb_method_attr_struct 
rb_method_attr_t
 
typedef struct rb_iseq_struct rb_iseq_t
 
typedef struct
rb_method_definition_struct 
rb_method_definition_t
 
typedef struct
rb_method_entry_struct 
rb_method_entry_t
 

Enumerations

enum  rb_method_flag_t {
  NOEX_PUBLIC = 0x00, NOEX_NOSUPER = 0x01, NOEX_PRIVATE = 0x02, NOEX_PROTECTED = 0x04,
  NOEX_MASK = 0x06, NOEX_BASIC = 0x08, NOEX_UNDEF = NOEX_NOSUPER, NOEX_MODFUNC = 0x12,
  NOEX_SUPER = 0x20, NOEX_VCALL = 0x40, NOEX_RESPONDS = 0x80, NOEX_BIT_WIDTH = 8,
  NOEX_SAFE_SHIFT_OFFSET = ((NOEX_BIT_WIDTH+3)/4)*4
}
 
enum  rb_method_type_t {
  VM_METHOD_TYPE_ISEQ, VM_METHOD_TYPE_CFUNC, VM_METHOD_TYPE_ATTRSET, VM_METHOD_TYPE_IVAR,
  VM_METHOD_TYPE_BMETHOD, VM_METHOD_TYPE_ZSUPER, VM_METHOD_TYPE_UNDEF, VM_METHOD_TYPE_NOTIMPLEMENTED,
  VM_METHOD_TYPE_OPTIMIZED, VM_METHOD_TYPE_MISSING, VM_METHOD_TYPE_REFINED
}
 

Functions

void rb_add_method_cfunc (VALUE klass, ID mid, VALUE(*func)(ANYARGS), int argc, rb_method_flag_t noex)
 
rb_method_entry_trb_add_method (VALUE klass, ID mid, rb_method_type_t type, void *option, rb_method_flag_t noex)
 
rb_method_entry_trb_method_entry (VALUE klass, ID id, VALUE *define_class_ptr)
 
void rb_add_refined_method_entry (VALUE refined_class, ID mid)
 
rb_method_entry_trb_resolve_refined_method (VALUE refinements, const rb_method_entry_t *me, VALUE *defined_class_ptr)
 
rb_method_entry_trb_method_entry_with_refinements (VALUE klass, ID id, VALUE *defined_class_ptr)
 
rb_method_entry_trb_method_entry_without_refinements (VALUE klass, ID id, VALUE *defined_class_ptr)
 
rb_method_entry_trb_method_entry_get_without_cache (VALUE klass, ID id, VALUE *define_class_ptr)
 
rb_method_entry_trb_method_entry_set (VALUE klass, ID mid, const rb_method_entry_t *, rb_method_flag_t noex)
 
int rb_method_entry_arity (const rb_method_entry_t *me)
 
int rb_method_entry_eq (const rb_method_entry_t *m1, const rb_method_entry_t *m2)
 
st_index_t rb_hash_method_entry (st_index_t hash, const rb_method_entry_t *me)
 
VALUE rb_method_entry_location (rb_method_entry_t *me)
 
VALUE rb_mod_method_location (VALUE mod, ID id)
 
VALUE rb_obj_method_location (VALUE obj, ID id)
 
void rb_mark_method_entry (const rb_method_entry_t *me)
 
void rb_free_method_entry (rb_method_entry_t *me)
 
void rb_sweep_method_entry (void *vm)
 
void rb_free_m_table (st_table *tbl)
 

Macro Definition Documentation

#define END_OF_ENUMERATION (   key)    END_OF_##key##_PLACEHOLDER = 0

Definition at line 18 of file method.h.

#define NOEX_SAFE (   n)    ((int)((n) >> NOEX_SAFE_SHIFT_OFFSET) & 0x0F)

Definition at line 39 of file method.h.

Referenced by rb_method_call_status(), and vm_call_method().

#define NOEX_WITH (   n,
  s 
)    (((s) << NOEX_SAFE_SHIFT_OFFSET) | (n) | (ruby_running ? 0 : NOEX_BASIC))

Definition at line 40 of file method.h.

#define NOEX_WITH_SAFE (   n)    NOEX_WITH((n), rb_safe_level())

Definition at line 41 of file method.h.

Referenced by make_method_entry_refined(), and rb_method_entry_make().

#define UNDEFINED_METHOD_ENTRY_P (   me)    (!(me) || !(me)->def || (me)->def->type == VM_METHOD_TYPE_UNDEF)

Typedef Documentation

typedef struct rb_iseq_struct rb_iseq_t

Definition at line 74 of file method.h.

Enumeration Type Documentation

Enumerator
NOEX_PUBLIC 
NOEX_NOSUPER 
NOEX_PRIVATE 
NOEX_PROTECTED 
NOEX_MASK 
NOEX_BASIC 
NOEX_UNDEF 
NOEX_MODFUNC 
NOEX_SUPER 
NOEX_VCALL 
NOEX_RESPONDS 
NOEX_BIT_WIDTH 
NOEX_SAFE_SHIFT_OFFSET 

Definition at line 22 of file method.h.

Enumerator
VM_METHOD_TYPE_ISEQ 
VM_METHOD_TYPE_CFUNC 
VM_METHOD_TYPE_ATTRSET 
VM_METHOD_TYPE_IVAR 
VM_METHOD_TYPE_BMETHOD 
VM_METHOD_TYPE_ZSUPER 
VM_METHOD_TYPE_UNDEF 
VM_METHOD_TYPE_NOTIMPLEMENTED 
VM_METHOD_TYPE_OPTIMIZED 
VM_METHOD_TYPE_MISSING 
VM_METHOD_TYPE_REFINED 

Definition at line 45 of file method.h.

Function Documentation

rb_method_entry_t* rb_add_method ( VALUE  klass,
ID  mid,
rb_method_type_t  type,
void option,
rb_method_flag_t  noex 
)
void rb_add_method_cfunc ( VALUE  klass,
ID  mid,
VALUE(*)(ANYARGS func,
int  argc,
rb_method_flag_t  noex 
)
void rb_add_refined_method_entry ( VALUE  refined_class,
ID  mid 
)
void rb_free_m_table ( st_table tbl)

Definition at line 800 of file gc.c.

References free_method_entry_i(), st_foreach(), and st_free_table().

Referenced by obj_free(), and rb_mod_init_copy().

void rb_free_method_entry ( rb_method_entry_t me)
st_index_t rb_hash_method_entry ( st_index_t  hash,
const rb_method_entry_t me 
)

Definition at line 1197 of file vm_method.c.

References rb_method_entry_struct::def, and rb_hash_method_definition().

Referenced by method_hash().

void rb_mark_method_entry ( const rb_method_entry_t me)

Definition at line 2449 of file gc.c.

References mark_method_entry().

Referenced by bm_mark(), rb_gc_mark_unlinked_live_method_entries(), and rb_thread_mark().

rb_method_entry_t* rb_method_entry ( VALUE  klass,
ID  id,
VALUE define_class_ptr 
)
int rb_method_entry_arity ( const rb_method_entry_t me)

Definition at line 1743 of file proc.c.

References max(), min(), and rb_method_entry_min_max_arity().

Referenced by check_funcall_respond_to(), method_arity(), and rb_mod_method_arity().

int rb_method_entry_eq ( const rb_method_entry_t m1,
const rb_method_entry_t m2 
)

Definition at line 1115 of file vm_method.c.

References rb_method_entry_struct::def, and rb_method_definition_eq().

Referenced by method_eq().

rb_method_entry_t* rb_method_entry_get_without_cache ( VALUE  klass,
ID  id,
VALUE define_class_ptr 
)
VALUE rb_method_entry_location ( rb_method_entry_t me)

Definition at line 1876 of file proc.c.

References rb_method_entry_struct::def, method_def_location(), and Qnil.

Referenced by rb_mod_method_location().

rb_method_entry_t* rb_method_entry_set ( VALUE  klass,
ID  mid,
const rb_method_entry_t ,
rb_method_flag_t  noex 
)

Definition at line 478 of file vm_method.c.

References method_entry_set().

Referenced by clone_method(), rb_mod_define_method(), and rb_mod_modfunc().

rb_method_entry_t* rb_method_entry_with_refinements ( VALUE  klass,
ID  id,
VALUE defined_class_ptr 
)
rb_method_entry_t* rb_method_entry_without_refinements ( VALUE  klass,
ID  id,
VALUE defined_class_ptr 
)
VALUE rb_mod_method_location ( VALUE  mod,
ID  id 
)
VALUE rb_obj_method_location ( VALUE  obj,
ID  id 
)

Definition at line 1890 of file proc.c.

References CLASS_OF, and rb_mod_method_location().

rb_method_entry_t* rb_resolve_refined_method ( VALUE  refinements,
const rb_method_entry_t me,
VALUE defined_class_ptr 
)
void rb_sweep_method_entry ( void vm)