1 /*
2 * Copyright (c) 2009-2021, Google LLC
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Google LLC nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef UPB_PROTOS_GENERATOR_GEN_UTILS_H_
29 #define UPB_PROTOS_GENERATOR_GEN_UTILS_H_
30
31 #include <vector>
32
33 #include "google/protobuf/descriptor.pb.h"
34 #include "absl/container/flat_hash_map.h"
35 #include "absl/strings/string_view.h"
36 #include "google/protobuf/compiler/code_generator.h"
37 #include "google/protobuf/compiler/plugin.h"
38 #include "google/protobuf/descriptor.h"
39 #include "google/protobuf/wire_format.h"
40 #include "protos_generator/output.h"
41
42 namespace protos_generator {
43
44 namespace protobuf = ::google::protobuf;
45
46 enum class MessageClassType {
47 kMessage,
48 kMessageCProxy,
49 kMessageProxy,
50 kMessageAccess,
51 };
52
53 std::string ClassName(const protobuf::Descriptor* descriptor);
54 std::string QualifiedClassName(const protobuf::Descriptor* descriptor);
55 std::string QualifiedInternalClassName(const protobuf::Descriptor* descriptor);
56
IsMapEntryMessage(const protobuf::Descriptor * descriptor)57 inline bool IsMapEntryMessage(const protobuf::Descriptor* descriptor) {
58 return descriptor->options().map_entry();
59 }
60 std::string CppSourceFilename(const google::protobuf::FileDescriptor* file);
61 std::string ForwardingHeaderFilename(const google::protobuf::FileDescriptor* file);
62 std::string UpbCFilename(const google::protobuf::FileDescriptor* file);
63 std::string CppHeaderFilename(const google::protobuf::FileDescriptor* file);
64
65 void WriteStartNamespace(const protobuf::FileDescriptor* file, Output& output);
66 void WriteEndNamespace(const protobuf::FileDescriptor* file, Output& output);
67
68 std::string CppConstType(const protobuf::FieldDescriptor* field);
69 std::string CppTypeParameterName(const protobuf::FieldDescriptor* field);
70
71 std::string MessageBaseType(const protobuf::FieldDescriptor* field,
72 bool is_const);
73 // Generate protos::Ptr<const Model> to be used in accessors as public
74 // signatures.
75 std::string MessagePtrConstType(const protobuf::FieldDescriptor* field,
76 bool is_const);
77 std::string MessageCProxyType(const protobuf::FieldDescriptor* field,
78 bool is_const);
79 std::string MessageProxyType(const protobuf::FieldDescriptor* field,
80 bool is_const);
81
82 std::vector<const protobuf::EnumDescriptor*> SortedEnums(
83 const protobuf::FileDescriptor* file);
84 std::vector<const protobuf::Descriptor*> SortedMessages(
85 const protobuf::FileDescriptor* file);
86 std::vector<const protobuf::FieldDescriptor*> SortedExtensions(
87 const protobuf::FileDescriptor* file);
88 std::vector<const protobuf::FieldDescriptor*> FieldNumberOrder(
89 const protobuf::Descriptor* message);
90
91 inline constexpr absl::string_view kNoPackageNamePrefix = "protos_";
92
93 std::string ToCamelCase(const std::string& input, bool lower_first);
94
95 } // namespace protos_generator
96
97 #endif // UPB_PROTOS_GENERATOR_GEN_UTILS_H_
98