class.c File Reference

Class related functions. More...

#include "mrubyc.h"
#include "_autogen_builtin_class.h"

Include dependency graph for class.c:

Go to the source code of this file.

Macros
#define	IS_CLASS_OR_MODULE(v)
#define	MRBC_DEFINE_BUILTIN_CLASS_TABLE

Functions
mrbc_class *	mrbc_traverse_class_tree (mrbc_class *cls, mrbc_class *nest_buf[], int *nest_idx)
mrbc_class *	mrbc_traverse_class_tree_skip (mrbc_class *nest_buf[], int *nest_idx)
static mrbc_class *	sub_define_class_or_module (struct VM *vm, const mrbc_class *outer, const char *name, mrbc_class *super, mrbc_vtype vtype)
mrbc_class *	mrbc_define_class (struct VM *vm, const char *name, mrbc_class *super)
mrbc_class *	mrbc_define_class_under (struct VM *vm, const mrbc_class *outer, const char *name, mrbc_class *super)
mrbc_class *	mrbc_define_module (struct VM *vm, const char *name)
mrbc_class *	mrbc_define_module_under (struct VM *vm, const mrbc_class *outer, const char *name)
void	mrbc_define_method (struct VM *vm, mrbc_class *cls, const char *name, mrbc_func_t cfunc)
mrbc_value	mrbc_instance_new (struct VM *vm, mrbc_class *cls, int size)
void	mrbc_instance_delete (mrbc_value *v)
int	mrbc_instance_setiv (mrbc_value *target, mrbc_sym sym_id, mrbc_value *v)
mrbc_value	mrbc_instance_getiv (mrbc_value *target, mrbc_sym sym_id)
int	mrbc_obj_is_kind_of (const mrbc_value *obj, const mrbc_class *tcls)
mrbc_class *	mrbc_find_method (mrbc_method *r_method, mrbc_class *cls, mrbc_sym sym_id)
mrbc_class *	mrbc_get_class_by_name (const char *name)
mrbc_value	mrbc_send (struct VM *vm, mrbc_value *v, int argc, mrbc_value *recv, const char *method_name, int n_params,...)
void	c_ineffect (struct VM *vm, mrbc_value v[], int argc)
int	mrbc_run_mrblib (const void *bytecode)
void	mrbc_init_class (void)
void	mrbc_init_class_c (void)
void	mrbc_init_class_mrblib (void)

Variables
mrbc_class *const	mrbc_class_tbl [MRBC_TT_MAXVAL+1]

Detailed Description

Class related functions.

Copyright (C) 2015-      Kyushu Institute of Technology.
Copyright (C) 2015-2026  Shimane IT Open-Innovation Center.
Copyright (C) 2026-      Shimane Institute for Industrial Technology.

This file is distributed under BSD 3-Clause License.

Definition in file class.c.

Macro Definition Documentation

IS_CLASS_OR_MODULE

#define IS_CLASS_OR_MODULE

(

v

)

Value:

(mrbc_type(v) == MRBC_TT_CLASS || mrbc_type(v) == MRBC_TT_MODULE)

Definition at line 29 of file class.c.

MRBC_DEFINE_BUILTIN_CLASS_TABLE

#define MRBC_DEFINE_BUILTIN_CLASS_TABLE

Definition at line 615 of file class.c.

Function Documentation

c_ineffect()

void c_ineffect	(	struct VM *	vm,
		mrbc_value	v[],
		int	argc )

(method) Ineffect operator / method

Definition at line 581 of file class.c.

mrbc_define_class()

mrbc_class * mrbc_define_class	(	struct VM *	vm,
		const char *	name,
		mrbc_class *	super )

define class

Parameters

vm	pointer to vm.
name	class name.
super	super class.

Returns

pointer to defined class.

Definition at line 191 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_define_class_under()

mrbc_class * mrbc_define_class_under	(	struct VM *	vm,
		const mrbc_class *	outer,
		const char *	name,
		mrbc_class *	super )

define nested class

Parameters

vm	pointer to vm.
outer	outer class
name	class name.
super	super class.

Returns

pointer to defined class.

Definition at line 207 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_define_method()

void mrbc_define_method	(	struct VM *	vm,
		mrbc_class *	cls,
		const char *	name,
		mrbc_func_t	cfunc )

define method.

Parameters

vm	pointer to vm.
cls	pointer to class.
name	method name.
cfunc	pointer to function.

Definition at line 249 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_define_module()

mrbc_class * mrbc_define_module	(	struct VM *	vm,
		const char *	name )

define module

Parameters

vm	pointer to vm.
name	module name.

Returns

pointer to defined module.

Definition at line 221 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_define_module_under()

mrbc_class * mrbc_define_module_under	(	struct VM *	vm,
		const mrbc_class *	outer,
		const char *	name )

define nested module

Parameters

vm	pointer to vm.
outer	outer module
name	module name.

Returns

pointer to defined module.

Definition at line 235 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_find_method()

mrbc_class * mrbc_find_method	(	mrbc_method *	r_method,
		mrbc_class *	cls,
		mrbc_sym	sym_id )

find method

Parameters

r_method	pointer to mrbc_method to return values.
cls	search class or module.
sym_id	search symbol id.

Returns

pointer to class if found, otherwise NULL.

Definition at line 417 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_get_class_by_name()

mrbc_class * mrbc_get_class_by_name

(

const char *

name

)

get class by name

Parameters

name	class name.

Returns

pointer to class object.

Definition at line 491 of file class.c.

Here is the call graph for this function:

mrbc_init_class()

void mrbc_init_class

(

void

)

initialize all classes.

Definition at line 623 of file class.c.

Here is the call graph for this function:

mrbc_init_class_c()

void mrbc_init_class_c

(

void

)

Initialize built-in classes (scheduler-related classes excluded).

Definition at line 633 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_init_class_mrblib()

void mrbc_init_class_mrblib

(

void

)

Initialize Ruby-implemented classes

Definition at line 657 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_instance_delete()

void mrbc_instance_delete

(

mrbc_value *

v

)

instance destructor

Parameters

v	pointer to target value

Definition at line 300 of file class.c.

Here is the call graph for this function:

mrbc_instance_getiv()

mrbc_value mrbc_instance_getiv	(	mrbc_value *	target,
		mrbc_sym	sym_id )

instance variable getter

Parameters

target	target object or class.
sym_id	key symbol ID.

Returns

value.

Definition at line 350 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_instance_new()

mrbc_value mrbc_instance_new	(	struct VM *	vm,
		mrbc_class *	cls,
		int	size )

instance constructor

Parameters

vm	Pointer to VM.
cls	Pointer to Class (mrbc_class).
size	size of additional data.

Returns

mrbc_instance object.

Definition at line 281 of file class.c.

Here is the caller graph for this function:

mrbc_instance_setiv()

int mrbc_instance_setiv	(	mrbc_value *	target,
		mrbc_sym	sym_id,
		mrbc_value *	v )

instance variable setter

Parameters

target	target object or class.
sym_id	key symbol ID.
v	pointer to value.

Returns

error code.

Definition at line 322 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_obj_is_kind_of()

int mrbc_obj_is_kind_of	(	const mrbc_value *	obj,
		const mrbc_class *	tcls )

Check the class is the class of object.

Parameters

obj	target object
tcls	target class

Returns

result

Definition at line 393 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_run_mrblib()

int mrbc_run_mrblib

(

const void *

bytecode

)

Run mrblib, which is mruby bytecode

Parameters

bytecode

bytecode (.mrb file)

Returns

dummy yet.

Definition at line 593 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_send()

mrbc_value mrbc_send	(	struct VM *	vm,
		mrbc_value *	v,
		int	argc,
		mrbc_value *	recv,
		const char *	method_name,
		int	n_params,
			... )

(BETA) Call any method of the object, but written by C.

Parameters

vm	pointer to vm.
v	see below example.
argc	see below example.
recv	pointer to receiver.
method_name	method name.
n_params	num of params.

Examples

// (Integer).to_s(16)
static void c_integer_to_s(struct VM *vm, mrbc_value v[], int argc)
{
  mrbc_value *recv = &v[1];   // expect Integer.
  mrbc_value arg1 = mrbc_integer_value(16);
  mrbc_value ret = mrbc_send( vm, v, argc, recv, "to_s", 1, &arg1 );
  SET_RETURN(ret);
}

Definition at line 526 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_traverse_class_tree()

mrbc_class * mrbc_traverse_class_tree	(	mrbc_class *	cls,
		mrbc_class *	nest_buf[],
		int *	nest_idx )

(internal use) traverse class tree.

Parameters

cls	target class
nest_buf	nest buffer
nest_idx	nest buffer index

Returns

mrbc_class * next target class or NULL

Definition at line 80 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

mrbc_traverse_class_tree_skip()

mrbc_class * mrbc_traverse_class_tree_skip	(	mrbc_class *	nest_buf[],
		int *	nest_idx )

(internal use) traverse class tree. skip that class.

Parameters

nest_buf	nest buffer
nest_idx	nest buffer index

Returns

mrbc_class * previous target class or NULL

Definition at line 111 of file class.c.

sub_define_class_or_module()

mrbc_class * sub_define_class_or_module ( struct VM * vm, const mrbc_class * outer, const char * name, mrbc_class * super, mrbc_vtype vtype )

static

Definition at line 121 of file class.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

mrbc_class_tbl

mrbc_class* const mrbc_class_tbl[MRBC_TT_MAXVAL+1]

Initial value:

                                 = {
  0,                            
  MRBC_CLASS(NilClass),         
  MRBC_CLASS(FalseClass),       
  MRBC_CLASS(TrueClass),        
  MRBC_CLASS(Integer),          
 
  MRBC_CLASS(Float),            
 
 
 
  MRBC_CLASS(Symbol),           
  0,                            
  0,                            
  0,                            
  MRBC_CLASS(Proc),             
  MRBC_CLASS(Array),            
 
  MRBC_CLASS(String),           
 
 
 
  MRBC_CLASS(Range),            
  MRBC_CLASS(Hash),             
  0,                            
}

Builtin class table.

Note

must be same order as mrbc_vtype.

See also

mrbc_vtype in value.h

Definition at line 42 of file class.c.