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.

printbuf_8h.html 20 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>json-c: printbuf.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">json-c
  21. &#160;<span id="projectnumber">0.13.1</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  35. <li class="current"><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="files.html"><span>File&#160;List</span></a></li>
  41. <li><a href="globals.html"><span>Globals</span></a></li>
  42. </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#nested-classes">Data Structures</a> &#124;
  48. <a href="#define-members">Macros</a> &#124;
  49. <a href="#typedef-members">Typedefs</a> &#124;
  50. <a href="#func-members">Functions</a> </div>
  51. <div class="headertitle">
  52. <div class="title">printbuf.h File Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Internal string buffer handing. Unless you're writing a json_object_to_json_string_fn implementation for use with <a class="el" href="json__object_8h.html#a889345512a214b8f78f6a73561523c7c">json_object_set_serializer()</a> direct use of this is not recommended.
  56. <a href="#details">More...</a></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  59. Data Structures</h2></td></tr>
  60. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structprintbuf.html">printbuf</a></td></tr>
  61. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. </table><table class="memberdecls">
  63. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  64. Macros</h2></td></tr>
  65. <tr class="memitem:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast</a>(p, bufptr, bufsize)</td></tr>
  66. <tr class="separator:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:acdd84ad88987c0166b7ba0e3f1f8f1bb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#acdd84ad88987c0166b7ba0e3f1f8f1bb">printbuf_length</a>(p)&#160;&#160;&#160;((p)-&gt;bpos)</td></tr>
  68. <tr class="separator:acdd84ad88987c0166b7ba0e3f1f8f1bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ab009973c5e15aae191e610cd70752603"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#ab009973c5e15aae191e610cd70752603">_printbuf_check_literal</a>(mystr)&#160;&#160;&#160;(&quot;&quot; mystr)</td></tr>
  70. <tr class="separator:ab009973c5e15aae191e610cd70752603"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a2f30492682f5fbc59a8749b428e0e4ba">printbuf_strappend</a>(pb, str)&#160;&#160;&#160;<a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a> ((pb), <a class="el" href="printbuf_8h.html#ab009973c5e15aae191e610cd70752603">_printbuf_check_literal</a>(str), sizeof(str) - 1)</td></tr>
  72. <tr class="separator:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. </table><table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  75. Typedefs</h2></td></tr>
  76. <tr class="memitem:ace274df280df67463ff417b1b3392395"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structprintbuf.html">printbuf</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#ace274df280df67463ff417b1b3392395">printbuf</a></td></tr>
  77. <tr class="separator:ace274df280df67463ff417b1b3392395"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table><table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  80. Functions</h2></td></tr>
  81. <tr class="memitem:a3e390ebc7660a18335edd89f640fd415"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structprintbuf.html">printbuf</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a3e390ebc7660a18335edd89f640fd415">printbuf_new</a> (void)</td></tr>
  82. <tr class="separator:a3e390ebc7660a18335edd89f640fd415"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a22f09779a19db59a83e7cb8c2ce4c75f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p, const char *buf, int size)</td></tr>
  84. <tr class="separator:a22f09779a19db59a83e7cb8c2ce4c75f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ad7fc6ec4c296e85abf404244614cded5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#ad7fc6ec4c296e85abf404244614cded5">printbuf_memset</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *pb, int offset, int charvalue, int len)</td></tr>
  86. <tr class="separator:ad7fc6ec4c296e85abf404244614cded5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:adf6214db6c8ce994c7f7f1180863c8a4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#adf6214db6c8ce994c7f7f1180863c8a4">sprintbuf</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p, const char *msg,...)</td></tr>
  88. <tr class="separator:adf6214db6c8ce994c7f7f1180863c8a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a4393ee3dedb376af11c96fe97532292e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a4393ee3dedb376af11c96fe97532292e">printbuf_reset</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p)</td></tr>
  90. <tr class="separator:a4393ee3dedb376af11c96fe97532292e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ab525221c767ac65c58ddeea8a655a4e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#ab525221c767ac65c58ddeea8a655a4e8">printbuf_free</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p)</td></tr>
  92. <tr class="separator:ab525221c767ac65c58ddeea8a655a4e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  95. <div class="textblock"><p>Internal string buffer handing. Unless you're writing a json_object_to_json_string_fn implementation for use with <a class="el" href="json__object_8h.html#a889345512a214b8f78f6a73561523c7c">json_object_set_serializer()</a> direct use of this is not recommended. </p>
  96. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  97. <a class="anchor" id="ab009973c5e15aae191e610cd70752603"></a>
  98. <div class="memitem">
  99. <div class="memproto">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname">#define _printbuf_check_literal</td>
  103. <td>(</td>
  104. <td class="paramtype">&#160;</td>
  105. <td class="paramname">mystr</td><td>)</td>
  106. <td>&#160;&#160;&#160;(&quot;&quot; mystr)</td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p>Results in a compile error if the argument is not a string literal. </p>
  111. </div>
  112. </div>
  113. <a class="anchor" id="acdd84ad88987c0166b7ba0e3f1f8f1bb"></a>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">#define printbuf_length</td>
  119. <td>(</td>
  120. <td class="paramtype">&#160;</td>
  121. <td class="paramname">p</td><td>)</td>
  122. <td>&#160;&#160;&#160;((p)-&gt;bpos)</td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. </div>
  127. </div>
  128. <a class="anchor" id="a6f3a4dc87fab41c37e3eff42f40dc346"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">#define printbuf_memappend_fast</td>
  134. <td>(</td>
  135. <td class="paramtype">&#160;</td>
  136. <td class="paramname">p, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">&#160;</td>
  142. <td class="paramname">bufptr, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">&#160;</td>
  148. <td class="paramname">bufsize&#160;</td>
  149. </tr>
  150. <tr>
  151. <td></td>
  152. <td>)</td>
  153. <td></td><td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
  158. <div class="line"> if ((p-&gt;size - p-&gt;bpos) &gt; bufsize) { \</div>
  159. <div class="line"> memcpy(p-&gt;buf + p-&gt;bpos, (bufptr), bufsize); \</div>
  160. <div class="line"> p-&gt;bpos += bufsize; \</div>
  161. <div class="line"> p-&gt;buf[p-&gt;bpos]= <span class="charliteral">&#39;\0&#39;</span>; \</div>
  162. <div class="line"> } <span class="keywordflow">else</span> { <a class="code" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a>(p, (bufptr), bufsize); } \</div>
  163. <div class="line">} <span class="keywordflow">while</span> (0)</div>
  164. <div class="ttc" id="printbuf_8h_html_a22f09779a19db59a83e7cb8c2ce4c75f"><div class="ttname"><a href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a></div><div class="ttdeci">int printbuf_memappend(struct printbuf *p, const char *buf, int size)</div></div>
  165. </div><!-- fragment -->
  166. </div>
  167. </div>
  168. <a class="anchor" id="a2f30492682f5fbc59a8749b428e0e4ba"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">#define printbuf_strappend</td>
  174. <td>(</td>
  175. <td class="paramtype">&#160;</td>
  176. <td class="paramname">pb, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">&#160;</td>
  182. <td class="paramname">str&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td>&#160;&#160;&#160;<a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a> ((pb), <a class="el" href="printbuf_8h.html#ab009973c5e15aae191e610cd70752603">_printbuf_check_literal</a>(str), sizeof(str) - 1)</td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>This is an optimization wrapper around <a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend()</a> that is useful for appending string literals. Since the size of string constants is known at compile time, using this macro can avoid a costly strlen() call. This is especially helpful when a constant string must be appended many times. If you got here because of a compilation error caused by passing something other than a string literal, use <a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast()</a> in conjunction with strlen().</p>
  192. <p>See also: <a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast()</a> <a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend()</a> <a class="el" href="printbuf_8h.html#adf6214db6c8ce994c7f7f1180863c8a4">sprintbuf()</a> </p>
  193. </div>
  194. </div>
  195. <h2 class="groupheader">Typedef Documentation</h2>
  196. <a class="anchor" id="ace274df280df67463ff417b1b3392395"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">typedef struct <a class="el" href="structprintbuf.html">printbuf</a> <a class="el" href="structprintbuf.html">printbuf</a></td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. </div>
  206. </div>
  207. <h2 class="groupheader">Function Documentation</h2>
  208. <a class="anchor" id="ab525221c767ac65c58ddeea8a655a4e8"></a>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">void printbuf_free </td>
  214. <td>(</td>
  215. <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> *&#160;</td>
  216. <td class="paramname"><em>p</em></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. </div>
  222. </div>
  223. <a class="anchor" id="a22f09779a19db59a83e7cb8c2ce4c75f"></a>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">int printbuf_memappend </td>
  229. <td>(</td>
  230. <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> *&#160;</td>
  231. <td class="paramname"><em>p</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">const char *&#160;</td>
  237. <td class="paramname"><em>buf</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype">int&#160;</td>
  243. <td class="paramname"><em>size</em>&#160;</td>
  244. </tr>
  245. <tr>
  246. <td></td>
  247. <td>)</td>
  248. <td></td><td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <a class="anchor" id="ad7fc6ec4c296e85abf404244614cded5"></a>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">int printbuf_memset </td>
  260. <td>(</td>
  261. <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> *&#160;</td>
  262. <td class="paramname"><em>pb</em>, </td>
  263. </tr>
  264. <tr>
  265. <td class="paramkey"></td>
  266. <td></td>
  267. <td class="paramtype">int&#160;</td>
  268. <td class="paramname"><em>offset</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">int&#160;</td>
  274. <td class="paramname"><em>charvalue</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype">int&#160;</td>
  280. <td class="paramname"><em>len</em>&#160;</td>
  281. </tr>
  282. <tr>
  283. <td></td>
  284. <td>)</td>
  285. <td></td><td></td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Set len bytes of the buffer to charvalue, starting at offset offset. Similar to calling memset(x, charvalue, len);</p>
  290. <p>The memory allocated for the buffer is extended as necessary.</p>
  291. <p>If offset is -1, this starts at the end of the current data in the buffer. </p>
  292. </div>
  293. </div>
  294. <a class="anchor" id="a3e390ebc7660a18335edd89f640fd415"></a>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">struct <a class="el" href="structprintbuf.html">printbuf</a>* printbuf_new </td>
  300. <td>(</td>
  301. <td class="paramtype">void&#160;</td>
  302. <td class="paramname"></td><td>)</td>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. </div>
  308. </div>
  309. <a class="anchor" id="a4393ee3dedb376af11c96fe97532292e"></a>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">void printbuf_reset </td>
  315. <td>(</td>
  316. <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> *&#160;</td>
  317. <td class="paramname"><em>p</em></td><td>)</td>
  318. <td></td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. </div>
  323. </div>
  324. <a class="anchor" id="adf6214db6c8ce994c7f7f1180863c8a4"></a>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">int sprintbuf </td>
  330. <td>(</td>
  331. <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> *&#160;</td>
  332. <td class="paramname"><em>p</em>, </td>
  333. </tr>
  334. <tr>
  335. <td class="paramkey"></td>
  336. <td></td>
  337. <td class="paramtype">const char *&#160;</td>
  338. <td class="paramname"><em>msg</em>, </td>
  339. </tr>
  340. <tr>
  341. <td class="paramkey"></td>
  342. <td></td>
  343. <td class="paramtype">&#160;</td>
  344. <td class="paramname"><em>...</em>&#160;</td>
  345. </tr>
  346. <tr>
  347. <td></td>
  348. <td>)</td>
  349. <td></td><td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Formatted print to printbuf.</p>
  354. <p>This function is the most expensive of the available functions for appending string data to a printbuf and should be used only where convenience is more important than speed. Avoid using this function in high performance code or tight loops; in these scenarios, consider using snprintf() with a static buffer in conjunction with one of the printbuf_*append() functions.</p>
  355. <p>See also: <a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast()</a> <a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend()</a> <a class="el" href="printbuf_8h.html#a2f30492682f5fbc59a8749b428e0e4ba">printbuf_strappend()</a> </p>
  356. </div>
  357. </div>
  358. </div><!-- contents -->
  359. <!-- start footer part -->
  360. <hr class="footer"/><address class="footer"><small>
  361. Generated on Mon Mar 5 2018 23:17:09 for json-c by &#160;<a href="http://www.doxygen.org/index.html">
  362. <img class="footer" src="doxygen.png" alt="doxygen"/>
  363. </a> 1.8.8
  364. </small></address>
  365. </body>
  366. </html>

No Description