|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: distrho/extra/ScopedSafeLocale.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="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.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">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
- /* @license-end */
- </script>
- <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&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li><li class="navelem"><a class="el" href="dir_b1be46be7d80596b116b2b4ac973f2f0.html">extra</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">ScopedSafeLocale.hpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
- <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
- <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com></span></div>
- <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
- <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
- <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
- <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
- <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
- <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
- <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
- <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
- <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
- <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
- <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
- <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef DISTRHO_SCOPED_SAFE_LOCALE_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define DISTRHO_SCOPED_SAFE_LOCALE_HPP_INCLUDED</span></div>
- <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
- <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../DistrhoUtils.hpp"</span></div>
- <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
- <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <clocale></span></div>
- <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
- <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#if ! (defined(DISTRHO_OS_HAIKU) || defined(DISTRHO_OS_MAC) || defined(DISTRHO_OS_WINDOWS))</span></div>
- <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"># define DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
- <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#if defined(DISTRHO_OS_WINDOWS) && __MINGW64_VERSION_MAJOR >= 5</span></div>
- <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"># define DISTRHO_USE_CONFIGTHREADLOCALE</span></div>
- <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
- <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <a class="code" href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div>
- <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
- <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// ScopedSafeLocale class definition</span></div>
- <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/**</span></div>
- <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> ScopedSafeLocale is a handy class for setting current locale to C on constructor, and revert back on destructor.</span></div>
- <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> It tries to be thread-safe, but it is not always possible.</span></div>
- <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Put it inside a scope of code where string conversions happen to ensure they are consistent across many systems.</span></div>
- <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> For example:</span></div>
- <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> ```</span></div>
- <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> // stack buffer to put converted float value in</span></div>
- <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> char strbuf[0xff];</span></div>
- <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> {</span></div>
- <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> // safe locale operations during this scope</span></div>
- <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> const ScopedSafeLocale sl;</span></div>
- <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> snprintf(strbuf, 0xff, "%f", value);</span></div>
- <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> }</span></div>
- <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> </div>
- <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> // do something with `strbuf` now, locale is reverted and left just as it was before</span></div>
- <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> ```</span></div>
- <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classScopedSafeLocale.html"> 57</a></span> <span class="keyword">class </span><a class="code" href="classScopedSafeLocale.html">ScopedSafeLocale</a> {</div>
- <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">public</span>:</div>
- <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">/*</span></div>
- <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * Constructor.</span></div>
- <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * Current system locale will saved, while "C" is set as the next one to use.</span></div>
- <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">inline</span> <a class="code" href="classScopedSafeLocale.html">ScopedSafeLocale</a>() noexcept;</div>
- <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
- <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">/*</span></div>
- <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * Destructor.</span></div>
- <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * System locale will revert back to the one saved during constructor.</span></div>
- <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div>
- <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">inline</span> ~<a class="code" href="classScopedSafeLocale.html">ScopedSafeLocale</a>() noexcept;</div>
- <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
- <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div>
- <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#ifdef DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  locale_t newloc, oldloc;</div>
- <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#else</span></div>
- <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"># ifdef DISTRHO_USE_CONFIGTHREADLOCALE</span></div>
- <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> oldthreadloc;</div>
- <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"># endif</span></div>
- <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">char</span>* <span class="keyword">const</span> oldloc;</div>
- <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
- <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  DISTRHO_DECLARE_NON_COPYABLE(<a class="code" href="classScopedSafeLocale.html">ScopedSafeLocale</a>)</div>
- <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  DISTRHO_PREVENT_HEAP_ALLOCATION</div>
- <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div>
- <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
- <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// ScopedSafeLocale class implementation</span></div>
- <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
- <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#ifdef DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">static</span> constexpr <span class="keyword">const</span> locale_t kNullLocale = (locale_t)<span class="keyword">nullptr</span>;</div>
- <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
- <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">inline</span> ScopedSafeLocale::ScopedSafeLocale() noexcept</div>
- <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#ifdef DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  : newloc(::newlocale(LC_NUMERIC_MASK, <span class="stringliteral">"C"</span>, kNullLocale)),</div>
- <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  oldloc(newloc != kNullLocale ? ::uselocale(newloc) : kNullLocale) {}</div>
- <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#else</span></div>
- <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"># ifdef DISTRHO_USE_CONFIGTHREADLOCALE</span></div>
- <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  : oldthreadloc(_configthreadlocale(_ENABLE_PER_THREAD_LOCALE)),</div>
- <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"># else</span></div>
- <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  :</div>
- <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"># endif</span></div>
- <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  oldloc(strdup(::setlocale(LC_NUMERIC, <span class="keyword">nullptr</span>)))</div>
- <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> {</div>
- <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  ::setlocale(LC_NUMERIC, <span class="stringliteral">"C"</span>);</div>
- <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> }</div>
- <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif</span></div>
- <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
- <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">inline</span> ScopedSafeLocale::~ScopedSafeLocale() noexcept</div>
- <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> {</div>
- <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#ifdef DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">if</span> (oldloc != kNullLocale)</div>
- <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  ::uselocale(oldloc);</div>
- <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">if</span> (newloc != kNullLocale)</div>
- <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  ::freelocale(newloc);</div>
- <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#else </span><span class="comment">// DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">if</span> (oldloc != <span class="keyword">nullptr</span>)</div>
- <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {</div>
- <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  ::setlocale(LC_NUMERIC, oldloc);</div>
- <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::free(oldloc);</div>
- <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  }</div>
- <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  </div>
- <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor"># ifdef DISTRHO_USE_CONFIGTHREADLOCALE</span></div>
- <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">if</span> (oldthreadloc != -1)</div>
- <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  _configthreadlocale(oldthreadloc);</div>
- <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor"># endif</span></div>
- <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif </span><span class="comment">// DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> }</div>
- <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div>
- <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
- <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
- <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#undef DISTRHO_USE_CONFIGTHREADLOCALE</span></div>
- <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#undef DISTRHO_USE_NEWLOCALE</span></div>
- <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div>
- <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <a class="code" href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div>
- <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
- <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#endif </span><span class="comment">// DISTRHO_SCOPED_SAFE_LOCALE_HPP_INCLUDED</span></div>
- <div class="ttc" id="aclassScopedSafeLocale_html"><div class="ttname"><a href="classScopedSafeLocale.html">ScopedSafeLocale</a></div><div class="ttdef"><b>Definition:</b> ScopedSafeLocale.hpp:57</div></div>
- <div class="ttc" id="agroup__NamespaceMacros_html_ga3ff541a449593e069a29e92d21e38ef3"><div class="ttname"><a href="group__NamespaceMacros.html#ga3ff541a449593e069a29e92d21e38ef3">END_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define END_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:949</div></div>
- <div class="ttc" id="agroup__NamespaceMacros_html_gac4cb97c393d20c28ba19365d844341cd"><div class="ttname"><a href="group__NamespaceMacros.html#gac4cb97c393d20c28ba19365d844341cd">START_NAMESPACE_DISTRHO</a></div><div class="ttdeci">#define START_NAMESPACE_DISTRHO</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:943</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
- </small></address>
- </body>
- </html>
|