|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21573/root/usr/share/devhelp/books/dbus/api/ |
Upload File : |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>D-Bus: DBusString implementation details</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<h1>DBusString implementation details<br>
<small>
[<a class="el" href="group__DBusInternals.html">D-Bus secret internal implementation details</a>]</small>
</h1><a class="el" href="structDBusString.html">DBusString</a> implementation details.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gff1c3814294a9db8ea968d159e8fd092"></a><!-- doxytag: member="DBusStringInternals::_DBUS_STRING_MAX_MAX_LENGTH" ref="gff1c3814294a9db8ea968d159e8fd092" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#gff1c3814294a9db8ea968d159e8fd092">_DBUS_STRING_MAX_MAX_LENGTH</a> (_DBUS_INT32_MAX - _DBUS_STRING_ALLOCATION_PADDING)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the maximum max length (and thus also the maximum length) of a <a class="el" href="structDBusString.html">DBusString</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#g862cb88a139179981e1fcd5643165b56">DBUS_GENERIC_STRING_PREAMBLE</a>(real) _dbus_assert ((real) != NULL); _dbus_assert (!(real)->invalid); _dbus_assert ((real)->len >= 0); _dbus_assert ((real)->allocated >= 0); _dbus_assert ((real)->max_length >= 0); _dbus_assert ((real)->len <= ((real)->allocated - _DBUS_STRING_ALLOCATION_PADDING)); _dbus_assert ((real)->len <= (real)->max_length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks a bunch of assertions about a string object. <a href="#g862cb88a139179981e1fcd5643165b56"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#g376570af2af3ebb7e59d45b49b9582b3">DBUS_STRING_PREAMBLE</a>(str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks assertions about a string object that needs to be modifiable - may not be locked or const. <a href="#g376570af2af3ebb7e59d45b49b9582b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#gd9f957c4027c34a5c330822aa98b9307">DBUS_LOCKED_STRING_PREAMBLE</a>(str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks assertions about a string object that may be locked but can't be const. <a href="#gd9f957c4027c34a5c330822aa98b9307"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#g5cf5f12f6d8f839e9a7c3ad790a83316">DBUS_CONST_STRING_PREAMBLE</a>(str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks assertions about a string that may be const or locked. <a href="#g5cf5f12f6d8f839e9a7c3ad790a83316"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#g8f488964e430c0ae6a1a4204e0098dfe">DBUS_IS_ASCII_BLANK</a>(c) ((c) == ' ' || (c) == '\t')</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks for ASCII blank byte. <a href="#g8f488964e430c0ae6a1a4204e0098dfe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__DBusStringInternals.html#g9c88845804be152df28b81d7cad5673a">DBUS_IS_ASCII_WHITE</a>(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks for ASCII whitespace byte. <a href="#g9c88845804be152df28b81d7cad5673a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="structDBusString.html">DBusString</a> implementation details.
<p>
The guts of <a class="el" href="structDBusString.html">DBusString</a>. <hr><h2>Define Documentation</h2>
<a class="anchor" name="g5cf5f12f6d8f839e9a7c3ad790a83316"></a><!-- doxytag: member="dbus-string-private.h::DBUS_CONST_STRING_PREAMBLE" ref="g5cf5f12f6d8f839e9a7c3ad790a83316" args="(str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DBUS_CONST_STRING_PREAMBLE </td>
<td>(</td>
<td class="paramtype">str </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">const</span> <a class="code" href="structDBusRealString.html">DBusRealString</a> *real = (<a class="code" href="structDBusRealString.html">DBusRealString</a>*) str; \
<a class="code" href="group__DBusStringInternals.html#g862cb88a139179981e1fcd5643165b56">DBUS_GENERIC_STRING_PREAMBLE</a> (real)
</pre></div>Checks assertions about a string that may be const or locked.
<p>
Also declares the "real" variable pointing to <a class="el" href="structDBusRealString.html">DBusRealString</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-string-private_8h-source.html#l00107">107</a> of file <a class="el" href="dbus-string-private_8h-source.html">dbus-string-private.h</a>.
<p>
Referenced by <a class="el" href="dbus-string_8c-source.html#l00697">_dbus_string_copy_data()</a>, <a class="el" href="dbus-string_8c-source.html#l00721">_dbus_string_copy_to_buffer()</a>, <a class="el" href="dbus-string_8c-source.html#l01944">_dbus_string_find_blank()</a>, <a class="el" href="dbus-string-util_8c-source.html#l00089">_dbus_string_find_byte_backward()</a>, <a class="el" href="dbus-string_8c-source.html#l01806">_dbus_string_find_eol()</a>, <a class="el" href="dbus-string_8c-source.html#l01876">_dbus_string_find_to()</a>, <a class="el" href="dbus-string_8c-source.html#l01982">_dbus_string_skip_blank()</a>, <a class="el" href="dbus-string_8c-source.html#l02016">_dbus_string_skip_white()</a>, <a class="el" href="dbus-string_8c-source.html#l02049">_dbus_string_skip_white_reverse()</a>, <a class="el" href="dbus-string_8c-source.html#l02633">_dbus_string_validate_ascii()</a>, <a class="el" href="dbus-string_8c-source.html#l02774">_dbus_string_validate_nul()</a>, and <a class="el" href="dbus-string_8c-source.html#l02676">_dbus_string_validate_utf8()</a>.
</div>
</div><p>
<a class="anchor" name="g862cb88a139179981e1fcd5643165b56"></a><!-- doxytag: member="dbus-string-private.h::DBUS_GENERIC_STRING_PREAMBLE" ref="g862cb88a139179981e1fcd5643165b56" args="(real)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DBUS_GENERIC_STRING_PREAMBLE </td>
<td>(</td>
<td class="paramtype">real </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> _dbus_assert ((real) != NULL); _dbus_assert (!(real)->invalid); _dbus_assert ((real)->len >= 0); _dbus_assert ((real)->allocated >= 0); _dbus_assert ((real)->max_length >= 0); _dbus_assert ((real)->len <= ((real)->allocated - _DBUS_STRING_ALLOCATION_PADDING)); _dbus_assert ((real)->len <= (real)->max_length)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks a bunch of assertions about a string object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>real</em> </td><td>the <a class="el" href="structDBusRealString.html">DBusRealString</a> </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-string-private_8h-source.html#l00078">78</a> of file <a class="el" href="dbus-string-private_8h-source.html">dbus-string-private.h</a>.
<p>
Referenced by <a class="el" href="dbus-string-util_8c-source.html#l00045">_dbus_string_ends_with_c_str()</a>, <a class="el" href="dbus-string_8c-source.html#l02192">_dbus_string_equal()</a>, <a class="el" href="dbus-string_8c-source.html#l02333">_dbus_string_equal_c_str()</a>, <a class="el" href="dbus-string_8c-source.html#l02285">_dbus_string_equal_substring()</a>, and <a class="el" href="dbus-string_8c-source.html#l00262">_dbus_string_free()</a>.
</div>
</div><p>
<a class="anchor" name="g8f488964e430c0ae6a1a4204e0098dfe"></a><!-- doxytag: member="dbus-string-private.h::DBUS_IS_ASCII_BLANK" ref="g8f488964e430c0ae6a1a4204e0098dfe" args="(c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DBUS_IS_ASCII_BLANK </td>
<td>(</td>
<td class="paramtype">c </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> ((c) == ' ' || (c) == '\t')</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks for ASCII blank byte.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the byte </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-string-private_8h-source.html#l00114">114</a> of file <a class="el" href="dbus-string-private_8h-source.html">dbus-string-private.h</a>.
<p>
Referenced by <a class="el" href="dbus-string_8c-source.html#l01982">_dbus_string_skip_blank()</a>.
</div>
</div><p>
<a class="anchor" name="g9c88845804be152df28b81d7cad5673a"></a><!-- doxytag: member="dbus-string-private.h::DBUS_IS_ASCII_WHITE" ref="g9c88845804be152df28b81d7cad5673a" args="(c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DBUS_IS_ASCII_WHITE </td>
<td>(</td>
<td class="paramtype">c </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks for ASCII whitespace byte.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the byte </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-string-private_8h-source.html#l00120">120</a> of file <a class="el" href="dbus-string-private_8h-source.html">dbus-string-private.h</a>.
<p>
Referenced by <a class="el" href="dbus-string_8c-source.html#l01982">_dbus_string_skip_blank()</a>, <a class="el" href="dbus-string_8c-source.html#l02016">_dbus_string_skip_white()</a>, and <a class="el" href="dbus-string_8c-source.html#l02049">_dbus_string_skip_white_reverse()</a>.
</div>
</div><p>
<a class="anchor" name="gd9f957c4027c34a5c330822aa98b9307"></a><!-- doxytag: member="dbus-string-private.h::DBUS_LOCKED_STRING_PREAMBLE" ref="gd9f957c4027c34a5c330822aa98b9307" args="(str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DBUS_LOCKED_STRING_PREAMBLE </td>
<td>(</td>
<td class="paramtype">str </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="structDBusRealString.html">DBusRealString</a> *real = (<a class="code" href="structDBusRealString.html">DBusRealString</a>*) str; \
<a class="code" href="group__DBusStringInternals.html#g862cb88a139179981e1fcd5643165b56">DBUS_GENERIC_STRING_PREAMBLE</a> (real); \
<a class="code" href="group__DBusInternalsUtils.html#g129c6c03f011cdc171934d5d386cc797">_dbus_assert</a> (!(real)->constant)
</pre></div>Checks assertions about a string object that may be locked but can't be const.
<p>
i.e. a string object that we can free. Also declares the "real" variable pointing to <a class="el" href="structDBusRealString.html">DBusRealString</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-string-private_8h-source.html#l00098">98</a> of file <a class="el" href="dbus-string-private_8h-source.html">dbus-string-private.h</a>.
</div>
</div><p>
<a class="anchor" name="g376570af2af3ebb7e59d45b49b9582b3"></a><!-- doxytag: member="dbus-string-private.h::DBUS_STRING_PREAMBLE" ref="g376570af2af3ebb7e59d45b49b9582b3" args="(str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DBUS_STRING_PREAMBLE </td>
<td>(</td>
<td class="paramtype">str </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="structDBusRealString.html">DBusRealString</a> *real = (<a class="code" href="structDBusRealString.html">DBusRealString</a>*) str; \
<a class="code" href="group__DBusStringInternals.html#g862cb88a139179981e1fcd5643165b56">DBUS_GENERIC_STRING_PREAMBLE</a> (real); \
<a class="code" href="group__DBusInternalsUtils.html#g129c6c03f011cdc171934d5d386cc797">_dbus_assert</a> (!(real)->constant); \
<a class="code" href="group__DBusInternalsUtils.html#g129c6c03f011cdc171934d5d386cc797">_dbus_assert</a> (!(real)->locked)
</pre></div>Checks assertions about a string object that needs to be modifiable - may not be locked or const.
<p>
Also declares the "real" variable pointing to <a class="el" href="structDBusRealString.html">DBusRealString</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-string-private_8h-source.html#l00086">86</a> of file <a class="el" href="dbus-string-private_8h-source.html">dbus-string-private.h</a>.
<p>
Referenced by <a class="el" href="dbus-string_8c-source.html#l00987">_dbus_string_append()</a>, <a class="el" href="dbus-string_8c-source.html#l01273">_dbus_string_append_byte()</a>, <a class="el" href="dbus-string_8c-source.html#l01253">_dbus_string_append_len()</a>, <a class="el" href="dbus-string_8c-source.html#l01192">_dbus_string_append_printf_valist()</a>, <a class="el" href="dbus-string_8c-source.html#l01382">_dbus_string_delete()</a>, <a class="el" href="dbus-string_8c-source.html#l00457">_dbus_string_get_data_len()</a>, <a class="el" href="dbus-string_8c-source.html#l01092">_dbus_string_insert_2_aligned()</a>, <a class="el" href="dbus-string_8c-source.html#l01116">_dbus_string_insert_4_aligned()</a>, <a class="el" href="dbus-string_8c-source.html#l01140">_dbus_string_insert_8_aligned()</a>, <a class="el" href="dbus-string_8c-source.html#l01168">_dbus_string_insert_alignment()</a>, <a class="el" href="dbus-string_8c-source.html#l00581">_dbus_string_insert_byte()</a>, <a class="el" href="dbus-string_8c-source.html#l00551">_dbus_string_insert_bytes()</a>, <a class="el" href="dbus-string_8c-source.html#l00812">_dbus_string_lengthen()</a>, <a class="el" href="dbus-string_8c-source.html#l00854">_dbus_string_set_length()</a>, <a class="el" href="dbus-string_8c-source.html#l00832">_dbus_string_shorten()</a>, <a class="el" href="dbus-string_8c-source.html#l00608">_dbus_string_steal_data()</a>, and <a class="el" href="dbus-string_8c-source.html#l02806">_dbus_string_zero()</a>.
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 14 22:26:14 2009 for D-Bus by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>