message.c 20.8 KB
Newer Older
Chris Fallin's avatar
Chris Fallin committed
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
// Protocol Buffers - Google's data interchange format
// Copyright 2014 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "protobuf.h"

// -----------------------------------------------------------------------------
// Class/module creation from msgdefs and enumdefs, respectively.
// -----------------------------------------------------------------------------

void* Message_data(void* msg) {
  return ((uint8_t *)msg) + sizeof(MessageHeader);
}

void Message_mark(void* _self) {
  MessageHeader* self = (MessageHeader *)_self;
  layout_mark(self->descriptor->layout, Message_data(self));
}

void Message_free(void* self) {
47 48 49 50 51
  stringsink* unknown = ((MessageHeader *)self)->unknown_fields;
  if (unknown != NULL) {
    stringsink_uninit(unknown);
    free(unknown);
  }
Chris Fallin's avatar
Chris Fallin committed
52 53 54 55 56 57 58 59 60
  xfree(self);
}

rb_data_type_t Message_type = {
  "Message",
  { Message_mark, Message_free, NULL },
};

VALUE Message_alloc(VALUE klass) {
61
  VALUE descriptor = rb_ivar_get(klass, descriptor_instancevar_interned);
Chris Fallin's avatar
Chris Fallin committed
62 63 64
  Descriptor* desc = ruby_to_Descriptor(descriptor);
  MessageHeader* msg = (MessageHeader*)ALLOC_N(
      uint8_t, sizeof(MessageHeader) + desc->layout->size);
65 66
  VALUE ret;

Chris Fallin's avatar
Chris Fallin committed
67 68 69 70
  memset(Message_data(msg), 0, desc->layout->size);

  // We wrap first so that everything in the message object is GC-rooted in case
  // a collection happens during object creation in layout_init().
71
  ret = TypedData_Wrap_Struct(klass, &Message_type, msg);
Chris Fallin's avatar
Chris Fallin committed
72
  msg->descriptor = desc;
73
  rb_ivar_set(ret, descriptor_instancevar_interned, descriptor);
Chris Fallin's avatar
Chris Fallin committed
74

75 76
  msg->unknown_fields = NULL;

Chris Fallin's avatar
Chris Fallin committed
77 78 79 80 81
  layout_init(desc->layout, Message_data(msg));

  return ret;
}

82
static VALUE which_oneof_field(MessageHeader* self, const upb_oneofdef* o) {
83 84 85 86 87 88
  upb_oneof_iter it;
  size_t case_ofs;
  uint32_t oneof_case;
  const upb_fielddef* first_field;
  const upb_fielddef* f;

89 90 91 92 93 94 95 96
  // If no fields in the oneof, always nil.
  if (upb_oneofdef_numfields(o) == 0) {
    return Qnil;
  }
  // Grab the first field in the oneof so we can get its layout info to find the
  // oneof_case field.
  upb_oneof_begin(&it, o);
  assert(!upb_oneof_done(&it));
97
  first_field = upb_oneof_iter_field(&it);
98 99
  assert(upb_fielddef_containingoneof(first_field) != NULL);

100
  case_ofs =
101 102
      self->descriptor->layout->
      fields[upb_fielddef_index(first_field)].case_offset;
103
  oneof_case = *((uint32_t*)((char*)Message_data(self) + case_ofs));
104

105
  if (oneof_case == ONEOF_CASE_NONE) {
106 107 108 109
    return Qnil;
  }

  // oneof_case is a field index, so find that field.
110
  f = upb_oneofdef_itof(o, oneof_case);
111 112 113 114 115
  assert(f != NULL);

  return ID2SYM(rb_intern(upb_fielddef_name(f)));
}

Chris Fallin's avatar
Chris Fallin committed
116 117 118 119 120 121 122 123 124 125 126 127
/*
 * call-seq:
 *     Message.method_missing(*args)
 *
 * Provides accessors and setters for message fields according to their field
 * names. For any field whose name does not conflict with a built-in method, an
 * accessor is provided with the same name as the field, and a setter is
 * provided with the name of the field plus the '=' suffix. Thus, given a
 * message instance 'msg' with field 'foo', the following code is valid:
 *
 *     msg.foo = 42
 *     puts msg.foo
128 129 130 131
 *
 * This method also provides read-only accessors for oneofs. If a oneof exists
 * with name 'my_oneof', then msg.my_oneof will return a Ruby symbol equal to
 * the name of the field in that oneof that is currently set, or nil if none.
Chris Fallin's avatar
Chris Fallin committed
132 133 134
 */
VALUE Message_method_missing(int argc, VALUE* argv, VALUE _self) {
  MessageHeader* self;
135 136 137 138 139 140 141
  VALUE method_name, method_str;
  char* name;
  size_t name_len;
  bool setter;
  const upb_oneofdef* o;
  const upb_fielddef* f;

Chris Fallin's avatar
Chris Fallin committed
142 143 144 145
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);
  if (argc < 1) {
    rb_raise(rb_eArgError, "Expected method name as first argument.");
  }
146
  method_name = argv[0];
Chris Fallin's avatar
Chris Fallin committed
147 148 149
  if (!SYMBOL_P(method_name)) {
    rb_raise(rb_eArgError, "Expected symbol as method name.");
  }
150 151 152 153
  method_str = rb_id2str(SYM2ID(method_name));
  name = RSTRING_PTR(method_str);
  name_len = RSTRING_LEN(method_str);
  setter = false;
Chris Fallin's avatar
Chris Fallin committed
154 155 156 157 158 159 160

  // Setters have names that end in '='.
  if (name[name_len - 1] == '=') {
    setter = true;
    name_len--;
  }

161 162 163 164 165 166
  // See if this name corresponds to either a oneof or field in this message.
  if (!upb_msgdef_lookupname(self->descriptor->msgdef, name, name_len, &f,
                             &o)) {
    return rb_call_super(argc, argv);
  }

167
  if (o != NULL) {
168
    // This is a oneof -- return which field inside the oneof is set.
169 170 171 172
    if (setter) {
      rb_raise(rb_eRuntimeError, "Oneof accessors are read-only.");
    }
    return which_oneof_field(self, o);
Chris Fallin's avatar
Chris Fallin committed
173
  } else {
174 175 176 177 178 179 180 181 182 183 184
    // This is a field -- get or set the field's value.
    assert(f);
    if (setter) {
      if (argc < 2) {
        rb_raise(rb_eArgError, "No value provided to setter.");
      }
      layout_set(self->descriptor->layout, Message_data(self), f, argv[1]);
      return Qnil;
    } else {
      return layout_get(self->descriptor->layout, Message_data(self), f);
    }
Chris Fallin's avatar
Chris Fallin committed
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
VALUE Message_respond_to_missing(int argc, VALUE* argv, VALUE _self) {
  MessageHeader* self;
  VALUE method_name, method_str;
  char* name;
  size_t name_len;
  bool setter;
  const upb_oneofdef* o;
  const upb_fielddef* f;

  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);
  if (argc < 1) {
    rb_raise(rb_eArgError, "Expected method name as first argument.");
  }
  method_name = argv[0];
  if (!SYMBOL_P(method_name)) {
    rb_raise(rb_eArgError, "Expected symbol as method name.");
  }
  method_str = rb_id2str(SYM2ID(method_name));
  name = RSTRING_PTR(method_str);
  name_len = RSTRING_LEN(method_str);
  setter = false;

  // Setters have names that end in '='.
  if (name[name_len - 1] == '=') {
    setter = true;
    name_len--;
  }

  // See if this name corresponds to either a oneof or field in this message.
  if (!upb_msgdef_lookupname(self->descriptor->msgdef, name, name_len, &f,
                             &o)) {
    return rb_call_super(argc, argv);
  }
  if (o != NULL) {
    return setter ? Qfalse : Qtrue;
  }
  return Qtrue;
}

227 228 229 230 231 232 233 234 235 236 237
VALUE create_submsg_from_hash(const upb_fielddef *f, VALUE hash) {
  const upb_def *d = upb_fielddef_subdef(f);
  assert(d != NULL);

  VALUE descriptor = get_def_obj(d);
  VALUE msgclass = rb_funcall(descriptor, rb_intern("msgclass"), 0, NULL);

  VALUE args[1] = { hash };
  return rb_class_new_instance(1, args, msgclass);
}

Chris Fallin's avatar
Chris Fallin committed
238 239
int Message_initialize_kwarg(VALUE key, VALUE val, VALUE _self) {
  MessageHeader* self;
240
  char *name;
241
  const upb_fielddef* f;
Chris Fallin's avatar
Chris Fallin committed
242 243
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);

244 245 246 247 248
  if (TYPE(key) == T_STRING) {
    name = RSTRING_PTR(key);
  } else if (TYPE(key) == T_SYMBOL) {
    name = RSTRING_PTR(rb_id2str(SYM2ID(key)));
  } else {
Chris Fallin's avatar
Chris Fallin committed
249
    rb_raise(rb_eArgError,
250
             "Expected string or symbols as hash keys when initializing proto from hash.");
Chris Fallin's avatar
Chris Fallin committed
251 252
  }

253
  f = upb_msgdef_ntofz(self->descriptor->msgdef, name);
Chris Fallin's avatar
Chris Fallin committed
254 255
  if (f == NULL) {
    rb_raise(rb_eArgError,
256
             "Unknown field name '%s' in initialization map entry.", name);
Chris Fallin's avatar
Chris Fallin committed
257 258
  }

259
  if (is_map_field(f)) {
260 261
    VALUE map;

262 263
    if (TYPE(val) != T_HASH) {
      rb_raise(rb_eArgError,
264
               "Expected Hash object as initializer value for map field '%s'.", name);
265
    }
266
    map = layout_get(self->descriptor->layout, Message_data(self), f);
267 268
    Map_merge_into_self(map, val);
  } else if (upb_fielddef_label(f) == UPB_LABEL_REPEATED) {
269 270
    VALUE ary;

Chris Fallin's avatar
Chris Fallin committed
271 272
    if (TYPE(val) != T_ARRAY) {
      rb_raise(rb_eArgError,
273
               "Expected array as initializer value for repeated field '%s'.", name);
Chris Fallin's avatar
Chris Fallin committed
274
    }
275
    ary = layout_get(self->descriptor->layout, Message_data(self), f);
Chris Fallin's avatar
Chris Fallin committed
276
    for (int i = 0; i < RARRAY_LEN(val); i++) {
Zachary Anker's avatar
Zachary Anker committed
277
      VALUE entry = rb_ary_entry(val, i);
278 279 280 281 282
      if (TYPE(entry) == T_HASH && upb_fielddef_issubmsg(f)) {
        entry = create_submsg_from_hash(f, entry);
      }

      RepeatedField_push(ary, entry);
Chris Fallin's avatar
Chris Fallin committed
283 284
    }
  } else {
285 286 287 288
    if (TYPE(val) == T_HASH && upb_fielddef_issubmsg(f)) {
      val = create_submsg_from_hash(f, val);
    }

Chris Fallin's avatar
Chris Fallin committed
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    layout_set(self->descriptor->layout, Message_data(self), f, val);
  }
  return 0;
}

/*
 * call-seq:
 *     Message.new(kwargs) => new_message
 *
 * Creates a new instance of the given message class. Keyword arguments may be
 * provided with keywords corresponding to field names.
 *
 * Note that no literal Message class exists. Only concrete classes per message
 * type exist, as provided by the #msgclass method on Descriptors after they
 * have been added to a pool. The method definitions described here on the
 * Message class are provided on each concrete message class.
 */
VALUE Message_initialize(int argc, VALUE* argv, VALUE _self) {
307 308
  VALUE hash_args;

Chris Fallin's avatar
Chris Fallin committed
309 310 311 312 313 314
  if (argc == 0) {
    return Qnil;
  }
  if (argc != 1) {
    rb_raise(rb_eArgError, "Expected 0 or 1 arguments.");
  }
315
  hash_args = argv[0];
Chris Fallin's avatar
Chris Fallin committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
  if (TYPE(hash_args) != T_HASH) {
    rb_raise(rb_eArgError, "Expected hash arguments.");
  }

  rb_hash_foreach(hash_args, Message_initialize_kwarg, _self);
  return Qnil;
}

/*
 * call-seq:
 *     Message.dup => new_message
 *
 * Performs a shallow copy of this message and returns the new copy.
 */
VALUE Message_dup(VALUE _self) {
  MessageHeader* self;
332 333
  VALUE new_msg;
  MessageHeader* new_msg_self;
Chris Fallin's avatar
Chris Fallin committed
334 335
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);

336
  new_msg = rb_class_new_instance(0, NULL, CLASS_OF(_self));
Chris Fallin's avatar
Chris Fallin committed
337 338 339 340 341 342 343 344 345 346 347 348
  TypedData_Get_Struct(new_msg, MessageHeader, &Message_type, new_msg_self);

  layout_dup(self->descriptor->layout,
             Message_data(new_msg_self),
             Message_data(self));

  return new_msg;
}

// Internal only; used by Google::Protobuf.deep_copy.
VALUE Message_deep_copy(VALUE _self) {
  MessageHeader* self;
349 350
  MessageHeader* new_msg_self;
  VALUE new_msg;
Chris Fallin's avatar
Chris Fallin committed
351 352
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);

353
  new_msg = rb_class_new_instance(0, NULL, CLASS_OF(_self));
Chris Fallin's avatar
Chris Fallin committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
  TypedData_Get_Struct(new_msg, MessageHeader, &Message_type, new_msg_self);

  layout_deep_copy(self->descriptor->layout,
                   Message_data(new_msg_self),
                   Message_data(self));

  return new_msg;
}

/*
 * call-seq:
 *     Message.==(other) => boolean
 *
 * Performs a deep comparison of this message with another. Messages are equal
 * if they have the same type and if each field is equal according to the :==
 * method's semantics (a more efficient comparison may actually be done if the
 * field is of a primitive type).
 */
VALUE Message_eq(VALUE _self, VALUE _other) {
373 374
  MessageHeader* self;
  MessageHeader* other;
375 376 377
  if (TYPE(_self) != TYPE(_other)) {
    return Qfalse;
  }
378
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);
Chris Fallin's avatar
Chris Fallin committed
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
  TypedData_Get_Struct(_other, MessageHeader, &Message_type, other);

  if (self->descriptor != other->descriptor) {
    return Qfalse;
  }

  return layout_eq(self->descriptor->layout,
                   Message_data(self),
                   Message_data(other));
}

/*
 * call-seq:
 *     Message.hash => hash_value
 *
 * Returns a hash value that represents this message's field values.
 */
VALUE Message_hash(VALUE _self) {
  MessageHeader* self;
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);

  return layout_hash(self->descriptor->layout, Message_data(self));
}

/*
 * call-seq:
 *     Message.inspect => string
 *
 * Returns a human-readable string representing this message. It will be
 * formatted as "<MessageType: field1: value1, field2: value2, ...>". Each
 * field's value is represented according to its own #inspect method.
 */
VALUE Message_inspect(VALUE _self) {
  MessageHeader* self;
413
  VALUE str;
Chris Fallin's avatar
Chris Fallin committed
414 415
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);

416
  str = rb_str_new2("<");
Chris Fallin's avatar
Chris Fallin committed
417 418 419 420 421 422 423 424
  str = rb_str_append(str, rb_str_new2(rb_class2name(CLASS_OF(_self))));
  str = rb_str_cat2(str, ": ");
  str = rb_str_append(str, layout_inspect(
      self->descriptor->layout, Message_data(self)));
  str = rb_str_cat2(str, ">");
  return str;
}

425 426 427 428 429 430
/*
 * call-seq:
 *     Message.to_h => {}
 *
 * Returns the message as a Ruby Hash object, with keys as symbols.
 */
431 432
VALUE Message_to_h(VALUE _self) {
  MessageHeader* self;
433 434
  VALUE hash;
  upb_msg_field_iter it;
435 436
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);

437
  hash = rb_hash_new();
438 439 440 441 442

  for (upb_msg_field_begin(&it, self->descriptor->msgdef);
       !upb_msg_field_done(&it);
       upb_msg_field_next(&it)) {
    const upb_fielddef* field = upb_msg_iter_field(&it);
443 444
    VALUE msg_value = layout_get(self->descriptor->layout, Message_data(self),
                                 field);
445
    VALUE msg_key   = ID2SYM(rb_intern(upb_fielddef_name(field)));
446 447 448
    if (upb_fielddef_ismap(field)) {
      msg_value = Map_to_h(msg_value);
    } else if (upb_fielddef_label(field) == UPB_LABEL_REPEATED) {
449
      msg_value = RepeatedField_to_ary(msg_value);
450

Zachary Anker's avatar
Zachary Anker committed
451
      if (upb_fielddef_type(field) == UPB_TYPE_MESSAGE) {
452 453 454 455 456
        for (int i = 0; i < RARRAY_LEN(msg_value); i++) {
          VALUE elem = rb_ary_entry(msg_value, i);
          rb_ary_store(msg_value, i, Message_to_h(elem));
        }
      }
457 458 459
    } else if (msg_value != Qnil &&
               upb_fielddef_type(field) == UPB_TYPE_MESSAGE) {
      msg_value = Message_to_h(msg_value);
460 461 462 463 464 465 466 467
    }
    rb_hash_aset(hash, msg_key, msg_value);
  }
  return hash;
}



Chris Fallin's avatar
Chris Fallin committed
468 469 470 471 472 473 474 475 476
/*
 * call-seq:
 *     Message.[](index) => value
 *
 * Accesses a field's value by field name. The provided field name should be a
 * string.
 */
VALUE Message_index(VALUE _self, VALUE field_name) {
  MessageHeader* self;
477
  const upb_fielddef* field;
Chris Fallin's avatar
Chris Fallin committed
478 479
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);
  Check_Type(field_name, T_STRING);
480
  field = upb_msgdef_ntofz(self->descriptor->msgdef, RSTRING_PTR(field_name));
Chris Fallin's avatar
Chris Fallin committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
  if (field == NULL) {
    return Qnil;
  }
  return layout_get(self->descriptor->layout, Message_data(self), field);
}

/*
 * call-seq:
 *     Message.[]=(index, value)
 *
 * Sets a field's value by field name. The provided field name should be a
 * string.
 */
VALUE Message_index_set(VALUE _self, VALUE field_name, VALUE value) {
  MessageHeader* self;
496
  const upb_fielddef* field;
Chris Fallin's avatar
Chris Fallin committed
497 498
  TypedData_Get_Struct(_self, MessageHeader, &Message_type, self);
  Check_Type(field_name, T_STRING);
499
  field = upb_msgdef_ntofz(self->descriptor->msgdef, RSTRING_PTR(field_name));
Chris Fallin's avatar
Chris Fallin committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
  if (field == NULL) {
    rb_raise(rb_eArgError, "Unknown field: %s", RSTRING_PTR(field_name));
  }
  layout_set(self->descriptor->layout, Message_data(self), field, value);
  return Qnil;
}

/*
 * call-seq:
 *     Message.descriptor => descriptor
 *
 * Class method that returns the Descriptor instance corresponding to this
 * message class's type.
 */
VALUE Message_descriptor(VALUE klass) {
515
  return rb_ivar_get(klass, descriptor_instancevar_interned);
Chris Fallin's avatar
Chris Fallin committed
516 517 518
}

VALUE build_class_from_descriptor(Descriptor* desc) {
519 520 521
  const char *name;
  VALUE klass;

Chris Fallin's avatar
Chris Fallin committed
522 523 524 525 526 527 528
  if (desc->layout == NULL) {
    desc->layout = create_layout(desc->msgdef);
  }
  if (desc->fill_method == NULL) {
    desc->fill_method = new_fillmsg_decodermethod(desc, &desc->fill_method);
  }

529
  name = upb_msgdef_fullname(desc->msgdef);
Chris Fallin's avatar
Chris Fallin committed
530 531 532 533
  if (name == NULL) {
    rb_raise(rb_eRuntimeError, "Descriptor does not have assigned name.");
  }

534
  klass = rb_define_class_id(
Chris Fallin's avatar
Chris Fallin committed
535 536 537 538
      // Docs say this parameter is ignored. User will assign return value to
      // their own toplevel constant class name.
      rb_intern("Message"),
      rb_cObject);
539 540
  rb_ivar_set(klass, descriptor_instancevar_interned,
              get_def_obj(desc->msgdef));
Chris Fallin's avatar
Chris Fallin committed
541
  rb_define_alloc_func(klass, Message_alloc);
542 543
  rb_require("google/protobuf/message_exts");
  rb_include_module(klass, rb_eval_string("Google::Protobuf::MessageExts"));
544 545
  rb_extend_object(
      klass, rb_eval_string("Google::Protobuf::MessageExts::ClassMethods"));
546

Chris Fallin's avatar
Chris Fallin committed
547 548
  rb_define_method(klass, "method_missing",
                   Message_method_missing, -1);
549 550
  rb_define_method(klass, "respond_to_missing?",
                   Message_respond_to_missing, -1);
Chris Fallin's avatar
Chris Fallin committed
551 552 553 554 555 556
  rb_define_method(klass, "initialize", Message_initialize, -1);
  rb_define_method(klass, "dup", Message_dup, 0);
  // Also define #clone so that we don't inherit Object#clone.
  rb_define_method(klass, "clone", Message_dup, 0);
  rb_define_method(klass, "==", Message_eq, 1);
  rb_define_method(klass, "hash", Message_hash, 0);
557 558
  rb_define_method(klass, "to_h", Message_to_h, 0);
  rb_define_method(klass, "to_hash", Message_to_h, 0);
Chris Fallin's avatar
Chris Fallin committed
559 560 561 562 563 564
  rb_define_method(klass, "inspect", Message_inspect, 0);
  rb_define_method(klass, "[]", Message_index, 1);
  rb_define_method(klass, "[]=", Message_index_set, 2);
  rb_define_singleton_method(klass, "decode", Message_decode, 1);
  rb_define_singleton_method(klass, "encode", Message_encode, 1);
  rb_define_singleton_method(klass, "decode_json", Message_decode_json, 1);
565
  rb_define_singleton_method(klass, "encode_json", Message_encode_json, -1);
Chris Fallin's avatar
Chris Fallin committed
566
  rb_define_singleton_method(klass, "descriptor", Message_descriptor, 0);
567

Chris Fallin's avatar
Chris Fallin committed
568 569 570 571 572 573 574 575 576 577 578 579
  return klass;
}

/*
 * call-seq:
 *     Enum.lookup(number) => name
 *
 * This module method, provided on each generated enum module, looks up an enum
 * value by number and returns its name as a Ruby symbol, or nil if not found.
 */
VALUE enum_lookup(VALUE self, VALUE number) {
  int32_t num = NUM2INT(number);
580
  VALUE desc = rb_ivar_get(self, descriptor_instancevar_interned);
Chris Fallin's avatar
Chris Fallin committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
  EnumDescriptor* enumdesc = ruby_to_EnumDescriptor(desc);

  const char* name = upb_enumdef_iton(enumdesc->enumdef, num);
  if (name == NULL) {
    return Qnil;
  } else {
    return ID2SYM(rb_intern(name));
  }
}

/*
 * call-seq:
 *     Enum.resolve(name) => number
 *
 * This module method, provided on each generated enum module, looks up an enum
 * value by name (as a Ruby symbol) and returns its name, or nil if not found.
 */
VALUE enum_resolve(VALUE self, VALUE sym) {
  const char* name = rb_id2name(SYM2ID(sym));
600
  VALUE desc = rb_ivar_get(self, descriptor_instancevar_interned);
Chris Fallin's avatar
Chris Fallin committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
  EnumDescriptor* enumdesc = ruby_to_EnumDescriptor(desc);

  int32_t num = 0;
  bool found = upb_enumdef_ntoiz(enumdesc->enumdef, name, &num);
  if (!found) {
    return Qnil;
  } else {
    return INT2NUM(num);
  }
}

/*
 * call-seq:
 *     Enum.descriptor
 *
 * This module method, provided on each generated enum module, returns the
 * EnumDescriptor corresponding to this enum type.
 */
VALUE enum_descriptor(VALUE self) {
620
  return rb_ivar_get(self, descriptor_instancevar_interned);
Chris Fallin's avatar
Chris Fallin committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
}

VALUE build_module_from_enumdesc(EnumDescriptor* enumdesc) {
  VALUE mod = rb_define_module_id(
      rb_intern(upb_enumdef_fullname(enumdesc->enumdef)));

  upb_enum_iter it;
  for (upb_enum_begin(&it, enumdesc->enumdef);
       !upb_enum_done(&it);
       upb_enum_next(&it)) {
    const char* name = upb_enum_iter_name(&it);
    int32_t value = upb_enum_iter_number(&it);
    if (name[0] < 'A' || name[0] > 'Z') {
      rb_raise(rb_eTypeError,
               "Enum value '%s' does not start with an uppercase letter "
               "as is required for Ruby constants.",
               name);
    }
    rb_define_const(mod, name, INT2NUM(value));
  }

  rb_define_singleton_method(mod, "lookup", enum_lookup, 1);
  rb_define_singleton_method(mod, "resolve", enum_resolve, 1);
  rb_define_singleton_method(mod, "descriptor", enum_descriptor, 0);
645 646
  rb_ivar_set(mod, descriptor_instancevar_interned,
              get_def_obj(enumdesc->enumdef));
Chris Fallin's avatar
Chris Fallin committed
647 648 649 650 651 652 653 654

  return mod;
}

/*
 * call-seq:
 *     Google::Protobuf.deep_copy(obj) => copy_of_obj
 *
655 656
 * Performs a deep copy of a RepeatedField instance, a Map instance, or a
 * message object, recursively copying its members.
Chris Fallin's avatar
Chris Fallin committed
657 658 659 660 661
 */
VALUE Google_Protobuf_deep_copy(VALUE self, VALUE obj) {
  VALUE klass = CLASS_OF(obj);
  if (klass == cRepeatedField) {
    return RepeatedField_deep_copy(obj);
662 663
  } else if (klass == cMap) {
    return Map_deep_copy(obj);
Chris Fallin's avatar
Chris Fallin committed
664 665 666 667
  } else {
    return Message_deep_copy(obj);
  }
}