OLD | NEW |
1 // Protocol Buffers - Google's data interchange format | 1 // Protocol Buffers - Google's data interchange format |
2 // Copyright 2008 Google Inc. All rights reserved. | 2 // Copyright 2008 Google Inc. All rights reserved. |
3 // https://developers.google.com/protocol-buffers/ | 3 // https://developers.google.com/protocol-buffers/ |
4 // | 4 // |
5 // Redistribution and use in source and binary forms, with or without | 5 // Redistribution and use in source and binary forms, with or without |
6 // modification, are permitted provided that the following conditions are | 6 // modification, are permitted provided that the following conditions are |
7 // met: | 7 // met: |
8 // | 8 // |
9 // * Redistributions of source code must retain the above copyright | 9 // * Redistributions of source code must retain the above copyright |
10 // notice, this list of conditions and the following disclaimer. | 10 // notice, this list of conditions and the following disclaimer. |
(...skipping 20 matching lines...) Expand all Loading... |
31 #import <Foundation/Foundation.h> | 31 #import <Foundation/Foundation.h> |
32 | 32 |
33 #import "GPBArray.h" | 33 #import "GPBArray.h" |
34 #import "GPBMessage.h" | 34 #import "GPBMessage.h" |
35 #import "GPBRuntimeTypes.h" | 35 #import "GPBRuntimeTypes.h" |
36 | 36 |
37 CF_EXTERN_C_BEGIN | 37 CF_EXTERN_C_BEGIN |
38 | 38 |
39 NS_ASSUME_NONNULL_BEGIN | 39 NS_ASSUME_NONNULL_BEGIN |
40 | 40 |
41 /** | 41 /// Generates a string that should be a valid "Text Format" for the C++ version |
42 * Generates a string that should be a valid "TextFormat" for the C++ version | 42 /// of Protocol Buffers. |
43 * of Protocol Buffers. | 43 /// |
44 * | 44 /// @param message The message to generate from. |
45 * @param message The message to generate from. | 45 /// @param lineIndent A string to use as the prefix for all lines generated. Ca
n |
46 * @param lineIndent A string to use as the prefix for all lines generated. Can | 46 /// be nil if no extra indent is needed. |
47 * be nil if no extra indent is needed. | 47 /// |
48 * | 48 /// @return A @c NSString with the Text Format of the message. |
49 * @return An NSString with the TextFormat of the message. | |
50 **/ | |
51 NSString *GPBTextFormatForMessage(GPBMessage *message, | 49 NSString *GPBTextFormatForMessage(GPBMessage *message, |
52 NSString * __nullable lineIndent); | 50 NSString * __nullable lineIndent); |
53 | 51 |
54 /** | 52 /// Generates a string that should be a valid "Text Format" for the C++ version |
55 * Generates a string that should be a valid "TextFormat" for the C++ version | 53 /// of Protocol Buffers. |
56 * of Protocol Buffers. | 54 /// |
57 * | 55 /// @param unknownSet The unknown field set to generate from. |
58 * @param unknownSet The unknown field set to generate from. | 56 /// @param lineIndent A string to use as the prefix for all lines generated. Ca
n |
59 * @param lineIndent A string to use as the prefix for all lines generated. Can | 57 /// be nil if no extra indent is needed. |
60 * be nil if no extra indent is needed. | 58 /// |
61 * | 59 /// @return A @c NSString with the Text Format of the unknown field set. |
62 * @return An NSString with the TextFormat of the unknown field set. | |
63 **/ | |
64 NSString *GPBTextFormatForUnknownFieldSet(GPBUnknownFieldSet * __nullable unknow
nSet, | 60 NSString *GPBTextFormatForUnknownFieldSet(GPBUnknownFieldSet * __nullable unknow
nSet, |
65 NSString * __nullable lineIndent); | 61 NSString * __nullable lineIndent); |
66 | 62 |
67 /** | 63 /// Test if the given field is set on a message. |
68 * Checks if the given field number is set on a message. | |
69 * | |
70 * @param self The message to check. | |
71 * @param fieldNumber The field number to check. | |
72 * | |
73 * @return YES if the field number is set on the given message. | |
74 **/ | |
75 BOOL GPBMessageHasFieldNumberSet(GPBMessage *self, uint32_t fieldNumber); | 64 BOOL GPBMessageHasFieldNumberSet(GPBMessage *self, uint32_t fieldNumber); |
76 | 65 /// Test if the given field is set on a message. |
77 /** | |
78 * Checks if the given field is set on a message. | |
79 * | |
80 * @param self The message to check. | |
81 * @param field The field to check. | |
82 * | |
83 * @return YES if the field is set on the given message. | |
84 **/ | |
85 BOOL GPBMessageHasFieldSet(GPBMessage *self, GPBFieldDescriptor *field); | 66 BOOL GPBMessageHasFieldSet(GPBMessage *self, GPBFieldDescriptor *field); |
86 | 67 |
87 /** | 68 /// Clear the given field of a message. |
88 * Clears the given field for the given message. | |
89 * | |
90 * @param self The message for which to clear the field. | |
91 * @param field The field to clear. | |
92 **/ | |
93 void GPBClearMessageField(GPBMessage *self, GPBFieldDescriptor *field); | 69 void GPBClearMessageField(GPBMessage *self, GPBFieldDescriptor *field); |
94 | 70 |
95 //%PDDM-EXPAND GPB_ACCESSORS() | 71 //%PDDM-EXPAND GPB_ACCESSORS() |
96 // This block of code is generated, do not edit it directly. | 72 // This block of code is generated, do not edit it directly. |
97 | 73 |
98 | 74 |
99 // | 75 // |
100 // Get/Set a given field from/to a message. | 76 // Get/Set the given field of a message. |
101 // | 77 // |
102 | 78 |
103 // Single Fields | 79 // Single Fields |
104 | 80 |
105 /** | 81 /// Gets the value of a bytes field. |
106 * Gets the value of a bytes field. | |
107 * | |
108 * @param self The message from which to get the field. | |
109 * @param field The field to get. | |
110 **/ | |
111 NSData *GPBGetMessageBytesField(GPBMessage *self, GPBFieldDescriptor *field); | 82 NSData *GPBGetMessageBytesField(GPBMessage *self, GPBFieldDescriptor *field); |
112 | 83 /// Sets the value of a bytes field. |
113 /** | |
114 * Sets the value of a bytes field. | |
115 * | |
116 * @param self The message into which to set the field. | |
117 * @param field The field to set. | |
118 * @param value The to set in the field. | |
119 **/ | |
120 void GPBSetMessageBytesField(GPBMessage *self, GPBFieldDescriptor *field, NSData
*value); | 84 void GPBSetMessageBytesField(GPBMessage *self, GPBFieldDescriptor *field, NSData
*value); |
121 | 85 |
122 /** | 86 /// Gets the value of a string field. |
123 * Gets the value of a string field. | |
124 * | |
125 * @param self The message from which to get the field. | |
126 * @param field The field to get. | |
127 **/ | |
128 NSString *GPBGetMessageStringField(GPBMessage *self, GPBFieldDescriptor *field); | 87 NSString *GPBGetMessageStringField(GPBMessage *self, GPBFieldDescriptor *field); |
129 | 88 /// Sets the value of a string field. |
130 /** | |
131 * Sets the value of a string field. | |
132 * | |
133 * @param self The message into which to set the field. | |
134 * @param field The field to set. | |
135 * @param value The to set in the field. | |
136 **/ | |
137 void GPBSetMessageStringField(GPBMessage *self, GPBFieldDescriptor *field, NSStr
ing *value); | 89 void GPBSetMessageStringField(GPBMessage *self, GPBFieldDescriptor *field, NSStr
ing *value); |
138 | 90 |
139 /** | 91 /// Gets the value of a message field. |
140 * Gets the value of a message field. | |
141 * | |
142 * @param self The message from which to get the field. | |
143 * @param field The field to get. | |
144 **/ | |
145 GPBMessage *GPBGetMessageMessageField(GPBMessage *self, GPBFieldDescriptor *fiel
d); | 92 GPBMessage *GPBGetMessageMessageField(GPBMessage *self, GPBFieldDescriptor *fiel
d); |
146 | 93 /// Sets the value of a message field. |
147 /** | |
148 * Sets the value of a message field. | |
149 * | |
150 * @param self The message into which to set the field. | |
151 * @param field The field to set. | |
152 * @param value The to set in the field. | |
153 **/ | |
154 void GPBSetMessageMessageField(GPBMessage *self, GPBFieldDescriptor *field, GPBM
essage *value); | 94 void GPBSetMessageMessageField(GPBMessage *self, GPBFieldDescriptor *field, GPBM
essage *value); |
155 | 95 |
156 /** | 96 /// Gets the value of a group field. |
157 * Gets the value of a group field. | |
158 * | |
159 * @param self The message from which to get the field. | |
160 * @param field The field to get. | |
161 **/ | |
162 GPBMessage *GPBGetMessageGroupField(GPBMessage *self, GPBFieldDescriptor *field)
; | 97 GPBMessage *GPBGetMessageGroupField(GPBMessage *self, GPBFieldDescriptor *field)
; |
163 | 98 /// Sets the value of a group field. |
164 /** | |
165 * Sets the value of a group field. | |
166 * | |
167 * @param self The message into which to set the field. | |
168 * @param field The field to set. | |
169 * @param value The to set in the field. | |
170 **/ | |
171 void GPBSetMessageGroupField(GPBMessage *self, GPBFieldDescriptor *field, GPBMes
sage *value); | 99 void GPBSetMessageGroupField(GPBMessage *self, GPBFieldDescriptor *field, GPBMes
sage *value); |
172 | 100 |
173 /** | 101 /// Gets the value of a bool field. |
174 * Gets the value of a bool field. | |
175 * | |
176 * @param self The message from which to get the field. | |
177 * @param field The field to get. | |
178 **/ | |
179 BOOL GPBGetMessageBoolField(GPBMessage *self, GPBFieldDescriptor *field); | 102 BOOL GPBGetMessageBoolField(GPBMessage *self, GPBFieldDescriptor *field); |
180 | 103 /// Sets the value of a bool field. |
181 /** | |
182 * Sets the value of a bool field. | |
183 * | |
184 * @param self The message into which to set the field. | |
185 * @param field The field to set. | |
186 * @param value The to set in the field. | |
187 **/ | |
188 void GPBSetMessageBoolField(GPBMessage *self, GPBFieldDescriptor *field, BOOL va
lue); | 104 void GPBSetMessageBoolField(GPBMessage *self, GPBFieldDescriptor *field, BOOL va
lue); |
189 | 105 |
190 /** | 106 /// Gets the value of an int32 field. |
191 * Gets the value of an int32 field. | |
192 * | |
193 * @param self The message from which to get the field. | |
194 * @param field The field to get. | |
195 **/ | |
196 int32_t GPBGetMessageInt32Field(GPBMessage *self, GPBFieldDescriptor *field); | 107 int32_t GPBGetMessageInt32Field(GPBMessage *self, GPBFieldDescriptor *field); |
197 | 108 /// Sets the value of an int32 field. |
198 /** | |
199 * Sets the value of an int32 field. | |
200 * | |
201 * @param self The message into which to set the field. | |
202 * @param field The field to set. | |
203 * @param value The to set in the field. | |
204 **/ | |
205 void GPBSetMessageInt32Field(GPBMessage *self, GPBFieldDescriptor *field, int32_
t value); | 109 void GPBSetMessageInt32Field(GPBMessage *self, GPBFieldDescriptor *field, int32_
t value); |
206 | 110 |
207 /** | 111 /// Gets the value of an uint32 field. |
208 * Gets the value of an uint32 field. | |
209 * | |
210 * @param self The message from which to get the field. | |
211 * @param field The field to get. | |
212 **/ | |
213 uint32_t GPBGetMessageUInt32Field(GPBMessage *self, GPBFieldDescriptor *field); | 112 uint32_t GPBGetMessageUInt32Field(GPBMessage *self, GPBFieldDescriptor *field); |
214 | 113 /// Sets the value of an uint32 field. |
215 /** | |
216 * Sets the value of an uint32 field. | |
217 * | |
218 * @param self The message into which to set the field. | |
219 * @param field The field to set. | |
220 * @param value The to set in the field. | |
221 **/ | |
222 void GPBSetMessageUInt32Field(GPBMessage *self, GPBFieldDescriptor *field, uint3
2_t value); | 114 void GPBSetMessageUInt32Field(GPBMessage *self, GPBFieldDescriptor *field, uint3
2_t value); |
223 | 115 |
224 /** | 116 /// Gets the value of an int64 field. |
225 * Gets the value of an int64 field. | |
226 * | |
227 * @param self The message from which to get the field. | |
228 * @param field The field to get. | |
229 **/ | |
230 int64_t GPBGetMessageInt64Field(GPBMessage *self, GPBFieldDescriptor *field); | 117 int64_t GPBGetMessageInt64Field(GPBMessage *self, GPBFieldDescriptor *field); |
231 | 118 /// Sets the value of an int64 field. |
232 /** | |
233 * Sets the value of an int64 field. | |
234 * | |
235 * @param self The message into which to set the field. | |
236 * @param field The field to set. | |
237 * @param value The to set in the field. | |
238 **/ | |
239 void GPBSetMessageInt64Field(GPBMessage *self, GPBFieldDescriptor *field, int64_
t value); | 119 void GPBSetMessageInt64Field(GPBMessage *self, GPBFieldDescriptor *field, int64_
t value); |
240 | 120 |
241 /** | 121 /// Gets the value of an uint64 field. |
242 * Gets the value of an uint64 field. | |
243 * | |
244 * @param self The message from which to get the field. | |
245 * @param field The field to get. | |
246 **/ | |
247 uint64_t GPBGetMessageUInt64Field(GPBMessage *self, GPBFieldDescriptor *field); | 122 uint64_t GPBGetMessageUInt64Field(GPBMessage *self, GPBFieldDescriptor *field); |
248 | 123 /// Sets the value of an uint64 field. |
249 /** | |
250 * Sets the value of an uint64 field. | |
251 * | |
252 * @param self The message into which to set the field. | |
253 * @param field The field to set. | |
254 * @param value The to set in the field. | |
255 **/ | |
256 void GPBSetMessageUInt64Field(GPBMessage *self, GPBFieldDescriptor *field, uint6
4_t value); | 124 void GPBSetMessageUInt64Field(GPBMessage *self, GPBFieldDescriptor *field, uint6
4_t value); |
257 | 125 |
258 /** | 126 /// Gets the value of a float field. |
259 * Gets the value of a float field. | |
260 * | |
261 * @param self The message from which to get the field. | |
262 * @param field The field to get. | |
263 **/ | |
264 float GPBGetMessageFloatField(GPBMessage *self, GPBFieldDescriptor *field); | 127 float GPBGetMessageFloatField(GPBMessage *self, GPBFieldDescriptor *field); |
265 | 128 /// Sets the value of a float field. |
266 /** | |
267 * Sets the value of a float field. | |
268 * | |
269 * @param self The message into which to set the field. | |
270 * @param field The field to set. | |
271 * @param value The to set in the field. | |
272 **/ | |
273 void GPBSetMessageFloatField(GPBMessage *self, GPBFieldDescriptor *field, float
value); | 129 void GPBSetMessageFloatField(GPBMessage *self, GPBFieldDescriptor *field, float
value); |
274 | 130 |
275 /** | 131 /// Gets the value of a double field. |
276 * Gets the value of a double field. | |
277 * | |
278 * @param self The message from which to get the field. | |
279 * @param field The field to get. | |
280 **/ | |
281 double GPBGetMessageDoubleField(GPBMessage *self, GPBFieldDescriptor *field); | 132 double GPBGetMessageDoubleField(GPBMessage *self, GPBFieldDescriptor *field); |
282 | 133 /// Sets the value of a double field. |
283 /** | |
284 * Sets the value of a double field. | |
285 * | |
286 * @param self The message into which to set the field. | |
287 * @param field The field to set. | |
288 * @param value The to set in the field. | |
289 **/ | |
290 void GPBSetMessageDoubleField(GPBMessage *self, GPBFieldDescriptor *field, doubl
e value); | 134 void GPBSetMessageDoubleField(GPBMessage *self, GPBFieldDescriptor *field, doubl
e value); |
291 | 135 |
292 /** | 136 /// Get the given enum field of a message. For proto3, if the value isn't a |
293 * Gets the given enum field of a message. For proto3, if the value isn't a | 137 /// member of the enum, @c kGPBUnrecognizedEnumeratorValue will be returned. |
294 * member of the enum, @c kGPBUnrecognizedEnumeratorValue will be returned. | 138 /// GPBGetMessageRawEnumField will bypass the check and return whatever value |
295 * GPBGetMessageRawEnumField will bypass the check and return whatever value | 139 /// was set. |
296 * was set. | |
297 * | |
298 * @param self The message from which to get the field. | |
299 * @param field The field to get. | |
300 * | |
301 * @return The enum value for the given field. | |
302 **/ | |
303 int32_t GPBGetMessageEnumField(GPBMessage *self, GPBFieldDescriptor *field); | 140 int32_t GPBGetMessageEnumField(GPBMessage *self, GPBFieldDescriptor *field); |
304 | 141 /// Set the given enum field of a message. You can only set values that are |
305 /** | 142 /// members of the enum. |
306 * Set the given enum field of a message. You can only set values that are | 143 void GPBSetMessageEnumField(GPBMessage *self, GPBFieldDescriptor *field, int32_t
value); |
307 * members of the enum. | 144 /// Get the given enum field of a message. No check is done to ensure the value |
308 * | 145 /// was defined in the enum. |
309 * @param self The message into which to set the field. | |
310 * @param field The field to set. | |
311 * @param value The enum value to set in the field. | |
312 **/ | |
313 void GPBSetMessageEnumField(GPBMessage *self, | |
314 GPBFieldDescriptor *field, | |
315 int32_t value); | |
316 | |
317 /** | |
318 * Get the given enum field of a message. No check is done to ensure the value | |
319 * was defined in the enum. | |
320 * | |
321 * @param self The message from which to get the field. | |
322 * @param field The field to get. | |
323 * | |
324 * @return The raw enum value for the given field. | |
325 **/ | |
326 int32_t GPBGetMessageRawEnumField(GPBMessage *self, GPBFieldDescriptor *field); | 146 int32_t GPBGetMessageRawEnumField(GPBMessage *self, GPBFieldDescriptor *field); |
327 | 147 /// Set the given enum field of a message. You can set the value to anything, |
328 /** | 148 /// even a value that is not a member of the enum. |
329 * Set the given enum field of a message. You can set the value to anything, | 149 void GPBSetMessageRawEnumField(GPBMessage *self, GPBFieldDescriptor *field, int3
2_t value); |
330 * even a value that is not a member of the enum. | |
331 * | |
332 * @param self The message into which to set the field. | |
333 * @param field The field to set. | |
334 * @param value The raw enum value to set in the field. | |
335 **/ | |
336 void GPBSetMessageRawEnumField(GPBMessage *self, | |
337 GPBFieldDescriptor *field, | |
338 int32_t value); | |
339 | 150 |
340 // Repeated Fields | 151 // Repeated Fields |
341 | 152 |
342 /** | 153 /// Gets the value of a repeated field. |
343 * Gets the value of a repeated field. | 154 /// |
344 * | 155 /// The result will be @c GPB*Array or @c NSMutableArray based on the |
345 * @param self The message from which to get the field. | 156 /// field's type. |
346 * @param field The repeated field to get. | |
347 * | |
348 * @return A GPB*Array or an NSMutableArray based on the field's type. | |
349 **/ | |
350 id GPBGetMessageRepeatedField(GPBMessage *self, GPBFieldDescriptor *field); | 157 id GPBGetMessageRepeatedField(GPBMessage *self, GPBFieldDescriptor *field); |
351 | 158 /// Sets the value of a repeated field. |
352 /** | 159 /// |
353 * Sets the value of a repeated field. | 160 /// The value should be @c GPB*Array or @c NSMutableArray based on the |
354 * | 161 /// field's type. |
355 * @param self The message into which to set the field. | 162 void GPBSetMessageRepeatedField(GPBMessage *self, GPBFieldDescriptor *field, id
array); |
356 * @param field The field to set. | |
357 * @param array A GPB*Array or NSMutableArray based on the field's type. | |
358 **/ | |
359 void GPBSetMessageRepeatedField(GPBMessage *self, | |
360 GPBFieldDescriptor *field, | |
361 id array); | |
362 | 163 |
363 // Map Fields | 164 // Map Fields |
364 | 165 |
365 /** | 166 /// Gets the value of a map<> field. |
366 * Gets the value of a map<> field. | 167 /// |
367 * | 168 /// The result will be @c GPB*Dictionary or @c NSMutableDictionary based on |
368 * @param self The message from which to get the field. | 169 /// the field's type. |
369 * @param field The repeated field to get. | |
370 * | |
371 * @return A GPB*Dictionary or NSMutableDictionary based on the field's type. | |
372 **/ | |
373 id GPBGetMessageMapField(GPBMessage *self, GPBFieldDescriptor *field); | 170 id GPBGetMessageMapField(GPBMessage *self, GPBFieldDescriptor *field); |
374 | 171 /// Sets the value of a map<> field. |
375 /** | 172 /// |
376 * Sets the value of a map<> field. | 173 /// The object should be @c GPB*Dictionary or @c NSMutableDictionary based |
377 * | 174 /// on the field's type. |
378 * @param self The message into which to set the field. | 175 void GPBSetMessageMapField(GPBMessage *self, GPBFieldDescriptor *field, id dicti
onary); |
379 * @param field The field to set. | |
380 * @param dictionary A GPB*Dictionary or NSMutableDictionary based on the | |
381 * field's type. | |
382 **/ | |
383 void GPBSetMessageMapField(GPBMessage *self, | |
384 GPBFieldDescriptor *field, | |
385 id dictionary); | |
386 | 176 |
387 //%PDDM-EXPAND-END GPB_ACCESSORS() | 177 //%PDDM-EXPAND-END GPB_ACCESSORS() |
388 | 178 |
389 /** | 179 // Returns an empty NSData to assign to byte fields when you wish |
390 * Returns an empty NSData to assign to byte fields when you wish to assign them | 180 // to assign them to empty. Prevents allocating a lot of little [NSData data] |
391 * to empty. Prevents allocating a lot of little [NSData data] objects. | 181 // objects. |
392 **/ | |
393 NSData *GPBEmptyNSData(void) __attribute__((pure)); | 182 NSData *GPBEmptyNSData(void) __attribute__((pure)); |
394 | 183 |
395 NS_ASSUME_NONNULL_END | 184 NS_ASSUME_NONNULL_END |
396 | 185 |
397 CF_EXTERN_C_END | 186 CF_EXTERN_C_END |
398 | 187 |
399 | 188 |
400 //%PDDM-DEFINE GPB_ACCESSORS() | 189 //%PDDM-DEFINE GPB_ACCESSORS() |
401 //% | 190 //% |
402 //%// | 191 //%// |
403 //%// Get/Set a given field from/to a message. | 192 //%// Get/Set the given field of a message. |
404 //%// | 193 //%// |
405 //% | 194 //% |
406 //%// Single Fields | 195 //%// Single Fields |
407 //% | 196 //% |
408 //%GPB_ACCESSOR_SINGLE_FULL(Bytes, NSData, , *) | 197 //%GPB_ACCESSOR_SINGLE_FULL(Bytes, NSData, , *) |
409 //%GPB_ACCESSOR_SINGLE_FULL(String, NSString, , *) | 198 //%GPB_ACCESSOR_SINGLE_FULL(String, NSString, , *) |
410 //%GPB_ACCESSOR_SINGLE_FULL(Message, GPBMessage, , *) | 199 //%GPB_ACCESSOR_SINGLE_FULL(Message, GPBMessage, , *) |
411 //%GPB_ACCESSOR_SINGLE_FULL(Group, GPBMessage, , *) | 200 //%GPB_ACCESSOR_SINGLE_FULL(Group, GPBMessage, , *) |
412 //%GPB_ACCESSOR_SINGLE(Bool, BOOL, ) | 201 //%GPB_ACCESSOR_SINGLE(Bool, BOOL, ) |
413 //%GPB_ACCESSOR_SINGLE(Int32, int32_t, n) | 202 //%GPB_ACCESSOR_SINGLE(Int32, int32_t, n) |
414 //%GPB_ACCESSOR_SINGLE(UInt32, uint32_t, n) | 203 //%GPB_ACCESSOR_SINGLE(UInt32, uint32_t, n) |
415 //%GPB_ACCESSOR_SINGLE(Int64, int64_t, n) | 204 //%GPB_ACCESSOR_SINGLE(Int64, int64_t, n) |
416 //%GPB_ACCESSOR_SINGLE(UInt64, uint64_t, n) | 205 //%GPB_ACCESSOR_SINGLE(UInt64, uint64_t, n) |
417 //%GPB_ACCESSOR_SINGLE(Float, float, ) | 206 //%GPB_ACCESSOR_SINGLE(Float, float, ) |
418 //%GPB_ACCESSOR_SINGLE(Double, double, ) | 207 //%GPB_ACCESSOR_SINGLE(Double, double, ) |
419 //%/** | 208 //%/// Get the given enum field of a message. For proto3, if the value isn't a |
420 //% * Gets the given enum field of a message. For proto3, if the value isn't a | 209 //%/// member of the enum, @c kGPBUnrecognizedEnumeratorValue will be returned. |
421 //% * member of the enum, @c kGPBUnrecognizedEnumeratorValue will be returned. | 210 //%/// GPBGetMessageRawEnumField will bypass the check and return whatever value |
422 //% * GPBGetMessageRawEnumField will bypass the check and return whatever value | 211 //%/// was set. |
423 //% * was set. | |
424 //% * | |
425 //% * @param self The message from which to get the field. | |
426 //% * @param field The field to get. | |
427 //% * | |
428 //% * @return The enum value for the given field. | |
429 //% **/ | |
430 //%int32_t GPBGetMessageEnumField(GPBMessage *self, GPBFieldDescriptor *field); | 212 //%int32_t GPBGetMessageEnumField(GPBMessage *self, GPBFieldDescriptor *field); |
431 //% | 213 //%/// Set the given enum field of a message. You can only set values that are |
432 //%/** | 214 //%/// members of the enum. |
433 //% * Set the given enum field of a message. You can only set values that are | 215 //%void GPBSetMessageEnumField(GPBMessage *self, GPBFieldDescriptor *field, int3
2_t value); |
434 //% * members of the enum. | 216 //%/// Get the given enum field of a message. No check is done to ensure the val
ue |
435 //% * | 217 //%/// was defined in the enum. |
436 //% * @param self The message into which to set the field. | |
437 //% * @param field The field to set. | |
438 //% * @param value The enum value to set in the field. | |
439 //% **/ | |
440 //%void GPBSetMessageEnumField(GPBMessage *self, | |
441 //% GPBFieldDescriptor *field, | |
442 //% int32_t value); | |
443 //% | |
444 //%/** | |
445 //% * Get the given enum field of a message. No check is done to ensure the valu
e | |
446 //% * was defined in the enum. | |
447 //% * | |
448 //% * @param self The message from which to get the field. | |
449 //% * @param field The field to get. | |
450 //% * | |
451 //% * @return The raw enum value for the given field. | |
452 //% **/ | |
453 //%int32_t GPBGetMessageRawEnumField(GPBMessage *self, GPBFieldDescriptor *field
); | 218 //%int32_t GPBGetMessageRawEnumField(GPBMessage *self, GPBFieldDescriptor *field
); |
454 //% | 219 //%/// Set the given enum field of a message. You can set the value to anything, |
455 //%/** | 220 //%/// even a value that is not a member of the enum. |
456 //% * Set the given enum field of a message. You can set the value to anything, | 221 //%void GPBSetMessageRawEnumField(GPBMessage *self, GPBFieldDescriptor *field, i
nt32_t value); |
457 //% * even a value that is not a member of the enum. | |
458 //% * | |
459 //% * @param self The message into which to set the field. | |
460 //% * @param field The field to set. | |
461 //% * @param value The raw enum value to set in the field. | |
462 //% **/ | |
463 //%void GPBSetMessageRawEnumField(GPBMessage *self, | |
464 //% GPBFieldDescriptor *field, | |
465 //% int32_t value); | |
466 //% | 222 //% |
467 //%// Repeated Fields | 223 //%// Repeated Fields |
468 //% | 224 //% |
469 //%/** | 225 //%/// Gets the value of a repeated field. |
470 //% * Gets the value of a repeated field. | 226 //%/// |
471 //% * | 227 //%/// The result will be @c GPB*Array or @c NSMutableArray based on the |
472 //% * @param self The message from which to get the field. | 228 //%/// field's type. |
473 //% * @param field The repeated field to get. | |
474 //% * | |
475 //% * @return A GPB*Array or an NSMutableArray based on the field's type. | |
476 //% **/ | |
477 //%id GPBGetMessageRepeatedField(GPBMessage *self, GPBFieldDescriptor *field); | 229 //%id GPBGetMessageRepeatedField(GPBMessage *self, GPBFieldDescriptor *field); |
478 //% | 230 //%/// Sets the value of a repeated field. |
479 //%/** | 231 //%/// |
480 //% * Sets the value of a repeated field. | 232 //%/// The value should be @c GPB*Array or @c NSMutableArray based on the |
481 //% * | 233 //%/// field's type. |
482 //% * @param self The message into which to set the field. | 234 //%void GPBSetMessageRepeatedField(GPBMessage *self, GPBFieldDescriptor *field,
id array); |
483 //% * @param field The field to set. | |
484 //% * @param array A GPB*Array or NSMutableArray based on the field's type. | |
485 //% **/ | |
486 //%void GPBSetMessageRepeatedField(GPBMessage *self, | |
487 //% GPBFieldDescriptor *field, | |
488 //% id array); | |
489 //% | 235 //% |
490 //%// Map Fields | 236 //%// Map Fields |
491 //% | 237 //% |
492 //%/** | 238 //%/// Gets the value of a map<> field. |
493 //% * Gets the value of a map<> field. | 239 //%/// |
494 //% * | 240 //%/// The result will be @c GPB*Dictionary or @c NSMutableDictionary based on |
495 //% * @param self The message from which to get the field. | 241 //%/// the field's type. |
496 //% * @param field The repeated field to get. | |
497 //% * | |
498 //% * @return A GPB*Dictionary or NSMutableDictionary based on the field's type. | |
499 //% **/ | |
500 //%id GPBGetMessageMapField(GPBMessage *self, GPBFieldDescriptor *field); | 242 //%id GPBGetMessageMapField(GPBMessage *self, GPBFieldDescriptor *field); |
501 //% | 243 //%/// Sets the value of a map<> field. |
502 //%/** | 244 //%/// |
503 //% * Sets the value of a map<> field. | 245 //%/// The object should be @c GPB*Dictionary or @c NSMutableDictionary based |
504 //% * | 246 //%/// on the field's type. |
505 //% * @param self The message into which to set the field. | 247 //%void GPBSetMessageMapField(GPBMessage *self, GPBFieldDescriptor *field, id di
ctionary); |
506 //% * @param field The field to set. | |
507 //% * @param dictionary A GPB*Dictionary or NSMutableDictionary based on the | |
508 //% * field's type. | |
509 //% **/ | |
510 //%void GPBSetMessageMapField(GPBMessage *self, | |
511 //% GPBFieldDescriptor *field, | |
512 //% id dictionary); | |
513 //% | 248 //% |
514 | 249 |
515 //%PDDM-DEFINE GPB_ACCESSOR_SINGLE(NAME, TYPE, AN) | 250 //%PDDM-DEFINE GPB_ACCESSOR_SINGLE(NAME, TYPE, AN) |
516 //%GPB_ACCESSOR_SINGLE_FULL(NAME, TYPE, AN, ) | 251 //%GPB_ACCESSOR_SINGLE_FULL(NAME, TYPE, AN, ) |
517 //%PDDM-DEFINE GPB_ACCESSOR_SINGLE_FULL(NAME, TYPE, AN, TisP) | 252 //%PDDM-DEFINE GPB_ACCESSOR_SINGLE_FULL(NAME, TYPE, AN, TisP) |
518 //%/** | 253 //%/// Gets the value of a##AN NAME$L field. |
519 //% * Gets the value of a##AN NAME$L field. | |
520 //% * | |
521 //% * @param self The message from which to get the field. | |
522 //% * @param field The field to get. | |
523 //% **/ | |
524 //%TYPE TisP##GPBGetMessage##NAME##Field(GPBMessage *self, GPBFieldDescriptor *f
ield); | 254 //%TYPE TisP##GPBGetMessage##NAME##Field(GPBMessage *self, GPBFieldDescriptor *f
ield); |
525 //% | 255 //%/// Sets the value of a##AN NAME$L field. |
526 //%/** | |
527 //% * Sets the value of a##AN NAME$L field. | |
528 //% * | |
529 //% * @param self The message into which to set the field. | |
530 //% * @param field The field to set. | |
531 //% * @param value The to set in the field. | |
532 //% **/ | |
533 //%void GPBSetMessage##NAME##Field(GPBMessage *self, GPBFieldDescriptor *field,
TYPE TisP##value); | 256 //%void GPBSetMessage##NAME##Field(GPBMessage *self, GPBFieldDescriptor *field,
TYPE TisP##value); |
534 //% | 257 //% |
OLD | NEW |