descriptor.h

Doc comments found at the source location.

See the comments in SourceCodeInfo.Location (descriptor.proto) for details.

include original user comments as recorded in SourceLocation entries.

N.B. that this must be |false| by default: several other pieces of code (for example, the C++ code generation for fields in the proto compiler) rely on DebugString() output being unobstructed by user comments.

The fully-qualified name of the message type, scope delimited by periods.

For example, message type "Foo" which is declared in package "bar" has full name "bar.Foo". If a type "Baz" is nested within Foo, Baz's full_name is "bar.Foo.Baz". To get only the part that comes after the last '.', use name().

If this Descriptor describes a nested type, this returns the type in which it is nested.

Otherwise, returns nullptr.

Get options for this message type.

These are specified in the .proto file by placing lines like "option foo = 1234;" in the message definition. Allowed options are defined by MessageOptions in descriptor.proto, and any available extensions of that message.

Write the contents of this Descriptor into the given DescriptorProto.

The target DescriptorProto must be clear before calling this; if it isn't, the result may be garbage.

Write the contents of this descriptor in a human-readable form.

Output will be suitable for re-parsing.

Returns true if this is a placeholder for an unknown type.

This will only be the case if this descriptor comes from a DescriptorPool with AllowUnknownDependencies() set.

Gets a field by index, where 0 <= index < field_count().

These are returned in the order they were defined in the .proto file.

Looks up a field by declared tag number.

Returns nullptr if no such field exists.

Looks up a field by lowercased name (as returned by lowercase_name()).

This lookup may be ambiguous if multiple field names differ only by case, in which case the field returned is chosen arbitrarily from the matches.

Looks up a field by camel-case name (as returned by camelcase_name()).

This lookup may be ambiguous if multiple field names differ in a way that leads them to have identical camel-case names, in which case the field returned is chosen arbitrarily from the matches.

The number of oneofs in this message type, excluding synthetic oneofs.

Real oneofs always come first, so iterating up to real_oneof_decl_cout() will yield all real oneofs.

Get a oneof by index, where 0 <= index < oneof_decl_count().

These are returned in the order they were defined in the .proto file.

Gets a nested type by index, where 0 <= index < nested_type_count().

These are returned in the order they were defined in the .proto file.

Looks up a nested type by name.

Returns nullptr if no such nested type exists.

Gets an enum type by index, where 0 <= index < enum_type_count().

These are returned in the order they were defined in the .proto file.

Looks up an enum type by name.

Returns nullptr if no such enum type exists.

Looks up an enum value by name, among all enum types in this message.

Returns nullptr if no such value exists.

Gets an extension range by index, where 0 <= index < extension_range_count().

These are returned in the order they were defined in the .proto file.

The number of extensions defined nested within this message type's scope.

See doc:

will return "foo", even though "foo" is an extension of M1. To find all known extensions of a given message, instead use DescriptorPool::FindAllExtensions.

Get an extension by index, where 0 <= index < extension_count().

These are returned in the order they were defined in the .proto file.

Gets an reserved range by index, where 0 <= index < reserved_range_count().

These are returned in the order they were defined in the .proto file.

Gets a reserved name by index, where 0 <= index < reserved_name_count().

Can't use PROTOBUF_DEFINE_ARRAY_ACCESSOR because reserved_names_ is actually an array of pointers rather than the usual array of objects.

Updates |*out_location| to the source location of the complete extent of this message declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

Returns the FieldDescriptor for the "key" field.

If this isn't a map entry field, returns nullptr.

Returns the FieldDescriptor for the "value" field.

If this isn't a map entry field, returns nullptr.

Identifies a field type.

0 is reserved for errors. The order is weird for historical reasons. Types 12 and up are new in proto2.

Specifies the C++ data type used to represent the field.

There is a fixed mapping from Type to CppType where each Type maps to exactly one CppType. 0 is reserved for errors.

Identifies whether the field is optional, required, or repeated.

0 is reserved for errors.

First field number reserved for the protocol buffer library implementation.

Users may not declare fields that use reserved numbers.

Last field number reserved for the protocol buffer library implementation.

Users may not declare fields that use reserved numbers.

Same as name() except converted to lower-case.

This (and especially the FindFieldByLowercaseName() method) can be useful when parsing formats which prefer to use lowercase naming style. (Although, technically field names should be lowercased anyway according to the protobuf style guide, so this only makes a difference when dealing with old .proto files which do not follow the guide.)

Same as name() except converted to camel-case.

In this conversion, any time an underscore appears in the name, it is removed and the next letter is capitalized. Furthermore, the first letter of the name is lower-cased. Examples:

FooBar -> fooBar
foo_bar -> fooBar
fooBar -> fooBar

This (and especially the FindFieldByCamelcaseName() method) can be useful when parsing formats which prefer to use camel-case naming style.

Returns true if this field was syntactically written with "optional" in the .proto file.

Excludes singular proto3 fields that do not have a label.

Returns true if this field tracks presence, ie.

does the field distinguish between "unset" and "present with default value." This includes required, optional, and oneof fields. It excludes maps, repeated fields, and singular proto3 fields without "optional".

For fields where has_presence() == true, the return value of Reflection::HasField() is semantically meaningful.

Get the field default value if cpp_type() == CPPTYPE_INT32.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_INT64.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_UINT32.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_UINT64.

If no explicit default was defined, the default is 0.

Get the field default value if cpp_type() == CPPTYPE_FLOAT.

If no explicit default was defined, the default is 0.0.

Get the field default value if cpp_type() == CPPTYPE_DOUBLE.

If no explicit default was defined, the default is 0.0.

Get the field default value if cpp_type() == CPPTYPE_BOOL.

If no explicit default was defined, the default is false.

Get the field default value if cpp_type() == CPPTYPE_ENUM.

If no explicit default was defined, the default is the first value defined in the enum type (all enum types are required to have at least one value). This never returns nullptr.

Get the field default value if cpp_type() == CPPTYPE_STRING.

If no explicit default was defined, the default is the empty string.

The Descriptor for the message of which this is a field.

For extensions, this is the extended type. Never nullptr.

An extension may be declared within the scope of another message.

If this field is an extension (is_extension() is true), then extension_scope() returns that message, or nullptr if the extension was declared at global scope. If this is not an extension, extension_scope() is undefined (may assert-fail).

If type is TYPE_MESSAGE or TYPE_GROUP, returns a descriptor for the message or the group type.

Otherwise, returns null.

If type is TYPE_ENUM, returns a descriptor for the enum.

Otherwise, returns null.

Get the FieldOptions for this field.

This includes things listed in square brackets after the field definition. E.g., the field:

optional string text = 1 [[]ctype=CORD];

has the "ctype" option set. Allowed options are defined by FieldOptions in descriptor.proto, and any available extensions of that message.

Returns full_name() except if the field is a MessageSet extension, in which case it returns the full_name() of the containing message type for backwards compatibility with proto1.

A MessageSet extension is defined as an optional message extension whose containing type has the message_set_wire_format option set. This should be true of extensions of google.protobuf.bridge.MessageSet; by convention, such extensions are named "message_set_extension".

The opposite operation (looking up an extension's FieldDescriptor given its printable name) can be accomplished with

message->file()->pool()->FindExtensionByPrintableName(message, name)

where the extension extends "message".

Updates |*out_location| to the source location of the complete extent of this field declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

Returns whether this oneof was inserted by the compiler to wrap a proto3 optional field.

If this returns true, code generators should not emit it.

Get a member of this oneof, in the order in which they were declared in the .proto file.

Can't use PROTOBUF_DEFINE_ARRAY_ACCESSOR because fields_ is actually an array of pointers rather than the usual array of objects.

Does not include extensions.

Updates |*out_location| to the source location of the complete extent of this oneof declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

The number of values for this EnumDescriptor.

Guaranteed to be greater than zero.

Gets a value by index, where 0 <= index < value_count().

These are returned in the order they were defined in the .proto file.

Looks up a value by number.

Returns nullptr if no such value exists. If multiple values have this number, the first one defined is returned.

If this enum type is nested in a message type, this is that message type.

Otherwise, nullptr.

Get options for this enum type.

These are specified in the .proto file by placing lines like "option foo = 1234;" in the enum definition. Allowed options are defined by EnumOptions in descriptor.proto, and any available extensions of that message.

Returns true if this is a placeholder for an unknown enum.

This will only be the case if this descriptor comes from a DescriptorPool with AllowUnknownDependencies() set.

Gets an reserved range by index, where 0 <= index < reserved_range_count().

These are returned in the order they were defined in the .proto file.

Gets a reserved name by index, where 0 <= index < reserved_name_count().

Can't use PROTOBUF_DEFINE_ARRAY_ACCESSOR because reserved_names_ is actually an array of pointers rather than the usual array of objects.

Updates |*out_location| to the source location of the complete extent of this enum declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

The full_name of an enum value is a sibling symbol of the enum type.

e.g. the full name of FieldDescriptorProto::TYPE_INT32 is actually "google.protobuf.FieldDescriptorProto.TYPE_INT32", NOT "google.protobuf.FieldDescriptorProto.Type.TYPE_INT32". This is to conform with C++ scoping rules for enums.

Get options for this enum value.

These are specified in the .proto file by adding text like "[[]foo = 1234]" after an enum value definition. Allowed options are defined by EnumValueOptions in descriptor.proto, and any available extensions of that message.

Updates |*out_location| to the source location of the complete extent of this enum value declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

Get options for this service type.

These are specified in the .proto file by placing lines like "option foo = 1234;" in the service definition. Allowed options are defined by ServiceOptions in descriptor.proto, and any available extensions of that message.

Gets a MethodDescriptor by index, where 0 <= index < method_count().

These are returned in the order they were defined in the .proto file.

Updates |*out_location| to the source location of the complete extent of this service declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

Get options for this method.

These are specified in the .proto file by placing lines like "option foo = 1234;" in curly-braces after a method declaration. Allowed options are defined by MethodOptions in descriptor.proto, and any available extensions of that message.

Updates |*out_location| to the source location of the complete extent of this method declaration.

Returns false and leaves |*out_location| unchanged iff location information was not available.

Syntax of this file.

The filename, relative to the source tree.

e.g. "foo/bar/baz.proto"

The DescriptorPool in which this FileDescriptor and all its contents were allocated.

Never nullptr.

Gets an imported file by index, where 0 <= index < dependency_count().

These are returned in the order they were defined in the .proto file.

The number of files public imported by this one.

The public dependency list is a subset of the dependency list.

Gets a public imported file by index, where 0 <= index < public_dependency_count().

These are returned in the order they were defined in the .proto file.

The number of files that are imported for weak fields.

The weak dependency list is a subset of the dependency list.

Gets a weak imported file by index, where 0 <= index < weak_dependency_count().

These are returned in the order they were defined in the .proto file.

Number of top-level message types defined in this file.

(This does not include nested types.)

Gets a top-level message type, where 0 <= index < message_type_count().

These are returned in the order they were defined in the .proto file.

Number of top-level enum types defined in this file.

(This does not include nested types.)

Gets a top-level enum type, where 0 <= index < enum_type_count().

These are returned in the order they were defined in the .proto file.

Gets a service, where 0 <= index < service_count().

These are returned in the order they were defined in the .proto file.

Number of extensions defined at file scope.

(This does not include extensions nested within message types.)

Gets an extension's descriptor, where 0 <= index < extension_count().

These are returned in the order they were defined in the .proto file.

Get options for this file.

These are specified in the .proto file by placing lines like "option foo = 1234;" at the top level, outside of any other definitions. Allowed options are defined by FileOptions in descriptor.proto, and any available extensions of that message.

Find a top-level message type by name (not full_name).

Returns nullptr if not found.

Find an enum value defined in any top-level enum by name.

Returns nullptr if not found.

Find a top-level extension definition by name.

Returns nullptr if not found.

Similar to FindExtensionByName(), but searches by lowercased-name.

See Descriptor::FindFieldByLowercaseName().

Similar to FindExtensionByName(), but searches by camelcased-name.

See Descriptor::FindFieldByCamelcaseName().

See Descriptor::CopyTo().

Notes:

• This method does NOT copy source code information since it is relatively large and rarely needed. See CopySourceCodeInfoTo() below.

Write the source code information of this FileDescriptor into the given FileDescriptorProto.

See CopyTo() above.

Fill the json_name field of FieldDescriptorProto for all fields.

Can only be called after CopyTo().

Returns true if this is a placeholder for an unknown file.

This will only be the case if this descriptor comes from a DescriptorPool with AllowUnknownDependencies() set.

Updates |*out_location| to the source location of the complete extent of the declaration or declaration-part denoted by |path|.

Returns false and leaves |*out_location| unchanged iff location information was not available. (See SourceCodeInfo for description of path encoding.)

Find a FileDescriptor in the pool by file name.

Returns nullptr if not found.

Find the FileDescriptor in the pool which defines the given symbol.

If any of the Find*ByName() methods below would succeed, then this is equivalent to calling that method and calling the result's file() method. Otherwise this returns nullptr.

Get a pointer to the generated pool.

Generated protocol message classes which are compiled into the binary will allocate their descriptors in this pool. Do not add your own descriptors to this pool.

Finds an extension of the given type by number.

The extendee must be a member of this DescriptorPool or one of its underlays.

Finds an extension of the given type by its printable name.

See comments above PrintableNameForExtension() for the definition of "printable name". The extendee must be a member of this DescriptorPool or one of its underlays. Returns nullptr if there is no known message extension with the given printable name.

Finds extensions of extendee.

The extensions will be appended to out in an undefined order. Only extensions defined directly in this DescriptorPool or one of its underlays are guaranteed to be found: extensions defined in the fallback database might not be found depending on the database implementation.

Convert the FileDescriptorProto to real descriptors and place them in this DescriptorPool.

All dependencies of the file must already be in the pool. Returns the resulting FileDescriptor, or nullptr if there were problems with the input (e.g. the message was invalid, or dependencies were missing). Details about the errors are written to GOOGLE_LOG(ERROR).

By default, it is an error if a FileDescriptorProto contains references to types or other files that are not found in the DescriptorPool (or its backing DescriptorDatabase, if any).

If you call AllowUnknownDependencies(), however, then unknown types and files will be replaced by placeholder descriptors (which can be identified by the is_placeholder() method). This can allow you to perform some useful operations with a .proto file even if you do not have access to other .proto files on which it depends. However, some heuristics must be used to fill in the gaps in information, and these can lead to descriptors which are inaccurate. For example, the DescriptorPool may be forced to guess whether an unknown type is a message or an enum, as well as what package it resides in. Furthermore, placeholder types will not be discoverable via FindMessageTypeByName() and similar methods, which could confuse some descriptor-based algorithms. Generally, the results of this option should be handled with extreme care.

By default, weak imports are allowed to be missing, in which case we will use a placeholder for the dependency and convert the field to be an Empty message field.

If you call EnforceWeakDependencies(true), however, the DescriptorPool will report a import not found error.

Create a DescriptorPool which is overlaid on top of some other pool.

If you search for a descriptor in the overlay and it is not found, the underlay will be searched as a backup. If the underlay has its own underlay, that will be searched next, and so on. This also means that files built in the overlay will be cross-linked with the underlay's descriptors if necessary. The underlay remains property of the caller; it must remain valid for the lifetime of the newly-constructed pool.

Example: Say you want to parse a .proto file at runtime in order to use its type with a DynamicMessage. Say this .proto file has dependencies, but you know that all the dependencies will be things that are already compiled into the binary. For ease of use, you'd like to load the types right out of generated_pool() rather than have to parse redundant copies of all these .protos and runtime. But, you don't want to add the parsed types directly into generated_pool(): this is not allowed, and would be bad design anyway. So, instead, you could use generated_pool() as an underlay for a new DescriptorPool in which you add only the new file.

WARNING: Use of underlays can lead to many subtle gotchas. Instead, try to formulate what you want to do in terms of DescriptorDatabases.

For internal use only: Enables lazy building of dependencies of a file.

Delay the building of dependencies of a file descriptor until absolutely necessary, like when message_type() is called on a field that is defined in that dependency's file. This will cause functional issues if a proto or one of its dependencies has errors. Should only be enabled for the generated_pool_ (because no descriptor build errors are guaranteed by the compilation generation process), testing, or if a lack of descriptor build errors can be guaranteed for a pool.

For internal (unit test) use only: Returns true if a FileDescriptor has been constructed for the given file, false otherwise.

Useful for testing lazy descriptor initialization behavior.

Add a file to unused_import_track_files_.

DescriptorBuilder will log warnings or errors for those files if there is any unused import.

Called by generated classes at init time to add their descriptors to generated_pool.

Do NOT call this in your own code! filename must be a permanent string (e.g. a string literal).

For internal use only: Gets a non-const pointer to the generated pool.

This is called at static-initialization time only, so thread-safety is not a concern. If both an underlay and a fallback database are present, the underlay takes precedence.

For internal use only: Gets a non-const pointer to the generated descriptor database.

Only used for testing.

These constants specify what exact part of the construct is broken.

This is useful e.g. for mapping the error back to an exact location in a .proto file.

Reports an error in the FileDescriptorProto.

Use this function if the problem occurred should interrupt building the FileDescriptorProto.

Reports a warning in the FileDescriptorProto.

Use this function if the problem occurred should NOT interrupt building the FileDescriptorProto.