xref: /aosp_15_r20/external/protobuf/ruby/ext/google/protobuf_c/defs.h (revision 1b3f573f81763fcece89efc2b6a5209149e44ab8)
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_DEFS_H_
32 #define RUBY_PROTOBUF_DEFS_H_
33 
34 #include <ruby/ruby.h>
35 
36 #include "protobuf.h"
37 #include "ruby-upb.h"
38 
39 // -----------------------------------------------------------------------------
40 // TypeInfo
41 // -----------------------------------------------------------------------------
42 
43 // This bundles a upb_CType and msgdef/enumdef when appropriate. This is
44 // convenient for functions that need type information but cannot necessarily
45 // assume a upb_FieldDef will be available.
46 //
47 // For example, Google::Protobuf::Map and Google::Protobuf::RepeatedField can
48 // be constructed with type information alone:
49 //
50 //   # RepeatedField will internally store the type information in a TypeInfo.
51 //   Google::Protobuf::RepeatedField.new(:message, FooMessage)
52 
53 typedef struct {
54   upb_CType type;
55   union {
56     const upb_MessageDef* msgdef;  // When type == kUpb_CType_Message
57     const upb_EnumDef* enumdef;    // When type == kUpb_CType_Enum
58   } def;
59 } TypeInfo;
60 
TypeInfo_get(const upb_FieldDef * f)61 static inline TypeInfo TypeInfo_get(const upb_FieldDef* f) {
62   TypeInfo ret = {upb_FieldDef_CType(f), {NULL}};
63   switch (ret.type) {
64     case kUpb_CType_Message:
65       ret.def.msgdef = upb_FieldDef_MessageSubDef(f);
66       break;
67     case kUpb_CType_Enum:
68       ret.def.enumdef = upb_FieldDef_EnumSubDef(f);
69       break;
70     default:
71       break;
72   }
73   return ret;
74 }
75 
76 TypeInfo TypeInfo_FromClass(int argc, VALUE* argv, int skip_arg,
77                             VALUE* type_class, VALUE* init_arg);
78 
TypeInfo_from_type(upb_CType type)79 static inline TypeInfo TypeInfo_from_type(upb_CType type) {
80   TypeInfo ret = {type};
81   assert(type != kUpb_CType_Message && type != kUpb_CType_Enum);
82   return ret;
83 }
84 
85 // -----------------------------------------------------------------------------
86 // Other utilities
87 // -----------------------------------------------------------------------------
88 
89 VALUE Descriptor_DefToClass(const upb_MessageDef* m);
90 
91 // Returns the underlying msgdef, enumdef, or symtab (respectively) for the
92 // given Descriptor, EnumDescriptor, or DescriptorPool Ruby object.
93 const upb_EnumDef* EnumDescriptor_GetEnumDef(VALUE enum_desc_rb);
94 const upb_DefPool* DescriptorPool_GetSymtab(VALUE desc_pool_rb);
95 const upb_MessageDef* Descriptor_GetMsgDef(VALUE desc_rb);
96 
97 // Returns a upb field type for the given Ruby symbol
98 // (eg. :float => kUpb_CType_Float).
99 upb_CType ruby_to_fieldtype(VALUE type);
100 
101 // The singleton generated pool (a DescriptorPool object).
102 extern VALUE generated_pool;
103 
104 // Call at startup to register all types in this module.
105 void Defs_register(VALUE module);
106 
107 #endif  // RUBY_PROTOBUF_DEFS_H_
108