87 lines
15 KiB
HTML
87 lines
15 KiB
HTML
<!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.13"/>
|
|
<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">2.7.2</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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 <cassert></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../config/config.h"</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> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">template</span><<span class="keyword">typename</span> Service></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html"> 26</a></span> <span class="keyword">struct </span><a class="code" href="structentt_1_1ServiceLocator.html">ServiceLocator</a> final {</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#a0631b136adf579365fb444bc5e8f1416"> 28</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1ServiceLocator.html#a0631b136adf579365fb444bc5e8f1416">service_type</a> = Service;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="structentt_1_1ServiceLocator.html#a9806fa1d96f6edfb5b946b11acabc0da">ServiceLocator</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="structentt_1_1ServiceLocator.html#af0dc69f829f93c86b6537cf0c133ef75">~ServiceLocator</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#afb0038914d828b6b3483484cc906ec44"> 39</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structentt_1_1ServiceLocator.html#afb0038914d828b6b3483484cc906ec44">empty</a>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> !<span class="keyword">static_cast<</span><span class="keywordtype">bool</span><span class="keyword">></span>(service);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#a87a0d27f2ce4ac8a94229e32853503ca"> 53</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> std::weak_ptr<Service> <span class="keyword">get</span>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> service;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#a746c27214142cdd98c650c9cc66bf165"> 71</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> Service & <a class="code" href="structentt_1_1ServiceLocator.html#a746c27214142cdd98c650c9cc66bf165">ref</a>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> *service;</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="l00081"></a><span class="lineno"> 81</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="l00082"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#abf8d8b8d70ed082d54516def7500ec5c"> 82</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <span class="keyword">set</span>(Args &&... args) {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  service = std::make_shared<Impl>(std::forward<Args>(args)...);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#ad913de8d4a2dcf39b925773e42cbfff5"> 90</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <span class="keyword">set</span>(std::shared_ptr<Service> ptr) {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  assert(static_cast<bool>(ptr));</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  service = std::move(ptr);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structentt_1_1ServiceLocator.html#ac52892a5692c15c8b230a5020adb0847"> 100</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="structentt_1_1ServiceLocator.html#ac52892a5692c15c8b230a5020adb0847">reset</a>() {</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  service.reset();</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> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">static</span> std::shared_ptr<Service> service;</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> <span class="keyword">template</span><<span class="keyword">typename</span> Service></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> std::shared_ptr<Service> <a class="code" href="structentt_1_1ServiceLocator.html">ServiceLocator<Service>::service</a>{};</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> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif // ENTT_LOCATOR_LOCATOR_HPP</span></div><div class="ttc" id="structentt_1_1ServiceLocator_html_afb0038914d828b6b3483484cc906ec44"><div class="ttname"><a href="structentt_1_1ServiceLocator.html#afb0038914d828b6b3483484cc906ec44">entt::ServiceLocator::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#l00039">locator.hpp:39</a></div></div>
|
|
<div class="ttc" id="structentt_1_1ServiceLocator_html_ac52892a5692c15c8b230a5020adb0847"><div class="ttname"><a href="structentt_1_1ServiceLocator.html#ac52892a5692c15c8b230a5020adb0847">entt::ServiceLocator::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#l00100">locator.hpp:100</a></div></div>
|
|
<div class="ttc" id="namespaceentt_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#l00010">algorithm.hpp:10</a></div></div>
|
|
<div class="ttc" id="structentt_1_1ServiceLocator_html_af0dc69f829f93c86b6537cf0c133ef75"><div class="ttname"><a href="structentt_1_1ServiceLocator.html#af0dc69f829f93c86b6537cf0c133ef75">entt::ServiceLocator::~ServiceLocator</a></div><div class="ttdeci">~ServiceLocator()=delete</div><div class="ttdoc">Default destructor, deleted on purpose. </div></div>
|
|
<div class="ttc" id="structentt_1_1ServiceLocator_html_a746c27214142cdd98c650c9cc66bf165"><div class="ttname"><a href="structentt_1_1ServiceLocator.html#a746c27214142cdd98c650c9cc66bf165">entt::ServiceLocator::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#l00071">locator.hpp:71</a></div></div>
|
|
<div class="ttc" id="structentt_1_1ServiceLocator_html_a9806fa1d96f6edfb5b946b11acabc0da"><div class="ttname"><a href="structentt_1_1ServiceLocator.html#a9806fa1d96f6edfb5b946b11acabc0da">entt::ServiceLocator::ServiceLocator</a></div><div class="ttdeci">ServiceLocator()=delete</div><div class="ttdoc">Default constructor, deleted on purpose. </div></div>
|
|
<div class="ttc" id="structentt_1_1ServiceLocator_html_a0631b136adf579365fb444bc5e8f1416"><div class="ttname"><a href="structentt_1_1ServiceLocator.html#a0631b136adf579365fb444bc5e8f1416">entt::ServiceLocator::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#l00028">locator.hpp:28</a></div></div>
|
|
<div class="ttc" id="structentt_1_1ServiceLocator_html"><div class="ttname"><a href="structentt_1_1ServiceLocator.html">entt::ServiceLocator</a></div><div class="ttdoc">Service locator, nothing more. </div><div class="ttdef"><b>Definition:</b> <a href="locator_8hpp_source.html#l00026">locator.hpp:26</a></div></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">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|