• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_CONVERT_H_
32 #define RUBY_PROTOBUF_CONVERT_H_
33 
34 #include <ruby/ruby.h>
35 
36 #include "protobuf.h"
37 #include "ruby-upb.h"
38 
39 // Converts |ruby_val| to a upb_MessageValue according to |type_info|.
40 //
41 // The |arena| parameter indicates the lifetime of the container where this
42 // value will be assigned. It is used as follows:
43 // - If type is string or bytes, the string data will be copied into |arena|.
44 // - If type is message, and we need to auto-construct a message due to implicit
45 //   conversions (eg. Time -> Google::Protobuf::Timestamp), the new message
46 //   will be created in |arena|.
47 // - If type is message and the Ruby value is a message instance, we will fuse
48 //   the message's arena into |arena|, to ensure that this message outlives the
49 //   container.
50 upb_MessageValue Convert_RubyToUpb(VALUE ruby_val, const char *name,
51                                    TypeInfo type_info, upb_Arena *arena);
52 
53 // Converts |upb_val| to a Ruby VALUE according to |type_info|. This may involve
54 // creating a Ruby wrapper object.
55 //
56 // The |arena| parameter indicates the arena that owns the lifetime of
57 // |upb_val|. Any Ruby wrapper object that is created will reference |arena|
58 // and ensure it outlives the wrapper.
59 VALUE Convert_UpbToRuby(upb_MessageValue upb_val, TypeInfo type_info,
60                         VALUE arena);
61 
62 // Creates a deep copy of |msgval| in |arena|.
63 upb_MessageValue Msgval_DeepCopy(upb_MessageValue msgval, TypeInfo type_info,
64                                  upb_Arena *arena);
65 
66 // Returns true if |val1| and |val2| are equal. Their type is given by
67 // |type_info|.
68 bool Msgval_IsEqual(upb_MessageValue val1, upb_MessageValue val2,
69                     TypeInfo type_info);
70 
71 // Returns a hash value for the given upb_MessageValue.
72 uint64_t Msgval_GetHash(upb_MessageValue val, TypeInfo type_info,
73                         uint64_t seed);
74 
75 #endif  // RUBY_PROTOBUF_CONVERT_H_
76