• 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_MAP_H_
32 #define PHP_PROTOBUF_MAP_H_
33 
34 #include <php.h>
35 
36 #include "php-upb.h"
37 
38 void Map_ModuleInit();
39 
40 // Gets a upb_map* for the PHP object |val|:
41 //  * If |val| is a RepeatedField object, we first check its type and verify
42 //    that that the elements have the correct type for |f|. If so, we return the
43 //    wrapped upb_map*. We also make sure that this map's arena is fused to
44 //    |arena|, so the returned upb_map is guaranteed to live as long as
45 //    |arena|.
46 //  * If |val| is a PHP Map, we attempt to create a new upb_map using
47 //    |arena| and add all of the PHP elements to it.
48 //
49 // If an error occurs, we raise a PHP error and return NULL.
50 upb_map *MapField_GetUpbMap(zval *val, const upb_fielddef *f, upb_arena *arena);
51 
52 // Creates a PHP MapField object for the given upb_map* and |f| and returns it
53 // in |val|. The PHP object will keep a reference to this |arena| to ensure the
54 // underlying array data stays alive.
55 //
56 // If |map| is NULL, this will return a PHP null object.
57 void MapField_GetPhpWrapper(zval *val, upb_map *arr, const upb_fielddef *f,
58                             zval *arena);
59 
60 bool MapEq(const upb_map *m1, const upb_map *m2, upb_fieldtype_t key_type,
61            upb_fieldtype_t val_type, const upb_msgdef *m);
62 
63 #endif  // PHP_PROTOBUF_MAP_H_
64