<!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: vbase.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>vbase.h</h1><a href="vbase_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file vbase.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Base class for vformat support</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2006-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_SYNC_VBASE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_SYNC_VBASE_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <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="l00026"></a>00026 <span class="preprocessor">#include "vsmartptr.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "vformat.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <vector></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Sync {
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">//</span>
<a name="l00034"></a>00034 <span class="comment">// vTimeZone</span>
<a name="l00035"></a>00035 <span class="comment">//</span><span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/// A virtual base class that the plugins may override, to do</span>
<a name="l00037"></a>00037 <span class="comment">/// time related conversions. Default implementations for these</span>
<a name="l00038"></a>00038 <span class="comment">/// functions are provided, but may be overrided depending on need.</span>
<a name="l00039"></a>00039 <span class="comment">///</span>
<a name="l00040"></a>00040 <span class="comment">/// We do this in a "callback" style, so that it doesn't matter what</span>
<a name="l00041"></a>00041 <span class="comment">/// version of the opensync library we link against, in case the</span>
<a name="l00042"></a>00042 <span class="comment">/// user wishes to use the opensync time functions.</span>
<a name="l00043"></a>00043 <span class="comment">///</span>
<a name="l00044"></a><a class="code" href="classBarry_1_1Sync_1_1vTimeConverter.html">00044</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Sync_1_1vTimeConverter.html" title="A virtual base class that the plugins may override, to do time related conversions...">vTimeConverter</a>
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">public</span>:
<a name="l00047"></a>00047 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Sync_1_1vTimeConverter.html" title="A virtual base class that the plugins may override, to do time related conversions...">vTimeConverter</a>() {}
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment"> /// Convert a time_t into an ISO timestamp string</span>
<a name="l00050"></a>00050 <span class="comment"> /// Throws Barry::ConvertError on error, but these errors</span>
<a name="l00051"></a>00051 <span class="comment"> /// must be rare.</span>
<a name="l00052"></a>00052 <span class="comment"></span> <span class="keyword">virtual</span> std::string unix2vtime(<span class="keyword">const</span> time_t *timestamp);
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /// Convert an ISO timestamp string into a time_t, using</span>
<a name="l00055"></a>00055 <span class="comment"> /// the current system timezone if vtime is not in UTC.</span>
<a name="l00056"></a>00056 <span class="comment"> /// Returns (time_t)-1 on error.</span>
<a name="l00057"></a>00057 <span class="comment"></span> <span class="keyword">virtual</span> time_t vtime2unix(<span class="keyword">const</span> <span class="keywordtype">char</span> *vtime);
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /// Convert a VEVENT alarm duration string in the format</span>
<a name="l00060"></a>00060 <span class="comment"> /// of "[+-]P.W.DT.H.M.S" where the periods represent numbers</span>
<a name="l00061"></a>00061 <span class="comment"> /// and each letter besides P and T represent Week, Day,</span>
<a name="l00062"></a>00062 <span class="comment"> /// Hour, Minute, and Second respectively.</span>
<a name="l00063"></a>00063 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> alarmduration2sec(<span class="keyword">const</span> <span class="keywordtype">char</span> *alarm);
<a name="l00064"></a>00064 };
<a name="l00065"></a>00065
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">typedef</span> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">Barry::vSmartPtr<b_VFormatAttribute, b_VFormatAttribute, &b_vformat_attribute_free></a> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</a>;
<a name="l00068"></a>00068 <span class="keyword">typedef</span> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">Barry::vSmartPtr<b_VFormatParam, b_VFormatParam, &b_vformat_attribute_param_free></a> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vParamPtr</a>;
<a name="l00069"></a>00069 <span class="keyword">typedef</span> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">Barry::vSmartPtr<char, void, &g_free></a> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">gStringPtr</a>;
<a name="l00070"></a>00070
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">//</span>
<a name="l00073"></a>00073 <span class="comment">// vAttr</span>
<a name="l00074"></a>00074 <span class="comment">//</span><span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment">/// Class for reading a b_VFormatAttribute. Reading does not require</span>
<a name="l00076"></a>00076 <span class="comment">/// memory management, so none is done.</span>
<a name="l00077"></a>00077 <span class="comment">///</span>
<a name="l00078"></a><a class="code" href="classBarry_1_1Sync_1_1vAttr.html">00078</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *m_attr;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">public</span>:
<a name="l00083"></a>00083 <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>()
<a name="l00084"></a>00084 : m_attr(0)
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>(<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr)
<a name="l00089"></a>00089 : m_attr(attr)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>& operator=(<a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a> *attr)
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 m_attr = attr;
<a name="l00096"></a>00096 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <a class="code" href="structb__VFormatAttribute.html">b_VFormatAttribute</a>* Get() { <span class="keywordflow">return</span> m_attr; }
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="comment">// These functions do not throw an error if the value</span>
<a name="l00102"></a>00102 <span class="comment">// is NULL or does not exist (for example, if you ask for</span>
<a name="l00103"></a>00103 <span class="comment">// value #5 and there are only 4).</span>
<a name="l00104"></a>00104 std::string GetName();
<a name="l00105"></a>00105 std::string GetValue(<span class="keywordtype">int</span> nth = 0);
<a name="l00106"></a>00106 std::string GetDecodedValue();
<a name="l00107"></a>00107 std::string GetParam(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> nth = 0);
<a name="l00108"></a>00108 std::string GetAllParams(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00109"></a>00109 };
<a name="l00110"></a>00110
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">//</span>
<a name="l00113"></a>00113 <span class="comment">// vBase</span>
<a name="l00114"></a>00114 <span class="comment">//</span><span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/// Base class containing vformat helper API.</span>
<a name="l00116"></a>00116 <span class="comment">///</span>
<a name="l00117"></a><a class="code" href="classBarry_1_1Sync_1_1vBase.html">00117</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Sync_1_1vBase.html" title="Base class containing vformat helper API.">vBase</a>
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="comment">// internal data for managing the vformat</span>
<a name="l00120"></a>00120 <a class="code" href="structb__VFormat.html">b_VFormat</a> *m_format;
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keyword">public</span>:
<a name="l00123"></a>00123 <span class="keyword">protected</span>:
<a name="l00124"></a>00124 <a class="code" href="classBarry_1_1Sync_1_1vBase.html" title="Base class containing vformat helper API.">vBase</a>();
<a name="l00125"></a>00125 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Sync_1_1vBase.html" title="Base class containing vformat helper API.">vBase</a>();
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <a class="code" href="structb__VFormat.html">b_VFormat</a>* Format() { <span class="keywordflow">return</span> m_format; }
<a name="l00128"></a>00128 <span class="keyword">const</span> <a class="code" href="structb__VFormat.html">b_VFormat</a>* Format()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_format; }
<a name="l00129"></a>00129 <span class="keywordtype">void</span> SetFormat(<a class="code" href="structb__VFormat.html">b_VFormat</a> *format);
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keywordtype">void</span> Clear();
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</a> NewAttr(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00134"></a>00134 <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</a> NewAttr(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00135"></a>00135 <span class="keywordtype">void</span> AddAttr(<a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</a> attr);
<a name="l00136"></a>00136 <span class="keywordtype">void</span> AddValue(<a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</a> &attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00137"></a>00137 <span class="keywordtype">void</span> AddEncodedValue(<a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</a> &attr, b_VFormatEncoding encoding, <span class="keyword">const</span> <span class="keywordtype">char</span> *value, <span class="keywordtype">int</span> len);
<a name="l00138"></a>00138 <span class="keywordtype">void</span> AddParam(<a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &#39;free&#39;...">vAttrPtr</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="l00139"></a>00139
<a name="l00140"></a>00140 std::string GetAttr(<span class="keyword">const</span> <span class="keywordtype">char</span> *attrname, <span class="keyword">const</span> <span class="keywordtype">char</span> *block = 0);
<a name="l00141"></a>00141 std::vector<std::string> GetValueVector(<span class="keyword">const</span> <span class="keywordtype">char</span> *attrname, <span class="keyword">const</span> <span class="keywordtype">char</span> *block = 0);
<a name="l00142"></a>00142 <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a> GetAttrObj(<span class="keyword">const</span> <span class="keywordtype">char</span> *attrname, <span class="keywordtype">int</span> nth = 0, <span class="keyword">const</span> <span class="keywordtype">char</span> *block = 0);
<a name="l00143"></a>00143
<a name="l00144"></a>00144 std::vector<std::string> Tokenize(<span class="keyword">const</span> std::string &str, <span class="keyword">const</span> <span class="keywordtype">char</span> delim = <span class="charliteral">','</span>);
<a name="l00145"></a>00145 std::string ToStringList(<span class="keyword">const</span> std::vector<std::string> &list, <span class="keyword">const</span> <span class="keywordtype">char</span> delim = <span class="charliteral">','</span>);
<a name="l00146"></a>00146 };
<a name="l00147"></a>00147
<a name="l00148"></a>00148 }} <span class="comment">// namespace Barry::Sync</span>
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="preprocessor">#endif</span>
<a name="l00151"></a>00151 <span class="preprocessor"></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>
