summaryrefslogtreecommitdiffhomepage
path: root/doc/api/mruby/value.h.md
blob: fbf2dadf127201f824cb48126409629c1a71262c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
### mrb_float_value
```C
static inline mrb_value mrb_float_value(struct mrb_state *mrb, mrb_float f)
```

Returns a float in Ruby.

##### Example

In this example we read from a Ruby file inside C. The Ruby code will print what you pass as an argument 
and what class the passed in value is. In this case we are passing in mrb_float f = 0.09. Alternatively 
double i = 0.09 could also be used.


example.c
```C
#include <stdio.h>
#include <mruby.h>
#include "mruby/compile.h"
#include "mruby/string.h"

int
main(void)
{
  mrb_float f = 0.09;// or double i = 0.09;
  mrb_state *mrb = mrb_open();
  if (!mrb) { /* handle error */ }
  FILE *fp = fopen("test.rb","r");
  mrb_value obj = mrb_load_file(mrb,fp);
  mrb_funcall(mrb, obj, "method_name", 1, mrb_float_value(mrb, f));
  fclose(fp);
  mrb_close(mrb);
  return 0;
}

```

test.rb
```Ruby
class My_Class
  def method_name(s)
    puts s
    puts s.class
  end
end
a = My_Class.new
```

### mrb_fixnum_value

```C
static inline mrb_value mrb_fixnum_value(mrb_int i)
```

Returns a fixnum in Ruby.

##### Example

In this example we read from a Ruby file inside C. The Ruby code will print what you pass as an argument 
and what class the passed in value is. In this case we are passing in mrb_int i = 99. Alternativly int i = 99
could also be used.


example.c
```C
#include <stdio.h>
#include <mruby.h>
#include "mruby/compile.h"

int
main(void)
{
  mrb_int i = 99; // or int i = 99;
  mrb_state *mrb = mrb_open();
  if (!mrb) { /* handle error */ }
  FILE *fp = fopen("test.rb","r");
  mrb_value obj = mrb_load_file(mrb,fp);
  mrb_funcall(mrb, obj, "method_name", 1, mrb_fixnum_value(i));
  fclose(fp);
  mrb_close(mrb);
  return 0;
}

```

test.rb
```Ruby
class My_Class
  def method_name(s)
    puts s
    puts s.class
  end
end
a = My_Class.new
```



### mrb_nil_value

```C
static inline mrb_value mrb_nil_value(void)
```

Returns nil in Ruby.

##### Example

In this example we read from a Ruby file inside C. The Ruby code will print what you pass as an argument 
and what class the passed in value is. In this case we are passing in nothing and we will get NillClass.


example.c
```C
#include <stdio.h>
#include <mruby.h>
#include "mruby/compile.h"

int
main(void)
{
  mrb_state *mrb = mrb_open();
  if (!mrb) { /* handle error */ }
  FILE *fp = fopen("test.rb","r");
  mrb_value obj = mrb_load_file(mrb,fp);
  mrb_funcall(mrb, obj, "method_name", 1, mrb_nil_value());
  fclose(fp);
  mrb_close(mrb);
  return 0;
}

```

test.rb
```Ruby
class My_Class
  def method_name(s)
    puts s
    puts s.class
  end
end
a = My_Class.new
```


### mrb_false_value

```C
static inline mrb_value mrb_false_value(void)
```

Returns false in Ruby.

##### Example

In this example we read from a Ruby file inside C. The Ruby code will print what you pass as an argument 
and what class the passed in value is. In this case we are passing in nothing and we will get FalseClass.


example.c
```C
#include <stdio.h>
#include <mruby.h>
#include "mruby/compile.h"

int
main(void)
{
  mrb_state *mrb = mrb_open();
  if (!mrb) { /* handle error */ }
  FILE *fp = fopen("test.rb","r");
  mrb_value obj = mrb_load_file(mrb,fp);
  mrb_funcall(mrb, obj, "method_name", 1, mrb_false_value());
  fclose(fp);
  mrb_close(mrb);
  return 0;
}

```

test.rb
```Ruby
class My_Class
  def method_name(s)
    puts s
    puts s.class
  end
end
a = My_Class.new
```



### mrb_true_value

```C
static inline mrb_value mrb_true_value(void)
```

Returns true in Ruby.

##### Example

In this example we read from a Ruby file inside C. The Ruby code will print what you pass as an argument 
and what class the passed in value is. In this case we are passing in nothing and we will get TrueClass.


example.c
```C
#include <stdio.h>
#include <mruby.h>
#include "mruby/compile.h"

int
main(void)
{
  mrb_state *mrb = mrb_open();
  if (!mrb) { /* handle error */ }
  FILE *fp = fopen("test.rb","r");
  mrb_value obj = mrb_load_file(mrb,fp);
  mrb_funcall(mrb, obj, "method_name", 1, mrb_true_value());
  fclose(fp);
  mrb_close(mrb);
  return 0;
}

```

test.rb
```Ruby
class My_Class
  def method_name(s)
    puts s
    puts s.class
  end
end
a = My_Class.new
```