164 lines
16 KiB
HTML
164 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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>LibRTOSConsole-C-Library: C:/HomeGit/STM32/libs/LibRTOSConsole/inc/Console.h 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.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>
|
|
<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="banner.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">LibRTOSConsole-C-Library<span id="projectnumber"> 1.0</span>
|
|
</div>
|
|
<div id="projectbrief">Library Code documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('Console_8h_source.html',''); initResizable(true); });
|
|
/* @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="headertitle"><div class="title">Console.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="Console_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Console.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Created on: Dec 8, 2024</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Author: Thorsten</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifndef INC_CONSOLE_CONSOLE_H_</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define INC_CONSOLE_CONSOLE_H_</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed"> 17</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structConsoleHandle.html">ConsoleHandle</a>* <a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a>;</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f"> 30</a></span><span class="keyword">typedef</span> int (*<a class="code hl_typedef" href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f">CONSOLE_CommandFunc</a>)(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv, <span class="keywordtype">void</span>* context);</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21"> 38</a></span><span class="keyword">typedef</span> int (*<a class="code hl_typedef" href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21">ConsoleReadStream_t</a>)(<span class="keywordtype">void</span>* pContext, <span class="keywordtype">char</span>* pBuffer, <span class="keywordtype">int</span> num);</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42"> 46</a></span><span class="keyword">typedef</span> int (*<a class="code hl_typedef" href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42">ConsoleWriteStream_t</a>)(<span class="keywordtype">void</span>* pContext, <span class="keyword">const</span> <span class="keywordtype">char</span>* pBuffer, <span class="keywordtype">int</span> num);</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> <a class="code hl_function" href="Console_8h.html#a1cc9e1f1895ce147a8402a545f431af0">CONSOLE_CreateInstance</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> uxStackDepth, <span class="keywordtype">int</span> xPrio );</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keywordtype">void</span> <a class="code hl_function" href="Console_8h.html#ae795dfef72286b292ad0e8a5436b7d72">CONSOLE_DestroyInstance</a>( <a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h );</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keywordtype">int</span> <a class="code hl_function" href="Console_8h.html#addfc73ef0ae78e22f0ce2cfb9ea1858e">CONSOLE_RegisterCommand</a>( <a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, <span class="keywordtype">char</span>* cmd, <span class="keywordtype">char</span>* help, <a class="code hl_typedef" href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f">CONSOLE_CommandFunc</a> func, <span class="keywordtype">void</span>* context );</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span></div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="keywordtype">int</span> <a class="code hl_function" href="Console_8h.html#a9f2d2d6d16197db3343378f8015be902">CONSOLE_RegisterAlias</a>( <a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, <span class="keywordtype">char</span>* cmd, <span class="keywordtype">char</span>* aliasCmd );</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span></div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="keywordtype">int</span> <a class="code hl_function" href="Console_8h.html#a0138abed767bbe0731ccbe18c0166295">CONSOLE_RemoveAliasOrCommand</a>( <a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, <span class="keywordtype">char</span>* cmd);</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="keywordtype">int</span> <a class="code hl_function" href="Console_8h.html#ad421602256c464d09af01e0ccf942935">CONSOLE_RedirectStreams</a>( <a class="code hl_typedef" href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a> h, <a class="code hl_typedef" href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21">ConsoleReadStream_t</a> rdFunc, <a class="code hl_typedef" href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42">ConsoleWriteStream_t</a> wrFunc,</div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">void</span>* rdContext, <span class="keywordtype">void</span>* wrContext );</div>
|
|
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
|
|
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span></div>
|
|
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> </div>
|
|
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> </div>
|
|
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span><span class="preprocessor">#endif </span><span class="comment">/* INC_CONSOLE_CONSOLE_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="aConsole_8h_html_a0138abed767bbe0731ccbe18c0166295"><div class="ttname"><a href="Console_8h.html#a0138abed767bbe0731ccbe18c0166295">CONSOLE_RemoveAliasOrCommand</a></div><div class="ttdeci">int CONSOLE_RemoveAliasOrCommand(ConsoleHandle_t h, char *cmd)</div><div class="ttdef"><b>Definition</b> Console.c:1553</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_a12c3effabac4f86fdade6a4bf60c5f21"><div class="ttname"><a href="Console_8h.html#a12c3effabac4f86fdade6a4bf60c5f21">ConsoleReadStream_t</a></div><div class="ttdeci">int(* ConsoleReadStream_t)(void *pContext, char *pBuffer, int num)</div><div class="ttdef"><b>Definition</b> Console.h:38</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_a1cc9e1f1895ce147a8402a545f431af0"><div class="ttname"><a href="Console_8h.html#a1cc9e1f1895ce147a8402a545f431af0">CONSOLE_CreateInstance</a></div><div class="ttdeci">ConsoleHandle_t CONSOLE_CreateInstance(unsigned int uxStackDepth, int xPrio)</div><div class="ttdef"><b>Definition</b> Console.c:1397</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_a46ebef7f89bcb306abadd6f600b8929f"><div class="ttname"><a href="Console_8h.html#a46ebef7f89bcb306abadd6f600b8929f">CONSOLE_CommandFunc</a></div><div class="ttdeci">int(* CONSOLE_CommandFunc)(int argc, char **argv, void *context)</div><div class="ttdef"><b>Definition</b> Console.h:30</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_a6b0ace0f789c7b3dd7e0d33b5b60ec42"><div class="ttname"><a href="Console_8h.html#a6b0ace0f789c7b3dd7e0d33b5b60ec42">ConsoleWriteStream_t</a></div><div class="ttdeci">int(* ConsoleWriteStream_t)(void *pContext, const char *pBuffer, int num)</div><div class="ttdef"><b>Definition</b> Console.h:46</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_a9f2d2d6d16197db3343378f8015be902"><div class="ttname"><a href="Console_8h.html#a9f2d2d6d16197db3343378f8015be902">CONSOLE_RegisterAlias</a></div><div class="ttdeci">int CONSOLE_RegisterAlias(ConsoleHandle_t h, char *cmd, char *aliasCmd)</div><div class="ttdef"><b>Definition</b> Console.c:1498</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_ad421602256c464d09af01e0ccf942935"><div class="ttname"><a href="Console_8h.html#ad421602256c464d09af01e0ccf942935">CONSOLE_RedirectStreams</a></div><div class="ttdeci">int CONSOLE_RedirectStreams(ConsoleHandle_t h, ConsoleReadStream_t rdFunc, ConsoleWriteStream_t wrFunc, void *rdContext, void *wrContext)</div><div class="ttdef"><b>Definition</b> Console.c:580</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_addfc73ef0ae78e22f0ce2cfb9ea1858e"><div class="ttname"><a href="Console_8h.html#addfc73ef0ae78e22f0ce2cfb9ea1858e">CONSOLE_RegisterCommand</a></div><div class="ttdeci">int CONSOLE_RegisterCommand(ConsoleHandle_t h, char *cmd, char *help, CONSOLE_CommandFunc func, void *context)</div><div class="ttdef"><b>Definition</b> Console.c:1442</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_ae795dfef72286b292ad0e8a5436b7d72"><div class="ttname"><a href="Console_8h.html#ae795dfef72286b292ad0e8a5436b7d72">CONSOLE_DestroyInstance</a></div><div class="ttdeci">void CONSOLE_DestroyInstance(ConsoleHandle_t h)</div><div class="ttdef"><b>Definition</b> Console.c:1592</div></div>
|
|
<div class="ttc" id="aConsole_8h_html_aed9ab825e8ec4fe645de7e1d7b3548ed"><div class="ttname"><a href="Console_8h.html#aed9ab825e8ec4fe645de7e1d7b3548ed">ConsoleHandle_t</a></div><div class="ttdeci">struct ConsoleHandle * ConsoleHandle_t</div><div class="ttdef"><b>Definition</b> Console.h:17</div></div>
|
|
<div class="ttc" id="astructConsoleHandle_html"><div class="ttname"><a href="structConsoleHandle.html">ConsoleHandle</a></div><div class="ttdef"><b>Definition</b> Console.c:175</div></div>
|
|
</div><!-- fragment --></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_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="Console_8h.html">Console.h</a></li>
|
|
<li class="footer">Generated on Mon Apr 14 2025 21:44:52 for LibRTOSConsole-C-Library by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|