This repository has been archived on 2020-05-16. You can view files and clone it, but cannot push or open issues or pull requests.
xdgcfg/docs/xdgcfg_8hpp_source.html
2019-07-21 23:12:08 +02:00

67 lines
21 KiB
HTML

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>xdgcfg: src/xdgcfg.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xdgcfg
&#160;<span id="projectnumber">0.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">xdgcfg.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Public Domain / CC-0</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Author: tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef XDGCFG_HPP</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define XDGCFG_HPP</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#if __cplusplus &gt;= 201703L</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"> #include &lt;filesystem&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor"> #include &lt;experimental/filesystem&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;libconfig.h++&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;basedir.h&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#if __cplusplus &gt;= 201703L</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">namespace </span>fs = std::filesystem;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">namespace </span>fs = std::experimental::filesystem;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">using</span> std::uint_fast8_t;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">using</span> std::cerr;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">using</span> std::endl;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classxdgcfg.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classxdgcfg.html">xdgcfg</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classxdgcfg.html#ab6fc4f07be696a779d26317a5a7a8b54"> 43</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classxdgcfg.html#ab6fc4f07be696a779d26317a5a7a8b54">xdgcfg</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;filename, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;subdir = <span class="stringliteral">&quot;&quot;</span>)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; : _cfg()</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; , _verbose(false)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; xdgHandle xdg;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; xdgInitHandle(&amp;xdg);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; _filepath = xdgConfigHome(&amp;xdg);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; xdgWipeHandle(&amp;xdg);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">if</span> (!subdir.empty())</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; _filepath /= subdir;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">if</span> (!fs::exists(_filepath))</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; fs::create_directories(_filepath);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; _filepath /= filename;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classxdgcfg.html#a60584df7badfddce574df3cc1b9fce85"> 68</a></span>&#160; uint_fast8_t <a class="code" href="classxdgcfg.html#a60584df7badfddce574df3cc1b9fce85">read</a>()</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; _cfg.readFile(_filepath.c_str());</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> libconfig::FileIOException &amp;e)</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">if</span> (_verbose)</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; cerr &lt;&lt; <span class="stringliteral">&quot;I/O error while reading &quot;</span> &lt;&lt; _filepath</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; &lt;&lt; <span class="stringliteral">&quot; - &quot;</span> &lt;&lt; e.what() &lt;&lt; endl;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> 1;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> libconfig::ParseException &amp;e)</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span> (_verbose)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; cerr &lt;&lt; <span class="stringliteral">&quot;Parse error at &quot;</span> &lt;&lt; e.getFile() &lt;&lt; <span class="stringliteral">&quot;:&quot;</span> &lt;&lt; e.getLine()</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; &lt;&lt; <span class="stringliteral">&quot; - &quot;</span> &lt;&lt; e.getError() &lt;&lt; endl;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">return</span> 2;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classxdgcfg.html#addb7dd29dc725fef54820aab38b42e30"> 101</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classxdgcfg.html#addb7dd29dc725fef54820aab38b42e30">write</a>()</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; {</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; _cfg.writeFile(_filepath.c_str());</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">catch</span> (<span class="keyword">const</span> libconfig::FileIOException &amp;e)</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">if</span> (_verbose)</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; cerr &lt;&lt; <span class="stringliteral">&quot;I/O error while writing &quot;</span> &lt;&lt; _filepath</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; &lt;&lt; <span class="stringliteral">&quot; - &quot;</span> &lt;&lt; e.what() &lt;&lt; endl;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classxdgcfg.html#ab4466f9c41dd2334b7e03f434ab69be0"> 128</a></span>&#160; libconfig::Config &amp;<a class="code" href="classxdgcfg.html#ab4466f9c41dd2334b7e03f434ab69be0">get_cfg</a>()</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordflow">return</span> _cfg;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; }</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classxdgcfg.html#a27f788427081434a6bcbd6724a93e3d1"> 136</a></span>&#160; <span class="keyword">const</span> fs::path <a class="code" href="classxdgcfg.html#a27f788427081434a6bcbd6724a93e3d1">get_filepath</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="keyword"> </span>{</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordflow">return</span> _filepath;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classxdgcfg.html#a982f773bb644c465bed6144dca44c98f"> 144</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classxdgcfg.html#a982f773bb644c465bed6144dca44c98f">set_verbose</a>(<span class="keywordtype">bool</span> verbose)</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; {</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; _verbose = verbose;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; }</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="classxdgcfg.html#aa1c726d62d1194036a19bd2b7e79f531"> 152</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classxdgcfg.html#aa1c726d62d1194036a19bd2b7e79f531">get_verbose</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="keyword"> </span>{</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keywordflow">return</span> _verbose;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; }</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; libconfig::Config _cfg;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; fs::path _filepath;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordtype">bool</span> _verbose;</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;};</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="preprocessor">#endif // XDGCFG_HPP</span></div><div class="ttc" id="classxdgcfg_html"><div class="ttname"><a href="classxdgcfg.html">xdgcfg</a></div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:29</div></div>
<div class="ttc" id="classxdgcfg_html_ab4466f9c41dd2334b7e03f434ab69be0"><div class="ttname"><a href="classxdgcfg.html#ab4466f9c41dd2334b7e03f434ab69be0">xdgcfg::get_cfg</a></div><div class="ttdeci">libconfig::Config &amp; get_cfg()</div><div class="ttdoc">Returns a reference to the config as libconfig::Config. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:128</div></div>
<div class="ttc" id="classxdgcfg_html_ab6fc4f07be696a779d26317a5a7a8b54"><div class="ttname"><a href="classxdgcfg.html#ab6fc4f07be696a779d26317a5a7a8b54">xdgcfg::xdgcfg</a></div><div class="ttdeci">xdgcfg(const string &amp;filename, const string &amp;subdir=&quot;&quot;)</div><div class="ttdoc">Checks if subdir is present, creates it if necessary. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:43</div></div>
<div class="ttc" id="classxdgcfg_html_a982f773bb644c465bed6144dca44c98f"><div class="ttname"><a href="classxdgcfg.html#a982f773bb644c465bed6144dca44c98f">xdgcfg::set_verbose</a></div><div class="ttdeci">void set_verbose(bool verbose)</div><div class="ttdoc">Sets verbosity. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:144</div></div>
<div class="ttc" id="classxdgcfg_html_a27f788427081434a6bcbd6724a93e3d1"><div class="ttname"><a href="classxdgcfg.html#a27f788427081434a6bcbd6724a93e3d1">xdgcfg::get_filepath</a></div><div class="ttdeci">const fs::path get_filepath() const</div><div class="ttdoc">Returns the complete filepath. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:136</div></div>
<div class="ttc" id="classxdgcfg_html_a60584df7badfddce574df3cc1b9fce85"><div class="ttname"><a href="classxdgcfg.html#a60584df7badfddce574df3cc1b9fce85">xdgcfg::read</a></div><div class="ttdeci">uint_fast8_t read()</div><div class="ttdoc">Read the file. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:68</div></div>
<div class="ttc" id="classxdgcfg_html_aa1c726d62d1194036a19bd2b7e79f531"><div class="ttname"><a href="classxdgcfg.html#aa1c726d62d1194036a19bd2b7e79f531">xdgcfg::get_verbose</a></div><div class="ttdeci">bool get_verbose() const</div><div class="ttdoc">Returns verbosity. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:152</div></div>
<div class="ttc" id="classxdgcfg_html_addb7dd29dc725fef54820aab38b42e30"><div class="ttname"><a href="classxdgcfg.html#addb7dd29dc725fef54820aab38b42e30">xdgcfg::write</a></div><div class="ttdeci">bool write()</div><div class="ttdoc">Write the file. </div><div class="ttdef"><b>Definition:</b> xdgcfg.hpp:101</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>