<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>HTP: bstr_builder.c 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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">HTP
 <span id="projectnumber">0.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_5edaa2d740570af18be6e40ef0aff597.html">htp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">bstr_builder.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="bstr_8h_source.html">bstr.h</a>"</code><br/>
<code>#include "<a class="el" href="htp__list_8h_source.html">htp_list.h</a>"</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7960a70d5805c6923451a0d1672c958e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#a7960a70d5805c6923451a0d1672c958e">bstr_builder_appendn</a> (<a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb, <a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> *b)</td></tr>
<tr class="separator:a7960a70d5805c6923451a0d1672c958e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af321d8263825604b52bae18b9c86133d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#af321d8263825604b52bae18b9c86133d">bstr_builder_append_c</a> (<a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb, const char *cstr)</td></tr>
<tr class="separator:af321d8263825604b52bae18b9c86133d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d3f608e4787b2e01540b2e675fd3565"><td class="memItemLeft" align="right" valign="top"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#a1d3f608e4787b2e01540b2e675fd3565">bstr_builder_append_mem</a> (<a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb, const void *data, size_t len)</td></tr>
<tr class="separator:a1d3f608e4787b2e01540b2e675fd3565"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b2387b545c3ebc9cfbeae4c3ede3e8b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#a1b2387b545c3ebc9cfbeae4c3ede3e8b">bstr_builder_clear</a> (<a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb)</td></tr>
<tr class="separator:a1b2387b545c3ebc9cfbeae4c3ede3e8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cda5d2f8e4a0529b31f67eff4f65a51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#a6cda5d2f8e4a0529b31f67eff4f65a51">bstr_builder_create</a> ()</td></tr>
<tr class="separator:a6cda5d2f8e4a0529b31f67eff4f65a51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c90e3030e9ab7bf81caf09a76c57ec9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#a4c90e3030e9ab7bf81caf09a76c57ec9">bstr_builder_destroy</a> (<a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb)</td></tr>
<tr class="separator:a4c90e3030e9ab7bf81caf09a76c57ec9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a015b1e7016ec84c36209f03ec96a7a49"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#a015b1e7016ec84c36209f03ec96a7a49">bstr_builder_size</a> (const <a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb)</td></tr>
<tr class="separator:a015b1e7016ec84c36209f03ec96a7a49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa20111ccd65d633649a4b4cf9b711954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="bstr__builder_8c.html#aa20111ccd65d633649a4b4cf9b711954">bstr_builder_to_str</a> (const <a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> *bb)</td></tr>
<tr class="separator:aa20111ccd65d633649a4b4cf9b711954"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Ivan Ristic <a href="#" onclick="location.href='mai'+'lto:'+'iva'+'nr'+'@we'+'bk'+'rea'+'to'+'r.c'+'om'; return false;">ivanr<span style="display: none;">.nosp@m.</span>@web<span style="display: none;">.nosp@m.</span>kreat<span style="display: none;">.nosp@m.</span>or.c<span style="display: none;">.nosp@m.</span>om</a> </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="af321d8263825604b52bae18b9c86133d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> bstr_builder_append_c </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cstr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds one new piece, in the form of a NUL-terminated string, to the builder. This function will make a copy of the provided string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cstr</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>HTP_OK on success, HTP_ERROR on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a1d3f608e4787b2e01540b2e675fd3565"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> bstr_builder_append_mem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </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>Adds one new piece, defined with the supplied pointer and length, to the builder. This function will make a copy of the provided data region.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd>
<dd>
HTP_OK on success, HTP_ERROR on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a7960a70d5805c6923451a0d1672c958e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="htp__core_8h.html#ab8a71422665c0773654b9b4d96f01e31">htp_status_t</a> bstr_builder_appendn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a> * </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds one new string to the builder. This function will adopt the string and destroy it when the builder itself is destroyed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">b</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>HTP_OK on success, HTP_ERROR on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a1b2387b545c3ebc9cfbeae4c3ede3e8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bstr_builder_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears this string builder, destroying all existing pieces. You may want to clear a builder once you've either read all the pieces and done something with them, or after you've converted the builder into a single string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6cda5d2f8e4a0529b31f67eff4f65a51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a>* bstr_builder_create </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new string builder.</p>
<dl class="section return"><dt>Returns</dt><dd>New string builder, or NULL on error. </dd></dl>
</div>
</div>
<a class="anchor" id="a4c90e3030e9ab7bf81caf09a76c57ec9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bstr_builder_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys an existing string builder, also destroying all the pieces stored within.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a015b1e7016ec84c36209f03ec96a7a49"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t bstr_builder_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size (the number of pieces) currently in a string builder.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size </dd></dl>
</div>
</div>
<a class="anchor" id="aa20111ccd65d633649a4b4cf9b711954"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="bstr_8h.html#ad24e3759c8d17c13ae2f05d9dde4d0b6">bstr</a>* bstr_builder_to_str </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbstr__builder__t.html">bstr_builder_t</a> * </td>
<td class="paramname"><em>bb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a single string out of all the pieces held in a string builder. This method will not destroy any of the pieces.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bb</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>New string, or NULL on error. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
distrib
>
Fedora
>
20
>
x86_64
>
media
>
updates
>
by-pkgid
>
c579c38484b8ffa244858626df1128ca
>
files
>
9
