google::protobuf::FieldDescriptor Class Reference

#include <descriptor.h>

Public Types
enum	Type {   TYPE_DOUBLE = 1, TYPE_FLOAT = 2, TYPE_INT64 = 3, TYPE_UINT64 = 4,   TYPE_INT32 = 5, TYPE_FIXED64 = 6, TYPE_FIXED32 = 7, TYPE_BOOL = 8,   TYPE_STRING = 9, TYPE_GROUP = 10, TYPE_MESSAGE = 11, TYPE_BYTES = 12,   TYPE_UINT32 = 13, TYPE_ENUM = 14, TYPE_SFIXED32 = 15, TYPE_SFIXED64 = 16,   TYPE_SINT32 = 17, TYPE_SINT64 = 18, MAX_TYPE = 18 }
enum	CppType {   CPPTYPE_INT32 = 1, CPPTYPE_INT64 = 2, CPPTYPE_UINT32 = 3, CPPTYPE_UINT64 = 4,   CPPTYPE_DOUBLE = 5, CPPTYPE_FLOAT = 6, CPPTYPE_BOOL = 7, CPPTYPE_ENUM = 8,   CPPTYPE_STRING = 9, CPPTYPE_MESSAGE = 10, MAX_CPPTYPE = 10 }
enum	Label { LABEL_OPTIONAL = 1, LABEL_REQUIRED = 2, LABEL_REPEATED = 3, MAX_LABEL = 3 }

Public Member Functions
const string &	name () const
const string &	full_name () const
const FileDescriptor *	file () const
bool	is_extension () const
int	number () const
const string &	lowercase_name () const
const string &	camelcase_name () const
Type	type () const
const char *	type_name () const
CppType	cpp_type () const
const char *	cpp_type_name () const
Label	label () const
bool	is_required () const
bool	is_optional () const
bool	is_repeated () const
bool	is_packable () const
bool	is_packed () const
int	index () const
bool	has_default_value () const
int32	default_value_int32 () const
int64	default_value_int64 () const
uint32	default_value_uint32 () const
uint64	default_value_uint64 () const
float	default_value_float () const
double	default_value_double () const
bool	default_value_bool () const
const EnumValueDescriptor *	default_value_enum () const
const string &	default_value_string () const
const Descriptor *	containing_type () const
const OneofDescriptor *	containing_oneof () const
int	index_in_oneof () const
const Descriptor *	extension_scope () const
const Descriptor *	message_type () const
const EnumDescriptor *	enum_type () const
const FieldDescriptor *	experimental_map_key () const
const FieldOptions &	options () const
void	CopyTo (FieldDescriptorProto *proto) const
string	DebugString () const
bool	GetSourceLocation (SourceLocation *out_location) const

Static Public Member Functions
static CppType	TypeToCppType (Type type)
static const char *	TypeName (Type type)
static const char *	CppTypeName (CppType cpp_type)
static bool	IsTypePackable (Type field_type)

Static Public Attributes
static const int	kMaxNumber = (1 << 29) - 1
static const int	kFirstReservedNumber = 19000
static const int	kLastReservedNumber = 19999

Private Types
enum	PrintLabelFlag { PRINT_LABEL, OMIT_LABEL }
typedef FieldOptions	OptionsType

Private Member Functions
void	DebugString (int depth, PrintLabelFlag print_label_flag, string *contents) const
string	DefaultValueAsString (bool quote_string_type) const
void	GetLocationPath (vector< int > *output) const
	FieldDescriptor ()
	GOOGLE_DISALLOW_EVIL_CONSTRUCTORS (FieldDescriptor)

Private Attributes
const string *	name_
const string *	full_name_
const string *	lowercase_name_
const string *	camelcase_name_
const FileDescriptor *	file_
int	number_
Type	type_
Label	label_
bool	is_extension_
int	index_in_oneof_
const Descriptor *	containing_type_
const OneofDescriptor *	containing_oneof_
const Descriptor *	extension_scope_
const Descriptor *	message_type_
const EnumDescriptor *	enum_type_
const FieldDescriptor *	experimental_map_key_
const FieldOptions *	options_
bool	has_default_value_
union {
int32   default_value_int32_
int64   default_value_int64_
uint32   default_value_uint32_
uint64   default_value_uint64_
float   default_value_float_
double   default_value_double_
bool   default_value_bool_
const EnumValueDescriptor *   default_value_enum_
const string *   default_value_string_
};

Static Private Attributes
static const CppType	kTypeToCppTypeMap [MAX_TYPE+1]
static const char *const	kTypeToName [MAX_TYPE+1]
static const char *const	kCppTypeToName [MAX_CPPTYPE+1]
static const char *const	kLabelToName [MAX_LABEL+1]

Friends
class	DescriptorBuilder
class	FileDescriptor
class	Descriptor
class	OneofDescriptor

Member Typedef Documentation

typedef FieldOptions google::protobuf::FieldDescriptor::OptionsType

private

Member Enumeration Documentation

enum google::protobuf::FieldDescriptor::CppType

Enumerator
CPPTYPE_INT32
CPPTYPE_INT64
CPPTYPE_UINT32
CPPTYPE_UINT64
CPPTYPE_DOUBLE
CPPTYPE_FLOAT
CPPTYPE_BOOL
CPPTYPE_ENUM
CPPTYPE_STRING
CPPTYPE_MESSAGE
MAX_CPPTYPE

 {
 CPPTYPE_INT32 = 1, // TYPE_INT32, TYPE_SINT32, TYPE_SFIXED32
 CPPTYPE_INT64 = 2, // TYPE_INT64, TYPE_SINT64, TYPE_SFIXED64
 CPPTYPE_UINT32 = 3, // TYPE_UINT32, TYPE_FIXED32
 CPPTYPE_UINT64 = 4, // TYPE_UINT64, TYPE_FIXED64
 CPPTYPE_DOUBLE = 5, // TYPE_DOUBLE
 CPPTYPE_FLOAT = 6, // TYPE_FLOAT
 CPPTYPE_BOOL = 7, // TYPE_BOOL
 CPPTYPE_ENUM = 8, // TYPE_ENUM
 CPPTYPE_STRING = 9, // TYPE_STRING, TYPE_BYTES
 CPPTYPE_MESSAGE = 10, // TYPE_MESSAGE, TYPE_GROUP

 MAX_CPPTYPE = 10, // Constant useful for defining lookup tables
 // indexed by CppType.
 };

enum google::protobuf::FieldDescriptor::Label

Enumerator
LABEL_OPTIONAL
LABEL_REQUIRED
LABEL_REPEATED
MAX_LABEL

 {
 LABEL_OPTIONAL = 1, // optional
 LABEL_REQUIRED = 2, // required
 LABEL_REPEATED = 3, // repeated

 MAX_LABEL = 3, // Constant useful for defining lookup tables
 // indexed by Label.
 };

enum google::protobuf::FieldDescriptor::PrintLabelFlag

private

Enumerator
PRINT_LABEL
OMIT_LABEL

{ PRINT_LABEL, OMIT_LABEL };

enum google::protobuf::FieldDescriptor::Type

Enumerator
TYPE_DOUBLE
TYPE_FLOAT
TYPE_INT64
TYPE_UINT64
TYPE_INT32
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP
TYPE_MESSAGE
TYPE_BYTES
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32
TYPE_SINT64
MAX_TYPE

 {
 TYPE_DOUBLE = 1, // double, exactly eight bytes on the wire.
 TYPE_FLOAT = 2, // float, exactly four bytes on the wire.
 TYPE_INT64 = 3, // int64, varint on the wire. Negative numbers
 // take 10 bytes. Use TYPE_SINT64 if negative
 // values are likely.
 TYPE_UINT64 = 4, // uint64, varint on the wire.
 TYPE_INT32 = 5, // int32, varint on the wire. Negative numbers
 // take 10 bytes. Use TYPE_SINT32 if negative
 // values are likely.
 TYPE_FIXED64 = 6, // uint64, exactly eight bytes on the wire.
 TYPE_FIXED32 = 7, // uint32, exactly four bytes on the wire.
 TYPE_BOOL = 8, // bool, varint on the wire.
 TYPE_STRING = 9, // UTF-8 text.
 TYPE_GROUP = 10, // Tag-delimited message. Deprecated.
 TYPE_MESSAGE = 11, // Length-delimited message.

 TYPE_BYTES = 12, // Arbitrary byte array.
 TYPE_UINT32 = 13, // uint32, varint on the wire
 TYPE_ENUM = 14, // Enum, varint on the wire
 TYPE_SFIXED32 = 15, // int32, exactly four bytes on the wire
 TYPE_SFIXED64 = 16, // int64, exactly eight bytes on the wire
 TYPE_SINT32 = 17, // int32, ZigZag-encoded varint on the wire
 TYPE_SINT64 = 18, // int64, ZigZag-encoded varint on the wire

 MAX_TYPE = 18, // Constant useful for defining lookup tables
 // indexed by Type.
 };

Constructor & Destructor Documentation

google::protobuf::FieldDescriptor::FieldDescriptor ( )

inlineprivate

{}

Member Function Documentation

const string& google::protobuf::FieldDescriptor::camelcase_name

(

)

const

const OneofDescriptor* google::protobuf::FieldDescriptor::containing_oneof

(

)

const

const Descriptor* google::protobuf::FieldDescriptor::containing_type

(

)

const

Here is the caller graph for this function:

void google::protobuf::FieldDescriptor::CopyTo

(

FieldDescriptorProto *

proto

)

const

FieldDescriptor::CppType google::protobuf::FieldDescriptor::cpp_type ( ) const

inline

 {
 return kTypeToCppTypeMap[type_];
}

Here is the caller graph for this function:

const char * google::protobuf::FieldDescriptor::cpp_type_name ( ) const

inline

 {
 return kCppTypeToName[kTypeToCppTypeMap[type_]];
}

const char * google::protobuf::FieldDescriptor::CppTypeName ( CppType  cpp_type )

inlinestatic

 {
 return kCppTypeToName[cpp_type];
}

Here is the call graph for this function:

Here is the caller graph for this function:

string google::protobuf::FieldDescriptor::DebugString

(

)

const

void google::protobuf::FieldDescriptor::DebugString ( int  depth, PrintLabelFlag  print_label_flag, string *  contents  ) const

private

bool google::protobuf::FieldDescriptor::default_value_bool

(

)

const

double google::protobuf::FieldDescriptor::default_value_double

(

)

const

const EnumValueDescriptor* google::protobuf::FieldDescriptor::default_value_enum

(

)

const

float google::protobuf::FieldDescriptor::default_value_float

(

)

const

int32 google::protobuf::FieldDescriptor::default_value_int32

(

)

const

int64 google::protobuf::FieldDescriptor::default_value_int64

(

)

const

const string& google::protobuf::FieldDescriptor::default_value_string

(

)

const

uint32 google::protobuf::FieldDescriptor::default_value_uint32

(

)

const

uint64 google::protobuf::FieldDescriptor::default_value_uint64

(

)

const

string google::protobuf::FieldDescriptor::DefaultValueAsString ( bool  quote_string_type ) const

private

const EnumDescriptor* google::protobuf::FieldDescriptor::enum_type

(

)

const

Here is the caller graph for this function:

const FieldDescriptor* google::protobuf::FieldDescriptor::experimental_map_key

(

)

const

const Descriptor* google::protobuf::FieldDescriptor::extension_scope

(

)

const

Here is the caller graph for this function:

const FileDescriptor* google::protobuf::FieldDescriptor::file

(

)

const

const string& google::protobuf::FieldDescriptor::full_name

(

)

const

Here is the caller graph for this function:

void google::protobuf::FieldDescriptor::GetLocationPath ( vector< int > *  output ) const

private

bool google::protobuf::FieldDescriptor::GetSourceLocation

(

SourceLocation *

out_location

)

const

google::protobuf::FieldDescriptor::GOOGLE_DISALLOW_EVIL_CONSTRUCTORS ( FieldDescriptor  )

private

bool google::protobuf::FieldDescriptor::has_default_value

(

)

const

int google::protobuf::FieldDescriptor::index ( ) const

inline

 {
 if (!is_extension_) {
 return static_cast<int>(this - containing_type_->fields_);
 } else if (extension_scope_ != NULL) {
 return static_cast<int>(this - extension_scope_->extensions_);
 } else {
 return static_cast<int>(this - file_->extensions_);
 }
}

int google::protobuf::FieldDescriptor::index_in_oneof

(

)

const

bool google::protobuf::FieldDescriptor::is_extension

(

)

const

Here is the caller graph for this function:

bool google::protobuf::FieldDescriptor::is_optional ( ) const

inline

 {
 return label() == LABEL_OPTIONAL;
}

Here is the call graph for this function:

bool google::protobuf::FieldDescriptor::is_packable ( ) const

inline

 {
 return is_repeated() && IsTypePackable(type());
}

Here is the call graph for this function:

bool google::protobuf::FieldDescriptor::is_packed

(

)

const

bool google::protobuf::FieldDescriptor::is_repeated ( ) const

inline

 {
 return label() == LABEL_REPEATED;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool google::protobuf::FieldDescriptor::is_required ( ) const

inline

 {
 return label() == LABEL_REQUIRED;
}

Here is the call graph for this function:

bool google::protobuf::FieldDescriptor::IsTypePackable ( Type  field_type )

inlinestatic

 {
 return (field_type != FieldDescriptor::TYPE_STRING &&
 field_type != FieldDescriptor::TYPE_GROUP &&
 field_type != FieldDescriptor::TYPE_MESSAGE &&
 field_type != FieldDescriptor::TYPE_BYTES);
}

Here is the caller graph for this function:

Label google::protobuf::FieldDescriptor::label

(

)

const

Here is the caller graph for this function:

const string& google::protobuf::FieldDescriptor::lowercase_name

(

)

const

const Descriptor* google::protobuf::FieldDescriptor::message_type

(

)

const

const string& google::protobuf::FieldDescriptor::name

(

)

const

Here is the caller graph for this function:

int google::protobuf::FieldDescriptor::number

(

)

const

Here is the caller graph for this function:

const FieldOptions& google::protobuf::FieldDescriptor::options

(

)

const

Here is the caller graph for this function:

Type google::protobuf::FieldDescriptor::type

(

)

const

Here is the caller graph for this function:

const char * google::protobuf::FieldDescriptor::type_name ( ) const

inline

 {
 return kTypeToName[type_];
}

const char * google::protobuf::FieldDescriptor::TypeName ( Type  type )

inlinestatic

 {
 return kTypeToName[type];
}

Here is the call graph for this function:

FieldDescriptor::CppType google::protobuf::FieldDescriptor::TypeToCppType ( Type  type )

inlinestatic

 {
 return kTypeToCppTypeMap[type];
}

Here is the call graph for this function:

Friends And Related Function Documentation

friend class Descriptor

friend

friend class DescriptorBuilder

friend

friend class FileDescriptor

friend

friend class OneofDescriptor

friend

Member Data Documentation

union { ... }

const string* google::protobuf::FieldDescriptor::camelcase_name_

private

const OneofDescriptor* google::protobuf::FieldDescriptor::containing_oneof_

private

const Descriptor* google::protobuf::FieldDescriptor::containing_type_

private

bool google::protobuf::FieldDescriptor::default_value_bool_

double google::protobuf::FieldDescriptor::default_value_double_

const EnumValueDescriptor* google::protobuf::FieldDescriptor::default_value_enum_

float google::protobuf::FieldDescriptor::default_value_float_

int32 google::protobuf::FieldDescriptor::default_value_int32_

int64 google::protobuf::FieldDescriptor::default_value_int64_

const string* google::protobuf::FieldDescriptor::default_value_string_

uint32 google::protobuf::FieldDescriptor::default_value_uint32_

uint64 google::protobuf::FieldDescriptor::default_value_uint64_

const EnumDescriptor* google::protobuf::FieldDescriptor::enum_type_

private

const FieldDescriptor* google::protobuf::FieldDescriptor::experimental_map_key_

private

const Descriptor* google::protobuf::FieldDescriptor::extension_scope_

private

const FileDescriptor* google::protobuf::FieldDescriptor::file_

private

const string* google::protobuf::FieldDescriptor::full_name_

private

bool google::protobuf::FieldDescriptor::has_default_value_

private

int google::protobuf::FieldDescriptor::index_in_oneof_

private

bool google::protobuf::FieldDescriptor::is_extension_

private

const char* const google::protobuf::FieldDescriptor::kCppTypeToName[MAX_CPPTYPE+1]

staticprivate

const int google::protobuf::FieldDescriptor::kFirstReservedNumber = 19000

static

const char* const google::protobuf::FieldDescriptor::kLabelToName[MAX_LABEL+1]

staticprivate

const int google::protobuf::FieldDescriptor::kLastReservedNumber = 19999

static

const int google::protobuf::FieldDescriptor::kMaxNumber = (1 << 29) - 1

static

const CppType google::protobuf::FieldDescriptor::kTypeToCppTypeMap[MAX_TYPE+1]

staticprivate

const char* const google::protobuf::FieldDescriptor::kTypeToName[MAX_TYPE+1]

staticprivate

Label google::protobuf::FieldDescriptor::label_

private

const string* google::protobuf::FieldDescriptor::lowercase_name_

private

const Descriptor* google::protobuf::FieldDescriptor::message_type_

private

const string* google::protobuf::FieldDescriptor::name_

private

int google::protobuf::FieldDescriptor::number_

private

const FieldOptions* google::protobuf::FieldDescriptor::options_

private

Type google::protobuf::FieldDescriptor::type_

private

---

The documentation for this class was generated from the following file:

• dep/protobuf/src/google/protobuf/descriptor.h