Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > e8201bf25fe615fa1a8b232e84a1236d > files > 27

libxnm-devel-0.1.3-3.fc12.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>src/xnm.h Source File</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.5.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_a825c5a75cd0c09c6e5bad1a80440c04.html">src</a>
  </div>
</div>
<div class="contents">
<h1>xnm.h</h1><a href="xnm_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* libxnm</span>
<a name="l00002"></a>00002 <span class="comment"> * xnm.h:</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2007 Dov Grobgeld</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> * Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU Library General Public</span>
<a name="l00017"></a>00017 <span class="comment"> * License along with this library; if not, write to the</span>
<a name="l00018"></a>00018 <span class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330,</span>
<a name="l00019"></a>00019 <span class="comment"> * Boston, MA 02111-1307, USA.</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * Dov Grobgeld &lt;dov.grobgeld@gmail.com&gt;</span>
<a name="l00023"></a>00023 <span class="comment"> * Thu Jan 11 23:44:32 2007</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 
<a name="l00076"></a>00076 <span class="preprocessor">#ifndef XNM_H</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor">#define XNM_H</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span>
<a name="l00079"></a>00079 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="preprocessor">#endif</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span>
<a name="l00084"></a>00084 <span class="preprocessor">#include &lt;glib.h&gt;</span>
<a name="l00085"></a>00085 
<a name="l00090"></a>00090 <span class="keyword">enum</span> {
<a name="l00091"></a>00091   XNM_ERROR = 0,
<a name="l00092"></a>00092   XNM_ERROR_SYNTAX_ERROR = 1,
<a name="l00093"></a>00093   XNM_ERROR_KEY_NOT_FOUND = 2
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095 
<a name="l00100"></a><a class="code" href="xnm_8h.html#3a6586e2bc52922ca880931f68f90e84">00100</a> <span class="keyword">typedef</span> <span class="keyword">enum</span>  {
<a name="l00101"></a>00101   XNM_UNKNOWN,
<a name="l00102"></a>00102   XNM_TABLE,
<a name="l00103"></a>00103   XNM_ARRAY,
<a name="l00104"></a>00104   XNM_STRING,
<a name="l00105"></a>00105   XNM_BINARY 
<a name="l00106"></a>00106 } <a class="code" href="xnm_8h.html#3a6586e2bc52922ca880931f68f90e84">XnmValueType</a>;
<a name="l00107"></a>00107 
<a name="l00114"></a><a class="code" href="xnm_8h.html#06c3ee8df49603f2aad739d285179e06">00114</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00115"></a>00115   XNM_GET_UINT8,
<a name="l00116"></a>00116   XNM_GET_UINT16,
<a name="l00117"></a>00117   XNM_GET_UINT,
<a name="l00118"></a>00118   XNM_GET_UINT32,
<a name="l00119"></a>00119   XNM_GET_INT8,
<a name="l00120"></a>00120   XNM_GET_INT16,
<a name="l00121"></a>00121   XNM_GET_INT,
<a name="l00122"></a>00122   XNM_GET_INT32,
<a name="l00123"></a>00123   XNM_GET_INT64,
<a name="l00124"></a>00124   XNM_GET_FLOAT,
<a name="l00125"></a>00125   XNM_GET_DOUBLE,
<a name="l00126"></a>00126   XNM_GET_STRING,
<a name="l00127"></a>00127   XNM_GET_BOOL
<a name="l00128"></a>00128 } <a class="code" href="xnm_8h.html#06c3ee8df49603f2aad739d285179e06">XnmValueGetType</a>;
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 <span class="comment">/* Forward declarations */</span>
<a name="l00131"></a>00131 <span class="keyword">struct </span>xnm_string_struct;
<a name="l00132"></a>00132 <span class="keyword">struct </span>xnm_table_struct;
<a name="l00133"></a>00133 <span class="keyword">struct </span>xnm_array_struct;
<a name="l00134"></a>00134 <span class="keyword">struct </span>xnm_bin_struct;
<a name="l00135"></a>00135 
<a name="l00140"></a><a class="code" href="structXnmValue.html">00140</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00141"></a><a class="code" href="structXnmValue.html#f484d85e6b17bf0c9c4b26e25623c295">00141</a>     <span class="keywordtype">int</span> ref_count;              
<a name="l00142"></a>00142     <a class="code" href="xnm_8h.html#3a6586e2bc52922ca880931f68f90e84">XnmValueType</a> type;
<a name="l00143"></a>00143 
<a name="l00144"></a>00144     <span class="keyword">union </span>{
<a name="l00145"></a>00145         <span class="keyword">struct </span>xnm_table_struct *table;
<a name="l00146"></a>00146         <span class="keyword">struct </span>xnm_array_struct *array;
<a name="l00147"></a>00147         <span class="keyword">struct </span>xnm_string_struct *string;
<a name="l00148"></a>00148         <span class="keyword">struct </span>xnm_binary_struct *binary;
<a name="l00149"></a>00149     } value;
<a name="l00150"></a>00150 } <a class="code" href="structXnmValue.html">XnmValue</a>;
<a name="l00151"></a>00151 
<a name="l00160"></a>00160 <a class="code" href="structXnmValue.html">XnmValue</a> * <a class="code" href="xnm_8h.html#144adfe0d13dc5c3dcc507491778cc41">xnm_value_new_string</a>            (<span class="keyword">const</span> gchar *s);
<a name="l00161"></a>00161 
<a name="l00168"></a>00168 <a class="code" href="structXnmValue.html">XnmValue</a> * <a class="code" href="xnm_8h.html#936c57fd5d7d5ef0b292efcfe72cbe09">xnm_value_new_table</a>             ();
<a name="l00169"></a>00169 
<a name="l00175"></a>00175 <a class="code" href="structXnmValue.html">XnmValue</a> * <a class="code" href="xnm_8h.html#c8ca7c7c0946a5c52e00070fac2c99d2">xnm_value_new_array</a>             ();
<a name="l00176"></a>00176 
<a name="l00177"></a>00177 
<a name="l00183"></a>00183 <a class="code" href="structXnmValue.html">XnmValue</a> * <a class="code" href="xnm_8h.html#c42ff90d826164d82eb81cf866a1354a">xnm_value_new_binary</a>            (<span class="keyword">const</span> gchar *buf, <span class="keywordtype">size_t</span> size);
<a name="l00184"></a>00184 
<a name="l00185"></a>00185 
<a name="l00191"></a>00191 <span class="keywordtype">void</span>          <a class="code" href="xnm_8h.html#cebb1c769e50dda33868b9c06f9eb23e">xnm_value_ref</a>              (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value);
<a name="l00192"></a>00192 
<a name="l00199"></a>00199 <span class="keywordtype">void</span>          <a class="code" href="xnm_8h.html#e638c66188b57521792404e4cc61c629">xnm_value_unref</a>            (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value);
<a name="l00200"></a>00200 
<a name="l00209"></a>00209 gchar *       <a class="code" href="xnm_8h.html#ab2b28f893e053a5ab3ca9fe0afdd59a">xnm_value_export_to_string</a> (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value);
<a name="l00210"></a>00210 
<a name="l00228"></a>00228 <span class="keywordtype">int</span>           <a class="code" href="xnm_8h.html#200b9e0ba79c5fb95e53c7c1a5869a76">xnm_value_get</a>              (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value_tree,
<a name="l00229"></a>00229                                           <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00230"></a>00230                                           <span class="comment">// output</span>
<a name="l00231"></a>00231                                           <a class="code" href="structXnmValue.html">XnmValue</a> **xnm_value);
<a name="l00232"></a>00232 
<a name="l00244"></a>00244 <span class="keywordtype">int</span>           <a class="code" href="xnm_8h.html#a5c81a90fe1ad55f71699c5f5734a51e">xnm_value_get_string</a>       (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value,
<a name="l00245"></a>00245                                           <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00246"></a>00246                                           <span class="comment">// output</span>
<a name="l00247"></a>00247                                           gchar **string_val);
<a name="l00248"></a>00248 
<a name="l00259"></a>00259 <span class="keywordtype">int</span>           <a class="code" href="xnm_8h.html#22eb29b840b66863d87bad4bb1a62314">xnm_value_get_const_string</a>  (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value_tree,
<a name="l00260"></a>00260                                            <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00261"></a>00261 
<a name="l00262"></a>00262                                            <span class="comment">/* output */</span>
<a name="l00263"></a>00263                                            <span class="keyword">const</span> gchar **const_val_string);
<a name="l00264"></a>00264 
<a name="l00275"></a>00275 <span class="keywordtype">int</span>           <a class="code" href="xnm_8h.html#cf6a2568f7d910e67e3e8323d8b61f8d">xnm_value_get_int</a>           (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value,
<a name="l00276"></a>00276                                            <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00277"></a>00277                                            <span class="comment">/* output */</span>
<a name="l00278"></a>00278                                            <span class="keywordtype">int</span> *val_int);
<a name="l00279"></a>00279 
<a name="l00280"></a>00280 
<a name="l00286"></a>00286 <span class="keywordtype">int</span> <a class="code" href="xnm_8h.html#8dd500e7727fa2efc6b167c774451ffb">xnm_value_get_bool</a> (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value,
<a name="l00287"></a>00287                         <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00288"></a>00288                         <span class="comment">/* output */</span>
<a name="l00289"></a>00289                         gboolean *val_bool);
<a name="l00290"></a>00290 
<a name="l00296"></a>00296 <span class="keywordtype">int</span> <a class="code" href="xnm_8h.html#72bd5015e3e6b9c853abfc4ecdabb48b">xnm_value_array_push_value</a>(<a class="code" href="structXnmValue.html">XnmValue</a> * xnm_value_array,
<a name="l00297"></a>00297                                <a class="code" href="structXnmValue.html">XnmValue</a> * value);
<a name="l00298"></a>00298 
<a name="l00307"></a>00307 <span class="keywordtype">int</span> <a class="code" href="xnm_8h.html#89dcf69f95cdea22b248e1ad8a3ab581">xnm_value_array_push_string</a>(<a class="code" href="structXnmValue.html">XnmValue</a> * xnm_value_array,
<a name="l00308"></a>00308                                 <span class="keyword">const</span> gchar *<span class="keywordtype">string</span>);
<a name="l00309"></a>00309 
<a name="l00310"></a>00310 
<a name="l00319"></a>00319 <span class="keywordtype">int</span> <a class="code" href="xnm_8h.html#6433fc5b4afb59ca8ed7d4592238eec7">xnm_value_array_push_int</a>(<a class="code" href="structXnmValue.html">XnmValue</a> * xnm_value_array,
<a name="l00320"></a>00320                              <span class="keywordtype">int</span> value_int);
<a name="l00321"></a>00321 
<a name="l00322"></a>00322 
<a name="l00331"></a>00331 <span class="keywordtype">int</span> <a class="code" href="xnm_8h.html#d6c05af0da1af59b59de87b79ecc5d3f">xnm_value_array_push_printf</a>(<a class="code" href="structXnmValue.html">XnmValue</a> * xnm_value_array,
<a name="l00332"></a>00332                                 <span class="keyword">const</span> gchar *format,
<a name="l00333"></a>00333                                 ...);
<a name="l00334"></a>00334 
<a name="l00350"></a>00350 <span class="keywordtype">int</span> <a class="code" href="xnm_8h.html#8be4e6e56710a5865fdfb4003f167b0a">xnm_value_table_set_key_value</a>(<a class="code" href="structXnmValue.html">XnmValue</a>    * xnm_value_tree,
<a name="l00351"></a>00351                                   <span class="keyword">const</span> gchar * key,
<a name="l00352"></a>00352                                   <a class="code" href="structXnmValue.html">XnmValue</a>    * xnm_value);
<a name="l00353"></a>00353 
<a name="l00365"></a>00365 <span class="keywordtype">int</span>
<a name="l00366"></a>00366 <a class="code" href="xnm_8h.html#9161807d2bf248d29af7e172169d1b6a">xnm_value_table_set_key_value_string</a>(<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value_parent,
<a name="l00367"></a>00367                                      <span class="keyword">const</span> gchar *key,
<a name="l00368"></a>00368                                      <span class="keyword">const</span> gchar *<span class="keywordtype">string</span>);
<a name="l00369"></a>00369 
<a name="l00379"></a>00379 <span class="keywordtype">int</span>
<a name="l00380"></a>00380 <a class="code" href="xnm_8h.html#eef96b7ef63c8b66a8d11ab90ac20792">xnm_value_set_key_value_printf</a>(<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value_parent,
<a name="l00381"></a>00381                                <span class="keyword">const</span> gchar *key,
<a name="l00382"></a>00382                                <span class="keyword">const</span> gchar *format,
<a name="l00383"></a>00383                                ...
<a name="l00384"></a>00384                                );
<a name="l00385"></a>00385 
<a name="l00395"></a>00395 <span class="keywordtype">int</span>
<a name="l00396"></a>00396 <a class="code" href="xnm_8h.html#7343bccb1d8c50c2de232dbd429e4dfc">xnm_value_get_array_length</a> (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value,
<a name="l00397"></a>00397                             <span class="keyword">const</span> <span class="keywordtype">char</span> *key);
<a name="l00398"></a>00398 
<a name="l00413"></a>00413 <span class="keywordtype">int</span>
<a name="l00414"></a>00414 <a class="code" href="xnm_8h.html#56ff15c5debd596dc1b18b4efd772d95">xnm_value_get_values</a>(<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value,
<a name="l00415"></a>00415                      ...);
<a name="l00416"></a>00416 
<a name="l00417"></a>00417 
<a name="l00427"></a>00427 <span class="keywordtype">int</span>
<a name="l00428"></a>00428 <a class="code" href="xnm_8h.html#23b2cd798592a48bb2025f225ae8904c">xnm_value_get_table_key_list</a> (<a class="code" href="structXnmValue.html">XnmValue</a> *xnm_value,
<a name="l00429"></a>00429                               <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00430"></a>00430                               <span class="comment">// output</span>
<a name="l00431"></a>00431                               <span class="keyword">const</span> GPtrArray **key_list
<a name="l00432"></a>00432                               );
<a name="l00433"></a>00433 
<a name="l00443"></a>00443 <span class="keywordtype">int</span>
<a name="l00444"></a>00444 <a class="code" href="xnm_8h.html#edd6feaf8fcfe69a214625750412eef0">xnm_parse_string</a>(<span class="keyword">const</span> gchar *<span class="keywordtype">string</span>,
<a name="l00445"></a>00445                  <span class="comment">// output</span>
<a name="l00446"></a>00446                  <a class="code" href="structXnmValue.html">XnmValue</a> **value,
<a name="l00447"></a>00447                  GError **error
<a name="l00448"></a>00448                  );
<a name="l00449"></a>00449 
<a name="l00460"></a>00460 <span class="keywordtype">int</span>
<a name="l00461"></a>00461 <a class="code" href="xnm_8h.html#6b5d134d6c3c14858ac3e6bf160251ba">xnm_parse_string_len</a>(<span class="keyword">const</span> gchar *<span class="keywordtype">string</span>,
<a name="l00462"></a>00462                      <span class="keywordtype">int</span> len,
<a name="l00463"></a>00463                      <span class="comment">// output</span>
<a name="l00464"></a>00464                      <a class="code" href="structXnmValue.html">XnmValue</a> **value,
<a name="l00465"></a>00465                      GError **error
<a name="l00466"></a>00466                      );
<a name="l00467"></a>00467 
<a name="l00468"></a>00468 
<a name="l00478"></a>00478 <span class="keywordtype">int</span>
<a name="l00479"></a>00479 <a class="code" href="xnm_8h.html#e2514b5cba985458cfc51c3eec10cab3">xnm_parse_file</a>(<span class="keyword">const</span> gchar *filenam,
<a name="l00480"></a>00480                <span class="comment">// output</span>
<a name="l00481"></a>00481                <a class="code" href="structXnmValue.html">XnmValue</a> **xnm_value,
<a name="l00482"></a>00482                GError **error);
<a name="l00483"></a>00483 
<a name="l00484"></a>00484 <span class="preprocessor">#ifdef  __cplusplus</span>
<a name="l00485"></a>00485 <span class="preprocessor"></span>}
<a name="l00486"></a>00486 <span class="preprocessor">#endif</span>
<a name="l00487"></a>00487 <span class="preprocessor"></span>
<a name="l00488"></a>00488 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 25 10:36:27 2008 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>