Google Git
Sign in
pigweed / third_party / github / protocolbuffers / protobuf / 001be3c65545365574e13d0099b9eb241b338f2f
commit001be3c65545365574e13d0099b9eb241b338f2f[log] [tgz]
authorJakob Buchgraber <buchgr@google.com>Thu Nov 16 01:36:28 2023 -0800
committerCopybara-Service <copybara-worker@google.com>Thu Nov 16 01:38:42 2023 -0800
tree025e039c838a301e8c363cde66e2246087cfeac0
parent1fa484c4ed0877ea9ade22c3147175a476711589 [diff]
Implement Maps for scalar types for the C++ kernel

This CL implements Maps for scalar types for the C++ runtime. It's orthogonal to cl/580453646. This CL is constrained by having to force template instantiation of proto2::Map<K, V>. Put differently, a Rust protobuf::Map<K, V> implementation needs to call 'extern "C"' functions with both key and value type in the function name (e.g. __pb_rust_Map_i32_f64_get()). We use macros to generate a Map implementation for every (K,V)-pair. An alternative would have been to use vtables.

Luckily a key in a protobuf map can only be integer types, bool and string. So the number of key types is bounded by the specification, while the number of value types is not i.e. any protobuf message can be a value in a map. Given these constraints we introduce one 'MapKeyOps' trait per key type e.g. MapKeyBOOLOps or MapKeyI32Ops. These traits need to be implemented for every value type e.g. 'impl MapKeyBOOLOps for i32' will implement 'Map::<bool, i32>'. In particular the MapKeyOps traits can also be implemented for generated messages without violating the orphan rule.

This CL also contains significant changes to the UPB runtime so that both upb.rs and cpp.rs export a similar interface to simplify the implementation in  map.rs and the generated code.

This CL does not yet implement the Proxied trait.

PiperOrigin-RevId: 582951914
10 files changed
tree: 025e039c838a301e8c363cde66e2246087cfeac0
  1. .github/
  2. bazel/
  3. benchmarks/
  4. build_defs/
  5. ci/
  6. cmake/
  7. conformance/
  8. csharp/
  9. docs/
  10. editors/
  11. examples/
  12. java/
  13. lua/
  14. objectivec/
  15. php/
  16. pkg/
  17. protos/
  18. protos_generator/
  19. python/
  20. ruby/
  21. rust/
  22. src/
  23. third_party/
  24. toolchain/
  25. upb/
  26. upb_generator/
  27. .bazelignore
  28. .bazelrc
  29. .clang-format
  30. .gitignore
  31. .gitmodules
  32. .readthedocs.yml
  33. appveyor.bat
  34. appveyor.yml
  35. BUILD.bazel
  36. Cargo.bazel.lock
  37. Cargo.lock
  38. CMakeLists.txt
  39. CODE_OF_CONDUCT.md
  40. CONTRIBUTING.md
  41. CONTRIBUTORS.txt
  42. fix_permissions.sh
  43. generate_descriptor_proto.sh
  44. global.json
  45. google3_export_generated_files.sh
  46. LICENSE
  47. maven_install.json
  48. MODULE.bazel
  49. Protobuf-C++.podspec
  50. protobuf.bzl
  51. Protobuf.podspec
  52. protobuf_deps.bzl
  53. protobuf_release.bzl
  54. protobuf_version.bzl
  55. README.md
  56. regenerate_stale_files.sh
  57. SECURITY.md
  58. version.json
  59. WORKSPACE
README.md

Protocol Buffers - Google's data interchange format

OpenSSF Scorecard

Copyright 2023 Google LLC

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can learn more about it in protobuf's documentation.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Protobuf Compiler Installation

The protobuf compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our GitHub release page.

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the Maven repository.

These pre-built binaries are only provided for released versions. If you want to use the github main version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

LanguageSource
C++ (include C++ runtime and protoc)src
Javajava
Pythonpython
Objective-Cobjectivec
C#csharp
Rubyruby
Goprotocolbuffers/protobuf-go
PHPphp
Dartdart-lang/protobuf
JavaScriptprotocolbuffers/protobuf-javascript

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide.

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation is available at the Protocol Buffers doc site.

Support Policy

Read about our version support policy to stay current on support timeframes for the language libraries.

Developer Community

To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.