147 lines
16 KiB
HTML
147 lines
16 KiB
HTML
<!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.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: src/entt/locator/locator.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">EnTT
|
|
 <span id="projectnumber">3.3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<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');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_66e9674e8206a335795995fa32a03c91.html">entt</a></li><li class="navelem"><a class="el" href="dir_b64489a1e8130d5ebf6d86d282f500f0.html">locator</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">locator.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef ENTT_LOCATOR_LOCATOR_HPP</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_LOCATOR_LOCATOR_HPP</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <utility></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../config/config.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">template</span><<span class="keyword">typename</span> Service></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html"> 25</a></span> <span class="keyword">struct </span><a class="code" href="structentt_1_1service__locator.html">service_locator</a> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#af34a883e56f32a98d7b8a5db87bdf504"> 27</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1service__locator.html#af34a883e56f32a98d7b8a5db87bdf504">service_type</a> = Service;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="structentt_1_1service__locator.html#a120cdb3eb1d820e5649f3d8bac8098d0">service_locator</a>() = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="structentt_1_1service__locator.html#a2cbb6cfc1614067ae92f1c60580236a8">~service_locator</a>() = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#a9265b7273a758003283a79f7a4de6250"> 38</a></span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structentt_1_1service__locator.html#a9265b7273a758003283a79f7a4de6250">empty</a>() ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">return</span> !static_cast<bool>(service);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#ab72c1dab3eec4554690a82457894b385"> 52</a></span>  <span class="keyword">static</span> std::weak_ptr<Service> <a class="code" href="structentt_1_1service__locator.html#ab72c1dab3eec4554690a82457894b385">get</a>() ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> service;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#ae24d16726620af40371fadeddf5b5e2e"> 70</a></span>  <span class="keyword">static</span> Service & <a class="code" href="structentt_1_1service__locator.html#ae24d16726620af40371fadeddf5b5e2e">ref</a>() ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> *service;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Impl = Service, <span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#a116dc62f5d2a1c65db9d7528c957e91f"> 81</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structentt_1_1service__locator.html#a116dc62f5d2a1c65db9d7528c957e91f">set</a>(Args &&... args) {</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  service = std::make_shared<Impl>(std::forward<Args>(args)...);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#a86770e79d01ab5fb0dddffba0bf9a697"> 89</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structentt_1_1service__locator.html#a86770e79d01ab5fb0dddffba0bf9a697">set</a>(std::shared_ptr<Service> ptr) {</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  ENTT_ASSERT(static_cast<bool>(ptr));</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  service = std::move(ptr);</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="structentt_1_1service__locator.html#a4d655acab54d87058ad41a266830d0e8"> 99</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structentt_1_1service__locator.html#a4d655acab54d87058ad41a266830d0e8">reset</a>() {</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  service.reset();</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</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">private</span>:</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">inline</span> <span class="keyword">static</span> std::shared_ptr<Service> service = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> };</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</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> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructentt_1_1service__locator_html"><div class="ttname"><a href="structentt_1_1service__locator.html">entt::service_locator</a></div><div class="ttdoc">Service locator, nothing more.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00025">locator.hpp:25</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_af34a883e56f32a98d7b8a5db87bdf504"><div class="ttname"><a href="structentt_1_1service__locator.html#af34a883e56f32a98d7b8a5db87bdf504">entt::service_locator::service_type</a></div><div class="ttdeci">Service service_type</div><div class="ttdoc">Type of service offered.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00027">locator.hpp:27</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_ae24d16726620af40371fadeddf5b5e2e"><div class="ttname"><a href="structentt_1_1service__locator.html#ae24d16726620af40371fadeddf5b5e2e">entt::service_locator::ref</a></div><div class="ttdeci">static Service & ref() ENTT_NOEXCEPT</div><div class="ttdoc">Returns a weak reference to a service implementation, if any.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00070">locator.hpp:70</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_a4d655acab54d87058ad41a266830d0e8"><div class="ttname"><a href="structentt_1_1service__locator.html#a4d655acab54d87058ad41a266830d0e8">entt::service_locator::reset</a></div><div class="ttdeci">static void reset()</div><div class="ttdoc">Resets a service.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00099">locator.hpp:99</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_ab72c1dab3eec4554690a82457894b385"><div class="ttname"><a href="structentt_1_1service__locator.html#ab72c1dab3eec4554690a82457894b385">entt::service_locator::get</a></div><div class="ttdeci">static std::weak_ptr< Service > get() ENTT_NOEXCEPT</div><div class="ttdoc">Returns a weak pointer to a service implementation, if any.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00052">locator.hpp:52</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_a2cbb6cfc1614067ae92f1c60580236a8"><div class="ttname"><a href="structentt_1_1service__locator.html#a2cbb6cfc1614067ae92f1c60580236a8">entt::service_locator::~service_locator</a></div><div class="ttdeci">~service_locator()=delete</div><div class="ttdoc">Default destructor, deleted on purpose.</div></div>
|
|
<div class="ttc" id="anamespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8hpp_source.html#l00013">algorithm.hpp:13</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_a120cdb3eb1d820e5649f3d8bac8098d0"><div class="ttname"><a href="structentt_1_1service__locator.html#a120cdb3eb1d820e5649f3d8bac8098d0">entt::service_locator::service_locator</a></div><div class="ttdeci">service_locator()=delete</div><div class="ttdoc">Default constructor, deleted on purpose.</div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_a86770e79d01ab5fb0dddffba0bf9a697"><div class="ttname"><a href="structentt_1_1service__locator.html#a86770e79d01ab5fb0dddffba0bf9a697">entt::service_locator::set</a></div><div class="ttdeci">static void set(std::shared_ptr< Service > ptr)</div><div class="ttdoc">Sets or replaces a service.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00089">locator.hpp:89</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_a9265b7273a758003283a79f7a4de6250"><div class="ttname"><a href="structentt_1_1service__locator.html#a9265b7273a758003283a79f7a4de6250">entt::service_locator::empty</a></div><div class="ttdeci">static bool empty() ENTT_NOEXCEPT</div><div class="ttdoc">Tests if a valid service implementation is set.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00038">locator.hpp:38</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1service__locator_html_a116dc62f5d2a1c65db9d7528c957e91f"><div class="ttname"><a href="structentt_1_1service__locator.html#a116dc62f5d2a1c65db9d7528c957e91f">entt::service_locator::set</a></div><div class="ttdeci">static void set(Args &&... args)</div><div class="ttdoc">Sets or replaces a service.</div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00081">locator.hpp:81</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|