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_MESSAGE_H_ 32 #define PHP_PROTOBUF_MESSAGE_H_ 33 34 #include <stdbool.h> 35 36 #include "def.h" 37 38 // Registers the PHP Message class. 39 void Message_ModuleInit(); 40 41 // Gets a upb_msg* for the PHP object |val|, which must either be a Message 42 // object or 'null'. Returns true and stores the message in |msg| if the 43 // conversion succeeded (we can't return upb_msg* because null->NULL is a valid 44 // conversion). Returns false and raises a PHP error if this isn't a Message 45 // object or null, or if the Message object doesn't match this Descriptor. 46 // 47 // The given |arena| will be fused to this message's arena. 48 bool Message_GetUpbMessage(zval *val, const Descriptor *desc, upb_arena *arena, 49 upb_msg **msg); 50 51 // Gets or creates a PHP Message object to wrap the given upb_msg* and |desc| 52 // and returns it in |val|. The PHP object will keep a reference to this |arena| 53 // to ensure the underlying message data stays alive. 54 // 55 // If |msg| is NULL, this will return a PHP null. 56 void Message_GetPhpWrapper(zval *val, const Descriptor *desc, upb_msg *msg, 57 zval *arena); 58 59 bool ValueEq(upb_msgval val1, upb_msgval val2, TypeInfo type); 60 61 #endif // PHP_PROTOBUF_MESSAGE_H_ 62