|
@@ -34,134 +34,148 @@ NS_ASSUME_NONNULL_BEGIN
|
|
|
|
|
|
#pragma mark - Enum GPBSyntax
|
|
|
|
|
|
-/// The syntax in which a protocol buffer element is defined.
|
|
|
+/** The syntax in which a protocol buffer element is defined. */
|
|
|
typedef GPB_ENUM(GPBSyntax) {
|
|
|
- /// Value used if any message's field encounters a value that is not defined
|
|
|
- /// by this enum. The message will also have C functions to get/set the rawValue
|
|
|
- /// of the field.
|
|
|
+ /**
|
|
|
+ * Value used if any message's field encounters a value that is not defined
|
|
|
+ * by this enum. The message will also have C functions to get/set the rawValue
|
|
|
+ * of the field.
|
|
|
+ **/
|
|
|
GPBSyntax_GPBUnrecognizedEnumeratorValue = kGPBUnrecognizedEnumeratorValue,
|
|
|
- /// Syntax `proto2`.
|
|
|
+ /** Syntax `proto2`. */
|
|
|
GPBSyntax_SyntaxProto2 = 0,
|
|
|
|
|
|
- /// Syntax `proto3`.
|
|
|
+ /** Syntax `proto3`. */
|
|
|
GPBSyntax_SyntaxProto3 = 1,
|
|
|
};
|
|
|
|
|
|
GPBEnumDescriptor *GPBSyntax_EnumDescriptor(void);
|
|
|
|
|
|
-/// Checks to see if the given value is defined by the enum or was not known at
|
|
|
-/// the time this source was generated.
|
|
|
+/**
|
|
|
+ * Checks to see if the given value is defined by the enum or was not known at
|
|
|
+ * the time this source was generated.
|
|
|
+ **/
|
|
|
BOOL GPBSyntax_IsValidValue(int32_t value);
|
|
|
|
|
|
#pragma mark - Enum GPBField_Kind
|
|
|
|
|
|
-/// Basic field types.
|
|
|
+/** Basic field types. */
|
|
|
typedef GPB_ENUM(GPBField_Kind) {
|
|
|
- /// Value used if any message's field encounters a value that is not defined
|
|
|
- /// by this enum. The message will also have C functions to get/set the rawValue
|
|
|
- /// of the field.
|
|
|
+ /**
|
|
|
+ * Value used if any message's field encounters a value that is not defined
|
|
|
+ * by this enum. The message will also have C functions to get/set the rawValue
|
|
|
+ * of the field.
|
|
|
+ **/
|
|
|
GPBField_Kind_GPBUnrecognizedEnumeratorValue = kGPBUnrecognizedEnumeratorValue,
|
|
|
- /// Field type unknown.
|
|
|
+ /** Field type unknown. */
|
|
|
GPBField_Kind_TypeUnknown = 0,
|
|
|
|
|
|
- /// Field type double.
|
|
|
+ /** Field type double. */
|
|
|
GPBField_Kind_TypeDouble = 1,
|
|
|
|
|
|
- /// Field type float.
|
|
|
+ /** Field type float. */
|
|
|
GPBField_Kind_TypeFloat = 2,
|
|
|
|
|
|
- /// Field type int64.
|
|
|
+ /** Field type int64. */
|
|
|
GPBField_Kind_TypeInt64 = 3,
|
|
|
|
|
|
- /// Field type uint64.
|
|
|
+ /** Field type uint64. */
|
|
|
GPBField_Kind_TypeUint64 = 4,
|
|
|
|
|
|
- /// Field type int32.
|
|
|
+ /** Field type int32. */
|
|
|
GPBField_Kind_TypeInt32 = 5,
|
|
|
|
|
|
- /// Field type fixed64.
|
|
|
+ /** Field type fixed64. */
|
|
|
GPBField_Kind_TypeFixed64 = 6,
|
|
|
|
|
|
- /// Field type fixed32.
|
|
|
+ /** Field type fixed32. */
|
|
|
GPBField_Kind_TypeFixed32 = 7,
|
|
|
|
|
|
- /// Field type bool.
|
|
|
+ /** Field type bool. */
|
|
|
GPBField_Kind_TypeBool = 8,
|
|
|
|
|
|
- /// Field type string.
|
|
|
+ /** Field type string. */
|
|
|
GPBField_Kind_TypeString = 9,
|
|
|
|
|
|
- /// Field type group. Proto2 syntax only, and deprecated.
|
|
|
+ /** Field type group. Proto2 syntax only, and deprecated. */
|
|
|
GPBField_Kind_TypeGroup = 10,
|
|
|
|
|
|
- /// Field type message.
|
|
|
+ /** Field type message. */
|
|
|
GPBField_Kind_TypeMessage = 11,
|
|
|
|
|
|
- /// Field type bytes.
|
|
|
+ /** Field type bytes. */
|
|
|
GPBField_Kind_TypeBytes = 12,
|
|
|
|
|
|
- /// Field type uint32.
|
|
|
+ /** Field type uint32. */
|
|
|
GPBField_Kind_TypeUint32 = 13,
|
|
|
|
|
|
- /// Field type enum.
|
|
|
+ /** Field type enum. */
|
|
|
GPBField_Kind_TypeEnum = 14,
|
|
|
|
|
|
- /// Field type sfixed32.
|
|
|
+ /** Field type sfixed32. */
|
|
|
GPBField_Kind_TypeSfixed32 = 15,
|
|
|
|
|
|
- /// Field type sfixed64.
|
|
|
+ /** Field type sfixed64. */
|
|
|
GPBField_Kind_TypeSfixed64 = 16,
|
|
|
|
|
|
- /// Field type sint32.
|
|
|
+ /** Field type sint32. */
|
|
|
GPBField_Kind_TypeSint32 = 17,
|
|
|
|
|
|
- /// Field type sint64.
|
|
|
+ /** Field type sint64. */
|
|
|
GPBField_Kind_TypeSint64 = 18,
|
|
|
};
|
|
|
|
|
|
GPBEnumDescriptor *GPBField_Kind_EnumDescriptor(void);
|
|
|
|
|
|
-/// Checks to see if the given value is defined by the enum or was not known at
|
|
|
-/// the time this source was generated.
|
|
|
+/**
|
|
|
+ * Checks to see if the given value is defined by the enum or was not known at
|
|
|
+ * the time this source was generated.
|
|
|
+ **/
|
|
|
BOOL GPBField_Kind_IsValidValue(int32_t value);
|
|
|
|
|
|
#pragma mark - Enum GPBField_Cardinality
|
|
|
|
|
|
-/// Whether a field is optional, required, or repeated.
|
|
|
+/** Whether a field is optional, required, or repeated. */
|
|
|
typedef GPB_ENUM(GPBField_Cardinality) {
|
|
|
- /// Value used if any message's field encounters a value that is not defined
|
|
|
- /// by this enum. The message will also have C functions to get/set the rawValue
|
|
|
- /// of the field.
|
|
|
+ /**
|
|
|
+ * Value used if any message's field encounters a value that is not defined
|
|
|
+ * by this enum. The message will also have C functions to get/set the rawValue
|
|
|
+ * of the field.
|
|
|
+ **/
|
|
|
GPBField_Cardinality_GPBUnrecognizedEnumeratorValue = kGPBUnrecognizedEnumeratorValue,
|
|
|
- /// For fields with unknown cardinality.
|
|
|
+ /** For fields with unknown cardinality. */
|
|
|
GPBField_Cardinality_CardinalityUnknown = 0,
|
|
|
|
|
|
- /// For optional fields.
|
|
|
+ /** For optional fields. */
|
|
|
GPBField_Cardinality_CardinalityOptional = 1,
|
|
|
|
|
|
- /// For required fields. Proto2 syntax only.
|
|
|
+ /** For required fields. Proto2 syntax only. */
|
|
|
GPBField_Cardinality_CardinalityRequired = 2,
|
|
|
|
|
|
- /// For repeated fields.
|
|
|
+ /** For repeated fields. */
|
|
|
GPBField_Cardinality_CardinalityRepeated = 3,
|
|
|
};
|
|
|
|
|
|
GPBEnumDescriptor *GPBField_Cardinality_EnumDescriptor(void);
|
|
|
|
|
|
-/// Checks to see if the given value is defined by the enum or was not known at
|
|
|
-/// the time this source was generated.
|
|
|
+/**
|
|
|
+ * Checks to see if the given value is defined by the enum or was not known at
|
|
|
+ * the time this source was generated.
|
|
|
+ **/
|
|
|
BOOL GPBField_Cardinality_IsValidValue(int32_t value);
|
|
|
|
|
|
#pragma mark - GPBTypeRoot
|
|
|
|
|
|
-/// Exposes the extension registry for this file.
|
|
|
-///
|
|
|
-/// The base class provides:
|
|
|
-/// @code
|
|
|
-/// + (GPBExtensionRegistry *)extensionRegistry;
|
|
|
-/// @endcode
|
|
|
-/// which is a @c GPBExtensionRegistry that includes all the extensions defined by
|
|
|
-/// this file and all files that it depends on.
|
|
|
+/**
|
|
|
+ * Exposes the extension registry for this file.
|
|
|
+ *
|
|
|
+ * The base class provides:
|
|
|
+ * @code
|
|
|
+ * + (GPBExtensionRegistry *)extensionRegistry;
|
|
|
+ * @endcode
|
|
|
+ * which is a @c GPBExtensionRegistry that includes all the extensions defined by
|
|
|
+ * this file and all files that it depends on.
|
|
|
+ **/
|
|
|
@interface GPBTypeRoot : GPBRootObject
|
|
|
@end
|
|
|
|
|
@@ -176,43 +190,49 @@ typedef GPB_ENUM(GPBType_FieldNumber) {
|
|
|
GPBType_FieldNumber_Syntax = 6,
|
|
|
};
|
|
|
|
|
|
-/// A protocol buffer message type.
|
|
|
+/**
|
|
|
+ * A protocol buffer message type.
|
|
|
+ **/
|
|
|
@interface GPBType : GPBMessage
|
|
|
|
|
|
-/// The fully qualified message name.
|
|
|
+/** The fully qualified message name. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *name;
|
|
|
|
|
|
-/// The list of fields.
|
|
|
+/** The list of fields. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBField*> *fieldsArray;
|
|
|
-/// The number of items in @c fieldsArray without causing the array to be created.
|
|
|
+/** The number of items in @c fieldsArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger fieldsArray_Count;
|
|
|
|
|
|
-/// The list of types appearing in `oneof` definitions in this type.
|
|
|
+/** The list of types appearing in `oneof` definitions in this type. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<NSString*> *oneofsArray;
|
|
|
-/// The number of items in @c oneofsArray without causing the array to be created.
|
|
|
+/** The number of items in @c oneofsArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger oneofsArray_Count;
|
|
|
|
|
|
-/// The protocol buffer options.
|
|
|
+/** The protocol buffer options. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOption*> *optionsArray;
|
|
|
-/// The number of items in @c optionsArray without causing the array to be created.
|
|
|
+/** The number of items in @c optionsArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger optionsArray_Count;
|
|
|
|
|
|
-/// The source context.
|
|
|
+/** The source context. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) GPBSourceContext *sourceContext;
|
|
|
-/// Test to see if @c sourceContext has been set.
|
|
|
+/** Test to see if @c sourceContext has been set. */
|
|
|
@property(nonatomic, readwrite) BOOL hasSourceContext;
|
|
|
|
|
|
-/// The source syntax.
|
|
|
+/** The source syntax. */
|
|
|
@property(nonatomic, readwrite) GPBSyntax syntax;
|
|
|
|
|
|
@end
|
|
|
|
|
|
-/// Fetches the raw value of a @c GPBType's @c syntax property, even
|
|
|
-/// if the value was not defined by the enum at the time the code was generated.
|
|
|
+/**
|
|
|
+ * Fetches the raw value of a @c GPBType's @c syntax property, even
|
|
|
+ * if the value was not defined by the enum at the time the code was generated.
|
|
|
+ **/
|
|
|
int32_t GPBType_Syntax_RawValue(GPBType *message);
|
|
|
-/// Sets the raw value of an @c GPBType's @c syntax property, allowing
|
|
|
-/// it to be set to a value that was not defined by the enum at the time the code
|
|
|
-/// was generated.
|
|
|
+/**
|
|
|
+ * Sets the raw value of an @c GPBType's @c syntax property, allowing
|
|
|
+ * it to be set to a value that was not defined by the enum at the time the code
|
|
|
+ * was generated.
|
|
|
+ **/
|
|
|
void SetGPBType_Syntax_RawValue(GPBType *message, int32_t value);
|
|
|
|
|
|
#pragma mark - GPBField
|
|
@@ -230,59 +250,73 @@ typedef GPB_ENUM(GPBField_FieldNumber) {
|
|
|
GPBField_FieldNumber_DefaultValue = 11,
|
|
|
};
|
|
|
|
|
|
-/// A single field of a message type.
|
|
|
+/**
|
|
|
+ * A single field of a message type.
|
|
|
+ **/
|
|
|
@interface GPBField : GPBMessage
|
|
|
|
|
|
-/// The field type.
|
|
|
+/** The field type. */
|
|
|
@property(nonatomic, readwrite) GPBField_Kind kind;
|
|
|
|
|
|
-/// The field cardinality.
|
|
|
+/** The field cardinality. */
|
|
|
@property(nonatomic, readwrite) GPBField_Cardinality cardinality;
|
|
|
|
|
|
-/// The field number.
|
|
|
+/** The field number. */
|
|
|
@property(nonatomic, readwrite) int32_t number;
|
|
|
|
|
|
-/// The field name.
|
|
|
+/** The field name. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *name;
|
|
|
|
|
|
-/// The field type URL, without the scheme, for message or enumeration
|
|
|
-/// types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
|
|
+/**
|
|
|
+ * The field type URL, without the scheme, for message or enumeration
|
|
|
+ * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
|
|
+ **/
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *typeURL;
|
|
|
|
|
|
-/// The index of the field type in `Type.oneofs`, for message or enumeration
|
|
|
-/// types. The first type has index 1; zero means the type is not in the list.
|
|
|
+/**
|
|
|
+ * The index of the field type in `Type.oneofs`, for message or enumeration
|
|
|
+ * types. The first type has index 1; zero means the type is not in the list.
|
|
|
+ **/
|
|
|
@property(nonatomic, readwrite) int32_t oneofIndex;
|
|
|
|
|
|
-/// Whether to use alternative packed wire representation.
|
|
|
+/** Whether to use alternative packed wire representation. */
|
|
|
@property(nonatomic, readwrite) BOOL packed;
|
|
|
|
|
|
-/// The protocol buffer options.
|
|
|
+/** The protocol buffer options. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOption*> *optionsArray;
|
|
|
-/// The number of items in @c optionsArray without causing the array to be created.
|
|
|
+/** The number of items in @c optionsArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger optionsArray_Count;
|
|
|
|
|
|
-/// The field JSON name.
|
|
|
+/** The field JSON name. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *jsonName;
|
|
|
|
|
|
-/// The string value of the default value of this field. Proto2 syntax only.
|
|
|
+/** The string value of the default value of this field. Proto2 syntax only. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *defaultValue;
|
|
|
|
|
|
@end
|
|
|
|
|
|
-/// Fetches the raw value of a @c GPBField's @c kind property, even
|
|
|
-/// if the value was not defined by the enum at the time the code was generated.
|
|
|
+/**
|
|
|
+ * Fetches the raw value of a @c GPBField's @c kind property, even
|
|
|
+ * if the value was not defined by the enum at the time the code was generated.
|
|
|
+ **/
|
|
|
int32_t GPBField_Kind_RawValue(GPBField *message);
|
|
|
-/// Sets the raw value of an @c GPBField's @c kind property, allowing
|
|
|
-/// it to be set to a value that was not defined by the enum at the time the code
|
|
|
-/// was generated.
|
|
|
+/**
|
|
|
+ * Sets the raw value of an @c GPBField's @c kind property, allowing
|
|
|
+ * it to be set to a value that was not defined by the enum at the time the code
|
|
|
+ * was generated.
|
|
|
+ **/
|
|
|
void SetGPBField_Kind_RawValue(GPBField *message, int32_t value);
|
|
|
|
|
|
-/// Fetches the raw value of a @c GPBField's @c cardinality property, even
|
|
|
-/// if the value was not defined by the enum at the time the code was generated.
|
|
|
+/**
|
|
|
+ * Fetches the raw value of a @c GPBField's @c cardinality property, even
|
|
|
+ * if the value was not defined by the enum at the time the code was generated.
|
|
|
+ **/
|
|
|
int32_t GPBField_Cardinality_RawValue(GPBField *message);
|
|
|
-/// Sets the raw value of an @c GPBField's @c cardinality property, allowing
|
|
|
-/// it to be set to a value that was not defined by the enum at the time the code
|
|
|
-/// was generated.
|
|
|
+/**
|
|
|
+ * Sets the raw value of an @c GPBField's @c cardinality property, allowing
|
|
|
+ * it to be set to a value that was not defined by the enum at the time the code
|
|
|
+ * was generated.
|
|
|
+ **/
|
|
|
void SetGPBField_Cardinality_RawValue(GPBField *message, int32_t value);
|
|
|
|
|
|
#pragma mark - GPBEnum
|
|
@@ -295,38 +329,44 @@ typedef GPB_ENUM(GPBEnum_FieldNumber) {
|
|
|
GPBEnum_FieldNumber_Syntax = 5,
|
|
|
};
|
|
|
|
|
|
-/// Enum type definition.
|
|
|
+/**
|
|
|
+ * Enum type definition.
|
|
|
+ **/
|
|
|
@interface GPBEnum : GPBMessage
|
|
|
|
|
|
-/// Enum type name.
|
|
|
+/** Enum type name. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *name;
|
|
|
|
|
|
-/// Enum value definitions.
|
|
|
+/** Enum value definitions. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBEnumValue*> *enumvalueArray;
|
|
|
-/// The number of items in @c enumvalueArray without causing the array to be created.
|
|
|
+/** The number of items in @c enumvalueArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger enumvalueArray_Count;
|
|
|
|
|
|
-/// Protocol buffer options.
|
|
|
+/** Protocol buffer options. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOption*> *optionsArray;
|
|
|
-/// The number of items in @c optionsArray without causing the array to be created.
|
|
|
+/** The number of items in @c optionsArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger optionsArray_Count;
|
|
|
|
|
|
-/// The source context.
|
|
|
+/** The source context. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) GPBSourceContext *sourceContext;
|
|
|
-/// Test to see if @c sourceContext has been set.
|
|
|
+/** Test to see if @c sourceContext has been set. */
|
|
|
@property(nonatomic, readwrite) BOOL hasSourceContext;
|
|
|
|
|
|
-/// The source syntax.
|
|
|
+/** The source syntax. */
|
|
|
@property(nonatomic, readwrite) GPBSyntax syntax;
|
|
|
|
|
|
@end
|
|
|
|
|
|
-/// Fetches the raw value of a @c GPBEnum's @c syntax property, even
|
|
|
-/// if the value was not defined by the enum at the time the code was generated.
|
|
|
+/**
|
|
|
+ * Fetches the raw value of a @c GPBEnum's @c syntax property, even
|
|
|
+ * if the value was not defined by the enum at the time the code was generated.
|
|
|
+ **/
|
|
|
int32_t GPBEnum_Syntax_RawValue(GPBEnum *message);
|
|
|
-/// Sets the raw value of an @c GPBEnum's @c syntax property, allowing
|
|
|
-/// it to be set to a value that was not defined by the enum at the time the code
|
|
|
-/// was generated.
|
|
|
+/**
|
|
|
+ * Sets the raw value of an @c GPBEnum's @c syntax property, allowing
|
|
|
+ * it to be set to a value that was not defined by the enum at the time the code
|
|
|
+ * was generated.
|
|
|
+ **/
|
|
|
void SetGPBEnum_Syntax_RawValue(GPBEnum *message, int32_t value);
|
|
|
|
|
|
#pragma mark - GPBEnumValue
|
|
@@ -337,18 +377,20 @@ typedef GPB_ENUM(GPBEnumValue_FieldNumber) {
|
|
|
GPBEnumValue_FieldNumber_OptionsArray = 3,
|
|
|
};
|
|
|
|
|
|
-/// Enum value definition.
|
|
|
+/**
|
|
|
+ * Enum value definition.
|
|
|
+ **/
|
|
|
@interface GPBEnumValue : GPBMessage
|
|
|
|
|
|
-/// Enum value name.
|
|
|
+/** Enum value name. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *name;
|
|
|
|
|
|
-/// Enum value number.
|
|
|
+/** Enum value number. */
|
|
|
@property(nonatomic, readwrite) int32_t number;
|
|
|
|
|
|
-/// Protocol buffer options.
|
|
|
+/** Protocol buffer options. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOption*> *optionsArray;
|
|
|
-/// The number of items in @c optionsArray without causing the array to be created.
|
|
|
+/** The number of items in @c optionsArray without causing the array to be created. */
|
|
|
@property(nonatomic, readonly) NSUInteger optionsArray_Count;
|
|
|
|
|
|
@end
|
|
@@ -360,16 +402,18 @@ typedef GPB_ENUM(GPBOption_FieldNumber) {
|
|
|
GPBOption_FieldNumber_Value = 2,
|
|
|
};
|
|
|
|
|
|
-/// A protocol buffer option, which can be attached to a message, field,
|
|
|
-/// enumeration, etc.
|
|
|
+/**
|
|
|
+ * A protocol buffer option, which can be attached to a message, field,
|
|
|
+ * enumeration, etc.
|
|
|
+ **/
|
|
|
@interface GPBOption : GPBMessage
|
|
|
|
|
|
-/// The option's name. For example, `"java_package"`.
|
|
|
+/** The option's name. For example, `"java_package"`. */
|
|
|
@property(nonatomic, readwrite, copy, null_resettable) NSString *name;
|
|
|
|
|
|
-/// The option's value. For example, `"com.google.protobuf"`.
|
|
|
+/** The option's value. For example, `"com.google.protobuf"`. */
|
|
|
@property(nonatomic, readwrite, strong, null_resettable) GPBAny *value;
|
|
|
-/// Test to see if @c value has been set.
|
|
|
+/** Test to see if @c value has been set. */
|
|
|
@property(nonatomic, readwrite) BOOL hasValue;
|
|
|
|
|
|
@end
|