doc/www/doxygen/html/vbase_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: vbase.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <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>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       vbase.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Base class for vformat support</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2006-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_SYNC_VBASE_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_SYNC_VBASE_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <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>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include "vsmartptr.h"</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include "vformat.h"</span>
  50 <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>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;vector&gt;</span>
  52 <a name="l00030"></a>00030
  53 <a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Sync {
  54 <a name="l00032"></a>00032
  55 <a name="l00033"></a>00033 <span class="comment">//</span>
  56 <a name="l00034"></a>00034 <span class="comment">// vTimeZone</span>
  57 <a name="l00035"></a>00035 <span class="comment">//</span><span class="comment"></span>
  58 <a name="l00036"></a>00036 <span class="comment">/// A virtual base class that the plugins may override, to do</span>
  59 <a name="l00037"></a>00037 <span class="comment">/// time related conversions.  Default implementations for these</span>
  60 <a name="l00038"></a>00038 <span class="comment">/// functions are provided, but may be overrided depending on need.</span>
  61 <a name="l00039"></a>00039 <span class="comment">///</span>
  62 <a name="l00040"></a>00040 <span class="comment">/// We do this in a "callback" style, so that it doesn't matter what</span>
  63 <a name="l00041"></a>00041 <span class="comment">/// version of the opensync library we link against, in case the</span>
  64 <a name="l00042"></a>00042 <span class="comment">/// user wishes to use the opensync time functions.</span>
  65 <a name="l00043"></a>00043 <span class="comment">///</span>
  66 <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>
  67 <a name="l00045"></a>00045 {
  68 <a name="l00046"></a>00046 <span class="keyword">public</span>:
  69 <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>() {}
  70 <a name="l00048"></a>00048 <span class="comment"></span>
  71 <a name="l00049"></a>00049 <span class="comment">        /// Convert a time_t into an ISO timestamp string</span>
  72 <a name="l00050"></a>00050 <span class="comment">        /// Throws Barry::ConvertError on error, but these errors</span>
  73 <a name="l00051"></a>00051 <span class="comment">        /// must be rare.</span>
  74 <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);
  75 <a name="l00053"></a>00053 <span class="comment"></span>
  76 <a name="l00054"></a>00054 <span class="comment">        /// Convert an ISO timestamp string into a time_t, using</span>
  77 <a name="l00055"></a>00055 <span class="comment">        /// the current system timezone if vtime is not in UTC.</span>
  78 <a name="l00056"></a>00056 <span class="comment">        /// Returns (time_t)-1 on error.</span>
  79 <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);
  80 <a name="l00058"></a>00058 <span class="comment"></span>
  81 <a name="l00059"></a>00059 <span class="comment">        /// Convert a VEVENT alarm duration string in the format</span>
  82 <a name="l00060"></a>00060 <span class="comment">        /// of "[+-]P.W.DT.H.M.S" where the periods represent numbers</span>
  83 <a name="l00061"></a>00061 <span class="comment">        /// and each letter besides P and T represent Week, Day,</span>
  84 <a name="l00062"></a>00062 <span class="comment">        /// Hour, Minute, and Second respectively.</span>
  85 <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);
  86 <a name="l00064"></a>00064 };
  87 <a name="l00065"></a>00065
  88 <a name="l00066"></a>00066
  89 <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 &amp;#39;free&amp;#39;...">Barry::vSmartPtr&lt;b_VFormatAttribute, b_VFormatAttribute, &amp;b_vformat_attribute_free&gt;</a> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vAttrPtr</a>;
  90 <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 &amp;#39;free&amp;#39;...">Barry::vSmartPtr&lt;b_VFormatParam, b_VFormatParam, &amp;b_vformat_attribute_param_free&gt;</a> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">vParamPtr</a>;
  91 <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 &amp;#39;free&amp;#39;...">Barry::vSmartPtr&lt;char, void, &amp;g_free&gt;</a> <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#39;...">gStringPtr</a>;
  92 <a name="l00070"></a>00070
  93 <a name="l00071"></a>00071
  94 <a name="l00072"></a>00072 <span class="comment">//</span>
  95 <a name="l00073"></a>00073 <span class="comment">// vAttr</span>
  96 <a name="l00074"></a>00074 <span class="comment">//</span><span class="comment"></span>
  97 <a name="l00075"></a>00075 <span class="comment">/// Class for reading a b_VFormatAttribute.  Reading does not require</span>
  98 <a name="l00076"></a>00076 <span class="comment">/// memory management, so none is done.</span>
  99 <a name="l00077"></a>00077 <span class="comment">///</span>
 100 <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>
 101 <a name="l00079"></a>00079 {
 102 <a name="l00080"></a>00080         b_VFormatAttribute *m_attr;
 103 <a name="l00081"></a>00081
 104 <a name="l00082"></a>00082 <span class="keyword">public</span>:
 105 <a name="l00083"></a>00083         <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>()
 106 <a name="l00084"></a>00084                 : m_attr(0)
 107 <a name="l00085"></a>00085         {
 108 <a name="l00086"></a>00086         }
 109 <a name="l00087"></a>00087
 110 <a name="l00088"></a>00088         <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>(b_VFormatAttribute *attr)
 111 <a name="l00089"></a>00089                 : m_attr(attr)
 112 <a name="l00090"></a>00090         {
 113 <a name="l00091"></a>00091         }
 114 <a name="l00092"></a>00092
 115 <a name="l00093"></a>00093         <a class="code" href="classBarry_1_1Sync_1_1vAttr.html" title="Class for reading a b_VFormatAttribute.">vAttr</a>&amp; operator=(b_VFormatAttribute *attr)
 116 <a name="l00094"></a>00094         {
 117 <a name="l00095"></a>00095                 m_attr = attr;
 118 <a name="l00096"></a>00096                 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
 119 <a name="l00097"></a>00097         }
 120 <a name="l00098"></a>00098
 121 <a name="l00099"></a>00099         b_VFormatAttribute* Get() { <span class="keywordflow">return</span> m_attr; }
 122 <a name="l00100"></a>00100
 123 <a name="l00101"></a>00101         <span class="comment">// These functions do not throw an error if the value</span>
 124 <a name="l00102"></a>00102         <span class="comment">// is NULL or does not exist (for example, if you ask for</span>
 125 <a name="l00103"></a>00103         <span class="comment">// value #5 and there are only 4).</span>
 126 <a name="l00104"></a>00104         std::string GetName();
 127 <a name="l00105"></a>00105         std::string GetValue(<span class="keywordtype">int</span> nth = 0);
 128 <a name="l00106"></a>00106         std::string GetDecodedValue();
 129 <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);
 130 <a name="l00108"></a>00108         std::string GetAllParams(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
 131 <a name="l00109"></a>00109 };
 132 <a name="l00110"></a>00110
 133 <a name="l00111"></a>00111
 134 <a name="l00112"></a>00112 <span class="comment">//</span>
 135 <a name="l00113"></a>00113 <span class="comment">// vBase</span>
 136 <a name="l00114"></a>00114 <span class="comment">//</span><span class="comment"></span>
 137 <a name="l00115"></a>00115 <span class="comment">/// Base class containing vformat helper API.</span>
 138 <a name="l00116"></a>00116 <span class="comment">///</span>
 139 <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>
 140 <a name="l00118"></a>00118 {
 141 <a name="l00119"></a>00119         <span class="comment">// internal data for managing the vformat</span>
 142 <a name="l00120"></a>00120         b_VFormat *m_format;
 143 <a name="l00121"></a>00121
 144 <a name="l00122"></a>00122 <span class="keyword">public</span>:
 145 <a name="l00123"></a>00123 <span class="keyword">protected</span>:
 146 <a name="l00124"></a>00124         <a class="code" href="classBarry_1_1Sync_1_1vBase.html" title="Base class containing vformat helper API.">vBase</a>();
 147 <a name="l00125"></a>00125         <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1Sync_1_1vBase.html" title="Base class containing vformat helper API.">vBase</a>(b_VFormat *format);
 148 <a name="l00126"></a>00126         <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Sync_1_1vBase.html" title="Base class containing vformat helper API.">vBase</a>();
 149 <a name="l00127"></a>00127
 150 <a name="l00128"></a>00128         b_VFormat* Format() { <span class="keywordflow">return</span> m_format; }
 151 <a name="l00129"></a>00129         <span class="keyword">const</span> b_VFormat* Format()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_format; }
 152 <a name="l00130"></a>00130         <span class="keywordtype">void</span> SetFormat(b_VFormat *format);
 153 <a name="l00131"></a>00131
 154 <a name="l00132"></a>00132         <span class="keywordtype">void</span> Clear();
 155 <a name="l00133"></a>00133
 156 <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 &amp;#39;free&amp;#39;...">vAttrPtr</a> NewAttr(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
 157 <a name="l00135"></a>00135         <a class="code" href="classBarry_1_1vSmartPtr.html" title="A special smart pointer for variables that have their own special &amp;#39;free&amp;#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);
 158 <a name="l00136"></a>00136         <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 &amp;#39;free&amp;#39;...">vAttrPtr</a> attr);
 159 <a name="l00137"></a>00137         <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 &amp;#39;free&amp;#39;...">vAttrPtr</a> &amp;attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
 160 <a name="l00138"></a>00138         <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 &amp;#39;free&amp;#39;...">vAttrPtr</a> &amp;attr, b_VFormatEncoding encoding, <span class="keyword">const</span> <span class="keywordtype">char</span> *value, <span class="keywordtype">int</span> len);
 161 <a name="l00139"></a>00139         <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 &amp;#39;free&amp;#39;...">vAttrPtr</a> &amp;attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
 162 <a name="l00140"></a>00140
 163 <a name="l00141"></a>00141         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);
 164 <a name="l00142"></a>00142         std::vector&lt;std::string&gt; GetValueVector(<span class="keyword">const</span> <span class="keywordtype">char</span> *attrname, <span class="keyword">const</span> <span class="keywordtype">char</span> *block = 0);
 165 <a name="l00143"></a>00143         <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);
 166 <a name="l00144"></a>00144
 167 <a name="l00145"></a>00145         std::vector&lt;std::string&gt; Tokenize(<span class="keyword">const</span> std::string &amp;str, <span class="keyword">const</span> <span class="keywordtype">char</span> delim = <span class="charliteral">','</span>);
 168 <a name="l00146"></a>00146         std::string ToStringList(<span class="keyword">const</span> std::vector&lt;std::string&gt; &amp;list, <span class="keyword">const</span> <span class="keywordtype">char</span> delim = <span class="charliteral">','</span>);
 169 <a name="l00147"></a>00147 };
 170 <a name="l00148"></a>00148
 171 <a name="l00149"></a>00149 }} <span class="comment">// namespace Barry::Sync</span>
 172 <a name="l00150"></a>00150
 173 <a name="l00151"></a>00151 <span class="preprocessor">#endif</span>
 174 <a name="l00152"></a>00152 <span class="preprocessor"></span>
 175 </pre></div></div>
 176 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:59 2011 for Barry by&nbsp;
 177 <a href="http://www.doxygen.org/index.html">
 178 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 179 </body>
 180 </html>