1 /*
2  * Copyright (c) 2009-2021, Google LLC
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Google LLC nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT,
20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef UPB_JSON_ENCODE_H_
29 #define UPB_JSON_ENCODE_H_
30 
31 #include "upb/reflection/def.h"
32 
33 // Must be last.
34 #include "upb/port/def.inc"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 enum {
41   /* When set, emits 0/default values.  TODO(haberman): proto3 only? */
42   upb_JsonEncode_EmitDefaults = 1 << 0,
43 
44   /* When set, use normal (snake_case) field names instead of JSON (camelCase)
45      names. */
46   upb_JsonEncode_UseProtoNames = 1 << 1,
47 
48   /* When set, emits enums as their integer values instead of as their names. */
49   upb_JsonEncode_FormatEnumsAsIntegers = 1 << 2
50 };
51 
52 /* Encodes the given |msg| to JSON format.  The message's reflection is given in
53  * |m|.  The symtab in |symtab| is used to find extensions (if NULL, extensions
54  * will not be printed).
55  *
56  * Output is placed in the given buffer, and always NULL-terminated.  The output
57  * size (excluding NULL) is returned.  This means that a return value >= |size|
58  * implies that the output was truncated.  (These are the same semantics as
59  * snprintf()). */
60 size_t upb_JsonEncode(const upb_Message* msg, const upb_MessageDef* m,
61                       const upb_DefPool* ext_pool, int options, char* buf,
62                       size_t size, upb_Status* status);
63 
64 #ifdef __cplusplus
65 } /* extern "C" */
66 #endif
67 
68 #include "upb/port/undef.inc"
69 
70 #endif /* UPB_JSONENCODE_H_ */
71