2 ** object.c - Object, NilClass, TrueClass, FalseClass class
4 ** See Copyright Notice in mruby.h
8 #include <mruby/class.h>
9 #include <mruby/numeric.h>
10 #include <mruby/string.h>
11 #include <mruby/class.h>
14 mrb_obj_eq(mrb_state *mrb, mrb_value v1, mrb_value v2)
16 if (mrb_type(v1) != mrb_type(v2)) return FALSE;
17 switch (mrb_type(v1)) {
23 return (mrb_fixnum(v1) == mrb_fixnum(v2));
25 return (mrb_symbol(v1) == mrb_symbol(v2));
27 #ifndef MRB_WITHOUT_FLOAT
29 return (mrb_float(v1) == mrb_float(v2));
33 return (mrb_ptr(v1) == mrb_ptr(v2));
38 mrb_obj_equal(mrb_state *mrb, mrb_value v1, mrb_value v2)
40 /* temporary definition */
41 return mrb_obj_eq(mrb, v1, v2);
45 mrb_equal(mrb_state *mrb, mrb_value obj1, mrb_value obj2)
49 if (mrb_obj_eq(mrb, obj1, obj2)) return TRUE;
50 result = mrb_funcall(mrb, obj1, "==", 1, obj2);
51 if (mrb_test(result)) return TRUE;
56 * Document-class: NilClass
58 * The class of the singleton object <code>nil</code>.
66 * Only the object <i>nil</i> responds <code>true</code> to <code>nil?</code>.
70 mrb_true(mrb_state *mrb, mrb_value obj)
72 return mrb_true_value();
80 * Always returns the empty string.
84 nil_to_s(mrb_state *mrb, mrb_value obj)
86 return mrb_str_new(mrb, 0, 0);
90 nil_inspect(mrb_state *mrb, mrb_value obj)
92 return mrb_str_new_lit(mrb, "nil");
95 /***********************************************************************
96 * Document-class: TrueClass
98 * The global value <code>true</code> is the only instance of class
99 * <code>TrueClass</code> and represents a logically true value in
100 * boolean expressions. The class provides operators allowing
101 * <code>true</code> to be used in logical expressions.
107 * true & obj -> true or false
109 * And---Returns <code>false</code> if <i>obj</i> is
110 * <code>nil</code> or <code>false</code>, <code>true</code> otherwise.
114 true_and(mrb_state *mrb, mrb_value obj)
118 mrb_get_args(mrb, "b", &obj2);
120 return mrb_bool_value(obj2);
128 * Exclusive Or---Returns <code>true</code> if <i>obj</i> is
129 * <code>nil</code> or <code>false</code>, <code>false</code>
134 true_xor(mrb_state *mrb, mrb_value obj)
138 mrb_get_args(mrb, "b", &obj2);
139 return mrb_bool_value(!obj2);
145 * true.to_s -> "true"
147 * The string representation of <code>true</code> is "true".
151 true_to_s(mrb_state *mrb, mrb_value obj)
153 return mrb_str_new_lit(mrb, "true");
161 * Or---Returns <code>true</code>. As <i>anObject</i> is an argument to
162 * a method call, it is always evaluated; there is no short-circuit
163 * evaluation in this case.
166 * true || puts("logical or")
174 true_or(mrb_state *mrb, mrb_value obj)
176 return mrb_true_value();
180 * Document-class: FalseClass
182 * The global value <code>false</code> is the only instance of class
183 * <code>FalseClass</code> and represents a logically false value in
184 * boolean expressions. The class provides operators allowing
185 * <code>false</code> to participate correctly in logical expressions.
193 * false & obj -> false
196 * And---Returns <code>false</code>. <i>obj</i> is always
197 * evaluated as it is the argument to a method call---there is no
198 * short-circuit evaluation in this case.
202 false_and(mrb_state *mrb, mrb_value obj)
204 return mrb_false_value();
211 * false ^ obj -> true or false
212 * nil ^ obj -> true or false
214 * Exclusive Or---If <i>obj</i> is <code>nil</code> or
215 * <code>false</code>, returns <code>false</code>; otherwise, returns
221 false_xor(mrb_state *mrb, mrb_value obj)
225 mrb_get_args(mrb, "b", &obj2);
226 return mrb_bool_value(obj2);
233 * false | obj -> true or false
234 * nil | obj -> true or false
236 * Or---Returns <code>false</code> if <i>obj</i> is
237 * <code>nil</code> or <code>false</code>; <code>true</code> otherwise.
241 false_or(mrb_state *mrb, mrb_value obj)
245 mrb_get_args(mrb, "b", &obj2);
246 return mrb_bool_value(obj2);
252 * false.to_s -> "false"
258 false_to_s(mrb_state *mrb, mrb_value obj)
260 return mrb_str_new_lit(mrb, "false");
264 mrb_init_object(mrb_state *mrb)
270 mrb->nil_class = n = mrb_define_class(mrb, "NilClass", mrb->object_class);
271 MRB_SET_INSTANCE_TT(n, MRB_TT_TRUE);
272 mrb_undef_class_method(mrb, n, "new");
273 mrb_define_method(mrb, n, "&", false_and, MRB_ARGS_REQ(1)); /* 15.2.4.3.1 */
274 mrb_define_method(mrb, n, "^", false_xor, MRB_ARGS_REQ(1)); /* 15.2.4.3.2 */
275 mrb_define_method(mrb, n, "|", false_or, MRB_ARGS_REQ(1)); /* 15.2.4.3.3 */
276 mrb_define_method(mrb, n, "nil?", mrb_true, MRB_ARGS_NONE()); /* 15.2.4.3.4 */
277 mrb_define_method(mrb, n, "to_s", nil_to_s, MRB_ARGS_NONE()); /* 15.2.4.3.5 */
278 mrb_define_method(mrb, n, "inspect", nil_inspect, MRB_ARGS_NONE());
280 mrb->true_class = t = mrb_define_class(mrb, "TrueClass", mrb->object_class);
281 MRB_SET_INSTANCE_TT(t, MRB_TT_TRUE);
282 mrb_undef_class_method(mrb, t, "new");
283 mrb_define_method(mrb, t, "&", true_and, MRB_ARGS_REQ(1)); /* 15.2.5.3.1 */
284 mrb_define_method(mrb, t, "^", true_xor, MRB_ARGS_REQ(1)); /* 15.2.5.3.2 */
285 mrb_define_method(mrb, t, "to_s", true_to_s, MRB_ARGS_NONE()); /* 15.2.5.3.3 */
286 mrb_define_method(mrb, t, "|", true_or, MRB_ARGS_REQ(1)); /* 15.2.5.3.4 */
287 mrb_define_method(mrb, t, "inspect", true_to_s, MRB_ARGS_NONE());
289 mrb->false_class = f = mrb_define_class(mrb, "FalseClass", mrb->object_class);
290 MRB_SET_INSTANCE_TT(f, MRB_TT_TRUE);
291 mrb_undef_class_method(mrb, f, "new");
292 mrb_define_method(mrb, f, "&", false_and, MRB_ARGS_REQ(1)); /* 15.2.6.3.1 */
293 mrb_define_method(mrb, f, "^", false_xor, MRB_ARGS_REQ(1)); /* 15.2.6.3.2 */
294 mrb_define_method(mrb, f, "to_s", false_to_s, MRB_ARGS_NONE()); /* 15.2.6.3.3 */
295 mrb_define_method(mrb, f, "|", false_or, MRB_ARGS_REQ(1)); /* 15.2.6.3.4 */
296 mrb_define_method(mrb, f, "inspect", false_to_s, MRB_ARGS_NONE());
300 inspect_type(mrb_state *mrb, mrb_value val)
302 if (mrb_type(val) == MRB_TT_FALSE || mrb_type(val) == MRB_TT_TRUE) {
303 return mrb_inspect(mrb, val);
306 return mrb_str_new_cstr(mrb, mrb_obj_classname(mrb, val));
311 convert_type(mrb_state *mrb, mrb_value val, const char *tname, const char *method, mrb_bool raise)
315 m = mrb_intern_cstr(mrb, method);
316 if (!mrb_respond_to(mrb, val, m)) {
318 mrb_raisef(mrb, E_TYPE_ERROR, "can't convert %S into %S", inspect_type(mrb, val), mrb_str_new_cstr(mrb, tname));
320 return mrb_nil_value();
322 return mrb_funcall_argv(mrb, val, m, 0, 0);
326 mrb_convert_type(mrb_state *mrb, mrb_value val, enum mrb_vtype type, const char *tname, const char *method)
330 if (mrb_type(val) == type) return val;
331 v = convert_type(mrb, val, tname, method, TRUE);
332 if (mrb_type(v) != type) {
333 mrb_raisef(mrb, E_TYPE_ERROR, "%S cannot be converted to %S by #%S", val,
334 mrb_str_new_cstr(mrb, tname), mrb_str_new_cstr(mrb, method));
340 mrb_check_convert_type(mrb_state *mrb, mrb_value val, enum mrb_vtype type, const char *tname, const char *method)
344 if (mrb_type(val) == type && type != MRB_TT_DATA && type != MRB_TT_ISTRUCT) return val;
345 v = convert_type(mrb, val, tname, method, FALSE);
346 if (mrb_nil_p(v) || mrb_type(v) != type) return mrb_nil_value();
350 static const struct types {
353 } builtin_types[] = {
354 /* {MRB_TT_NIL, "nil"}, */
355 {MRB_TT_FALSE, "false"},
356 {MRB_TT_TRUE, "true"},
357 {MRB_TT_FIXNUM, "Fixnum"},
358 {MRB_TT_SYMBOL, "Symbol"}, /* :symbol */
359 {MRB_TT_MODULE, "Module"},
360 {MRB_TT_OBJECT, "Object"},
361 {MRB_TT_CLASS, "Class"},
362 {MRB_TT_ICLASS, "iClass"}, /* internal use: mixed-in module holder */
363 {MRB_TT_SCLASS, "SClass"},
364 {MRB_TT_PROC, "Proc"},
365 #ifndef MRB_WITHOUT_FLOAT
366 {MRB_TT_FLOAT, "Float"},
368 {MRB_TT_ARRAY, "Array"},
369 {MRB_TT_HASH, "Hash"},
370 {MRB_TT_STRING, "String"},
371 {MRB_TT_RANGE, "Range"},
372 /* {MRB_TT_BIGNUM, "Bignum"}, */
373 {MRB_TT_FILE, "File"},
374 {MRB_TT_DATA, "Data"}, /* internal use: wrapped C pointers */
375 /* {MRB_TT_VARMAP, "Varmap"}, */ /* internal use: dynamic variables */
376 /* {MRB_TT_NODE, "Node"}, */ /* internal use: syntax tree node */
377 /* {MRB_TT_UNDEF, "undef"}, */ /* internal use: #undef; should not happen */
378 {MRB_TT_MAXDEFINE, 0}
382 mrb_check_type(mrb_state *mrb, mrb_value x, enum mrb_vtype t)
384 const struct types *type = builtin_types;
388 if ((xt != t) || (xt == MRB_TT_DATA) || (xt == MRB_TT_ISTRUCT)) {
389 while (type->type < MRB_TT_MAXDEFINE) {
390 if (type->type == t) {
396 else if (mrb_fixnum_p(x)) {
399 else if (mrb_type(x) == MRB_TT_SYMBOL) {
402 else if (mrb_immediate_p(x)) {
403 etype = RSTRING_PTR(mrb_obj_as_string(mrb, x));
406 etype = mrb_obj_classname(mrb, x);
408 mrb_raisef(mrb, E_TYPE_ERROR, "wrong argument type %S (expected %S)",
409 mrb_str_new_cstr(mrb, etype), mrb_str_new_cstr(mrb, type->name));
413 mrb_raisef(mrb, E_TYPE_ERROR, "unknown type %S (%S given)",
414 mrb_fixnum_value(t), mrb_fixnum_value(mrb_type(x)));
423 * Returns a string representing <i>obj</i>. The default
424 * <code>to_s</code> prints the object's class and an encoding of the
425 * object id. As a special case, the top-level object that is the
426 * initial execution context of Ruby programs returns "main."
430 mrb_any_to_s(mrb_state *mrb, mrb_value obj)
432 mrb_value str = mrb_str_new_capa(mrb, 20);
433 const char *cname = mrb_obj_classname(mrb, obj);
435 mrb_str_cat_lit(mrb, str, "#<");
436 mrb_str_cat_cstr(mrb, str, cname);
437 if (!mrb_immediate_p(obj)) {
438 mrb_str_cat_lit(mrb, str, ":");
439 mrb_str_concat(mrb, str, mrb_ptr_to_str(mrb, mrb_ptr(obj)));
441 mrb_str_cat_lit(mrb, str, ">");
448 * obj.is_a?(class) => true or false
449 * obj.kind_of?(class) => true or false
451 * Returns <code>true</code> if <i>class</i> is the class of
452 * <i>obj</i>, or if <i>class</i> is one of the superclasses of
453 * <i>obj</i> or modules included in <i>obj</i>.
462 * b.instance_of? A #=> false
463 * b.instance_of? B #=> true
464 * b.instance_of? C #=> false
465 * b.instance_of? M #=> false
466 * b.kind_of? A #=> true
467 * b.kind_of? B #=> true
468 * b.kind_of? C #=> false
469 * b.kind_of? M #=> true
473 mrb_obj_is_kind_of(mrb_state *mrb, mrb_value obj, struct RClass *c)
475 struct RClass *cl = mrb_class(mrb, obj);
485 mrb_raise(mrb, E_TYPE_ERROR, "class or module required");
490 if (cl == c || cl->mt == c->mt)
498 mrb_to_int(mrb_state *mrb, mrb_value val)
501 if (!mrb_fixnum_p(val)) {
504 #ifndef MRB_WITHOUT_FLOAT
505 if (mrb_float_p(val)) {
506 return mrb_flo_to_fixnum(mrb, val);
509 type = inspect_type(mrb, val);
510 mrb_raisef(mrb, E_TYPE_ERROR, "can't convert %S to Integer", type);
516 mrb_convert_to_integer(mrb_state *mrb, mrb_value val, mrb_int base)
520 if (mrb_nil_p(val)) {
521 if (base != 0) goto arg_error;
522 mrb_raise(mrb, E_TYPE_ERROR, "can't convert nil into Integer");
524 switch (mrb_type(val)) {
525 #ifndef MRB_WITHOUT_FLOAT
527 if (base != 0) goto arg_error;
528 return mrb_flo_to_fixnum(mrb, val);
532 if (base != 0) goto arg_error;
537 return mrb_str_to_inum(mrb, val, base, TRUE);
543 tmp = mrb_check_string_type(mrb, val);
544 if (!mrb_nil_p(tmp)) {
549 mrb_raise(mrb, E_ARGUMENT_ERROR, "base specified for non string value");
551 /* to raise TypeError */
552 return mrb_to_int(mrb, val);
556 mrb_Integer(mrb_state *mrb, mrb_value val)
558 return mrb_convert_to_integer(mrb, val, 0);
561 #ifndef MRB_WITHOUT_FLOAT
563 mrb_Float(mrb_state *mrb, mrb_value val)
565 if (mrb_nil_p(val)) {
566 mrb_raise(mrb, E_TYPE_ERROR, "can't convert nil into Float");
568 switch (mrb_type(val)) {
570 return mrb_float_value(mrb, (mrb_float)mrb_fixnum(val));
576 return mrb_float_value(mrb, mrb_str_to_dbl(mrb, val, TRUE));
579 return mrb_convert_type(mrb, val, MRB_TT_FLOAT, "Float", "to_f");
585 mrb_to_str(mrb_state *mrb, mrb_value val)
587 if (!mrb_string_p(val)) {
588 mrb_value type = inspect_type(mrb, val);
589 mrb_raisef(mrb, E_TYPE_ERROR, "can't convert %S to String", type);
594 /* obsolete: use mrb_ensure_string_type() instead */
596 mrb_string_type(mrb_state *mrb, mrb_value str)
598 return mrb_ensure_string_type(mrb, str);
602 mrb_ensure_string_type(mrb_state *mrb, mrb_value str)
604 if (!mrb_string_p(str)) {
605 mrb_raisef(mrb, E_TYPE_ERROR, "%S cannot be converted to String",
606 inspect_type(mrb, str));
612 mrb_check_string_type(mrb_state *mrb, mrb_value str)
614 if (!mrb_string_p(str)) return mrb_nil_value();
619 mrb_ensure_array_type(mrb_state *mrb, mrb_value ary)
621 if (!mrb_array_p(ary)) {
622 mrb_raisef(mrb, E_TYPE_ERROR, "%S cannot be converted to Array",
623 inspect_type(mrb, ary));
629 mrb_check_array_type(mrb_state *mrb, mrb_value ary)
631 if (!mrb_array_p(ary)) return mrb_nil_value();
636 mrb_ensure_hash_type(mrb_state *mrb, mrb_value hash)
638 if (!mrb_hash_p(hash)) {
639 mrb_raisef(mrb, E_TYPE_ERROR, "%S cannot be converted to Hash",
640 inspect_type(mrb, hash));
646 mrb_check_hash_type(mrb_state *mrb, mrb_value hash)
648 if (!mrb_hash_p(hash)) return mrb_nil_value();
653 mrb_inspect(mrb_state *mrb, mrb_value obj)
655 return mrb_obj_as_string(mrb, mrb_funcall(mrb, obj, "inspect", 0));
659 mrb_eql(mrb_state *mrb, mrb_value obj1, mrb_value obj2)
661 if (mrb_obj_eq(mrb, obj1, obj2)) return TRUE;
662 return mrb_test(mrb_funcall(mrb, obj1, "eql?", 1, obj2));