mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-22 04:22:01 +02:00
185 lines
20 KiB
HTML
185 lines
20 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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>cereal: base_class.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">cereal
|
|
</div>
|
|
<div id="projectbrief">A C++11 library for serialization</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d445d0c097210746bce3afd9a77bcad9.html">cereal</a></li><li class="navelem"><a class="el" href="dir_056182efa28390c8a7ef83cb1836ec86.html">types</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">base_class.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="base__class_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>  </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"> Copyright (c) 2014, Randolph Voorhies, Shane Grant</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> All rights reserved.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Redistribution and use in source and binary forms, with or without</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> modification, are permitted provided that the following conditions are met:</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Redistributions of source code must retain the above copyright</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> notice, this list of conditions and the following disclaimer.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Redistributions in binary form must reproduce the above copyright</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> notice, this list of conditions and the following disclaimer in the</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> documentation and/or other materials provided with the distribution.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Neither the name of the copyright holder nor the</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> names of its contributors may be used to endorse or promote products</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> derived from this software without specific prior written permission.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifndef CEREAL_TYPES_BASE_CLASS_HPP_</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define CEREAL_TYPES_BASE_CLASS_HPP_</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="traits_8hpp.html">cereal/details/traits.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="polymorphic__impl__fwd_8hpp.html">cereal/details/polymorphic_impl_fwd.hpp</a>"</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="keyword">namespace </span>cereal</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">namespace </span>base_class_detail</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  template <class Base, class Derived, bool IsPolymorphic = std::is_polymorphic<Base>::value></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass.html"> 44</a></span>  <span class="keyword">struct </span><a class="code" href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass.html">RegisterPolymorphicBaseClass</a></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>  <span class="keyword">static</span> <span class="keywordtype">void</span> bind()</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  { }</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  };</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">template</span> <<span class="keyword">class</span> Base, <span class="keyword">class</span> Derived></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass_3_01Base_00_01Derived_00_01true_01_4.html"> 53</a></span>  <span class="keyword">struct </span><a class="code" href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass.html">RegisterPolymorphicBaseClass</a><Base, Derived, true></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>  <span class="keyword">static</span> <span class="keywordtype">void</span> bind()</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  { <a class="code" href="structcereal_1_1detail_1_1RegisterPolymorphicCaster.html#a14f9cd6827498e31efbd8c94dc786e44">detail::RegisterPolymorphicCaster<Base, Derived>::bind</a>(); }</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  };</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">template</span><<span class="keyword">class</span> Base></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structcereal_1_1base__class.html"> 100</a></span>  <span class="keyword">struct </span><a class="code" href="structcereal_1_1base__class.html">base_class</a> : <span class="keyword">private</span> <a class="code" href="structcereal_1_1traits_1_1detail_1_1BaseCastBase.html">traits::detail::BaseCastBase</a></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>  <span class="keyword">template</span><<span class="keyword">class</span> Derived></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="structcereal_1_1base__class.html">base_class</a>(Derived <span class="keyword">const</span> * derived) :</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  base_ptr(<span class="keyword">const_cast<</span>Base*<span class="keyword">></span>(<span class="keyword">static_cast<</span>Base <span class="keyword">const </span>*<span class="keyword">></span>(derived)))</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>  static_assert( std::is_base_of<Base, Derived>::value, <span class="stringliteral">"Can only use base_class on a valid base class"</span> );</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass.html">base_class_detail::RegisterPolymorphicBaseClass<Base, Derived>::bind</a>();</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>  Base * base_ptr;</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="l00114"></a><span class="lineno"> 114</span>  </div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keyword">template</span><<span class="keyword">class</span> Base></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="structcereal_1_1virtual__base__class.html"> 188</a></span>  <span class="keyword">struct </span><a class="code" href="structcereal_1_1virtual__base__class.html">virtual_base_class</a> : <span class="keyword">private</span> <a class="code" href="structcereal_1_1traits_1_1detail_1_1BaseCastBase.html">traits::detail::BaseCastBase</a></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  {</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keyword">template</span><<span class="keyword">class</span> Derived></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <a class="code" href="structcereal_1_1virtual__base__class.html">virtual_base_class</a>(Derived <span class="keyword">const</span> * derived) :</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  base_ptr(<span class="keyword">const_cast<</span>Base*<span class="keyword">></span>(<span class="keyword">static_cast<</span>Base <span class="keyword">const </span>*<span class="keyword">></span>(derived)))</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  {</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  static_assert( std::is_base_of<Base, Derived>::value, <span class="stringliteral">"Can only use virtual_base_class on a valid base class"</span> );</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass.html">base_class_detail::RegisterPolymorphicBaseClass<Base, Derived>::bind</a>();</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  }</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  Base * base_ptr;</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  };</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> } <span class="comment">// namespace cereal</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  </div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor">#endif // CEREAL_TYPES_BASE_CLASS_HPP_</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructcereal_1_1traits_1_1detail_1_1BaseCastBase_html"><div class="ttname"><a href="structcereal_1_1traits_1_1detail_1_1BaseCastBase.html">cereal::traits::detail::BaseCastBase</a></div><div class="ttdoc">Common base type for base class casting.</div><div class="ttdef"><b>Definition:</b> traits.hpp:1167</div></div>
|
|
<div class="ttc" id="apolymorphic__impl__fwd_8hpp_html"><div class="ttname"><a href="polymorphic__impl__fwd_8hpp.html">polymorphic_impl_fwd.hpp</a></div><div class="ttdoc">Internal polymorphism support forward declarations.</div></div>
|
|
<div class="ttc" id="astructcereal_1_1base__class_html"><div class="ttname"><a href="structcereal_1_1base__class.html">cereal::base_class</a></div><div class="ttdoc">Casts a derived class to its non-virtual base class in a way that safely supports abstract classes.</div><div class="ttdef"><b>Definition:</b> base_class.hpp:100</div></div>
|
|
<div class="ttc" id="astructcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass_html"><div class="ttname"><a href="structcereal_1_1base__class__detail_1_1RegisterPolymorphicBaseClass.html">cereal::base_class_detail::RegisterPolymorphicBaseClass</a></div><div class="ttdef"><b>Definition:</b> base_class.hpp:44</div></div>
|
|
<div class="ttc" id="astructcereal_1_1detail_1_1RegisterPolymorphicCaster_html_a14f9cd6827498e31efbd8c94dc786e44"><div class="ttname"><a href="structcereal_1_1detail_1_1RegisterPolymorphicCaster.html#a14f9cd6827498e31efbd8c94dc786e44">cereal::detail::RegisterPolymorphicCaster::bind</a></div><div class="ttdeci">static const PolymorphicCaster * bind()</div><div class="ttdoc">Performs registration (binding) between Base and Derived.</div><div class="ttdef"><b>Definition:</b> polymorphic_impl.hpp:450</div></div>
|
|
<div class="ttc" id="atraits_8hpp_html"><div class="ttname"><a href="traits_8hpp.html">traits.hpp</a></div><div class="ttdoc">Internal type trait support.</div></div>
|
|
<div class="ttc" id="astructcereal_1_1virtual__base__class_html"><div class="ttname"><a href="structcereal_1_1virtual__base__class.html">cereal::virtual_base_class</a></div><div class="ttdoc">Casts a derived class to its virtual base class in a way that allows cereal to track inheritance.</div><div class="ttdef"><b>Definition:</b> base_class.hpp:188</div></div>
|
|
<!-- HTML footer for doxygen 1.8.3.1-->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Feb 27 2022 19:46:46 for cereal by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-42360142-1', 'uscilab.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|