Protobuf Team Bot
2 years ago
committed by
Copybara-Service
parent
5c33ed0855
commit
99d4060ec2
9 changed files with 460 additions and 40 deletions
@ -0,0 +1,250 @@ |
|||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2023 Google LLC. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google LLC. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
#include "google/protobuf/compiler/rust/oneof.h" |
||||||
|
|
||||||
|
#include <string> |
||||||
|
|
||||||
|
#include "absl/strings/string_view.h" |
||||||
|
#include "google/protobuf/compiler/cpp/helpers.h" |
||||||
|
#include "google/protobuf/compiler/rust/context.h" |
||||||
|
#include "google/protobuf/compiler/rust/naming.h" |
||||||
|
#include "google/protobuf/descriptor.h" |
||||||
|
|
||||||
|
namespace google { |
||||||
|
namespace protobuf { |
||||||
|
namespace compiler { |
||||||
|
namespace rust { |
||||||
|
|
||||||
|
// We emit three Rust enums:
|
||||||
|
// - An enum acting as a tagged union that has each case holds a View<> of
|
||||||
|
// each of the cases. Named as the one_of name in CamelCase.
|
||||||
|
// - An enum acting as a tagged union that has each case holds a Mut<> of
|
||||||
|
// each of the cases. Named as one_of name in CamelCase with "Mut" appended.
|
||||||
|
// [TODO(b/285309334): Mut not implemented yet].
|
||||||
|
// - A simple enum whose cases have int values matching the cpp or upb's
|
||||||
|
// case enum. Named as the one_of camelcase with "Case" appended.
|
||||||
|
// All three contain cases matching the fields in the oneof CamelCased.
|
||||||
|
// The first and second are exposed in the API, the third is internal and
|
||||||
|
// used for interop with the Kernels in the generation of the other two.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
// For this oneof:
|
||||||
|
// message SomeMsg {
|
||||||
|
// oneof some_oneof {
|
||||||
|
// int32 field_a = 7;
|
||||||
|
// uint32 field_b = 9;
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// This will emit as the exposed API:
|
||||||
|
// pub mod SomeMsg_ {
|
||||||
|
// // The 'view' struct (no suffix on the name)
|
||||||
|
// pub enum SomeOneof {
|
||||||
|
// FieldA(i32) = 7,
|
||||||
|
// FieldB(u32) = 9,
|
||||||
|
// not_set = 0
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// impl SomeMsg {
|
||||||
|
// pub fn some_oneof() -> SomeOneof {...}
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// An additional "Case" enum which just reflects the corresponding slot numbers
|
||||||
|
// is emitted for usage with the FFI (exactly matching the Case struct that both
|
||||||
|
// cpp and upb generate). This enum is pub(super) which makes it private to the
|
||||||
|
// codegen since its inside an inner mod:
|
||||||
|
//
|
||||||
|
// #[repr(C)] pub(super) enum SomeOneofCase {
|
||||||
|
// FieldA = 7,
|
||||||
|
// FieldB = 9,
|
||||||
|
// not_set = 0
|
||||||
|
// }
|
||||||
|
|
||||||
|
namespace { |
||||||
|
std::string ToCamelCase(absl::string_view name) { |
||||||
|
return cpp::UnderscoresToCamelCase(name, /* upper initial letter */ true); |
||||||
|
} |
||||||
|
|
||||||
|
std::string oneofViewEnumRsName(const OneofDescriptor& desc) { |
||||||
|
return ToCamelCase(desc.name()); |
||||||
|
} |
||||||
|
|
||||||
|
std::string oneofCaseEnumName(const OneofDescriptor& desc) { |
||||||
|
// Note: This is the name used for the cpp Case enum, we use it for both
|
||||||
|
// the Rust Case enum as well as for the cpp case enum in the cpp thunk.
|
||||||
|
return oneofViewEnumRsName(desc) + "Case"; |
||||||
|
} |
||||||
|
|
||||||
|
// TODO(b/285309334): Promote up to naming.h once all types can be spelled.
|
||||||
|
std::string RsTypeName(const FieldDescriptor& desc) { |
||||||
|
switch (desc.type()) { |
||||||
|
case FieldDescriptor::TYPE_MESSAGE: |
||||||
|
case FieldDescriptor::TYPE_ENUM: |
||||||
|
case FieldDescriptor::TYPE_GROUP: |
||||||
|
case FieldDescriptor::TYPE_STRING: |
||||||
|
case FieldDescriptor::TYPE_BYTES: |
||||||
|
return ""; |
||||||
|
default: |
||||||
|
return PrimitiveRsTypeName(desc); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
} // namespace
|
||||||
|
|
||||||
|
void GenerateOneofDefinition(Context<OneofDescriptor> oneof) { |
||||||
|
const auto& desc = oneof.desc(); |
||||||
|
|
||||||
|
oneof.Emit( |
||||||
|
{{"view_enum_name", oneofViewEnumRsName(desc)}, |
||||||
|
{"view_fields", |
||||||
|
[&] { |
||||||
|
for (int i = 0; i < desc.field_count(); ++i) { |
||||||
|
const auto& field = desc.field(i); |
||||||
|
std::string rs_type = RsTypeName(*field); |
||||||
|
if (rs_type.empty()) { |
||||||
|
continue; |
||||||
|
} |
||||||
|
oneof.Emit({{"name", ToCamelCase(field->name())}, |
||||||
|
{"type", rs_type}, |
||||||
|
{"number", std::to_string(field->number())}}, |
||||||
|
R"rs($name$($type$) = $number$, |
||||||
|
)rs"); |
||||||
|
} |
||||||
|
}}}, |
||||||
|
// TODO(b/297342638): Revisit if isize is the optimal repr for this enum.
|
||||||
|
R"rs( |
||||||
|
#[non_exhaustive] |
||||||
|
#[derive(Debug, PartialEq)] |
||||||
|
#[repr(isize)] |
||||||
|
pub enum $view_enum_name$ { |
||||||
|
$view_fields$ |
||||||
|
|
||||||
|
#[allow(non_camel_case_types)] |
||||||
|
not_set = 0 |
||||||
|
} |
||||||
|
|
||||||
|
)rs"); |
||||||
|
|
||||||
|
// Note: This enum is used as the Thunk return type for getting which case is
|
||||||
|
// used: it exactly matches the generate case enum that both cpp and upb use.
|
||||||
|
oneof.Emit({{"case_enum_name", oneofCaseEnumName(desc)}, |
||||||
|
{"cases", |
||||||
|
[&] { |
||||||
|
for (int i = 0; i < desc.field_count(); ++i) { |
||||||
|
const auto& field = desc.field(i); |
||||||
|
oneof.Emit({{"name", ToCamelCase(field->name())}, |
||||||
|
{"number", std::to_string(field->number())}}, |
||||||
|
R"rs($name$ = $number$, |
||||||
|
)rs"); |
||||||
|
} |
||||||
|
}}}, |
||||||
|
R"rs( |
||||||
|
#[repr(C)] |
||||||
|
#[derive(Debug, Copy, Clone, PartialEq)] |
||||||
|
pub(super) enum $case_enum_name$ { |
||||||
|
$cases$ |
||||||
|
|
||||||
|
#[allow(non_camel_case_types)] |
||||||
|
not_set = 0 |
||||||
|
} |
||||||
|
|
||||||
|
)rs"); |
||||||
|
} |
||||||
|
|
||||||
|
void GenerateOneofAccessors(Context<OneofDescriptor> oneof) { |
||||||
|
const auto& desc = oneof.desc(); |
||||||
|
|
||||||
|
oneof.Emit( |
||||||
|
{{"oneof_name", desc.name()}, |
||||||
|
{"view_enum_name", oneofViewEnumRsName(desc)}, |
||||||
|
{"case_enum_name", oneofCaseEnumName(desc)}, |
||||||
|
{"cases", |
||||||
|
[&] { |
||||||
|
for (int i = 0; i < desc.field_count(); ++i) { |
||||||
|
const auto& field = desc.field(i); |
||||||
|
std::string rs_type = RsTypeName(*field); |
||||||
|
if (rs_type.empty()) { |
||||||
|
continue; |
||||||
|
} |
||||||
|
oneof.Emit( |
||||||
|
{ |
||||||
|
{"case", ToCamelCase(field->name())}, |
||||||
|
{"rs_getter", field->name()}, |
||||||
|
{"type", rs_type}, |
||||||
|
}, |
||||||
|
R"rs($Msg$_::$case_enum_name$::$case$ => $Msg$_::$view_enum_name$::$case$(self.$rs_getter$()), |
||||||
|
)rs"); |
||||||
|
} |
||||||
|
}}, |
||||||
|
{"case_thunk", Thunk(oneof, "case")}}, |
||||||
|
R"rs( |
||||||
|
pub fn r#$oneof_name$(&self) -> $Msg$_::$view_enum_name$ { |
||||||
|
match unsafe { $case_thunk$(self.inner.msg) } { |
||||||
|
$cases$ |
||||||
|
_ => $Msg$_::$view_enum_name$::not_set |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
)rs"); |
||||||
|
} |
||||||
|
|
||||||
|
void GenerateOneofExternC(Context<OneofDescriptor> oneof) { |
||||||
|
const auto& desc = oneof.desc(); |
||||||
|
oneof.Emit( |
||||||
|
{ |
||||||
|
{"case_enum_rs_name", oneofCaseEnumName(desc)}, |
||||||
|
{"case_thunk", Thunk(oneof, "case")}, |
||||||
|
}, |
||||||
|
R"rs( |
||||||
|
fn $case_thunk$(raw_msg: $pbi$::RawMessage) -> $Msg$_::$case_enum_rs_name$; |
||||||
|
)rs"); |
||||||
|
} |
||||||
|
|
||||||
|
void GenerateOneofThunkCc(Context<OneofDescriptor> oneof) { |
||||||
|
const auto& desc = oneof.desc(); |
||||||
|
oneof.Emit( |
||||||
|
{ |
||||||
|
{"oneof_name", desc.name()}, |
||||||
|
{"case_enum_name", oneofCaseEnumName(desc)}, |
||||||
|
{"case_thunk", Thunk(oneof, "case")}, |
||||||
|
{"QualifiedMsg", cpp::QualifiedClassName(desc.containing_type())}, |
||||||
|
}, |
||||||
|
R"cc( |
||||||
|
$QualifiedMsg$::$case_enum_name$ $case_thunk$($QualifiedMsg$* msg) { |
||||||
|
return msg->$oneof_name$_case(); |
||||||
|
} |
||||||
|
)cc"); |
||||||
|
} |
||||||
|
|
||||||
|
} // namespace rust
|
||||||
|
} // namespace compiler
|
||||||
|
} // namespace protobuf
|
||||||
|
} // namespace google
|
||||||
@ -0,0 +1,52 @@ |
|||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2023 Google LLC. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google LLC. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
#ifndef GOOGLE_PROTOBUF_COMPILER_RUST_ONEOF_H__ |
||||||
|
#define GOOGLE_PROTOBUF_COMPILER_RUST_ONEOF_H__ |
||||||
|
|
||||||
|
#include "google/protobuf/compiler/rust/context.h" |
||||||
|
#include "google/protobuf/descriptor.h" |
||||||
|
|
||||||
|
namespace google { |
||||||
|
namespace protobuf { |
||||||
|
namespace compiler { |
||||||
|
namespace rust { |
||||||
|
|
||||||
|
void GenerateOneofDefinition(Context<OneofDescriptor> oneof); |
||||||
|
void GenerateOneofAccessors(Context<OneofDescriptor> oneof); |
||||||
|
void GenerateOneofExternC(Context<OneofDescriptor> oneof); |
||||||
|
void GenerateOneofThunkCc(Context<OneofDescriptor> oneof); |
||||||
|
|
||||||
|
} // namespace rust
|
||||||
|
} // namespace compiler
|
||||||
|
} // namespace protobuf
|
||||||
|
} // namespace google
|
||||||
|
|
||||||
|
#endif // GOOGLE_PROTOBUF_COMPILER_RUST_ONEOF_H__
|
||||||
Loading…
Reference in new issue