upb/text/debug_string.h

0001 // Protocol Buffers - Google's data interchange format
0002 // Copyright 2024 Google LLC.  All rights reserved.
0003 //
0004 // Use of this source code is governed by a BSD-style
0005 // license that can be found in the LICENSE file or at
0006 // https://developers.google.com/open-source/licenses/bsd
0007
0008 #ifndef UPB_TEXT_ENCODE_DEBUG_H_
0009 #define UPB_TEXT_ENCODE_DEBUG_H_
0010
0011 #include <stddef.h>
0012
0013 #include "upb/message/message.h"
0014 #include "upb/mini_table/message.h"
0015 #include "upb/text/options.h"  // IWYU pragma: export
0016
0017 // Must be last.
0018 #include "upb/port/def.inc"
0019
0020 #ifdef __cplusplus
0021 extern "C" {
0022 #endif
0023
0024 /* Encodes the given |msg| to a pseudo-text format: Instead of printing field
0025  * name to value entries, it will print field number to value entries; much like
0026  * how unknown fields are printed in upb_TextEncode in this directory's
0027  * encode.h. |mt| should correspond to the |msg|'s minitable.
0028  *
0029  * Output is placed in the given buffer, and always NULL-terminated.  The output
0030  * size (excluding NULL) is returned.  This means that a return value >= |size|
0031  * implies that the output was truncated.  (These are the same semantics as
0032  * snprintf()). */
0033 UPB_API size_t upb_DebugString(const upb_Message* msg, const upb_MiniTable* mt,
0034                                int options, char* buf, size_t size);
0035
0036 #ifdef __cplusplus
0037 } /* extern "C" */
0038 #endif
0039
0040 #include "upb/port/undef.inc"
0041
0042 #endif /* UPB_TEXT_ENCODE_DEBUG_H_ */