• 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 PHP_PROTOBUF_CONVERT_H_
32 #define PHP_PROTOBUF_CONVERT_H_
33 
34 #include <php.h>
35 
36 #include "php-upb.h"
37 #include "def.h"
38 
39 upb_fieldtype_t pbphp_dtype_to_type(upb_descriptortype_t type);
40 
41 // Converts |php_val| to an int64_t. Returns false if the value cannot be
42 // converted.
43 bool Convert_PhpToInt64(const zval *php_val, int64_t *i64);
44 
45 // Converts |php_val| to a upb_msgval according to |type|. If type is
46 // UPB_TYPE_MESSAGE, then |desc| must be the Descriptor for this message type.
47 // If type is string, message, or bytes, then |arena| will be used to copy
48 // string data or fuse this arena to the given message's arena.
49 bool Convert_PhpToUpb(zval *php_val, upb_msgval *upb_val, upb_fieldtype_t type,
50                       const Descriptor *desc, upb_arena *arena);
51 
52 // Similar to Convert_PhpToUpb, but supports automatically wrapping the wrapper
53 // types if a primitive is specified:
54 //
55 //   5 -> Int64Wrapper(value=5)
56 //
57 // We currently allow this implicit conversion in initializers, but not for
58 // assignment.
59 bool Convert_PhpToUpbAutoWrap(zval *val, upb_msgval *upb_val,
60                               upb_fieldtype_t type, const Descriptor *desc,
61                               upb_arena *arena);
62 
63 // Converts |upb_val| to a PHP zval according to |type|. This may involve
64 // creating a PHP wrapper object. If type == UPB_TYPE_MESSAGE, then |desc| must
65 // be the Descriptor for this message type. Any newly created wrapper object
66 // will reference |arena|.
67 void Convert_UpbToPhp(upb_msgval upb_val, zval *php_val, upb_fieldtype_t type,
68                       const Descriptor *desc, zval *arena);
69 
70 // Registers the GPBUtil class.
71 void Convert_ModuleInit(void);
72 
73 #endif  // PHP_PROTOBUF_CONVERT_H_
74