Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > fffee38c4ecefcfc897550b36364b55a > files > 34

dmlite-docs-0.6.1-1.fc18.i686.rpm

<!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.3.1"/>
<title>dmlite: include/dmlite/c/any.h Source File</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">dmlite
   &#160;<span id="projectnumber">0.6</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</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&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c6836824bdef15bafab59627cccf2d55.html">dmlite</a></li><li class="navelem"><a class="el" href="dir_d445b4083d3c7359781dc9ee11dbbc0e.html">c</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">any.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="any_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/** @file   include/dmlite/c/any.h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *  @brief  Opaque handler to pass different types of values to the API.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  @author Alejandro Álvarez Ayllon &lt;aalvarez@cern.ch&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *  @note   Basically it wraps boost::any and dmlite::Extensible.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#ifndef DMLITE_ANY_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define DMLITE_ANY_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &quot;../common/config.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#ifdef  __cplusplus</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * @brief Used to pass configuration values.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34">   20</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * @brief Handles key-&gt;value pairs.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6">   25</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a> <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * @brief      Creates a new dmlite_any.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * @param  str The string that will be wrapped. It is safe to free afterwards.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * @return     A newly allocated dmlite_any.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a908aed1602e8a74659c063cb41f65b69" title="Creates a new dmlite_any.">dmlite_any_new_string</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> * @brief    Creates a new dmlite_any.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"> * @param  l The long that will be wrapped.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> * @return   A newly allocated dmlite_any.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a60f6e30e516f7dacc8fcc9964daa7eb8" title="Creates a new dmlite_any.">dmlite_any_new_long</a>(<span class="keywordtype">long</span> l);</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"> * @brief   Creates a new dmlite_any from an int64_t type.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"> * @param i The int64_t value.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"> * @return  A newly allocated dmlite_any.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a73391ae730324e87f4ee53ce725e3e6d" title="Creates a new dmlite_any from an int64_t type.">dmlite_any_new_s64</a>(int64_t i);</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> * @brief   Creates a new dmlite_any from an uint64_t type.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> * @param i The uint64_t value.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"> * @return  A newly allocated dmlite_any.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a6cf9e08533d78152b5b09f1e2630c24d" title="Creates a new dmlite_any from an uint64_t type.">dmlite_any_new_u64</a>(uint64_t i);</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> * @brief       Creates a new dmlite_any.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * @param  n    The number of elements.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * @param  strv The strings that will be wrapped. It is safe to free afterwards.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> * @return      A newly allocated dmlite_any.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> * @deprecated Use dmlite_set_array instead.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a282b7315f9c08926d81474e9c4517051" title="Creates a new dmlite_any.">dmlite_any_new_string_array</a>(<span class="keywordtype">unsigned</span> n, <span class="keyword">const</span> <span class="keywordtype">char</span>** strv);</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> * @brief      Creates a new dmlite_any.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> * @param  n   The number of elements.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> * @param  lv  The longs that will be wrapped.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> * @return     A newly allocated dmlite_any.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> * @deprecated Use dmlite_set_array instead.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a7aff15aafebc05de7bc23f12299669ed" title="Creates a new dmlite_any.">dmlite_any_new_long_array</a>(<span class="keywordtype">unsigned</span> n, <span class="keywordtype">long</span>* lv);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * @brief     Frees a dmlite_any.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * @param any The dmlite_any to destroy.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#a26a7315fc0b7fded5f0718bd42dc64f2" title="Frees a dmlite_any.">dmlite_any_free</a>(<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* any);</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * @brief        Gets the string interpretation of the dmlite_any.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * @details      Defaults to &quot;&quot;.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> * @param any    The dmlite_any to convert.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * @param buffer Where to put the string.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> * @param bsize  The size of the buffer.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#a15ae7b9378e03074b47332d2692e42c3" title="Gets the string interpretation of the dmlite_any.">dmlite_any_to_string</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* any, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">size_t</span> bsize);</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * @brief     Returns the long interpretation of they dmlite_any.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> * @details   Defaults to 0.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> * @param any The dmlite_any to convert.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="keywordtype">long</span> <a class="code" href="any_8h.html#a30a5c204c2a0d1874193d2d972935420" title="Returns the long interpretation of they dmlite_any.">dmlite_any_to_long</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* any);</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * @brief     Returns the int64_t interpretation of they dmlite_any.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> * @details   Defaults to 0.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> * @param any The dmlite_any to convert.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;int64_t <a class="code" href="any_8h.html#ae129020041df7712e95689597bd81290" title="Returns the int64_t interpretation of they dmlite_any.">dmlite_any_to_s64</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* any);</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> * @brief     Returns the uint64_t interpretation of they dmlite_any.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * @details   Defaults to 0.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> * @param any The dmlite_any to convert.</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;uint64_t <a class="code" href="any_8h.html#a879022eeacea2fa45fa4baefccc0885e" title="Returns the uint64_t interpretation of they dmlite_any.">dmlite_any_to_u64</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* any);</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> * @brief  Created a new generic dictionary.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> * @return A newly allocated dmlite_any_dict.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* <a class="code" href="any_8h.html#af5807b23e72ceb742187a57f8e11f1c4" title="Created a new generic dictionary.">dmlite_any_dict_new</a>();</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> * @brief      Make a copy of the dictionary.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> * @param dict The original</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * @return A newly allocated copy of dict.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* <a class="code" href="any_8h.html#a6960b4f6448a4a4032ec56bb034ac978" title="Make a copy of the dictionary.">dmlite_any_dict_copy</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* dict);</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * @brief Frees a dmlite_any_dict</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#ace1d3f0d8a13ce582a79e00319cf1929" title="Frees a dmlite_any_dict.">dmlite_any_dict_free</a>(<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d);</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> * @brief Clears the dictionary.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#ae9fc5dc81aa81a54c37f0cf31043d29e" title="Clears the dictionary.">dmlite_any_dict_clear</a>(<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d);</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> * @brief   Insert a new dmlite_any value into the dictionary.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> * @details Replaces if already present.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * @param d The dictionary.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * @param k The key.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> * @param v The value.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#a372397075a2beab931bcb89e36ae6c48" title="Insert a new dmlite_any value into the dictionary.">dmlite_any_dict_insert</a>(<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d, <span class="keyword">const</span> <span class="keywordtype">char</span>* k, <span class="keyword">const</span> <a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* v);</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> * @brief Returns how many elements there are in a specific dictionary.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="any_8h.html#a44ecafe09dedc99cbac2fdc118459dfa" title="Returns how many elements there are in a specific dictionary.">dmlite_any_dict_count</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d);</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * @brief  Returns the value associated with the key k.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> * @return NULL if not found.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<a class="code" href="any_8h.html#ab3cac35938c390304b4a1f7b6f816b34" title="Used to pass configuration values.">dmlite_any</a>* <a class="code" href="any_8h.html#a65c71bcbe78f83bc2a2165adc96e5efd" title="Returns the value associated with the key k.">dmlite_any_dict_get</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d, <span class="keyword">const</span> <span class="keywordtype">char</span>* k);</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> * @brief   Removes a key-value from the dictionary.</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment"> * @param d The dictionary.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> * @param k The key to be removed.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#a9fa409ba80c05f09e066b621ccfdb53e" title="Removes a key-value from the dictionary.">dmlite_any_dict_erase</a>(<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d, <span class="keyword">const</span> <span class="keywordtype">char</span>* k);</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"> * @brief  Generates a JSON serialization of the dictionary.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> * @return The same pointer as buffer.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="keywordtype">char</span>* <a class="code" href="any_8h.html#a0fb2f61152043cfe84a0b5093a09dc8c" title="Generates a JSON serialization of the dictionary.">dmlite_any_dict_to_json</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">size_t</span> bsize);</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> * @brief Populates a dmlite_any_dict from a JSON string.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* <a class="code" href="any_8h.html#a9015897e0328e8ad390e7a029d33a74e" title="Populates a dmlite_any_dict from a JSON string.">dmlite_any_dict_from_json</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* json);</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment"> * @brief       Puts in keys a pointer to an array of strings with all the available</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> *              keys in d.</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"> * @details     Use dmlite_any_dict_keys_free to free.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> * @param d     The Dictionary.</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment"> * @param nkeys Will be set to the number of stored keys.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#a96e93d0351cff85bf84442619f73d1c5" title="Puts in keys a pointer to an array of strings with all the available keys in d.">dmlite_any_dict_keys</a>(<span class="keyword">const</span> <a class="code" href="any_8h.html#ad0a8d66d6e94fe1181a146b046ceb8c6" title="Handles key-&gt;value pairs.">dmlite_any_dict</a>* d, <span class="keywordtype">unsigned</span>* nkeys, <span class="keywordtype">char</span>*** keys);</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"> * @brief Frees an array of strings allocated by dmlite_any_dict_keys.</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"> * @param n    The number of keys in **keys</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment"> * @param keys The array of keys.</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="keywordtype">void</span> <a class="code" href="any_8h.html#aca4f376fa5620263d9fc4c88237a8813" title="Frees an array of strings allocated by dmlite_any_dict_keys.">dmlite_any_dict_keys_free</a>(<span class="keywordtype">unsigned</span> n, <span class="keywordtype">char</span>** keys);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="preprocessor">#ifdef  __cplusplus</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="preprocessor"></span>}</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* DMLITE_ANY_H */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 12 2013 07:34:22 for dmlite by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>