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 PYUPB_REPEATED_H__
29 #define PYUPB_REPEATED_H__
30 
31 #include <stdbool.h>
32 
33 #include "python/python_api.h"
34 #include "upb/reflection/def.h"
35 
36 // Creates a new repeated field stub for field `f` of message object `parent`.
37 // Precondition: `parent` must be a stub.
38 PyObject* PyUpb_RepeatedContainer_NewStub(PyObject* parent,
39                                           const upb_FieldDef* f,
40                                           PyObject* arena);
41 
42 // Returns a repeated field object wrapping `arr`, of field type `f`, which
43 // must be on `arena`.  If an existing wrapper object exists, it will be
44 // returned, otherwise a new object will be created.  The caller always owns a
45 // ref on the returned value.
46 PyObject* PyUpb_RepeatedContainer_GetOrCreateWrapper(upb_Array* arr,
47                                                      const upb_FieldDef* f,
48                                                      PyObject* arena);
49 
50 // Reifies a repeated field stub to point to the concrete data in `arr`.
51 // If `arr` is NULL, an appropriate empty array will be constructed.
52 void PyUpb_RepeatedContainer_Reify(PyObject* self, upb_Array* arr);
53 
54 // Reifies this repeated object if it is not already reified.
55 upb_Array* PyUpb_RepeatedContainer_EnsureReified(PyObject* self);
56 
57 // Implements repeated_field.extend(iterable).  `_self` must be a repeated
58 // field (either repeated composite or repeated scalar).
59 PyObject* PyUpb_RepeatedContainer_Extend(PyObject* _self, PyObject* value);
60 
61 // Implements repeated_field.add(initial_values).  `_self` must be a repeated
62 // composite field.
63 PyObject* PyUpb_RepeatedCompositeContainer_Add(PyObject* _self, PyObject* args,
64                                                PyObject* kwargs);
65 
66 // Module-level init.
67 bool PyUpb_Repeated_Init(PyObject* m);
68 
69 #endif  // PYUPB_REPEATED_H__
70