|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.4"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>json-c: printbuf.h File Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">json-c<span id="projectnumber"> 0.18</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.4 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#define-members">Macros</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle"><div class="title">printbuf.h File Reference</div></div>
- </div><!--header-->
- <div class="contents">
-
- <p>Internal string buffer handling. 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.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structprintbuf.html">printbuf</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:a2a31d5c00f3a4712f2d5d62aee66344e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a>   extern</td></tr>
- <tr class="separator:a2a31d5c00f3a4712f2d5d62aee66344e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast</a>(p, bufptr, bufsize)</td></tr>
- <tr class="separator:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acdd84ad88987c0166b7ba0e3f1f8f1bb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#acdd84ad88987c0166b7ba0e3f1f8f1bb">printbuf_length</a>(p)   ((p)->bpos)</td></tr>
- <tr class="separator:acdd84ad88987c0166b7ba0e3f1f8f1bb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a2f30492682f5fbc59a8749b428e0e4ba">printbuf_strappend</a>(pb, str)    <a class="el" href="printbuf_8h.html#a9c193d30e9ca4936ea28a6c9e8e4f6f0">printbuf_memappend</a>((pb), _printbuf_check_literal(str), sizeof(str) - 1)</td></tr>
- <tr class="separator:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:ace274df280df67463ff417b1b3392395"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structprintbuf.html">printbuf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#ace274df280df67463ff417b1b3392395">printbuf</a></td></tr>
- <tr class="separator:ace274df280df67463ff417b1b3392395"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a569dcc73d06828580ab6d9034bf78fea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="structprintbuf.html">printbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a569dcc73d06828580ab6d9034bf78fea">printbuf_new</a> (void)</td></tr>
- <tr class="separator:a569dcc73d06828580ab6d9034bf78fea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9c193d30e9ca4936ea28a6c9e8e4f6f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a9c193d30e9ca4936ea28a6c9e8e4f6f0">printbuf_memappend</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p, const char *buf, int size)</td></tr>
- <tr class="separator:a9c193d30e9ca4936ea28a6c9e8e4f6f0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a93a27f4f8a092c58666724de23ae804d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a93a27f4f8a092c58666724de23ae804d">printbuf_memset</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *pb, int offset, int charvalue, int len)</td></tr>
- <tr class="separator:a93a27f4f8a092c58666724de23ae804d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a61f6bc0b1ca5787f0faca6799d61a0bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a61f6bc0b1ca5787f0faca6799d61a0bb">sprintbuf</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p, const char *msg,...)</td></tr>
- <tr class="separator:a61f6bc0b1ca5787f0faca6799d61a0bb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a705c62167df13e65e04de9ae60f6e136"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a705c62167df13e65e04de9ae60f6e136">printbuf_reset</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p)</td></tr>
- <tr class="separator:a705c62167df13e65e04de9ae60f6e136"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2b744266191ef5e3102fbf910e790a98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a2b744266191ef5e3102fbf910e790a98">printbuf_free</a> (struct <a class="el" href="structprintbuf.html">printbuf</a> *p)</td></tr>
- <tr class="separator:a2b744266191ef5e3102fbf910e790a98"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p >Internal string buffer handling. 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>
- </div><h2 class="groupheader">Macro Definition Documentation</h2>
- <a id="a2a31d5c00f3a4712f2d5d62aee66344e" name="a2a31d5c00f3a4712f2d5d62aee66344e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2a31d5c00f3a4712f2d5d62aee66344e">◆ </a></span>JSON_EXPORT</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define JSON_EXPORT   extern</td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <a id="acdd84ad88987c0166b7ba0e3f1f8f1bb" name="acdd84ad88987c0166b7ba0e3f1f8f1bb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acdd84ad88987c0166b7ba0e3f1f8f1bb">◆ </a></span>printbuf_length</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define printbuf_length</td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname">p</td><td>)</td>
- <td>   ((p)->bpos)</td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <a id="a6f3a4dc87fab41c37e3eff42f40dc346" name="a6f3a4dc87fab41c37e3eff42f40dc346"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6f3a4dc87fab41c37e3eff42f40dc346">◆ </a></span>printbuf_memappend_fast</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define printbuf_memappend_fast</td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname">p, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname">bufptr, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname">bufsize </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> \</div>
- <div class="line"> { \</div>
- <div class="line"> if ((p->size - p->bpos) > bufsize) \</div>
- <div class="line"> { \</div>
- <div class="line"> memcpy(p->buf + p->bpos, (bufptr), bufsize); \</div>
- <div class="line"> p->bpos += bufsize; \</div>
- <div class="line"> p->buf[p->bpos] = <span class="charliteral">'\0'</span>; \</div>
- <div class="line"> } \</div>
- <div class="line"> else \</div>
- <div class="line"> { \</div>
- <div class="line"> printbuf_memappend(p, (bufptr), bufsize); \</div>
- <div class="line"> } \</div>
- <div class="line"> } <span class="keywordflow">while</span> (0)</div>
- </div><!-- fragment -->
- </div>
- </div>
- <a id="a2f30492682f5fbc59a8749b428e0e4ba" name="a2f30492682f5fbc59a8749b428e0e4ba"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2f30492682f5fbc59a8749b428e0e4ba">◆ </a></span>printbuf_strappend</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define printbuf_strappend</td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname">pb, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname">str </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td>    <a class="el" href="printbuf_8h.html#a9c193d30e9ca4936ea28a6c9e8e4f6f0">printbuf_memappend</a>((pb), _printbuf_check_literal(str), sizeof(str) - 1)</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p >This is an optimization wrapper around <a class="el" href="printbuf_8h.html#a9c193d30e9ca4936ea28a6c9e8e4f6f0">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>
- <p >See also: <a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast()</a> <a class="el" href="printbuf_8h.html#a9c193d30e9ca4936ea28a6c9e8e4f6f0">printbuf_memappend()</a> <a class="el" href="printbuf_8h.html#a61f6bc0b1ca5787f0faca6799d61a0bb">sprintbuf()</a> </p>
-
- </div>
- </div>
- <h2 class="groupheader">Typedef Documentation</h2>
- <a id="ace274df280df67463ff417b1b3392395" name="ace274df280df67463ff417b1b3392395"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ace274df280df67463ff417b1b3392395">◆ </a></span>printbuf</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef struct <a class="el" href="structprintbuf.html">printbuf</a> <a class="el" href="structprintbuf.html">printbuf</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="a2b744266191ef5e3102fbf910e790a98" name="a2b744266191ef5e3102fbf910e790a98"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2b744266191ef5e3102fbf910e790a98">◆ </a></span>printbuf_free()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> void printbuf_free </td>
- <td>(</td>
- <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> * </td>
- <td class="paramname"><em>p</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <a id="a9c193d30e9ca4936ea28a6c9e8e4f6f0" name="a9c193d30e9ca4936ea28a6c9e8e4f6f0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9c193d30e9ca4936ea28a6c9e8e4f6f0">◆ </a></span>printbuf_memappend()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int printbuf_memappend </td>
- <td>(</td>
- <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> * </td>
- <td class="paramname"><em>p</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>buf</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <a id="a93a27f4f8a092c58666724de23ae804d" name="a93a27f4f8a092c58666724de23ae804d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a93a27f4f8a092c58666724de23ae804d">◆ </a></span>printbuf_memset()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int printbuf_memset </td>
- <td>(</td>
- <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> * </td>
- <td class="paramname"><em>pb</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>offset</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>charvalue</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>len</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p >Set len bytes of the buffer to charvalue, starting at offset offset. Similar to calling memset(x, charvalue, len);</p>
- <p >The memory allocated for the buffer is extended as necessary.</p>
- <p >If offset is -1, this starts at the end of the current data in the buffer. </p>
-
- </div>
- </div>
- <a id="a569dcc73d06828580ab6d9034bf78fea" name="a569dcc73d06828580ab6d9034bf78fea"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a569dcc73d06828580ab6d9034bf78fea">◆ </a></span>printbuf_new()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> struct <a class="el" href="structprintbuf.html">printbuf</a> * printbuf_new </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <a id="a705c62167df13e65e04de9ae60f6e136" name="a705c62167df13e65e04de9ae60f6e136"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a705c62167df13e65e04de9ae60f6e136">◆ </a></span>printbuf_reset()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> void printbuf_reset </td>
- <td>(</td>
- <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> * </td>
- <td class="paramname"><em>p</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- </div>
- </div>
- <a id="a61f6bc0b1ca5787f0faca6799d61a0bb" name="a61f6bc0b1ca5787f0faca6799d61a0bb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a61f6bc0b1ca5787f0faca6799d61a0bb">◆ </a></span>sprintbuf()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="printbuf_8h.html#a2a31d5c00f3a4712f2d5d62aee66344e">JSON_EXPORT</a> int sprintbuf </td>
- <td>(</td>
- <td class="paramtype">struct <a class="el" href="structprintbuf.html">printbuf</a> * </td>
- <td class="paramname"><em>p</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>msg</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>...</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p >Formatted print to printbuf.</p>
- <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>
- <p >See also: <a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast()</a> <a class="el" href="printbuf_8h.html#a9c193d30e9ca4936ea28a6c9e8e4f6f0">printbuf_memappend()</a> <a class="el" href="printbuf_8h.html#a2f30492682f5fbc59a8749b428e0e4ba">printbuf_strappend()</a> </p>
-
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Sun Sep 15 2024 16:22:28 for json-c by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
- </small></address>
- </body>
- </html>
|