<!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: configfile.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>configfile.h</h1><a href="configfile_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 configfile.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Barry configuraion class, for one device PIN</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) 2007-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_CONFIGFILE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_CONFIGFILE_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 "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="pin_8h.html" title="class for device PIN notation">pin.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry {
<a name="l00031"></a>00031
<a name="l00032"></a><a class="code" href="classBarry_1_1ConfigFile.html">00032</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1ConfigFile.html">ConfigFile</a>
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 <span class="keyword">public</span>:
<a name="l00035"></a><a class="code" href="classBarry_1_1ConfigFile_1_1DBListType.html">00035</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1ConfigFile_1_1DBListType.html">DBListType</a> : <span class="keyword">public</span> std::vector<std::string>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00038"></a>00038 <span class="keywordtype">bool</span> IsSelected(<span class="keyword">const</span> std::string &dbname) <span class="keyword">const</span>;
<a name="l00039"></a>00039 };
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">private</span>:
<a name="l00042"></a>00042 <span class="comment">// meta data</span>
<a name="l00043"></a>00043 <a class="code" href="classBarry_1_1Pin.html">Barry::Pin</a> m_pin;
<a name="l00044"></a>00044 std::string m_path; <span class="comment">// /path/to/config/dir without trailing slash</span>
<a name="l00045"></a>00045 std::string m_filename; <span class="comment">// /path/to/config/dir/filename</span>
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> m_loaded;
<a name="l00047"></a>00047 std::string m_last_error;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// configuration data</span>
<a name="l00050"></a>00050 <a class="code" href="classBarry_1_1ConfigFile_1_1DBListType.html">DBListType</a> m_backupList;
<a name="l00051"></a>00051 <a class="code" href="classBarry_1_1ConfigFile_1_1DBListType.html">DBListType</a> m_restoreList;
<a name="l00052"></a>00052 std::string m_deviceName;
<a name="l00053"></a>00053 <span class="keywordtype">bool</span> m_promptBackupLabel; <span class="comment">// if true, prompt the user on every</span>
<a name="l00054"></a>00054 <span class="comment">// backup for a string to label the</span>
<a name="l00055"></a>00055 <span class="comment">// backup file with</span>
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">protected</span>:
<a name="l00058"></a>00058 <span class="keywordtype">void</span> BuildFilename();
<a name="l00059"></a>00059 <span class="keywordtype">void</span> BuildDefaultPath();
<a name="l00060"></a>00060 <span class="keywordtype">void</span> Clear();
<a name="l00061"></a>00061 <span class="keywordtype">void</span> Load();
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /// Loads config file for the given pin, and ends up in an</span>
<a name="l00065"></a>00065 <span class="comment"> /// unenlightened state. Throws ConfigFileError on error,</span>
<a name="l00066"></a>00066 <span class="comment"> /// but it is not an error if the config does not exist.</span>
<a name="l00067"></a>00067 <span class="comment"> /// Never use this if you have a DatabaseDatabase object!</span>
<a name="l00068"></a>00068 <span class="comment"> /// This ctor is only for temporary loading of config data.</span>
<a name="l00069"></a>00069 <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1ConfigFile.html">ConfigFile</a>(<a class="code" href="classBarry_1_1Pin.html">Barry::Pin</a> pin);
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /// Opens and loads config file for given pin, and calls Enlighten</span>
<a name="l00072"></a>00072 <span class="comment"> /// Throws ConfigFileError on error. Should never fail unless</span>
<a name="l00073"></a>00073 <span class="comment"> /// passed a bad pin, or if unable to get current user info.</span>
<a name="l00074"></a>00074 <span class="comment"></span> <a class="code" href="classBarry_1_1ConfigFile.html">ConfigFile</a>(<a class="code" href="classBarry_1_1Pin.html">Barry::Pin</a> pin, <span class="keyword">const</span> <a class="code" href="classBarry_1_1DatabaseDatabase.html">Barry::DatabaseDatabase</a> &db);
<a name="l00075"></a>00075
<a name="l00076"></a>00076 ~<a class="code" href="classBarry_1_1ConfigFile.html">ConfigFile</a>();
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">//</span>
<a name="l00079"></a>00079 <span class="comment">// data access</span>
<a name="l00080"></a>00080 <span class="comment">//</span>
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">const</span> std::string& get_last_error()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_last_error; }
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> IsConfigLoaded()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_loaded; }
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">const</span> std::string& GetPath()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_path; }
<a name="l00086"></a>00086 <span class="comment">// const std::string& GetDeviceConfigFilename() const { return m_device_filename; }</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">//</span>
<a name="l00089"></a>00089 <span class="comment">// per-Device Configuration</span>
<a name="l00090"></a>00090 <span class="comment">//</span>
<a name="l00091"></a>00091 <span class="keyword">const</span> DBListType& GetBackupList()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_backupList; }
<a name="l00092"></a>00092 <span class="keyword">const</span> DBListType& GetRestoreList()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_restoreList; }
<a name="l00093"></a>00093 <span class="keyword">const</span> std::string& GetDeviceName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_deviceName; }
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> HasDeviceName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_deviceName.size(); }
<a name="l00095"></a>00095 <span class="keywordtype">bool</span> PromptBackupLabel()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_promptBackupLabel; }
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">//</span>
<a name="l00098"></a>00098 <span class="comment">// operations</span>
<a name="l00099"></a>00099 <span class="comment">//</span>
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /// Saves current device's config, overwriting or creating a</span>
<a name="l00102"></a>00102 <span class="comment"> /// config file</span>
<a name="l00103"></a>00103 <span class="comment"></span> <span class="keywordtype">bool</span> Save();
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment"> /// Compares a given databasedatabase from a real device with the</span>
<a name="l00106"></a>00106 <span class="comment"> /// current config. If not yet configured, initialize with valid</span>
<a name="l00107"></a>00107 <span class="comment"> /// defaults.</span>
<a name="l00108"></a>00108 <span class="comment"></span> <span class="keywordtype">void</span> Enlighten(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DatabaseDatabase.html">Barry::DatabaseDatabase</a> &db);
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="comment">//</span>
<a name="l00111"></a>00111 <span class="comment">// per-Device Configuration setting</span>
<a name="l00112"></a>00112 <span class="comment">//</span>
<a name="l00113"></a>00113 <span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment"> /// Sets list with new config</span>
<a name="l00115"></a>00115 <span class="comment"></span> <span class="keywordtype">void</span> SetBackupList(<span class="keyword">const</span> DBListType &list);
<a name="l00116"></a>00116 <span class="keywordtype">void</span> SetRestoreList(<span class="keyword">const</span> DBListType &list);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keywordtype">void</span> SetDeviceName(<span class="keyword">const</span> std::string &name);
<a name="l00119"></a>00119 <span class="keywordtype">void</span> SetBackupPath(<span class="keyword">const</span> std::string &path);
<a name="l00120"></a>00120 <span class="keywordtype">void</span> SetPromptBackupLabel(<span class="keywordtype">bool</span> prompt = <span class="keyword">true</span>);
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="comment">//</span>
<a name="l00123"></a>00123 <span class="comment">// Utility functions</span>
<a name="l00124"></a>00124 <span class="comment">//</span>
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment"> /// Checks that the path in path exists, and if not, creates it.</span>
<a name="l00127"></a>00127 <span class="comment"> /// Returns false if unable to create path, true if ok.</span>
<a name="l00128"></a>00128 <span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> CheckPath(<span class="keyword">const</span> std::string &path, std::string *perr = 0);
<a name="l00129"></a>00129 };
<a name="l00130"></a>00130
<a name="l00131"></a><a class="code" href="classBarry_1_1GlobalConfigFile.html">00131</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1GlobalConfigFile.html">GlobalConfigFile</a>
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 <span class="keyword">private</span>:
<a name="l00134"></a>00134 <span class="keyword">typedef</span> std::map<std::string, std::string> keymap_type;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="comment">// meta data</span>
<a name="l00137"></a>00137 std::string m_path; <span class="comment">// /path/to/.barry without trailing slash</span>
<a name="l00138"></a>00138 std::string m_filename; <span class="comment">// /path/to/.barry/config</span>
<a name="l00139"></a>00139 <span class="keywordtype">bool</span> m_loaded;
<a name="l00140"></a>00140 std::string m_last_error;
<a name="l00141"></a>00141 std::string m_appname;
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">// global configuration data</span>
<a name="l00144"></a>00144 <a class="code" href="classBarry_1_1Pin.html">Barry::Pin</a> m_lastDevice; <span class="comment">// the last selected device in a GUI</span>
<a name="l00145"></a>00145 <span class="keywordtype">bool</span> m_verboseLogging;
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="comment">// set/get key data</span>
<a name="l00148"></a>00148 keymap_type m_keymap;
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keyword">protected</span>:
<a name="l00151"></a>00151 <span class="keywordtype">void</span> BuildFilename();
<a name="l00152"></a>00152 <span class="keywordtype">void</span> Clear();
<a name="l00153"></a>00153 <span class="keywordtype">void</span> Load();
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment"> /// Loads the global config file.</span>
<a name="l00157"></a>00157 <span class="comment"> /// Throws ConfigFileError on error, but it is not an error</span>
<a name="l00158"></a>00158 <span class="comment"> /// if the config does not exist.</span>
<a name="l00159"></a>00159 <span class="comment"></span> <a class="code" href="classBarry_1_1GlobalConfigFile.html">GlobalConfigFile</a>();
<a name="l00160"></a>00160 <span class="comment"></span>
<a name="l00161"></a>00161 <span class="comment"> /// Loads the global config file, as well as any application-specific</span>
<a name="l00162"></a>00162 <span class="comment"> /// keywords and variables. Use this if you wish to make use of</span>
<a name="l00163"></a>00163 <span class="comment"> /// SetKey() and GetKey(), otherwise these functions will throw</span>
<a name="l00164"></a>00164 <span class="comment"> /// and exception since they don't have an application name.</span>
<a name="l00165"></a>00165 <span class="comment"></span> <a class="code" href="classBarry_1_1GlobalConfigFile.html">GlobalConfigFile</a>(<span class="keyword">const</span> std::string &appname);
<a name="l00166"></a>00166
<a name="l00167"></a>00167 ~<a class="code" href="classBarry_1_1GlobalConfigFile.html">GlobalConfigFile</a>();
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="comment">//</span>
<a name="l00170"></a>00170 <span class="comment">// data access</span>
<a name="l00171"></a>00171 <span class="comment">//</span>
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">const</span> std::string& get_last_error()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_last_error; }
<a name="l00174"></a>00174 <span class="keywordtype">bool</span> IsConfigLoaded()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_loaded; }
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="comment">//</span>
<a name="l00177"></a>00177 <span class="comment">// Global Configuration data access</span>
<a name="l00178"></a>00178 <span class="comment">//</span>
<a name="l00179"></a>00179 <a class="code" href="classBarry_1_1Pin.html">Barry::Pin</a> GetLastDevice()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_lastDevice; }
<a name="l00180"></a>00180 <span class="keywordtype">bool</span> VerboseLogging()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_verboseLogging; }
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="comment">//</span>
<a name="l00183"></a>00183 <span class="comment">// operations</span>
<a name="l00184"></a>00184 <span class="comment">//</span>
<a name="l00185"></a>00185 <span class="comment"></span>
<a name="l00186"></a>00186 <span class="comment"> /// Save the current global config, overwriting or creating as needed</span>
<a name="l00187"></a>00187 <span class="comment"></span> <span class="keywordtype">bool</span> Save();
<a name="l00188"></a>00188 <span class="comment"></span>
<a name="l00189"></a>00189 <span class="comment"> /// Throws std::logic_error if not constructed with an appname</span>
<a name="l00190"></a>00190 <span class="comment"></span> <span class="keywordtype">void</span> SetKey(<span class="keyword">const</span> std::string &key, <span class="keyword">const</span> std::string &value);
<a name="l00191"></a>00191 std::string GetKey(<span class="keyword">const</span> std::string &key) <span class="keyword">const</span>;
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="comment">//</span>
<a name="l00194"></a>00194 <span class="comment">// Global Configuration setting</span>
<a name="l00195"></a>00195 <span class="comment">//</span>
<a name="l00196"></a>00196 <span class="keywordtype">void</span> SetLastDevice(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Pin.html">Barry::Pin</a> &pin);
<a name="l00197"></a>00197 <span class="keywordtype">void</span> SetVerboseLogging(<span class="keywordtype">bool</span> verbose = <span class="keyword">true</span>);
<a name="l00198"></a>00198 };
<a name="l00199"></a>00199
<a name="l00200"></a>00200 } <span class="comment">// namespace Barry</span>
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="preprocessor">#endif</span>
<a name="l00203"></a>00203 <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>
