descritor.h

Comentários do documento encontrados no local de origem.

Consulte os comentários em SourceCodeInfo.Location (descrito.proto) para mais detalhes.

incluir comentários originais do usuário conforme gravados nas entradas SourceLocation.

Observação: isso precisa ser |false| por padrão: várias outras partes do código (por exemplo, a geração de código C++ para campos no compilador proto) dependem da saída do DebugString() ser desobstruída pelos comentários do usuário.

O nome totalmente qualificado do tipo de mensagem, com escopo delimitado por pontos.

Por exemplo, o tipo de mensagem "Foo" declarado no pacote "bar" tem o nome completo "bar.Foo". Se um tipo "Baz" estiver aninhado dentro do Foo, o nome completo do Baz será "bar.Foo.Baz". Para receber apenas a parte que vem depois do último ".", use name().

Se o Descriptor descrever um tipo aninhado, isso retornará o tipo em que está aninhado.

Caso contrário, retorna nuloptr.

Veja as opções desse tipo de mensagem.

Elas são especificadas no arquivo .proto , colocando linhas como "option foo = 1234;" na definição da mensagem. As opções permitidas são definidas por MessageOptions em Descriptor.proto e qualquer extensão disponível dessa mensagem.

Grave o conteúdo desse Descriptor no DescriptorProto fornecido.

O DescriptorProto de destino precisa estar claro antes de chamar esse método. Caso contrário, o resultado pode ser um lixo.

Escreva o conteúdo desse descritor em um formato legível.

A saída será adequada para uma nova análise.

Retornará "true" se este for um marcador para um tipo desconhecido.

Isso só acontecerá se esse descritor vier de um DescriptorPool com allowUnknownDependencies() definido.

Recebe um campo por índice, em que 0 <= índice < field_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Pesquisa um campo por número de tag declarado.

Retorna nuloptr, se esse campo não existir.

Procura um campo pelo nome em letras minúsculas (conforme retornado por minúsculas_name()).

Essa pesquisa pode ser ambígua se vários nomes de campo forem diferentes apenas por caso. Nesse caso, o campo retornado será escolhido arbitrariamente entre as correspondências.

Procura um campo pelo nome do concatenado, conforme retornado por camelcase_name().

Essa pesquisa pode ser ambígua se vários nomes de campo diferem de forma a fazer com que eles tenham nomes de concatenação idênticos. Nesse caso, o campo retornado é escolhido arbitrariamente entre as correspondências.

O número de um dos tipos nesse tipo de mensagem, exceto os sintéticos.

Os resultados reais sempre vêm em primeiro lugar. Por isso, iterar até real_oneof_decl_cout() trará resultados reais.

Recebe um oneof por índice, em que 0 <= índice < oneof_decl_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Recebe um tipo aninhado por índice, em que 0 <= índice < nested_type_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Procura um tipo aninhado por nome.

Retorna nuloptr, se nenhum tipo aninhado existir.

Recebe um tipo de enumeração por índice, em que 0 <= índice < enum_type_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Procura um tipo de enumeração pelo nome.

Retorna nuloptr, se esse tipo de enumeração não existir.

Procura um valor de enumeração pelo nome, entre todos os tipos de enumeração nessa mensagem.

Retornará nuloptr se esse valor não existir.

Recebe um intervalo de extensões por índice, em que 0 <= índice < extension_range_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

O número de extensões definidas aninhadas no escopo deste tipo de mensagem.

Veja a documentação:

As extensões podem estar estendendo outras mensagens.

Por exemplo: mensagem M1 {

extensions 1 to max;

}

mensagem M2 {

extend M1 {
  optional int32 foo = 1;
}

}

Neste caso, DescriptorPool::Generated_pool()

->FindMessageTypeByName("M2")
->extension(0)

retornará "foo", mesmo que "foo" seja uma extensão da M1. Para encontrar todas as extensões conhecidas de uma determinada mensagem, use DescriptorPool::FindAllExtensions.

Receba uma extensão por índice, em que 0 <= índice < extension_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Recebe um intervalo reservado por índice, em que 0 <= índice < reserved_range_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Recebe um nome reservado por índice, em que 0 <= índice < reserved_name_count().

Não é possível usar PROTOBUF_DEFINE_ARRAY_ACCESSOR porque reserve_names_ é uma matriz de ponteiros, em vez da matriz normal de objetos.

Atualiza |*out_location| para o local de origem na extensão completa desta declaração de mensagem.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

Retorna o FieldDescriptor do campo "key".

Se este não for um campo de entrada de mapa, retorna nuloptr.

Retorna o FieldDescriptor do campo "value".

Se este não for um campo de entrada de mapa, retorna nuloptr.

Identifica um tipo de campo.

0 é reservado para erros. A ordem é estranha por motivos históricos. Os tipos 12 e mais recentes são novos no proto2.

Especifica o tipo de dados C++ usado para representar o campo.

Há um mapeamento fixo de Type para CppType, em que cada Type é mapeado para exatamente um CppType. 0 é reservado para erros.

Identifica se o campo é opcional, obrigatório ou repetido.

0 é reservado para erros.

Primeiro número de campo reservado para a implementação da biblioteca de buffers de protocolo.

Os usuários não podem declarar campos que usam números reservados.

Último número de campo reservado para a implementação da biblioteca de buffers de protocolo.

Os usuários não podem declarar campos que usam números reservados.

O mesmo que name(), exceto por conversão para letras minúsculas.

Isso (especialmente o método FindFieldByLowercaseName()) pode ser útil ao analisar formatos que preferem usar um estilo de nomenclatura em letras minúsculas. Tecnicamente, os nomes de campo precisam estar em letras minúsculas de acordo com o guia de estilo protobuf. Isso só faz diferença quando lidamos com arquivos .proto antigos que não seguem o guia.

O mesmo que name(), exceto pela conversão para concatenação.

Nessa conversão, sempre que um sublinhado aparecer no nome, ele será removido e a próxima letra será maiúscula. Além disso, a primeira letra do nome está em letras minúsculas. Exemplos:

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

Isso (especialmente o método FindFieldByCamelcaseName()) pode ser útil ao analisar formatos que preferem usar o estilo de nomeação de concatenação.

Retornará "true" se este campo tiver sido escrito com sintaxe com "opcional" no arquivo .proto.

Exclui campos proto3 singulares que não têm rótulo.

Retorna verdadeiro se este campo rastrear a presença, ou seja,

o campo distingue entre "não definido" e "presente com valor padrão". Isso inclui campos obrigatórios, opcionais e um. Ela não inclui mapas, campos repetidos e campos proto3 únicos sem "opcional".

Para campos em que has_presence() == true, o valor de retorno de Reflection::HasField() é semanticamente significativo.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_INT32.

Se nenhum padrão explícito tiver sido definido, o padrão será 0.

Receba o valor padrão do campo se cpp_type() == CPPTYPE_INT64.

Se nenhum padrão explícito tiver sido definido, o padrão será 0.

Receba o valor padrão do campo se cpp_type() == CPPTYPE_UINT32.

Se nenhum padrão explícito tiver sido definido, o padrão será 0.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_UINT64.

Se nenhum padrão explícito tiver sido definido, o padrão será 0.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_FLOAT.

Se nenhum padrão explícito tiver sido definido, o padrão será 0,0.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_DOUBLE.

Se nenhum padrão explícito tiver sido definido, o padrão será 0,0.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_BOOL.

Se nenhum padrão explícito tiver sido definido, o valor será falso.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_ENUM.

Se nenhum padrão explícito for definido, o padrão será o primeiro valor definido no tipo de enumeração (todos os tipos de enumeração precisam ter pelo menos um valor). Isso nunca retorna nuloptr.

Acessa o valor padrão do campo se cpp_type() == CPPTYPE_STRING.

Se nenhum padrão explícito tiver sido definido, a string vai ficar vazia.

O Descriptor da mensagem que é um campo.

Para extensões, esse é o tipo estendido. Nunca nulo.

Uma extensão pode ser declarada no escopo de outra mensagem.

Se o campo for uma extensão (is_extension() for verdadeiro), extension_scope() retornará essa mensagem ou nuloptr se a extensão tiver sido declarada no escopo global. Se essa não for uma extensão, extension_scope() será indefinido (pode ter o status assert-fail).

Se o tipo for TYPE_MESSAGE ou TYPE_GROUP, retorna um descritor para a mensagem ou o tipo de grupo.

Caso contrário, retorna nulo.

Se o tipo for TYPE_ENUM, retorna um descritor para a enumeração.

Caso contrário, retorna nulo.

Acessa o FieldOptions para esse campo.

Isso inclui os itens entre colchetes depois da definição do campo. Por exemplo, o campo:

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

tem a opção "ctype" definida. As opções permitidas são definidas pelo FieldOptions em Descriptor.proto e por qualquer extensão disponível dessa mensagem.

Retorna full_name(), exceto se o campo for uma extensão MessageSet. Nesse caso, retorna full_name() do tipo de mensagem contido para compatibilidade com o proto1.

Uma extensão MessageSet é definida como uma extensão de mensagem opcional cujo tipo contém a opção message_set_wire_format definida. Isso deve ser feito com as extensões de google.protobuf.bridge.MessageSet. Por convenção, essas extensões são chamadas de "message_set_extension".

A operação oposta (procurar o FieldDescriptor de uma extensão por seu nome para impressão) pode ser realizada com o

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

em que a extensão estende "mensagem".

Atualiza |*out_location| para o local de origem na extensão completa desta declaração de campo.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

Retorna se este foi inserido pelo compilador para encapsular um campo proto3 opcional.

Se isso retornar "true", os geradores de código não vão poder emiti-lo.

Encontre um membro desse objeto, na ordem em que foram declarados no arquivo .proto.

Não é possível usar PROTOBUF_DEFINE_ARRAY_ACCESSOR porque fields_ é uma matriz de ponteiros, em vez da matriz normal de objetos.

Não inclui extensões.

Atualiza |*out_location| para o local de origem na extensão completa desta única declaração.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

O número de valores para este EnumDescriptor.

É garantido que é maior que zero.

Recebe um valor por índice, em que 0 <= índice < value_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Procura um valor por número.

Retornará nuloptr se esse valor não existir. Se esse campo tiver vários valores, o primeiro definido será retornado.

Se esse tipo de enumeração estiver aninhado em um tipo de mensagem, esse será o tipo.

Caso contrário, o valor nulo será usado.

Receba opções para esse tipo de enumeração.

Elas são especificadas no arquivo .proto , colocando linhas como "option foo = 1234;" na definição da enumeração. As opções permitidas são definidas por EnumOptions em Descriptor.proto e qualquer extensão disponível dessa mensagem.

Retorna "true" se este for um marcador para uma enumeração desconhecida.

Isso só acontecerá se esse descritor vier de um DescriptorPool com allowUnknownDependencies() definido.

Recebe um intervalo reservado por índice, em que 0 <= índice < reserved_range_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Recebe um nome reservado por índice, em que 0 <= índice < reserved_name_count().

Não é possível usar PROTOBUF_DEFINE_ARRAY_ACCESSOR porque reserve_names_ é uma matriz de ponteiros, em vez da matriz normal de objetos.

Atualiza |*out_location| para o local de origem na extensão completa desta declaração de enumeração.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

O "full_name" de um valor de enumeração é um símbolo irmão do tipo "enum".

Por exemplo, o nome completo de FieldDescriptorProto::TYPE_INT32 é, na verdade, "google.protobuf.FieldDescriptorProto.TYPE_INT32", NÃO "google.protobuf.FieldDescriptorProto.Type.TYPE_INT32". Isso está em conformidade com as regras de escopo C++ para enumerações.

Receba opções para esse valor de enumeração.

Elas são especificadas no arquivo .proto adicionando um texto como "[[]foo = 1234]" após uma definição de valor de enumeração. As opções permitidas são definidas por EnumValueOptions em Descriptor.proto e qualquer extensão disponível dessa mensagem.

Atualiza |*out_location| para o local de origem na extensão completa desta declaração de valor de enumeração.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

Veja opções para esse tipo de serviço.

Elas são especificadas no arquivo .proto , colocando linhas como "option foo = 1234;" na definição do serviço. As opções permitidas são definidas pelo ServiceOptions em Descriptor.proto e por qualquer extensão disponível dessa mensagem.

Recebe um MethodDescriptor por índice, em que 0 <= index < method_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Atualiza |*out_location| para o local de origem na extensão completa desta declaração de serviço.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

Acesse opções para esse método.

Elas são especificadas no arquivo .proto posicionando linhas como "option foo = 1234;" entre chaves após uma declaração de método. As opções permitidas são definidas por MethodOptions em Descriptor.proto e qualquer extensão disponível dessa mensagem.

Atualiza |*out_location| para o local de origem na extensão completa desta declaração de método.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis.

Sintaxe desse arquivo.

Nome do arquivo, relativo à árvore de origem.

Por exemplo, "foo/bar/baz.proto"

O DescriptorPool em que o FileDescriptor e todo o conteúdo dele foram alocados.

Nunca nulo.

Recebe um arquivo importado por índice, em que 0 <= index < dependency_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

O número de arquivos públicos importados por este.

A lista de dependências públicas é um subconjunto da lista de dependências.

Recebe um arquivo público importado por índice, em que 0 <= índice < public_dependency_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Número de arquivos importados para campos fracos.

A lista de dependências fracas é um subconjunto da lista de dependências.

Recebe um arquivo importado fraco por índice, em que 0 <= index < weak_dependency_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Número de tipos de mensagens de nível superior definidos neste arquivo.

Isso não inclui tipos aninhados.

Recebe um tipo de mensagem de nível superior, em que 0 <= índice < message_type_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Número de tipos de enumeração de nível superior definidos neste arquivo.

Isso não inclui tipos aninhados.

Recebe um tipo de enumeração de nível superior, em que 0 <= índice < enum_type_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Recebe um serviço, em que 0 <= index < service_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Número de extensões definidas no escopo do arquivo.

Isso não inclui extensões aninhadas nos tipos de mensagem.

Recebe o descritor de uma extensão, em que 0 <= índice < extension_count().

Elas são retornadas na ordem em que foram definidas no arquivo .proto.

Obter opções para este arquivo.

Elas são especificadas no arquivo .proto colocando linhas como "option foo = 1234;" no nível superior, fora de quaisquer outras definições. As opções permitidas são definidas por FileOptions em Descriptor.proto e qualquer extensão disponível dessa mensagem.

Encontre um tipo de mensagem de nível superior pelo nome (não nome completo).

Retorna nuloptr, se não for encontrado.

Encontre um valor de enumeração definido em qualquer enumeração de nível superior por nome.

Retorna nuloptr, se não for encontrado.

Encontre uma definição de extensão de nível superior por nome.

Retorna nuloptr, se não for encontrado.

Semelhante a FindExtensionByName(), mas pesquisa por nome em letras minúsculas.

Consulte Descriptor::FindFieldByLowercaseName().

Semelhante a FindExtensionByName(), mas pesquisa por camelcased-name.

Consulte Descriptor::FindFieldByCamelcaseName().

Consulte Descriptor::CopyTo().

Observações:

• Esse método NÃO copia informações de código-fonte, uma vez que elas são relativamente grandes e raramente são necessárias. Consulte CopySourceCodeInfoTo() abaixo.

Grave as informações do código-fonte desse FileDescriptor no FileDescriptorProto fornecido.

Consulte CopyTo() acima.

Preencha o campo json_name de FieldDescriptorProto para todos os campos.

Só pode ser chamado após CopyTo().

Retorna "true" se este for um marcador de posição para um arquivo desconhecido.

Isso só acontecerá se esse descritor vier de um DescriptorPool com allowUnknownDependencies() definido.

Atualiza |*out_location| para o local de origem na extensão completa da declaração ou parte da declaração indicada por |path|.

Retorna "false" e deixa |*out_location| inalterado se as informações de local não estiverem disponíveis. Consulte SourceCodeInfo para ver a descrição da codificação de caminho.

Encontre um FileDescriptor no pool por nome de arquivo.

Retorna nuloptr, se não for encontrado.

Encontre o FileDescriptor no pool que define o símbolo especificado.

Se algum dos métodos Find*ByName() abaixo for bem-sucedido, ele equivale a chamar esse método e ao método file() do resultado. Caso contrário, retorna nuloptr.

Receba um ponteiro para o pool gerado.

As classes de mensagem de protocolo geradas que são compiladas no binário alocam os descritores neste pool. Não adicione seus próprios descritores a este pool.

Localiza uma extensão do tipo fornecido pelo número.

O beneficiário precisa ser um membro deste DescriptorPool ou um dos sublaços.

Encontra uma extensão do tipo fornecido pelo nome para impressão.

Consulte os comentários acima de PrintableNameForExtension() para ver a definição de "nome para impressão". O beneficiário precisa ser um membro deste DescriptorPool ou um dos sublaços. Retorna nuloptr, se não houver uma extensão de mensagem conhecida com o nome para impressão fornecido.

Encontra extensões.

As extensões vão ser anexadas em uma ordem indefinida. Somente as extensões definidas diretamente neste DescriptorPool ou em um dos subjacentes dele podem ser encontradas: extensões definidas no banco de dados substituto podem não ser encontradas, dependendo da implementação do banco de dados.

Converta FileDescriptorProto em descritores reais e coloque-os neste DescriptorPool.

Todas as dependências do arquivo já precisam estar no pool. Retorna o FileDescriptor resultante, ou nulo, se houver problemas com a entrada (por exemplo, a mensagem era inválida ou faltavam dependências). Os detalhes sobre os erros são gravados em GOOGLE_LOG(ERROR).

Por padrão, é um erro quando um FileDescriptorProto contém referências a tipos ou outros arquivos não encontrados no DescriptorPool (ou no DescriptorDatabase dele, se houver).

Se você chamar AllowUnknownDependencies(), os tipos e os arquivos desconhecidos serão substituídos por descritores de marcador (que podem ser identificados pelo método is_placeholder()). Isso permite que você execute algumas operações úteis com um arquivo .proto, mesmo que não tenha acesso a outros arquivos .proto dos quais ele depende. No entanto, algumas heurísticas precisam ser usadas para preencher as lacunas nas informações, que podem levar a descritores imprecisos. Por exemplo, o DescriptorPool pode ser forçado a adivinhar se um tipo desconhecido é uma mensagem ou enumeração, bem como em qual pacote reside. Além disso, os tipos de marcador de posição não serão detectáveis pelo FindMessageTypeByName() e por métodos semelhantes, o que pode confundir alguns algoritmos baseados em descritor. Geralmente, os resultados dessa opção devem ser processados com muito cuidado.

Por padrão, as importações fracas podem estar ausentes. Nesse caso, usaremos um marcador para a dependência e converteremos o campo em um campo de mensagem vazio.

No entanto, se você chamar EnforcementWeakDependencies(true), o DescriptorPool informará um erro de importação não encontrado.

Crie um DescriptorPool que seja sobreposto a algum outro pool.

Se você pesquisar um descritor na sobreposição, e ele não for encontrado, o resultado será pesquisado como backup. Se o material subjacente tiver seu próprio material, ele será pesquisado em seguida e assim por diante. Isso também significa que os arquivos criados na sobreposição terão links cruzados com os descritores da sobreposição, se necessário. O objeto subjacente permanece como propriedade do autor da chamada e precisa permanecer válido durante o ciclo de vida do pool recém-construído.

Exemplo: você quer analisar um arquivo .proto no momento da execução para usar o tipo dele com uma DynamicMessage. Digamos que este arquivo .proto tenha dependências, mas você sabe que todas as dependências serão compiladas no binário. Para facilitar o uso, convém carregar os tipos diretamente de Generated_pool(), em vez de analisar cópias redundantes de todos esses arquivos .protos e do ambiente de execução. No entanto, você não quer adicionar os tipos analisados diretamente em generate_pool(): isso não é permitido e seria um design de qualquer maneira. Em vez disso, é possível usar Generated_pool() como subjacente para um novo DescriptorPool em que apenas o novo arquivo será adicionado.

AVISO: o uso de underlays pode levar a muitas pegadinhas sutis. Em vez disso, tente formular o que você quer fazer em termos de DescriptorDatabases.

Somente para uso interno: permite a criação lenta de dependências de um arquivo.

Atrasar a criação de dependências de um descritor de arquivos até ser absolutamente necessário, como quando message_type() for chamado em um campo definido no arquivo da dependência. Isso causará problemas funcionais se um proto ou uma das dependências dele tiver erros. Só deve ser ativado para o generate_pool_ (porque nenhum erro de build do descritor é garantido pelo processo de geração da compilação), testando ou se a falta de erros de build do descritor puder ser garantida para um pool.

Somente para uso interno (teste de unidade): retorna verdadeiro se um FileDescriptor tiver sido criado para o arquivo especificado. Caso contrário, será falso.

Útil para testar o comportamento de inicialização do descritor lento.

Adicione um arquivo a unused_import_track_files_.

O DescriptorBuilder vai registrar avisos ou erros para esses arquivos se houver uma importação não utilizada.

Chamado por classes geradas no momento de inicialização para adicionar os descritores ao generate_pool.

NÃO chame isso em seu próprio código! O nome do arquivo deve ser uma string permanente (por exemplo, um literal de string).

Somente para uso interno: recebe um ponteiro não constante para o pool gerado.

Isso é chamado apenas no momento da inicialização estática. Portanto, a segurança da linha de execução não é uma preocupação. Se houver um banco de dados subjacente e um banco de dados substituto, eles terão precedência.

Somente para uso interno: recebe um ponteiro não constante para o banco de dados do descritor gerado.

Usado apenas para testes.

Essas constantes especificam qual parte exata da construção está corrompida.

Isso é útil, por exemplo, para mapear o erro de volta para um local exato em um arquivo .proto.

Informa um erro no FileDescriptorProto.

Use essa função se o problema ocorrer ao interromper a criação do FileDescriptorProto.

Informa um aviso no FileDescriptorProto.

Use essa função se o problema NÃO ocorrer durante a criação do FileDescriptorProto.