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_SCALAR_CONTAINER_H__
35#define GOOGLE_PROTOBUF_PYTHON_CPP_REPEATED_SCALAR_CONTAINER_H__
36
37#include <Python.h>
38
39#include <memory>
40#ifndef _SHARED_PTR_H
41#include <google/protobuf/stubs/shared_ptr.h>
42#endif
43
44#include <google/protobuf/descriptor.h>
45
46namespace google {
47namespace protobuf {
48
49class Message;
50
51#ifdef _SHARED_PTR_H
52using std::shared_ptr;
53#else
54using internal::shared_ptr;
55#endif
56
57namespace python {
58
59struct CMessage;
60
61typedef struct RepeatedScalarContainer {
62  PyObject_HEAD;
63
64  // This is the top-level C++ Message object that owns the whole
65  // proto tree.  Every Python RepeatedScalarContainer holds a
66  // reference to it in order to keep it alive as long as there's a
67  // Python object that references any part of the tree.
68  shared_ptr<Message> owner;
69
70  // Pointer to the C++ Message that contains this container.  The
71  // RepeatedScalarContainer does not own this pointer.
72  Message* message;
73
74  // Weak reference to a parent CMessage object (i.e. may be NULL.)
75  //
76  // Used to make sure all ancestors are also mutable when first
77  // modifying the container.
78  CMessage* parent;
79
80  // Pointer to the parent's descriptor that describes this
81  // field.  Used together with the parent's message when making a
82  // default message instance mutable.
83  // The pointer is owned by the global DescriptorPool.
84  const FieldDescriptor* parent_field_descriptor;
85} RepeatedScalarContainer;
86
87extern PyTypeObject RepeatedScalarContainer_Type;
88
89namespace repeated_scalar_container {
90
91// Builds a RepeatedScalarContainer object, from a parent message and a
92// field descriptor.
93extern PyObject *NewContainer(
94    CMessage* parent, const FieldDescriptor* parent_field_descriptor);
95
96// Appends the scalar 'item' to the end of the container 'self'.
97//
98// Returns None if successful; returns NULL and sets an exception if
99// unsuccessful.
100PyObject* Append(RepeatedScalarContainer* self, PyObject* item);
101
102// Releases the messages in the container to a new message.
103//
104// Returns 0 on success, -1 on failure.
105int Release(RepeatedScalarContainer* self);
106
107// Appends all the elements in the input iterator to the container.
108//
109// Returns None if successful; returns NULL and sets an exception if
110// unsuccessful.
111PyObject* Extend(RepeatedScalarContainer* self, PyObject* value);
112
113// Set the owner field of self and any children of self.
114void SetOwner(RepeatedScalarContainer* self,
115              const shared_ptr<Message>& new_owner);
116
117}  // namespace repeated_scalar_container
118}  // namespace python
119}  // namespace protobuf
120
121}  // namespace google
122#endif  // GOOGLE_PROTOBUF_PYTHON_CPP_REPEATED_SCALAR_CONTAINER_H__
123