-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbase_8h_source.html
209 lines (207 loc) · 21.3 KB
/
base_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<!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>farm-ng-core: /home/runner/work/farm-ng-core/farm-ng-core/cpp/farm_ng/core/struct/base.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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">farm-ng-core
</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('base_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">base.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="base_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">// Copyright 2022, farm-ng inc.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</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">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#pragma once</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">#include "<a class="code" href="macro__lib_8h.html">farm_ng/core/struct/macro_lib.h</a>"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <farm_pp/preprocessor/comparison/equal.hpp></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <farm_pp/preprocessor/control/if.hpp></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <farm_pp/preprocessor/punctuation/remove_parens.hpp></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <farm_pp/preprocessor/seq/pop_front.hpp></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <farm_pp/preprocessor/tuple/elem.hpp></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// Given a triplet such as (Type, name, init), return a field declaration.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">///</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/// ${triplet}</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">///</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/// => ${triplet}[0] ${triplet}[1] ${triplet}[2]</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">/// Example:</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">///</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// Input: (Type0, name0, {init0})</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/// Output: Type name {init};</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"><a class="line" href="base_8h.html#a30a755c37fd71ec7598abe38947b5fdb"> 36</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_FIELD_DECLARATION( \</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"> Dummy1_, Dummy2_, Type_Name_Init_) \</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"> FARM_PP_TUPLE_ELEM(0, Type_Name_Init_) \</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"> FARM_PP_TUPLE_ELEM(1, Type_Name_Init_) FARM_PP_TUPLE_ELEM(2, Type_Name_Init_);</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">/// Given a sequence of triplets, create field declarations for</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/// each triplet.</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">/// Example:</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">///</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// Input: ((Type0, name0, init0)) ((Type1, name1, init1)) ...</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/// Output: Type0 name0 {init0}; Type1 name1 {init1}; ...</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="base_8h.html#afeb1340b259bc9b3b96ffa671da66195"> 48</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_FIELD_DECLARATION_LOOP(Field_Seq_) \</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"> FARM_PP_SEQ_FOR_EACH(FARM_STRUCT_DETAILS_FIELD_DECLARATION, _, Field_Seq_)</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/// Given a triplet such as (Type, name, init), return the name as a string</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/// leading with a comma.</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">/// ${triplet}</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">/// => , "${triplet}[1]"</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">///</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/// Example:</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">/// Input: (Type0, name0, {init0})</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/// Output: , "name0"</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="base_8h.html#af7a0edb7e7653242f0e76d8063950332"> 62</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_FIELD_NAME(Dummy1_, Dummy2_, Type_Name_Init_) \</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> , FARM_PP_STRINGIZE(FARM_PP_TUPLE_ELEM(1, Type_Name_Init_))</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/// Given a sequence of triplets, create a comma separated list of field name</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/// strings.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">///</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/// Example:</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">///</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/// Input: ((Type0, name0, init0)) ((Type1, name1, init1)) ... Output: ,</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/// Output: name0, name1 ...</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="base_8h.html#abfe133a99c075092a5c8b6bd3817f839"> 72</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_FIELD_NAME_LOOP(Field_Seq_) \</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> FARM_PP_STRINGIZE(FARM_PP_TUPLE_ELEM(1, FARM_PP_SEQ_ELEM(0, Field_Seq_))) \</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> FARM_PP_SEQ_FOR_EACH( \</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> FARM_STRUCT_DETAILS_FIELD_NAME, _, FARM_PP_SEQ_POP_FRONT(Field_Seq_))</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/// Given a triplet such as (Type, name, init), return the type.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">///</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/// ${triplet}</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">///</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">/// => ${triplet}[0]</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">///</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/// Example:</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">///</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/// Input: (Type0, name0, {init0})</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/// Output: , Type</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="base_8h.html#a70ac98988541017a6250bb8e0c144f00"> 87</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_FIELD_TYPE(Dummy1_, Dummy2_, Type_Name_Init_) \</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"> , FARM_PP_TUPLE_ELEM(0, Type_Name_Init_)</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/// Given a sequence of triplets, create a comma separated list of field types.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">///</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/// Example:</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">///</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/// Input: ((Type0, name0, init0)) ((Type1, name1, init1)) ...</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/// Output: , Type0 , Type1 ...</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="base_8h.html#a8696b0d2fe8fce07d9fd2915074e3ddb"> 96</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_FIELD_TYPE_LOOP(Field_Seq_) \</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"> FARM_PP_TUPLE_ELEM(0, FARM_PP_SEQ_ELEM(0, Field_Seq_)) \</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"> FARM_PP_SEQ_FOR_EACH( \</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"> FARM_STRUCT_DETAILS_FIELD_TYPE, _, FARM_PP_SEQ_POP_FRONT(Field_Seq_))</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">/// Implementation details for FARM_STRUCT.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="base_8h.html#a6ff1c919dcaa2d17cf100c7d5de8ca63"> 102</a></span> <span class="comment"></span><span class="preprocessor">#define FARM_STRUCT_DETAILS_BASE(Num_Fields_, Field_Seq_) \</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"> static int constexpr kNumFields = Num_Fields_; \</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"> static std::array<std::string_view, kNumFields> constexpr kFieldNames = { \</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"> FARM_STRUCT_DETAILS_FIELD_NAME_LOOP(Field_Seq_)}; \</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"> using FieldTypes = \</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> std::tuple<FARM_STRUCT_DETAILS_FIELD_TYPE_LOOP(Field_Seq_)>; \</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> FARM_STRUCT_DETAILS_FIELD_DECLARATION_LOOP(Field_Seq_)</span></div>
<div class="ttc" id="amacro__lib_8h_html"><div class="ttname"><a href="macro__lib_8h.html">macro_lib.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_df511e5bd85cec96854b39d5e1c27aa8.html">cpp</a></li><li class="navelem"><a class="el" href="dir_0308c12ad8158275f0c131a01f906685.html">farm_ng</a></li><li class="navelem"><a class="el" href="dir_c1d4bf06504c7829838fa1aa9a28d188.html">core</a></li><li class="navelem"><a class="el" href="dir_4720c4df6f42865fdafa6fe59ab275f2.html">struct</a></li><li class="navelem"><a class="el" href="base_8h.html">base.h</a></li>
<li class="footer">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 </li>
</ul>
</div>
</body>
</html>