http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/logging_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/logging_8h_source.html b/docs/cpp/logging_8h_source.html index fe83b6c..0c42dec 100644 --- a/docs/cpp/logging_8h_source.html +++ b/docs/cpp/logging_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/util/logging.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/util/logging.h 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> @@ -67,9 +67,10 @@ $(function() { <div class="title">logging.h</div> </div> </div><!--header--> <div class="contents"> -<a href="logging_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class ="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</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">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed u nder the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_UTIL_LOGGING_H</span></div><div class="line"><a name="l00019"></a><span class="lineno" > 19</span> <span class="preprocessor">#define > ARROW_UTIL_LOGGING_H</span></div><div class="line"><a > name="l00020"></a><span class="lineno"> 20</span> </div><div > class="line"><a name="l00021"></a><span class="lineno"> > 21</span> <span class="preprocessor">#include > <cstdlib></span></div><div class="line"><a name="l00022"></a><span > class="lineno"> 22</span> <span class="preprocessor">#include > <iostream></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">#include "<a class="code" > href="macros_8h.html">arrow/util/macros.h</a>"</span></div><div > class="line"><a name="l00025"></a><span class="lineno"> > 25</span> </div><div class="line"><a name="l00026"></a><span > class="lineno"> 26</span> <span class="keyword">namespace </span><a > class="code" href="namespacearrow.html">arrow</a> {</ 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="comment">// Stubbed versions of macros defined in glog/logging.h, intended for</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// environments where glog headers aren't available.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Add more as needed.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Log levels. LOG ignores them, so their values are abitrary.</span></div><div class="line"><a name="l00034"></a><span clas s="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="logging_8h.html#a3057840b0de9d217fdcedddc615295ad"> 35</a></span> <span class="preprocessor">#define ARROW_DEBUG (-1)</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="logging_8h.html#a0670d4558bbb40d053bf4d0698f0a1ea"> 36</a></span> <span class="preprocessor">#define ARROW_INFO 0</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="logging_8h.html#a4f604f658bd8290bc50f1f06119076c3"> 37</a></span> <span class="preprocessor">#define ARROW_WARNING 1</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="logging_8h.html#a8049c0e4c54326ace670750e2b8716d0"> 38</a></span> <span class="preprocessor">#define ARROW_ERROR 2</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="logging_8h.h tml#a12f356b9b859fe60b5fcc906ba71b718"> 39</a></span> <span class="preprocessor">#define ARROW_FATAL 3</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="logging_8h.html#a89c958b59b86ed5881d703b5cd5866fd"> 41</a></span> <span class="preprocessor">#define ARROW_LOG_INTERNAL(level) ::arrow::internal::CerrLog(level)</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="logging_8h.html#a6297ec7b42990f6318ea902765172cf0"> 42</a></span> <span class="preprocessor">#define ARROW_LOG(level) ARROW_LOG_INTERNAL(ARROW_##level)</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="logging_8h.html#a479d6d97ef10313772bde465cbc73926"> 43</a></span> <span class="preprocessor">#define ARROW_IGNORE_EXPR(expr) ((void)(expr));</span></div><div class="line"><a name="l00044" ></a><span class="lineno"> 44</span> </div><div class="line"><a >name="l00045"></a><span class="lineno"><a class="line" >href="logging_8h.html#a389e6c69f3ba2e62c5a9e0372059f1a4"> >45</a></span> <span class="preprocessor">#define ARROW_CHECK(condition) > \</span></div><div class="line"><a >name="l00046"></a><span class="lineno"> 46</span> <span >class="preprocessor"> (condition) ? 0 >\</span></div><div class="line"><a name="l00047"></a><span class="lineno"> >47</span> <span class="preprocessor"> : >::arrow::internal::FatalLog(ARROW_FATAL) \</span></div><div class="line"><a >name="l00048"></a><span class="lineno"> 48</span> <span >class="preprocessor"> << __FILE__ << __LINE__ ><< " Check failed: " #condition " >"</span></div><div class="line"><a name="l00049"></a><span >class="lineno"> 49</span> </div><div class="line"><a na me="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifdef NDEBUG</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define ARROW_DFATAL ARROW_WARNING</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define DCHECK(condition) \</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(condition) \</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define DCHECK_EQ(val1, val2) \</span></div><div class="line"><a name="l00057"></a><sp an class="lineno"> 57</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define DCHECK_NE(val1, val2) \</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define DCHECK_LE(val1, val2) \</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> ARROW_IGNORE _EXPR(val1) \</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define DCHECK_LT(val1, val2) \</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define DCHECK_GE(val1, val2) \</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00070"></a><span cl ass="lineno"> 70</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#define DCHECK_GT(val1, val2) \</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="logging_8h.html#ad85fba57e0e48e503ae521494e6b361c"> 76</a></span> <span class="preprocessor">#define ARROW_DFATAL ARROW_FATAL< /span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="logging_8h.html#ae17f8119c108cf3070bad3449c7e0006"> 78</a></span> <span class="preprocessor">#define DCHECK(condition) ARROW_CHECK(condition)</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="logging_8h.html#ae89df3243bbb8341130c7b3f44145ea0"> 79</a></span> <span class="preprocessor">#define DCHECK_EQ(val1, val2) ARROW_CHECK((val1) == (val2))</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="logging_8h.html#a46e69120fbd3b36e6960e096d23b66f0"> 80</a></span> <span class="preprocessor">#define DCHECK_NE(val1, val2) ARROW_CHECK((val1) != (val2))</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="logging_8h.html#a4395e95bab44e222cb2e77251017a0e2"> 81</a></span>& #160;<span class="preprocessor">#define DCHECK_LE(val1, val2) ARROW_CHECK((val1) <= (val2))</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="logging_8h.html#ab62f5ed8f2d48e29802be0cbbcd1359a"> 82</a></span> <span class="preprocessor">#define DCHECK_LT(val1, val2) ARROW_CHECK((val1) < (val2))</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="logging_8h.html#aae2dc65d9ea248d54bf39daa986dd295"> 83</a></span> <span class="preprocessor">#define DCHECK_GE(val1, val2) ARROW_CHECK((val1) >= (val2))</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="logging_8h.html#ab4f56aa24c4c9cddc47a6abd2d747f9a"> 84</a></span> <span class="preprocessor">#define DCHECK_GT(val1, val2) ARROW_CHECK((val1) > (val2))</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></ a><span class="lineno"> 86</span> <span class="preprocessor">#endif // NDEBUG</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="keyword">namespace </span>internal {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">class </span>NullLog {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  NullLog& operator<<(<span class="keyword">const</span> T& t) {</div><div class="line">< a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> };</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">class </span>CerrLog {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  CerrLog(<span class="keywordtype">int</span> severity) <span class="comment">// NOLINT(runtime/explicit)</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  : severity_(severity), has_logged_(<span class="keyword">false</s pan>) {}</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">virtual</span> ~CerrLog() {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">if</span> (has_logged_) {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  std::cerr << std::endl;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">if</span> (severity_ == <a class="code" href="logging_8h.html#a12f356b9b859fe60b5fcc906ba71b718">ARROW_FATAL</a>) {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  std::exit(1);</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>  }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  CerrLog& operator<<(<span class="keyword">const</span> T& t) {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">if</span> (severity_ != <a class="code" href="logging_8h.html#a3057840b0de9d217fdcedddc615295ad">ARROW_DEBUG</a>) {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  has_logged_ = <span class="keyword">true</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  std::cerr << t;</div><div class="li ne"><a name="l00117"></a><span class="lineno"> 117</span>  }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</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>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> severity_;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">bool</span> has_logged_;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> };</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&# 160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// Clang-tidy isn't smart enough to determine that DCHECK using CerrLog doesn't</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// return so we create a new class to give it a hint.</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">class </span>FatalLog : <span class="keyword">public</span> CerrLog {</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">explicit</span> FatalLog(<span class="keywordtype">int</span> <span class="comment">/* severity */</span>) <span class="comment">// NOLINT</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span >  : CerrLog(<a class="code" >href="logging_8h.html#a12f356b9b859fe60b5fcc906ba71b718">ARROW_FATAL</a>) {} > <span class="comment">// NOLINT</span></div><div class="line"><a >name="l00132"></a><span class="lineno"> 132</span> </div><div >class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a >class="code" >href="macros_8h.html#a0406f232596131e1c5853411539ce0c7">ARROW_NORETURN</a> >~FatalLog() {</div><div class="line"><a name="l00134"></a><span >class="lineno"> 134</span>  <span class="keywordflow">if</span> >(has_logged_) {</div><div class="line"><a name="l00135"></a><span >class="lineno"> 135</span>  std::cerr << >std::endl;</div><div class="line"><a name="l00136"></a><span class="lineno"> >136</span>  }</div><div class="line"><a name="l00137"></a><span >class="lineno"> 137</span>  std::exit(1);</div><div class="line"><a >name="l00138"></a><span class="lineno"> 138</span>  }</div><div >class="line">< a name="l00139"></a><span class="lineno"> 139</span> };</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif // ARROW_UTIL_LOGGING_H</span></div><div class="ttc" id="macros_8h_html_a0406f232596131e1c5853411539ce0c7"><div class="ttname"><a href="macros_8h.html#a0406f232596131e1c5853411539ce0c7">ARROW_NORETURN</a></div><div class="ttdeci">#define ARROW_NORETURN</div><div class="ttdef"><b>Definition:</b > macros.h:47</div></div> +<a href="logging_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class ="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</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">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed u nder the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_UTIL_LOGGING_H</span></div><div class="line"><a name="l00019"></a><span class="lineno" > 19</span> <span class="preprocessor">#define > ARROW_UTIL_LOGGING_H</span></div><div class="line"><a > name="l00020"></a><span class="lineno"> 20</span> </div><div > class="line"><a name="l00021"></a><span class="lineno"> > 21</span> <span class="preprocessor">#include > <cstdlib></span></div><div class="line"><a name="l00022"></a><span > class="lineno"> 22</span> <span class="preprocessor">#include > <iostream></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">#include "<a class="code" > href="macros_8h.html">arrow/util/macros.h</a>"</span></div><div > class="line"><a name="l00025"></a><span class="lineno"> > 25</span> </div><div class="line"><a name="l00026"></a><span > class="lineno"> 26</span> <span class="keyword">namespace </span><a > class="code" href="namespacearrow.html">arrow</a> {</ 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="comment">// Stubbed versions of macros defined in glog/logging.h, intended for</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// environments where glog headers aren't available.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Add more as needed.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Log levels. LOG ignores them, so their values are abitrary.</span></div><div class="line"><a name="l00034"></a><span clas s="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="logging_8h.html#a3057840b0de9d217fdcedddc615295ad"> 35</a></span> <span class="preprocessor">#define ARROW_DEBUG (-1)</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="logging_8h.html#a0670d4558bbb40d053bf4d0698f0a1ea"> 36</a></span> <span class="preprocessor">#define ARROW_INFO 0</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="logging_8h.html#a4f604f658bd8290bc50f1f06119076c3"> 37</a></span> <span class="preprocessor">#define ARROW_WARNING 1</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="logging_8h.html#a8049c0e4c54326ace670750e2b8716d0"> 38</a></span> <span class="preprocessor">#define ARROW_ERROR 2</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="logging_8h.h tml#a12f356b9b859fe60b5fcc906ba71b718"> 39</a></span> <span class="preprocessor">#define ARROW_FATAL 3</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="logging_8h.html#a89c958b59b86ed5881d703b5cd5866fd"> 41</a></span> <span class="preprocessor">#define ARROW_LOG_INTERNAL(level) ::arrow::internal::CerrLog(level)</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="logging_8h.html#a6297ec7b42990f6318ea902765172cf0"> 42</a></span> <span class="preprocessor">#define ARROW_LOG(level) ARROW_LOG_INTERNAL(ARROW_##level)</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="logging_8h.html#a479d6d97ef10313772bde465cbc73926"> 43</a></span> <span class="preprocessor">#define ARROW_IGNORE_EXPR(expr) ((void)(expr));</span></div><div class="line"><a name="l00044" ></a><span class="lineno"> 44</span> </div><div class="line"><a >name="l00045"></a><span class="lineno"><a class="line" >href="logging_8h.html#a389e6c69f3ba2e62c5a9e0372059f1a4"> >45</a></span> <span class="preprocessor">#define ARROW_CHECK(condition) > \</span></div><div class="line"><a >name="l00046"></a><span class="lineno"> 46</span> <span >class="preprocessor"> (condition) ? 0 >\</span></div><div class="line"><a name="l00047"></a><span class="lineno"> >47</span> <span class="preprocessor"> : >::arrow::internal::FatalLog(ARROW_FATAL) \</span></div><div class="line"><a >name="l00048"></a><span class="lineno"> 48</span> <span >class="preprocessor"> << __FILE__ << >":" << __LINE__ << " Check failed: " >#condition " "</span></div><div class="line"><a >name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifdef NDEBUG</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define ARROW_DFATAL ARROW_WARNING</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define DCHECK(condition) \</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(condition) \</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define DCHECK_EQ(val1, val2) \</span></div><div class="line">< a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define DCHECK_NE(val1, val2) \</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define DCHECK_LE(val1, val2) \</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="prepr ocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define DCHECK_LT(val1, val2) \</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define DCHECK_GE(val1, val2) \</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a nam e="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#define DCHECK_GT(val1, val2) \</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> ARROW_IGNORE_EXPR(val1) \</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> while (false) ::arrow::internal::NullLog()</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="logging_8h.html#ad85fba57e0e48e503ae521494e6b361c"> 76</a></span> <span class="preprocessor">#define AR ROW_DFATAL ARROW_FATAL</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="logging_8h.html#ae17f8119c108cf3070bad3449c7e0006"> 78</a></span> <span class="preprocessor">#define DCHECK(condition) ARROW_CHECK(condition)</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="logging_8h.html#ae89df3243bbb8341130c7b3f44145ea0"> 79</a></span> <span class="preprocessor">#define DCHECK_EQ(val1, val2) ARROW_CHECK((val1) == (val2))</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="logging_8h.html#a46e69120fbd3b36e6960e096d23b66f0"> 80</a></span> <span class="preprocessor">#define DCHECK_NE(val1, val2) ARROW_CHECK((val1) != (val2))</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="logging_8h.html#a4395e95bab44e222cb2e77251017 a0e2"> 81</a></span> <span class="preprocessor">#define DCHECK_LE(val1, val2) ARROW_CHECK((val1) <= (val2))</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="logging_8h.html#ab62f5ed8f2d48e29802be0cbbcd1359a"> 82</a></span> <span class="preprocessor">#define DCHECK_LT(val1, val2) ARROW_CHECK((val1) < (val2))</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="logging_8h.html#aae2dc65d9ea248d54bf39daa986dd295"> 83</a></span> <span class="preprocessor">#define DCHECK_GE(val1, val2) ARROW_CHECK((val1) >= (val2))</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="logging_8h.html#ab4f56aa24c4c9cddc47a6abd2d747f9a"> 84</a></span> <span class="preprocessor">#define DCHECK_GT(val1, val2) ARROW_CHECK((val1) > (val2))</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="li ne"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif // NDEBUG</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="keyword">namespace </span>internal {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">class </span>NullLog {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  NullLog& operator<<(<span class="keyword">const</span> T& <a cla ss="code" href="macros_8h.html#a563379ffcc9ec4421d5fdeb876a194aa">ARROW_ARG_UNUSED</a>(t)) {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> };</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">class </span>CerrLog {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  CerrLog(<span class="keywordtype">int</span> severity) <span class="comment">// NOLINT(runtime/explicit)</span></div><div class="line"><a name="l0010 1"></a><span class="lineno"> 101</span>  : severity_(severity), has_logged_(<span class="keyword">false</span>) {}</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">virtual</span> ~CerrLog() {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">if</span> (has_logged_) {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  std::cerr << std::endl;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">if</span> (severity_ == <a class="code" href="logging_8h.html#a12f356b9b859fe60b5fcc906ba71b718">ARROW_FATAL</a>) {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span >  std::exit(1);</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>  }</div><div >class="line"><a name="l00111"></a><span class="lineno"> >111</span> </div><div class="line"><a name="l00112"></a><span >class="lineno"> 112</span>  <span class="keyword">template</span> ><<span class="keyword">class</span> T></div><div class="line"><a >name="l00113"></a><span class="lineno"> 113</span>  CerrLog& >operator<<(<span class="keyword">const</span> T& t) {</div><div >class="line"><a name="l00114"></a><span class="lineno"> 114</span>  ><span class="keywordflow">if</span> (severity_ != <a class="code" >href="logging_8h.html#a3057840b0de9d217fdcedddc615295ad">ARROW_DEBUG</a>) >{</div><div class="line"><a name="l00115"></a><span class="lineno"> >115</span>  has_logged_ = <span >class="keyword">true</span>;</div><div cla ss="line"><a name="l00116"></a><span class="lineno"> 116</span>  std::cerr << t;</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>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</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>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> severity_;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">bool</span> has_logged_;</div><div class="line"><a name="l00124"></a><spa n class="lineno"> 124</span> };</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// Clang-tidy isn't smart enough to determine that DCHECK using CerrLog doesn't</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// return so we create a new class to give it a hint.</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">class </span>FatalLog : <span class="keyword">public</span> CerrLog {</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">explicit</span> FatalLog(<span class="keywordtype">int</span> <span class="comment">/* severity */</span>) <span class="comment">// NOLINT</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  : CerrLog(<a class="code" href="logging_8h.html#a12f356b9b859fe60b5fcc906ba71b718">ARROW_FATAL</a>) {} <span class="comment">// NOLINT</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="macros_8h.html#a0406f232596131e1c5853411539ce0c7">ARROW_NORETURN</a> ~FatalLog() {</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">if</span> (has_logged_) {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  std::cerr << std::endl;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  std::exi t(1);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> };</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif // ARROW_UTIL_LOGGING_H</span></div><div class="ttc" id="macros_8h_html_a0406f232596131e1c5853411539ce0c7"><div class="ttname"><a href="macros_8h.html#a0406f232596131e1c58534115 39ce0c7">ARROW_NORETURN</a></div><div class="ttdeci">#define ARROW_NORETURN</div><div class="ttdef"><b>Definition:</b> macros.h:47</div></div> <div class="ttc" id="logging_8h_html_a12f356b9b859fe60b5fcc906ba71b718"><div class="ttname"><a href="logging_8h.html#a12f356b9b859fe60b5fcc906ba71b718">ARROW_FATAL</a></div><div class="ttdeci">#define ARROW_FATAL</div><div class="ttdef"><b>Definition:</b> logging.h:39</div></div> <div class="ttc" id="logging_8h_html_a3057840b0de9d217fdcedddc615295ad"><div class="ttname"><a href="logging_8h.html#a3057840b0de9d217fdcedddc615295ad">ARROW_DEBUG</a></div><div class="ttdeci">#define ARROW_DEBUG</div><div class="ttdef"><b>Definition:</b> logging.h:35</div></div> +<div class="ttc" id="macros_8h_html_a563379ffcc9ec4421d5fdeb876a194aa"><div class="ttname"><a href="macros_8h.html#a563379ffcc9ec4421d5fdeb876a194aa">ARROW_ARG_UNUSED</a></div><div class="ttdeci">#define ARROW_ARG_UNUSED(x)</div><div class="ttdef"><b>Definition:</b> macros.h:29</div></div> <div class="ttc" id="macros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div></div> <div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> allocator.h:28</div></div> </div><!-- fragment --></div><!-- contents -->
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/macros_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/macros_8h.html b/docs/cpp/macros_8h.html index acc9949..4c1033e 100644 --- a/docs/cpp/macros_8h.html +++ b/docs/cpp/macros_8h.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/util/macros.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/util/macros.h File Reference</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> @@ -78,6 +78,8 @@ Macros</h2></td></tr> <tr class="separator:a40d72e185b1488b5659b761f0b6115bb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa696459b563e15751224cec3dabc50bc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#aa696459b563e15751224cec3dabc50bc">ARROW_UNUSED</a>(x)   (void)x</td></tr> <tr class="separator:aa696459b563e15751224cec3dabc50bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a563379ffcc9ec4421d5fdeb876a194aa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a563379ffcc9ec4421d5fdeb876a194aa">ARROW_ARG_UNUSED</a>(x)</td></tr> +<tr class="separator:a563379ffcc9ec4421d5fdeb876a194aa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0406f232596131e1c5853411539ce0c7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a0406f232596131e1c5853411539ce0c7">ARROW_NORETURN</a></td></tr> <tr class="separator:a0406f232596131e1c5853411539ce0c7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f2ee7ad52872edb915cf48e163ac99c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8h.html#a6f2ee7ad52872edb915cf48e163ac99c">ARROW_PREDICT_FALSE</a>(x)   x</td></tr> @@ -90,6 +92,24 @@ Macros</h2></td></tr> <tr class="separator:a09069a1c5629cb028843a785b1f35bfe"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Macro Definition Documentation</h2> +<a id="a563379ffcc9ec4421d5fdeb876a194aa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a563379ffcc9ec4421d5fdeb876a194aa">◆ </a></span>ARROW_ARG_UNUSED</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ARROW_ARG_UNUSED</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">x</td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> <a id="a40d72e185b1488b5659b761f0b6115bb"></a> <h2 class="memtitle"><span class="permalink"><a href="#a40d72e185b1488b5659b761f0b6115bb">◆ </a></span>ARROW_DISALLOW_COPY_AND_ASSIGN</h2> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/macros_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/macros_8h_source.html b/docs/cpp/macros_8h_source.html index 1b0f257..ef12ce7 100644 --- a/docs/cpp/macros_8h_source.html +++ b/docs/cpp/macros_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/util/macros.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/util/macros.h 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> @@ -67,7 +67,7 @@ $(function() { <div class="title">macros.h</div> </div> </div><!--header--> <div class="contents"> -<a href="macros_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class= "lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</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">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed un der the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_UTIL_MACROS_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_UTIL_MACROS_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// From Google gutil</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef ARROW_DISALLOW_COPY_AND_ASSIGN</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="macros_8h.html#a40d72e185b1488b5659b761f0b6115bb"> 23</a></span> <span class="preprocessor">#define ARROW_DISALLOW_COPY_AND_ASSIGN(TypeName) \</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"> TypeName(const TypeName&) = delete; \</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"> void operator=(co nst TypeName&) = delete</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"><a class="line" href="macros_8h.html#aa696459b563e15751224cec3dabc50bc"> 28</a></span> <span class="preprocessor">#define ARROW_UNUSED(x) (void)x</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// GCC can be told that a certain branch is not likely to be taken (for</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// instance, a CHECK failure), and use th at information in static analysis.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Giving it this information can help it optimize for the common case in</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// the absence of better information (ie. -fprofile-arcs).</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">//</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#if defined(__GNUC__)</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define ARROW_PREDICT_FALSE(x) (__builtin_expect(x, 0))</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define ARROW_PREDICT_TRUE(x) (__builtin_expect(!!(x), 1))</s pan></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define ARROW_NORETURN __attribute__((noreturn))</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define ARROW_PREFETCH(addr) __builtin_prefetch(addr)</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#elif defined(_MSC_VER)</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define ARROW_NORETURN __declspec(noreturn)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#define ARROW_PREDICT_FALSE(x) x</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define ARROW_PREDICT_TRUE(x) x</span></div><div class="line"><a name="l00045"></a><span clas s="lineno"> 45</span> <span class="preprocessor">#define ARROW_PREFETCH(addr)</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="macros_8h.html#a0406f232596131e1c5853411539ce0c7"> 47</a></span> <span class="preprocessor">#define ARROW_NORETURN</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="macros_8h.html#a6f2ee7ad52872edb915cf48e163ac99c"> 48</a></span> <span class="preprocessor">#define ARROW_PREDICT_FALSE(x) x</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="macros_8h.html#a1f418a9edc46d53e62732e7ccd06f329"> 49</a></span> <span class="preprocessor">#define ARROW_PREDICT_TRUE(x) x</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="macros_8h.html#a76175559bb2c 4934d6084eafc14968ed"> 50</a></span> <span class="preprocessor">#define ARROW_PREFETCH(addr)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#if (defined(__GNUC__) || defined(__APPLE__))</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define ARROW_MUST_USE_RESULT __attribute__((warn_unused_result))</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#elif defined(_MSC_VER)</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define ARROW_MUST_USE_RESULT</span></div><div class="line"><a name="l00057"></a><spa n class="lineno"> 57</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="macros_8h.html#a09069a1c5629cb028843a785b1f35bfe"> 58</a></span> <span class="preprocessor">#define ARROW_MUST_USE_RESULT</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// macros to disable padding</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// these macros are portable across different compilers and platforms</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">//[https://github.com/google/flatbuffers/blob/master/include/fl atbuffers/flatbuffers.h#L1355]</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#if !defined(MANUALLY_ALIGNED_STRUCT)</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#if defined(_MSC_VER)</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#define MANUALLY_ALIGNED_STRUCT(alignment) \</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> __pragma(pack(1)); \</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> struct __declspec(align(alignment))</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#define STRUCT_END(name, size) \</span></div><div class="line"><a name="l000 70"></a><span class="lineno"> 70</span> <span class="preprocessor"> __pragma(pack()); \</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> static_assert(sizeof(name) == size, "compiler breaks packing rules")</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#elif defined(__GNUC__) || defined(__clang__)</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#define MANUALLY_ALIGNED_STRUCT(alignment) \</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> _Pragma("pack(1)") struct __attribute__((aligned(alignment)))</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#define STRUCT_END(name, size) \</span></div><div class="li ne"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> _Pragma("pack()") static_assert(sizeof(name) == size, "compiler breaks packing rules")</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#error Unknown compiler, please define structure alignment macros</span></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> <span class="preprocessor">#endif // !defined(MANUALLY_ALIGNED_STRUCT)</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#end if // ARROW_UTIL_MACROS_H</span></div></div><!-- fragment --></div><!-- contents --> +<a href="macros_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class= "lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</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">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed un der the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_UTIL_MACROS_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_UTIL_MACROS_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// From Google gutil</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef ARROW_DISALLOW_COPY_AND_ASSIGN</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="macros_8h.html#a40d72e185b1488b5659b761f0b6115bb"> 23</a></span> <span class="preprocessor">#define ARROW_DISALLOW_COPY_AND_ASSIGN(TypeName) \</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"> TypeName(const TypeName&) = delete; \</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"> void operator=(co nst TypeName&) = delete</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"><a class="line" href="macros_8h.html#aa696459b563e15751224cec3dabc50bc"> 28</a></span> <span class="preprocessor">#define ARROW_UNUSED(x) (void)x</span></div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="macros_8h.html#a563379ffcc9ec4421d5fdeb876a194aa"> 29</a></span> <span class="preprocessor">#define ARROW_ARG_UNUSED(x)</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// GCC can be told that a certain branch is not likely to be taken (for</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// instance, a CHECK failure), and use that information in static analysis.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Giving it this information can help it optimize for the common case in</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// the absence of better information (ie. -fprofile-arcs).</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">//</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#if defined(__GNUC__)</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define ARROW_PREDICT_FALSE(x) (__builtin_expect(x, 0))</span></div><div class="line"><a name="l0 0038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define ARROW_PREDICT_TRUE(x) (__builtin_expect(!!(x), 1))</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define ARROW_NORETURN __attribute__((noreturn))</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define ARROW_PREFETCH(addr) __builtin_prefetch(addr)</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#elif defined(_MSC_VER)</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define ARROW_NORETURN __declspec(noreturn)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#define ARROW_PREDICT_FALSE(x) x</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define ARROW_PREDICT_TRUE(x) x</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define ARROW_PREFETCH(addr)</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="macros_8h.html#a0406f232596131e1c5853411539ce0c7"> 47</a></span> <span class="preprocessor">#define ARROW_NORETURN</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="macros_8h.html#a6f2ee7ad52872edb915cf48e163ac99c"> 48</a></span> <span class="preprocessor">#define ARROW_PREDICT_FALSE(x) x</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="macros_8h.html#a1f418a9edc46d53e62732e7ccd06f329"> 49</a></span> <span class="preprocessor">#define ARROW_PRE DICT_TRUE(x) x</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="macros_8h.html#a76175559bb2c4934d6084eafc14968ed"> 50</a></span> <span class="preprocessor">#define ARROW_PREFETCH(addr)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#if (defined(__GNUC__) || defined(__APPLE__))</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define ARROW_MUST_USE_RESULT __attribute__((warn_unused_result))</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#elif defined(_MSC_VER)</span></div><div class="line"><a name="l00056"></a><span class="l ineno"> 56</span> <span class="preprocessor">#define ARROW_MUST_USE_RESULT</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="macros_8h.html#a09069a1c5629cb028843a785b1f35bfe"> 58</a></span> <span class="preprocessor">#define ARROW_MUST_USE_RESULT</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// macros to disable padding</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// these macros are portable across different compilers and platforms</span></div><div class="line"><a name= "l00063"></a><span class="lineno"> 63</span> <span class="comment">//[https://github.com/google/flatbuffers/blob/master/include/flatbuffers/flatbuffers.h#L1355]</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#if !defined(MANUALLY_ALIGNED_STRUCT)</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#if defined(_MSC_VER)</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#define MANUALLY_ALIGNED_STRUCT(alignment) \</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> __pragma(pack(1)); \</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> struct __declspec(align(alignment))</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#define STRUCT_END(name, size) \</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"> __pragma(pack()); \</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> static_assert(sizeof(name) == size, "compiler breaks packing rules")</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#elif defined(__GNUC__) || defined(__clang__)</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#define MANUALLY_ALIGNED_STRUCT(alignment) \</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> _Pragma("pack(1)") struct __attribute__((aligned(alignment)))</span></div><div class="line"><a name=" l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#define STRUCT_END(name, size) \</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> _Pragma("pack()") static_assert(sizeof(name) == size, "compiler breaks packing rules")</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#error Unknown compiler, please define structure alignment macros</span></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> <span class="preprocessor">#endif // !defined(MANUALLY_ALIGNED_STRUCT)</span></div><div class="line"><a name="l00081"></a><span class="line no"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif // ARROW_UTIL_MACROS_H</span></div></div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html";> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/malloc_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/malloc_8h.html b/docs/cpp/malloc_8h.html index 16637a8..ba3fad0 100644 --- a/docs/cpp/malloc_8h.html +++ b/docs/cpp/malloc_8h.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/plasma/malloc.h File Reference</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/plasma/malloc.h File Reference</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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/malloc_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/malloc_8h_source.html b/docs/cpp/malloc_8h_source.html index 4166bc6..967053c 100644 --- a/docs/cpp/malloc_8h_source.html +++ b/docs/cpp/malloc_8h_source.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/plasma/malloc.h Source File</title> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/plasma/malloc.h 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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/785c5862/docs/cpp/md_tutorials_plasma.html ---------------------------------------------------------------------- diff --git a/docs/cpp/md_tutorials_plasma.html b/docs/cpp/md_tutorials_plasma.html index 51312f7..979c1a4 100644 --- a/docs/cpp/md_tutorials_plasma.html +++ b/docs/cpp/md_tutorials_plasma.html @@ -97,7 +97,7 @@ $(function() { <div class="fragment"><div class="line"><span class="comment">// Create a Plasma object with metadata.</span></div><div class="line">int64_t data_size = 100;</div><div class="line">std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line">uint8_t* data;</div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#af1ed3031d79b55c01c4714453401849f">Create</a>(object_id, data_size, (uint8_t*) metadata.data(), metadata.size(), &data);</div></div><!-- fragment --><p>Now that we've obtained a pointer to our object's data, we can write our data to it:</p> <div class="fragment"><div class="line"><span class="comment">// Write some data for the Plasma object.</span></div><div class="line"><span class="keywordflow">for</span> (int64_t i = 0; i < data_size; i++) {</div><div class="line"> data[i] = <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(i % 4);</div><div class="line">}</div></div><!-- fragment --><p>When the client is done, the client <b>seals</b> the buffer, making the object immutable, and making it available to other Plasma clients:</p> <div class="fragment"><div class="line"><span class="comment">// Seal the object. This makes it available for all clients.</span></div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#ae06a7b43528f66b2dd28abf7138e5b6d">Seal</a>(object_id);</div></div><!-- fragment --><p>Here is an example that combines all these features:</p> -<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="client_8h.html">plasma/client.h</a>></span></div><div class="line"></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceplasma.html">plasma</a>;</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div><div class="line"> <span class="comment">// Start up and connect a Plasma client.</span></div><div class="line"> <a class="code" href="classplasma_1_1_plasma_client.html">PlasmaClient</a> client;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ac024b42271ad80c467636fc5b16968a3">Connect</a>(<span class="stringliteral">"/tmp/plasma"</span>, <span class="stringliteral">&q uot;"</span>, <a class="code" href="client_8h.html#ac6a4959f813315451e993a3dfe28cac7">PLASMA_DEFAULT_RELEASE_DELAY</a>));</div><div class="line"> <span class="comment">// Create an object with a random ObjectID.</span></div><div class="line"> <a class="code" href="classplasma_1_1_unique_i_d.html">ObjectID</a> object_id = <a class="code" href="classplasma_1_1_unique_i_d.html#a35bce29897b79eb6215fbd1b9ebe99bb">ObjectID::from_binary</a>(<span class="stringliteral">"00000000000000000000"</span>);</div><div class="line"> int64_t data_size = 1000;</div><div class="line"> uint8_t *data;</div><div class="line"> std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#af1ed3031d79b55c01c4714453401849f">Create</a>(object_id, data_size, (uint8_t*) m etadata.data(), metadata.size(), &data));</div><div class="line"> <span class="comment">// Write some data into the object.</span></div><div class="line"> <span class="keywordflow">for</span> (int64_t i = 0; i < data_size; i++) {</div><div class="line"> data[i] = <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(i % 4);</div><div class="line"> }</div><div class="line"> <span class="comment">// Seal the object.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ae06a7b43528f66b2dd28abf7138e5b6d">Seal</a>(object_id));</div><div class="line"> <span class="comment">// Disconnect the client.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#a82ff4d7b988c040aa46674a2fa907 eff">Disconnect</a>());</div><div class="line">}</div></div><!-- fragment --><p>This example can be compiled with</p> +<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="client_8h.html">plasma/client.h</a>></span></div><div class="line"></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespaceplasma.html">plasma</a>;</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div><div class="line"> <span class="comment">// Start up and connect a Plasma client.</span></div><div class="line"> <a class="code" href="classplasma_1_1_plasma_client.html">PlasmaClient</a> client;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ac024b42271ad80c467636fc5b16968a3">Connect</a>(<span class="stringliteral">"/tmp/plasma"</span>, <span class="stringliteral">&q uot;"</span>, <a class="code" href="client_8h.html#ac6a4959f813315451e993a3dfe28cac7">PLASMA_DEFAULT_RELEASE_DELAY</a>));</div><div class="line"> <span class="comment">// Create an object with a fixed ObjectID.</span></div><div class="line"> <a class="code" href="classplasma_1_1_unique_i_d.html">ObjectID</a> object_id = <a class="code" href="classplasma_1_1_unique_i_d.html#a35bce29897b79eb6215fbd1b9ebe99bb">ObjectID::from_binary</a>(<span class="stringliteral">"00000000000000000000"</span>);</div><div class="line"> int64_t data_size = 1000;</div><div class="line"> uint8_t *data;</div><div class="line"> std::string metadata = <span class="stringliteral">"{'author': 'john'}"</span>;</div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#af1ed3031d79b55c01c4714453401849f">Create</a>(object_id, data_size, (uint8_t*) me tadata.data(), metadata.size(), &data));</div><div class="line"> <span class="comment">// Write some data into the object.</span></div><div class="line"> <span class="keywordflow">for</span> (int64_t i = 0; i < data_size; i++) {</div><div class="line"> data[i] = <span class="keyword">static_cast<</span>uint8_t<span class="keyword">></span>(i % 4);</div><div class="line"> }</div><div class="line"> <span class="comment">// Seal the object.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#ae06a7b43528f66b2dd28abf7138e5b6d">Seal</a>(object_id));</div><div class="line"> <span class="comment">// Disconnect the client.</span></div><div class="line"> <a class="code" href="status_8h.html#ab1dca026b4840fea1e82df4c176de6b3">ARROW_CHECK_OK</a>(client.<a class="code" href="classplasma_1_1_plasma_client.html#a82ff4d7b988c040aa46674a2fa907e ff">Disconnect</a>());</div><div class="line">}</div></div><!-- fragment --><p>This example can be compiled with</p> <div class="fragment"><div class="line">g++ create.cc `pkg-config --cflags --libs plasma` --std=c++11 -o create</div></div><!-- fragment --><p>To verify that an object exists in the Plasma object store, you can call <code>PlasmaClient::Contains()</code> to check if an object has been created and sealed for a given Object ID. Note that this function will still return False if the object has been created, but not yet sealed:</p> <div class="fragment"><div class="line"><span class="comment">// Check if an object has been created and sealed.</span></div><div class="line"><span class="keywordtype">bool</span> has_object;</div><div class="line">client.<a class="code" href="classplasma_1_1_plasma_client.html#af573b2ba35f48bf012393e9438ef086d">Contains</a>(object_id, &has_object);</div><div class="line"><span class="keywordflow">if</span> (has_object) {</div><div class="line"> <span class="comment">// Object has been created and sealed, proceed</span></div><div class="line">}</div></div><!-- fragment --><h2>Getting an Object </h2> <p>After an object has been sealed, any client who knows the Object ID can get the object. To store the retrieved object contents, you should create an <code>ObjectBuffer</code>, then call <code>PlasmaClient::Get()</code> as follows:</p>
