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 (at) google.com (Anuraag Agrawal) 32 // Author: tibell (at) google.com (Johan Tibell) 33 34 #ifndef GOOGLE_PROTOBUF_PYTHON_CPP_EXTENSION_DICT_H__ 35 #define GOOGLE_PROTOBUF_PYTHON_CPP_EXTENSION_DICT_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 namespace google { 45 namespace protobuf { 46 47 class Message; 48 class FieldDescriptor; 49 50 #ifdef _SHARED_PTR_H 51 using std::shared_ptr; 52 #else 53 using internal::shared_ptr; 54 #endif 55 56 namespace python { 57 58 struct CMessage; 59 60 typedef struct ExtensionDict { 61 PyObject_HEAD; 62 63 // This is the top-level C++ Message object that owns the whole 64 // proto tree. Every Python container class holds a 65 // reference to it in order to keep it alive as long as there's a 66 // Python object that references any part of the tree. 67 shared_ptr<Message> owner; 68 69 // Weak reference to parent message. Used to make sure 70 // the parent is writable when an extension field is modified. 71 CMessage* parent; 72 73 // Pointer to the C++ Message that this ExtensionDict extends. 74 // Not owned by us. 75 Message* message; 76 77 // A dict of child messages, indexed by Extension descriptors. 78 // Similar to CMessage::composite_fields. 79 PyObject* values; 80 } ExtensionDict; 81 82 extern PyTypeObject ExtensionDict_Type; 83 84 namespace extension_dict { 85 86 // Builds an Extensions dict for a specific message. 87 ExtensionDict* NewExtensionDict(CMessage *parent); 88 89 // Gets the number of extension values in this ExtensionDict as a python object. 90 // 91 // Returns a new reference. 92 PyObject* len(ExtensionDict* self); 93 94 // Releases extensions referenced outside this dictionary to keep outside 95 // references alive. 96 // 97 // Returns 0 on success, -1 on failure. 98 int ReleaseExtension(ExtensionDict* self, 99 PyObject* extension, 100 const FieldDescriptor* descriptor); 101 102 // Gets an extension from the dict for the given extension descriptor. 103 // 104 // Returns a new reference. 105 PyObject* subscript(ExtensionDict* self, PyObject* key); 106 107 // Assigns a value to an extension in the dict. Can only be used for singular 108 // simple types. 109 // 110 // Returns 0 on success, -1 on failure. 111 int ass_subscript(ExtensionDict* self, PyObject* key, PyObject* value); 112 113 // Clears an extension from the dict. Will release the extension if there 114 // is still an external reference left to it. 115 // 116 // Returns None on success. 117 PyObject* ClearExtension(ExtensionDict* self, 118 PyObject* extension); 119 120 // Gets an extension from the dict given the extension name as opposed to 121 // descriptor. 122 // 123 // Returns a new reference. 124 PyObject* _FindExtensionByName(ExtensionDict* self, PyObject* name); 125 126 // Gets an extension from the dict given the extension field number as 127 // opposed to descriptor. 128 // 129 // Returns a new reference. 130 PyObject* _FindExtensionByNumber(ExtensionDict* self, PyObject* number); 131 132 } // namespace extension_dict 133 } // namespace python 134 } // namespace protobuf 135 136 } // namespace google 137 #endif // GOOGLE_PROTOBUF_PYTHON_CPP_EXTENSION_DICT_H__ 138
