FSM/vscode/manual/html/_f_s_m_8c.html

339 lines
16 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>状态机框架: FSM_OOP/baseFSM/FSM.c 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo_transparent.png"/></td>
<td id="projectalign">
<div id="projectname">状态机框架<span id="projectnumber">&#160;0.1alpha</span>
</div>
<div id="projectbrief">by 天神</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_f_s_m_8c.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">FSM.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="_f_s_m__private_8h_source.html">FSM_private.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_f_s_m__protected_8h_source.html">FSM_protected.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_f_s_m__public_8h_source.html">FSM_public.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6b596586b33f46c312a7088e8352d226" id="r_a6b596586b33f46c312a7088e8352d226"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b596586b33f46c312a7088e8352d226">setNextState</a> (FSM *pFSM)</td></tr>
<tr class="memdesc:a6b596586b33f46c312a7088e8352d226"><td class="mdescLeft">&#160;</td><td class="mdescRight">设置下一个状态,里面的子状态机暂时没用到 <br /></td></tr>
<tr class="separator:a6b596586b33f46c312a7088e8352d226"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fc6a4715e8cbd7660788fd9c59cb417" id="r_a7fc6a4715e8cbd7660788fd9c59cb417"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7fc6a4715e8cbd7660788fd9c59cb417">preload</a> (FSM *pFSM)</td></tr>
<tr class="separator:a7fc6a4715e8cbd7660788fd9c59cb417"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bab0f8eedb805136ee573eac09b6ebb" id="r_a9bab0f8eedb805136ee573eac09b6ebb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9bab0f8eedb805136ee573eac09b6ebb">stepBaseFSM</a> (FSM *pFSM)</td></tr>
<tr class="memdesc:a9bab0f8eedb805136ee573eac09b6ebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">运行状态机,状态机框架的核心函数 <br /></td></tr>
<tr class="separator:a9bab0f8eedb805136ee573eac09b6ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c285ac5bbad90b0b04de18d393cf4ce" id="r_a9c285ac5bbad90b0b04de18d393cf4ce"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c285ac5bbad90b0b04de18d393cf4ce">_preloadIn</a> (FSM *pFSM)</td></tr>
<tr class="separator:a9c285ac5bbad90b0b04de18d393cf4ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e2a8d16f390efeaecc8938ec8f2e728" id="r_a6e2a8d16f390efeaecc8938ec8f2e728"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e2a8d16f390efeaecc8938ec8f2e728">_preloaderGetReady</a> (FSM *pFSM)</td></tr>
<tr class="separator:a6e2a8d16f390efeaecc8938ec8f2e728"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a704103961964dbb8582b59fd161a3348" id="r_a704103961964dbb8582b59fd161a3348"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a704103961964dbb8582b59fd161a3348">_getPreloaderOverFlag</a> (FSM *pFSM)</td></tr>
<tr class="separator:a704103961964dbb8582b59fd161a3348"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad909acd21e17b8073d5d9dfb8892ccb" id="r_aad909acd21e17b8073d5d9dfb8892ccb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad909acd21e17b8073d5d9dfb8892ccb">_clearPreloaderOverFlag</a> (FSM *pFSM)</td></tr>
<tr class="separator:aad909acd21e17b8073d5d9dfb8892ccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>天神 (<a href="#" onclick="location.href='mai'+'lto:'+'dal'+'ao'+'shi'+'@s'+'tu.'+'xj'+'tu.'+'ed'+'u.c'+'n'; return false;">dalao<span class="obfuscator">.nosp@m.</span>shi@<span class="obfuscator">.nosp@m.</span>stu.x<span class="obfuscator">.nosp@m.</span>jtu.<span class="obfuscator">.nosp@m.</span>edu.c<span class="obfuscator">.nosp@m.</span>n</a>) </dd></dl>
<dl class="section version"><dt>Version</dt><dd>2.1 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2024-05-07</dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>天神创意无限公司 2024 </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a6b596586b33f46c312a7088e8352d226" name="a6b596586b33f46c312a7088e8352d226"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b596586b33f46c312a7088e8352d226">&#9670;&#160;</a></span>setNextState()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void setNextState </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>设置下一个状态,里面的子状态机暂时没用到 </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td>状态机变量的基类指针 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7fc6a4715e8cbd7660788fd9c59cb417" name="a7fc6a4715e8cbd7660788fd9c59cb417"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fc6a4715e8cbd7660788fd9c59cb417">&#9670;&#160;</a></span>preload()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void preload </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated</a></b></dt><dd>去掉了所有和预装载器相关的内容 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9bab0f8eedb805136ee573eac09b6ebb" name="a9bab0f8eedb805136ee573eac09b6ebb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bab0f8eedb805136ee573eac09b6ebb">&#9670;&#160;</a></span>stepBaseFSM()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stepBaseFSM </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>运行状态机,状态机框架的核心函数 </p>
<p>共分为三部首先判断是否有状态机切换, </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td>状态机基类指针 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9c285ac5bbad90b0b04de18d393cf4ce" name="a9c285ac5bbad90b0b04de18d393cf4ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c285ac5bbad90b0b04de18d393cf4ce">&#9670;&#160;</a></span>_preloadIn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * _preloadIn </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated</a></b></dt><dd>弃用 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void* </dd></dl>
</div>
</div>
<a id="a6e2a8d16f390efeaecc8938ec8f2e728" name="a6e2a8d16f390efeaecc8938ec8f2e728"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e2a8d16f390efeaecc8938ec8f2e728">&#9670;&#160;</a></span>_preloaderGetReady()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void _preloaderGetReady </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated</a></b></dt><dd>弃用 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a704103961964dbb8582b59fd161a3348" name="a704103961964dbb8582b59fd161a3348"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a704103961964dbb8582b59fd161a3348">&#9670;&#160;</a></span>_getPreloaderOverFlag()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int _getPreloaderOverFlag </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated</a></b></dt><dd>弃用 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
</div>
</div>
<a id="aad909acd21e17b8073d5d9dfb8892ccb" name="aad909acd21e17b8073d5d9dfb8892ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad909acd21e17b8073d5d9dfb8892ccb">&#9670;&#160;</a></span>_clearPreloaderOverFlag()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void _clearPreloaderOverFlag </td>
<td>(</td>
<td class="paramtype">FSM *</td> <td class="paramname"><span class="paramname"><em>pFSM</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated</a></b></dt><dd>弃用 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pFSM</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d39bfbf75725f6289f30e50b2f1305f4.html">FSM_OOP</a></li><li class="navelem"><a class="el" href="dir_80fe18a48ef62b4daee0a25030c2866c.html">baseFSM</a></li><li class="navelem"><a class="el" href="_f_s_m_8c.html">FSM.c</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>