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 NULL.

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 google/protobuf/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 decriptor in a human-readable form.

Output will be suitable for re-parsing.

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 NULL 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.

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 NULL 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 value by name, among all enum types in this message.

Returns NULL 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.

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

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

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.

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 NULL.

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 NULL.

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 NULL 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, undefined.

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

Otherwise, undefined.

EXPERIMENTAL; DO NOT USE.

If this field is a map field, experimental_map_key() is the field that is the key for this map. experimental_map_key()->containing_type() is the same as message_type().

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 google/protobuf/descriptor.proto, and any available extensions of that message.

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 NULL 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, NULL.

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 google/protobuf/descriptor.proto, and any available extensions of that message.

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 google/protobuf/descriptor.proto, and any available extensions of that message.

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 google/protobuf/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.

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 google/protobuf/descriptor.proto, and any available extensions of that message.

The filename, relative to the source tree.

e.g. "google/protobuf/descriptor.proto"

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

Never NULL.

Gets an imported file by index, where 0 <= index < 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 google/protobuf/descriptor.proto, and any available extensions of that message.

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

Returns NULL 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().

Find a FileDescriptor in the pool by file name.

Returns NULL 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 NULL.

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 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 NULL 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. 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 only be relied upon for debugging purposes.

DEPRECATED: Use of underlays can lead to many subtle gotchas.

Instead, try to formulate what you want to do in terms of DescriptorDatabases. This constructor will be removed soon.

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.

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.

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 fallback database takes precedence.

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.