EIC code displayed by LXR master/​include/​google/​protobuf/​compiler/​cpp/​helpers.h	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-31 10:11:56

 // Protocol Buffers - Google's data interchange format
 // Copyright 2008 Google Inc.  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
 
 // Author: kenton@google.com (Kenton Varda)
 //  Based on original Protocol Buffers design by
 //  Sanjay Ghemawat, Jeff Dean, and others.
 
 #ifndef GOOGLE_PROTOBUF_COMPILER_CPP_HELPERS_H__
 #define GOOGLE_PROTOBUF_COMPILER_CPP_HELPERS_H__
 
 #include <iterator>
 #include <string>
 #include <tuple>
 #include <vector>
 
 #include "absl/container/flat_hash_map.h"
 #include "absl/log/absl_check.h"
 #include "absl/strings/str_cat.h"
 #include "absl/strings/str_split.h"
 #include "absl/strings/string_view.h"
 #include "absl/types/optional.h"
 #include "google/protobuf/compiler/code_generator.h"
 #include "google/protobuf/compiler/cpp/names.h"
 #include "google/protobuf/compiler/cpp/options.h"
 #include "google/protobuf/compiler/scc.h"
 #include "google/protobuf/descriptor.h"
 #include "google/protobuf/descriptor.pb.h"
 #include "google/protobuf/io/printer.h"
 #include "google/protobuf/port.h"
 
 
 // Must be included last.
 #include "google/protobuf/port_def.inc"
 
 namespace google {
 namespace protobuf {
 namespace compiler {
 namespace cpp {
 enum class ArenaDtorNeeds { kNone = 0, kOnDemand = 1, kRequired = 2 };
 
 inline absl::string_view ProtobufNamespace(const Options& opts) {
   // This won't be transformed by copybara, since copybara looks for google::protobuf::.
   constexpr absl::string_view kGoogle3Ns = "proto2";
   constexpr absl::string_view kOssNs = "google::protobuf";
 
   return opts.opensource_runtime ? kOssNs : kGoogle3Ns;
 }
 
 inline std::string MacroPrefix(const Options& options) {
   // Constants are different in the internal and external version.
   return options.opensource_runtime ? "GOOGLE_PROTOBUF" : "GOOGLE_PROTOBUF";
 }
 
 inline std::string DeprecatedAttribute(const Options&,
                                        const FieldDescriptor* d) {
   return d->options().deprecated() ? "[[deprecated]] " : "";
 }
 
 inline std::string DeprecatedAttribute(const Options&,
                                        const EnumValueDescriptor* d) {
   return d->options().deprecated() ? "[[deprecated]] " : "";
 }
 
 // Commonly-used separator comments.  Thick is a line of '=', thin is a line
 // of '-'.
 extern const char kThickSeparator[];
 extern const char kThinSeparator[];
 
 absl::flat_hash_map<absl::string_view, std::string> MessageVars(
     const Descriptor* desc);
 
 // Variables to access message data from the message scope.
 void SetCommonMessageDataVariables(
     const Descriptor* descriptor,
     absl::flat_hash_map<absl::string_view, std::string>* variables);
 
 absl::flat_hash_map<absl::string_view, std::string> UnknownFieldsVars(
     const Descriptor* desc, const Options& opts);
 
 void SetUnknownFieldsVariable(
     const Descriptor* descriptor, const Options& options,
     absl::flat_hash_map<absl::string_view, std::string>* variables);
 
 bool GetBootstrapBasename(const Options& options, absl::string_view basename,
                           std::string* bootstrap_basename);
 bool MaybeBootstrap(const Options& options, GeneratorContext* generator_context,
                     bool bootstrap_flag, std::string* basename);
 bool IsBootstrapProto(const Options& options, const FileDescriptor* file);
 
 // Name space of the proto file. This namespace is such that the string
 // "<namespace>::some_name" is the correct fully qualified namespace.
 // This means if the package is empty the namespace is "", and otherwise
 // the namespace is "::foo::bar::...::baz" without trailing semi-colons.
 std::string Namespace(const FileDescriptor* d, const Options& options);
 std::string Namespace(const Descriptor* d, const Options& options);
 std::string Namespace(const FieldDescriptor* d, const Options& options);
 std::string Namespace(const EnumDescriptor* d, const Options& options);
 PROTOC_EXPORT std::string Namespace(const FileDescriptor* d);
 PROTOC_EXPORT std::string Namespace(const Descriptor* d);
 PROTOC_EXPORT std::string Namespace(const FieldDescriptor* d);
 PROTOC_EXPORT std::string Namespace(const EnumDescriptor* d);
 
 class MessageSCCAnalyzer;
 
 // Returns true if it's safe to init "field" to zero.
 bool CanInitializeByZeroing(const FieldDescriptor* field,
                             const Options& options,
                             MessageSCCAnalyzer* scc_analyzer);
 // Returns true if it's safe to reset "field" to zero.
 bool CanClearByZeroing(const FieldDescriptor* field);
 // Determines if swap can be implemented via memcpy.
 bool HasTrivialSwap(const FieldDescriptor* field, const Options& options,
                     MessageSCCAnalyzer* scc_analyzer);
 
 PROTOC_EXPORT std::string ClassName(const Descriptor* descriptor);
 PROTOC_EXPORT std::string ClassName(const EnumDescriptor* enum_descriptor);
 
 std::string QualifiedClassName(const Descriptor* d, const Options& options);
 std::string QualifiedClassName(const EnumDescriptor* d, const Options& options);
 
 PROTOC_EXPORT std::string QualifiedClassName(const Descriptor* d);
 PROTOC_EXPORT std::string QualifiedClassName(const EnumDescriptor* d);
 
 // DEPRECATED just use ClassName or QualifiedClassName, a boolean is very
 // unreadable at the callsite.
 // Returns the non-nested type name for the given type.  If "qualified" is
 // true, prefix the type with the full namespace.  For example, if you had:
 //   package foo.bar;
 //   message Baz { message Moo {} }
 // Then the qualified ClassName for Moo would be:
 //   ::foo::bar::Baz_Moo
 // While the non-qualified version would be:
 //   Baz_Moo
 inline std::string ClassName(const Descriptor* descriptor, bool qualified) {
   return qualified ? QualifiedClassName(descriptor, Options())
                    : ClassName(descriptor);
 }
 
 inline std::string ClassName(const EnumDescriptor* descriptor, bool qualified) {
   return qualified ? QualifiedClassName(descriptor, Options())
                    : ClassName(descriptor);
 }
 
 // Returns the extension name prefixed with the class name if nested but without
 // the package name.
 std::string ExtensionName(const FieldDescriptor* d);
 
 std::string QualifiedExtensionName(const FieldDescriptor* d,
                                    const Options& options);
 std::string QualifiedExtensionName(const FieldDescriptor* d);
 
 // Type name of default instance.
 std::string DefaultInstanceType(const Descriptor* descriptor,
                                 const Options& options, bool split = false);
 
 // Non-qualified name of the default_instance of this message.
 std::string DefaultInstanceName(const Descriptor* descriptor,
                                 const Options& options, bool split = false);
 
 // Non-qualified name of the default instance pointer. This is used only for
 // implicit weak fields, where we need an extra indirection.
 std::string DefaultInstancePtr(const Descriptor* descriptor,
                                const Options& options, bool split = false);
 
 // Fully qualified name of the default_instance of this message.
 std::string QualifiedDefaultInstanceName(const Descriptor* descriptor,
                                          const Options& options,
                                          bool split = false);
 
 // Fully qualified name of the default instance pointer.
 std::string QualifiedDefaultInstancePtr(const Descriptor* descriptor,
                                         const Options& options,
                                         bool split = false);
 
 // DescriptorTable variable name.
 std::string DescriptorTableName(const FileDescriptor* file,
                                 const Options& options);
 
 // When declaring symbol externs from another file, this macro will supply the
 // dllexport needed for the target file, if any.
 std::string FileDllExport(const FileDescriptor* file, const Options& options);
 
 // Name of the base class: google::protobuf::Message or google::protobuf::MessageLite.
 std::string SuperClassName(const Descriptor* descriptor,
                            const Options& options);
 
 // Adds an underscore if necessary to prevent conflicting with a keyword.
 std::string ResolveKeyword(absl::string_view name);
 
 // Get the (unqualified) name that should be used for this field in C++ code.
 // The name is coerced to lower-case to emulate proto1 behavior.  People
 // should be using lowercase-with-underscores style for proto field names
 // anyway, so normally this just returns field->name().
 PROTOC_EXPORT std::string FieldName(const FieldDescriptor* field);
 
 // Returns the (unqualified) private member name for this field in C++ code.
 std::string FieldMemberName(const FieldDescriptor* field, bool split);
 
 // Returns an estimate of the compiler's alignment for the field.  This
 // can't guarantee to be correct because the generated code could be compiled on
 // different systems with different alignment rules.  The estimates below assume
 // 64-bit pointers.
 int EstimateAlignmentSize(const FieldDescriptor* field);
 
 // Returns an estimate of the size of the field.  This
 // can't guarantee to be correct because the generated code could be compiled on
 // different systems with different alignment rules.  The estimates below assume
 // 64-bit pointers.
 int EstimateSize(const FieldDescriptor* field);
 
 // Get the unqualified name that should be used for a field's field
 // number constant.
 std::string FieldConstantName(const FieldDescriptor* field);
 
 // Returns the scope where the field was defined (for extensions, this is
 // different from the message type to which the field applies).
 inline const Descriptor* FieldScope(const FieldDescriptor* field) {
   return field->is_extension() ? field->extension_scope()
                                : field->containing_type();
 }
 
 // Returns the fully-qualified type name field->message_type().  Usually this
 // is just ClassName(field->message_type(), true);
 std::string FieldMessageTypeName(const FieldDescriptor* field,
                                  const Options& options);
 
 // Get the C++ type name for a primitive type (e.g. "double", "::int32", etc.).
 const char* PrimitiveTypeName(FieldDescriptor::CppType type);
 std::string PrimitiveTypeName(const Options& options,
                               FieldDescriptor::CppType type);
 
 // Get the declared type name in CamelCase format, as is used e.g. for the
 // methods of WireFormat.  For example, TYPE_INT32 becomes "Int32".
 const char* DeclaredTypeMethodName(FieldDescriptor::Type type);
 
 // Return the code that evaluates to the number when compiled.
 std::string Int32ToString(int number);
 
 // Get code that evaluates to the field's default value.
 std::string DefaultValue(const Options& options, const FieldDescriptor* field);
 
 // Compatibility function for callers outside proto2.
 std::string DefaultValue(const FieldDescriptor* field);
 
 // Convert a file name into a valid identifier.
 std::string FilenameIdentifier(absl::string_view filename);
 
 // For each .proto file generates a unique name. To prevent collisions of
 // symbols in the global namespace
 std::string UniqueName(absl::string_view name, absl::string_view filename,
                        const Options& options);
 inline std::string UniqueName(absl::string_view name, const FileDescriptor* d,
                               const Options& options) {
   return UniqueName(name, d->name(), options);
 }
 inline std::string UniqueName(absl::string_view name, const Descriptor* d,
                               const Options& options) {
   return UniqueName(name, d->file(), options);
 }
 inline std::string UniqueName(absl::string_view name, const EnumDescriptor* d,
                               const Options& options) {
   return UniqueName(name, d->file(), options);
 }
 inline std::string UniqueName(absl::string_view name,
                               const ServiceDescriptor* d,
                               const Options& options) {
   return UniqueName(name, d->file(), options);
 }
 
 // Versions for call sites that only support the internal runtime (like proto1
 // support).
 inline Options InternalRuntimeOptions() {
   Options options;
   options.opensource_runtime = false;
   return options;
 }
 inline std::string UniqueName(absl::string_view name,
                               absl::string_view filename) {
   return UniqueName(name, filename, InternalRuntimeOptions());
 }
 inline std::string UniqueName(absl::string_view name, const FileDescriptor* d) {
   return UniqueName(name, d->name(), InternalRuntimeOptions());
 }
 inline std::string UniqueName(absl::string_view name, const Descriptor* d) {
   return UniqueName(name, d->file(), InternalRuntimeOptions());
 }
 inline std::string UniqueName(absl::string_view name, const EnumDescriptor* d) {
   return UniqueName(name, d->file(), InternalRuntimeOptions());
 }
 inline std::string UniqueName(absl::string_view name,
                               const ServiceDescriptor* d) {
   return UniqueName(name, d->file(), InternalRuntimeOptions());
 }
 
 // Return the qualified C++ name for a file level symbol.
 std::string QualifiedFileLevelSymbol(const FileDescriptor* file,
                                      absl::string_view name,
                                      const Options& options);
 
 // Escape C++ trigraphs by escaping question marks to \?
 std::string EscapeTrigraphs(absl::string_view to_escape);
 
 // Escaped function name to eliminate naming conflict.
 std::string SafeFunctionName(const Descriptor* descriptor,
                              const FieldDescriptor* field,
                              absl::string_view prefix);
 
 // Returns the optimize mode for <file>, respecting <options.enforce_lite>.
 FileOptions_OptimizeMode GetOptimizeFor(const FileDescriptor* file,
                                         const Options& options);
 
 // Determines whether unknown fields will be stored in an UnknownFieldSet or
 // a string.
 inline bool UseUnknownFieldSet(const FileDescriptor* file,
                                const Options& options) {
   return GetOptimizeFor(file, options) != FileOptions::LITE_RUNTIME;
 }
 
 inline bool IsWeak(const FieldDescriptor* field, const Options& options) {
   if (field->options().weak()) {
     ABSL_CHECK(!options.opensource_runtime);
     return true;
   }
   return false;
 }
 
 inline bool IsCord(const FieldDescriptor* field) {
   return field->cpp_type() == FieldDescriptor::CPPTYPE_STRING &&
          internal::cpp::EffectiveStringCType(field) == FieldOptions::CORD;
 }
 
 inline bool IsString(const FieldDescriptor* field) {
   return field->cpp_type() == FieldDescriptor::CPPTYPE_STRING &&
          internal::cpp::EffectiveStringCType(field) == FieldOptions::STRING;
 }
 
 inline bool IsStringPiece(const FieldDescriptor* field) {
   return field->cpp_type() == FieldDescriptor::CPPTYPE_STRING &&
          internal::cpp::EffectiveStringCType(field) ==
              FieldOptions::STRING_PIECE;
 }
 
 bool IsProfileDriven(const Options& options);
 
 // Returns true if `field` is unlikely to be present based on PDProto profile.
 bool IsRarelyPresent(const FieldDescriptor* field, const Options& options);
 
 // Returns true if `field` is likely to be present based on PDProto profile.
 bool IsLikelyPresent(const FieldDescriptor* field, const Options& options);
 
 float GetPresenceProbability(const FieldDescriptor* field,
                              const Options& options);
 
 bool IsStringInliningEnabled(const Options& options);
 
 // Returns true if the provided field is a singular string and can be inlined.
 bool CanStringBeInlined(const FieldDescriptor* field);
 
 // Returns true if `field` is a string field that can and should be inlined
 // based on PDProto profile.
 bool IsStringInlined(const FieldDescriptor* field, const Options& options);
 
 // Returns true if `field` should be inlined based on PDProto profile.
 // Currently we only enable inlining for string fields backed by a std::string
 // instance, but in the future we may expand this to message types.
 inline bool IsFieldInlined(const FieldDescriptor* field,
                            const Options& options) {
   return IsStringInlined(field, options);
 }
 
 // Does the given FileDescriptor use lazy fields?
 bool HasLazyFields(const FileDescriptor* file, const Options& options,
                    MessageSCCAnalyzer* scc_analyzer);
 
 // Is the given field a supported lazy field?
 bool IsLazy(const FieldDescriptor* field, const Options& options,
             MessageSCCAnalyzer* scc_analyzer);
 
 // Is this an explicit (non-profile driven) lazy field, as denoted by
 // lazy/unverified_lazy in the descriptor?
 inline bool IsExplicitLazy(const FieldDescriptor* field) {
   if (field->is_map() || field->is_repeated()) {
     return false;
   }
 
   if (field->cpp_type() != FieldDescriptor::CPPTYPE_MESSAGE) {
     return false;
   }
 
   return field->options().lazy() || field->options().unverified_lazy();
 }
 
 internal::field_layout::TransformValidation GetLazyStyle(
     const FieldDescriptor* field, const Options& options,
     MessageSCCAnalyzer* scc_analyzer);
 
 bool IsEagerlyVerifiedLazy(const FieldDescriptor* field, const Options& options,
                            MessageSCCAnalyzer* scc_analyzer);
 
 bool IsLazilyVerifiedLazy(const FieldDescriptor* field, const Options& options);
 
 bool ShouldVerify(const Descriptor* descriptor, const Options& options,
                   MessageSCCAnalyzer* scc_analyzer);
 bool ShouldVerify(const FileDescriptor* file, const Options& options,
                   MessageSCCAnalyzer* scc_analyzer);
 bool ShouldVerifyRecursively(const FieldDescriptor* field);
 
 // Indicates whether to use predefined verify methods for a given message. If a
 // message is "simple" and needs no special verification per field (e.g. message
 // field, repeated packed, UTF8 string, etc.), we can use either VerifySimple or
 // VerifySimpleAlwaysCheckInt32 methods as all verification can be done based on
 // the wire type.
 //
 // Otherwise, we need "custom" verify methods tailored to a message to pass
 // which field needs a special verification; i.e. InternalVerify.
 enum class VerifySimpleType {
   kSimpleInt32Never,   // Use VerifySimple
   kSimpleInt32Always,  // Use VerifySimpleAlwaysCheckInt32
   kCustom,             // Use InternalVerify and check only for int32
   kCustomInt32Never,   // Use InternalVerify but never check for int32
   kCustomInt32Always,  // Use InternalVerify and always check for int32
 };
 
 // Returns VerifySimpleType if messages can be verified by predefined methods.
 VerifySimpleType ShouldVerifySimple(const Descriptor* descriptor);
 
 
 // Is the given message being split (go/pdsplit)?
 bool ShouldSplit(const Descriptor* desc, const Options& options);
 
 // Is the given field being split out?
 bool ShouldSplit(const FieldDescriptor* field, const Options& options);
 
 // Should we generate code that force creating an allocation in the constructor
 // of the given message?
 bool ShouldForceAllocationOnConstruction(const Descriptor* desc,
                                          const Options& options);
 
 // Returns true if the message is present based on PDProto profile.
 bool IsPresentMessage(const Descriptor* descriptor, const Options& options);
 
 // Returns the most likely present field. Returns nullptr if not profile driven.
 const FieldDescriptor* FindHottestField(
     const std::vector<const FieldDescriptor*>& fields, const Options& options);
 
 // Does the file contain any definitions that need extension_set.h?
 bool HasExtensionsOrExtendableMessage(const FileDescriptor* file);
 
 // Does the file have any repeated fields, necessitating the file to include
 // repeated_field.h? This does not include repeated extensions, since those are
 // all stored internally in an ExtensionSet, not a separate RepeatedField*.
 bool HasRepeatedFields(const FileDescriptor* file);
 
 // Does the file have any string/bytes fields with ctype=STRING_PIECE? This
 // does not include extensions, since ctype is ignored for extensions.
 bool HasStringPieceFields(const FileDescriptor* file, const Options& options);
 
 // Does the file have any string/bytes fields with ctype=CORD? This does not
 // include extensions, since ctype is ignored for extensions.
 bool HasCordFields(const FileDescriptor* file, const Options& options);
 
 // Does the file have any map fields, necessitating the file to include
 // map_field_inl.h and map.h.
 bool HasMapFields(const FileDescriptor* file);
 
 // Does this file have any enum type definitions?
 bool HasEnumDefinitions(const FileDescriptor* file);
 
 // Does this file have generated parsing, serialization, and other
 // standard methods for which reflection-based fallback implementations exist?
 inline bool HasGeneratedMethods(const FileDescriptor* file,
                                 const Options& options) {
   return GetOptimizeFor(file, options) != FileOptions::CODE_SIZE;
 }
 
 // Do message classes in this file have descriptor and reflection methods?
 inline bool HasDescriptorMethods(const FileDescriptor* file,
                                  const Options& options) {
   return GetOptimizeFor(file, options) != FileOptions::LITE_RUNTIME;
 }
 
 // Should we generate generic services for this file?
 inline bool HasGenericServices(const FileDescriptor* file,
                                const Options& options) {
   return file->service_count() > 0 &&
          GetOptimizeFor(file, options) != FileOptions::LITE_RUNTIME &&
          file->options().cc_generic_services();
 }
 
 inline bool IsProto2MessageSet(const Descriptor* descriptor,
                                const Options& options) {
   return !options.opensource_runtime &&
          options.enforce_mode != EnforceOptimizeMode::kLiteRuntime &&
          !options.lite_implicit_weak_fields &&
          descriptor->options().message_set_wire_format() &&
          descriptor->full_name() == "google.protobuf.bridge.MessageSet";
 }
 
 inline bool IsMapEntryMessage(const Descriptor* descriptor) {
   return descriptor->options().map_entry();
 }
 
 // Returns true if the field's CPPTYPE is string or message.
 bool IsStringOrMessage(const FieldDescriptor* field);
 
 std::string UnderscoresToCamelCase(absl::string_view input,
                                    bool cap_next_letter);
 
 inline bool IsCrossFileMessage(const FieldDescriptor* field) {
   return field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE &&
          field->message_type()->file() != field->file();
 }
 
 inline std::string MakeDefaultName(const FieldDescriptor* field) {
   return absl::StrCat("_i_give_permission_to_break_this_code_default_",
                       FieldName(field), "_");
 }
 
 // Semantically distinct from MakeDefaultName in that it gives the C++ code
 // referencing a default field from the message scope, rather than just the
 // variable name.
 // For example, declarations of default variables should always use just
 // MakeDefaultName to produce code like:
 //   Type _i_give_permission_to_break_this_code_default_field_;
 //
 // Code that references these should use MakeDefaultFieldName, in case the field
 // exists at some nested level like:
 //   internal_container_._i_give_permission_to_break_this_code_default_field_;
 inline std::string MakeDefaultFieldName(const FieldDescriptor* field) {
   return absl::StrCat("Impl_::", MakeDefaultName(field));
 }
 
 inline std::string MakeVarintCachedSizeName(const FieldDescriptor* field) {
   return absl::StrCat("_", FieldName(field), "_cached_byte_size_");
 }
 
 // Semantically distinct from MakeVarintCachedSizeName in that it gives the C++
 // code referencing the object from the message scope, rather than just the
 // variable name.
 // For example, declarations of default variables should always use just
 // MakeVarintCachedSizeName to produce code like:
 //   Type _field_cached_byte_size_;
 //
 // Code that references these variables should use
 // MakeVarintCachedSizeFieldName, in case the field exists at some nested level
 // like:
 //   internal_container_._field_cached_byte_size_;
 inline std::string MakeVarintCachedSizeFieldName(const FieldDescriptor* field,
                                                  bool split) {
   return absl::StrCat("_impl_.", split ? "_split_->" : "", "_",
                       FieldName(field), "_cached_byte_size_");
 }
 
 // Note: A lot of libraries detect Any protos based on Descriptor::full_name()
 // while the two functions below use FileDescriptor::name(). In a sane world the
 // two approaches should be equivalent. But if you are dealing with descriptors
 // from untrusted sources, you might need to match semantics across libraries.
 bool IsAnyMessage(const FileDescriptor* descriptor);
 bool IsAnyMessage(const Descriptor* descriptor);
 
 bool IsWellKnownMessage(const FileDescriptor* descriptor);
 
 enum class GeneratedFileType : int { kPbH, kProtoH, kProtoStaticReflectionH };
 
 inline std::string IncludeGuard(const FileDescriptor* file,
                                 GeneratedFileType file_type,
                                 const Options& options) {
   // If we are generating a .pb.h file and the proto_h option is enabled, then
   // the .pb.h gets an extra suffix.
   std::string extension;
   switch (file_type) {
     case GeneratedFileType::kPbH:
       extension = ".pb.h";
       break;
     case GeneratedFileType::kProtoH:
       extension = ".proto.h";
       break;
     case GeneratedFileType::kProtoStaticReflectionH:
       extension = ".proto.static_reflection.h";
   }
   std::string filename_identifier =
       FilenameIdentifier(absl::StrCat(file->name(), extension));
 
   if (IsWellKnownMessage(file)) {
     // For well-known messages we need third_party/protobuf and net/proto2 to
     // have distinct include guards, because some source files include both and
     // both need to be defined (the third_party copies will be in the
     // google::protobuf_opensource namespace).
     return absl::StrCat(MacroPrefix(options), "_INCLUDED_",
                         filename_identifier);
   } else {
     // Ideally this case would use distinct include guards for opensource and
     // google3 protos also.  (The behavior of "first #included wins" is not
     // ideal).  But unfortunately some legacy code includes both and depends on
     // the identical include guards to avoid compile errors.
     //
     // We should clean this up so that this case can be removed.
     return absl::StrCat("GOOGLE_PROTOBUF_INCLUDED_", filename_identifier);
   }
 }
 
 // Returns the OptimizeMode for this file, furthermore it updates a status
 // bool if has_opt_codesize_extension is non-null. If this status bool is true
 // it means this file contains an extension that itself is defined as
 // optimized_for = CODE_SIZE.
 FileOptions_OptimizeMode GetOptimizeFor(const FileDescriptor* file,
                                         const Options& options,
                                         bool* has_opt_codesize_extension);
 inline FileOptions_OptimizeMode GetOptimizeFor(const FileDescriptor* file,
                                                const Options& options) {
   return GetOptimizeFor(file, options, nullptr);
 }
 inline bool NeedsEagerDescriptorAssignment(const FileDescriptor* file,
                                            const Options& options) {
   bool has_opt_codesize_extension;
   if (GetOptimizeFor(file, options, &has_opt_codesize_extension) ==
           FileOptions::CODE_SIZE &&
       has_opt_codesize_extension) {
     // If this filedescriptor contains an extension from another file which
     // is optimized_for = CODE_SIZE. We need to be careful in the ordering so
     // we eagerly build the descriptors in the dependencies before building
     // the descriptors of this file.
     return true;
   } else {
     // If we have a generated code based parser we never need eager
     // initialization of descriptors of our deps.
     return false;
   }
 }
 
 // This orders the messages in a .pb.cc as it's outputted by file.cc
 void FlattenMessagesInFile(const FileDescriptor* file,
                            std::vector<const Descriptor*>* result);
 inline std::vector<const Descriptor*> FlattenMessagesInFile(
     const FileDescriptor* file) {
   std::vector<const Descriptor*> result;
   FlattenMessagesInFile(file, &result);
   return result;
 }
 
 std::vector<const Descriptor*> TopologicalSortMessagesInFile(
     const FileDescriptor* file, MessageSCCAnalyzer& scc_analyzer);
 
 bool HasWeakFields(const Descriptor* desc, const Options& options);
 bool HasWeakFields(const FileDescriptor* desc, const Options& options);
 
 // Returns true if the "required" restriction check should be ignored for the
 // given field.
 inline static bool ShouldIgnoreRequiredFieldCheck(const FieldDescriptor* field,
                                                   const Options& options) {
   // Do not check "required" for lazily verified lazy fields.
   return IsLazilyVerifiedLazy(field, options);
 }
 
 struct MessageAnalysis {
   bool is_recursive = false;
   bool contains_cord = false;
   bool contains_extension = false;
   bool contains_required = false;
   bool contains_weak = false;  // Implicit weak as well.
 };
 
 // This class is used in FileGenerator, to ensure linear instead of
 // quadratic performance, if we do this per message we would get O(V*(V+E)).
 // Logically this is just only used in message.cc, but in the header for
 // FileGenerator to help share it.
 class PROTOC_EXPORT MessageSCCAnalyzer {
  public:
   explicit MessageSCCAnalyzer(const Options& options) : options_(options) {}
 
   MessageAnalysis GetSCCAnalysis(const SCC* scc);
 
   bool HasRequiredFields(const Descriptor* descriptor) {
     MessageAnalysis result = GetSCCAnalysis(GetSCC(descriptor));
     return result.contains_required || result.contains_extension;
   }
   bool HasWeakField(const Descriptor* descriptor) {
     MessageAnalysis result = GetSCCAnalysis(GetSCC(descriptor));
     return result.contains_weak;
   }
   const SCC* GetSCC(const Descriptor* descriptor) {
     return analyzer_.GetSCC(descriptor);
   }
 
  private:
   struct DepsGenerator {
     std::vector<const Descriptor*> operator()(const Descriptor* desc) const {
       std::vector<const Descriptor*> deps;
       for (int i = 0; i < desc->field_count(); i++) {
         if (desc->field(i)->message_type()) {
           deps.push_back(desc->field(i)->message_type());
         }
       }
       return deps;
     }
   };
   SCCAnalyzer<DepsGenerator> analyzer_;
   Options options_;
   absl::flat_hash_map<const SCC*, MessageAnalysis> analysis_cache_;
 };
 
 void ListAllFields(const Descriptor* d,
                    std::vector<const FieldDescriptor*>* fields);
 void ListAllFields(const FileDescriptor* d,
                    std::vector<const FieldDescriptor*>* fields);
 
 template <bool do_nested_types, class T>
 void ForEachField(const Descriptor* d, T&& func) {
   if (do_nested_types) {
     for (int i = 0; i < d->nested_type_count(); i++) {
       ForEachField<true>(d->nested_type(i), std::forward<T&&>(func));
     }
   }
   for (int i = 0; i < d->extension_count(); i++) {
     func(d->extension(i));
   }
   for (int i = 0; i < d->field_count(); i++) {
     func(d->field(i));
   }
 }
 
 template <class T>
 void ForEachField(const FileDescriptor* d, T&& func) {
   for (int i = 0; i < d->message_type_count(); i++) {
     ForEachField<true>(d->message_type(i), std::forward<T&&>(func));
   }
   for (int i = 0; i < d->extension_count(); i++) {
     func(d->extension(i));
   }
 }
 
 void ListAllTypesForServices(const FileDescriptor* fd,
                              std::vector<const Descriptor*>* types);
 
 // Whether this type should use the implicit weak feature for descriptor based
 // objects.
 //
 // This feature allows tree shaking within a single translation unit by
 // decoupling the messages from the TU-wide `file_default_instances` array.
 // This way there are no static initializers in the TU pointing to any part of
 // the generated classes and they can be GC'd by the linker.
 // Instead of direct use, we have two ways to weakly refer to the default
 // instances:
 //  - Each default instance is located on its own section, and we use a
 //    `&__start_section_name` pointer to access it. This is a reference that
 //    allows GC to happen. This step is used with dynamic linking.
 //  - We also allow merging all these sections at link time into the
 //    `pb_defaults` section. All surviving messages will be injected back into
 //    the `file_default_instances` when the runtime is initialized. This is
 //    useful when doing static linking and you want to avoid having an unbounded
 //    number of sections.
 //
 // Any object that gets GC'd will have a `nullptr` in the respective slot in the
 // `file_default_instances` array. The runtime will recognize this and will
 // dynamically generate the object if needed. This logic is in the
 // `GeneratedMessageFactory::GetPrototype`.  It will fall back to a
 // `DynamicMessage` for the missing objects.
 // This allows all of reflection to keep working normally, even for types that
 // were dropped. Note that dropping the _classes_ will not drop the descriptor
 // information. The messages are still going to be registered in the generated
 // `DescriptorPool` and will be available via normal `FindMessageTypeByName` and
 // friends.
 //
 // A "pin" is adding dependency edge in the graph for the GC.
 // The default instance and vtable of a message pin each other. If any one
 // lives, they both do. This is important. The default instance of the message
 // pins the vtable trivially by using it. The vtable pins the default instance
 // by having a StrongPointer into it from any of the virtual functions.
 //
 // All parent messages pin their children.
 // SPEED messages do this implicitly via the TcParseTable, which contain
 // pointers to the submessages.
 // CODE_SIZE messages explicitly add a pin via `StrongPointer` somewhere in
 // their codegen.
 // LITE messages do not participate at all in this feature.
 //
 // For extensions, the identifiers currently pin the extendee. The extended is
 // assumed to by pinned elsewhere since we already have an instance of it when
 // we call `.GetExtension` et al. The extension identifier itself is not
 // automatically pinned, so it has to be used to participate in the graph.
 // Registration of the extensions do not pin the extended or the extendee. At
 // registration time we will eagerly create a prototype object if one is
 // missing to insert in the extension table in ExtensionSet.
 //
 // For services, the TU unconditionally pins the request/response objects.
 // This is the status quo for simplicitly to avoid modifying the RPC layer. It
 // might be improved in the future.
 bool UsingImplicitWeakDescriptor(const FileDescriptor* file,
                                  const Options& options);
 
 // Generates a strong reference to the message in `desc`, as a statement.
 std::string StrongReferenceToType(const Descriptor* desc,
                                   const Options& options);
 
 // Generates the section name to be used for a data object when using implicit
 // weak descriptors. The prefix determines the kind of object and the section it
 // will be merged into afterwards.
 // See `UsingImplicitWeakDescriptor` above.
 std::string WeakDescriptorDataSection(absl::string_view prefix,
                                       const Descriptor* descriptor,
                                       int index_in_file_messages,
                                       const Options& options);
 
 // Section name to be used for the default instance for implicit weak descriptor
 // objects. See `UsingImplicitWeakDescriptor` above.
 inline std::string WeakDefaultInstanceSection(const Descriptor* descriptor,
                                               int index_in_file_messages,
                                               const Options& options) {
   return WeakDescriptorDataSection("def", descriptor, index_in_file_messages,
                                    options);
 }
 
 // Indicates whether we should use implicit weak fields for this file.
 bool UsingImplicitWeakFields(const FileDescriptor* file,
                              const Options& options);
 
 // Indicates whether to treat this field as implicitly weak.
 bool IsImplicitWeakField(const FieldDescriptor* field, const Options& options,
                          MessageSCCAnalyzer* scc_analyzer);
 
 inline std::string SimpleBaseClass(const Descriptor* desc,
                                    const Options& options) {
   // The only base class we have derived from `Message`.
   if (!HasDescriptorMethods(desc->file(), options)) return "";
   // We don't use the base class to be able to inject the weak descriptor pins.
   if (UsingImplicitWeakDescriptor(desc->file(), options)) return "";
   if (desc->extension_range_count() != 0) return "";
   // Don't use a simple base class if the field tracking is enabled. This
   // ensures generating all methods to track.
   if (options.field_listener_options.inject_field_listener_events) return "";
   if (desc->field_count() == 0) {
     return "ZeroFieldsBase";
   }
   // TODO: Support additional common message types with only one
   // or two fields
   return "";
 }
 
 inline bool HasSimpleBaseClass(const Descriptor* desc, const Options& options) {
   return !SimpleBaseClass(desc, options).empty();
 }
 
 inline bool HasSimpleBaseClasses(const FileDescriptor* file,
                                  const Options& options) {
   return internal::cpp::VisitDescriptorsInFileOrder(
       file, [&](const Descriptor* desc) {
         return HasSimpleBaseClass(desc, options);
       });
 }
 
 // Returns true if this message has a _tracker_ field.
 inline bool HasTracker(const Descriptor* desc, const Options& options) {
   return options.field_listener_options.inject_field_listener_events &&
          desc->file()->options().optimize_for() !=
              google::protobuf::FileOptions::LITE_RUNTIME &&
          !IsMapEntryMessage(desc);
 }
 
 // Returns true if this message needs an Impl_ struct for it's data.
 inline bool HasImplData(const Descriptor* desc, const Options& options) {
   return !HasSimpleBaseClass(desc, options);
 }
 
 // DO NOT USE IN NEW CODE! Use io::Printer directly instead. See b/242326974.
 //
 // Formatter is a functor class which acts as a closure around printer and
 // the variable map. It's much like printer->Print except it supports both named
 // variables that are substituted using a key value map and direct arguments. In
 // the format string $1$, $2$, etc... are substituted for the first, second, ...
 // direct argument respectively in the format call, it accepts both strings and
 // integers. The implementation verifies all arguments are used and are "first"
 // used in order of appearance in the argument list. For example,
 //
 // Format("return array[$1$];", 3) -> "return array[3];"
 // Format("array[$2$] = $1$;", "Bla", 3) -> FATAL error (wrong order)
 // Format("array[$1$] = $2$;", 3, "Bla") -> "array[3] = Bla;"
 //
 // The arguments can be used more than once like
 //
 // Format("array[$1$] = $2$;  // Index = $1$", 3, "Bla") ->
 //        "array[3] = Bla;  // Index = 3"
 //
 // If you use more arguments use the following style to help the reader,
 //
 // Format("int $1$() {\n"
 //        "  array[$2$] = $3$;\n"
 //        "  return $4$;"
 //        "}\n",
 //        funname, // 1
 //        idx,  // 2
 //        varname,  // 3
 //        retval);  // 4
 //
 // but consider using named variables. Named variables like $foo$, with some
 // identifier foo, are looked up in the map. One additional feature is that
 // spaces are accepted between the '$' delimiters, $ foo$ will
 // substitute to " bar" if foo stands for "bar", but in case it's empty
 // will substitute to "". Hence, for example,
 //
 // Format(vars, "$dllexport $void fun();") -> "void fun();"
 //                                            "__declspec(export) void fun();"
 //
 // which is convenient to prevent double, leading or trailing spaces.
 class PROTOC_EXPORT Formatter {
  public:
   explicit Formatter(io::Printer* printer) : printer_(printer) {}
   Formatter(io::Printer* printer,
             const absl::flat_hash_map<absl::string_view, std::string>& vars)
       : printer_(printer), vars_(vars) {}
 
   template <typename T>
   void Set(absl::string_view key, const T& value) {
     vars_[key] = ToString(value);
   }
 
   template <typename... Args>
   void operator()(const char* format, const Args&... args) const {
     printer_->FormatInternal({ToString(args)...}, vars_, format);
   }
 
   void Indent() const { printer_->Indent(); }
   void Outdent() const { printer_->Outdent(); }
   io::Printer* printer() const { return printer_; }
 
   class PROTOC_EXPORT ScopedIndenter {
    public:
     explicit ScopedIndenter(Formatter* format) : format_(format) {
       format_->Indent();
     }
     ~ScopedIndenter() { format_->Outdent(); }
 
    private:
     Formatter* format_;
   };
 
   PROTOBUF_NODISCARD ScopedIndenter ScopedIndent() {
     return ScopedIndenter(this);
   }
   template <typename... Args>
   PROTOBUF_NODISCARD ScopedIndenter ScopedIndent(const char* format,
                                                  const Args&&... args) {
     (*this)(format, static_cast<Args&&>(args)...);
     return ScopedIndenter(this);
   }
 
  private:
   io::Printer* printer_;
   absl::flat_hash_map<absl::string_view, std::string> vars_;
 
   // Convenience overloads to accept different types as arguments.
   static std::string ToString(absl::string_view s) { return std::string(s); }
   template <typename I, typename = typename std::enable_if<
                             std::is_integral<I>::value>::type>
   static std::string ToString(I x) {
     return absl::StrCat(x);
   }
   static std::string ToString(absl::Hex x) { return absl::StrCat(x); }
   static std::string ToString(const FieldDescriptor* d) {
     return Payload(d, GeneratedCodeInfo::Annotation::NONE);
   }
   static std::string ToString(const Descriptor* d) {
     return Payload(d, GeneratedCodeInfo::Annotation::NONE);
   }
   static std::string ToString(const EnumDescriptor* d) {
     return Payload(d, GeneratedCodeInfo::Annotation::NONE);
   }
   static std::string ToString(const EnumValueDescriptor* d) {
     return Payload(d, GeneratedCodeInfo::Annotation::NONE);
   }
   static std::string ToString(const OneofDescriptor* d) {
     return Payload(d, GeneratedCodeInfo::Annotation::NONE);
   }
 
   static std::string ToString(
       std::tuple<const FieldDescriptor*,
                  GeneratedCodeInfo::Annotation::Semantic>
           p) {
     return Payload(std::get<0>(p), std::get<1>(p));
   }
   static std::string ToString(
       std::tuple<const Descriptor*, GeneratedCodeInfo::Annotation::Semantic>
           p) {
     return Payload(std::get<0>(p), std::get<1>(p));
   }
   static std::string ToString(
       std::tuple<const EnumDescriptor*, GeneratedCodeInfo::Annotation::Semantic>
           p) {
     return Payload(std::get<0>(p), std::get<1>(p));
   }
   static std::string ToString(
       std::tuple<const EnumValueDescriptor*,
                  GeneratedCodeInfo::Annotation::Semantic>
           p) {
     return Payload(std::get<0>(p), std::get<1>(p));
   }
   static std::string ToString(
       std::tuple<const OneofDescriptor*,
                  GeneratedCodeInfo::Annotation::Semantic>
           p) {
     return Payload(std::get<0>(p), std::get<1>(p));
   }
 
   template <typename Descriptor>
   static std::string Payload(const Descriptor* descriptor,
                              GeneratedCodeInfo::Annotation::Semantic semantic) {
     std::vector<int> path;
     descriptor->GetLocationPath(&path);
     GeneratedCodeInfo::Annotation annotation;
     for (int index : path) {
       annotation.add_path(index);
     }
     annotation.set_source_file(descriptor->file()->name());
     annotation.set_semantic(semantic);
     return annotation.SerializeAsString();
   }
 };
 
 template <typename T>
 std::string FieldComment(const T* field, const Options& options) {
   if (options.strip_nonfunctional_codegen) {
     return std::string(field->name());
   }
   // Print the field's (or oneof's) proto-syntax definition as a comment.
   // We don't want to print group bodies so we cut off after the first
   // line.
   DebugStringOptions debug_options;
   debug_options.elide_group_body = true;
   debug_options.elide_oneof_body = true;
 
   for (absl::string_view chunk :
        absl::StrSplit(field->DebugStringWithOptions(debug_options), '\n')) {
     return std::string(chunk);
   }
 
   return "<unknown>";
 }
 
 template <class T>
 void PrintFieldComment(const Formatter& format, const T* field,
                        const Options& options) {
   format("// $1$\n", FieldComment(field, options));
 }
 
 class PROTOC_EXPORT NamespaceOpener {
  public:
   explicit NamespaceOpener(
       io::Printer* p,
       io::Printer::SourceLocation loc = io::Printer::SourceLocation::current())
       : p_(p), loc_(loc) {}
 
   explicit NamespaceOpener(
       const Formatter& format,
       io::Printer::SourceLocation loc = io::Printer::SourceLocation::current())
       : NamespaceOpener(format.printer(), loc) {}
 
   NamespaceOpener(
       absl::string_view name, const Formatter& format,
       io::Printer::SourceLocation loc = io::Printer::SourceLocation::current())
       : NamespaceOpener(name, format.printer(), loc) {}
 
   NamespaceOpener(
       absl::string_view name, io::Printer* p,
       io::Printer::SourceLocation loc = io::Printer::SourceLocation::current())
       : NamespaceOpener(p, loc) {
     ChangeTo(name, loc);
   }
 
   ~NamespaceOpener() { ChangeTo("", loc_); }
 
   void ChangeTo(
       absl::string_view name,
       io::Printer::SourceLocation loc = io::Printer::SourceLocation::current());
 
  private:
   io::Printer* p_;
   io::Printer::SourceLocation loc_;
   std::vector<std::string> name_stack_;
 };
 
 void GenerateUtf8CheckCodeForString(const FieldDescriptor* field,
                                     const Options& options, bool for_parse,
                                     absl::string_view parameters,
                                     const Formatter& format);
 
 void GenerateUtf8CheckCodeForCord(const FieldDescriptor* field,
                                   const Options& options, bool for_parse,
                                   absl::string_view parameters,
                                   const Formatter& format);
 
 void GenerateUtf8CheckCodeForString(io::Printer* p,
                                     const FieldDescriptor* field,
                                     const Options& options, bool for_parse,
                                     absl::string_view parameters);
 
 void GenerateUtf8CheckCodeForCord(io::Printer* p, const FieldDescriptor* field,
                                   const Options& options, bool for_parse,
                                   absl::string_view parameters);
 
 inline bool ShouldGenerateExternSpecializations(const Options& options) {
   // For OSS we omit the specializations to reduce codegen size.
   // Some compilers can't handle that much input in a single translation unit.
   // These specializations are just a link size optimization and do not affect
   // correctness or performance, so it is ok to omit them.
   return !options.opensource_runtime;
 }
 
 struct OneOfRangeImpl {
   struct Iterator {
     using iterator_category = std::forward_iterator_tag;
     using value_type = const OneofDescriptor*;
     using difference_type = int;
 
     value_type operator*() { return descriptor->oneof_decl(idx); }
 
     friend bool operator==(const Iterator& a, const Iterator& b) {
       ABSL_DCHECK(a.descriptor == b.descriptor);
       return a.idx == b.idx;
     }
     friend bool operator!=(const Iterator& a, const Iterator& b) {
       return !(a == b);
     }
 
     Iterator& operator++() {
       idx++;
       return *this;
     }
 
     int idx;
     const Descriptor* descriptor;
   };
 
   Iterator begin() const { return {0, descriptor}; }
   Iterator end() const {
     return {descriptor->real_oneof_decl_count(), descriptor};
   }
 
   const Descriptor* descriptor;
 };
 
 inline OneOfRangeImpl OneOfRange(const Descriptor* desc) { return {desc}; }
 
 // Strips ".proto" or ".protodevel" from the end of a filename.
 PROTOC_EXPORT std::string StripProto(absl::string_view filename);
 
 bool HasMessageFieldOrExtension(const Descriptor* desc);
 
 // Generates a vector of substitutions for use with Printer::WithVars that
 // contains annotated accessor names for a particular field.
 //
 // Each substitution will be named `absl::StrCat(prefix, "name")`, and will
 // be annotated with `field`.
 std::vector<io::Printer::Sub> AnnotatedAccessors(
     const FieldDescriptor* field, absl::Span<const absl::string_view> prefixes,
     absl::optional<google::protobuf::io::AnnotationCollector::Semantic> semantic =
         absl::nullopt);
 
 // Check whether `file` represents the .proto file FileDescriptorProto and
 // friends. This file needs special handling because it must be usable during
 // dynamic initialization.
 bool IsFileDescriptorProto(const FileDescriptor* file, const Options& options);
 
 // Determine if we should generate a class for the descriptor.
 // Some descriptors, like some map entries, are not represented as a generated
 // class.
 bool ShouldGenerateClass(const Descriptor* descriptor, const Options& options);
 
 
 // Determine if we are going to generate a tracker call for OnDeserialize.
 // This one is handled specially because we generate the PostLoopHandler for it.
 // We don't want to generate a handler if it is going to end up empty.
 bool HasOnDeserializeTracker(const Descriptor* descriptor,
                              const Options& options);
 
 // Determine if we need a PostLoopHandler function to inject into TcParseTable's
 // ParseLoop.
 // If this returns true, the parse table generation will use
 // `&ClassName::PostLoopHandler` which should be a static function of the right
 // signature.
 bool NeedsPostLoopHandler(const Descriptor* descriptor, const Options& options);
 
 // Priority used for static initializers.
 enum InitPriority {
   kInitPriority101,
   kInitPriority102,
 };
 
 }  // namespace cpp
 }  // namespace compiler
 }  // namespace protobuf
 }  // namespace google
 
 #include "google/protobuf/port_undef.inc"
 
 #endif  // GOOGLE_PROTOBUF_COMPILER_CPP_HELPERS_H__

This page was automatically generated by the 2.3.7 LXR engine. The LXR team