145 lines
14 KiB
HTML
145 lines
14 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.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: src/uvw/resource.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">uvw
|
|
 <span id="projectnumber">2.8.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<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_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">resource.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 UVW_RESOURCE_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define UVW_RESOURCE_INCLUDE_H</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 "emitter.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "underlying_type.hpp"</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="namespaceuvw.html">uvw</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="l00019"></a><span class="lineno"> 19</span> <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> U></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classuvw_1_1Resource.html"> 20</a></span> <span class="keyword">class </span><a class="code" href="classuvw_1_1Resource.html">Resource</a>: <span class="keyword">public</span> <a class="code" href="classuvw_1_1UnderlyingType.html">UnderlyingType</a><T, U>, <span class="keyword">public</span> <a class="code" href="classuvw_1_1Emitter.html">Emitter</a><T>, <span class="keyword">public</span> std::enable_shared_from_this<T> {</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">using</span> ConstructorAccess = <span class="keyword">typename</span> <a class="code" href="classuvw_1_1UnderlyingType.html">UnderlyingType<T, U>::ConstructorAccess</a>;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">auto</span> parent() <span class="keyword">const</span> noexcept {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">return</span> this-><a class="code" href="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">loop</a>().loop.get();</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  }</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">void</span> leak() noexcept {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  sPtr = this->shared_from_this();</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</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="keywordtype">void</span> reset() noexcept {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  sPtr.reset();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> <span class="keyword">self</span>() <span class="keyword">const</span> noexcept {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">bool</span><span class="keyword">></span>(sPtr);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1Resource.html">Resource</a>(ConstructorAccess ca, std::shared_ptr<Loop> ref)</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  : <a class="code" href="classuvw_1_1UnderlyingType.html">UnderlyingType<T, U></a>{ca, std::move(ref)}</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  this->get()->data = <span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">template</span><<span class="keyword">typename</span> R = <span class="keywordtype">void</span>></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classuvw_1_1Resource.html#a0d6bb9bf4bcdf98afc37d3d267178813"> 52</a></span>  std::shared_ptr<R> <a class="code" href="classuvw_1_1Resource.html#a0d6bb9bf4bcdf98afc37d3d267178813">data</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> std::static_pointer_cast<R>(userData);</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="l00060"></a><span class="lineno"><a class="line" href="classuvw_1_1Resource.html#a7f7b97267eb68d987d2f85b1161e55ee"> 60</a></span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1Resource.html#a7f7b97267eb68d987d2f85b1161e55ee">data</a>(std::shared_ptr<void> uData) {</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  userData = std::move(uData);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::shared_ptr<void> userData{<span class="keyword">nullptr</span>};</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  std::shared_ptr<void> sPtr{<span class="keyword">nullptr</span>};</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> };</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> }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif // UVW_RESOURCE_INCLUDE_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassuvw_1_1Resource_html_a0d6bb9bf4bcdf98afc37d3d267178813"><div class="ttname"><a href="classuvw_1_1Resource.html#a0d6bb9bf4bcdf98afc37d3d267178813">uvw::Resource::data</a></div><div class="ttdeci">std::shared_ptr< R > data() const</div><div class="ttdoc">Gets user-defined data. uvw won't use this field in any case.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00052">resource.hpp:52</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00010">async.h:10</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1UnderlyingType_html_aab78fbfffb3c03d78aab515e605ecb18"><div class="ttname"><a href="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">uvw::UnderlyingType::loop</a></div><div class="ttdeci">Loop & loop() const noexcept</div><div class="ttdoc">Gets the loop from which the resource was originated.</div><div class="ttdef"><b>Definition:</b> <a href="underlying__type_8hpp_source.html#l00071">underlying_type.hpp:71</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1UnderlyingType_html"><div class="ttname"><a href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType</a></div><div class="ttdoc">Wrapper class for underlying types.</div><div class="ttdef"><b>Definition:</b> <a href="underlying__type_8hpp_source.html#l00020">underlying_type.hpp:20</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1Emitter_html"><div class="ttname"><a href="classuvw_1_1Emitter.html">uvw::Emitter</a></div><div class="ttdoc">Event emitter base class.</div><div class="ttdef"><b>Definition:</b> <a href="emitter_8h_source.html#l00086">emitter.h:86</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1Resource_html"><div class="ttname"><a href="classuvw_1_1Resource.html">uvw::Resource</a></div><div class="ttdoc">Common class for almost all the resources available in uvw.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00020">resource.hpp:20</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1Resource_html_a7f7b97267eb68d987d2f85b1161e55ee"><div class="ttname"><a href="classuvw_1_1Resource.html#a7f7b97267eb68d987d2f85b1161e55ee">uvw::Resource::data</a></div><div class="ttdeci">void data(std::shared_ptr< void > uData)</div><div class="ttdoc">Sets arbitrary data. uvw won't use this field in any case.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00060">resource.hpp:60</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.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
|
|
</small></address>
|
|
</body>
|
|
</html>
|