1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // https://developers.google.com/protocol-buffers/ 4 // 5 // Redistribution and use in source and binary forms, with or without 6 // modification, are permitted provided that the following conditions are 7 // met: 8 // 9 // * Redistributions of source code must retain the above copyright 10 // notice, this list of conditions and the following disclaimer. 11 // * Redistributions in binary form must reproduce the above 12 // copyright notice, this list of conditions and the following disclaimer 13 // in the documentation and/or other materials provided with the 14 // distribution. 15 // * Neither the name of Google Inc. nor the names of its 16 // contributors may be used to endorse or promote products derived from 17 // this software without specific prior written permission. 18 // 19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 #ifndef RUBY_PROTOBUF_MAP_H_ 32 #define RUBY_PROTOBUF_MAP_H_ 33 34 #include <ruby/ruby.h> 35 36 #include "protobuf.h" 37 #include "ruby-upb.h" 38 39 // Returns a Ruby wrapper object for the given map, which will be created if 40 // one does not exist already. 41 VALUE Map_GetRubyWrapper(upb_Map *map, upb_CType key_type, TypeInfo value_type, 42 VALUE arena); 43 44 // Gets the underlying upb_Map for this Ruby map object, which must have 45 // key/value type that match |field|. If this is not a map or the type doesn't 46 // match, raises an exception. 47 const upb_Map *Map_GetUpbMap(VALUE val, const upb_FieldDef *field, 48 upb_Arena *arena); 49 50 // Implements #inspect for this map by appending its contents to |b|. 51 void Map_Inspect(StringBuilder *b, const upb_Map *map, upb_CType key_type, 52 TypeInfo val_type); 53 54 // Returns a new Hash object containing the contents of this Map. 55 VALUE Map_CreateHash(const upb_Map *map, upb_CType key_type, TypeInfo val_info); 56 57 // Returns a deep copy of this Map object. 58 VALUE Map_deep_copy(VALUE obj); 59 60 // Ruby class of Google::Protobuf::Map. 61 extern VALUE cMap; 62 63 // Call at startup to register all types in this module. 64 void Map_register(VALUE module); 65 66 #endif // RUBY_PROTOBUF_MAP_H_ 67