gitlab-pg_query 1.3.1 → 2.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (480) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +217 -99
  3. data/README.md +92 -69
  4. data/Rakefile +85 -5
  5. data/ext/pg_query/extconf.rb +3 -40
  6. data/ext/pg_query/guc-file.c +0 -0
  7. data/ext/pg_query/include/access/amapi.h +246 -0
  8. data/ext/pg_query/include/access/attmap.h +52 -0
  9. data/ext/pg_query/include/access/attnum.h +64 -0
  10. data/ext/pg_query/include/access/clog.h +61 -0
  11. data/ext/pg_query/include/access/commit_ts.h +77 -0
  12. data/ext/pg_query/include/access/detoast.h +92 -0
  13. data/ext/pg_query/include/access/genam.h +228 -0
  14. data/ext/pg_query/include/access/gin.h +78 -0
  15. data/ext/pg_query/include/access/htup.h +89 -0
  16. data/ext/pg_query/include/access/htup_details.h +819 -0
  17. data/ext/pg_query/include/access/itup.h +161 -0
  18. data/ext/pg_query/include/access/parallel.h +82 -0
  19. data/ext/pg_query/include/access/printtup.h +35 -0
  20. data/ext/pg_query/include/access/relation.h +28 -0
  21. data/ext/pg_query/include/access/relscan.h +176 -0
  22. data/ext/pg_query/include/access/rmgr.h +35 -0
  23. data/ext/pg_query/include/access/rmgrlist.h +49 -0
  24. data/ext/pg_query/include/access/sdir.h +58 -0
  25. data/ext/pg_query/include/access/skey.h +151 -0
  26. data/ext/pg_query/include/access/stratnum.h +83 -0
  27. data/ext/pg_query/include/access/sysattr.h +29 -0
  28. data/ext/pg_query/include/access/table.h +27 -0
  29. data/ext/pg_query/include/access/tableam.h +1825 -0
  30. data/ext/pg_query/include/access/transam.h +265 -0
  31. data/ext/pg_query/include/access/tupconvert.h +51 -0
  32. data/ext/pg_query/include/access/tupdesc.h +154 -0
  33. data/ext/pg_query/include/access/tupmacs.h +247 -0
  34. data/ext/pg_query/include/access/twophase.h +61 -0
  35. data/ext/pg_query/include/access/xact.h +463 -0
  36. data/ext/pg_query/include/access/xlog.h +398 -0
  37. data/ext/pg_query/include/access/xlog_internal.h +330 -0
  38. data/ext/pg_query/include/access/xlogdefs.h +109 -0
  39. data/ext/pg_query/include/access/xloginsert.h +64 -0
  40. data/ext/pg_query/include/access/xlogreader.h +327 -0
  41. data/ext/pg_query/include/access/xlogrecord.h +227 -0
  42. data/ext/pg_query/include/bootstrap/bootstrap.h +62 -0
  43. data/ext/pg_query/include/c.h +1322 -0
  44. data/ext/pg_query/include/catalog/catalog.h +42 -0
  45. data/ext/pg_query/include/catalog/catversion.h +58 -0
  46. data/ext/pg_query/include/catalog/dependency.h +275 -0
  47. data/ext/pg_query/include/catalog/genbki.h +64 -0
  48. data/ext/pg_query/include/catalog/index.h +199 -0
  49. data/ext/pg_query/include/catalog/indexing.h +366 -0
  50. data/ext/pg_query/include/catalog/namespace.h +188 -0
  51. data/ext/pg_query/include/catalog/objectaccess.h +197 -0
  52. data/ext/pg_query/include/catalog/objectaddress.h +84 -0
  53. data/ext/pg_query/include/catalog/pg_aggregate.h +176 -0
  54. data/ext/pg_query/include/catalog/pg_aggregate_d.h +77 -0
  55. data/ext/pg_query/include/catalog/pg_am.h +60 -0
  56. data/ext/pg_query/include/catalog/pg_am_d.h +45 -0
  57. data/ext/pg_query/include/catalog/pg_attribute.h +204 -0
  58. data/ext/pg_query/include/catalog/pg_attribute_d.h +59 -0
  59. data/ext/pg_query/include/catalog/pg_authid.h +58 -0
  60. data/ext/pg_query/include/catalog/pg_authid_d.h +49 -0
  61. data/ext/pg_query/include/catalog/pg_class.h +200 -0
  62. data/ext/pg_query/include/catalog/pg_class_d.h +103 -0
  63. data/ext/pg_query/include/catalog/pg_collation.h +73 -0
  64. data/ext/pg_query/include/catalog/pg_collation_d.h +45 -0
  65. data/ext/pg_query/include/catalog/pg_constraint.h +247 -0
  66. data/ext/pg_query/include/catalog/pg_constraint_d.h +67 -0
  67. data/ext/pg_query/include/catalog/pg_control.h +250 -0
  68. data/ext/pg_query/include/catalog/pg_conversion.h +72 -0
  69. data/ext/pg_query/include/catalog/pg_conversion_d.h +35 -0
  70. data/ext/pg_query/include/catalog/pg_depend.h +73 -0
  71. data/ext/pg_query/include/catalog/pg_depend_d.h +34 -0
  72. data/ext/pg_query/include/catalog/pg_event_trigger.h +51 -0
  73. data/ext/pg_query/include/catalog/pg_event_trigger_d.h +34 -0
  74. data/ext/pg_query/include/catalog/pg_index.h +80 -0
  75. data/ext/pg_query/include/catalog/pg_index_d.h +56 -0
  76. data/ext/pg_query/include/catalog/pg_language.h +67 -0
  77. data/ext/pg_query/include/catalog/pg_language_d.h +39 -0
  78. data/ext/pg_query/include/catalog/pg_namespace.h +59 -0
  79. data/ext/pg_query/include/catalog/pg_namespace_d.h +34 -0
  80. data/ext/pg_query/include/catalog/pg_opclass.h +85 -0
  81. data/ext/pg_query/include/catalog/pg_opclass_d.h +49 -0
  82. data/ext/pg_query/include/catalog/pg_operator.h +102 -0
  83. data/ext/pg_query/include/catalog/pg_operator_d.h +106 -0
  84. data/ext/pg_query/include/catalog/pg_opfamily.h +60 -0
  85. data/ext/pg_query/include/catalog/pg_opfamily_d.h +47 -0
  86. data/ext/pg_query/include/catalog/pg_partitioned_table.h +63 -0
  87. data/ext/pg_query/include/catalog/pg_partitioned_table_d.h +35 -0
  88. data/ext/pg_query/include/catalog/pg_proc.h +211 -0
  89. data/ext/pg_query/include/catalog/pg_proc_d.h +99 -0
  90. data/ext/pg_query/include/catalog/pg_publication.h +115 -0
  91. data/ext/pg_query/include/catalog/pg_publication_d.h +36 -0
  92. data/ext/pg_query/include/catalog/pg_replication_origin.h +57 -0
  93. data/ext/pg_query/include/catalog/pg_replication_origin_d.h +29 -0
  94. data/ext/pg_query/include/catalog/pg_statistic.h +275 -0
  95. data/ext/pg_query/include/catalog/pg_statistic_d.h +194 -0
  96. data/ext/pg_query/include/catalog/pg_statistic_ext.h +74 -0
  97. data/ext/pg_query/include/catalog/pg_statistic_ext_d.h +40 -0
  98. data/ext/pg_query/include/catalog/pg_transform.h +45 -0
  99. data/ext/pg_query/include/catalog/pg_transform_d.h +32 -0
  100. data/ext/pg_query/include/catalog/pg_trigger.h +137 -0
  101. data/ext/pg_query/include/catalog/pg_trigger_d.h +106 -0
  102. data/ext/pg_query/include/catalog/pg_ts_config.h +50 -0
  103. data/ext/pg_query/include/catalog/pg_ts_config_d.h +32 -0
  104. data/ext/pg_query/include/catalog/pg_ts_dict.h +54 -0
  105. data/ext/pg_query/include/catalog/pg_ts_dict_d.h +33 -0
  106. data/ext/pg_query/include/catalog/pg_ts_parser.h +57 -0
  107. data/ext/pg_query/include/catalog/pg_ts_parser_d.h +35 -0
  108. data/ext/pg_query/include/catalog/pg_ts_template.h +48 -0
  109. data/ext/pg_query/include/catalog/pg_ts_template_d.h +32 -0
  110. data/ext/pg_query/include/catalog/pg_type.h +372 -0
  111. data/ext/pg_query/include/catalog/pg_type_d.h +285 -0
  112. data/ext/pg_query/include/catalog/storage.h +48 -0
  113. data/ext/pg_query/include/commands/async.h +54 -0
  114. data/ext/pg_query/include/commands/dbcommands.h +35 -0
  115. data/ext/pg_query/include/commands/defrem.h +173 -0
  116. data/ext/pg_query/include/commands/event_trigger.h +88 -0
  117. data/ext/pg_query/include/commands/explain.h +127 -0
  118. data/ext/pg_query/include/commands/prepare.h +61 -0
  119. data/ext/pg_query/include/commands/tablespace.h +67 -0
  120. data/ext/pg_query/include/commands/trigger.h +277 -0
  121. data/ext/pg_query/include/commands/user.h +37 -0
  122. data/ext/pg_query/include/commands/vacuum.h +293 -0
  123. data/ext/pg_query/include/commands/variable.h +38 -0
  124. data/ext/pg_query/include/common/file_perm.h +56 -0
  125. data/ext/pg_query/include/common/hashfn.h +104 -0
  126. data/ext/pg_query/include/common/ip.h +37 -0
  127. data/ext/pg_query/include/common/keywords.h +33 -0
  128. data/ext/pg_query/include/common/kwlookup.h +44 -0
  129. data/ext/pg_query/include/common/relpath.h +90 -0
  130. data/ext/pg_query/include/common/string.h +19 -0
  131. data/ext/pg_query/include/common/unicode_combining_table.h +196 -0
  132. data/ext/pg_query/include/datatype/timestamp.h +197 -0
  133. data/ext/pg_query/include/executor/execdesc.h +70 -0
  134. data/ext/pg_query/include/executor/executor.h +614 -0
  135. data/ext/pg_query/include/executor/functions.h +41 -0
  136. data/ext/pg_query/include/executor/instrument.h +101 -0
  137. data/ext/pg_query/include/executor/spi.h +175 -0
  138. data/ext/pg_query/include/executor/tablefunc.h +67 -0
  139. data/ext/pg_query/include/executor/tuptable.h +487 -0
  140. data/ext/pg_query/include/fmgr.h +775 -0
  141. data/ext/pg_query/include/funcapi.h +348 -0
  142. data/ext/pg_query/include/getaddrinfo.h +162 -0
  143. data/ext/pg_query/include/jit/jit.h +105 -0
  144. data/ext/pg_query/include/kwlist_d.h +1072 -0
  145. data/ext/pg_query/include/lib/ilist.h +727 -0
  146. data/ext/pg_query/include/lib/pairingheap.h +102 -0
  147. data/ext/pg_query/include/lib/simplehash.h +1059 -0
  148. data/ext/pg_query/include/lib/stringinfo.h +161 -0
  149. data/ext/pg_query/include/libpq/auth.h +29 -0
  150. data/ext/pg_query/include/libpq/crypt.h +46 -0
  151. data/ext/pg_query/include/libpq/hba.h +140 -0
  152. data/ext/pg_query/include/libpq/libpq-be.h +326 -0
  153. data/ext/pg_query/include/libpq/libpq.h +133 -0
  154. data/ext/pg_query/include/libpq/pqcomm.h +208 -0
  155. data/ext/pg_query/include/libpq/pqformat.h +210 -0
  156. data/ext/pg_query/include/libpq/pqsignal.h +42 -0
  157. data/ext/pg_query/include/mb/pg_wchar.h +672 -0
  158. data/ext/pg_query/include/mb/stringinfo_mb.h +24 -0
  159. data/ext/pg_query/include/miscadmin.h +476 -0
  160. data/ext/pg_query/include/nodes/bitmapset.h +122 -0
  161. data/ext/pg_query/include/nodes/execnodes.h +2520 -0
  162. data/ext/pg_query/include/nodes/extensible.h +160 -0
  163. data/ext/pg_query/include/nodes/lockoptions.h +61 -0
  164. data/ext/pg_query/include/nodes/makefuncs.h +108 -0
  165. data/ext/pg_query/include/nodes/memnodes.h +108 -0
  166. data/ext/pg_query/include/nodes/nodeFuncs.h +162 -0
  167. data/ext/pg_query/include/nodes/nodes.h +842 -0
  168. data/ext/pg_query/include/nodes/params.h +170 -0
  169. data/ext/pg_query/include/nodes/parsenodes.h +3579 -0
  170. data/ext/pg_query/include/nodes/pathnodes.h +2556 -0
  171. data/ext/pg_query/include/nodes/pg_list.h +605 -0
  172. data/ext/pg_query/include/nodes/plannodes.h +1251 -0
  173. data/ext/pg_query/include/nodes/primnodes.h +1541 -0
  174. data/ext/pg_query/include/nodes/print.h +34 -0
  175. data/ext/pg_query/include/nodes/tidbitmap.h +75 -0
  176. data/ext/pg_query/include/nodes/value.h +61 -0
  177. data/ext/pg_query/include/optimizer/cost.h +206 -0
  178. data/ext/pg_query/include/optimizer/geqo.h +88 -0
  179. data/ext/pg_query/include/optimizer/geqo_gene.h +45 -0
  180. data/ext/pg_query/include/optimizer/optimizer.h +199 -0
  181. data/ext/pg_query/include/optimizer/paths.h +249 -0
  182. data/ext/pg_query/include/optimizer/planmain.h +119 -0
  183. data/ext/pg_query/include/parser/analyze.h +49 -0
  184. data/ext/pg_query/include/parser/gram.h +1067 -0
  185. data/ext/pg_query/include/parser/gramparse.h +75 -0
  186. data/ext/pg_query/include/parser/kwlist.h +477 -0
  187. data/ext/pg_query/include/parser/parse_agg.h +68 -0
  188. data/ext/pg_query/include/parser/parse_clause.h +54 -0
  189. data/ext/pg_query/include/parser/parse_coerce.h +97 -0
  190. data/ext/pg_query/include/parser/parse_collate.h +27 -0
  191. data/ext/pg_query/include/parser/parse_expr.h +26 -0
  192. data/ext/pg_query/include/parser/parse_func.h +73 -0
  193. data/ext/pg_query/include/parser/parse_node.h +327 -0
  194. data/ext/pg_query/include/parser/parse_oper.h +67 -0
  195. data/ext/pg_query/include/parser/parse_relation.h +123 -0
  196. data/ext/pg_query/include/parser/parse_target.h +46 -0
  197. data/ext/pg_query/include/parser/parse_type.h +60 -0
  198. data/ext/pg_query/include/parser/parser.h +41 -0
  199. data/ext/pg_query/include/parser/parsetree.h +61 -0
  200. data/ext/pg_query/include/parser/scanner.h +152 -0
  201. data/ext/pg_query/include/parser/scansup.h +30 -0
  202. data/ext/pg_query/include/partitioning/partdefs.h +26 -0
  203. data/ext/pg_query/include/pg_config.h +989 -0
  204. data/ext/pg_query/include/pg_config_ext.h +8 -0
  205. data/ext/pg_query/include/pg_config_manual.h +350 -0
  206. data/ext/pg_query/include/pg_config_os.h +8 -0
  207. data/ext/pg_query/include/pg_getopt.h +56 -0
  208. data/ext/pg_query/include/pg_query.h +121 -0
  209. data/ext/pg_query/include/pg_query_enum_defs.c +2454 -0
  210. data/ext/pg_query/include/pg_query_fingerprint_conds.c +875 -0
  211. data/ext/pg_query/include/pg_query_fingerprint_defs.c +12413 -0
  212. data/ext/pg_query/include/pg_query_json_helper.c +61 -0
  213. data/ext/pg_query/include/pg_query_outfuncs_conds.c +686 -0
  214. data/ext/pg_query/include/pg_query_outfuncs_defs.c +2437 -0
  215. data/ext/pg_query/include/pg_query_readfuncs_conds.c +222 -0
  216. data/ext/pg_query/include/pg_query_readfuncs_defs.c +2878 -0
  217. data/ext/pg_query/include/pg_trace.h +17 -0
  218. data/ext/pg_query/include/pgstat.h +1487 -0
  219. data/ext/pg_query/include/pgtime.h +84 -0
  220. data/ext/pg_query/include/pl_gram.h +385 -0
  221. data/ext/pg_query/include/pl_reserved_kwlist.h +52 -0
  222. data/ext/pg_query/include/pl_reserved_kwlist_d.h +114 -0
  223. data/ext/pg_query/include/pl_unreserved_kwlist.h +112 -0
  224. data/ext/pg_query/include/pl_unreserved_kwlist_d.h +246 -0
  225. data/ext/pg_query/include/plerrcodes.h +990 -0
  226. data/ext/pg_query/include/plpgsql.h +1347 -0
  227. data/ext/pg_query/include/port.h +524 -0
  228. data/ext/pg_query/include/port/atomics.h +524 -0
  229. data/ext/pg_query/include/port/atomics/arch-arm.h +26 -0
  230. data/ext/pg_query/include/port/atomics/arch-ppc.h +254 -0
  231. data/ext/pg_query/include/port/atomics/arch-x86.h +252 -0
  232. data/ext/pg_query/include/port/atomics/fallback.h +170 -0
  233. data/ext/pg_query/include/port/atomics/generic-gcc.h +286 -0
  234. data/ext/pg_query/include/port/atomics/generic.h +401 -0
  235. data/ext/pg_query/include/port/pg_bitutils.h +226 -0
  236. data/ext/pg_query/include/port/pg_bswap.h +161 -0
  237. data/ext/pg_query/include/port/pg_crc32c.h +101 -0
  238. data/ext/pg_query/include/portability/instr_time.h +256 -0
  239. data/ext/pg_query/include/postgres.h +764 -0
  240. data/ext/pg_query/include/postgres_ext.h +74 -0
  241. data/ext/pg_query/include/postmaster/autovacuum.h +83 -0
  242. data/ext/pg_query/include/postmaster/bgworker.h +161 -0
  243. data/ext/pg_query/include/postmaster/bgworker_internals.h +64 -0
  244. data/ext/pg_query/include/postmaster/bgwriter.h +45 -0
  245. data/ext/pg_query/include/postmaster/fork_process.h +17 -0
  246. data/ext/pg_query/include/postmaster/interrupt.h +32 -0
  247. data/ext/pg_query/include/postmaster/pgarch.h +39 -0
  248. data/ext/pg_query/include/postmaster/postmaster.h +77 -0
  249. data/ext/pg_query/include/postmaster/syslogger.h +98 -0
  250. data/ext/pg_query/include/postmaster/walwriter.h +21 -0
  251. data/ext/pg_query/include/protobuf-c.h +1106 -0
  252. data/ext/pg_query/include/protobuf-c/protobuf-c.h +1106 -0
  253. data/ext/pg_query/include/protobuf/pg_query.pb-c.h +10846 -0
  254. data/ext/pg_query/include/protobuf/pg_query.pb.h +124718 -0
  255. data/ext/pg_query/include/regex/regex.h +184 -0
  256. data/ext/pg_query/include/replication/logicallauncher.h +31 -0
  257. data/ext/pg_query/include/replication/logicalproto.h +110 -0
  258. data/ext/pg_query/include/replication/logicalworker.h +19 -0
  259. data/ext/pg_query/include/replication/origin.h +73 -0
  260. data/ext/pg_query/include/replication/reorderbuffer.h +467 -0
  261. data/ext/pg_query/include/replication/slot.h +219 -0
  262. data/ext/pg_query/include/replication/syncrep.h +115 -0
  263. data/ext/pg_query/include/replication/walreceiver.h +340 -0
  264. data/ext/pg_query/include/replication/walsender.h +74 -0
  265. data/ext/pg_query/include/rewrite/prs2lock.h +46 -0
  266. data/ext/pg_query/include/rewrite/rewriteHandler.h +40 -0
  267. data/ext/pg_query/include/rewrite/rewriteManip.h +87 -0
  268. data/ext/pg_query/include/rewrite/rewriteSupport.h +26 -0
  269. data/ext/pg_query/include/storage/backendid.h +37 -0
  270. data/ext/pg_query/include/storage/block.h +121 -0
  271. data/ext/pg_query/include/storage/buf.h +46 -0
  272. data/ext/pg_query/include/storage/bufmgr.h +292 -0
  273. data/ext/pg_query/include/storage/bufpage.h +459 -0
  274. data/ext/pg_query/include/storage/condition_variable.h +62 -0
  275. data/ext/pg_query/include/storage/dsm.h +61 -0
  276. data/ext/pg_query/include/storage/dsm_impl.h +75 -0
  277. data/ext/pg_query/include/storage/fd.h +168 -0
  278. data/ext/pg_query/include/storage/ipc.h +81 -0
  279. data/ext/pg_query/include/storage/item.h +19 -0
  280. data/ext/pg_query/include/storage/itemid.h +184 -0
  281. data/ext/pg_query/include/storage/itemptr.h +206 -0
  282. data/ext/pg_query/include/storage/large_object.h +100 -0
  283. data/ext/pg_query/include/storage/latch.h +190 -0
  284. data/ext/pg_query/include/storage/lmgr.h +114 -0
  285. data/ext/pg_query/include/storage/lock.h +612 -0
  286. data/ext/pg_query/include/storage/lockdefs.h +59 -0
  287. data/ext/pg_query/include/storage/lwlock.h +232 -0
  288. data/ext/pg_query/include/storage/lwlocknames.h +51 -0
  289. data/ext/pg_query/include/storage/off.h +57 -0
  290. data/ext/pg_query/include/storage/pg_sema.h +61 -0
  291. data/ext/pg_query/include/storage/pg_shmem.h +90 -0
  292. data/ext/pg_query/include/storage/pmsignal.h +94 -0
  293. data/ext/pg_query/include/storage/predicate.h +87 -0
  294. data/ext/pg_query/include/storage/proc.h +333 -0
  295. data/ext/pg_query/include/storage/proclist_types.h +51 -0
  296. data/ext/pg_query/include/storage/procsignal.h +75 -0
  297. data/ext/pg_query/include/storage/relfilenode.h +99 -0
  298. data/ext/pg_query/include/storage/s_lock.h +1047 -0
  299. data/ext/pg_query/include/storage/sharedfileset.h +45 -0
  300. data/ext/pg_query/include/storage/shm_mq.h +85 -0
  301. data/ext/pg_query/include/storage/shm_toc.h +58 -0
  302. data/ext/pg_query/include/storage/shmem.h +81 -0
  303. data/ext/pg_query/include/storage/sinval.h +153 -0
  304. data/ext/pg_query/include/storage/sinvaladt.h +43 -0
  305. data/ext/pg_query/include/storage/smgr.h +109 -0
  306. data/ext/pg_query/include/storage/spin.h +77 -0
  307. data/ext/pg_query/include/storage/standby.h +91 -0
  308. data/ext/pg_query/include/storage/standbydefs.h +74 -0
  309. data/ext/pg_query/include/storage/sync.h +62 -0
  310. data/ext/pg_query/include/tcop/cmdtag.h +58 -0
  311. data/ext/pg_query/include/tcop/cmdtaglist.h +217 -0
  312. data/ext/pg_query/include/tcop/deparse_utility.h +108 -0
  313. data/ext/pg_query/include/tcop/dest.h +149 -0
  314. data/ext/pg_query/include/tcop/fastpath.h +21 -0
  315. data/ext/pg_query/include/tcop/pquery.h +45 -0
  316. data/ext/pg_query/include/tcop/tcopprot.h +89 -0
  317. data/ext/pg_query/include/tcop/utility.h +108 -0
  318. data/ext/pg_query/include/tsearch/ts_cache.h +98 -0
  319. data/ext/pg_query/include/utils/acl.h +312 -0
  320. data/ext/pg_query/include/utils/aclchk_internal.h +45 -0
  321. data/ext/pg_query/include/utils/array.h +458 -0
  322. data/ext/pg_query/include/utils/builtins.h +127 -0
  323. data/ext/pg_query/include/utils/bytea.h +27 -0
  324. data/ext/pg_query/include/utils/catcache.h +231 -0
  325. data/ext/pg_query/include/utils/date.h +90 -0
  326. data/ext/pg_query/include/utils/datetime.h +343 -0
  327. data/ext/pg_query/include/utils/datum.h +68 -0
  328. data/ext/pg_query/include/utils/dsa.h +123 -0
  329. data/ext/pg_query/include/utils/dynahash.h +19 -0
  330. data/ext/pg_query/include/utils/elog.h +439 -0
  331. data/ext/pg_query/include/utils/errcodes.h +352 -0
  332. data/ext/pg_query/include/utils/expandeddatum.h +159 -0
  333. data/ext/pg_query/include/utils/expandedrecord.h +231 -0
  334. data/ext/pg_query/include/utils/float.h +356 -0
  335. data/ext/pg_query/include/utils/fmgroids.h +2657 -0
  336. data/ext/pg_query/include/utils/fmgrprotos.h +2646 -0
  337. data/ext/pg_query/include/utils/fmgrtab.h +48 -0
  338. data/ext/pg_query/include/utils/guc.h +443 -0
  339. data/ext/pg_query/include/utils/guc_tables.h +272 -0
  340. data/ext/pg_query/include/utils/hsearch.h +149 -0
  341. data/ext/pg_query/include/utils/inval.h +64 -0
  342. data/ext/pg_query/include/utils/lsyscache.h +197 -0
  343. data/ext/pg_query/include/utils/memdebug.h +82 -0
  344. data/ext/pg_query/include/utils/memutils.h +225 -0
  345. data/ext/pg_query/include/utils/numeric.h +76 -0
  346. data/ext/pg_query/include/utils/palloc.h +136 -0
  347. data/ext/pg_query/include/utils/partcache.h +102 -0
  348. data/ext/pg_query/include/utils/pg_locale.h +119 -0
  349. data/ext/pg_query/include/utils/pg_lsn.h +29 -0
  350. data/ext/pg_query/include/utils/pidfile.h +56 -0
  351. data/ext/pg_query/include/utils/plancache.h +235 -0
  352. data/ext/pg_query/include/utils/portal.h +241 -0
  353. data/ext/pg_query/include/utils/probes.h +114 -0
  354. data/ext/pg_query/include/utils/ps_status.h +25 -0
  355. data/ext/pg_query/include/utils/queryenvironment.h +74 -0
  356. data/ext/pg_query/include/utils/regproc.h +28 -0
  357. data/ext/pg_query/include/utils/rel.h +644 -0
  358. data/ext/pg_query/include/utils/relcache.h +151 -0
  359. data/ext/pg_query/include/utils/reltrigger.h +81 -0
  360. data/ext/pg_query/include/utils/resowner.h +86 -0
  361. data/ext/pg_query/include/utils/rls.h +50 -0
  362. data/ext/pg_query/include/utils/ruleutils.h +44 -0
  363. data/ext/pg_query/include/utils/sharedtuplestore.h +61 -0
  364. data/ext/pg_query/include/utils/snapmgr.h +158 -0
  365. data/ext/pg_query/include/utils/snapshot.h +206 -0
  366. data/ext/pg_query/include/utils/sortsupport.h +276 -0
  367. data/ext/pg_query/include/utils/syscache.h +219 -0
  368. data/ext/pg_query/include/utils/timeout.h +88 -0
  369. data/ext/pg_query/include/utils/timestamp.h +116 -0
  370. data/ext/pg_query/include/utils/tuplesort.h +277 -0
  371. data/ext/pg_query/include/utils/tuplestore.h +91 -0
  372. data/ext/pg_query/include/utils/typcache.h +202 -0
  373. data/ext/pg_query/include/utils/tzparser.h +39 -0
  374. data/ext/pg_query/include/utils/varlena.h +39 -0
  375. data/ext/pg_query/include/utils/xml.h +84 -0
  376. data/ext/pg_query/include/xxhash.h +5445 -0
  377. data/ext/pg_query/include/xxhash/xxhash.h +5445 -0
  378. data/ext/pg_query/pg_query.c +104 -0
  379. data/ext/pg_query/pg_query.pb-c.c +37628 -0
  380. data/ext/pg_query/pg_query_deparse.c +9959 -0
  381. data/ext/pg_query/pg_query_fingerprint.c +295 -0
  382. data/ext/pg_query/pg_query_fingerprint.h +8 -0
  383. data/ext/pg_query/pg_query_internal.h +24 -0
  384. data/ext/pg_query/pg_query_json_plpgsql.c +738 -0
  385. data/ext/pg_query/pg_query_json_plpgsql.h +9 -0
  386. data/ext/pg_query/pg_query_normalize.c +439 -0
  387. data/ext/pg_query/pg_query_outfuncs.h +10 -0
  388. data/ext/pg_query/pg_query_outfuncs_json.c +297 -0
  389. data/ext/pg_query/pg_query_outfuncs_protobuf.c +237 -0
  390. data/ext/pg_query/pg_query_parse.c +148 -0
  391. data/ext/pg_query/pg_query_parse_plpgsql.c +460 -0
  392. data/ext/pg_query/pg_query_readfuncs.h +11 -0
  393. data/ext/pg_query/pg_query_readfuncs_protobuf.c +142 -0
  394. data/ext/pg_query/pg_query_ruby.c +108 -12
  395. data/ext/pg_query/pg_query_scan.c +173 -0
  396. data/ext/pg_query/pg_query_split.c +221 -0
  397. data/ext/pg_query/protobuf-c.c +3660 -0
  398. data/ext/pg_query/src_backend_catalog_namespace.c +1051 -0
  399. data/ext/pg_query/src_backend_catalog_pg_proc.c +142 -0
  400. data/ext/pg_query/src_backend_commands_define.c +117 -0
  401. data/ext/pg_query/src_backend_libpq_pqcomm.c +651 -0
  402. data/ext/pg_query/src_backend_nodes_bitmapset.c +513 -0
  403. data/ext/pg_query/src_backend_nodes_copyfuncs.c +6013 -0
  404. data/ext/pg_query/src_backend_nodes_equalfuncs.c +4003 -0
  405. data/ext/pg_query/src_backend_nodes_extensible.c +99 -0
  406. data/ext/pg_query/src_backend_nodes_list.c +922 -0
  407. data/ext/pg_query/src_backend_nodes_makefuncs.c +417 -0
  408. data/ext/pg_query/src_backend_nodes_nodeFuncs.c +1363 -0
  409. data/ext/pg_query/src_backend_nodes_value.c +84 -0
  410. data/ext/pg_query/src_backend_parser_gram.c +47456 -0
  411. data/ext/pg_query/src_backend_parser_parse_expr.c +313 -0
  412. data/ext/pg_query/src_backend_parser_parser.c +497 -0
  413. data/ext/pg_query/src_backend_parser_scan.c +7091 -0
  414. data/ext/pg_query/src_backend_parser_scansup.c +160 -0
  415. data/ext/pg_query/src_backend_postmaster_postmaster.c +2230 -0
  416. data/ext/pg_query/src_backend_storage_ipc_ipc.c +192 -0
  417. data/ext/pg_query/src_backend_storage_lmgr_s_lock.c +370 -0
  418. data/ext/pg_query/src_backend_tcop_postgres.c +776 -0
  419. data/ext/pg_query/src_backend_utils_adt_datum.c +326 -0
  420. data/ext/pg_query/src_backend_utils_adt_expandeddatum.c +98 -0
  421. data/ext/pg_query/src_backend_utils_adt_format_type.c +136 -0
  422. data/ext/pg_query/src_backend_utils_adt_ruleutils.c +1683 -0
  423. data/ext/pg_query/src_backend_utils_error_assert.c +74 -0
  424. data/ext/pg_query/src_backend_utils_error_elog.c +1748 -0
  425. data/ext/pg_query/src_backend_utils_fmgr_fmgr.c +570 -0
  426. data/ext/pg_query/src_backend_utils_hash_dynahash.c +1086 -0
  427. data/ext/pg_query/src_backend_utils_init_globals.c +168 -0
  428. data/ext/pg_query/src_backend_utils_mb_mbutils.c +839 -0
  429. data/ext/pg_query/src_backend_utils_misc_guc.c +1831 -0
  430. data/ext/pg_query/src_backend_utils_mmgr_aset.c +1560 -0
  431. data/ext/pg_query/src_backend_utils_mmgr_mcxt.c +1006 -0
  432. data/ext/pg_query/src_common_encnames.c +158 -0
  433. data/ext/pg_query/src_common_keywords.c +39 -0
  434. data/ext/pg_query/src_common_kwlist_d.h +1081 -0
  435. data/ext/pg_query/src_common_kwlookup.c +91 -0
  436. data/ext/pg_query/src_common_psprintf.c +158 -0
  437. data/ext/pg_query/src_common_string.c +86 -0
  438. data/ext/pg_query/src_common_stringinfo.c +336 -0
  439. data/ext/pg_query/src_common_wchar.c +1651 -0
  440. data/ext/pg_query/src_pl_plpgsql_src_pl_comp.c +1133 -0
  441. data/ext/pg_query/src_pl_plpgsql_src_pl_funcs.c +877 -0
  442. data/ext/pg_query/src_pl_plpgsql_src_pl_gram.c +6533 -0
  443. data/ext/pg_query/src_pl_plpgsql_src_pl_handler.c +107 -0
  444. data/ext/pg_query/src_pl_plpgsql_src_pl_reserved_kwlist_d.h +123 -0
  445. data/ext/pg_query/src_pl_plpgsql_src_pl_scanner.c +671 -0
  446. data/ext/pg_query/src_pl_plpgsql_src_pl_unreserved_kwlist_d.h +255 -0
  447. data/ext/pg_query/src_port_erand48.c +127 -0
  448. data/ext/pg_query/src_port_pg_bitutils.c +246 -0
  449. data/ext/pg_query/src_port_pgsleep.c +69 -0
  450. data/ext/pg_query/src_port_pgstrcasecmp.c +83 -0
  451. data/ext/pg_query/src_port_qsort.c +240 -0
  452. data/ext/pg_query/src_port_random.c +31 -0
  453. data/ext/pg_query/src_port_snprintf.c +1449 -0
  454. data/ext/pg_query/src_port_strerror.c +324 -0
  455. data/ext/pg_query/src_port_strnlen.c +39 -0
  456. data/ext/pg_query/xxhash.c +43 -0
  457. data/lib/pg_query.rb +7 -4
  458. data/lib/pg_query/constants.rb +21 -0
  459. data/lib/pg_query/deparse.rb +15 -1581
  460. data/lib/pg_query/filter_columns.rb +88 -85
  461. data/lib/pg_query/fingerprint.rb +122 -87
  462. data/lib/pg_query/json_field_names.rb +1402 -0
  463. data/lib/pg_query/node.rb +31 -0
  464. data/lib/pg_query/param_refs.rb +42 -37
  465. data/lib/pg_query/parse.rb +220 -203
  466. data/lib/pg_query/parse_error.rb +1 -1
  467. data/lib/pg_query/pg_query_pb.rb +3211 -0
  468. data/lib/pg_query/scan.rb +23 -0
  469. data/lib/pg_query/treewalker.rb +24 -40
  470. data/lib/pg_query/truncate.rb +71 -42
  471. data/lib/pg_query/version.rb +2 -2
  472. metadata +472 -11
  473. data/ext/pg_query/pg_query_ruby.h +0 -10
  474. data/lib/pg_query/deep_dup.rb +0 -16
  475. data/lib/pg_query/deparse/alter_table.rb +0 -42
  476. data/lib/pg_query/deparse/interval.rb +0 -105
  477. data/lib/pg_query/deparse/keywords.rb +0 -159
  478. data/lib/pg_query/deparse/rename.rb +0 -41
  479. data/lib/pg_query/legacy_parsetree.rb +0 -109
  480. data/lib/pg_query/node_types.rb +0 -296
@@ -0,0 +1,32 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * interrupt.h
4
+ * Interrupt handling routines.
5
+ *
6
+ * Responses to interrupts are fairly varied and many types of backends
7
+ * have their own implementations, but we provide a few generic things
8
+ * here to facilitate code reuse.
9
+ *
10
+ * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
11
+ * Portions Copyright (c) 1994, Regents of the University of California
12
+ *
13
+ * IDENTIFICATION
14
+ * src/include/postmaster/interrupt.h
15
+ *
16
+ *-------------------------------------------------------------------------
17
+ */
18
+
19
+ #ifndef INTERRUPT_H
20
+ #define INTERRUPT_H
21
+
22
+ #include <signal.h>
23
+
24
+ extern PGDLLIMPORT volatile sig_atomic_t ConfigReloadPending;
25
+ extern PGDLLIMPORT volatile sig_atomic_t ShutdownRequestPending;
26
+
27
+ extern void HandleMainLoopInterrupts(void);
28
+ extern void SignalHandlerForConfigReload(SIGNAL_ARGS);
29
+ extern void SignalHandlerForCrashExit(SIGNAL_ARGS);
30
+ extern void SignalHandlerForShutdownRequest(SIGNAL_ARGS);
31
+
32
+ #endif
@@ -0,0 +1,39 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * pgarch.h
4
+ * Exports from postmaster/pgarch.c.
5
+ *
6
+ * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
7
+ * Portions Copyright (c) 1994, Regents of the University of California
8
+ *
9
+ * src/include/postmaster/pgarch.h
10
+ *
11
+ *-------------------------------------------------------------------------
12
+ */
13
+ #ifndef _PGARCH_H
14
+ #define _PGARCH_H
15
+
16
+ /* ----------
17
+ * Archiver control info.
18
+ *
19
+ * We expect that archivable files within pg_wal will have names between
20
+ * MIN_XFN_CHARS and MAX_XFN_CHARS in length, consisting only of characters
21
+ * appearing in VALID_XFN_CHARS. The status files in archive_status have
22
+ * corresponding names with ".ready" or ".done" appended.
23
+ * ----------
24
+ */
25
+ #define MIN_XFN_CHARS 16
26
+ #define MAX_XFN_CHARS 40
27
+ #define VALID_XFN_CHARS "0123456789ABCDEF.history.backup.partial"
28
+
29
+ /* ----------
30
+ * Functions called from postmaster
31
+ * ----------
32
+ */
33
+ extern int pgarch_start(void);
34
+
35
+ #ifdef EXEC_BACKEND
36
+ extern void PgArchiverMain(int argc, char *argv[]) pg_attribute_noreturn();
37
+ #endif
38
+
39
+ #endif /* _PGARCH_H */
@@ -0,0 +1,77 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * postmaster.h
4
+ * Exports from postmaster/postmaster.c.
5
+ *
6
+ * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
7
+ * Portions Copyright (c) 1994, Regents of the University of California
8
+ *
9
+ * src/include/postmaster/postmaster.h
10
+ *
11
+ *-------------------------------------------------------------------------
12
+ */
13
+ #ifndef _POSTMASTER_H
14
+ #define _POSTMASTER_H
15
+
16
+ /* GUC options */
17
+ extern bool EnableSSL;
18
+ extern int ReservedBackends;
19
+ extern PGDLLIMPORT int PostPortNumber;
20
+ extern int Unix_socket_permissions;
21
+ extern char *Unix_socket_group;
22
+ extern char *Unix_socket_directories;
23
+ extern char *ListenAddresses;
24
+ extern __thread bool ClientAuthInProgress;
25
+ extern int PreAuthDelay;
26
+ extern int AuthenticationTimeout;
27
+ extern bool Log_connections;
28
+ extern bool log_hostname;
29
+ extern bool enable_bonjour;
30
+ extern char *bonjour_name;
31
+ extern bool restart_after_crash;
32
+
33
+ #ifdef WIN32
34
+ extern HANDLE PostmasterHandle;
35
+ #else
36
+ extern int postmaster_alive_fds[2];
37
+
38
+ /*
39
+ * Constants that represent which of postmaster_alive_fds is held by
40
+ * postmaster, and which is used in children to check for postmaster death.
41
+ */
42
+ #define POSTMASTER_FD_WATCH 0 /* used in children to check for
43
+ * postmaster death */
44
+ #define POSTMASTER_FD_OWN 1 /* kept open by postmaster only */
45
+ #endif
46
+
47
+ extern PGDLLIMPORT const char *progname;
48
+
49
+ extern void PostmasterMain(int argc, char *argv[]) pg_attribute_noreturn();
50
+ extern void ClosePostmasterPorts(bool am_syslogger);
51
+ extern void InitProcessGlobals(void);
52
+
53
+ extern int MaxLivePostmasterChildren(void);
54
+
55
+ extern bool PostmasterMarkPIDForWorkerNotify(int);
56
+
57
+ #ifdef EXEC_BACKEND
58
+ extern pid_t postmaster_forkexec(int argc, char *argv[]);
59
+ extern void SubPostmasterMain(int argc, char *argv[]) pg_attribute_noreturn();
60
+
61
+ extern Size ShmemBackendArraySize(void);
62
+ extern void ShmemBackendArrayAllocation(void);
63
+ #endif
64
+
65
+ /*
66
+ * Note: MAX_BACKENDS is limited to 2^18-1 because that's the width reserved
67
+ * for buffer references in buf_internals.h. This limitation could be lifted
68
+ * by using a 64bit state; but it's unlikely to be worthwhile as 2^18-1
69
+ * backends exceed currently realistic configurations. Even if that limitation
70
+ * were removed, we still could not a) exceed 2^23-1 because inval.c stores
71
+ * the backend ID as a 3-byte signed integer, b) INT_MAX/4 because some places
72
+ * compute 4*MaxBackends without any overflow check. This is rechecked in the
73
+ * relevant GUC check hooks and in RegisterBackgroundWorker().
74
+ */
75
+ #define MAX_BACKENDS 0x3FFFF
76
+
77
+ #endif /* _POSTMASTER_H */
@@ -0,0 +1,98 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * syslogger.h
4
+ * Exports from postmaster/syslogger.c.
5
+ *
6
+ * Copyright (c) 2004-2020, PostgreSQL Global Development Group
7
+ *
8
+ * src/include/postmaster/syslogger.h
9
+ *
10
+ *-------------------------------------------------------------------------
11
+ */
12
+ #ifndef _SYSLOGGER_H
13
+ #define _SYSLOGGER_H
14
+
15
+ #include <limits.h> /* for PIPE_BUF */
16
+
17
+
18
+ /*
19
+ * Primitive protocol structure for writing to syslogger pipe(s). The idea
20
+ * here is to divide long messages into chunks that are not more than
21
+ * PIPE_BUF bytes long, which according to POSIX spec must be written into
22
+ * the pipe atomically. The pipe reader then uses the protocol headers to
23
+ * reassemble the parts of a message into a single string. The reader can
24
+ * also cope with non-protocol data coming down the pipe, though we cannot
25
+ * guarantee long strings won't get split apart.
26
+ *
27
+ * We use non-nul bytes in is_last to make the protocol a tiny bit
28
+ * more robust against finding a false double nul byte prologue. But
29
+ * we still might find it in the len and/or pid bytes unless we're careful.
30
+ */
31
+
32
+ #ifdef PIPE_BUF
33
+ /* Are there any systems with PIPE_BUF > 64K? Unlikely, but ... */
34
+ #if PIPE_BUF > 65536
35
+ #define PIPE_CHUNK_SIZE 65536
36
+ #else
37
+ #define PIPE_CHUNK_SIZE ((int) PIPE_BUF)
38
+ #endif
39
+ #else /* not defined */
40
+ /* POSIX says the value of PIPE_BUF must be at least 512, so use that */
41
+ #define PIPE_CHUNK_SIZE 512
42
+ #endif
43
+
44
+ typedef struct
45
+ {
46
+ char nuls[2]; /* always \0\0 */
47
+ uint16 len; /* size of this chunk (counts data only) */
48
+ int32 pid; /* writer's pid */
49
+ char is_last; /* last chunk of message? 't' or 'f' ('T' or
50
+ * 'F' for CSV case) */
51
+ char data[FLEXIBLE_ARRAY_MEMBER]; /* data payload starts here */
52
+ } PipeProtoHeader;
53
+
54
+ typedef union
55
+ {
56
+ PipeProtoHeader proto;
57
+ char filler[PIPE_CHUNK_SIZE];
58
+ } PipeProtoChunk;
59
+
60
+ #define PIPE_HEADER_SIZE offsetof(PipeProtoHeader, data)
61
+ #define PIPE_MAX_PAYLOAD ((int) (PIPE_CHUNK_SIZE - PIPE_HEADER_SIZE))
62
+
63
+
64
+ /* GUC options */
65
+ extern bool Logging_collector;
66
+ extern int Log_RotationAge;
67
+ extern int Log_RotationSize;
68
+ extern PGDLLIMPORT char *Log_directory;
69
+ extern PGDLLIMPORT char *Log_filename;
70
+ extern bool Log_truncate_on_rotation;
71
+ extern int Log_file_mode;
72
+
73
+ #ifndef WIN32
74
+ extern int syslogPipe[2];
75
+ #else
76
+ extern HANDLE syslogPipe[2];
77
+ #endif
78
+
79
+
80
+ extern int SysLogger_Start(void);
81
+
82
+ extern void write_syslogger_file(const char *buffer, int count, int dest);
83
+
84
+ #ifdef EXEC_BACKEND
85
+ extern void SysLoggerMain(int argc, char *argv[]) pg_attribute_noreturn();
86
+ #endif
87
+
88
+ extern bool CheckLogrotateSignal(void);
89
+ extern void RemoveLogrotateSignalFiles(void);
90
+
91
+ /*
92
+ * Name of files saving meta-data information about the log
93
+ * files currently in use by the syslogger
94
+ */
95
+ #define LOG_METAINFO_DATAFILE "current_logfiles"
96
+ #define LOG_METAINFO_DATAFILE_TMP LOG_METAINFO_DATAFILE ".tmp"
97
+
98
+ #endif /* _SYSLOGGER_H */
@@ -0,0 +1,21 @@
1
+ /*-------------------------------------------------------------------------
2
+ *
3
+ * walwriter.h
4
+ * Exports from postmaster/walwriter.c.
5
+ *
6
+ * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
7
+ *
8
+ * src/include/postmaster/walwriter.h
9
+ *
10
+ *-------------------------------------------------------------------------
11
+ */
12
+ #ifndef _WALWRITER_H
13
+ #define _WALWRITER_H
14
+
15
+ /* GUC options */
16
+ extern int WalWriterDelay;
17
+ extern int WalWriterFlushAfter;
18
+
19
+ extern void WalWriterMain(void) pg_attribute_noreturn();
20
+
21
+ #endif /* _WALWRITER_H */
@@ -0,0 +1,1106 @@
1
+ /*
2
+ * Copyright (c) 2008-2018, Dave Benson and the protobuf-c authors.
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
7
+ * met:
8
+ *
9
+ * * Redistributions of source code must retain the above copyright
10
+ * notice, this list of conditions and the following disclaimer.
11
+ *
12
+ * * Redistributions in binary form must reproduce the above
13
+ * copyright notice, this list of conditions and the following disclaimer
14
+ * in the documentation and/or other materials provided with the
15
+ * distribution.
16
+ *
17
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
+ */
29
+
30
+ /*! \file
31
+ * \mainpage Introduction
32
+ *
33
+ * This is [protobuf-c], a C implementation of [Protocol Buffers].
34
+ *
35
+ * This file defines the public API for the `libprotobuf-c` support library.
36
+ * This API includes interfaces that can be used directly by client code as well
37
+ * as the interfaces used by the code generated by the `protoc-c` compiler.
38
+ *
39
+ * The `libprotobuf-c` support library performs the actual serialization and
40
+ * deserialization of Protocol Buffers messages. It interacts with structures,
41
+ * definitions, and metadata generated by the `protoc-c` compiler from .proto
42
+ * files.
43
+ *
44
+ * \authors Dave Benson and the `protobuf-c` authors.
45
+ *
46
+ * \copyright 2008-2014. Licensed under the terms of the [BSD-2-Clause] license.
47
+ *
48
+ * [protobuf-c]: https://github.com/protobuf-c/protobuf-c
49
+ * [Protocol Buffers]: https://developers.google.com/protocol-buffers/
50
+ * [BSD-2-Clause]: http://opensource.org/licenses/BSD-2-Clause
51
+ *
52
+ * \page gencode Generated Code
53
+ *
54
+ * For each enum, we generate a C enum. For each message, we generate a C
55
+ * structure which can be cast to a `ProtobufCMessage`.
56
+ *
57
+ * For each enum and message, we generate a descriptor object that allows us to
58
+ * implement a kind of reflection on the structures.
59
+ *
60
+ * First, some naming conventions:
61
+ *
62
+ * - The name of the type for enums and messages and services is camel case
63
+ * (meaning WordsAreCrammedTogether) except that double underscores are used
64
+ * to delimit scopes. For example, the following `.proto` file:
65
+ *
66
+ ~~~{.proto}
67
+ package foo.bar;
68
+ message BazBah {
69
+ optional int32 val = 1;
70
+ }
71
+ ~~~
72
+ *
73
+ * would generate a C type `Foo__Bar__BazBah`.
74
+ *
75
+ * - Identifiers for functions and globals are all lowercase, with camel case
76
+ * words separated by single underscores. For example, one of the function
77
+ * prototypes generated by `protoc-c` for the above example:
78
+ *
79
+ ~~~{.c}
80
+ Foo__Bar__BazBah *
81
+ foo__bar__baz_bah__unpack
82
+ (ProtobufCAllocator *allocator,
83
+ size_t len,
84
+ const uint8_t *data);
85
+ ~~~
86
+ *
87
+ * - Identifiers for enum values contain an uppercase prefix which embeds the
88
+ * package name and the enum type name.
89
+ *
90
+ * - A double underscore is used to separate further components of identifier
91
+ * names.
92
+ *
93
+ * For example, in the name of the unpack function above, the package name
94
+ * `foo.bar` has become `foo__bar`, the message name BazBah has become
95
+ * `baz_bah`, and the method name is `unpack`. These are all joined with double
96
+ * underscores to form the C identifier `foo__bar__baz_bah__unpack`.
97
+ *
98
+ * We also generate descriptor objects for messages and enums. These are
99
+ * declared in the `.pb-c.h` files:
100
+ *
101
+ ~~~{.c}
102
+ extern const ProtobufCMessageDescriptor foo__bar__baz_bah__descriptor;
103
+ ~~~
104
+ *
105
+ * The message structures all begin with `ProtobufCMessageDescriptor *` which is
106
+ * sufficient to allow them to be cast to `ProtobufCMessage`.
107
+ *
108
+ * For each message defined in a `.proto` file, we generate a number of
109
+ * functions and macros. Each function name contains a prefix based on the
110
+ * package name and message name in order to make it a unique C identifier.
111
+ *
112
+ * - `INIT`. Statically initializes a message object, initializing its
113
+ * descriptor and setting its fields to default values. Uninitialized
114
+ * messages cannot be processed by the protobuf-c library.
115
+ *
116
+ ~~~{.c}
117
+ #define FOO__BAR__BAZ_BAH__INIT \
118
+ { PROTOBUF_C_MESSAGE_INIT (&foo__bar__baz_bah__descriptor), 0 }
119
+ ~~~
120
+ * - `init()`. Initializes a message object, initializing its descriptor and
121
+ * setting its fields to default values. Uninitialized messages cannot be
122
+ * processed by the protobuf-c library.
123
+ *
124
+ ~~~{.c}
125
+ void foo__bar__baz_bah__init
126
+ (Foo__Bar__BazBah *message);
127
+ ~~~
128
+ * - `unpack()`. Unpacks data for a particular message format. Note that the
129
+ * `allocator` parameter is usually `NULL` to indicate that the system's
130
+ * `malloc()` and `free()` functions should be used for dynamically allocating
131
+ * memory.
132
+ *
133
+ ~~~{.c}
134
+ Foo__Bar__BazBah *
135
+ foo__bar__baz_bah__unpack
136
+ (ProtobufCAllocator *allocator,
137
+ size_t len,
138
+ const uint8_t *data);
139
+ ~~~
140
+ *
141
+ * - `free_unpacked()`. Frees a message object obtained with the `unpack()`
142
+ * method. Freeing `NULL` is allowed (the same as with `free()`).
143
+ *
144
+ ~~~{.c}
145
+ void foo__bar__baz_bah__free_unpacked
146
+ (Foo__Bar__BazBah *message,
147
+ ProtobufCAllocator *allocator);
148
+ ~~~
149
+ *
150
+ * - `get_packed_size()`. Calculates the length in bytes of the serialized
151
+ * representation of the message object.
152
+ *
153
+ ~~~{.c}
154
+ size_t foo__bar__baz_bah__get_packed_size
155
+ (const Foo__Bar__BazBah *message);
156
+ ~~~
157
+ *
158
+ * - `pack()`. Pack a message object into a preallocated buffer. Assumes that
159
+ * the buffer is large enough. (Use `get_packed_size()` first.)
160
+ *
161
+ ~~~{.c}
162
+ size_t foo__bar__baz_bah__pack
163
+ (const Foo__Bar__BazBah *message,
164
+ uint8_t *out);
165
+ ~~~
166
+ *
167
+ * - `pack_to_buffer()`. Packs a message into a "virtual buffer". This is an
168
+ * object which defines an "append bytes" callback to consume data as it is
169
+ * serialized.
170
+ *
171
+ ~~~{.c}
172
+ size_t foo__bar__baz_bah__pack_to_buffer
173
+ (const Foo__Bar__BazBah *message,
174
+ ProtobufCBuffer *buffer);
175
+ ~~~
176
+ *
177
+ * \page pack Packing and unpacking messages
178
+ *
179
+ * To pack a message, first compute the packed size of the message with
180
+ * protobuf_c_message_get_packed_size(), then allocate a buffer of at least
181
+ * that size, then call protobuf_c_message_pack().
182
+ *
183
+ * Alternatively, a message can be serialized without calculating the final size
184
+ * first. Use the protobuf_c_message_pack_to_buffer() function and provide a
185
+ * ProtobufCBuffer object which implements an "append" method that consumes
186
+ * data.
187
+ *
188
+ * To unpack a message, call the protobuf_c_message_unpack() function. The
189
+ * result can be cast to an object of the type that matches the descriptor for
190
+ * the message.
191
+ *
192
+ * The result of unpacking a message should be freed with
193
+ * protobuf_c_message_free_unpacked().
194
+ */
195
+
196
+ #ifndef PROTOBUF_C_H
197
+ #define PROTOBUF_C_H
198
+
199
+ #include <assert.h>
200
+ #include <limits.h>
201
+ #include <stddef.h>
202
+ #include <stdint.h>
203
+
204
+ #ifdef __cplusplus
205
+ # define PROTOBUF_C__BEGIN_DECLS extern "C" {
206
+ # define PROTOBUF_C__END_DECLS }
207
+ #else
208
+ # define PROTOBUF_C__BEGIN_DECLS
209
+ # define PROTOBUF_C__END_DECLS
210
+ #endif
211
+
212
+ PROTOBUF_C__BEGIN_DECLS
213
+
214
+ #if defined(_WIN32) && defined(PROTOBUF_C_USE_SHARED_LIB)
215
+ # ifdef PROTOBUF_C_EXPORT
216
+ # define PROTOBUF_C__API __declspec(dllexport)
217
+ # else
218
+ # define PROTOBUF_C__API __declspec(dllimport)
219
+ # endif
220
+ #else
221
+ # define PROTOBUF_C__API
222
+ #endif
223
+
224
+ #if !defined(PROTOBUF_C__NO_DEPRECATED) && \
225
+ ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
226
+ # define PROTOBUF_C__DEPRECATED __attribute__((__deprecated__))
227
+ #else
228
+ # define PROTOBUF_C__DEPRECATED
229
+ #endif
230
+
231
+ #ifndef PROTOBUF_C__FORCE_ENUM_TO_BE_INT_SIZE
232
+ #define PROTOBUF_C__FORCE_ENUM_TO_BE_INT_SIZE(enum_name) \
233
+ , _##enum_name##_IS_INT_SIZE = INT_MAX
234
+ #endif
235
+
236
+ #define PROTOBUF_C__SERVICE_DESCRIPTOR_MAGIC 0x14159bc3
237
+ #define PROTOBUF_C__MESSAGE_DESCRIPTOR_MAGIC 0x28aaeef9
238
+ #define PROTOBUF_C__ENUM_DESCRIPTOR_MAGIC 0x114315af
239
+
240
+ /* Empty string used for initializers */
241
+ extern const char protobuf_c_empty_string[];
242
+
243
+ /**
244
+ * \defgroup api Public API
245
+ *
246
+ * This is the public API for `libprotobuf-c`. These interfaces are stable and
247
+ * subject to Semantic Versioning guarantees.
248
+ *
249
+ * @{
250
+ */
251
+
252
+ /**
253
+ * Values for the `flags` word in `ProtobufCFieldDescriptor`.
254
+ */
255
+ typedef enum {
256
+ /** Set if the field is repeated and marked with the `packed` option. */
257
+ PROTOBUF_C_FIELD_FLAG_PACKED = (1 << 0),
258
+
259
+ /** Set if the field is marked with the `deprecated` option. */
260
+ PROTOBUF_C_FIELD_FLAG_DEPRECATED = (1 << 1),
261
+
262
+ /** Set if the field is a member of a oneof (union). */
263
+ PROTOBUF_C_FIELD_FLAG_ONEOF = (1 << 2),
264
+ } ProtobufCFieldFlag;
265
+
266
+ /**
267
+ * Message field rules.
268
+ *
269
+ * \see [Defining A Message Type] in the Protocol Buffers documentation.
270
+ *
271
+ * [Defining A Message Type]:
272
+ * https://developers.google.com/protocol-buffers/docs/proto#simple
273
+ */
274
+ typedef enum {
275
+ /** A well-formed message must have exactly one of this field. */
276
+ PROTOBUF_C_LABEL_REQUIRED,
277
+
278
+ /**
279
+ * A well-formed message can have zero or one of this field (but not
280
+ * more than one).
281
+ */
282
+ PROTOBUF_C_LABEL_OPTIONAL,
283
+
284
+ /**
285
+ * This field can be repeated any number of times (including zero) in a
286
+ * well-formed message. The order of the repeated values will be
287
+ * preserved.
288
+ */
289
+ PROTOBUF_C_LABEL_REPEATED,
290
+
291
+ /**
292
+ * This field has no label. This is valid only in proto3 and is
293
+ * equivalent to OPTIONAL but no "has" quantifier will be consulted.
294
+ */
295
+ PROTOBUF_C_LABEL_NONE,
296
+ } ProtobufCLabel;
297
+
298
+ /**
299
+ * Field value types.
300
+ *
301
+ * \see [Scalar Value Types] in the Protocol Buffers documentation.
302
+ *
303
+ * [Scalar Value Types]:
304
+ * https://developers.google.com/protocol-buffers/docs/proto#scalar
305
+ */
306
+ typedef enum {
307
+ PROTOBUF_C_TYPE_INT32, /**< int32 */
308
+ PROTOBUF_C_TYPE_SINT32, /**< signed int32 */
309
+ PROTOBUF_C_TYPE_SFIXED32, /**< signed int32 (4 bytes) */
310
+ PROTOBUF_C_TYPE_INT64, /**< int64 */
311
+ PROTOBUF_C_TYPE_SINT64, /**< signed int64 */
312
+ PROTOBUF_C_TYPE_SFIXED64, /**< signed int64 (8 bytes) */
313
+ PROTOBUF_C_TYPE_UINT32, /**< unsigned int32 */
314
+ PROTOBUF_C_TYPE_FIXED32, /**< unsigned int32 (4 bytes) */
315
+ PROTOBUF_C_TYPE_UINT64, /**< unsigned int64 */
316
+ PROTOBUF_C_TYPE_FIXED64, /**< unsigned int64 (8 bytes) */
317
+ PROTOBUF_C_TYPE_FLOAT, /**< float */
318
+ PROTOBUF_C_TYPE_DOUBLE, /**< double */
319
+ PROTOBUF_C_TYPE_BOOL, /**< boolean */
320
+ PROTOBUF_C_TYPE_ENUM, /**< enumerated type */
321
+ PROTOBUF_C_TYPE_STRING, /**< UTF-8 or ASCII string */
322
+ PROTOBUF_C_TYPE_BYTES, /**< arbitrary byte sequence */
323
+ PROTOBUF_C_TYPE_MESSAGE, /**< nested message */
324
+ } ProtobufCType;
325
+
326
+ /**
327
+ * Field wire types.
328
+ *
329
+ * \see [Message Structure] in the Protocol Buffers documentation.
330
+ *
331
+ * [Message Structure]:
332
+ * https://developers.google.com/protocol-buffers/docs/encoding#structure
333
+ */
334
+ typedef enum {
335
+ PROTOBUF_C_WIRE_TYPE_VARINT = 0,
336
+ PROTOBUF_C_WIRE_TYPE_64BIT = 1,
337
+ PROTOBUF_C_WIRE_TYPE_LENGTH_PREFIXED = 2,
338
+ /* "Start group" and "end group" wire types are unsupported. */
339
+ PROTOBUF_C_WIRE_TYPE_32BIT = 5,
340
+ } ProtobufCWireType;
341
+
342
+ struct ProtobufCAllocator;
343
+ struct ProtobufCBinaryData;
344
+ struct ProtobufCBuffer;
345
+ struct ProtobufCBufferSimple;
346
+ struct ProtobufCEnumDescriptor;
347
+ struct ProtobufCEnumValue;
348
+ struct ProtobufCEnumValueIndex;
349
+ struct ProtobufCFieldDescriptor;
350
+ struct ProtobufCIntRange;
351
+ struct ProtobufCMessage;
352
+ struct ProtobufCMessageDescriptor;
353
+ struct ProtobufCMessageUnknownField;
354
+ struct ProtobufCMethodDescriptor;
355
+ struct ProtobufCService;
356
+ struct ProtobufCServiceDescriptor;
357
+
358
+ typedef struct ProtobufCAllocator ProtobufCAllocator;
359
+ typedef struct ProtobufCBinaryData ProtobufCBinaryData;
360
+ typedef struct ProtobufCBuffer ProtobufCBuffer;
361
+ typedef struct ProtobufCBufferSimple ProtobufCBufferSimple;
362
+ typedef struct ProtobufCEnumDescriptor ProtobufCEnumDescriptor;
363
+ typedef struct ProtobufCEnumValue ProtobufCEnumValue;
364
+ typedef struct ProtobufCEnumValueIndex ProtobufCEnumValueIndex;
365
+ typedef struct ProtobufCFieldDescriptor ProtobufCFieldDescriptor;
366
+ typedef struct ProtobufCIntRange ProtobufCIntRange;
367
+ typedef struct ProtobufCMessage ProtobufCMessage;
368
+ typedef struct ProtobufCMessageDescriptor ProtobufCMessageDescriptor;
369
+ typedef struct ProtobufCMessageUnknownField ProtobufCMessageUnknownField;
370
+ typedef struct ProtobufCMethodDescriptor ProtobufCMethodDescriptor;
371
+ typedef struct ProtobufCService ProtobufCService;
372
+ typedef struct ProtobufCServiceDescriptor ProtobufCServiceDescriptor;
373
+
374
+ /** Boolean type. */
375
+ typedef int protobuf_c_boolean;
376
+
377
+ typedef void (*ProtobufCClosure)(const ProtobufCMessage *, void *closure_data);
378
+ typedef void (*ProtobufCMessageInit)(ProtobufCMessage *);
379
+ typedef void (*ProtobufCServiceDestroy)(ProtobufCService *);
380
+
381
+ /**
382
+ * Structure for defining a custom memory allocator.
383
+ */
384
+ struct ProtobufCAllocator {
385
+ /** Function to allocate memory. */
386
+ void *(*alloc)(void *allocator_data, size_t size);
387
+
388
+ /** Function to free memory. */
389
+ void (*free)(void *allocator_data, void *pointer);
390
+
391
+ /** Opaque pointer passed to `alloc` and `free` functions. */
392
+ void *allocator_data;
393
+ };
394
+
395
+ /**
396
+ * Structure for the protobuf `bytes` scalar type.
397
+ *
398
+ * The data contained in a `ProtobufCBinaryData` is an arbitrary sequence of
399
+ * bytes. It may contain embedded `NUL` characters and is not required to be
400
+ * `NUL`-terminated.
401
+ */
402
+ struct ProtobufCBinaryData {
403
+ size_t len; /**< Number of bytes in the `data` field. */
404
+ uint8_t *data; /**< Data bytes. */
405
+ };
406
+
407
+ /**
408
+ * Structure for defining a virtual append-only buffer. Used by
409
+ * protobuf_c_message_pack_to_buffer() to abstract the consumption of serialized
410
+ * bytes.
411
+ *
412
+ * `ProtobufCBuffer` "subclasses" may be defined on the stack. For example, to
413
+ * write to a `FILE` object:
414
+ *
415
+ ~~~{.c}
416
+ typedef struct {
417
+ ProtobufCBuffer base;
418
+ FILE *fp;
419
+ } BufferAppendToFile;
420
+
421
+ static void
422
+ my_buffer_file_append(ProtobufCBuffer *buffer,
423
+ size_t len,
424
+ const uint8_t *data)
425
+ {
426
+ BufferAppendToFile *file_buf = (BufferAppendToFile *) buffer;
427
+ fwrite(data, len, 1, file_buf->fp); // XXX: No error handling!
428
+ }
429
+ ~~~
430
+ *
431
+ * To use this new type of ProtobufCBuffer, it could be called as follows:
432
+ *
433
+ ~~~{.c}
434
+ ...
435
+ BufferAppendToFile tmp = {0};
436
+ tmp.base.append = my_buffer_file_append;
437
+ tmp.fp = fp;
438
+ protobuf_c_message_pack_to_buffer(&message, &tmp);
439
+ ...
440
+ ~~~
441
+ */
442
+ struct ProtobufCBuffer {
443
+ /** Append function. Consumes the `len` bytes stored at `data`. */
444
+ void (*append)(ProtobufCBuffer *buffer,
445
+ size_t len,
446
+ const uint8_t *data);
447
+ };
448
+
449
+ /**
450
+ * Simple buffer "subclass" of `ProtobufCBuffer`.
451
+ *
452
+ * A `ProtobufCBufferSimple` object is declared on the stack and uses a
453
+ * scratch buffer provided by the user for the initial allocation. It performs
454
+ * exponential resizing, using dynamically allocated memory. A
455
+ * `ProtobufCBufferSimple` object can be created and used as follows:
456
+ *
457
+ ~~~{.c}
458
+ uint8_t pad[128];
459
+ ProtobufCBufferSimple simple = PROTOBUF_C_BUFFER_SIMPLE_INIT(pad);
460
+ ProtobufCBuffer *buffer = (ProtobufCBuffer *) &simple;
461
+ ~~~
462
+ *
463
+ * `buffer` can now be used with `protobuf_c_message_pack_to_buffer()`. Once a
464
+ * message has been serialized to a `ProtobufCBufferSimple` object, the
465
+ * serialized data bytes can be accessed from the `.data` field.
466
+ *
467
+ * To free the memory allocated by a `ProtobufCBufferSimple` object, if any,
468
+ * call PROTOBUF_C_BUFFER_SIMPLE_CLEAR() on the object, for example:
469
+ *
470
+ ~~~{.c}
471
+ PROTOBUF_C_BUFFER_SIMPLE_CLEAR(&simple);
472
+ ~~~
473
+ *
474
+ * \see PROTOBUF_C_BUFFER_SIMPLE_INIT
475
+ * \see PROTOBUF_C_BUFFER_SIMPLE_CLEAR
476
+ */
477
+ struct ProtobufCBufferSimple {
478
+ /** "Base class". */
479
+ ProtobufCBuffer base;
480
+ /** Number of bytes allocated in `data`. */
481
+ size_t alloced;
482
+ /** Number of bytes currently stored in `data`. */
483
+ size_t len;
484
+ /** Data bytes. */
485
+ uint8_t *data;
486
+ /** Whether `data` must be freed. */
487
+ protobuf_c_boolean must_free_data;
488
+ /** Allocator to use. May be NULL to indicate the system allocator. */
489
+ ProtobufCAllocator *allocator;
490
+ };
491
+
492
+ /**
493
+ * Describes an enumeration as a whole, with all of its values.
494
+ */
495
+ struct ProtobufCEnumDescriptor {
496
+ /** Magic value checked to ensure that the API is used correctly. */
497
+ uint32_t magic;
498
+
499
+ /** The qualified name (e.g., "namespace.Type"). */
500
+ const char *name;
501
+ /** The unqualified name as given in the .proto file (e.g., "Type"). */
502
+ const char *short_name;
503
+ /** Identifier used in generated C code. */
504
+ const char *c_name;
505
+ /** The dot-separated namespace. */
506
+ const char *package_name;
507
+
508
+ /** Number elements in `values`. */
509
+ unsigned n_values;
510
+ /** Array of distinct values, sorted by numeric value. */
511
+ const ProtobufCEnumValue *values;
512
+
513
+ /** Number of elements in `values_by_name`. */
514
+ unsigned n_value_names;
515
+ /** Array of named values, including aliases, sorted by name. */
516
+ const ProtobufCEnumValueIndex *values_by_name;
517
+
518
+ /** Number of elements in `value_ranges`. */
519
+ unsigned n_value_ranges;
520
+ /** Value ranges, for faster lookups by numeric value. */
521
+ const ProtobufCIntRange *value_ranges;
522
+
523
+ /** Reserved for future use. */
524
+ void *reserved1;
525
+ /** Reserved for future use. */
526
+ void *reserved2;
527
+ /** Reserved for future use. */
528
+ void *reserved3;
529
+ /** Reserved for future use. */
530
+ void *reserved4;
531
+ };
532
+
533
+ /**
534
+ * Represents a single value of an enumeration.
535
+ */
536
+ struct ProtobufCEnumValue {
537
+ /** The string identifying this value in the .proto file. */
538
+ const char *name;
539
+
540
+ /** The string identifying this value in generated C code. */
541
+ const char *c_name;
542
+
543
+ /** The numeric value assigned in the .proto file. */
544
+ int value;
545
+ };
546
+
547
+ /**
548
+ * Used by `ProtobufCEnumDescriptor` to look up enum values.
549
+ */
550
+ struct ProtobufCEnumValueIndex {
551
+ /** Name of the enum value. */
552
+ const char *name;
553
+ /** Index into values[] array. */
554
+ unsigned index;
555
+ };
556
+
557
+ /**
558
+ * Describes a single field in a message.
559
+ */
560
+ struct ProtobufCFieldDescriptor {
561
+ /** Name of the field as given in the .proto file. */
562
+ const char *name;
563
+
564
+ /** Tag value of the field as given in the .proto file. */
565
+ uint32_t id;
566
+
567
+ /** Whether the field is `REQUIRED`, `OPTIONAL`, or `REPEATED`. */
568
+ ProtobufCLabel label;
569
+
570
+ /** The type of the field. */
571
+ ProtobufCType type;
572
+
573
+ /**
574
+ * The offset in bytes of the message's C structure's quantifier field
575
+ * (the `has_MEMBER` field for optional members or the `n_MEMBER` field
576
+ * for repeated members or the case enum for oneofs).
577
+ */
578
+ unsigned quantifier_offset;
579
+
580
+ /**
581
+ * The offset in bytes into the message's C structure for the member
582
+ * itself.
583
+ */
584
+ unsigned offset;
585
+
586
+ /**
587
+ * A type-specific descriptor.
588
+ *
589
+ * If `type` is `PROTOBUF_C_TYPE_ENUM`, then `descriptor` points to the
590
+ * corresponding `ProtobufCEnumDescriptor`.
591
+ *
592
+ * If `type` is `PROTOBUF_C_TYPE_MESSAGE`, then `descriptor` points to
593
+ * the corresponding `ProtobufCMessageDescriptor`.
594
+ *
595
+ * Otherwise this field is NULL.
596
+ */
597
+ const void *descriptor; /* for MESSAGE and ENUM types */
598
+
599
+ /** The default value for this field, if defined. May be NULL. */
600
+ const void *default_value;
601
+
602
+ /**
603
+ * A flag word. Zero or more of the bits defined in the
604
+ * `ProtobufCFieldFlag` enum may be set.
605
+ */
606
+ uint32_t flags;
607
+
608
+ /** Reserved for future use. */
609
+ unsigned reserved_flags;
610
+ /** Reserved for future use. */
611
+ void *reserved2;
612
+ /** Reserved for future use. */
613
+ void *reserved3;
614
+ };
615
+
616
+ /**
617
+ * Helper structure for optimizing int => index lookups in the case
618
+ * where the keys are mostly consecutive values, as they presumably are for
619
+ * enums and fields.
620
+ *
621
+ * The data structures requires that the values in the original array are
622
+ * sorted.
623
+ */
624
+ struct ProtobufCIntRange {
625
+ int start_value;
626
+ unsigned orig_index;
627
+ /*
628
+ * NOTE: the number of values in the range can be inferred by looking
629
+ * at the next element's orig_index. A dummy element is added to make
630
+ * this simple.
631
+ */
632
+ };
633
+
634
+ /**
635
+ * An instance of a message.
636
+ *
637
+ * `ProtobufCMessage` is a light-weight "base class" for all messages.
638
+ *
639
+ * In particular, `ProtobufCMessage` doesn't have any allocation policy
640
+ * associated with it. That's because it's common to create `ProtobufCMessage`
641
+ * objects on the stack. In fact, that's what we recommend for sending messages.
642
+ * If the object is allocated from the stack, you can't really have a memory
643
+ * leak.
644
+ *
645
+ * This means that calls to functions like protobuf_c_message_unpack() which
646
+ * return a `ProtobufCMessage` must be paired with a call to a free function,
647
+ * like protobuf_c_message_free_unpacked().
648
+ */
649
+ struct ProtobufCMessage {
650
+ /** The descriptor for this message type. */
651
+ const ProtobufCMessageDescriptor *descriptor;
652
+ /** The number of elements in `unknown_fields`. */
653
+ unsigned n_unknown_fields;
654
+ /** The fields that weren't recognized by the parser. */
655
+ ProtobufCMessageUnknownField *unknown_fields;
656
+ };
657
+
658
+ /**
659
+ * Describes a message.
660
+ */
661
+ struct ProtobufCMessageDescriptor {
662
+ /** Magic value checked to ensure that the API is used correctly. */
663
+ uint32_t magic;
664
+
665
+ /** The qualified name (e.g., "namespace.Type"). */
666
+ const char *name;
667
+ /** The unqualified name as given in the .proto file (e.g., "Type"). */
668
+ const char *short_name;
669
+ /** Identifier used in generated C code. */
670
+ const char *c_name;
671
+ /** The dot-separated namespace. */
672
+ const char *package_name;
673
+
674
+ /**
675
+ * Size in bytes of the C structure representing an instance of this
676
+ * type of message.
677
+ */
678
+ size_t sizeof_message;
679
+
680
+ /** Number of elements in `fields`. */
681
+ unsigned n_fields;
682
+ /** Field descriptors, sorted by tag number. */
683
+ const ProtobufCFieldDescriptor *fields;
684
+ /** Used for looking up fields by name. */
685
+ const unsigned *fields_sorted_by_name;
686
+
687
+ /** Number of elements in `field_ranges`. */
688
+ unsigned n_field_ranges;
689
+ /** Used for looking up fields by id. */
690
+ const ProtobufCIntRange *field_ranges;
691
+
692
+ /** Message initialisation function. */
693
+ ProtobufCMessageInit message_init;
694
+
695
+ /** Reserved for future use. */
696
+ void *reserved1;
697
+ /** Reserved for future use. */
698
+ void *reserved2;
699
+ /** Reserved for future use. */
700
+ void *reserved3;
701
+ };
702
+
703
+ /**
704
+ * An unknown message field.
705
+ */
706
+ struct ProtobufCMessageUnknownField {
707
+ /** The tag number. */
708
+ uint32_t tag;
709
+ /** The wire type of the field. */
710
+ ProtobufCWireType wire_type;
711
+ /** Number of bytes in `data`. */
712
+ size_t len;
713
+ /** Field data. */
714
+ uint8_t *data;
715
+ };
716
+
717
+ /**
718
+ * Method descriptor.
719
+ */
720
+ struct ProtobufCMethodDescriptor {
721
+ /** Method name. */
722
+ const char *name;
723
+ /** Input message descriptor. */
724
+ const ProtobufCMessageDescriptor *input;
725
+ /** Output message descriptor. */
726
+ const ProtobufCMessageDescriptor *output;
727
+ };
728
+
729
+ /**
730
+ * Service.
731
+ */
732
+ struct ProtobufCService {
733
+ /** Service descriptor. */
734
+ const ProtobufCServiceDescriptor *descriptor;
735
+ /** Function to invoke the service. */
736
+ void (*invoke)(ProtobufCService *service,
737
+ unsigned method_index,
738
+ const ProtobufCMessage *input,
739
+ ProtobufCClosure closure,
740
+ void *closure_data);
741
+ /** Function to destroy the service. */
742
+ void (*destroy)(ProtobufCService *service);
743
+ };
744
+
745
+ /**
746
+ * Service descriptor.
747
+ */
748
+ struct ProtobufCServiceDescriptor {
749
+ /** Magic value checked to ensure that the API is used correctly. */
750
+ uint32_t magic;
751
+
752
+ /** Service name. */
753
+ const char *name;
754
+ /** Short version of service name. */
755
+ const char *short_name;
756
+ /** C identifier for the service name. */
757
+ const char *c_name;
758
+ /** Package name. */
759
+ const char *package;
760
+ /** Number of elements in `methods`. */
761
+ unsigned n_methods;
762
+ /** Method descriptors, in the order defined in the .proto file. */
763
+ const ProtobufCMethodDescriptor *methods;
764
+ /** Sort index of methods. */
765
+ const unsigned *method_indices_by_name;
766
+ };
767
+
768
+ /**
769
+ * Get the version of the protobuf-c library. Note that this is the version of
770
+ * the library linked against, not the version of the headers compiled against.
771
+ *
772
+ * \return A string containing the version number of protobuf-c.
773
+ */
774
+ PROTOBUF_C__API
775
+ const char *
776
+ protobuf_c_version(void);
777
+
778
+ /**
779
+ * Get the version of the protobuf-c library. Note that this is the version of
780
+ * the library linked against, not the version of the headers compiled against.
781
+ *
782
+ * \return A 32 bit unsigned integer containing the version number of
783
+ * protobuf-c, represented in base-10 as (MAJOR*1E6) + (MINOR*1E3) + PATCH.
784
+ */
785
+ PROTOBUF_C__API
786
+ uint32_t
787
+ protobuf_c_version_number(void);
788
+
789
+ /**
790
+ * The version of the protobuf-c headers, represented as a string using the same
791
+ * format as protobuf_c_version().
792
+ */
793
+ #define PROTOBUF_C_VERSION "1.3.3"
794
+
795
+ /**
796
+ * The version of the protobuf-c headers, represented as an integer using the
797
+ * same format as protobuf_c_version_number().
798
+ */
799
+ #define PROTOBUF_C_VERSION_NUMBER 1003003
800
+
801
+ /**
802
+ * The minimum protoc-c version which works with the current version of the
803
+ * protobuf-c headers.
804
+ */
805
+ #define PROTOBUF_C_MIN_COMPILER_VERSION 1000000
806
+
807
+ /**
808
+ * Look up a `ProtobufCEnumValue` from a `ProtobufCEnumDescriptor` by name.
809
+ *
810
+ * \param desc
811
+ * The `ProtobufCEnumDescriptor` object.
812
+ * \param name
813
+ * The `name` field from the corresponding `ProtobufCEnumValue` object to
814
+ * match.
815
+ * \return
816
+ * A `ProtobufCEnumValue` object.
817
+ * \retval NULL
818
+ * If not found or if the optimize_for = CODE_SIZE option was set.
819
+ */
820
+ PROTOBUF_C__API
821
+ const ProtobufCEnumValue *
822
+ protobuf_c_enum_descriptor_get_value_by_name(
823
+ const ProtobufCEnumDescriptor *desc,
824
+ const char *name);
825
+
826
+ /**
827
+ * Look up a `ProtobufCEnumValue` from a `ProtobufCEnumDescriptor` by numeric
828
+ * value.
829
+ *
830
+ * \param desc
831
+ * The `ProtobufCEnumDescriptor` object.
832
+ * \param value
833
+ * The `value` field from the corresponding `ProtobufCEnumValue` object to
834
+ * match.
835
+ *
836
+ * \return
837
+ * A `ProtobufCEnumValue` object.
838
+ * \retval NULL
839
+ * If not found.
840
+ */
841
+ PROTOBUF_C__API
842
+ const ProtobufCEnumValue *
843
+ protobuf_c_enum_descriptor_get_value(
844
+ const ProtobufCEnumDescriptor *desc,
845
+ int value);
846
+
847
+ /**
848
+ * Look up a `ProtobufCFieldDescriptor` from a `ProtobufCMessageDescriptor` by
849
+ * the name of the field.
850
+ *
851
+ * \param desc
852
+ * The `ProtobufCMessageDescriptor` object.
853
+ * \param name
854
+ * The name of the field.
855
+ * \return
856
+ * A `ProtobufCFieldDescriptor` object.
857
+ * \retval NULL
858
+ * If not found or if the optimize_for = CODE_SIZE option was set.
859
+ */
860
+ PROTOBUF_C__API
861
+ const ProtobufCFieldDescriptor *
862
+ protobuf_c_message_descriptor_get_field_by_name(
863
+ const ProtobufCMessageDescriptor *desc,
864
+ const char *name);
865
+
866
+ /**
867
+ * Look up a `ProtobufCFieldDescriptor` from a `ProtobufCMessageDescriptor` by
868
+ * the tag value of the field.
869
+ *
870
+ * \param desc
871
+ * The `ProtobufCMessageDescriptor` object.
872
+ * \param value
873
+ * The tag value of the field.
874
+ * \return
875
+ * A `ProtobufCFieldDescriptor` object.
876
+ * \retval NULL
877
+ * If not found.
878
+ */
879
+ PROTOBUF_C__API
880
+ const ProtobufCFieldDescriptor *
881
+ protobuf_c_message_descriptor_get_field(
882
+ const ProtobufCMessageDescriptor *desc,
883
+ unsigned value);
884
+
885
+ /**
886
+ * Determine the number of bytes required to store the serialised message.
887
+ *
888
+ * \param message
889
+ * The message object to serialise.
890
+ * \return
891
+ * Number of bytes.
892
+ */
893
+ PROTOBUF_C__API
894
+ size_t
895
+ protobuf_c_message_get_packed_size(const ProtobufCMessage *message);
896
+
897
+ /**
898
+ * Serialise a message from its in-memory representation.
899
+ *
900
+ * This function stores the serialised bytes of the message in a pre-allocated
901
+ * buffer.
902
+ *
903
+ * \param message
904
+ * The message object to serialise.
905
+ * \param[out] out
906
+ * Buffer to store the bytes of the serialised message. This buffer must
907
+ * have enough space to store the packed message. Use
908
+ * protobuf_c_message_get_packed_size() to determine the number of bytes
909
+ * required.
910
+ * \return
911
+ * Number of bytes stored in `out`.
912
+ */
913
+ PROTOBUF_C__API
914
+ size_t
915
+ protobuf_c_message_pack(const ProtobufCMessage *message, uint8_t *out);
916
+
917
+ /**
918
+ * Serialise a message from its in-memory representation to a virtual buffer.
919
+ *
920
+ * This function calls the `append` method of a `ProtobufCBuffer` object to
921
+ * consume the bytes generated by the serialiser.
922
+ *
923
+ * \param message
924
+ * The message object to serialise.
925
+ * \param buffer
926
+ * The virtual buffer object.
927
+ * \return
928
+ * Number of bytes passed to the virtual buffer.
929
+ */
930
+ PROTOBUF_C__API
931
+ size_t
932
+ protobuf_c_message_pack_to_buffer(
933
+ const ProtobufCMessage *message,
934
+ ProtobufCBuffer *buffer);
935
+
936
+ /**
937
+ * Unpack a serialised message into an in-memory representation.
938
+ *
939
+ * \param descriptor
940
+ * The message descriptor.
941
+ * \param allocator
942
+ * `ProtobufCAllocator` to use for memory allocation. May be NULL to
943
+ * specify the default allocator.
944
+ * \param len
945
+ * Length in bytes of the serialised message.
946
+ * \param data
947
+ * Pointer to the serialised message.
948
+ * \return
949
+ * An unpacked message object.
950
+ * \retval NULL
951
+ * If an error occurred during unpacking.
952
+ */
953
+ PROTOBUF_C__API
954
+ ProtobufCMessage *
955
+ protobuf_c_message_unpack(
956
+ const ProtobufCMessageDescriptor *descriptor,
957
+ ProtobufCAllocator *allocator,
958
+ size_t len,
959
+ const uint8_t *data);
960
+
961
+ /**
962
+ * Free an unpacked message object.
963
+ *
964
+ * This function should be used to deallocate the memory used by a call to
965
+ * protobuf_c_message_unpack().
966
+ *
967
+ * \param message
968
+ * The message object to free. May be NULL.
969
+ * \param allocator
970
+ * `ProtobufCAllocator` to use for memory deallocation. May be NULL to
971
+ * specify the default allocator.
972
+ */
973
+ PROTOBUF_C__API
974
+ void
975
+ protobuf_c_message_free_unpacked(
976
+ ProtobufCMessage *message,
977
+ ProtobufCAllocator *allocator);
978
+
979
+ /**
980
+ * Check the validity of a message object.
981
+ *
982
+ * Makes sure all required fields (`PROTOBUF_C_LABEL_REQUIRED`) are present.
983
+ * Recursively checks nested messages.
984
+ *
985
+ * \retval TRUE
986
+ * Message is valid.
987
+ * \retval FALSE
988
+ * Message is invalid.
989
+ */
990
+ PROTOBUF_C__API
991
+ protobuf_c_boolean
992
+ protobuf_c_message_check(const ProtobufCMessage *);
993
+
994
+ /** Message initialiser. */
995
+ #define PROTOBUF_C_MESSAGE_INIT(descriptor) { descriptor, 0, NULL }
996
+
997
+ /**
998
+ * Initialise a message object from a message descriptor.
999
+ *
1000
+ * \param descriptor
1001
+ * Message descriptor.
1002
+ * \param message
1003
+ * Allocated block of memory of size `descriptor->sizeof_message`.
1004
+ */
1005
+ PROTOBUF_C__API
1006
+ void
1007
+ protobuf_c_message_init(
1008
+ const ProtobufCMessageDescriptor *descriptor,
1009
+ void *message);
1010
+
1011
+ /**
1012
+ * Free a service.
1013
+ *
1014
+ * \param service
1015
+ * The service object to free.
1016
+ */
1017
+ PROTOBUF_C__API
1018
+ void
1019
+ protobuf_c_service_destroy(ProtobufCService *service);
1020
+
1021
+ /**
1022
+ * Look up a `ProtobufCMethodDescriptor` by name.
1023
+ *
1024
+ * \param desc
1025
+ * Service descriptor.
1026
+ * \param name
1027
+ * Name of the method.
1028
+ *
1029
+ * \return
1030
+ * A `ProtobufCMethodDescriptor` object.
1031
+ * \retval NULL
1032
+ * If not found or if the optimize_for = CODE_SIZE option was set.
1033
+ */
1034
+ PROTOBUF_C__API
1035
+ const ProtobufCMethodDescriptor *
1036
+ protobuf_c_service_descriptor_get_method_by_name(
1037
+ const ProtobufCServiceDescriptor *desc,
1038
+ const char *name);
1039
+
1040
+ /**
1041
+ * Initialise a `ProtobufCBufferSimple` object.
1042
+ */
1043
+ #define PROTOBUF_C_BUFFER_SIMPLE_INIT(array_of_bytes) \
1044
+ { \
1045
+ { protobuf_c_buffer_simple_append }, \
1046
+ sizeof(array_of_bytes), \
1047
+ 0, \
1048
+ (array_of_bytes), \
1049
+ 0, \
1050
+ NULL \
1051
+ }
1052
+
1053
+ /**
1054
+ * Clear a `ProtobufCBufferSimple` object, freeing any allocated memory.
1055
+ */
1056
+ #define PROTOBUF_C_BUFFER_SIMPLE_CLEAR(simp_buf) \
1057
+ do { \
1058
+ if ((simp_buf)->must_free_data) { \
1059
+ if ((simp_buf)->allocator != NULL) \
1060
+ (simp_buf)->allocator->free( \
1061
+ (simp_buf)->allocator, \
1062
+ (simp_buf)->data); \
1063
+ else \
1064
+ free((simp_buf)->data); \
1065
+ } \
1066
+ } while (0)
1067
+
1068
+ /**
1069
+ * The `append` method for `ProtobufCBufferSimple`.
1070
+ *
1071
+ * \param buffer
1072
+ * The buffer object to append to. Must actually be a
1073
+ * `ProtobufCBufferSimple` object.
1074
+ * \param len
1075
+ * Number of bytes in `data`.
1076
+ * \param data
1077
+ * Data to append.
1078
+ */
1079
+ PROTOBUF_C__API
1080
+ void
1081
+ protobuf_c_buffer_simple_append(
1082
+ ProtobufCBuffer *buffer,
1083
+ size_t len,
1084
+ const unsigned char *data);
1085
+
1086
+ PROTOBUF_C__API
1087
+ void
1088
+ protobuf_c_service_generated_init(
1089
+ ProtobufCService *service,
1090
+ const ProtobufCServiceDescriptor *descriptor,
1091
+ ProtobufCServiceDestroy destroy);
1092
+
1093
+ PROTOBUF_C__API
1094
+ void
1095
+ protobuf_c_service_invoke_internal(
1096
+ ProtobufCService *service,
1097
+ unsigned method_index,
1098
+ const ProtobufCMessage *input,
1099
+ ProtobufCClosure closure,
1100
+ void *closure_data);
1101
+
1102
+ /**@}*/
1103
+
1104
+ PROTOBUF_C__END_DECLS
1105
+
1106
+ #endif /* PROTOBUF_C_H */