• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifndef GOOGLE_PROTOBUF_PYTHON_CPP_UNKNOWN_FIELDS_H__
32 #define GOOGLE_PROTOBUF_PYTHON_CPP_UNKNOWN_FIELDS_H__
33 
34 #include <Python.h>
35 
36 #include <memory>
37 #include <set>
38 
39 #include <google/protobuf/pyext/message.h>
40 
41 namespace google {
42 namespace protobuf {
43 
44 class UnknownField;
45 class UnknownFieldSet;
46 
47 namespace python {
48 struct CMessage;
49 
50 typedef struct PyUnknownFields {
51   PyObject_HEAD;
52   // Strong pointer to the parent CMessage or PyUnknownFields.
53   // The top PyUnknownFields holds a reference to its parent CMessage
54   // object before release.
55   // Sub PyUnknownFields holds reference to parent PyUnknownFields.
56   PyObject* parent;
57 
58   // Pointer to the C++ UnknownFieldSet.
59   // PyUnknownFields does not own this pointer.
60   const UnknownFieldSet* fields;
61 
62   // Weak references to child unknown fields.
63   std::set<PyUnknownFields*> sub_unknown_fields;
64 } PyUnknownFields;
65 
66 typedef struct PyUnknownFieldRef {
67   PyObject_HEAD;
68   // Every Python PyUnknownFieldRef holds a reference to its parent
69   // PyUnknownFields in order to keep it alive.
70   PyUnknownFields* parent;
71 
72   // The UnknownField index in UnknownFields.
73   Py_ssize_t index;
74 } UknownFieldRef;
75 
76 extern PyTypeObject PyUnknownFields_Type;
77 extern PyTypeObject PyUnknownFieldRef_Type;
78 
79 namespace unknown_fields {
80 
81 // Builds an PyUnknownFields for a specific message.
82 PyObject* NewPyUnknownFields(CMessage *parent);
83 void Clear(PyUnknownFields* self);
84 
85 }  // namespace unknown_fields
86 }  // namespace python
87 }  // namespace protobuf
88 }  // namespace google
89 
90 #endif  // GOOGLE_PROTOBUF_PYTHON_CPP_UNKNOWN_FIELDS_H__
91