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 // Author: kenton@google.com (Kenton Varda)
32 // Based on original Protocol Buffers design by
33 // Sanjay Ghemawat, Jeff Dean, and others.
34
35 #ifndef GOOGLE_PROTOBUF_COMPILER_CSHARP_HELPERS_H__
36 #define GOOGLE_PROTOBUF_COMPILER_CSHARP_HELPERS_H__
37
38 #include <string>
39 #include <google/protobuf/port.h>
40 #include <google/protobuf/stubs/common.h>
41 #include <google/protobuf/descriptor.pb.h>
42 #include <google/protobuf/descriptor.h>
43 #include <google/protobuf/compiler/code_generator.h>
44 #include <google/protobuf/io/printer.h>
45
46 #include <google/protobuf/port_def.inc>
47
48 namespace google {
49 namespace protobuf {
50 namespace compiler {
51 namespace csharp {
52
53 struct Options;
54 class FieldGeneratorBase;
55
56 // TODO: start using this enum.
57 enum CSharpType {
58 CSHARPTYPE_INT32 = 1,
59 CSHARPTYPE_INT64 = 2,
60 CSHARPTYPE_UINT32 = 3,
61 CSHARPTYPE_UINT64 = 4,
62 CSHARPTYPE_FLOAT = 5,
63 CSHARPTYPE_DOUBLE = 6,
64 CSHARPTYPE_BOOL = 7,
65 CSHARPTYPE_STRING = 8,
66 CSHARPTYPE_BYTESTRING = 9,
67 CSHARPTYPE_MESSAGE = 10,
68 CSHARPTYPE_ENUM = 11,
69 MAX_CSHARPTYPE = 11
70 };
71
72 // Converts field type to corresponding C# type.
73 CSharpType GetCSharpType(FieldDescriptor::Type type);
74
75 std::string StripDotProto(const std::string& proto_file);
76
77 // Gets unqualified name of the reflection class
78 std::string GetReflectionClassUnqualifiedName(const FileDescriptor* descriptor);
79 // Gets unqualified name of the extension class
80 std::string GetExtensionClassUnqualifiedName(const FileDescriptor* descriptor);
81
82 std::string GetClassName(const EnumDescriptor* descriptor);
83
84 std::string GetFieldName(const FieldDescriptor* descriptor);
85
86 std::string GetFieldConstantName(const FieldDescriptor* field);
87
88 std::string GetPropertyName(const FieldDescriptor* descriptor);
89
90 int GetFixedSize(FieldDescriptor::Type type);
91
92 std::string UnderscoresToCamelCase(const std::string& input,
93 bool cap_next_letter,
94 bool preserve_period);
95
UnderscoresToCamelCase(const std::string & input,bool cap_next_letter)96 inline std::string UnderscoresToCamelCase(const std::string& input, bool cap_next_letter) {
97 return UnderscoresToCamelCase(input, cap_next_letter, false);
98 }
99
100 std::string UnderscoresToPascalCase(const std::string& input);
101
102 // Note that we wouldn't normally want to export this (we're not expecting
103 // it to be used outside libprotoc itself) but this exposes it for testing.
104 std::string PROTOC_EXPORT GetEnumValueName(const std::string& enum_name,
105 const std::string& enum_value_name);
106
107 // TODO(jtattermusch): perhaps we could move this to strutil
108 std::string StringToBase64(const std::string& input);
109
110 std::string FileDescriptorToBase64(const FileDescriptor* descriptor);
111
112 FieldGeneratorBase* CreateFieldGenerator(const FieldDescriptor* descriptor,
113 int presenceIndex,
114 const Options* options);
115
116 std::string GetFullExtensionName(const FieldDescriptor* descriptor);
117
118 bool IsNullable(const FieldDescriptor* descriptor);
119
120 // Determines whether the given message is a map entry message,
121 // i.e. one implicitly created by protoc due to a map<key, value> field.
IsMapEntryMessage(const Descriptor * descriptor)122 inline bool IsMapEntryMessage(const Descriptor* descriptor) {
123 return descriptor->options().map_entry();
124 }
125
126 // Checks if this descriptor is for a group and gets its end tag or 0 if it's not a group
127 uint GetGroupEndTag(const Descriptor* descriptor);
128
129 // Determines whether we're generating code for the proto representation of
130 // descriptors etc, for use in the runtime. This is the only type which is
131 // allowed to use proto2 syntax, and it generates internal classes.
IsDescriptorProto(const FileDescriptor * descriptor)132 inline bool IsDescriptorProto(const FileDescriptor* descriptor) {
133 return descriptor->name() == "google/protobuf/descriptor.proto";
134 }
135
136 // Determines whether the given message is an options message within descriptor.proto.
IsDescriptorOptionMessage(const Descriptor * descriptor)137 inline bool IsDescriptorOptionMessage(const Descriptor* descriptor) {
138 if (!IsDescriptorProto(descriptor->file())) {
139 return false;
140 }
141 const string name = descriptor->full_name();
142 return name == "google.protobuf.FileOptions" ||
143 name == "google.protobuf.MessageOptions" ||
144 name == "google.protobuf.FieldOptions" ||
145 name == "google.protobuf.OneofOptions" ||
146 name == "google.protobuf.EnumOptions" ||
147 name == "google.protobuf.EnumValueOptions" ||
148 name == "google.protobuf.ServiceOptions" ||
149 name == "google.protobuf.MethodOptions";
150 }
151
IsWrapperType(const FieldDescriptor * descriptor)152 inline bool IsWrapperType(const FieldDescriptor* descriptor) {
153 return descriptor->type() == FieldDescriptor::TYPE_MESSAGE &&
154 descriptor->message_type()->file()->name() == "google/protobuf/wrappers.proto";
155 }
156
IsProto2(const FileDescriptor * descriptor)157 inline bool IsProto2(const FileDescriptor* descriptor) {
158 return descriptor->syntax() == FileDescriptor::SYNTAX_PROTO2;
159 }
160
SupportsPresenceApi(const FieldDescriptor * descriptor)161 inline bool SupportsPresenceApi(const FieldDescriptor* descriptor) {
162 // Unlike most languages, we don't generate Has/Clear members for message
163 // types, because they can always be set to null in C#. They're not really
164 // needed for oneof fields in proto2 either, as everything can be done via
165 // oneof case, but we follow the convention from other languages. Proto3
166 // oneof fields never have Has/Clear members - but will also never have
167 // the explicit optional keyword either.
168 //
169 // None of the built-in helpers (descriptor->has_presence() etc) describe
170 // quite the behavior we want, so the rules are explicit below.
171
172 if (descriptor->is_repeated() ||
173 descriptor->type() == FieldDescriptor::TYPE_MESSAGE) {
174 return false;
175 }
176 // has_optional_keyword() has more complex rules for proto2, but that
177 // doesn't matter given the first part of this condition.
178 return IsProto2(descriptor->file()) || descriptor->has_optional_keyword();
179 }
180
RequiresPresenceBit(const FieldDescriptor * descriptor)181 inline bool RequiresPresenceBit(const FieldDescriptor* descriptor) {
182 return SupportsPresenceApi(descriptor) &&
183 !IsNullable(descriptor) &&
184 !descriptor->is_extension() &&
185 !descriptor->real_containing_oneof();
186 }
187
188 } // namespace csharp
189 } // namespace compiler
190 } // namespace protobuf
191 } // namespace google
192
193 #include <google/protobuf/port_undef.inc>
194
195 #endif // GOOGLE_PROTOBUF_COMPILER_CSHARP_HELPERS_H__
196