1 /* 2 * Copyright (c) 2009-2021, Google LLC 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * * Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * * Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * * Neither the name of Google LLC nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT, 20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef UPB_COLLECTIONS_ARRAY_H_ 29 #define UPB_COLLECTIONS_ARRAY_H_ 30 31 #include "upb/base/descriptor_constants.h" 32 #include "upb/collections/message_value.h" 33 #include "upb/mem/arena.h" 34 35 // Must be last. 36 #include "upb/port/def.inc" 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 // Creates a new array on the given arena that holds elements of this type. 43 UPB_API upb_Array* upb_Array_New(upb_Arena* a, upb_CType type); 44 45 // Returns the number of elements in the array. 46 UPB_API size_t upb_Array_Size(const upb_Array* arr); 47 48 // Returns the given element, which must be within the array's current size. 49 UPB_API upb_MessageValue upb_Array_Get(const upb_Array* arr, size_t i); 50 51 // Sets the given element, which must be within the array's current size. 52 UPB_API void upb_Array_Set(upb_Array* arr, size_t i, upb_MessageValue val); 53 54 // Appends an element to the array. Returns false on allocation failure. 55 UPB_API bool upb_Array_Append(upb_Array* array, upb_MessageValue val, 56 upb_Arena* arena); 57 58 // Moves elements within the array using memmove(). 59 // Like memmove(), the source and destination elements may be overlapping. 60 UPB_API void upb_Array_Move(upb_Array* array, size_t dst_idx, size_t src_idx, 61 size_t count); 62 63 // Inserts one or more empty elements into the array. 64 // Existing elements are shifted right. 65 // The new elements have undefined state and must be set with `upb_Array_Set()`. 66 // REQUIRES: `i <= upb_Array_Size(arr)` 67 UPB_API bool upb_Array_Insert(upb_Array* array, size_t i, size_t count, 68 upb_Arena* arena); 69 70 // Deletes one or more elements from the array. 71 // Existing elements are shifted left. 72 // REQUIRES: `i + count <= upb_Array_Size(arr)` 73 UPB_API void upb_Array_Delete(upb_Array* array, size_t i, size_t count); 74 75 // Changes the size of a vector. New elements are initialized to NULL/0. 76 // Returns false on allocation failure. 77 UPB_API bool upb_Array_Resize(upb_Array* array, size_t size, upb_Arena* arena); 78 79 #ifdef __cplusplus 80 } /* extern "C" */ 81 #endif 82 83 #include "upb/port/undef.inc" 84 85 #endif /* UPB_COLLECTIONS_ARRAY_H_ */ 86