15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Protocol Buffers - Google's data interchange format 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright 2008 Google Inc. All rights reserved. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// http://code.google.com/p/protobuf/ 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met: 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions of source code must retain the above copyright 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions in binary form must reproduce the above 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution. 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission. 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: kenton@google.com (Kenton Varda) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Based on original Protocol Buffers design by 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Sanjay Ghemawat, Jeff Dean, and others. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file contains classes which describe a type of protocol message. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// You can use a message's descriptor to learn at runtime what fields 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// it contains and what the types of those fields are. The Message 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// interface also allows you to dynamically access and modify individual 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// fields by passing the FieldDescriptor of the field you are interested 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Most users will not care about descriptors, because they will write 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// code specific to certain protocol types and will simply use the classes 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// generated by the protocol compiler directly. Advanced users who want 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to operate on arbitrary types (not known at compile time) may want to 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// read descriptors in order to learn about the contents of a message. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A very small number of users will want to construct their own 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Descriptors, either because they are implementing Message manually or 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// because they are writing something like the protocol compiler. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For an example of how you might use descriptors, see the code example 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// at the top of message.h. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef GOOGLE_PROTOBUF_DESCRIPTOR_H__ 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define GOOGLE_PROTOBUF_DESCRIPTOR_H__ 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/stubs/common.h> 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 613551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)// TYPE_BOOL is defined in the MacOS's ConditionalMacros.h. 623551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)#ifdef TYPE_BOOL 633551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)#undef TYPE_BOOL 643551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)#endif // TYPE_BOOL 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace google { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace protobuf { 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Defined in this file. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Descriptor; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FieldDescriptor; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnumDescriptor; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnumValueDescriptor; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ServiceDescriptor; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MethodDescriptor; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FileDescriptor; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DescriptorDatabase; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DescriptorPool; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Defined in descriptor.proto 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DescriptorProto; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FieldDescriptorProto; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnumDescriptorProto; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnumValueDescriptorProto; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ServiceDescriptorProto; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MethodDescriptorProto; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FileDescriptorProto; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MessageOptions; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FieldOptions; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnumOptions; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EnumValueOptions; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ServiceOptions; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MethodOptions; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FileOptions; 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class UninterpretedOption; 96ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochclass SourceCodeInfo; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Defined in message.h 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Message; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Defined in descriptor.cc 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DescriptorBuilder; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FileDescriptorTables; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Defined in unknown_field_set.h. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class UnknownField; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 108ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch// NB, all indices are zero-based. 109ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochstruct SourceLocation { 110ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int start_line; 111ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int end_line; 112ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int start_column; 113ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int end_column; 114ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 115ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Doc comments found at the source location. 116ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // TODO(kenton): Maybe this struct should have been named SourceInfo or 117ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // something instead. Oh well. 118ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch string leading_comments; 119ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch string trailing_comments; 120ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch}; 121ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes a type of protocol message, or a particular group within a 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// message. To obtain the Descriptor for a given message object, call 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Message::GetDescriptor(). Generated message classes also have a 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static method called descriptor() which returns the type's descriptor. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use DescriptorPool to construct your own descriptors. 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT Descriptor { 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The name of the message type, not including its scope. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The fully-qualified name of the message type, scope delimited by 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // periods. For example, message type "Foo" which is declared in package 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "bar" has full name "bar.Foo". If a type "Baz" is nested within 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Foo, Baz's full_name is "bar.Foo.Baz". To get only the part that 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // comes after the last '.', use name(). 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& full_name() const; 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Index of this descriptor within the file or containing type's message 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // type array. 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index() const; 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The .proto file in which this message type was defined. Never NULL. 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file() const; 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this Descriptor describes a nested type, this returns the type 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in which it is nested. Otherwise, returns NULL. 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* containing_type() const; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get options for this message type. These are specified in the .proto file 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // by placing lines like "option foo = 1234;" in the message definition. 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Allowed options are defined by MessageOptions in 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // google/protobuf/descriptor.proto, and any available extensions of that 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message. 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MessageOptions& options() const; 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write the contents of this Descriptor into the given DescriptorProto. 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The target DescriptorProto must be clear before calling this; if it 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // isn't, the result may be garbage. 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(DescriptorProto* proto) const; 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write the contents of this decriptor in a human-readable form. Output 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be suitable for re-parsing. 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Field stuff ----------------------------------------------------- 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of fields in this message type. 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int field_count() const; 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a field by index, where 0 <= index < field_count(). 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* field(int index) const; 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a field by declared tag number. Returns NULL if no such field 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // exists. 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindFieldByNumber(int number) const; 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a field by name. Returns NULL if no such field exists. 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindFieldByName(const string& name) const; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a field by lowercased name (as returned by lowercase_name()). 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This lookup may be ambiguous if multiple field names differ only by case, 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in which case the field returned is chosen arbitrarily from the matches. 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindFieldByLowercaseName( 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& lowercase_name) const; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a field by camel-case name (as returned by camelcase_name()). 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This lookup may be ambiguous if multiple field names differ in a way that 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // leads them to have identical camel-case names, in which case the field 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returned is chosen arbitrarily from the matches. 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindFieldByCamelcaseName( 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& camelcase_name) const; 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Nested type stuff ----------------------------------------------- 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of nested types in this message type. 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int nested_type_count() const; 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a nested type by index, where 0 <= index < nested_type_count(). 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* nested_type(int index) const; 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a nested type by name. Returns NULL if no such nested type 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // exists. 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* FindNestedTypeByName(const string& name) const; 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Enum stuff ------------------------------------------------------ 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of enum types in this message type. 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int enum_type_count() const; 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets an enum type by index, where 0 <= index < enum_type_count(). 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* enum_type(int index) const; 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up an enum type by name. Returns NULL if no such enum type exists. 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* FindEnumTypeByName(const string& name) const; 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up an enum value by name, among all enum types in this message. 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns NULL if no such value exists. 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* FindEnumValueByName(const string& name) const; 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Extensions ------------------------------------------------------ 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A range of field numbers which are designated for third-party 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // extensions. 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct ExtensionRange { 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int start; // inclusive 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int end; // exclusive 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of extension ranges in this message type. 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extension_range_count() const; 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets an extension range by index, where 0 <= index < 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // extension_range_count(). These are returned in the order they were defined 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in the .proto file. 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ExtensionRange* extension_range(int index) const; 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the number is in one of the extension ranges. 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsExtensionNumber(int number) const; 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of extensions -- extending *other* messages -- that were 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // defined nested within this message type's scope. 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extension_count() const; 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get an extension by index, where 0 <= index < extension_count(). 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* extension(int index) const; 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a named extension (which extends some *other* message type) 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // defined within this message type's scope. 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByName(const string& name) const; 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Similar to FindFieldByLowercaseName(), but finds extensions defined within 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this message type's scope. 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByLowercaseName(const string& name) const; 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Similar to FindFieldByCamelcaseName(), but finds extensions defined within 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this message type's scope. 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByCamelcaseName(const string& name) const; 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 258ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 259ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 260ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 261ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of this message declaration. Returns false and leaves 262ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // |*out_location| unchanged iff location information was not available. 263ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(SourceLocation* out_location) const; 264ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef MessageOptions OptionsType; 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Internal version of DebugString; controls the level of indenting for 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // correct depth 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DebugString(int depth, string *contents) const; 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 272ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Walks up the descriptor tree to generate the source location path 273ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // to this descriptor from the file root. 274ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void GetLocationPath(vector<int>* output) const; 275ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* full_name_; 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file_; 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* containing_type_; 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MessageOptions* options_; 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if this is a placeholder for an unknown type. 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_placeholder_; 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if this is a placeholder and the type name wasn't fully-qualified. 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_unqualified_placeholder_; 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int field_count_; 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FieldDescriptor* fields_; 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int nested_type_count_; 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Descriptor* nested_types_; 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int enum_type_count_; 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EnumDescriptor* enum_types_; 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extension_range_count_; 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionRange* extension_ranges_; 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extension_count_; 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FieldDescriptor* extensions_; 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<Descriptor>() and AllocateArray<Descriptor>() in descriptor.cc 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and update them to initialize the field. 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be constructed using DescriptorPool. 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Descriptor() {} 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class EnumDescriptor; 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FieldDescriptor; 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class MethodDescriptor; 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FileDescriptor; 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(Descriptor); 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes a single field of a message. To get the descriptor for a given 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// field, first get the Descriptor for the message in which it is defined, 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// then call Descriptor::FindFieldByName(). To get a FieldDescriptor for 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// an extension, do one of the following: 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Get the Descriptor or FileDescriptor for its containing scope, then 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// call Descriptor::FindExtensionByName() or 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// FileDescriptor::FindExtensionByName(). 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Given a DescriptorPool, call DescriptorPool::FindExtensionByNumber(). 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Given a Reflection for a message object, call 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Reflection::FindKnownExtensionByName() or 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Reflection::FindKnownExtensionByNumber(). 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use DescriptorPool to construct your own descriptors. 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT FieldDescriptor { 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Identifies a field type. 0 is reserved for errors. The order is weird 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for historical reasons. Types 12 and up are new in proto2. 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Type { 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_DOUBLE = 1, // double, exactly eight bytes on the wire. 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_FLOAT = 2, // float, exactly four bytes on the wire. 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_INT64 = 3, // int64, varint on the wire. Negative numbers 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // take 10 bytes. Use TYPE_SINT64 if negative 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // values are likely. 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_UINT64 = 4, // uint64, varint on the wire. 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_INT32 = 5, // int32, varint on the wire. Negative numbers 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // take 10 bytes. Use TYPE_SINT32 if negative 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // values are likely. 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_FIXED64 = 6, // uint64, exactly eight bytes on the wire. 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_FIXED32 = 7, // uint32, exactly four bytes on the wire. 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_BOOL = 8, // bool, varint on the wire. 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_STRING = 9, // UTF-8 text. 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_GROUP = 10, // Tag-delimited message. Deprecated. 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_MESSAGE = 11, // Length-delimited message. 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_BYTES = 12, // Arbitrary byte array. 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_UINT32 = 13, // uint32, varint on the wire 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_ENUM = 14, // Enum, varint on the wire 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_SFIXED32 = 15, // int32, exactly four bytes on the wire 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_SFIXED64 = 16, // int64, exactly eight bytes on the wire 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_SINT32 = 17, // int32, ZigZag-encoded varint on the wire 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE_SINT64 = 18, // int64, ZigZag-encoded varint on the wire 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MAX_TYPE = 18, // Constant useful for defining lookup tables 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // indexed by Type. 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Specifies the C++ data type used to represent the field. There is a 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fixed mapping from Type to CppType where each Type maps to exactly one 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // CppType. 0 is reserved for errors. 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum CppType { 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_INT32 = 1, // TYPE_INT32, TYPE_SINT32, TYPE_SFIXED32 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_INT64 = 2, // TYPE_INT64, TYPE_SINT64, TYPE_SFIXED64 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_UINT32 = 3, // TYPE_UINT32, TYPE_FIXED32 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_UINT64 = 4, // TYPE_UINT64, TYPE_FIXED64 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_DOUBLE = 5, // TYPE_DOUBLE 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_FLOAT = 6, // TYPE_FLOAT 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_BOOL = 7, // TYPE_BOOL 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_ENUM = 8, // TYPE_ENUM 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_STRING = 9, // TYPE_STRING, TYPE_BYTES 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CPPTYPE_MESSAGE = 10, // TYPE_MESSAGE, TYPE_GROUP 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MAX_CPPTYPE = 10, // Constant useful for defining lookup tables 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // indexed by CppType. 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Identifies whether the field is optional, required, or repeated. 0 is 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // reserved for errors. 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Label { 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LABEL_OPTIONAL = 1, // optional 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LABEL_REQUIRED = 2, // required 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LABEL_REPEATED = 3, // repeated 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MAX_LABEL = 3, // Constant useful for defining lookup tables 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // indexed by Label. 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Valid field numbers are positive integers up to kMaxNumber. 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kMaxNumber = (1 << 29) - 1; 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // First field number reserved for the protocol buffer library implementation. 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Users may not declare fields that use reserved numbers. 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kFirstReservedNumber = 19000; 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Last field number reserved for the protocol buffer library implementation. 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Users may not declare fields that use reserved numbers. 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kLastReservedNumber = 19999; 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; // Name of this field within the message. 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& full_name() const; // Fully-qualified name of the field. 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file() const;// File in which this field was defined. 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_extension() const; // Is this an extension field? 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int number() const; // Declared tag number. 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Same as name() except converted to lower-case. This (and especially the 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FindFieldByLowercaseName() method) can be useful when parsing formats 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which prefer to use lowercase naming style. (Although, technically 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // field names should be lowercased anyway according to the protobuf style 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // guide, so this only makes a difference when dealing with old .proto files 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which do not follow the guide.) 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& lowercase_name() const; 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Same as name() except converted to camel-case. In this conversion, any 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // time an underscore appears in the name, it is removed and the next 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // letter is capitalized. Furthermore, the first letter of the name is 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // lower-cased. Examples: 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FooBar -> fooBar 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // foo_bar -> fooBar 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fooBar -> fooBar 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This (and especially the FindFieldByCamelcaseName() method) can be useful 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // when parsing formats which prefer to use camel-case naming style. 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& camelcase_name() const; 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 421ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch Type type() const; // Declared type of this field. 422ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch const char* type_name() const; // Name of the declared type. 423ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch CppType cpp_type() const; // C++ type of this field. 424ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch const char* cpp_type_name() const; // Name of the C++ type. 425ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch Label label() const; // optional/required/repeated 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_required() const; // shorthand for label() == LABEL_REQUIRED 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_optional() const; // shorthand for label() == LABEL_OPTIONAL 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_repeated() const; // shorthand for label() == LABEL_REPEATED 4305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_packable() const; // shorthand for is_repeated() && 4315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IsTypePackable(type()) 432ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool is_packed() const; // shorthand for is_packable() && 433ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // options().packed() 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Index of this field within the message's field array, or the file or 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // extension scope's extensions array. 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index() const; 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Does this field have an explicitly-declared default value? 4405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool has_default_value() const; 4415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_INT32. If no 4435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is 0. 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 default_value_int32() const; 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_INT64. If no 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is 0. 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 default_value_int64() const; 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_UINT32. If no 4495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is 0. 4505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint32 default_value_uint32() const; 4515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_UINT64. If no 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is 0. 4535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64 default_value_uint64() const; 4545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_FLOAT. If no 4555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is 0.0. 4565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) float default_value_float() const; 4575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_DOUBLE. If no 4585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is 0.0. 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) double default_value_double() const; 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_BOOL. If no 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is false. 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool default_value_bool() const; 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_ENUM. If no 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is the first value defined 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in the enum type (all enum types are required to have at least one value). 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This never returns NULL. 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* default_value_enum() const; 4685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the field default value if cpp_type() == CPPTYPE_STRING. If no 4695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // explicit default was defined, the default is the empty string. 4705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& default_value_string() const; 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The Descriptor for the message of which this is a field. For extensions, 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this is the extended type. Never NULL. 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* containing_type() const; 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // An extension may be declared within the scope of another message. If this 4775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // field is an extension (is_extension() is true), then extension_scope() 4785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns that message, or NULL if the extension was declared at global 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // scope. If this is not an extension, extension_scope() is undefined (may 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // assert-fail). 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* extension_scope() const; 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If type is TYPE_MESSAGE or TYPE_GROUP, returns a descriptor for the 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message or the group type. Otherwise, undefined. 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* message_type() const; 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If type is TYPE_ENUM, returns a descriptor for the enum. Otherwise, 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // undefined. 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* enum_type() const; 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // EXPERIMENTAL; DO NOT USE. 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this field is a map field, experimental_map_key() is the field 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that is the key for this map. 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // experimental_map_key()->containing_type() is the same as message_type(). 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* experimental_map_key() const; 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the FieldOptions for this field. This includes things listed in 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // square brackets after the field definition. E.g., the field: 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // optional string text = 1 [ctype=CORD]; 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // has the "ctype" option set. Allowed options are defined by FieldOptions 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in google/protobuf/descriptor.proto, and any available extensions of that 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message. 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldOptions& options() const; 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::CopyTo(). 5055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(FieldDescriptorProto* proto) const; 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper method to get the CppType for a particular Type. 5115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static CppType TypeToCppType(Type type); 5125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true iff [packed = true] is valid for fields of this type. 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static inline bool IsTypePackable(Type field_type); 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 516ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 517ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 518ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 519ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of this field declaration. Returns false and leaves 520ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // |*out_location| unchanged iff location information was not available. 521ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(SourceLocation* out_location) const; 522ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 5235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 5245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef FieldOptions OptionsType; 5255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 5275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DebugString(int depth, string *contents) const; 5285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // formats the default value appropriately and returns it as a string. 5305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must have a default value to call this. If quote_string_type is true, then 5315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // types of CPPTYPE_STRING whill be surrounded by quotes and CEscaped. 5325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DefaultValueAsString(bool quote_string_type) const; 5335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 534ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Walks up the descriptor tree to generate the source location path 535ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // to this descriptor from the file root. 536ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void GetLocationPath(vector<int>* output) const; 537ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 5385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 5395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* full_name_; 5405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* lowercase_name_; 5415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* camelcase_name_; 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file_; 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int number_; 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type_; 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Label label_; 5465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_extension_; 5475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* containing_type_; 5485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* extension_scope_; 5495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* message_type_; 5505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* enum_type_; 5515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* experimental_map_key_; 5525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldOptions* options_; 5535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 5545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<FieldDescriptor>() and AllocateArray<FieldDescriptor>() in 5555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptor.cc and update them to initialize the field. 5565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool has_default_value_; 5585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) union { 5595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 default_value_int32_; 5605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 default_value_int64_; 5615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint32 default_value_uint32_; 5625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64 default_value_uint64_; 5635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) float default_value_float_; 5645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) double default_value_double_; 5655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool default_value_bool_; 5665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* default_value_enum_; 5685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* default_value_string_; 5695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 5705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const CppType kTypeToCppTypeMap[MAX_TYPE + 1]; 5725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char * const kTypeToName[MAX_TYPE + 1]; 5745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch static const char * const kCppTypeToName[MAX_CPPTYPE + 1]; 576ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char * const kLabelToName[MAX_LABEL + 1]; 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be constructed using DescriptorPool. 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FieldDescriptor() {} 5815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FileDescriptor; 5835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class Descriptor; 5845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldDescriptor); 5855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 5865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes an enum type defined in a .proto file. To get the EnumDescriptor 5885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// for a generated enum type, call TypeName_descriptor(). Use DescriptorPool 5895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to construct your own descriptors. 5905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT EnumDescriptor { 5915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 5925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The name of this enum type in the containing scope. 5935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; 5945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The fully-qualified name of the enum type, scope delimited by periods. 5965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& full_name() const; 5975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Index of this enum within the file or containing message's enum array. 5995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index() const; 6005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The .proto file in which this enum type was defined. Never NULL. 6025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file() const; 6035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of values for this EnumDescriptor. Guaranteed to be greater 6055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // than zero. 6065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int value_count() const; 6075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a value by index, where 0 <= index < value_count(). 6085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 6095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* value(int index) const; 6105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a value by name. Returns NULL if no such value exists. 6125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* FindValueByName(const string& name) const; 6135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looks up a value by number. Returns NULL if no such value exists. If 6145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // multiple values have this number, the first one defined is returned. 6155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* FindValueByNumber(int number) const; 6165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this enum type is nested in a message type, this is that message type. 6185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Otherwise, NULL. 6195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* containing_type() const; 6205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get options for this enum type. These are specified in the .proto file by 6225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // placing lines like "option foo = 1234;" in the enum definition. Allowed 6235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // options are defined by EnumOptions in google/protobuf/descriptor.proto, 6245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and any available extensions of that message. 6255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumOptions& options() const; 6265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::CopyTo(). 6285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(EnumDescriptorProto* proto) const; 6295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 6315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 6325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 633ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 634ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 635ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 636ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of this enum declaration. Returns false and leaves 637ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // |*out_location| unchanged iff location information was not available. 638ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(SourceLocation* out_location) const; 639ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 6405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 6415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef EnumOptions OptionsType; 6425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 6445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DebugString(int depth, string *contents) const; 6455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 646ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Walks up the descriptor tree to generate the source location path 647ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // to this descriptor from the file root. 648ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void GetLocationPath(vector<int>* output) const; 649ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 6505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 6515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* full_name_; 6525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file_; 6535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* containing_type_; 6545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumOptions* options_; 6555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if this is a placeholder for an unknown type. 6575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_placeholder_; 6585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if this is a placeholder and the type name wasn't fully-qualified. 6595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_unqualified_placeholder_; 6605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int value_count_; 6625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EnumValueDescriptor* values_; 6635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 6645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<EnumDescriptor>() and AllocateArray<EnumDescriptor>() in 6655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptor.cc and update them to initialize the field. 6665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be constructed using DescriptorPool. 6685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EnumDescriptor() {} 6695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 6705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class Descriptor; 6715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FieldDescriptor; 6725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class EnumValueDescriptor; 6735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FileDescriptor; 6745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumDescriptor); 6755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes an individual enum constant of a particular type. To get the 6785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// EnumValueDescriptor for a given enum value, first get the EnumDescriptor 6795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// for its type, then use EnumDescriptor::FindValueByName() or 6805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// EnumDescriptor::FindValueByNumber(). Use DescriptorPool to construct 6815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// your own descriptors. 6825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT EnumValueDescriptor { 6835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 6845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; // Name of this enum constant. 6855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index() const; // Index within the enums's Descriptor. 6865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int number() const; // Numeric value of this enum constant. 6875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The full_name of an enum value is a sibling symbol of the enum type. 6895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // e.g. the full name of FieldDescriptorProto::TYPE_INT32 is actually 6905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "google.protobuf.FieldDescriptorProto.TYPE_INT32", NOT 6915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "google.protobuf.FieldDescriptorProto.Type.TYPE_INT32". This is to conform 6925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // with C++ scoping rules for enums. 6935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& full_name() const; 6945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The type of this value. Never NULL. 6965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* type() const; 6975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get options for this enum value. These are specified in the .proto file 6995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // by adding text like "[foo = 1234]" after an enum value definition. 7005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Allowed options are defined by EnumValueOptions in 7015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // google/protobuf/descriptor.proto, and any available extensions of that 7025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message. 7035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueOptions& options() const; 7045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::CopyTo(). 7065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(EnumValueDescriptorProto* proto) const; 7075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 7095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 7105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 711ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 712ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 713ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 714ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of this enum value declaration. Returns false and leaves 715ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // |*out_location| unchanged iff location information was not available. 716ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(SourceLocation* out_location) const; 717ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 7185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 7195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef EnumValueOptions OptionsType; 7205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 7225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DebugString(int depth, string *contents) const; 7235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 724ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Walks up the descriptor tree to generate the source location path 725ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // to this descriptor from the file root. 726ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void GetLocationPath(vector<int>* output) const; 727ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 7285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 7295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* full_name_; 7305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int number_; 7315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* type_; 7325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueOptions* options_; 7335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 7345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<EnumValueDescriptor>() and AllocateArray<EnumValueDescriptor>() 7355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in descriptor.cc and update them to initialize the field. 7365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be constructed using DescriptorPool. 7385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EnumValueDescriptor() {} 7395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 7405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class EnumDescriptor; 7415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(EnumValueDescriptor); 7425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 7435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes an RPC service. To get the ServiceDescriptor for a service, 7455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// call Service::GetDescriptor(). Generated service classes also have a 7465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static method called descriptor() which returns the type's 7475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ServiceDescriptor. Use DescriptorPool to construct your own descriptors. 7485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT ServiceDescriptor { 7495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 7505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The name of the service, not including its containing scope. 7515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; 7525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The fully-qualified name of the service, scope delimited by periods. 7535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& full_name() const; 7545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Index of this service within the file's services array. 7555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index() const; 7565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The .proto file in which this service was defined. Never NULL. 7585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file() const; 7595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get options for this service type. These are specified in the .proto file 7615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // by placing lines like "option foo = 1234;" in the service definition. 7625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Allowed options are defined by ServiceOptions in 7635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // google/protobuf/descriptor.proto, and any available extensions of that 7645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message. 7655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceOptions& options() const; 7665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of methods this service defines. 7685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int method_count() const; 7695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a MethodDescriptor by index, where 0 <= index < method_count(). 7705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 7715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MethodDescriptor* method(int index) const; 7725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Look up a MethodDescriptor by name. 7745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MethodDescriptor* FindMethodByName(const string& name) const; 7755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::CopyTo(). 7765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(ServiceDescriptorProto* proto) const; 7775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 7795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 7805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 781ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 782ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 783ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 784ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of this service declaration. Returns false and leaves 785ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // |*out_location| unchanged iff location information was not available. 786ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(SourceLocation* out_location) const; 787ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 7885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 7895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef ServiceOptions OptionsType; 7905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 7925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DebugString(string *contents) const; 7935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 794ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Walks up the descriptor tree to generate the source location path 795ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // to this descriptor from the file root. 796ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void GetLocationPath(vector<int>* output) const; 797ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 7985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 7995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* full_name_; 8005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* file_; 8015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceOptions* options_; 8025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int method_count_; 8035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MethodDescriptor* methods_; 8045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 8055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<ServiceDescriptor>() and AllocateArray<ServiceDescriptor>() in 8065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptor.cc and update them to initialize the field. 8075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be constructed using DescriptorPool. 8095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ServiceDescriptor() {} 8105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 8115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FileDescriptor; 8125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class MethodDescriptor; 8135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceDescriptor); 8145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 8155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes an individual service method. To obtain a MethodDescriptor given 8175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// a service, first get its ServiceDescriptor, then call 8185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ServiceDescriptor::FindMethodByName(). Use DescriptorPool to construct your 8195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// own descriptors. 8205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT MethodDescriptor { 8215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 8225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Name of this method, not including containing scope. 8235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; 8245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The fully-qualified name of the method, scope delimited by periods. 8255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& full_name() const; 8265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Index within the service's Descriptor. 8275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int index() const; 8285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the service to which this method belongs. Never NULL. 8305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceDescriptor* service() const; 8315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the type of protocol message which this method accepts as input. 8335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* input_type() const; 8345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the type of protocol message which this message produces as output. 8355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* output_type() const; 8365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get options for this method. These are specified in the .proto file by 8385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // placing lines like "option foo = 1234;" in curly-braces after a method 8395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // declaration. Allowed options are defined by MethodOptions in 8405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // google/protobuf/descriptor.proto, and any available extensions of that 8415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message. 8425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MethodOptions& options() const; 8435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::CopyTo(). 8455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(MethodDescriptorProto* proto) const; 8465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 8485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 8495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 850ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 851ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 852ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 853ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of this method declaration. Returns false and leaves 854ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // |*out_location| unchanged iff location information was not available. 855ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(SourceLocation* out_location) const; 856ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 8575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 8585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef MethodOptions OptionsType; 8595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 8615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DebugString(int depth, string *contents) const; 8625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 863ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Walks up the descriptor tree to generate the source location path 864ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // to this descriptor from the file root. 865ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void GetLocationPath(vector<int>* output) const; 866ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 8675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 8685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* full_name_; 8695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceDescriptor* service_; 8705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* input_type_; 8715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* output_type_; 8725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MethodOptions* options_; 8735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 8745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<MethodDescriptor>() and AllocateArray<MethodDescriptor>() in 8755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptor.cc and update them to initialize the field. 8765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be constructed using DescriptorPool. 8785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MethodDescriptor() {} 8795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 8805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class ServiceDescriptor; 8815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MethodDescriptor); 8825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 8835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 884ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 8855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Describes a whole .proto file. To get the FileDescriptor for a compiled-in 8865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// file, get the descriptor for something defined in that file and call 8875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// descriptor->file(). Use DescriptorPool to construct your own descriptors. 8885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT FileDescriptor { 8895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 8905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The filename, relative to the source tree. 8915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // e.g. "google/protobuf/descriptor.proto" 8925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& name() const; 8935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The package, e.g. "google.protobuf.compiler". 8955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& package() const; 8965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The DescriptorPool in which this FileDescriptor and all its contents were 8985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // allocated. Never NULL. 8995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DescriptorPool* pool() const; 9005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The number of files imported by this one. 9025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int dependency_count() const; 9035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets an imported file by index, where 0 <= index < dependency_count(). 9045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 9055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* dependency(int index) const; 9065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 907ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // The number of files public imported by this one. 908ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // The public dependency list is a subset of the dependency list. 909ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int public_dependency_count() const; 910ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Gets a public imported file by index, where 0 <= index < 911ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // public_dependency_count(). 912ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // These are returned in the order they were defined in the .proto file. 913ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch const FileDescriptor* public_dependency(int index) const; 914ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 915ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // The number of files that are imported for weak fields. 916ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // The weak dependency list is a subset of the dependency list. 917ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int weak_dependency_count() const; 918ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Gets a weak imported file by index, where 0 <= index < 919ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // weak_dependency_count(). 920ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // These are returned in the order they were defined in the .proto file. 921ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch const FileDescriptor* weak_dependency(int index) const; 922ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 9235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Number of top-level message types defined in this file. (This does not 9245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // include nested types.) 9255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int message_type_count() const; 9265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a top-level message type, where 0 <= index < message_type_count(). 9275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 9285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* message_type(int index) const; 9295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Number of top-level enum types defined in this file. (This does not 9315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // include nested types.) 9325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int enum_type_count() const; 9335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a top-level enum type, where 0 <= index < enum_type_count(). 9345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 9355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* enum_type(int index) const; 9365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Number of services defined in this file. 9385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int service_count() const; 9395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a service, where 0 <= index < service_count(). 9405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 9415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceDescriptor* service(int index) const; 9425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Number of extensions defined at file scope. (This does not include 9445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // extensions nested within message types.) 9455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extension_count() const; 9465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets an extension's descriptor, where 0 <= index < extension_count(). 9475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These are returned in the order they were defined in the .proto file. 9485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* extension(int index) const; 9495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get options for this file. These are specified in the .proto file by 9515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // placing lines like "option foo = 1234;" at the top level, outside of any 9525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // other definitions. Allowed options are defined by FileOptions in 9535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // google/protobuf/descriptor.proto, and any available extensions of that 9545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message. 9555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileOptions& options() const; 9565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find a top-level message type by name. Returns NULL if not found. 9585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* FindMessageTypeByName(const string& name) const; 9595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find a top-level enum type by name. Returns NULL if not found. 9605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* FindEnumTypeByName(const string& name) const; 9615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find an enum value defined in any top-level enum by name. Returns NULL if 9625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // not found. 9635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* FindEnumValueByName(const string& name) const; 9645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find a service definition by name. Returns NULL if not found. 9655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceDescriptor* FindServiceByName(const string& name) const; 9665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find a top-level extension definition by name. Returns NULL if not found. 9675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByName(const string& name) const; 9685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Similar to FindExtensionByName(), but searches by lowercased-name. See 9695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Descriptor::FindFieldByLowercaseName(). 9705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByLowercaseName(const string& name) const; 9715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Similar to FindExtensionByName(), but searches by camelcased-name. See 9725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Descriptor::FindFieldByCamelcaseName(). 9735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByCamelcaseName(const string& name) const; 9745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::CopyTo(). 976ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Notes: 977ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // - This method does NOT copy source code information since it is relatively 978ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // large and rarely needed. See CopySourceCodeInfoTo() below. 9795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CopyTo(FileDescriptorProto* proto) const; 980ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Write the source code information of this FileDescriptor into the given 981ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // FileDescriptorProto. See CopyTo() above. 982ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void CopySourceCodeInfoTo(FileDescriptorProto* proto) const; 9835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See Descriptor::DebugString(). 9855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string DebugString() const; 9865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 988ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Source Location --------------------------------------------------- 989ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 990ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Updates |*out_location| to the source location of the complete 991ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // extent of the declaration or declaration-part denoted by |path|. 992ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Returns false and leaves |*out_location| unchanged iff location 993ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // information was not available. (See SourceCodeInfo for 994ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // description of path encoding.) 995ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool GetSourceLocation(const vector<int>& path, 996ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch SourceLocation* out_location) const; 997ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 9985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef FileOptions OptionsType; 9995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* name_; 10015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string* package_; 10025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DescriptorPool* pool_; 10035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int dependency_count_; 10045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor** dependencies_; 1005ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int public_dependency_count_; 1006ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int* public_dependencies_; 1007ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int weak_dependency_count_; 1008ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int* weak_dependencies_; 10095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int message_type_count_; 10105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Descriptor* message_types_; 10115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int enum_type_count_; 10125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EnumDescriptor* enum_types_; 10135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int service_count_; 10145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ServiceDescriptor* services_; 10155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extension_count_; 10165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FieldDescriptor* extensions_; 10175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileOptions* options_; 10185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptorTables* tables_; 1020ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch const SourceCodeInfo* source_code_info_; 10215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IMPORTANT: If you add a new field, make sure to search for all instances 10225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of Allocate<FileDescriptor>() and AllocateArray<FileDescriptor>() in 10235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptor.cc and update them to initialize the field. 10245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FileDescriptor() {} 10265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 10275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class Descriptor; 10285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FieldDescriptor; 10295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class EnumDescriptor; 1030ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch friend class EnumValueDescriptor; 1031ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch friend class MethodDescriptor; 10325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class ServiceDescriptor; 10335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileDescriptor); 10345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 10355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// =================================================================== 10375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Used to construct descriptors. 10395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 10405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Normally you won't want to build your own descriptors. Message classes 10415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// constructed by the protocol compiler will provide them for you. However, 10425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// if you are implementing Message on your own, or if you are writing a 10435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// program which can operate on totally arbitrary types and needs to load 10445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// them from some sort of database, you might need to. 10455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 10465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Since Descriptors are composed of a whole lot of cross-linked bits of 10475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// data that would be a pain to put together manually, the 10485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DescriptorPool class is provided to make the process easier. It can 10495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// take a FileDescriptorProto (defined in descriptor.proto), validate it, 10505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and convert it to a set of nicely cross-linked Descriptors. 10515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 10525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DescriptorPool also helps with memory management. Descriptors are 10535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// composed of many objects containing static data and pointers to each 10545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// other. In all likelihood, when it comes time to delete this data, 10555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// you'll want to delete it all at once. In fact, it is not uncommon to 10565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// have a whole pool of descriptors all cross-linked with each other which 10575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// you wish to delete all at once. This class represents such a pool, and 10585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// handles the memory management for you. 10595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 10605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// You can also search for descriptors within a DescriptorPool by name, and 10615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// extensions by number. 10625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LIBPROTOBUF_EXPORT DescriptorPool { 10635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 10645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a normal, empty DescriptorPool. 10655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DescriptorPool(); 10665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Constructs a DescriptorPool that, when it can't find something among the 10685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptors already in the pool, looks for it in the given 10695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // DescriptorDatabase. 10705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notes: 10715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - If a DescriptorPool is constructed this way, its BuildFile*() methods 10725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // must not be called (they will assert-fail). The only way to populate 10735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the pool with descriptors is to call the Find*By*() methods. 10745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - The Find*By*() methods may block the calling thread if the 10755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // DescriptorDatabase blocks. This in turn means that parsing messages 10765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // may block if they need to look up extensions. 10775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - The Find*By*() methods will use mutexes for thread-safety, thus making 10785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // them slower even when they don't have to fall back to the database. 10795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In fact, even the Find*By*() methods of descriptor objects owned by 10805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this pool will be slower, since they will have to obtain locks too. 10815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - An ErrorCollector may optionally be given to collect validation errors 10825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in files loaded from the database. If not given, errors will be printed 10835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to GOOGLE_LOG(ERROR). Remember that files are built on-demand, so this 10845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ErrorCollector may be called from any thread that calls one of the 10855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find*By*() methods. 10865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class ErrorCollector; 10875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit DescriptorPool(DescriptorDatabase* fallback_database, 10885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ErrorCollector* error_collector = NULL); 10895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~DescriptorPool(); 10915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get a pointer to the generated pool. Generated protocol message classes 10935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which are compiled into the binary will allocate their descriptors in 10945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this pool. Do not add your own descriptors to this pool. 10955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const DescriptorPool* generated_pool(); 10965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find a FileDescriptor in the pool by file name. Returns NULL if not 10985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // found. 10995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* FindFileByName(const string& name) const; 11005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find the FileDescriptor in the pool which defines the given symbol. 11025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If any of the Find*ByName() methods below would succeed, then this is 11035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // equivalent to calling that method and calling the result's file() method. 11045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Otherwise this returns NULL. 11055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* FindFileContainingSymbol( 11065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& symbol_name) const; 11075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Looking up descriptors ------------------------------------------ 11095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These find descriptors by fully-qualified name. These will find both 11105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // top-level descriptors and nested descriptors. They return NULL if not 11115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // found. 11125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor* FindMessageTypeByName(const string& name) const; 11145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindFieldByName(const string& name) const; 11155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByName(const string& name) const; 11165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumDescriptor* FindEnumTypeByName(const string& name) const; 11175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor* FindEnumValueByName(const string& name) const; 11185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceDescriptor* FindServiceByName(const string& name) const; 11195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MethodDescriptor* FindMethodByName(const string& name) const; 11205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Finds an extension of the given type by number. The extendee must be 11225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a member of this DescriptorPool or one of its underlays. 11235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor* FindExtensionByNumber(const Descriptor* extendee, 11245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int number) const; 11255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Finds extensions of extendee. The extensions will be appended to 11275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // out in an undefined order. Only extensions defined directly in 11285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this DescriptorPool or one of its underlays are guaranteed to be 11295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // found: extensions defined in the fallback database might not be found 11305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // depending on the database implementation. 11315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void FindAllExtensions(const Descriptor* extendee, 11325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) vector<const FieldDescriptor*>* out) const; 11335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Building descriptors -------------------------------------------- 11355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When converting a FileDescriptorProto to a FileDescriptor, various 11375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // errors might be detected in the input. The caller may handle these 11385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // programmatically by implementing an ErrorCollector. 11395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class LIBPROTOBUF_EXPORT ErrorCollector { 11405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 11415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline ErrorCollector() {} 11425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ErrorCollector(); 11435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These constants specify what exact part of the construct is broken. 11455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is useful e.g. for mapping the error back to an exact location 11465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in a .proto file. 11475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum ErrorLocation { 11485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NAME, // the symbol name, or the package name for files 11495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NUMBER, // field or extension range number 11505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TYPE, // field type 11515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EXTENDEE, // field extendee 11525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DEFAULT_VALUE, // field default value 11535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) INPUT_TYPE, // method input type 11545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) OUTPUT_TYPE, // method output type 11555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) OPTION_NAME, // name in assignment 11565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) OPTION_VALUE, // value in option assignment 11575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) OTHER // some other problem 11585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 11595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Reports an error in the FileDescriptorProto. 11615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void AddError( 11625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& filename, // File name in which the error occurred. 11635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& element_name, // Full name of the erroneous element. 11645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Message* descriptor, // Descriptor of the erroneous element. 11655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ErrorLocation location, // One of the location constants, above. 11665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& message // Human-readable error message. 11675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) = 0; 11685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 11705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ErrorCollector); 11715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 11725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convert the FileDescriptorProto to real descriptors and place them in 11745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this DescriptorPool. All dependencies of the file must already be in 11755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the pool. Returns the resulting FileDescriptor, or NULL if there were 11765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // problems with the input (e.g. the message was invalid, or dependencies 11775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // were missing). Details about the errors are written to GOOGLE_LOG(ERROR). 11785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* BuildFile(const FileDescriptorProto& proto); 11795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Same as BuildFile() except errors are sent to the given ErrorCollector. 11815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* BuildFileCollectingErrors( 11825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptorProto& proto, 11835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ErrorCollector* error_collector); 11845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // By default, it is an error if a FileDescriptorProto contains references 11865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to types or other files that are not found in the DescriptorPool (or its 11875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // backing DescriptorDatabase, if any). If you call 11885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // AllowUnknownDependencies(), however, then unknown types and files 11895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be replaced by placeholder descriptors. This can allow you to 11905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // perform some useful operations with a .proto file even if you do not 11915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // have access to other .proto files on which it depends. However, some 11925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // heuristics must be used to fill in the gaps in information, and these 11935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // can lead to descriptors which are inaccurate. For example, the 11945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // DescriptorPool may be forced to guess whether an unknown type is a message 11955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // or an enum, as well as what package it resides in. Furthermore, 11965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // placeholder types will not be discoverable via FindMessageTypeByName() 11975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and similar methods, which could confuse some descriptor-based algorithms. 11985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Generally, the results of this option should only be relied upon for 11995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // debugging purposes. 12005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AllowUnknownDependencies() { allow_unknown_ = true; } 12015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Internal stuff -------------------------------------------------- 12035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These methods MUST NOT be called from outside the proto2 library. 12045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These methods may contain hidden pitfalls and may be removed in a 12055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // future library version. 12065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a DescriptorPool which is overlaid on top of some other pool. 12085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If you search for a descriptor in the overlay and it is not found, the 12095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // underlay will be searched as a backup. If the underlay has its own 12105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // underlay, that will be searched next, and so on. This also means that 12115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // files built in the overlay will be cross-linked with the underlay's 12125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // descriptors if necessary. The underlay remains property of the caller; 12135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it must remain valid for the lifetime of the newly-constructed pool. 12145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 12155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Example: Say you want to parse a .proto file at runtime in order to use 12165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // its type with a DynamicMessage. Say this .proto file has dependencies, 12175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but you know that all the dependencies will be things that are already 12185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // compiled into the binary. For ease of use, you'd like to load the types 12195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // right out of generated_pool() rather than have to parse redundant copies 12205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of all these .protos and runtime. But, you don't want to add the parsed 12215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // types directly into generated_pool(): this is not allowed, and would be 12225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // bad design anyway. So, instead, you could use generated_pool() as an 12235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // underlay for a new DescriptorPool in which you add only the new file. 12245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 12255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WARNING: Use of underlays can lead to many subtle gotchas. Instead, 12265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // try to formulate what you want to do in terms of DescriptorDatabases. 12275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit DescriptorPool(const DescriptorPool* underlay); 12285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by generated classes at init time to add their descriptors to 12305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // generated_pool. Do NOT call this in your own code! filename must be a 12315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // permanent string (e.g. a string literal). 12325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void InternalAddGeneratedFile( 12335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const void* encoded_file_descriptor, int size); 12345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For internal use only: Gets a non-const pointer to the generated pool. 12375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is called at static-initialization time only, so thread-safety is 12385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // not a concern. If both an underlay and a fallback database are present, 1239ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // the underlay takes precedence. 12405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static DescriptorPool* internal_generated_pool(); 12415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For internal use only: Changes the behavior of BuildFile() such that it 12435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // allows the file to make reference to message types declared in other files 12445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which it did not officially declare as dependencies. 12455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void InternalDontEnforceDependencies(); 12465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For internal use only. 12485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void internal_set_underlay(const DescriptorPool* underlay) { 12495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) underlay_ = underlay; 12505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 12515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For internal (unit test) use only: Returns true if a FileDescriptor has 12535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // been constructed for the given file, false otherwise. Useful for testing 12545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // lazy descriptor initialization behavior. 12555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool InternalIsFileLoaded(const string& filename) const; 12565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 12585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class Descriptor; 12595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FieldDescriptor; 12605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class EnumDescriptor; 12615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class ServiceDescriptor; 12625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class FileDescriptor; 12635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class DescriptorBuilder; 12645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1265ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Return true if the given name is a sub-symbol of any non-package 1266ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // descriptor that already exists in the descriptor pool. (The full 1267ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // definition of such types is already known.) 1268ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch bool IsSubSymbolOfBuiltType(const string& name) const; 1269ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 12705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Tries to find something in the fallback database and link in the 12715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // corresponding proto file. Returns true if successful, in which case 12725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the caller should search for the thing again. These are declared 12735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // const because they are called by (semantically) const methods. 12745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool TryFindFileInFallbackDatabase(const string& name) const; 12755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool TryFindSymbolInFallbackDatabase(const string& name) const; 12765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool TryFindExtensionInFallbackDatabase(const Descriptor* containing_type, 12775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int field_number) const; 12785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Like BuildFile() but called internally when the file has been loaded from 12805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fallback_database_. Declared const because it is called by (semantically) 12815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // const methods. 12825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptor* BuildFileFromDatabase( 12835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FileDescriptorProto& proto) const; 12845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If fallback_database_ is NULL, this is NULL. Otherwise, this is a mutex 12865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which must be locked while accessing tables_. 12875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Mutex* mutex_; 12885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See constructor. 12905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DescriptorDatabase* fallback_database_; 12915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ErrorCollector* default_error_collector_; 12925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DescriptorPool* underlay_; 12935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This class contains a lot of hash maps with complicated types that 12955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // we'd like to keep out of the header. 12965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Tables; 12975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<Tables> tables_; 12985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool enforce_dependencies_; 13005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool allow_unknown_; 13015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(DescriptorPool); 13035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 13045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// inline methods ==================================================== 13065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// These macros makes this repetitive code more readable. 13085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PROTOBUF_DEFINE_ACCESSOR(CLASS, FIELD, TYPE) \ 13095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline TYPE CLASS::FIELD() const { return FIELD##_; } 13105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Strings fields are stored as pointers but returned as const references. 13125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PROTOBUF_DEFINE_STRING_ACCESSOR(CLASS, FIELD) \ 13135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline const string& CLASS::FIELD() const { return *FIELD##_; } 13145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Arrays take an index parameter, obviously. 13165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PROTOBUF_DEFINE_ARRAY_ACCESSOR(CLASS, FIELD, TYPE) \ 13175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline TYPE CLASS::FIELD(int index) const { return FIELD##s_ + index; } 13185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PROTOBUF_DEFINE_OPTIONS_ACCESSOR(CLASS, TYPE) \ 13205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) inline const TYPE& CLASS::options() const { return *options_; } 13215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(Descriptor, name) 13235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(Descriptor, full_name) 13245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, file, const FileDescriptor*) 13255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, containing_type, const Descriptor*) 13265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, field_count, int) 13285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, nested_type_count, int) 13295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, enum_type_count, int) 13305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(Descriptor, field, const FieldDescriptor*) 13325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(Descriptor, nested_type, const Descriptor*) 13335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(Descriptor, enum_type, const EnumDescriptor*) 13345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, extension_range_count, int) 13365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(Descriptor, extension_count, int) 13375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(Descriptor, extension_range, 13385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Descriptor::ExtensionRange*) 13395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(Descriptor, extension, 13405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor*) 13413551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(Descriptor, MessageOptions) 13425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FieldDescriptor, name) 13445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FieldDescriptor, full_name) 13455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FieldDescriptor, lowercase_name) 13465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FieldDescriptor, camelcase_name) 13475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, file, const FileDescriptor*) 13485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, number, int) 13495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, is_extension, bool) 13505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, type, FieldDescriptor::Type) 13515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, label, FieldDescriptor::Label) 13525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, containing_type, const Descriptor*) 13535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, extension_scope, const Descriptor*) 13545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, message_type, const Descriptor*) 13555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, enum_type, const EnumDescriptor*) 13565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, experimental_map_key, 13575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor*) 13583551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(FieldDescriptor, FieldOptions) 13595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, has_default_value, bool) 13605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_int32 , int32 ) 13615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_int64 , int64 ) 13625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_uint32, uint32) 13635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_uint64, uint64) 13645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_float , float ) 13655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_double, double) 13665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_bool , bool ) 13675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FieldDescriptor, default_value_enum, 13685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor*) 13695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FieldDescriptor, default_value_string) 13705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(EnumDescriptor, name) 13725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(EnumDescriptor, full_name) 13735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(EnumDescriptor, file, const FileDescriptor*) 13745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(EnumDescriptor, containing_type, const Descriptor*) 13755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(EnumDescriptor, value_count, int) 13765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(EnumDescriptor, value, 13775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const EnumValueDescriptor*) 13783551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(EnumDescriptor, EnumOptions) 13795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(EnumValueDescriptor, name) 13815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(EnumValueDescriptor, full_name) 13825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(EnumValueDescriptor, number, int) 13835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(EnumValueDescriptor, type, const EnumDescriptor*) 13843551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(EnumValueDescriptor, EnumValueOptions) 13855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(ServiceDescriptor, name) 13875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(ServiceDescriptor, full_name) 13885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(ServiceDescriptor, file, const FileDescriptor*) 13895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(ServiceDescriptor, method_count, int) 13905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(ServiceDescriptor, method, 13915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MethodDescriptor*) 13923551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(ServiceDescriptor, ServiceOptions) 13935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(MethodDescriptor, name) 13955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(MethodDescriptor, full_name) 13965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(MethodDescriptor, service, const ServiceDescriptor*) 13975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(MethodDescriptor, input_type, const Descriptor*) 13985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(MethodDescriptor, output_type, const Descriptor*) 13993551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(MethodDescriptor, MethodOptions) 14005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FileDescriptor, name) 14015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_STRING_ACCESSOR(FileDescriptor, package) 14025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FileDescriptor, pool, const DescriptorPool*) 14035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FileDescriptor, dependency_count, int) 1404ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben MurdochPROTOBUF_DEFINE_ACCESSOR(FileDescriptor, public_dependency_count, int) 1405ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben MurdochPROTOBUF_DEFINE_ACCESSOR(FileDescriptor, weak_dependency_count, int) 14065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FileDescriptor, message_type_count, int) 14075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FileDescriptor, enum_type_count, int) 14085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FileDescriptor, service_count, int) 14095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ACCESSOR(FileDescriptor, extension_count, int) 14103551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)PROTOBUF_DEFINE_OPTIONS_ACCESSOR(FileDescriptor, FileOptions) 14115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(FileDescriptor, message_type, const Descriptor*) 14135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(FileDescriptor, enum_type, const EnumDescriptor*) 14145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(FileDescriptor, service, 14155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ServiceDescriptor*) 14165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PROTOBUF_DEFINE_ARRAY_ACCESSOR(FileDescriptor, extension, 14175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FieldDescriptor*) 14185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef PROTOBUF_DEFINE_ACCESSOR 14205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef PROTOBUF_DEFINE_STRING_ACCESSOR 14215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef PROTOBUF_DEFINE_ARRAY_ACCESSOR 14225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A few accessors differ from the macros... 14245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline bool FieldDescriptor::is_required() const { 14265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return label() == LABEL_REQUIRED; 14275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline bool FieldDescriptor::is_optional() const { 14305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return label() == LABEL_OPTIONAL; 14315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline bool FieldDescriptor::is_repeated() const { 14345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return label() == LABEL_REPEATED; 14355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline bool FieldDescriptor::is_packable() const { 14385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return is_repeated() && IsTypePackable(type()); 14395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// To save space, index() is computed by looking at the descriptor's position 14425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the parent's array of children. 14435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline int FieldDescriptor::index() const { 14445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!is_extension_) { 14455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - containing_type_->fields_; 14465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else if (extension_scope_ != NULL) { 14475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - extension_scope_->extensions_; 14485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 14495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - file_->extensions_; 14505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 14515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline int Descriptor::index() const { 14545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (containing_type_ == NULL) { 14555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - file_->message_types_; 14565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 14575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - containing_type_->nested_types_; 14585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 14595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline int EnumDescriptor::index() const { 14625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (containing_type_ == NULL) { 14635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - file_->enum_types_; 14645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 14655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - containing_type_->enum_types_; 14665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 14675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline int EnumValueDescriptor::index() const { 14705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - type_->values_; 14715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline int ServiceDescriptor::index() const { 14745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - file_->services_; 14755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline int MethodDescriptor::index() const { 14785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return this - service_->methods_; 14795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1481ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochinline const char* FieldDescriptor::type_name() const { 1482ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch return kTypeToName[type_]; 1483ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch} 1484ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 14855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline FieldDescriptor::CppType FieldDescriptor::cpp_type() const { 14865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return kTypeToCppTypeMap[type_]; 14875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1489ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochinline const char* FieldDescriptor::cpp_type_name() const { 1490ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch return kCppTypeToName[kTypeToCppTypeMap[type_]]; 1491ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch} 1492ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 14935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline FieldDescriptor::CppType FieldDescriptor::TypeToCppType(Type type) { 14945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return kTypeToCppTypeMap[type]; 14955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline bool FieldDescriptor::IsTypePackable(Type field_type) { 14985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return (field_type != FieldDescriptor::TYPE_STRING && 14995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) field_type != FieldDescriptor::TYPE_GROUP && 15005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) field_type != FieldDescriptor::TYPE_MESSAGE && 15015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) field_type != FieldDescriptor::TYPE_BYTES); 15025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline const FileDescriptor* FileDescriptor::dependency(int index) const { 15055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dependencies_[index]; 15065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1508ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochinline const FileDescriptor* FileDescriptor::public_dependency( 1509ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int index) const { 1510ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch return dependencies_[public_dependencies_[index]]; 1511ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch} 1512ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 1513ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochinline const FileDescriptor* FileDescriptor::weak_dependency( 1514ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch int index) const { 1515ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch return dependencies_[weak_dependencies_[index]]; 1516ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch} 1517ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 15185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace protobuf 15195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace google 15215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // GOOGLE_PROTOBUF_DESCRIPTOR_H__ 1522