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_MESSAGE_FACTORY_H__ 32 #define GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_FACTORY_H__ 33 34 #define PY_SSIZE_T_CLEAN 35 #include <Python.h> 36 37 #include <unordered_map> 38 #include <google/protobuf/descriptor.h> 39 #include <google/protobuf/pyext/descriptor_pool.h> 40 41 namespace google { 42 namespace protobuf { 43 class MessageFactory; 44 45 namespace python { 46 47 // The (meta) type of all Messages classes. 48 struct CMessageClass; 49 50 struct PyMessageFactory { 51 PyObject_HEAD 52 53 // DynamicMessageFactory used to create C++ instances of messages. 54 // This object cache the descriptors that were used, so the DescriptorPool 55 // needs to get rid of it before it can delete itself. 56 // 57 // Note: A C++ MessageFactory is different from the PyMessageFactory. 58 // The C++ one creates messages, when the Python one creates classes. 59 MessageFactory* message_factory; 60 61 // Owned reference to a Python DescriptorPool. 62 // This reference must stay until the message_factory is destructed. 63 PyDescriptorPool* pool; 64 65 // Make our own mapping to retrieve Python classes from C++ descriptors. 66 // 67 // Descriptor pointers stored here are owned by the DescriptorPool above. 68 // Python references to classes are owned by this PyDescriptorPool. 69 typedef std::unordered_map<const Descriptor*, CMessageClass*> 70 ClassesByMessageMap; 71 ClassesByMessageMap* classes_by_descriptor; 72 }; 73 74 extern PyTypeObject PyMessageFactory_Type; 75 76 namespace message_factory { 77 78 // Creates a new MessageFactory instance. 79 PyMessageFactory* NewMessageFactory(PyTypeObject* type, PyDescriptorPool* pool); 80 81 // Registers a new Python class for the given message descriptor. 82 // On error, returns -1 with a Python exception set. 83 int RegisterMessageClass(PyMessageFactory* self, 84 const Descriptor* message_descriptor, 85 CMessageClass* message_class); 86 // Retrieves the Python class registered with the given message descriptor, or 87 // fail with a TypeError. Returns a *borrowed* reference. 88 CMessageClass* GetMessageClass(PyMessageFactory* self, 89 const Descriptor* message_descriptor); 90 // Retrieves the Python class registered with the given message descriptor. 91 // The class is created if not done yet. Returns a *new* reference. 92 CMessageClass* GetOrCreateMessageClass(PyMessageFactory* self, 93 const Descriptor* message_descriptor); 94 } // namespace message_factory 95 96 // Initialize objects used by this module. 97 // On error, returns false with a Python exception set. 98 bool InitMessageFactory(); 99 100 } // namespace python 101 } // namespace protobuf 102 } // namespace google 103 104 #endif // GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_FACTORY_H__ 105