GPBArray.h 58.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
// Protocol Buffers - Google's data interchange format
// Copyright 2015 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#import <Foundation/Foundation.h>

33
#import "GPBRuntimeTypes.h"
34

35 36
NS_ASSUME_NONNULL_BEGIN

37 38 39 40 41
//%PDDM-EXPAND DECLARE_ARRAYS()
// This block of code is generated, do not edit it directly.

#pragma mark - Int32

42 43 44 45 46 47
/**
 * Class used for repeated fields of int32_t values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
48 49
@interface GPBInt32Array : NSObject <NSCopying>

50
/** The number of elements contained in the array. */
51 52
@property(nonatomic, readonly) NSUInteger count;

53 54 55
/**
 * @return A newly instanced and empty GPBInt32Array.
 **/
56
+ (instancetype)array;
57 58 59 60 61 62 63 64

/**
 * Creates and initializes a GPBInt32Array with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBInt32Array with value in it.
 **/
65
+ (instancetype)arrayWithValue:(int32_t)value;
66 67 68 69 70 71 72 73 74

/**
 * Creates and initializes a GPBInt32Array with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBInt32Array with the contents of array.
 **/
75
+ (instancetype)arrayWithValueArray:(GPBInt32Array *)array;
76 77 78 79 80 81 82 83

/**
 * Creates and initializes a GPBInt32Array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBInt32Array with a capacity of count.
 **/
84 85
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

86 87 88
/**
 * @return A newly initialized and empty GPBInt32Array.
 **/
89
- (instancetype)init NS_DESIGNATED_INITIALIZER;
90 91 92 93 94 95 96 97 98

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBInt32Array with a copy of the values.
 **/
99
- (instancetype)initWithValues:(const int32_t [__nullable])values
100
                         count:(NSUInteger)count;
101 102 103 104 105 106 107 108

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBInt32Array with a copy of the values.
 **/
109
- (instancetype)initWithValueArray:(GPBInt32Array *)array;
110 111 112 113 114 115 116 117

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBInt32Array with a capacity of count.
 **/
118 119
- (instancetype)initWithCapacity:(NSUInteger)count;

120 121 122 123 124 125 126
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
127 128
- (int32_t)valueAtIndex:(NSUInteger)index;

129 130 131 132 133 134 135 136
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
137
- (void)enumerateValuesWithBlock:(void (^)(int32_t value, NSUInteger idx, BOOL *stop))block;
138 139 140 141 142 143 144 145 146 147

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
148 149 150
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(int32_t value, NSUInteger idx, BOOL *stop))block;

151 152 153 154 155
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
156
- (void)addValue:(int32_t)value;
157 158 159 160 161 162 163

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
164
- (void)addValues:(const int32_t [__nullable])values count:(NSUInteger)count;
165 166 167 168 169 170

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
171 172
- (void)addValuesFromArray:(GPBInt32Array *)array;

173 174 175 176 177 178
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
179 180
- (void)insertValue:(int32_t)value atIndex:(NSUInteger)index;

181 182 183 184 185 186
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
187 188
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(int32_t)value;

189 190 191 192 193
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
194
- (void)removeValueAtIndex:(NSUInteger)index;
195 196 197 198

/**
 * Removes all the values from this array.
 **/
199 200
- (void)removeAll;

201 202 203 204 205 206
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
207 208 209 210 211 212 213
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - UInt32

214 215 216 217 218 219
/**
 * Class used for repeated fields of uint32_t values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
220 221
@interface GPBUInt32Array : NSObject <NSCopying>

222
/** The number of elements contained in the array. */
223 224
@property(nonatomic, readonly) NSUInteger count;

225 226 227
/**
 * @return A newly instanced and empty GPBUInt32Array.
 **/
228
+ (instancetype)array;
229 230 231 232 233 234 235 236

/**
 * Creates and initializes a GPBUInt32Array with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBUInt32Array with value in it.
 **/
237
+ (instancetype)arrayWithValue:(uint32_t)value;
238 239 240 241 242 243 244 245 246

/**
 * Creates and initializes a GPBUInt32Array with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBUInt32Array with the contents of array.
 **/
247
+ (instancetype)arrayWithValueArray:(GPBUInt32Array *)array;
248 249 250 251 252 253 254 255

/**
 * Creates and initializes a GPBUInt32Array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBUInt32Array with a capacity of count.
 **/
256 257
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

258 259 260
/**
 * @return A newly initialized and empty GPBUInt32Array.
 **/
261
- (instancetype)init NS_DESIGNATED_INITIALIZER;
262 263 264 265 266 267 268 269 270

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBUInt32Array with a copy of the values.
 **/
271
- (instancetype)initWithValues:(const uint32_t [__nullable])values
272
                         count:(NSUInteger)count;
273 274 275 276 277 278 279 280

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBUInt32Array with a copy of the values.
 **/
281
- (instancetype)initWithValueArray:(GPBUInt32Array *)array;
282 283 284 285 286 287 288 289

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBUInt32Array with a capacity of count.
 **/
290 291
- (instancetype)initWithCapacity:(NSUInteger)count;

292 293 294 295 296 297 298
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
299 300
- (uint32_t)valueAtIndex:(NSUInteger)index;

301 302 303 304 305 306 307 308
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
309
- (void)enumerateValuesWithBlock:(void (^)(uint32_t value, NSUInteger idx, BOOL *stop))block;
310 311 312 313 314 315 316 317 318 319

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
320 321 322
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(uint32_t value, NSUInteger idx, BOOL *stop))block;

323 324 325 326 327
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
328
- (void)addValue:(uint32_t)value;
329 330 331 332 333 334 335

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
336
- (void)addValues:(const uint32_t [__nullable])values count:(NSUInteger)count;
337 338 339 340 341 342

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
343 344
- (void)addValuesFromArray:(GPBUInt32Array *)array;

345 346 347 348 349 350
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
351 352
- (void)insertValue:(uint32_t)value atIndex:(NSUInteger)index;

353 354 355 356 357 358
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
359 360
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(uint32_t)value;

361 362 363 364 365
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
366
- (void)removeValueAtIndex:(NSUInteger)index;
367 368 369 370

/**
 * Removes all the values from this array.
 **/
371 372
- (void)removeAll;

373 374 375 376 377 378
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
379 380 381 382 383 384 385
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - Int64

386 387 388 389 390 391
/**
 * Class used for repeated fields of int64_t values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
392 393
@interface GPBInt64Array : NSObject <NSCopying>

394
/** The number of elements contained in the array. */
395 396
@property(nonatomic, readonly) NSUInteger count;

397 398 399
/**
 * @return A newly instanced and empty GPBInt64Array.
 **/
400
+ (instancetype)array;
401 402 403 404 405 406 407 408

/**
 * Creates and initializes a GPBInt64Array with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBInt64Array with value in it.
 **/
409
+ (instancetype)arrayWithValue:(int64_t)value;
410 411 412 413 414 415 416 417 418

/**
 * Creates and initializes a GPBInt64Array with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBInt64Array with the contents of array.
 **/
419
+ (instancetype)arrayWithValueArray:(GPBInt64Array *)array;
420 421 422 423 424 425 426 427

/**
 * Creates and initializes a GPBInt64Array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBInt64Array with a capacity of count.
 **/
428 429
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

430 431 432
/**
 * @return A newly initialized and empty GPBInt64Array.
 **/
433
- (instancetype)init NS_DESIGNATED_INITIALIZER;
434 435 436 437 438 439 440 441 442

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBInt64Array with a copy of the values.
 **/
443
- (instancetype)initWithValues:(const int64_t [__nullable])values
444
                         count:(NSUInteger)count;
445 446 447 448 449 450 451 452

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBInt64Array with a copy of the values.
 **/
453
- (instancetype)initWithValueArray:(GPBInt64Array *)array;
454 455 456 457 458 459 460 461

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBInt64Array with a capacity of count.
 **/
462 463
- (instancetype)initWithCapacity:(NSUInteger)count;

464 465 466 467 468 469 470
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
471 472
- (int64_t)valueAtIndex:(NSUInteger)index;

473 474 475 476 477 478 479 480
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
481
- (void)enumerateValuesWithBlock:(void (^)(int64_t value, NSUInteger idx, BOOL *stop))block;
482 483 484 485 486 487 488 489 490 491

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
492 493 494
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(int64_t value, NSUInteger idx, BOOL *stop))block;

495 496 497 498 499
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
500
- (void)addValue:(int64_t)value;
501 502 503 504 505 506 507

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
508
- (void)addValues:(const int64_t [__nullable])values count:(NSUInteger)count;
509 510 511 512 513 514

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
515 516
- (void)addValuesFromArray:(GPBInt64Array *)array;

517 518 519 520 521 522
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
523 524
- (void)insertValue:(int64_t)value atIndex:(NSUInteger)index;

525 526 527 528 529 530
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
531 532
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(int64_t)value;

533 534 535 536 537
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
538
- (void)removeValueAtIndex:(NSUInteger)index;
539 540 541 542

/**
 * Removes all the values from this array.
 **/
543 544
- (void)removeAll;

545 546 547 548 549 550
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
551 552 553 554 555 556 557
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - UInt64

558 559 560 561 562 563
/**
 * Class used for repeated fields of uint64_t values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
564 565
@interface GPBUInt64Array : NSObject <NSCopying>

566
/** The number of elements contained in the array. */
567 568
@property(nonatomic, readonly) NSUInteger count;

569 570 571
/**
 * @return A newly instanced and empty GPBUInt64Array.
 **/
572
+ (instancetype)array;
573 574 575 576 577 578 579 580

/**
 * Creates and initializes a GPBUInt64Array with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBUInt64Array with value in it.
 **/
581
+ (instancetype)arrayWithValue:(uint64_t)value;
582 583 584 585 586 587 588 589 590

/**
 * Creates and initializes a GPBUInt64Array with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBUInt64Array with the contents of array.
 **/
591
+ (instancetype)arrayWithValueArray:(GPBUInt64Array *)array;
592 593 594 595 596 597 598 599

/**
 * Creates and initializes a GPBUInt64Array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBUInt64Array with a capacity of count.
 **/
600 601
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

602 603 604
/**
 * @return A newly initialized and empty GPBUInt64Array.
 **/
605
- (instancetype)init NS_DESIGNATED_INITIALIZER;
606 607 608 609 610 611 612 613 614

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBUInt64Array with a copy of the values.
 **/
615
- (instancetype)initWithValues:(const uint64_t [__nullable])values
616
                         count:(NSUInteger)count;
617 618 619 620 621 622 623 624

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBUInt64Array with a copy of the values.
 **/
625
- (instancetype)initWithValueArray:(GPBUInt64Array *)array;
626 627 628 629 630 631 632 633

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBUInt64Array with a capacity of count.
 **/
634 635
- (instancetype)initWithCapacity:(NSUInteger)count;

636 637 638 639 640 641 642
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
643 644
- (uint64_t)valueAtIndex:(NSUInteger)index;

645 646 647 648 649 650 651 652
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
653
- (void)enumerateValuesWithBlock:(void (^)(uint64_t value, NSUInteger idx, BOOL *stop))block;
654 655 656 657 658 659 660 661 662 663

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
664 665 666
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(uint64_t value, NSUInteger idx, BOOL *stop))block;

667 668 669 670 671
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
672
- (void)addValue:(uint64_t)value;
673 674 675 676 677 678 679

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
680
- (void)addValues:(const uint64_t [__nullable])values count:(NSUInteger)count;
681 682 683 684 685 686

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
687 688
- (void)addValuesFromArray:(GPBUInt64Array *)array;

689 690 691 692 693 694
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
695 696
- (void)insertValue:(uint64_t)value atIndex:(NSUInteger)index;

697 698 699 700 701 702
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
703 704
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(uint64_t)value;

705 706 707 708 709
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
710
- (void)removeValueAtIndex:(NSUInteger)index;
711 712 713 714

/**
 * Removes all the values from this array.
 **/
715 716
- (void)removeAll;

717 718 719 720 721 722
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
723 724 725 726 727 728 729
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - Float

730 731 732 733 734 735
/**
 * Class used for repeated fields of float values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
736 737
@interface GPBFloatArray : NSObject <NSCopying>

738
/** The number of elements contained in the array. */
739 740
@property(nonatomic, readonly) NSUInteger count;

741 742 743
/**
 * @return A newly instanced and empty GPBFloatArray.
 **/
744
+ (instancetype)array;
745 746 747 748 749 750 751 752

/**
 * Creates and initializes a GPBFloatArray with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBFloatArray with value in it.
 **/
753
+ (instancetype)arrayWithValue:(float)value;
754 755 756 757 758 759 760 761 762

/**
 * Creates and initializes a GPBFloatArray with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBFloatArray with the contents of array.
 **/
763
+ (instancetype)arrayWithValueArray:(GPBFloatArray *)array;
764 765 766 767 768 769 770 771

/**
 * Creates and initializes a GPBFloatArray with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBFloatArray with a capacity of count.
 **/
772 773
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

774 775 776
/**
 * @return A newly initialized and empty GPBFloatArray.
 **/
777
- (instancetype)init NS_DESIGNATED_INITIALIZER;
778 779 780 781 782 783 784 785 786

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBFloatArray with a copy of the values.
 **/
787
- (instancetype)initWithValues:(const float [__nullable])values
788
                         count:(NSUInteger)count;
789 790 791 792 793 794 795 796

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBFloatArray with a copy of the values.
 **/
797
- (instancetype)initWithValueArray:(GPBFloatArray *)array;
798 799 800 801 802 803 804 805

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBFloatArray with a capacity of count.
 **/
806 807
- (instancetype)initWithCapacity:(NSUInteger)count;

808 809 810 811 812 813 814
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
815 816
- (float)valueAtIndex:(NSUInteger)index;

817 818 819 820 821 822 823 824
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
825
- (void)enumerateValuesWithBlock:(void (^)(float value, NSUInteger idx, BOOL *stop))block;
826 827 828 829 830 831 832 833 834 835

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
836 837 838
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(float value, NSUInteger idx, BOOL *stop))block;

839 840 841 842 843
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
844
- (void)addValue:(float)value;
845 846 847 848 849 850 851

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
852
- (void)addValues:(const float [__nullable])values count:(NSUInteger)count;
853 854 855 856 857 858

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
859 860
- (void)addValuesFromArray:(GPBFloatArray *)array;

861 862 863 864 865 866
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
867 868
- (void)insertValue:(float)value atIndex:(NSUInteger)index;

869 870 871 872 873 874
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
875 876
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(float)value;

877 878 879 880 881
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
882
- (void)removeValueAtIndex:(NSUInteger)index;
883 884 885 886

/**
 * Removes all the values from this array.
 **/
887 888
- (void)removeAll;

889 890 891 892 893 894
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
895 896 897 898 899 900 901
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - Double

902 903 904 905 906 907
/**
 * Class used for repeated fields of double values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
908 909
@interface GPBDoubleArray : NSObject <NSCopying>

910
/** The number of elements contained in the array. */
911 912
@property(nonatomic, readonly) NSUInteger count;

913 914 915
/**
 * @return A newly instanced and empty GPBDoubleArray.
 **/
916
+ (instancetype)array;
917 918 919 920 921 922 923 924

/**
 * Creates and initializes a GPBDoubleArray with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBDoubleArray with value in it.
 **/
925
+ (instancetype)arrayWithValue:(double)value;
926 927 928 929 930 931 932 933 934

/**
 * Creates and initializes a GPBDoubleArray with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBDoubleArray with the contents of array.
 **/
935
+ (instancetype)arrayWithValueArray:(GPBDoubleArray *)array;
936 937 938 939 940 941 942 943

/**
 * Creates and initializes a GPBDoubleArray with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBDoubleArray with a capacity of count.
 **/
944 945
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

946 947 948
/**
 * @return A newly initialized and empty GPBDoubleArray.
 **/
949
- (instancetype)init NS_DESIGNATED_INITIALIZER;
950 951 952 953 954 955 956 957 958

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBDoubleArray with a copy of the values.
 **/
959
- (instancetype)initWithValues:(const double [__nullable])values
960
                         count:(NSUInteger)count;
961 962 963 964 965 966 967 968

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBDoubleArray with a copy of the values.
 **/
969
- (instancetype)initWithValueArray:(GPBDoubleArray *)array;
970 971 972 973 974 975 976 977

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBDoubleArray with a capacity of count.
 **/
978 979
- (instancetype)initWithCapacity:(NSUInteger)count;

980 981 982 983 984 985 986
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
987 988
- (double)valueAtIndex:(NSUInteger)index;

989 990 991 992 993 994 995 996
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
997
- (void)enumerateValuesWithBlock:(void (^)(double value, NSUInteger idx, BOOL *stop))block;
998 999 1000 1001 1002 1003 1004 1005 1006 1007

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1008 1009 1010
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(double value, NSUInteger idx, BOOL *stop))block;

1011 1012 1013 1014 1015
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
1016
- (void)addValue:(double)value;
1017 1018 1019 1020 1021 1022 1023

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
1024
- (void)addValues:(const double [__nullable])values count:(NSUInteger)count;
1025 1026 1027 1028 1029 1030

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
1031 1032
- (void)addValuesFromArray:(GPBDoubleArray *)array;

1033 1034 1035 1036 1037 1038
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
1039 1040
- (void)insertValue:(double)value atIndex:(NSUInteger)index;

1041 1042 1043 1044 1045 1046
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
1047 1048
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(double)value;

1049 1050 1051 1052 1053
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
1054
- (void)removeValueAtIndex:(NSUInteger)index;
1055 1056 1057 1058

/**
 * Removes all the values from this array.
 **/
1059 1060
- (void)removeAll;

1061 1062 1063 1064 1065 1066
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
1067 1068 1069 1070 1071 1072 1073
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - Bool

1074 1075 1076 1077 1078 1079
/**
 * Class used for repeated fields of BOOL values. This performs better than
 * boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
1080 1081
@interface GPBBoolArray : NSObject <NSCopying>

1082
/** The number of elements contained in the array. */
1083 1084
@property(nonatomic, readonly) NSUInteger count;

1085 1086 1087
/**
 * @return A newly instanced and empty GPBBoolArray.
 **/
1088
+ (instancetype)array;
1089 1090 1091 1092 1093 1094 1095 1096

/**
 * Creates and initializes a GPBBoolArray with the single element given.
 *
 * @param value The value to be placed in the array.
 *
 * @return A newly instanced GPBBoolArray with value in it.
 **/
1097
+ (instancetype)arrayWithValue:(BOOL)value;
1098 1099 1100 1101 1102 1103 1104 1105 1106

/**
 * Creates and initializes a GPBBoolArray with the contents of the given
 * array.
 *
 * @param array Array with the contents to be put into the new array.
 *
 * @return A newly instanced GPBBoolArray with the contents of array.
 **/
1107
+ (instancetype)arrayWithValueArray:(GPBBoolArray *)array;
1108 1109 1110 1111 1112 1113 1114 1115

/**
 * Creates and initializes a GPBBoolArray with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBBoolArray with a capacity of count.
 **/
1116 1117
+ (instancetype)arrayWithCapacity:(NSUInteger)count;

1118 1119 1120
/**
 * @return A newly initialized and empty GPBBoolArray.
 **/
1121
- (instancetype)init NS_DESIGNATED_INITIALIZER;
1122 1123 1124 1125 1126 1127 1128 1129 1130

/**
 * Initializes the array, copying the given values.
 *
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBBoolArray with a copy of the values.
 **/
1131
- (instancetype)initWithValues:(const BOOL [__nullable])values
1132
                         count:(NSUInteger)count;
1133 1134 1135 1136 1137 1138 1139 1140

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBBoolArray with a copy of the values.
 **/
1141
- (instancetype)initWithValueArray:(GPBBoolArray *)array;
1142 1143 1144 1145 1146 1147 1148 1149

/**
 * Initializes the array with the given capacity.
 *
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBBoolArray with a capacity of count.
 **/
1150 1151
- (instancetype)initWithCapacity:(NSUInteger)count;

1152 1153 1154 1155 1156 1157 1158
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
1159 1160
- (BOOL)valueAtIndex:(NSUInteger)index;

1161 1162 1163 1164 1165 1166 1167 1168
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1169
- (void)enumerateValuesWithBlock:(void (^)(BOOL value, NSUInteger idx, BOOL *stop))block;
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1180 1181 1182
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(BOOL value, NSUInteger idx, BOOL *stop))block;

1183 1184 1185 1186 1187
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
1188
- (void)addValue:(BOOL)value;
1189 1190 1191 1192 1193 1194 1195

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
1196
- (void)addValues:(const BOOL [__nullable])values count:(NSUInteger)count;
1197 1198 1199 1200 1201 1202

/**
 * Adds the values from the given array to this array.
 *
 * @param array The array containing the elements to add to this array.
 **/
1203 1204
- (void)addValuesFromArray:(GPBBoolArray *)array;

1205 1206 1207 1208 1209 1210
/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
1211 1212
- (void)insertValue:(BOOL)value atIndex:(NSUInteger)index;

1213 1214 1215 1216 1217 1218
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
1219 1220
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(BOOL)value;

1221 1222 1223 1224 1225
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
1226
- (void)removeValueAtIndex:(NSUInteger)index;
1227 1228 1229 1230

/**
 * Removes all the values from this array.
 **/
1231 1232
- (void)removeAll;

1233 1234 1235 1236 1237 1238
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
1239 1240 1241 1242 1243 1244 1245
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

#pragma mark - Enum

1246 1247 1248 1249 1250 1251
/**
 * This class is used for repeated fields of int32_t values. This performs
 * better than boxing into NSNumbers in NSArrays.
 *
 * @note This class is not meant to be subclassed.
 **/
1252 1253
@interface GPBEnumArray : NSObject <NSCopying>

1254
/** The number of elements contained in the array. */
1255
@property(nonatomic, readonly) NSUInteger count;
1256
/** The validation function to check if the enums are valid. */
1257 1258
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc;

1259 1260 1261
/**
 * @return A newly instanced and empty GPBEnumArray.
 **/
1262
+ (instancetype)array;
1263 1264 1265 1266 1267 1268 1269 1270 1271

/**
 * Creates and initializes a GPBEnumArray with the enum validation function
 * given.
 *
 * @param func The enum validation function for the array.
 *
 * @return A newly instanced GPBEnumArray.
 **/
1272
+ (instancetype)arrayWithValidationFunction:(nullable GPBEnumValidationFunc)func;
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282

/**
 * Creates and initializes a GPBEnumArray with the enum validation function
 * given and the single raw value given.
 *
 * @param func  The enum validation function for the array.
 * @param value The raw value to add to this array.
 *
 * @return A newly instanced GPBEnumArray.
 **/
1283
+ (instancetype)arrayWithValidationFunction:(nullable GPBEnumValidationFunc)func
1284
                                   rawValue:(int32_t)value;
1285 1286 1287 1288 1289 1290 1291 1292 1293

/**
 * Creates and initializes a GPBEnumArray that adds the elements from the
 * given array.
 *
 * @param array Array containing the values to add to the new array.
 *
 * @return A newly instanced GPBEnumArray.
 **/
1294
+ (instancetype)arrayWithValueArray:(GPBEnumArray *)array;
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304

/**
 * Creates and initializes a GPBEnumArray with the given enum validation
 * function and with the givencapacity.
 *
 * @param func  The enum validation function for the array.
 * @param count The capacity needed for the array.
 *
 * @return A newly instanced GPBEnumArray with a capacity of count.
 **/
1305
+ (instancetype)arrayWithValidationFunction:(nullable GPBEnumValidationFunc)func
1306 1307
                                   capacity:(NSUInteger)count;

1308 1309 1310 1311 1312 1313 1314
/**
 * Initializes the array with the given enum validation function.
 *
 * @param func The enum validation function for the array.
 *
 * @return A newly initialized GPBEnumArray with a copy of the values.
 **/
1315 1316
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func
    NS_DESIGNATED_INITIALIZER;
1317

1318 1319 1320 1321 1322 1323 1324 1325 1326
/**
 * Initializes the array, copying the given values.
 *
 * @param func   The enum validation function for the array.
 * @param values An array with the values to put inside this array.
 * @param count  The number of elements to copy into the array.
 *
 * @return A newly initialized GPBEnumArray with a copy of the values.
 **/
1327
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func
1328
                                 rawValues:(const int32_t [__nullable])values
1329
                                     count:(NSUInteger)count;
1330 1331 1332 1333 1334 1335 1336 1337

/**
 * Initializes the array, copying the given values.
 *
 * @param array An array with the values to put inside this array.
 *
 * @return A newly initialized GPBEnumArray with a copy of the values.
 **/
1338
- (instancetype)initWithValueArray:(GPBEnumArray *)array;
1339 1340 1341 1342 1343 1344 1345 1346 1347

/**
 * Initializes the array with the given capacity.
 *
 * @param func  The enum validation function for the array.
 * @param count The capacity needed for the array.
 *
 * @return A newly initialized GPBEnumArray with a capacity of count.
 **/
1348
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func
1349 1350 1351 1352 1353 1354
                                  capacity:(NSUInteger)count;

// These will return kGPBUnrecognizedEnumeratorValue if the value at index is not a
// valid enumerator as defined by validationFunc. If the actual value is
// desired, use "raw" version of the method.

1355 1356 1357 1358 1359 1360 1361
/**
 * Gets the value at the given index.
 *
 * @param index The index of the value to get.
 *
 * @return The value at the given index.
 **/
1362 1363
- (int32_t)valueAtIndex:(NSUInteger)index;

1364 1365 1366 1367 1368 1369 1370 1371
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1372
- (void)enumerateValuesWithBlock:(void (^)(int32_t value, NSUInteger idx, BOOL *stop))block;
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1383 1384 1385 1386 1387 1388
- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
                        usingBlock:(void (^)(int32_t value, NSUInteger idx, BOOL *stop))block;

// These methods bypass the validationFunc to provide access to values that were not
// known at the time the binary was compiled.

1389 1390 1391 1392 1393 1394 1395
/**
 * Gets the raw enum value at the given index.
 *
 * @param index The index of the raw enum value to get.
 *
 * @return The raw enum value at the given index.
 **/
1396 1397
- (int32_t)rawValueAtIndex:(NSUInteger)index;

1398 1399 1400 1401 1402 1403 1404 1405
/**
 * Enumerates the values on this array with the given block.
 *
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1406
- (void)enumerateRawValuesWithBlock:(void (^)(int32_t value, NSUInteger idx, BOOL *stop))block;
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416

/**
 * Enumerates the values on this array with the given block.
 *
 * @param opts  Options to control the enumeration.
 * @param block The block to enumerate with.
 *   **value**: The current value being enumerated.
 *   **idx**:   The index of the current value.
 *   **stop**:  A pointer to a boolean that when set stops the enumeration.
 **/
1417 1418 1419 1420 1421 1422 1423 1424
- (void)enumerateRawValuesWithOptions:(NSEnumerationOptions)opts
                           usingBlock:(void (^)(int32_t value, NSUInteger idx, BOOL *stop))block;

// If value is not a valid enumerator as defined by validationFunc, these
// methods will assert in debug, and will log in release and assign the value
// to the default value. Use the rawValue methods below to assign non enumerator
// values.

1425 1426 1427 1428 1429
/**
 * Adds a value to this array.
 *
 * @param value The value to add to this array.
 **/
1430
- (void)addValue:(int32_t)value;
1431 1432 1433 1434 1435 1436 1437

/**
 * Adds values to this array.
 *
 * @param values The values to add to this array.
 * @param count  The number of elements to add.
 **/
1438
- (void)addValues:(const int32_t [__nullable])values count:(NSUInteger)count;
1439

1440 1441 1442 1443 1444 1445 1446

/**
 * Inserts a value into the given position.
 *
 * @param value The value to add to this array.
 * @param index The index into which to insert the value.
 **/
1447 1448
- (void)insertValue:(int32_t)value atIndex:(NSUInteger)index;

1449 1450 1451 1452 1453 1454
/**
 * Replaces the value at the given index with the given value.
 *
 * @param index The index for which to replace the value.
 * @param value The value to replace with.
 **/
1455 1456 1457 1458 1459
- (void)replaceValueAtIndex:(NSUInteger)index withValue:(int32_t)value;

// These methods bypass the validationFunc to provide setting of values that were not
// known at the time the binary was compiled.

1460 1461 1462 1463 1464 1465 1466 1467
/**
 * Adds a raw enum value to this array.
 *
 * @note This method bypass the validationFunc to enable the setting of values that
 *       were not known at the time the binary was compiled.
 *
 * @param value The raw enum value to add to the array.
 **/
1468
- (void)addRawValue:(int32_t)value;
1469 1470 1471 1472 1473 1474 1475 1476 1477

/**
 * Adds raw enum values to this array.
 *
 * @note This method bypass the validationFunc to enable the setting of values that
 *       were not known at the time the binary was compiled.
 *
 * @param array Array containing the raw enum values to add to this array.
 **/
1478
- (void)addRawValuesFromArray:(GPBEnumArray *)array;
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488

/**
 * Adds raw enum values to this array.
 *
 * @note This method bypass the validationFunc to enable the setting of values that
 *       were not known at the time the binary was compiled.
 *
 * @param values Array containing the raw enum values to add to this array.
 * @param count  The number of raw values to add.
 **/
1489
- (void)addRawValues:(const int32_t [__nullable])values count:(NSUInteger)count;
1490

1491 1492 1493 1494 1495 1496 1497 1498 1499
/**
 * Inserts a raw enum value at the given index.
 *
 * @note This method bypass the validationFunc to enable the setting of values that
 *       were not known at the time the binary was compiled.
 *
 * @param value Raw enum value to add.
 * @param index The index into which to insert the value.
 **/
1500 1501
- (void)insertRawValue:(int32_t)value atIndex:(NSUInteger)index;

1502 1503 1504 1505 1506 1507 1508 1509 1510
/**
 * Replaces the raw enum value at the given index with the given value.
 *
 * @note This method bypass the validationFunc to enable the setting of values that
 *       were not known at the time the binary was compiled.
 *
 * @param index The index for which to replace the value.
 * @param value The raw enum value to replace with.
 **/
1511 1512 1513 1514
- (void)replaceValueAtIndex:(NSUInteger)index withRawValue:(int32_t)value;

// No validation applies to these methods.

1515 1516 1517 1518 1519
/**
 * Removes the value at the given index.
 *
 * @param index The index of the value to remove.
 **/
1520
- (void)removeValueAtIndex:(NSUInteger)index;
1521 1522 1523 1524

/**
 * Removes all the values from this array.
 **/
1525 1526
- (void)removeAll;

1527 1528 1529 1530 1531 1532
/**
 * Exchanges the values between the given indexes.
 *
 * @param idx1 The index of the first element to exchange.
 * @param idx2 The index of the second element to exchange.
 **/
1533 1534 1535 1536 1537 1538 1539
- (void)exchangeValueAtIndex:(NSUInteger)idx1
            withValueAtIndex:(NSUInteger)idx2;

@end

//%PDDM-EXPAND-END DECLARE_ARRAYS()

1540 1541
NS_ASSUME_NONNULL_END

1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
//%PDDM-DEFINE DECLARE_ARRAYS()
//%ARRAY_INTERFACE_SIMPLE(Int32, int32_t)
//%ARRAY_INTERFACE_SIMPLE(UInt32, uint32_t)
//%ARRAY_INTERFACE_SIMPLE(Int64, int64_t)
//%ARRAY_INTERFACE_SIMPLE(UInt64, uint64_t)
//%ARRAY_INTERFACE_SIMPLE(Float, float)
//%ARRAY_INTERFACE_SIMPLE(Double, double)
//%ARRAY_INTERFACE_SIMPLE(Bool, BOOL)
//%ARRAY_INTERFACE_ENUM(Enum, int32_t)

//
// The common case (everything but Enum)
//

//%PDDM-DEFINE ARRAY_INTERFACE_SIMPLE(NAME, TYPE)
//%#pragma mark - NAME
//%
1559 1560 1561 1562 1563 1564
//%/**
//% * Class used for repeated fields of ##TYPE## values. This performs better than
//% * boxing into NSNumbers in NSArrays.
//% *
//% * @note This class is not meant to be subclassed.
//% **/
1565 1566
//%@interface GPB##NAME##Array : NSObject <NSCopying>
//%
1567
//%/** The number of elements contained in the array. */
1568 1569
//%@property(nonatomic, readonly) NSUInteger count;
//%
1570 1571 1572
//%/**
//% * @return A newly instanced and empty GPB##NAME##Array.
//% **/
1573
//%+ (instancetype)array;
1574 1575 1576
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array with the single element given.
1577
//% *
1578 1579 1580 1581
//% * @param value The value to be placed in the array.
//% *
//% * @return A newly instanced GPB##NAME##Array with value in it.
//% **/
1582
//%+ (instancetype)arrayWithValue:(TYPE)value;
1583 1584 1585 1586 1587 1588 1589 1590 1591
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array with the contents of the given
//% * array.
//% *
//% * @param array Array with the contents to be put into the new array.
//% *
//% * @return A newly instanced GPB##NAME##Array with the contents of array.
//% **/
1592
//%+ (instancetype)arrayWithValueArray:(GPB##NAME##Array *)array;
1593 1594 1595 1596 1597 1598 1599 1600
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array with the given capacity.
//% *
//% * @param count The capacity needed for the array.
//% *
//% * @return A newly instanced GPB##NAME##Array with a capacity of count.
//% **/
1601 1602
//%+ (instancetype)arrayWithCapacity:(NSUInteger)count;
//%
1603
//%/**
1604 1605
//% * @return A newly initialized and empty GPB##NAME##Array.
//% **/
1606
//%- (instancetype)init NS_DESIGNATED_INITIALIZER;
1607 1608 1609 1610 1611 1612 1613 1614 1615
//%
//%/**
//% * Initializes the array, copying the given values.
//% *
//% * @param values An array with the values to put inside this array.
//% * @param count  The number of elements to copy into the array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a copy of the values.
//% **/
1616
//%- (instancetype)initWithValues:(const TYPE [__nullable])values
1617
//%                         count:(NSUInteger)count;
1618 1619 1620 1621 1622 1623 1624 1625
//%
//%/**
//% * Initializes the array, copying the given values.
//% *
//% * @param array An array with the values to put inside this array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a copy of the values.
//% **/
1626
//%- (instancetype)initWithValueArray:(GPB##NAME##Array *)array;
1627 1628 1629 1630 1631 1632 1633 1634
//%
//%/**
//% * Initializes the array with the given capacity.
//% *
//% * @param count The capacity needed for the array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a capacity of count.
//% **/
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
//%- (instancetype)initWithCapacity:(NSUInteger)count;
//%
//%ARRAY_IMMUTABLE_INTERFACE(NAME, TYPE, Basic)
//%
//%ARRAY_MUTABLE_INTERFACE(NAME, TYPE, Basic)
//%
//%@end
//%

//
// Macros specific to Enums (to tweak their interface).
//

//%PDDM-DEFINE ARRAY_INTERFACE_ENUM(NAME, TYPE)
//%#pragma mark - NAME
//%
1651 1652 1653 1654 1655 1656
//%/**
//% * This class is used for repeated fields of ##TYPE## values. This performs
//% * better than boxing into NSNumbers in NSArrays.
//% *
//% * @note This class is not meant to be subclassed.
//% **/
1657 1658
//%@interface GPB##NAME##Array : NSObject <NSCopying>
//%
1659
//%/** The number of elements contained in the array. */
1660
//%@property(nonatomic, readonly) NSUInteger count;
1661
//%/** The validation function to check if the enums are valid. */
1662 1663
//%@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc;
//%
1664 1665 1666
//%/**
//% * @return A newly instanced and empty GPB##NAME##Array.
//% **/
1667
//%+ (instancetype)array;
1668 1669 1670 1671 1672 1673 1674 1675 1676
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array with the enum validation function
//% * given.
//% *
//% * @param func The enum validation function for the array.
//% *
//% * @return A newly instanced GPB##NAME##Array.
//% **/
1677
//%+ (instancetype)arrayWithValidationFunction:(nullable GPBEnumValidationFunc)func;
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array with the enum validation function
//% * given and the single raw value given.
//% *
//% * @param func  The enum validation function for the array.
//% * @param value The raw value to add to this array.
//% *
//% * @return A newly instanced GPB##NAME##Array.
//% **/
1688
//%+ (instancetype)arrayWithValidationFunction:(nullable GPBEnumValidationFunc)func
1689
//%                                   rawValue:(TYPE)value;
1690 1691 1692 1693 1694 1695 1696 1697 1698
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array that adds the elements from the
//% * given array.
//% *
//% * @param array Array containing the values to add to the new array.
//% *
//% * @return A newly instanced GPB##NAME##Array.
//% **/
1699
//%+ (instancetype)arrayWithValueArray:(GPB##NAME##Array *)array;
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
//%
//%/**
//% * Creates and initializes a GPB##NAME##Array with the given enum validation
//% * function and with the givencapacity.
//% *
//% * @param func  The enum validation function for the array.
//% * @param count The capacity needed for the array.
//% *
//% * @return A newly instanced GPB##NAME##Array with a capacity of count.
//% **/
1710
//%+ (instancetype)arrayWithValidationFunction:(nullable GPBEnumValidationFunc)func
1711 1712
//%                                   capacity:(NSUInteger)count;
//%
1713 1714 1715 1716 1717 1718 1719
//%/**
//% * Initializes the array with the given enum validation function.
//% *
//% * @param func The enum validation function for the array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a copy of the values.
//% **/
1720 1721
//%- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func
//%    NS_DESIGNATED_INITIALIZER;
1722
//%
1723 1724 1725 1726 1727 1728 1729 1730 1731
//%/**
//% * Initializes the array, copying the given values.
//% *
//% * @param func   The enum validation function for the array.
//% * @param values An array with the values to put inside this array.
//% * @param count  The number of elements to copy into the array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a copy of the values.
//% **/
1732
//%- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func
1733
//%                                 rawValues:(const TYPE [__nullable])values
1734
//%                                     count:(NSUInteger)count;
1735 1736 1737 1738 1739 1740 1741 1742
//%
//%/**
//% * Initializes the array, copying the given values.
//% *
//% * @param array An array with the values to put inside this array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a copy of the values.
//% **/
1743
//%- (instancetype)initWithValueArray:(GPB##NAME##Array *)array;
1744 1745 1746 1747 1748 1749 1750 1751 1752
//%
//%/**
//% * Initializes the array with the given capacity.
//% *
//% * @param func  The enum validation function for the array.
//% * @param count The capacity needed for the array.
//% *
//% * @return A newly initialized GPB##NAME##Array with a capacity of count.
//% **/
1753
//%- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
//%                                  capacity:(NSUInteger)count;
//%
//%// These will return kGPBUnrecognizedEnumeratorValue if the value at index is not a
//%// valid enumerator as defined by validationFunc. If the actual value is
//%// desired, use "raw" version of the method.
//%
//%ARRAY_IMMUTABLE_INTERFACE(NAME, TYPE, NAME)
//%
//%// These methods bypass the validationFunc to provide access to values that were not
//%// known at the time the binary was compiled.
//%
1765 1766 1767 1768 1769 1770 1771
//%/**
//% * Gets the raw enum value at the given index.
//% *
//% * @param index The index of the raw enum value to get.
//% *
//% * @return The raw enum value at the given index.
//% **/
1772 1773
//%- (TYPE)rawValueAtIndex:(NSUInteger)index;
//%
1774 1775
//%/**
//% * Enumerates the values on this array with the given block.
1776
//% *
1777 1778 1779 1780 1781
//% * @param block The block to enumerate with.
//% *   **value**: The current value being enumerated.
//% *   **idx**:   The index of the current value.
//% *   **stop**:  A pointer to a boolean that when set stops the enumeration.
//% **/
1782
//%- (void)enumerateRawValuesWithBlock:(void (^)(TYPE value, NSUInteger idx, BOOL *stop))block;
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
//%
//%/**
//% * Enumerates the values on this array with the given block.
//% *
//% * @param opts  Options to control the enumeration.
//% * @param block The block to enumerate with.
//% *   **value**: The current value being enumerated.
//% *   **idx**:   The index of the current value.
//% *   **stop**:  A pointer to a boolean that when set stops the enumeration.
//% **/
1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
//%- (void)enumerateRawValuesWithOptions:(NSEnumerationOptions)opts
//%                           usingBlock:(void (^)(TYPE value, NSUInteger idx, BOOL *stop))block;
//%
//%// If value is not a valid enumerator as defined by validationFunc, these
//%// methods will assert in debug, and will log in release and assign the value
//%// to the default value. Use the rawValue methods below to assign non enumerator
//%// values.
//%
//%ARRAY_MUTABLE_INTERFACE(NAME, TYPE, NAME)
//%
//%@end
//%

//%PDDM-DEFINE ARRAY_IMMUTABLE_INTERFACE(NAME, TYPE, HELPER_NAME)
1807 1808 1809 1810 1811 1812 1813
//%/**
//% * Gets the value at the given index.
//% *
//% * @param index The index of the value to get.
//% *
//% * @return The value at the given index.
//% **/
1814 1815
//%- (TYPE)valueAtIndex:(NSUInteger)index;
//%
1816 1817 1818 1819 1820 1821 1822 1823
//%/**
//% * Enumerates the values on this array with the given block.
//% *
//% * @param block The block to enumerate with.
//% *   **value**: The current value being enumerated.
//% *   **idx**:   The index of the current value.
//% *   **stop**:  A pointer to a boolean that when set stops the enumeration.
//% **/
1824
//%- (void)enumerateValuesWithBlock:(void (^)(TYPE value, NSUInteger idx, BOOL *stop))block;
1825 1826 1827 1828 1829
//%
//%/**
//% * Enumerates the values on this array with the given block.
//% *
//% * @param opts  Options to control the enumeration.
1830
//% * @param block The block to enumerate with.
1831 1832 1833 1834
//% *   **value**: The current value being enumerated.
//% *   **idx**:   The index of the current value.
//% *   **stop**:  A pointer to a boolean that when set stops the enumeration.
//% **/
1835 1836 1837 1838
//%- (void)enumerateValuesWithOptions:(NSEnumerationOptions)opts
//%                        usingBlock:(void (^)(TYPE value, NSUInteger idx, BOOL *stop))block;

//%PDDM-DEFINE ARRAY_MUTABLE_INTERFACE(NAME, TYPE, HELPER_NAME)
1839 1840 1841 1842 1843
//%/**
//% * Adds a value to this array.
//% *
//% * @param value The value to add to this array.
//% **/
1844
//%- (void)addValue:(TYPE)value;
1845 1846 1847 1848 1849 1850 1851
//%
//%/**
//% * Adds values to this array.
//% *
//% * @param values The values to add to this array.
//% * @param count  The number of elements to add.
//% **/
1852
//%- (void)addValues:(const TYPE [__nullable])values count:(NSUInteger)count;
1853
//%
1854
//%ARRAY_EXTRA_MUTABLE_METHODS1_##HELPER_NAME(NAME, TYPE)
1855 1856 1857 1858 1859 1860
//%/**
//% * Inserts a value into the given position.
//% *
//% * @param value The value to add to this array.
//% * @param index The index into which to insert the value.
//% **/
1861 1862
//%- (void)insertValue:(TYPE)value atIndex:(NSUInteger)index;
//%
1863 1864 1865 1866 1867 1868
//%/**
//% * Replaces the value at the given index with the given value.
//% *
//% * @param index The index for which to replace the value.
//% * @param value The value to replace with.
//% **/
1869 1870
//%- (void)replaceValueAtIndex:(NSUInteger)index withValue:(TYPE)value;
//%ARRAY_EXTRA_MUTABLE_METHODS2_##HELPER_NAME(NAME, TYPE)
1871 1872 1873 1874 1875
//%/**
//% * Removes the value at the given index.
//% *
//% * @param index The index of the value to remove.
//% **/
1876
//%- (void)removeValueAtIndex:(NSUInteger)index;
1877 1878 1879 1880
//%
//%/**
//% * Removes all the values from this array.
//% **/
1881 1882
//%- (void)removeAll;
//%
1883 1884 1885 1886 1887 1888
//%/**
//% * Exchanges the values between the given indexes.
//% *
//% * @param idx1 The index of the first element to exchange.
//% * @param idx2 The index of the second element to exchange.
//% **/
1889 1890 1891 1892 1893 1894 1895 1896
//%- (void)exchangeValueAtIndex:(NSUInteger)idx1
//%            withValueAtIndex:(NSUInteger)idx2;

//
// These are hooks invoked by the above to do insert as needed.
//

//%PDDM-DEFINE ARRAY_EXTRA_MUTABLE_METHODS1_Basic(NAME, TYPE)
1897 1898 1899 1900 1901
//%/**
//% * Adds the values from the given array to this array.
//% *
//% * @param array The array containing the elements to add to this array.
//% **/
1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
//%- (void)addValuesFromArray:(GPB##NAME##Array *)array;
//%
//%PDDM-DEFINE ARRAY_EXTRA_MUTABLE_METHODS2_Basic(NAME, TYPE)
// Empty
//%PDDM-DEFINE ARRAY_EXTRA_MUTABLE_METHODS1_Enum(NAME, TYPE)
// Empty
//%PDDM-DEFINE ARRAY_EXTRA_MUTABLE_METHODS2_Enum(NAME, TYPE)
//%
//%// These methods bypass the validationFunc to provide setting of values that were not
//%// known at the time the binary was compiled.
//%
1913 1914 1915 1916 1917 1918 1919 1920
//%/**
//% * Adds a raw enum value to this array.
//% *
//% * @note This method bypass the validationFunc to enable the setting of values that
//% *       were not known at the time the binary was compiled.
//% *
//% * @param value The raw enum value to add to the array.
//% **/
1921
//%- (void)addRawValue:(TYPE)value;
1922 1923 1924 1925 1926 1927 1928 1929 1930
//%
//%/**
//% * Adds raw enum values to this array.
//% *
//% * @note This method bypass the validationFunc to enable the setting of values that
//% *       were not known at the time the binary was compiled.
//% *
//% * @param array Array containing the raw enum values to add to this array.
//% **/
1931
//%- (void)addRawValuesFromArray:(GPB##NAME##Array *)array;
1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
//%
//%/**
//% * Adds raw enum values to this array.
//% *
//% * @note This method bypass the validationFunc to enable the setting of values that
//% *       were not known at the time the binary was compiled.
//% *
//% * @param values Array containing the raw enum values to add to this array.
//% * @param count  The number of raw values to add.
//% **/
1942
//%- (void)addRawValues:(const TYPE [__nullable])values count:(NSUInteger)count;
1943
//%
1944 1945 1946 1947 1948 1949 1950 1951 1952
//%/**
//% * Inserts a raw enum value at the given index.
//% *
//% * @note This method bypass the validationFunc to enable the setting of values that
//% *       were not known at the time the binary was compiled.
//% *
//% * @param value Raw enum value to add.
//% * @param index The index into which to insert the value.
//% **/
1953 1954
//%- (void)insertRawValue:(TYPE)value atIndex:(NSUInteger)index;
//%
1955 1956 1957 1958 1959 1960 1961 1962 1963
//%/**
//% * Replaces the raw enum value at the given index with the given value.
//% *
//% * @note This method bypass the validationFunc to enable the setting of values that
//% *       were not known at the time the binary was compiled.
//% *
//% * @param index The index for which to replace the value.
//% * @param value The raw enum value to replace with.
//% **/
1964 1965 1966 1967
//%- (void)replaceValueAtIndex:(NSUInteger)index withRawValue:(TYPE)value;
//%
//%// No validation applies to these methods.
//%