summaryrefslogtreecommitdiffstats
path: root/runtime/docs/html/map_8h.html
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/docs/html/map_8h.html')
-rw-r--r--runtime/docs/html/map_8h.html69
1 files changed, 46 insertions, 23 deletions
diff --git a/runtime/docs/html/map_8h.html b/runtime/docs/html/map_8h.html
index ae26cf69..849dfff4 100644
--- a/runtime/docs/html/map_8h.html
+++ b/runtime/docs/html/map_8h.html
@@ -14,25 +14,33 @@
<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="a0" doxytag="map.h::key1str"></a>
-#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>key1str</b>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key1.str)</td></tr>
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a0">key1str</a>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key1.str)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts string from key1 union. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="map.h::key2str"></a>
-#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>key2str</b>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key2.str)</td></tr>
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a1">key2str</a>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key2.str)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts string from key2 union. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="map.h::key1int"></a>
-#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>key1int</b>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key1.val)</td></tr>
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a2">key1int</a>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key1.val)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts int from key1 union. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="map.h::key2int"></a>
-#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>key2int</b>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key2.val)</td></tr>
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a3">key2int</a>(ptr)&nbsp;&nbsp;&nbsp;(ptr-&gt;n.key2.val)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>_stp_map_key2</b>(map, key1, key2)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts int from key2 union. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a4">_stp_map_key2</a>(map, key1, key2)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>_stp_map_key</b>(map, key)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Macro to call the proper _stp_map_key functions based on the types of the arguments. <a href="#a4"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a5">_stp_map_key</a>(map, key)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>_stp_map_set</b>(map, val)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Macro to call the proper _stp_map_key function based on the type of the argument. <a href="#a5"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a6">_stp_map_set</a>(map, val)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>_stp_list_add</b>(map, val)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Macro to call the proper _stp_map_set function based on the type of the argument. <a href="#a6"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a7">_stp_list_add</a>(map, val)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Macro to call the proper _stp_list_add function based on the types of the argument. <a href="#a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a8">foreach</a>(map, ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loop through all elements of a map. <a href="#a8"></a><br></td></tr>
@@ -42,21 +50,24 @@ typedef <a class="el" href="structmap__root.html">map_root</a> *&nbsp;</td><td c
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">All maps are of this type. <br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>keytype</b> { <b>NONE</b>,
+<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a18">keytype</a> { <b>NONE</b>,
<b>LONG</b>,
<b>STR</b>
}</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>valtype</b> { <b>INT64</b>,
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">keys can be longs or strings <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a19">valtype</a> { <b>INT64</b>,
<b>STAT</b>,
<b>STRING</b>,
<b>END</b>
}</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">values can be either int64, stats or strings <br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="map.h::packed"></a>
-enum keytype&nbsp;</td><td class="memItemRight" valign="bottom"><b>packed</b></td></tr>
+enum <a class="el" href="map_8h.html#a18">keytype</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="map_8h.html#a9">packed</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">keys can be longs or strings <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Header file for maps and lists.
@@ -98,9 +109,12 @@ Definition in file <a class="el" href="map_8h-source.html">map.h</a>.<hr><h2>Def
<span class="keywordflow">else</span> \
<a class="code" href="map_8c.html#a28">_stp_list_add_int64</a> (map, (int64_t)(val)); \
})
-</pre></div>
+</pre></div>Macro to call the proper _stp_list_add function based on the types of the argument.
<p>
-Definition at line <a class="el" href="map_8h-source.html#l00132">132</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
+<dl compact><dt><b>Note:</b></dt><dd>May cause compiler warning on some GCCs </dd></dl>
+
+<p>
+Definition at line <a class="el" href="map_8h-source.html#l00159">159</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="map.h::_stp_map_key"></a><p>
@@ -137,9 +151,12 @@ Definition at line <a class="el" href="map_8h-source.html#l00132">132</a> of fil
<span class="keywordflow">else</span> \
<a class="code" href="map_8c.html#a14">_stp_map_key_long</a> (map, (<span class="keywordtype">long</span>)(key)); \
})
-</pre></div>
+</pre></div>Macro to call the proper _stp_map_key function based on the type of the argument.
+<p>
+<dl compact><dt><b>Note:</b></dt><dd>May cause compiler warning on some GCCs </dd></dl>
+
<p>
-Definition at line <a class="el" href="map_8h-source.html#l00116">116</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
+Definition at line <a class="el" href="map_8h-source.html#l00135">135</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="map.h::_stp_map_key2"></a><p>
@@ -185,9 +202,12 @@ Definition at line <a class="el" href="map_8h-source.html#l00116">116</a> of fil
<span class="keywordflow">else</span> \
<a class="code" href="map_8c.html#a9">_stp_map_key_long_long</a> (map, (<span class="keywordtype">long</span>)(key1), (<span class="keywordtype">long</span>)(key2)); \
})
-</pre></div>
+</pre></div>Macro to call the proper _stp_map_key functions based on the types of the arguments.
<p>
-Definition at line <a class="el" href="map_8h-source.html#l00102">102</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
+<dl compact><dt><b>Note:</b></dt><dd>May cause compiler warning on some GCCs </dd></dl>
+
+<p>
+Definition at line <a class="el" href="map_8h-source.html#l00117">117</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="map.h::_stp_map_set"></a><p>
@@ -224,9 +244,12 @@ Definition at line <a class="el" href="map_8h-source.html#l00102">102</a> of fil
<span class="keywordflow">else</span> \
<a class="code" href="map_8c.html#a17">_stp_map_set_int64</a> (map, (int64_t)(val)); \
})
-</pre></div>
+</pre></div>Macro to call the proper _stp_map_set function based on the type of the argument.
+<p>
+<dl compact><dt><b>Note:</b></dt><dd>May cause compiler warning on some GCCs </dd></dl>
+
<p>
-Definition at line <a class="el" href="map_8h-source.html#l00124">124</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
+Definition at line <a class="el" href="map_8h-source.html#l00147">147</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="map.h::foreach"></a><p>
@@ -264,12 +287,12 @@ Definition at line <a class="el" href="map_8h-source.html#l00124">124</a> of fil
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>map</em>&nbsp;</td><td></td></tr>
- <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>pointer to a map_node_stat, map_node_int64 or map_node_str</td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>pointer to a <a class="el" href="structmap__node__stat.html">map_node_stat</a>, <a class="el" href="structmap__node__int64.html">map_node_int64</a> or <a class="el" href="structmap__node__str.html">map_node_str</a></td></tr>
</table>
</dl>
<b>Example:</b> <div class="fragment"><pre class="fragment"><span class="comment">/* example showing how to print all the stats in a map using foreach() */</span>
-<span class="keyword">struct </span>map_node_stat *ptr;
+<span class="keyword">struct </span><a class="code" href="structmap__node__stat.html">map_node_stat</a> *ptr;
<a class="code" href="map_8h.html#a8">foreach</a> (map, ptr)
printf ("map[%s,%ld] = [c=%lld s=%lld min=%lld max=%lld]\n", key1str(ptr),
@@ -278,9 +301,9 @@ Definition at line <a class="el" href="map_8h-source.html#l00124">124</a> of fil
</pre></div>
<p>
-Definition at line <a class="el" href="map_8h-source.html#l00149">149</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
+Definition at line <a class="el" href="map_8h-source.html#l00176">176</a> of file <a class="el" href="map_8h-source.html">map.h</a>. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>
-Generated on Tue Mar 22 00:32:02 2005 for SystemTap.</small></body>
+Generated on Tue Mar 22 10:27:36 2005 for SystemTap.</small></body>
</html>