<!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.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: safe_unordered_container.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> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </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('a00794_source.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">safe_unordered_container.h</div> </div> </div><!--header--> <div class="contents"> <a href="a00794.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">// Safe container implementation -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2011-2018 Free Software Foundation, Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This file is part of the GNU ISO C++ Library. This library is free</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// software; you can redistribute it and/or modify it under the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// terms of the GNU General Public License as published by the</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Free Software Foundation; either version 3, or (at your option)</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// any later version.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// GNU General Public License for more details.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Under Section 7 of GPL version 3, you are granted additional</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// permissions described in the GCC Runtime Library Exception, version</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 3.1, as published by the Free Software Foundation.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// You should have received a copy of the GNU General Public License and</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// a copy of the GCC Runtime Library Exception along with this program;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// <http://www.gnu.org/licenses/>.</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">/** @file debug/safe_unordered_container.h</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * This file is a GNU debug extension to the Standard C++ Library.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef _GLIBCXX_DEBUG_SAFE_UNORDERED_CONTAINER_H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define _GLIBCXX_DEBUG_SAFE_UNORDERED_CONTAINER_H 1</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="code" href="a00740.html">debug/assertions.h</a>></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <<a class="code" href="a00755.html">debug/macros.h</a>></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <<a class="code" href="a00749.html">debug/functions.h</a>></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <<a class="code" href="a00791.html">debug/safe_unordered_base.h</a>></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span><a class="code" href="a01568.html">__gnu_debug</a></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {<span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /**</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @brief Base class for constructing a @a safe unordered container type</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * that tracks iterators that reference it.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> *</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * The class template %_Safe_unordered_container simplifies the</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * construction of @a safe unordered containers that track the iterators</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * that reference the container, so that the iterators are notified of</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * changes in the container that may affect their operation, e.g., if</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * the container invalidates its iterators or is destructed. This class</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * template may only be used by deriving from it and passing the name</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * of the derived class as its template parameter via the curiously</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * recurring template pattern. The derived class must have @c</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * iterator and @c const_iterator types that are instantiations of</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * class template _Safe_iterator for this container and @c local_iterator</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * and @c const_local_iterator types that are instantiations of class</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * template _Safe_local_iterator for this container. Iterators will</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * then be tracked automatically.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Container></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="a08732.html"> 58</a></span>  <span class="keyword">class </span><a class="code" href="a08732.html">_Safe_unordered_container</a> : <span class="keyword">public</span> <a class="code" href="a08728.html">_Safe_unordered_container_base</a></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  _Container&</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  _M_cont() noexcept</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  { <span class="keywordflow">return</span> *static_cast<_Container*>(<span class="keyword">this</span>); }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  _M_invalidate_locals()</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">auto</span> __local_end = _M_cont()._M_base().end(0);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  this-><a class="code" href="a08732.html#aa3e9b27e61fad7cb80cfab023eac395d">_M_invalidate_local_if</a>(</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  [__local_end](__decltype(_M_cont()._M_base().<a class="code" href="a01538.html#a6cd5aaabed869c9d96801743fb4d7f6f">cend</a>(0)) __it)</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  { <span class="keywordflow">return</span> __it != __local_end; });</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</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="keywordtype">void</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  _M_invalidate_all()</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">auto</span> __end = _M_cont()._M_base().end();</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  this-><a class="code" href="a08732.html#aff0fe666b60f05c5f8da0ae92548ad42">_M_invalidate_if</a>(</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  [__end](__decltype(_M_cont()._M_base().<a class="code" href="a01538.html#a6cd5aaabed869c9d96801743fb4d7f6f">cend</a>()) __it)</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  { <span class="keywordflow">return</span> __it != __end; });</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  _M_invalidate_locals();</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /** Invalidates all iterators @c x that reference this container,</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> are not singular, and for which @c __pred(x) returns @c</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> true. @c __pred will be invoked with the normal iterators nested</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> in the safe ones. */</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Predicate></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="a08732.html#aff0fe666b60f05c5f8da0ae92548ad42">_M_invalidate_if</a>(_Predicate __pred);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /** Invalidates all local iterators @c x that reference this container,</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> are not singular, and for which @c __pred(x) returns @c</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> true. @c __pred will be invoked with the normal ilocal iterators</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> nested in the safe ones. */</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _Predicate></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="a08732.html#aa3e9b27e61fad7cb80cfab023eac395d">_M_invalidate_local_if</a>(_Predicate __pred);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  };</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> } <span class="comment">// namespace __gnu_debug</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="preprocessor">#include <<a class="code" href="a00797.html">debug/safe_unordered_container.tcc</a>></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="a08732_html_aa3e9b27e61fad7cb80cfab023eac395d"><div class="ttname"><a href="a08732.html#aa3e9b27e61fad7cb80cfab023eac395d">__gnu_debug::_Safe_unordered_container::_M_invalidate_local_if</a></div><div class="ttdeci">void _M_invalidate_local_if(_Predicate __pred)</div><div class="ttdef"><b>Definition:</b> <a href="a00797_source.html#l00070">safe_unordered_container.tcc:70</a></div></div> <div class="ttc" id="a00791_html"><div class="ttname"><a href="a00791.html">safe_unordered_base.h</a></div></div> <div class="ttc" id="a01568_html"><div class="ttname"><a href="a01568.html">__gnu_debug</a></div><div class="ttdoc">GNU debug classes for public use.</div></div> <div class="ttc" id="a00755_html"><div class="ttname"><a href="a00755.html">macros.h</a></div></div> <div class="ttc" id="a08732_html"><div class="ttname"><a href="a08732.html">__gnu_debug::_Safe_unordered_container</a></div><div class="ttdoc">Base class for constructing a safe unordered container type that tracks iterators that reference it.</div><div class="ttdef"><b>Definition:</b> <a href="a00794_source.html#l00058">safe_unordered_container.h:58</a></div></div> <div class="ttc" id="a01538_html_a6cd5aaabed869c9d96801743fb4d7f6f"><div class="ttname"><a href="a01538.html#a6cd5aaabed869c9d96801743fb4d7f6f">std::cend</a></div><div class="ttdeci">constexpr auto cend(const _Container &__cont) noexcept(noexcept(std::end(__cont))) -> decltype(std::end(__cont))</div><div class="ttdoc">Return an iterator pointing to one past the last element of the const container.</div><div class="ttdef"><b>Definition:</b> <a href="a00458_source.html#l00127">range_access.h:127</a></div></div> <div class="ttc" id="a08732_html_aff0fe666b60f05c5f8da0ae92548ad42"><div class="ttname"><a href="a08732.html#aff0fe666b60f05c5f8da0ae92548ad42">__gnu_debug::_Safe_unordered_container::_M_invalidate_if</a></div><div class="ttdeci">void _M_invalidate_if(_Predicate __pred)</div><div class="ttdef"><b>Definition:</b> <a href="a00797_source.html#l00038">safe_unordered_container.tcc:38</a></div></div> <div class="ttc" id="a00749_html"><div class="ttname"><a href="a00749.html">functions.h</a></div></div> <div class="ttc" id="a08728_html"><div class="ttname"><a href="a08728.html">__gnu_debug::_Safe_unordered_container_base</a></div><div class="ttdoc">Base class that supports tracking of local iterators that reference an unordered container.</div><div class="ttdef"><b>Definition:</b> <a href="a00791_source.html#l00120">safe_unordered_base.h:120</a></div></div> <div class="ttc" id="a00740_html"><div class="ttname"><a href="a00740.html">assertions.h</a></div></div> <div class="ttc" id="a00797_html"><div class="ttname"><a href="a00797.html">safe_unordered_container.tcc</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_e0ca5f9b79afec9781b100dc0e5c7504.html">include</a></li><li class="navelem"><a class="el" href="dir_15f6cdb42503ed1e5a77032521b39e3f.html">debug</a></li><li class="navelem"><a class="el" href="a00794.html">safe_unordered_container.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>