You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

mini_table_accessors.h 12 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. /*
  2. * Copyright (c) 2009-2022, 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. #ifndef UPB_MINI_TABLE_ACCESSORS_H_
  28. #define UPB_MINI_TABLE_ACCESSORS_H_
  29. #include "upb/array.h"
  30. #include "upb/internal/mini_table_accessors.h"
  31. #include "upb/msg_internal.h"
  32. // Must be last.
  33. #include "upb/port_def.inc"
  34. #ifdef __cplusplus
  35. extern "C" {
  36. #endif
  37. bool upb_MiniTable_HasField(const upb_Message* msg,
  38. const upb_MiniTable_Field* field);
  39. void upb_MiniTable_ClearField(upb_Message* msg,
  40. const upb_MiniTable_Field* field);
  41. UPB_INLINE bool upb_MiniTable_GetBool(const upb_Message* msg,
  42. const upb_MiniTable_Field* field) {
  43. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Bool);
  44. return *UPB_PTR_AT(msg, field->offset, bool);
  45. }
  46. UPB_INLINE void upb_MiniTable_SetBool(upb_Message* msg,
  47. const upb_MiniTable_Field* field,
  48. bool value) {
  49. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Bool);
  50. _upb_MiniTable_SetPresence(msg, field);
  51. *UPB_PTR_AT(msg, field->offset, bool) = value;
  52. }
  53. UPB_INLINE int32_t upb_MiniTable_GetInt32(const upb_Message* msg,
  54. const upb_MiniTable_Field* field) {
  55. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Int32 ||
  56. field->descriptortype == kUpb_FieldType_SInt32 ||
  57. field->descriptortype == kUpb_FieldType_SFixed32);
  58. return *UPB_PTR_AT(msg, field->offset, int32_t);
  59. }
  60. UPB_INLINE void upb_MiniTable_SetInt32(upb_Message* msg,
  61. const upb_MiniTable_Field* field,
  62. int32_t value) {
  63. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Int32 ||
  64. field->descriptortype == kUpb_FieldType_SInt32 ||
  65. field->descriptortype == kUpb_FieldType_SFixed32);
  66. _upb_MiniTable_SetPresence(msg, field);
  67. *UPB_PTR_AT(msg, field->offset, int32_t) = value;
  68. }
  69. UPB_INLINE uint32_t upb_MiniTable_GetUInt32(const upb_Message* msg,
  70. const upb_MiniTable_Field* field) {
  71. UPB_ASSERT(field->descriptortype == kUpb_FieldType_UInt32 ||
  72. field->descriptortype == kUpb_FieldType_Fixed32);
  73. return *UPB_PTR_AT(msg, field->offset, uint32_t);
  74. }
  75. UPB_INLINE void upb_MiniTable_SetUInt32(upb_Message* msg,
  76. const upb_MiniTable_Field* field,
  77. uint32_t value) {
  78. UPB_ASSERT(field->descriptortype == kUpb_FieldType_UInt32 ||
  79. field->descriptortype == kUpb_FieldType_Fixed32);
  80. _upb_MiniTable_SetPresence(msg, field);
  81. *UPB_PTR_AT(msg, field->offset, uint32_t) = value;
  82. }
  83. UPB_INLINE int32_t upb_MiniTable_GetEnum(const upb_Message* msg,
  84. const upb_MiniTable_Field* field) {
  85. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Enum);
  86. return *UPB_PTR_AT(msg, field->offset, int32_t);
  87. }
  88. UPB_INLINE void upb_MiniTable_SetEnum(upb_Message* msg,
  89. const upb_MiniTable_Field* field,
  90. int32_t value) {
  91. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Enum);
  92. _upb_MiniTable_SetPresence(msg, field);
  93. *UPB_PTR_AT(msg, field->offset, int32_t) = value;
  94. }
  95. UPB_INLINE int64_t upb_MiniTable_GetInt64(const upb_Message* msg,
  96. const upb_MiniTable_Field* field) {
  97. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Int64 ||
  98. field->descriptortype == kUpb_FieldType_SInt64 ||
  99. field->descriptortype == kUpb_FieldType_SFixed64);
  100. return *UPB_PTR_AT(msg, field->offset, int64_t);
  101. }
  102. UPB_INLINE void upb_MiniTable_SetInt64(upb_Message* msg,
  103. const upb_MiniTable_Field* field,
  104. int64_t value) {
  105. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Int64 ||
  106. field->descriptortype == kUpb_FieldType_SInt64 ||
  107. field->descriptortype == kUpb_FieldType_SFixed64);
  108. _upb_MiniTable_SetPresence(msg, field);
  109. *UPB_PTR_AT(msg, field->offset, int64_t) = value;
  110. }
  111. UPB_INLINE uint64_t upb_MiniTable_GetUInt64(const upb_Message* msg,
  112. const upb_MiniTable_Field* field) {
  113. UPB_ASSERT(field->descriptortype == kUpb_FieldType_UInt64 ||
  114. field->descriptortype == kUpb_FieldType_Fixed64);
  115. return *UPB_PTR_AT(msg, field->offset, uint64_t);
  116. }
  117. UPB_INLINE void upb_MiniTable_SetUInt64(upb_Message* msg,
  118. const upb_MiniTable_Field* field,
  119. uint64_t value) {
  120. UPB_ASSERT(field->descriptortype == kUpb_FieldType_UInt64 ||
  121. field->descriptortype == kUpb_FieldType_Fixed64);
  122. _upb_MiniTable_SetPresence(msg, field);
  123. *UPB_PTR_AT(msg, field->offset, uint64_t) = value;
  124. }
  125. UPB_INLINE float upb_MiniTable_GetFloat(const upb_Message* msg,
  126. const upb_MiniTable_Field* field) {
  127. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Float);
  128. return *UPB_PTR_AT(msg, field->offset, float);
  129. }
  130. UPB_INLINE void upb_MiniTable_SetFloat(upb_Message* msg,
  131. const upb_MiniTable_Field* field,
  132. float value) {
  133. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Float);
  134. _upb_MiniTable_SetPresence(msg, field);
  135. *UPB_PTR_AT(msg, field->offset, float) = value;
  136. }
  137. UPB_INLINE double upb_MiniTable_GetDouble(const upb_Message* msg,
  138. const upb_MiniTable_Field* field) {
  139. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Double);
  140. return *UPB_PTR_AT(msg, field->offset, double);
  141. }
  142. UPB_INLINE void upb_MiniTable_SetDouble(upb_Message* msg,
  143. const upb_MiniTable_Field* field,
  144. double value) {
  145. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Double);
  146. _upb_MiniTable_SetPresence(msg, field);
  147. *UPB_PTR_AT(msg, field->offset, double) = value;
  148. }
  149. UPB_INLINE upb_StringView upb_MiniTable_GetString(
  150. const upb_Message* msg, const upb_MiniTable_Field* field) {
  151. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Bytes ||
  152. field->descriptortype == kUpb_FieldType_String);
  153. return *UPB_PTR_AT(msg, field->offset, upb_StringView);
  154. }
  155. UPB_INLINE void upb_MiniTable_SetString(upb_Message* msg,
  156. const upb_MiniTable_Field* field,
  157. upb_StringView value) {
  158. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Bytes ||
  159. field->descriptortype == kUpb_FieldType_String);
  160. _upb_MiniTable_SetPresence(msg, field);
  161. *UPB_PTR_AT(msg, field->offset, upb_StringView) = value;
  162. }
  163. UPB_INLINE const upb_Message* upb_MiniTable_GetMessage(
  164. const upb_Message* msg, const upb_MiniTable_Field* field) {
  165. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Message ||
  166. field->descriptortype == kUpb_FieldType_Group);
  167. return *UPB_PTR_AT(msg, field->offset, const upb_Message*);
  168. }
  169. UPB_INLINE void upb_MiniTable_SetMessage(upb_Message* msg,
  170. const upb_MiniTable_Field* field,
  171. upb_Message* sub_message) {
  172. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Message ||
  173. field->descriptortype == kUpb_FieldType_Group);
  174. _upb_MiniTable_SetPresence(msg, field);
  175. *UPB_PTR_AT(msg, field->offset, const upb_Message*) = sub_message;
  176. }
  177. UPB_INLINE upb_Message* upb_MiniTable_GetMutableMessage(
  178. upb_Message* msg, const upb_MiniTable* mini_table,
  179. const upb_MiniTable_Field* field, upb_Arena* arena) {
  180. UPB_ASSERT(field->descriptortype == kUpb_FieldType_Message ||
  181. field->descriptortype == kUpb_FieldType_Group);
  182. upb_Message* sub_message = *UPB_PTR_AT(msg, field->offset, upb_Message*);
  183. if (!sub_message) {
  184. sub_message =
  185. _upb_Message_New(mini_table->subs[field->submsg_index].submsg, arena);
  186. *UPB_PTR_AT(msg, field->offset, upb_Message*) = sub_message;
  187. _upb_MiniTable_SetPresence(msg, field);
  188. }
  189. return sub_message;
  190. }
  191. UPB_INLINE const upb_Array* upb_MiniTable_GetArray(
  192. const upb_Message* msg, const upb_MiniTable_Field* field) {
  193. return (const upb_Array*)*UPB_PTR_AT(msg, field->offset, upb_Array*);
  194. }
  195. UPB_INLINE upb_Array* upb_MiniTable_GetMutableArray(
  196. upb_Message* msg, const upb_MiniTable_Field* field) {
  197. return (upb_Array*)*UPB_PTR_AT(msg, field->offset, upb_Array*);
  198. }
  199. void* upb_MiniTable_ResizeArray(upb_Message* msg,
  200. const upb_MiniTable_Field* field, size_t len,
  201. upb_Arena* arena);
  202. typedef enum {
  203. kUpb_GetExtension_Ok,
  204. kUpb_GetExtension_NotPresent,
  205. kUpb_GetExtension_ParseError,
  206. kUpb_GetExtension_OutOfMemory,
  207. } upb_GetExtension_Status;
  208. typedef enum {
  209. kUpb_GetExtensionAsBytes_Ok,
  210. kUpb_GetExtensionAsBytes_NotPresent,
  211. kUpb_GetExtensionAsBytes_EncodeError,
  212. } upb_GetExtensionAsBytes_Status;
  213. // Returns a message extension or promotes an unknown field to
  214. // an extension.
  215. //
  216. // TODO(ferhat): Only supports extension fields that are messages,
  217. // expand support to include non-message types.
  218. upb_GetExtension_Status upb_MiniTable_GetOrPromoteExtension(
  219. upb_Message* msg, const upb_MiniTable_Extension* ext_table,
  220. int decode_options, upb_Arena* arena,
  221. const upb_Message_Extension** extension);
  222. // Returns a message extension or unknown field matching the extension
  223. // data as bytes.
  224. //
  225. // If an extension has already been decoded it will be re-encoded
  226. // to bytes.
  227. upb_GetExtensionAsBytes_Status upb_MiniTable_GetExtensionAsBytes(
  228. const upb_Message* msg, const upb_MiniTable_Extension* ext_table,
  229. int encode_options, upb_Arena* arena, const char** extension_data,
  230. size_t* len);
  231. #ifdef __cplusplus
  232. } /* extern "C" */
  233. #endif
  234. #include "upb/port_undef.inc"
  235. #endif // UPB_MINI_TABLE_ACCESSORS_H_