1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
// Protocol Buffers - Google's data interchange format
// Copyright 2023 Google LLC. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd
#include <cstdint>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "google/protobuf/descriptor.pb.h"
#include "google/protobuf/compiler/code_generator.h"
#include "google/protobuf/compiler/hpb/context.h"
#include "google/protobuf/compiler/hpb/gen_enums.h"
#include "google/protobuf/compiler/hpb/gen_extensions.h"
#include "google/protobuf/compiler/hpb/gen_messages.h"
#include "google/protobuf/compiler/hpb/gen_utils.h"
#include "google/protobuf/compiler/hpb/names.h"
#include "google/protobuf/compiler/plugin.h"
#include "google/protobuf/descriptor.h"
namespace google::protobuf::hpb_generator {
namespace {
namespace protoc = ::google::protobuf::compiler;
namespace protobuf = ::proto2;
using FileDescriptor = ::google::protobuf::FileDescriptor;
using google::protobuf::Edition;
void WriteSource(const protobuf::FileDescriptor* file, Context& ctx,
bool fasttable_enabled, bool strip_feature_includes);
void WriteHeader(const protobuf::FileDescriptor* file, Context& ctx,
bool strip_feature_includes);
void WriteForwardingHeader(const protobuf::FileDescriptor* file, Context& ctx);
void WriteMessageImplementations(const protobuf::FileDescriptor* file,
Context& ctx);
void WriteTypedefForwardingHeader(
const protobuf::FileDescriptor* file,
const std::vector<const protobuf::Descriptor*>& file_messages,
Context& ctx);
void WriteHeaderMessageForwardDecls(const protobuf::FileDescriptor* file,
Context& ctx, bool strip_feature_includes);
class Generator : public protoc::CodeGenerator {
public:
~Generator() override = default;
bool Generate(const protobuf::FileDescriptor* file,
const std::string& parameter, protoc::GeneratorContext* context,
std::string* error) const override;
uint64_t GetSupportedFeatures() const override {
return Feature::FEATURE_PROTO3_OPTIONAL |
Feature::FEATURE_SUPPORTS_EDITIONS;
}
Edition GetMinimumEdition() const override { return Edition::EDITION_PROTO2; }
Edition GetMaximumEdition() const override { return Edition::EDITION_2023; }
};
bool Generator::Generate(const protobuf::FileDescriptor* file,
const std::string& parameter,
protoc::GeneratorContext* context,
std::string* error) const {
bool fasttable_enabled = false;
bool strip_nonfunctional_codegen = false;
std::vector<std::pair<std::string, std::string>> params;
google::protobuf::compiler::ParseGeneratorParameter(parameter, ¶ms);
for (const auto& pair : params) {
if (pair.first == "fasttable") {
fasttable_enabled = true;
} else if (pair.first == "experimental_strip_nonfunctional_codegen") {
strip_nonfunctional_codegen = true;
} else {
*error = "Unknown parameter: " + pair.first;
return false;
}
}
// Write model.hpb.h
std::unique_ptr<google::protobuf::io::ZeroCopyOutputStream> header_output_stream(
context->Open(CppHeaderFilename(file)));
Context hdr_ctx(file, header_output_stream.get(),
Options{.backend = Backend::UPB});
WriteHeader(file, hdr_ctx, strip_nonfunctional_codegen);
// Write model.hpb.cc
std::unique_ptr<google::protobuf::io::ZeroCopyOutputStream> cc_output_stream(
context->Open(CppSourceFilename(file)));
auto cc_ctx =
Context(file, cc_output_stream.get(), Options{.backend = Backend::UPB});
WriteSource(file, cc_ctx, fasttable_enabled, strip_nonfunctional_codegen);
return true;
}
void WriteForwardDecls(const protobuf::FileDescriptor* file, Context& ctx) {
for (int i = 0; i < file->public_dependency_count(); ++i) {
const auto target_file_messages =
SortedMessages(file->public_dependency(i));
WriteTypedefForwardingHeader(file->public_dependency(i),
target_file_messages, ctx);
}
const auto this_file_messages = SortedMessages(file);
WriteTypedefForwardingHeader(file, this_file_messages, ctx);
}
void WriteHeader(const protobuf::FileDescriptor* file, Context& ctx,
bool strip_feature_includes) {
EmitFileWarning(file, ctx);
ctx.EmitLegacy(
R"cc(
#ifndef $0_HPB_PROTO_H_
#define $0_HPB_PROTO_H_
#include "google/protobuf/hpb/repeated_field.h"
#include "absl/status/statusor.h"
#include "absl/strings/string_view.h"
)cc",
ToPreproc(file->name()));
// Import headers for proto public dependencies.
for (int i = 0; i < file->public_dependency_count(); i++) {
if (i == 0) {
ctx.Emit("// Public Imports.\n");
}
ctx.EmitLegacy("#include \"$0\"\n",
CppHeaderFilename(file->public_dependency(i)));
if (i == file->public_dependency_count() - 1) {
ctx.Emit("\n");
}
}
ctx.Emit("#include \"upb/port/def.inc\"\n");
const std::vector<const protobuf::Descriptor*> this_file_messages =
SortedMessages(file);
const std::vector<const protobuf::FieldDescriptor*> this_file_exts =
SortedExtensions(file);
if (!this_file_messages.empty()) {
ctx.Emit("\n");
}
WriteHeaderMessageForwardDecls(file, ctx, strip_feature_includes);
WriteForwardDecls(file, ctx);
std::vector<const protobuf::EnumDescriptor*> this_file_enums =
SortedEnums(file);
WrapNamespace(file, ctx, [&]() {
// Write Class and Enums.
WriteEnumDeclarations(this_file_enums, ctx);
ctx.Emit("\n");
for (auto message : this_file_messages) {
WriteMessageClassDeclarations(message, this_file_exts, this_file_enums,
ctx);
}
ctx.Emit("\n");
WriteExtensionIdentifiersHeader(this_file_exts, ctx);
ctx.Emit("\n");
});
ctx.Emit("\n#include \"upb/port/undef.inc\"\n\n");
// End of "C" section.
ctx.EmitLegacy("#endif /* $0_HPB_PROTO_H_ */\n", ToPreproc(file->name()));
}
// Writes a .upb.cc source file.
void WriteSource(const protobuf::FileDescriptor* file, Context& ctx,
bool fasttable_enabled, bool strip_feature_includes) {
EmitFileWarning(file, ctx);
ctx.EmitLegacy(
R"cc(
#include <stddef.h>
#include "absl/log/absl_check.h"
#include "absl/strings/string_view.h"
#include "$0"
)cc",
CppHeaderFilename(file));
for (int i = 0; i < file->dependency_count(); i++) {
if (strip_feature_includes &&
compiler::IsKnownFeatureProto(file->dependency(i)->name())) {
// Strip feature imports for editions codegen tests.
continue;
}
ctx.EmitLegacy("#include \"$0\"\n", CppHeaderFilename(file->dependency(i)));
}
ctx.EmitLegacy("#include \"upb/port/def.inc\"\n");
WrapNamespace(file, ctx, [&]() {
WriteMessageImplementations(file, ctx);
});
ctx.Emit("#include \"upb/port/undef.inc\"\n\n");
}
void WriteMessageImplementations(const protobuf::FileDescriptor* file,
Context& ctx) {
const std::vector<const protobuf::FieldDescriptor*> file_exts =
SortedExtensions(file);
const std::vector<const protobuf::Descriptor*> this_file_messages =
SortedMessages(file);
for (auto message : this_file_messages) {
WriteMessageImplementation(message, file_exts, ctx);
}
}
void WriteTypedefForwardingHeader(
const protobuf::FileDescriptor* file,
const std::vector<const protobuf::Descriptor*>& file_messages,
Context& ctx) {
WrapNamespace(file, ctx, [&]() {
// Forward-declare types defined in this file.
for (auto message : file_messages) {
ctx.Emit({{"class_name", ClassName(message)}},
R"cc(
class $class_name$;
namespace internal {
class $class_name$Access;
class $class_name$Proxy;
class $class_name$CProxy;
} // namespace internal
)cc");
}
});
ctx.Emit("\n");
}
/// Writes includes for upb C minitables and fwd.h for transitive typedefs.
void WriteHeaderMessageForwardDecls(const protobuf::FileDescriptor* file,
Context& ctx, bool strip_feature_includes) {
// Import forward-declaration of types defined in this file.
ctx.EmitLegacy("#include \"$0\"\n", UpbCFilename(file));
WriteForwardDecls(file, ctx);
// Import forward-declaration of types in dependencies.
for (int i = 0; i < file->dependency_count(); ++i) {
if (strip_feature_includes &&
compiler::IsKnownFeatureProto(file->dependency(i)->name())) {
// Strip feature imports for editions codegen tests.
continue;
}
WriteForwardDecls(file->dependency(i), ctx);
}
ctx.Emit("\n");
}
} // namespace
} // namespace protobuf
} // namespace google::hpb_generator
int main(int argc, char** argv) {
google::protobuf::hpb_generator::Generator generator_cc;
return google::protobuf::compiler::PluginMain(argc, argv, &generator_cc);
}
|
