blob: 8ed94f1dc1095277e10003fbf0c5aa82ddd1e379 [file] [log] [blame]
<!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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: util/misc/initialization_state_dcheck.h 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" />
<link href="crashpad_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">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<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_23ec12649285f9fabf3a6b7380226c28.html">util</a></li><li class="navelem"><a class="el" href="dir_83573ff3a96d199825b0a6f960a8a5e3.html">misc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">initialization_state_dcheck.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;base/compiler_specific.h&quot;</code><br />
<code>#include &quot;base/logging.h&quot;</code><br />
<code>#include &quot;base/macros.h&quot;</code><br />
<code>#include &quot;build/build_config.h&quot;</code><br />
<code>#include &quot;util/misc/initialization_state.h&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitializationStateDcheck.html">crashpad::InitializationStateDcheck</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access. <a href="classcrashpad_1_1InitializationStateDcheck.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacecrashpad"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecrashpad.html">crashpad</a></td></tr>
<tr class="memdesc:namespacecrashpad"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main namespace. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9f550b300c9c7d5214aa612adfdba40e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="initialization__state__dcheck_8h.html#a9f550b300c9c7d5214aa612adfdba40e">INITIALIZATION_STATE_SET_INITIALIZING</a>(initialization_state_dcheck)</td></tr>
<tr class="memdesc:a9f550b300c9c7d5214aa612adfdba40e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks that a <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object is in the <a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88ab86672ada53041ffcecfb379473bf353" title="The object has not yet been initialized.">crashpad::InitializationState::kStateUninitialized</a> state, and changes its state to initializing (<a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88afc9011e885f6b0a93151818010eefdfc" title="The object is being initialized.">crashpad::InitializationState::kStateInvalid</a>). <a href="initialization__state__dcheck_8h.html#a9f550b300c9c7d5214aa612adfdba40e">More...</a><br /></td></tr>
<tr class="separator:a9f550b300c9c7d5214aa612adfdba40e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a079bd353351188e4819d9008b732bdce"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="initialization__state__dcheck_8h.html#a079bd353351188e4819d9008b732bdce">INITIALIZATION_STATE_SET_VALID</a>(initialization_state_dcheck)</td></tr>
<tr class="memdesc:a079bd353351188e4819d9008b732bdce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks that a <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object is in the initializing (<a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88afc9011e885f6b0a93151818010eefdfc" title="The object is being initialized.">crashpad::InitializationState::kStateInvalid</a>) state, and changes its state to <a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88af8963ed6297bea7168911fe4ed87e163" title="The object has been initialized.">crashpad::InitializationState::kStateValid</a>. <a href="initialization__state__dcheck_8h.html#a079bd353351188e4819d9008b732bdce">More...</a><br /></td></tr>
<tr class="separator:a079bd353351188e4819d9008b732bdce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0cdf9da2bf4bb9c2318e100136782ee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="initialization__state__dcheck_8h.html#ad0cdf9da2bf4bb9c2318e100136782ee">INITIALIZATION_STATE_DCHECK_VALID</a>(initialization_state_dcheck)</td></tr>
<tr class="memdesc:ad0cdf9da2bf4bb9c2318e100136782ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks that a <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object is in the <a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88af8963ed6297bea7168911fe4ed87e163" title="The object has been initialized.">crashpad::InitializationState::kStateValid</a> state. <a href="initialization__state__dcheck_8h.html#ad0cdf9da2bf4bb9c2318e100136782ee">More...</a><br /></td></tr>
<tr class="separator:ad0cdf9da2bf4bb9c2318e100136782ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad0cdf9da2bf4bb9c2318e100136782ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0cdf9da2bf4bb9c2318e100136782ee">&#9670;&nbsp;</a></span>INITIALIZATION_STATE_DCHECK_VALID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INITIALIZATION_STATE_DCHECK_VALID</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">initialization_state_dcheck</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> DCHECK_EQ((initialization_state_dcheck).state(), \</div>
<div class="line"> (initialization_state_dcheck).kStateValid)</div>
</div><!-- fragment -->
<p>Checks that a <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object is in the <a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88af8963ed6297bea7168911fe4ed87e163" title="The object has been initialized.">crashpad::InitializationState::kStateValid</a> state. </p>
<p>If the object is not in the correct state, a DCHECK assertion is triggered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">initialization_state_dcheck</td><td>A <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> </dd></dl>
</div>
</div>
<a id="a9f550b300c9c7d5214aa612adfdba40e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f550b300c9c7d5214aa612adfdba40e">&#9670;&nbsp;</a></span>INITIALIZATION_STATE_SET_INITIALIZING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INITIALIZATION_STATE_SET_INITIALIZING</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">initialization_state_dcheck</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> DCHECK_EQ((initialization_state_dcheck).SetInitializing(), \</div>
<div class="line"> (initialization_state_dcheck).kStateUninitialized)</div>
</div><!-- fragment -->
<p>Checks that a <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object is in the <a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88ab86672ada53041ffcecfb379473bf353" title="The object has not yet been initialized.">crashpad::InitializationState::kStateUninitialized</a> state, and changes its state to initializing (<a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88afc9011e885f6b0a93151818010eefdfc" title="The object is being initialized.">crashpad::InitializationState::kStateInvalid</a>). </p>
<p>If the object is not in the correct state, a DCHECK assertion is triggered and the object’s state remains unchanged.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">initialization_state_dcheck</td><td>A <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> </dd></dl>
</div>
</div>
<a id="a079bd353351188e4819d9008b732bdce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a079bd353351188e4819d9008b732bdce">&#9670;&nbsp;</a></span>INITIALIZATION_STATE_SET_VALID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INITIALIZATION_STATE_SET_VALID</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">initialization_state_dcheck</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> DCHECK_EQ((initialization_state_dcheck).SetValid(), \</div>
<div class="line"> (initialization_state_dcheck).kStateInvalid)</div>
</div><!-- fragment -->
<p>Checks that a <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object is in the initializing (<a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88afc9011e885f6b0a93151818010eefdfc" title="The object is being initialized.">crashpad::InitializationState::kStateInvalid</a>) state, and changes its state to <a class="el" href="classcrashpad_1_1InitializationState.html#a044ea6d40e23683d6d1bb5ce30dafd88af8963ed6297bea7168911fe4ed87e163" title="The object has been initialized.">crashpad::InitializationState::kStateValid</a>. </p>
<p>If the object is not in the correct state, a DCHECK assertion is triggered and the object’s state remains unchanged.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">initialization_state_dcheck</td><td>A <a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> object.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classcrashpad_1_1InitializationStateDcheck.html" title="Tracks whether data are initialized, triggering a DCHECK assertion on an invalid data access.">crashpad::InitializationStateDcheck</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>