blob: 9e38ecdfe5d10e5bd7b0fdd520f79f2ddd11bb26 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Mesos: 3rdparty/stout/include/stout/foreach.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_aa547de1d719d14adccfca1dfb1735b3.html">stout</a></li><li class="navelem"><a class="el" href="dir_1a1b923d951dd999d43396870333fc33.html">include</a></li><li class="navelem"><a class="el" href="dir_dbd52553d038069c1ed93e3477ea333d.html">stout</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">foreach.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="foreach_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __STOUT_FOREACH_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __STOUT_FOREACH_HPP__</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;tuple&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="preprocessor_8hpp.html">stout/preprocessor.hpp</a>&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#a490273631f7a87286eb97e039acb6bd7"> 21</a></span>&#160;<span class="preprocessor">#define STOUT_FOREACH_PREFIX CAT(__foreach_, __LINE__)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#ad1515a2099bf691516e3567e1b2daabe"> 22</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define STOUT_FOREACH_BODY CAT(STOUT_FOREACH_PREFIX, _body__)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#ab5b9d86a4dd670c4d943f19eaa034a95"> 23</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define STOUT_FOREACH_BREAK CAT(STOUT_FOREACH_PREFIX, _break__)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#a37bb3270a89730b267c724f02da6a4a3"> 24</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define STOUT_FOREACH_CONTINUE CAT(STOUT_FOREACH_PREFIX, _continue__)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#a10a782133408245cc954deb9dbe9feee"> 25</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define STOUT_FOREACH_ELEM CAT(STOUT_FOREACH_PREFIX, _elem__)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#abbdcadceed9418ae9dc025a1205bafa9"> 26</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define STOUT_FOREACH_ONCE CAT(STOUT_FOREACH_PREFIX, _once__)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">// `foreach` is a trivial expansion to the range-based `for`.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#abc57d06899e91a60a3a35de756d337ba"> 30</a></span>&#160;<span class="preprocessor">#define foreach(ELEM, ELEMS) for (ELEM : ELEMS)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">// `foreachpair` is used to unpack the key and value of the pairs coming out of</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">// a sequence. e.g., std::map.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// Control flow:</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment">// Labels:</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// * `STOUT_FOREACH_BREAK` is the label that when jumped to, breaks out of</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// the loop.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">// * `STOUT_FOREACH_BODY` is the label that helps to skip the loop exit checks</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">// (break or continue) until we finish the current iteration.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// Flags:</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// * `STOUT_FOREACH_CONTINUE` determines whether the loop should continue or</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment">// not. If we encounter a `break`, this will be `false`. If we encounter a</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">// `continue` or run the current iteration to completion,</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment">// `STOUT_FOREACH_CONTINUE` will be set to `true`.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">// * `STOUT_FOREACH_ONCE` is used to execute a `for` loop exactly once.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#a66900b166526abe66464d6597536b111"> 51</a></span>&#160;<span class="preprocessor">#define foreachpair(KEY, VALUE, ELEMS) \</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor"> foreach (auto&amp;&amp; STOUT_FOREACH_ELEM, ELEMS) \</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor"> if (false) STOUT_FOREACH_BREAK: break; </span><span class="comment">/* set up the break path */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor"> else if (bool STOUT_FOREACH_CONTINUE = false) {} </span><span class="comment">/* var decl */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor"> else if (true) goto STOUT_FOREACH_BODY; </span><span class="comment">/* skip the loop exit checks */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor"> else for (;;) </span><span class="comment">/* determine whether we should break or continue. */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor"> if (!STOUT_FOREACH_CONTINUE) goto STOUT_FOREACH_BREAK; </span><span class="comment">/* break */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor"> else if (true) break; </span><span class="comment">/* continue */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor"> else \</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor"> STOUT_FOREACH_BODY: \</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor"> if (bool STOUT_FOREACH_ONCE = false) {} </span><span class="comment">/* var decl */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor"> else for (KEY = std::get&lt;0&gt;( \</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor"> std::forward&lt;decltype(STOUT_FOREACH_ELEM)&gt;( \</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor"> STOUT_FOREACH_ELEM)); \</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="preprocessor"> !STOUT_FOREACH_ONCE; \</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="preprocessor"> STOUT_FOREACH_ONCE = true) \</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor"> for (VALUE = std::get&lt;1&gt;( \</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor"> std::forward&lt;decltype(STOUT_FOREACH_ELEM)&gt;( \</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor"> STOUT_FOREACH_ELEM)); \</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor"> !STOUT_FOREACH_CONTINUE; \</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor"> STOUT_FOREACH_CONTINUE = true)</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#acac417231a256d7c6164a86db970da86"> 74</a></span>&#160;<span class="preprocessor">#define foreachkey(KEY, ELEMS) foreachpair (KEY, std::ignore, ELEMS)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="foreach_8hpp.html#a28670619e64a84270d76f07b0f6eb3b6"> 77</a></span>&#160;<span class="preprocessor">#define foreachvalue(VALUE, ELEMS) foreachpair (std::ignore, VALUE, ELEMS)</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#endif // __STOUT_FOREACH_HPP__</span></div>
<div class="ttc" id="preprocessor_8hpp_html"><div class="ttname"><a href="preprocessor_8hpp.html">preprocessor.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>