103 lines
3.1 KiB
C
103 lines
3.1 KiB
C
/**
|
|
** @file mruby/variable.h - mruby variables
|
|
**
|
|
** See Copyright Notice in mruby.h
|
|
*/
|
|
|
|
#ifndef MRUBY_VARIABLE_H
|
|
#define MRUBY_VARIABLE_H
|
|
|
|
#include "common.h"
|
|
|
|
/**
|
|
* Functions to access mruby variables.
|
|
*/
|
|
MRB_BEGIN_DECL
|
|
|
|
MRB_API mrb_value mrb_const_get(mrb_state*, mrb_value, mrb_sym);
|
|
MRB_API void mrb_const_set(mrb_state*, mrb_value, mrb_sym, mrb_value);
|
|
MRB_API mrb_bool mrb_const_defined(mrb_state*, mrb_value, mrb_sym);
|
|
MRB_API void mrb_const_remove(mrb_state*, mrb_value, mrb_sym);
|
|
|
|
MRB_API mrb_bool mrb_iv_name_sym_p(mrb_state *mrb, mrb_sym sym);
|
|
MRB_API void mrb_iv_name_sym_check(mrb_state *mrb, mrb_sym sym);
|
|
MRB_API mrb_value mrb_obj_iv_get(mrb_state *mrb, struct RObject *obj, mrb_sym sym);
|
|
MRB_API void mrb_obj_iv_set(mrb_state *mrb, struct RObject *obj, mrb_sym sym, mrb_value v);
|
|
MRB_API mrb_bool mrb_obj_iv_defined(mrb_state *mrb, struct RObject *obj, mrb_sym sym);
|
|
MRB_API mrb_value mrb_iv_get(mrb_state *mrb, mrb_value obj, mrb_sym sym);
|
|
MRB_API void mrb_iv_set(mrb_state *mrb, mrb_value obj, mrb_sym sym, mrb_value v);
|
|
MRB_API mrb_bool mrb_iv_defined(mrb_state*, mrb_value, mrb_sym);
|
|
MRB_API mrb_value mrb_iv_remove(mrb_state *mrb, mrb_value obj, mrb_sym sym);
|
|
MRB_API void mrb_iv_copy(mrb_state *mrb, mrb_value dst, mrb_value src);
|
|
MRB_API mrb_bool mrb_const_defined_at(mrb_state *mrb, mrb_value mod, mrb_sym id);
|
|
|
|
/**
|
|
* Get a global variable. Will return nil if the var does not exist
|
|
*
|
|
* Example:
|
|
*
|
|
* !!!ruby
|
|
* # Ruby style
|
|
* var = $value
|
|
*
|
|
* !!!c
|
|
* // C style
|
|
* mrb_sym sym = mrb_intern_lit(mrb, "$value");
|
|
* mrb_value var = mrb_gv_get(mrb, sym);
|
|
*
|
|
* @param mrb The mruby state reference
|
|
* @param sym The name of the global variable
|
|
* @return The value of that global variable. May be nil
|
|
*/
|
|
MRB_API mrb_value mrb_gv_get(mrb_state *mrb, mrb_sym sym);
|
|
|
|
/**
|
|
* Set a global variable
|
|
*
|
|
* Example:
|
|
*
|
|
* !!!ruby
|
|
* # Ruby style
|
|
* $value = "foo"
|
|
*
|
|
* !!!c
|
|
* // C style
|
|
* mrb_sym sym = mrb_intern_lit(mrb, "$value");
|
|
* mrb_gv_set(mrb, sym, mrb_str_new_lit("foo"));
|
|
*
|
|
* @param mrb The mruby state reference
|
|
* @param sym The name of the global variable
|
|
* @param val The value of the global variable
|
|
*/
|
|
MRB_API void mrb_gv_set(mrb_state *mrb, mrb_sym sym, mrb_value val);
|
|
|
|
/**
|
|
* Remove a global variable.
|
|
*
|
|
* Example:
|
|
*
|
|
* # Ruby style
|
|
* $value = nil
|
|
*
|
|
* // C style
|
|
* mrb_sym sym = mrb_intern_lit(mrb, "$value");
|
|
* mrb_gv_remove(mrb, sym);
|
|
*
|
|
* @param mrb The mruby state reference
|
|
* @param sym The name of the global variable
|
|
*/
|
|
MRB_API void mrb_gv_remove(mrb_state *mrb, mrb_sym sym);
|
|
|
|
MRB_API mrb_value mrb_cv_get(mrb_state *mrb, mrb_value mod, mrb_sym sym);
|
|
MRB_API void mrb_mod_cv_set(mrb_state *mrb, struct RClass * c, mrb_sym sym, mrb_value v);
|
|
MRB_API void mrb_cv_set(mrb_state *mrb, mrb_value mod, mrb_sym sym, mrb_value v);
|
|
MRB_API mrb_bool mrb_cv_defined(mrb_state *mrb, mrb_value mod, mrb_sym sym);
|
|
|
|
/* return non zero to break the loop */
|
|
typedef int (mrb_iv_foreach_func)(mrb_state*,mrb_sym,mrb_value,void*);
|
|
MRB_API void mrb_iv_foreach(mrb_state *mrb, mrb_value obj, mrb_iv_foreach_func *func, void *p);
|
|
|
|
MRB_END_DECL
|
|
|
|
#endif /* MRUBY_VARIABLE_H */
|