Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
M
mruby
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
mruby
Commits
afee618c
Commit
afee618c
authored
Nov 27, 2016
by
Herwin Weststrate
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added documentation on function for globals
parent
72915cab
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
58 additions
and
0 deletions
+58
-0
include/mruby/variable.h
include/mruby/variable.h
+58
-0
No files found.
include/mruby/variable.h
View file @
afee618c
...
...
@@ -54,9 +54,67 @@ 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_cstr(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_cstr(mrb, "$value");
* mrb_gv_set(mrb, sym, mrb_str_new_cstr("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
* # Ruby style
* $value = nil
*
* !!!c
* // C style
* mrb_sym sym = mrb_intern_cstr(mrb, "$value");
* mrb_gv_remove(mrb, sym);
*
* @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_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
);
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment