<!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"/>
<title>Barry: vformat.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<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="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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>vformat.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2003 Ximian, Inc. 2005 Armin Bauer</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2003 Ximian, Inc.</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 Lesser 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.1 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"> * Lesser 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 Lesser General Public</span>
<a name="l00017"></a>00017 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * Author: Chris Toshok (toshok@ximian.com)</span>
<a name="l00021"></a>00021 <span class="comment"> * Author: Armin Bauer (armin.bauer@opensync.org)</span>
<a name="l00022"></a>00022 <span class="comment"> *</span>
<a name="l00023"></a>00023 <span class="comment"> */</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _VFORMAT_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _VFORMAT_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <glib.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <<a class="code" href="time_8h.html" title="Time related conversion routines.">time.h</a>></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00037"></a>00037 VFORMAT_CARD_21,
<a name="l00038"></a>00038 VFORMAT_CARD_30,
<a name="l00039"></a>00039 VFORMAT_NOTE,
<a name="l00040"></a>00040 VFORMAT_EVENT_10,
<a name="l00041"></a>00041 VFORMAT_EVENT_20,
<a name="l00042"></a>00042 VFORMAT_TODO_10,
<a name="l00043"></a>00043 VFORMAT_TODO_20,
<a name="l00044"></a>00044 VFORMAT_JOURNAL
<a name="l00045"></a>00045 } b_VFormatType;
<a name="l00046"></a>00046
<a name="l00047"></a><a class="code" href="structb__VFormat.html">00047</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structb__VFormat.html">b_VFormat</a> {
<a name="l00048"></a>00048 <span class="comment">//b_VFormatType type;</span>
<a name="l00049"></a>00049 GList *attributes;
<a name="l00050"></a>00050 } <a class="code" href="structb__VFormat.html">b_VFormat</a>;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="preprocessor">#define CRLF "\r\n"</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span>
<a name="l00054"></a>00054 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00055"></a>00055 VF_ENCODING_RAW, <span class="comment">/* no encoding */</span>
<a name="l00056"></a>00056 VF_ENCODING_BASE64, <span class="comment">/* base64 */</span>
<a name="l00057"></a>00057 VF_ENCODING_QP, <span class="comment">/* quoted-printable */</span>
<a name="l00058"></a>00058 VF_ENCODING_8BIT
<a name="l00059"></a>00059 } b_VFormatEncoding;
<a name="l00060"></a>00060
<a name="l00061"></a><a class="code" href="structb__VFormatAttribute.html">00061</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> {
<a name="l00062"></a>00062 <span class="keywordtype">char</span> *block; <span class="comment">/* "vtimezone/standard", or "vevent", depending on</span>
<a name="l00063"></a>00063 <span class="comment"> current begin/end location... may be null */</span>
<a name="l00064"></a>00064 <span class="keywordtype">char</span> *group;
<a name="l00065"></a>00065 <span class="keywordtype">char</span> *name;
<a name="l00066"></a>00066 GList *params; <span class="comment">/* b_VFormatParam */</span>
<a name="l00067"></a>00067 GList *values;
<a name="l00068"></a>00068 GList *decoded_values;
<a name="l00069"></a>00069 b_VFormatEncoding encoding;
<a name="l00070"></a>00070 gboolean encoding_set;
<a name="l00071"></a>00071 } <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a>;
<a name="l00072"></a>00072
<a name="l00073"></a><a class="code" href="structb__VFormatParam.html">00073</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> {
<a name="l00074"></a>00074 <span class="keywordtype">char</span> *name;
<a name="l00075"></a>00075 GList *values; <span class="comment">/* GList of char*'s*/</span>
<a name="l00076"></a>00076 } <a class="code" href="structb__VFormatParam.html">b_VFormatParam</a>;
<a name="l00077"></a>00077
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">/*b_VFormat *vcard_new(b_VFormatType type);</span>
<a name="l00080"></a>00080 <span class="comment">b_VFormat *vcard_new_from_string (const char *str, b_VFormatType type);</span>
<a name="l00081"></a>00081 <span class="comment">//char *vcard_to_string(VFormat *card, VFormatType format);</span>
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">VFormat *vnote_new(void);</span>
<a name="l00084"></a>00084 <span class="comment">VFormat *vnote_new_from_string(const char *str);</span>
<a name="l00085"></a>00085 <span class="comment">//char *vnote_to_string(VFormat *note);</span>
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment">VFormat *vevent_new(void);</span>
<a name="l00089"></a>00089 <span class="comment">VFormat *vevent_new_from_string(const char *str);</span>
<a name="l00090"></a>00090 <span class="comment">//char *vevent_to_string(VFormat *event);</span>
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment">VFormat *vtodo_new(void);</span>
<a name="l00093"></a>00093 <span class="comment">VFormat *vtodo_new_from_string(const char *str);*/</span>
<a name="l00094"></a>00094 <span class="comment">//char *vtodo_to_string(VFormat *todo);</span>
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">/* mostly for debugging */</span>
<a name="l00097"></a>00097 <a class="code" href="structb__VFormat.html">b_VFormat</a> *b_vformat_new(<span class="keywordtype">void</span>);
<a name="l00098"></a>00098 <a class="code" href="structb__VFormat.html">b_VFormat</a> *b_vformat_new_from_string(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);
<a name="l00099"></a>00099 <span class="keywordtype">void</span> b_vformat_dump_structure(<a class="code" href="structb__VFormat.html">b_VFormat</a> *format);
<a name="l00100"></a>00100 <span class="keywordtype">char</span> *b_vformat_to_string(<a class="code" href="structb__VFormat.html">b_VFormat</a> *evc, b_VFormatType type);
<a name="l00101"></a>00101 time_t b_vformat_time_to_unix(<span class="keyword">const</span> <span class="keywordtype">char</span> *inptime);
<a name="l00102"></a>00102 <span class="keywordtype">void</span> b_vformat_free(<a class="code" href="structb__VFormat.html">b_VFormat</a> *format);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">/* attributes */</span>
<a name="l00105"></a>00105 <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *b_vformat_attribute_new (<span class="keyword">const</span> <span class="keywordtype">char</span> *attr_group, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name);
<a name="l00106"></a>00106 <span class="keywordtype">void</span> b_vformat_attribute_free (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00107"></a>00107 <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *b_vformat_attribute_copy (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00108"></a>00108 <span class="keywordtype">void</span> b_vformat_remove_attributes (<a class="code" href="structb__VFormat.html">b_VFormat</a> *vformat, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_group, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name);
<a name="l00109"></a>00109 <span class="keywordtype">void</span> b_vformat_remove_attribute (<a class="code" href="structb__VFormat.html">b_VFormat</a> *vformat, <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00110"></a>00110 <span class="keywordtype">void</span> b_vformat_add_attribute (<a class="code" href="structb__VFormat.html">b_VFormat</a> *vformat, <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00111"></a>00111 <span class="keywordtype">void</span> b_vformat_add_attribute_with_value (<a class="code" href="structb__VFormat.html">b_VFormat</a> *vformat, <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00112"></a>00112 <span class="keywordtype">void</span> b_vformat_add_attribute_with_values (<a class="code" href="structb__VFormat.html">b_VFormat</a> *vformat, <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, ...);
<a name="l00113"></a>00113 <span class="keywordtype">void</span> b_vformat_attribute_add_value (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00114"></a>00114 <span class="keywordtype">void</span> b_vformat_attribute_set_value (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keywordtype">int</span> nth, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00115"></a>00115 <span class="keywordtype">void</span> b_vformat_attribute_add_value_decoded (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *value, <span class="keywordtype">int</span> len);
<a name="l00116"></a>00116 <span class="keywordtype">void</span> b_vformat_attribute_add_values (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, ...);
<a name="l00117"></a>00117 <span class="keywordtype">void</span> b_vformat_attribute_remove_values (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00118"></a>00118 <span class="keywordtype">void</span> b_vformat_attribute_remove_params (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00119"></a>00119 <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *b_vformat_find_attribute (<a class="code" href="structb__VFormat.html">b_VFormat</a> *evc, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> nth, <span class="keyword">const</span> <span class="keywordtype">char</span> *block);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">/* attribute parameters */</span>
<a name="l00122"></a>00122 <a class="code" href="structb__VFormatParam.html">b_VFormatParam</a>* b_vformat_attribute_param_new (<span class="keyword">const</span> <span class="keywordtype">char</span> *param_name);
<a name="l00123"></a>00123 <span class="keywordtype">void</span> b_vformat_attribute_param_free (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param);
<a name="l00124"></a>00124 <a class="code" href="structb__VFormatParam.html">b_VFormatParam</a>* b_vformat_attribute_param_copy (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param);
<a name="l00125"></a>00125 <span class="keywordtype">void</span> b_vformat_attribute_add_param (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param);
<a name="l00126"></a>00126 <a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *b_vformat_attribute_find_param(<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> level);
<a name="l00127"></a>00127 <span class="keywordtype">void</span> b_vformat_attribute_add_param_with_value (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00128"></a>00128 <span class="keywordtype">void</span> b_vformat_attribute_add_param_with_values (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr,
<a name="l00129"></a>00129 <a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param, ...);
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keywordtype">void</span> b_vformat_attribute_param_add_value (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param,
<a name="l00132"></a>00132 <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00133"></a>00133 <span class="keywordtype">void</span> b_vformat_attribute_param_add_values (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param,
<a name="l00134"></a>00134 ...);
<a name="l00135"></a>00135 <span class="keywordtype">void</span> b_vformat_attribute_param_remove_values (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param);
<a name="l00136"></a>00136 gboolean b_vformat_attribute_has_param(<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">/* b_VFormat* accessors. nothing returned from these functions should be</span>
<a name="l00139"></a>00139 <span class="comment"> freed by the caller. */</span>
<a name="l00140"></a>00140 GList* b_vformat_get_attributes (<a class="code" href="structb__VFormat.html">b_VFormat</a> *vformat);
<a name="l00141"></a>00141 <span class="keyword">const</span> <span class="keywordtype">char</span>* b_vformat_attribute_get_group (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00142"></a>00142 <span class="keyword">const</span> <span class="keywordtype">char</span>* b_vformat_attribute_get_name (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00143"></a>00143 <span class="keyword">const</span> <span class="keywordtype">char</span>* b_vformat_attribute_get_block (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00144"></a>00144 GList* b_vformat_attribute_get_values (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr); <span class="comment">/* GList elements are of type char* */</span>
<a name="l00145"></a>00145 GList* b_vformat_attribute_get_values_decoded (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr); <span class="comment">/* GList elements are of type GString* */</span>
<a name="l00146"></a>00146 <span class="keyword">const</span> <span class="keywordtype">char</span> *b_vformat_attribute_get_nth_value(<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keywordtype">int</span> nth);
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">/* special accessors for single valued attributes */</span>
<a name="l00149"></a>00149 gboolean b_vformat_attribute_is_single_valued (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00150"></a>00150 <span class="keywordtype">char</span>* b_vformat_attribute_get_value (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00151"></a>00151 GString* b_vformat_attribute_get_value_decoded (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 GList* b_vformat_attribute_get_params (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr);
<a name="l00154"></a>00154 <span class="keyword">const</span> <span class="keywordtype">char</span>* b_vformat_attribute_param_get_name (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param);
<a name="l00155"></a>00155 GList* b_vformat_attribute_param_get_values (<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param);
<a name="l00156"></a>00156 <span class="keyword">const</span> <span class="keywordtype">char</span> *b_vformat_attribute_param_get_nth_value(<a class="code" href="structb__VFormatParam.html">b_VFormatParam</a> *param, <span class="keywordtype">int</span> nth);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">/* special TYPE= parameter predicate (checks for TYPE=@typestr */</span>
<a name="l00159"></a>00159 gboolean b_vformat_attribute_has_type (<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *typestr);
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="comment">/* Utility functions. */</span>
<a name="l00162"></a>00162 <span class="keywordtype">char</span>* b_vformat_escape_string (<span class="keyword">const</span> <span class="keywordtype">char</span> *str, b_VFormatType type);
<a name="l00163"></a>00163 <span class="keywordtype">char</span>* b_vformat_unescape_string (<span class="keyword">const</span> <span class="keywordtype">char</span> *str);
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00166"></a>00166 <span class="preprocessor"></span>}
<a name="l00167"></a>00167 <span class="preprocessor">#endif</span>
<a name="l00168"></a>00168 <span class="preprocessor"></span>
<a name="l00169"></a>00169 <span class="preprocessor">#endif </span><span class="comment">/* _VFORMAT_H */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
