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 PHP_PROTOBUF_DEF_H_ 32 #define PHP_PROTOBUF_DEF_H_ 33 34 #include <php.h> 35 36 #include "php-upb.h" 37 38 // Initializes the Def module, which defines all of the descriptor classes. 39 void Def_ModuleInit(); 40 41 // Creates a new DescriptorPool to wrap the given symtab. The DescriptorPool 42 // takes ownership of the given symtab. If symtab is NULL, the DescriptorPool 43 // will create an empty symtab instead. 44 void DescriptorPool_CreateWithSymbolTable(zval *zv, upb_symtab *symtab); 45 46 // Given a zval representing a DescriptorPool, steals and returns its symtab, 47 // which is now owned by the caller. 48 upb_symtab *DescriptorPool_Steal(zval *zv); 49 50 upb_symtab *DescriptorPool_GetSymbolTable(); 51 52 // Returns true if the global descriptor pool already has the given filename. 53 bool DescriptorPool_HasFile(const char *filename); 54 55 // Adds the given descriptor with the given filename to the global pool. 56 void DescriptorPool_AddDescriptor(const char *filename, const char *data, int size); 57 58 typedef struct Descriptor { 59 zend_object std; 60 const upb_msgdef *msgdef; 61 zend_class_entry *class_entry; 62 } Descriptor; 63 64 // Gets or creates a PHP Descriptor object for a |ce| and stores it in |val|. 65 // If this is not a protobuf generated class, |val| will be set to null. 66 void Descriptor_FromClassEntry(zval *val, zend_class_entry *ce); 67 68 // Gets or creates a Descriptor* for the given class entry, upb_msgdef, or 69 // upb_fielddef. The returned Descriptor* will live for the entire request, 70 // so no ref is necessary to keep it alive. 71 Descriptor* Descriptor_GetFromClassEntry(zend_class_entry *ce); 72 Descriptor* Descriptor_GetFromMessageDef(const upb_msgdef *m); 73 Descriptor* Descriptor_GetFromFieldDef(const upb_fielddef *f); 74 75 #endif // PHP_PROTOBUF_DEF_H_ 76