From 93aaa0673678ec53cf977ac908e962225db962cf Mon Sep 17 00:00:00 2001 From: "Ralph Desir(Mav7)" Date: Thu, 3 Sep 2015 14:16:57 -0400 Subject: Added range markdown. --- doc/api/mruby/range.h.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc/api/mruby/range.h.md (limited to 'doc') diff --git a/doc/api/mruby/range.h.md b/doc/api/mruby/range.h.md new file mode 100644 index 000000000..e69de29bb -- cgit v1.2.3 From e1beb502ab133d4bfae5fa3df856aa2b851e2655 Mon Sep 17 00:00:00 2001 From: Ralph Desir Date: Thu, 3 Sep 2015 14:19:02 -0400 Subject: Cleaned up the re.h markdown. --- doc/api/mruby/re.h.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/api/mruby/re.h.md b/doc/api/mruby/re.h.md index 01e18c6a5..f5cd2a71e 100644 --- a/doc/api/mruby/re.h.md +++ b/doc/api/mruby/re.h.md @@ -1,3 +1,3 @@ -#### Macros -### REGEXP_CLASS +### Macros +#### REGEXP_CLASS A string with the name of the REGEXP class. -- cgit v1.2.3 From 8a09515c6c7b1e8315c6b1accb92cb93d8e8138c Mon Sep 17 00:00:00 2001 From: Ralph Desir Date: Thu, 3 Sep 2015 14:20:16 -0400 Subject: Cleaned up the version.h markdown. --- doc/api/mruby/version.h.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'doc') diff --git a/doc/api/mruby/version.h.md b/doc/api/mruby/version.h.md index daf87077d..f627b1da1 100644 --- a/doc/api/mruby/version.h.md +++ b/doc/api/mruby/version.h.md @@ -1,33 +1,33 @@ -#### Macros -### MRUBY_RUBY_VERSION +### Macros +#### MRUBY_RUBY_VERSION The version of Ruby used by mruby. -### MRUBY_RUBY_ENGINE +#### MRUBY_RUBY_ENGINE Ruby engine. -### MRUBY_VERSION +#### MRUBY_VERSION The mruby version. -### MRUBY_RELEASE_MAJOR +#### MRUBY_RELEASE_MAJOR Major release version. -### MRUBY_RELEASE_MINOR +#### MRUBY_RELEASE_MINOR Minor release version. -### MRUBY_RELEASE_NO +#### MRUBY_RELEASE_NO Release number. -### MRUBY_RELEASE_DATE +#### MRUBY_RELEASE_DATE Release date as a string. -### MRUBY_RELEASE_YEAR +#### MRUBY_RELEASE_YEAR Release year. -### MRUBY_RELEASE_MONTH +#### MRUBY_RELEASE_MONTH Release month. -### MRUBY_RELEASE_DAY +#### MRUBY_RELEASE_DAY Release day. -### MRUBY_BIRTH_YEAR +#### MRUBY_BIRTH_YEAR The year mruby was first created. -### MRUBY_AUTHOR +#### MRUBY_AUTHOR Mruby's authors. -### MRB_STRINGIZE0(expr) +#### MRB_STRINGIZE0(expr) A passed in expression. -### MRB_STRINGIZE(expr) +#### MRB_STRINGIZE(expr) Passes in an expression to MRB_STRINGIZE0. -### MRUBY_DESCRIPTION +#### MRUBY_DESCRIPTION mruby's version, and release date. -### MRUBY_COPYRIGHT +#### MRUBY_COPYRIGHT mruby's copyright information. -- cgit v1.2.3 From 743432d4ecc2052f6808d1e1012eb356e85ccb1e Mon Sep 17 00:00:00 2001 From: Ralph Desir Date: Thu, 3 Sep 2015 14:52:21 -0400 Subject: Update range.h.md --- doc/api/mruby/range.h.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) (limited to 'doc') diff --git a/doc/api/mruby/range.h.md b/doc/api/mruby/range.h.md index e69de29bb..188e6ede6 100644 --- a/doc/api/mruby/range.h.md +++ b/doc/api/mruby/range.h.md @@ -0,0 +1,47 @@ +#### mrb_range_new +```C + mrb_value mrb_range_new(mrb_state*, mrb_value, mrb_value, mrb_bool); +``` +Initializes a Range. The first mrb_value being the beginning value and second being the ending value. +The third parameter is an mrb_bool value that represents the inclusion or exclusion of the last value. +If the third parameter is 0 then it includes the last value in the range. If the third parameter is 1 +then it excludes the last value in the range. +C code +```C + #include + #include + #include "mruby/range.h" // Needs the range header. + #include "mruby/compile.h" + + int main(int argc, char *argv[]) + { + mrb_int beg = 0; + mrb_int end = 2; + mrb_bool exclude = 1; + mrb_value range_obj; + mrb_state *mrb = mrb_open(); + if (!mrb) { /* handle error */ } + FILE *fp = fopen("test.rb","r"); + range_obj = mrb_range_new(mrb, mrb_fixnum_value(beg), mrb_fixnum_value(end), exclude); + mrb_value obj = mrb_load_file(mrb,fp); + mrb_funcall(mrb, obj, "method_name", 1, range_obj); + fclose(fp); + mrb_close(mrb); + return 0; + } +``` +Ruby code +```Ruby + class Example_Class + def method_name(a) + puts a + puts a.class + end + end + Example_Class.new +``` +This returns the following: +```Ruby + 0...2 + Range +``` -- cgit v1.2.3