generic-library/cereal
1
0
Fork 0
mirror of https://github.com/USCiLab/cereal.git synced 2025-07-21 02:02:00 +02:00
Code Issues Projects Releases Wiki Activity
cereal/assets/doxygen/macros_8hpp.html
Shane Grant bf9fc8231e Update doc for 132
2022-02-27 19:48:38 -08:00

291 lines
17 KiB
HTML
Raw Permalink Blame History

<!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: macros.hpp File Reference</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&amp;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&amp;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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">macros.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Preprocessor macros that can customise the cereal library.
<a href="#details">More...</a></p>
<p><a href="macros_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a89aa4dfbafa0236d0da6aa7bec573f35"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a89aa4dfbafa0236d0da6aa7bec573f35">CEREAL_THREAD_SAFE</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:a89aa4dfbafa0236d0da6aa7bec573f35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether cereal should be compiled for a threaded environment. <a href="macros_8hpp.html#a89aa4dfbafa0236d0da6aa7bec573f35">More...</a><br /></td></tr>
<tr class="separator:a89aa4dfbafa0236d0da6aa7bec573f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ad098b163a5f4829eb00fd7fb0b408d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a2ad098b163a5f4829eb00fd7fb0b408d">CEREAL_SIZE_TYPE</a>&#160;&#160;&#160;uint64_t</td></tr>
<tr class="memdesc:a2ad098b163a5f4829eb00fd7fb0b408d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the data type used for size_type. <a href="macros_8hpp.html#a2ad098b163a5f4829eb00fd7fb0b408d">More...</a><br /></td></tr>
<tr class="separator:a2ad098b163a5f4829eb00fd7fb0b408d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6b40d3472fa3d7f2148657c5bd6a07a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#ad6b40d3472fa3d7f2148657c5bd6a07a">CEREAL_SERIALIZE_FUNCTION_NAME</a>&#160;&#160;&#160;serialize</td></tr>
<tr class="memdesc:ad6b40d3472fa3d7f2148657c5bd6a07a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The serialization/deserialization function name to search for. <a href="macros_8hpp.html#ad6b40d3472fa3d7f2148657c5bd6a07a">More...</a><br /></td></tr>
<tr class="separator:ad6b40d3472fa3d7f2148657c5bd6a07a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a854de4fbe2b80753b27264b7dda740e8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a854de4fbe2b80753b27264b7dda740e8">CEREAL_LOAD_FUNCTION_NAME</a>&#160;&#160;&#160;load</td></tr>
<tr class="memdesc:a854de4fbe2b80753b27264b7dda740e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The deserialization (load) function name to search for. <a href="macros_8hpp.html#a854de4fbe2b80753b27264b7dda740e8">More...</a><br /></td></tr>
<tr class="separator:a854de4fbe2b80753b27264b7dda740e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85b7884671ac5a804b66ec7c34d0ca71"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a85b7884671ac5a804b66ec7c34d0ca71">CEREAL_SAVE_FUNCTION_NAME</a>&#160;&#160;&#160;save</td></tr>
<tr class="memdesc:a85b7884671ac5a804b66ec7c34d0ca71"><td class="mdescLeft">&#160;</td><td class="mdescRight">The serialization (save) function name to search for. <a href="macros_8hpp.html#a85b7884671ac5a804b66ec7c34d0ca71">More...</a><br /></td></tr>
<tr class="separator:a85b7884671ac5a804b66ec7c34d0ca71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d46fc40eb865ec42dd40929ed5db73f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a6d46fc40eb865ec42dd40929ed5db73f">CEREAL_LOAD_MINIMAL_FUNCTION_NAME</a>&#160;&#160;&#160;load_minimal</td></tr>
<tr class="memdesc:a6d46fc40eb865ec42dd40929ed5db73f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The deserialization (load_minimal) function name to search for. <a href="macros_8hpp.html#a6d46fc40eb865ec42dd40929ed5db73f">More...</a><br /></td></tr>
<tr class="separator:a6d46fc40eb865ec42dd40929ed5db73f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac018dce5e1c47d8948842e8eaa08815e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#ac018dce5e1c47d8948842e8eaa08815e">CEREAL_SAVE_MINIMAL_FUNCTION_NAME</a>&#160;&#160;&#160;save_minimal</td></tr>
<tr class="memdesc:ac018dce5e1c47d8948842e8eaa08815e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The serialization (save_minimal) function name to search for. <a href="macros_8hpp.html#ac018dce5e1c47d8948842e8eaa08815e">More...</a><br /></td></tr>
<tr class="separator:ac018dce5e1c47d8948842e8eaa08815e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c37b2307b83bbe2a3de58d78a2b8c0b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="memdesc:a6c37b2307b83bbe2a3de58d78a2b8c0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the CEREAL_NOEXCEPT macro to use instead of noexcept. <a href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">More...</a><br /></td></tr>
<tr class="separator:a6c37b2307b83bbe2a3de58d78a2b8c0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cef221591f5c83a264cd1e6738b678d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="macros_8hpp.html#a8cef221591f5c83a264cd1e6738b678d">CEREAL_ALIGNOF</a>&#160;&#160;&#160;alignof</td></tr>
<tr class="memdesc:a8cef221591f5c83a264cd1e6738b678d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if C++14 is available. <a href="macros_8hpp.html#a8cef221591f5c83a264cd1e6738b678d">More...</a><br /></td></tr>
<tr class="separator:a8cef221591f5c83a264cd1e6738b678d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Preprocessor macros that can customise the cereal library. </p>
<p>By default, cereal looks for serialization functions with very specific names, that is: serialize, load, save, load_minimal, or save_minimal.</p>
<p>This file allows an advanced user to change these names to conform to some other style or preference. This is implemented using preprocessor macros.</p>
<p>As a result of this, in internal cereal code you will see macros used for these function names. In user code, you should name the functions like you normally would and not use the macros to improve readability. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8cef221591f5c83a264cd1e6738b678d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cef221591f5c83a264cd1e6738b678d">&#9670;&nbsp;</a></span>CEREAL_ALIGNOF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_ALIGNOF&#160;&#160;&#160;alignof</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if C++14 is available. </p>
<p>Checks if C++17 is available NOTE: clang v5 has a bug with inline variables, so disable C++17 on that compiler Defines the CEREAL_ALIGNOF macro to use instead of alignof </p>
</div>
</div>
<a id="a854de4fbe2b80753b27264b7dda740e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a854de4fbe2b80753b27264b7dda740e8">&#9670;&nbsp;</a></span>CEREAL_LOAD_FUNCTION_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_LOAD_FUNCTION_NAME&#160;&#160;&#160;load</td>
</tr>
</table>
</div><div class="memdoc">
<p>The deserialization (load) function name to search for. </p>
<p>You can define <code>CEREAL_LOAD_FUNCTION_NAME</code> to be different assuming you do so before this file is included. </p>
</div>
</div>
<a id="a6d46fc40eb865ec42dd40929ed5db73f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d46fc40eb865ec42dd40929ed5db73f">&#9670;&nbsp;</a></span>CEREAL_LOAD_MINIMAL_FUNCTION_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_LOAD_MINIMAL_FUNCTION_NAME&#160;&#160;&#160;load_minimal</td>
</tr>
</table>
</div><div class="memdoc">
<p>The deserialization (load_minimal) function name to search for. </p>
<p>You can define <code>CEREAL_LOAD_MINIMAL_FUNCTION_NAME</code> to be different assuming you do so before this file is included. </p>
</div>
</div>
<a id="a6c37b2307b83bbe2a3de58d78a2b8c0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c37b2307b83bbe2a3de58d78a2b8c0b">&#9670;&nbsp;</a></span>CEREAL_NOEXCEPT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_NOEXCEPT</td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines the CEREAL_NOEXCEPT macro to use instead of noexcept. </p>
<p>If a compiler we support does not support noexcept, this macro will detect this and define CEREAL_NOEXCEPT as a no-op </p>
</div>
</div>
<a id="a85b7884671ac5a804b66ec7c34d0ca71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85b7884671ac5a804b66ec7c34d0ca71">&#9670;&nbsp;</a></span>CEREAL_SAVE_FUNCTION_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_SAVE_FUNCTION_NAME&#160;&#160;&#160;save</td>
</tr>
</table>
</div><div class="memdoc">
<p>The serialization (save) function name to search for. </p>
<p>You can define <code>CEREAL_SAVE_FUNCTION_NAME</code> to be different assuming you do so before this file is included. </p>
</div>
</div>
<a id="ac018dce5e1c47d8948842e8eaa08815e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac018dce5e1c47d8948842e8eaa08815e">&#9670;&nbsp;</a></span>CEREAL_SAVE_MINIMAL_FUNCTION_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_SAVE_MINIMAL_FUNCTION_NAME&#160;&#160;&#160;save_minimal</td>
</tr>
</table>
</div><div class="memdoc">
<p>The serialization (save_minimal) function name to search for. </p>
<p>You can define <code>CEREAL_SAVE_MINIMAL_FUNCTION_NAME</code> to be different assuming you do so before this file is included. </p>
</div>
</div>
<a id="ad6b40d3472fa3d7f2148657c5bd6a07a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6b40d3472fa3d7f2148657c5bd6a07a">&#9670;&nbsp;</a></span>CEREAL_SERIALIZE_FUNCTION_NAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_SERIALIZE_FUNCTION_NAME&#160;&#160;&#160;serialize</td>
</tr>
</table>
</div><div class="memdoc">
<p>The serialization/deserialization function name to search for. </p>
<p>You can define <code>CEREAL_SERIALIZE_FUNCTION_NAME</code> to be different assuming you do so before this file is included. </p>
</div>
</div>
<a id="a2ad098b163a5f4829eb00fd7fb0b408d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ad098b163a5f4829eb00fd7fb0b408d">&#9670;&nbsp;</a></span>CEREAL_SIZE_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_SIZE_TYPE&#160;&#160;&#160;uint64_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the data type used for size_type. </p>
<p>cereal uses size_type to ensure that the serialized size of dynamic containers is compatible across different architectures (e.g. 32 vs 64 bit), which may use different underlying types for std::size_t.</p>
<p>More information can be found in <a class="el" href="helpers_8hpp.html" title="Internal helper functionality.">cereal/details/helpers.hpp</a>.</p>
<p>If you choose to modify this type, ensure that you use a fixed size type (e.g. uint32_t). </p>
</div>
</div>
<a id="a89aa4dfbafa0236d0da6aa7bec573f35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89aa4dfbafa0236d0da6aa7bec573f35">&#9670;&nbsp;</a></span>CEREAL_THREAD_SAFE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CEREAL_THREAD_SAFE&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether cereal should be compiled for a threaded environment. </p>
<p>This macro causes cereal to use mutexes to control access to global internal state in a thread safe manner.</p>
<p>Note that even with this enabled you must still ensure that archives are accessed by only one thread at a time; it is safe to use multiple archives in parallel, but not to access one archive from many places simultaneously. </p>
</div>
</div>
</div><!-- contents -->
<!-- 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 &#160;<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>
Reference in New Issue View Git Blame Copy Permalink