1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // https://developers.google.com/protocol-buffers/ 4 // 5 // Redistribution and use in source and binary forms, with or without 6 // modification, are permitted provided that the following conditions are 7 // met: 8 // 9 // * Redistributions of source code must retain the above copyright 10 // notice, this list of conditions and the following disclaimer. 11 // * Redistributions in binary form must reproduce the above 12 // copyright notice, this list of conditions and the following disclaimer 13 // in the documentation and/or other materials provided with the 14 // distribution. 15 // * Neither the name of Google Inc. nor the names of its 16 // contributors may be used to endorse or promote products derived from 17 // this software without specific prior written permission. 18 // 19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 // Author: anuraag@google.com (Anuraag Agrawal) 32 // Author: tibell@google.com (Johan Tibell) 33 34 #ifndef GOOGLE_PROTOBUF_PYTHON_CPP_REPEATED_COMPOSITE_CONTAINER_H__ 35 #define GOOGLE_PROTOBUF_PYTHON_CPP_REPEATED_COMPOSITE_CONTAINER_H__ 36 37 #define PY_SSIZE_T_CLEAN 38 #include <Python.h> 39 40 #include <google/protobuf/pyext/message.h> 41 42 namespace google { 43 namespace protobuf { 44 45 class FieldDescriptor; 46 class Message; 47 48 namespace python { 49 50 struct CMessageClass; 51 52 // A RepeatedCompositeContainer always has a parent message. 53 // The parent message also caches reference to items of the container. 54 typedef struct RepeatedCompositeContainer : public ContainerBase { 55 // The type used to create new child messages. 56 CMessageClass* child_message_class; 57 } RepeatedCompositeContainer; 58 59 extern PyTypeObject RepeatedCompositeContainer_Type; 60 61 namespace repeated_composite_container { 62 63 // Builds a RepeatedCompositeContainer object, from a parent message and a 64 // field descriptor. 65 RepeatedCompositeContainer* NewContainer( 66 CMessage* parent, 67 const FieldDescriptor* parent_field_descriptor, 68 CMessageClass *child_message_class); 69 70 // Appends a new CMessage to the container and returns it. The 71 // CMessage is initialized using the content of kwargs. 72 // 73 // Returns a new reference if successful; returns NULL and sets an 74 // exception if unsuccessful. 75 PyObject* Add(RepeatedCompositeContainer* self, 76 PyObject* args, 77 PyObject* kwargs); 78 79 // Appends all the CMessages in the input iterator to the container. 80 // 81 // Returns None if successful; returns NULL and sets an exception if 82 // unsuccessful. 83 PyObject* Extend(RepeatedCompositeContainer* self, PyObject* value); 84 85 // Appends a new message to the container for each message in the 86 // input iterator, merging each data element in. Equivalent to extend. 87 // 88 // Returns None if successful; returns NULL and sets an exception if 89 // unsuccessful. 90 PyObject* MergeFrom(RepeatedCompositeContainer* self, PyObject* other); 91 92 // Accesses messages in the container. 93 // 94 // Returns a new reference to the message for an integer parameter. 95 // Returns a new reference to a list of messages for a slice. 96 PyObject* Subscript(RepeatedCompositeContainer* self, PyObject* slice); 97 98 // Deletes items from the container (cannot be used for assignment). 99 // 100 // Returns 0 on success, -1 on failure. 101 int AssignSubscript(RepeatedCompositeContainer* self, 102 PyObject* slice, 103 PyObject* value); 104 } // namespace repeated_composite_container 105 } // namespace python 106 } // namespace protobuf 107 } // namespace google 108 109 #endif // GOOGLE_PROTOBUF_PYTHON_CPP_REPEATED_COMPOSITE_CONTAINER_H__ 110