mirror of
https://github.com/protocolbuffers/protobuf
synced 2026-08-26 02:23:14 -04:00
fd6d8727c8
The goal of the `names.h` convention is to have a single canonical place where a code generator can define the set of symbols it exports to other code generators, and a canonical place where the name mangling logic is implemented. Each upb code generator now has its own `names.h` file defining the symbols that it owns & exports: * `third_party/upb/upb_generator/c/names.h` (for `foo.upb.h` files) * `third_party/upb/upb_generator/minitable/names.h` (for `foo.upb_minitable.h` files) * `third_party/upb/upb_generator/reflection/names.h` (for `foo.upbdefs.h` files) This is a significant improvement over the previous situation where the name mangling functions were co-mingled in `common.h`/`mangle.h`, or sprinkled throughout the generators, with no clear structure for which code generator owns which symbols. With this structure in place, the visibility lists for the various `names.h` files provide a clear dependency graph for how different generators depend on each other. In general, we want to keep dependencies on the "C" code generator to a minimum, since it is the largest and most complicated of upb's generated APIs, and is also the most prone to symbol name clashes. Note that upb's `names.h` headers are somewhat unusual, in that we do not want them to depend on C++'s reflection or upb's reflection. Most `names.h` headers in protobuf would use types like `proto2::Descriptor`, but we don't want upb to depend on C++ reflection, especially during its bootstrapping process. We also don't want to force users to build upb defs just to use these name mangling functions. So we use only plain string types like `absl::string_view` and `std::string`. PiperOrigin-RevId: 672397247
75 lines
2.3 KiB
C++
75 lines
2.3 KiB
C++
// 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
|
|
|
|
#ifndef UPB_GENERATOR_COMMON_H
|
|
#define UPB_GENERATOR_COMMON_H
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "absl/strings/str_replace.h"
|
|
#include "absl/strings/substitute.h"
|
|
#include "upb/reflection/def.hpp"
|
|
|
|
// Must be last.
|
|
#include "google/protobuf/port_def.inc"
|
|
|
|
namespace upb {
|
|
namespace generator {
|
|
|
|
class Output {
|
|
public:
|
|
template <class... Arg>
|
|
void operator()(absl::string_view format, const Arg&... arg) {
|
|
Write(absl::Substitute(format, arg...));
|
|
}
|
|
|
|
absl::string_view output() const { return output_; }
|
|
|
|
private:
|
|
void Write(absl::string_view data) {
|
|
std::string stripped;
|
|
if (absl::StartsWith(data, "\n ")) {
|
|
size_t indent = data.substr(1).find_first_not_of(' ');
|
|
if (indent != absl::string_view::npos) {
|
|
// Remove indentation from all lines.
|
|
auto line_prefix = data.substr(0, indent + 1);
|
|
// The final line has an extra newline and is indented two less, eg.
|
|
// R"cc(
|
|
// UPB_INLINE $0 $1_$2(const $1 *msg) {
|
|
// return $1_has_$2(msg) ? *UPB_PTR_AT(msg, $3, $0) : $4;
|
|
// }
|
|
// )cc",
|
|
std::string last_line_prefix = std::string(line_prefix);
|
|
last_line_prefix.resize(last_line_prefix.size() - 2);
|
|
data.remove_prefix(line_prefix.size());
|
|
stripped = absl::StrReplaceAll(
|
|
data, {{line_prefix, "\n"}, {last_line_prefix, "\n"}});
|
|
data = stripped;
|
|
}
|
|
}
|
|
absl::StrAppend(&output_, data);
|
|
}
|
|
|
|
std::string output_;
|
|
};
|
|
|
|
std::string FieldInitializer(upb::FieldDefPtr field,
|
|
const upb_MiniTableField* field64,
|
|
const upb_MiniTableField* field32);
|
|
std::string ArchDependentSize(int64_t size32, int64_t size64);
|
|
std::string GetModeInit(const upb_MiniTableField* field32,
|
|
const upb_MiniTableField* field64);
|
|
std::string GetFieldRep(const upb_MiniTableField* field32,
|
|
const upb_MiniTableField* field64);
|
|
|
|
} // namespace generator
|
|
} // namespace upb
|
|
|
|
#include "google/protobuf/port_undef.inc"
|
|
|
|
#endif // UPB_GENERATOR_COMMON_H
|