Protocol Buffers - Google's data interchange format (grpc依赖)
https://developers.google.com/protocol-buffers/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
4.0 KiB
94 lines
4.0 KiB
/* |
|
* Copyright (c) 2009-2021, Google LLC |
|
* All rights reserved. |
|
* |
|
* Redistribution and use in source and binary forms, with or without |
|
* modification, are permitted provided that the following conditions are met: |
|
* * Redistributions of source code must retain the above copyright |
|
* notice, this list of conditions and the following disclaimer. |
|
* * Redistributions in binary form must reproduce the above copyright |
|
* notice, this list of conditions and the following disclaimer in the |
|
* documentation and/or other materials provided with the distribution. |
|
* * Neither the name of Google LLC nor the |
|
* names of its contributors may be used to endorse or promote products |
|
* derived from this software without specific prior written permission. |
|
* |
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
* ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT, |
|
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
*/ |
|
|
|
#ifndef UPB_UTIL_REQUIRED_FIELDS_H_ |
|
#define UPB_UTIL_REQUIRED_FIELDS_H_ |
|
|
|
#include "upb/def.h" |
|
#include "upb/reflection.h" |
|
|
|
/* Must be last. */ |
|
#include "upb/port_def.inc" |
|
|
|
#ifdef __cplusplus |
|
extern "C" { |
|
#endif |
|
|
|
// A FieldPath can be encoded as an array of upb_FieldPathEntry, in the |
|
// following format: |
|
// { {.field = f1}, {.field = f2} } # f1.f2 |
|
// { {.field = f1}, {.index = 5}, {.field = f2} } # f1[5].f2 |
|
// { {.field = f1}, {.key = "abc"}, {.field = f2} } # f1["abc"].f2 |
|
// |
|
// Users must look at the type of `field` to know if an index or map key |
|
// follows. |
|
// |
|
// A field path may be NULL-terminated, in which case a NULL field indicates |
|
// the end of the field path. |
|
typedef union { |
|
const upb_FieldDef* field; |
|
size_t array_index; |
|
upb_MessageValue map_key; |
|
} upb_FieldPathEntry; |
|
|
|
// Writes a string representing `*path` to `buf` in the following textual |
|
// format: |
|
// foo.bar # Regular fields |
|
// repeated_baz[2].bar # Repeated field |
|
// int32_msg_map[5].bar # Integer-keyed map |
|
// string_msg_map["abc"] # String-keyed map |
|
// bool_msg_map[true] # Bool-keyed map |
|
// |
|
// The input array `*path` must be NULL-terminated. The pointer `*path` will be |
|
// updated to point to one past the terminating NULL pointer of the input array. |
|
// |
|
// The output buffer `buf` will always be NULL-terminated. If the output data |
|
// (including NULL terminator) exceeds `size`, the result will be truncated. |
|
// Returns the string length of the data we attempted to write, excluding the |
|
// terminating NULL. |
|
size_t upb_FieldPath_ToText(upb_FieldPathEntry** path, char* buf, size_t size); |
|
|
|
// Checks whether `msg` or any of its children has unset required fields, |
|
// returning `true` if any are found. `msg` may be NULL, in which case the |
|
// message will be treated as empty. |
|
// |
|
// When this function returns true, `fields` is updated (if non-NULL) to point |
|
// to a heap-allocated array encoding the field paths of the required fields |
|
// that are missing. Each path is terminated with {.field = NULL}, and a final |
|
// {.field = NULL} terminates the list of paths. The caller is responsible for |
|
// freeing this array. |
|
bool upb_util_HasUnsetRequired(const upb_msg* msg, const upb_MessageDef* m, |
|
const upb_DefPool* ext_pool, |
|
upb_FieldPathEntry** fields); |
|
|
|
#ifdef __cplusplus |
|
} /* extern "C" */ |
|
#endif |
|
|
|
#include "upb/port_undef.inc" |
|
|
|
#endif /* UPB_UTIL_REQUIRED_FIELDS_H_ */
|
|
|